Skip to main content
POST
/
v1
/
products
/
bulk
/
async
Update Products in Bulk
curl --request POST \
  --url https://{cluster}.voucherify.io/v1/products/bulk/async \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '[
  {
    "source_id": "first_product",
    "name": "Samsung Phone 1",
    "price": 220000,
    "attributes": [
      "color",
      "memory",
      "processor"
    ],
    "metadata": {
      "test": true,
      "vendor": "Online Store - 3"
    },
    "image_url": "{{internalVoucherifyURL}}"
  },
  {
    "source_id": "second_product",
    "name": "Samsung Phone 2",
    "price": 230000,
    "attributes": [
      "color",
      "memory",
      "processor"
    ],
    "metadata": {
      "test": true,
      "vendor": "Online Store - 4"
    },
    "image_url": "{{internalVoucherifyURL}}"
  }
]'
{
  "async_action_id": "aa_0a875d56c805df6601"
}

Authorizations

X-App-Id
string
header
required
X-App-Token
string
header
required
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json · Products Update In Bulk Request Body · object[]

List the product fields to be updated in each product object.

source_id
string
required

Unique product source ID from your inventory system.

Example:

"test_prod_id_1"

name
string

Unique user-defined product name.

Example:

"T-shirt"

price
integer

Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as $100.00 being expressed as 10000.

attributes
string[]

A list of product attributes whose values you can customize for given SKUs: ["color","size","ranking"]. Each child SKU can have a unique value for a given attribute.

image_url
string

The HTTPS URL pointing to the .png or .jpg file that will be used to render the product image.

Example:

"https://images.com/original.jpg"

metadata
object

The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format.

Response

Returns the ID of the scheduled asynchronous action. The response informs you that the request has been accepted and the resources will be updated in the repository asynchronously. To check the status and result, copy the async_action_id from the response and use it as a query parameter in the GET Async Action endpoint.

Response body schema for POST v1/products/bulk/async. Response to requests that are processed asynchronously.

async_action_id
string
required

The ID of the scheduled asynchronous action.

Example:

"aa_0a875d56c805df6601"

I