Products · Add files · product_id

Upload files as multipart/form-data after creating upload_id, then assign them to a product. Downloads require a Bearer token and permission for category; the response contains file bytes, without a public address or password. Explicit access rule for the uploaded shared digital file. new_purchases / recent_and_new / selected / all_purchasers.

POST/api/v1/products/{product_id}/files

cURL request

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request POST \
  --url 'https://shop.onshopently.com/api/v1/products/example/files?category=digital' \
  --header 'Authorization: Bearer EXAMPLE_ACCESS_TOKEN' \
  --header 'Idempotency-Key: files-example-assign_file_api_v1_products__product_id__files_post' \
  --header 'Content-Type: application/json' \
  --data-raw '{"audience":{"mode":"new_purchases"},"expected_version":1,"upload_id":"00000000-0000-4000-8000-000000000001"}'

Response

{
  "data": {
    "deleted": false,
    "id": "00000000-0000-4000-8000-000000000001",
    "version": 2
  },
  "meta": {
    "request_id": "example"
  }
}

Required permissions

Authentication: Access token
Available from: STANDARD
Required permissions

Additional permissions for selected fields

category=internal: Manage product files · Internal filescatalog.product_file:write_internal
category=customer_document: Manage product files · Customer documentscatalog.product_file:write_customer_document
category=digital: Manage product files · Digital productscatalog.product_file:write_digital