curl --request POST \
--url https://{cluster}.voucherify.io/v1/products \
--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",
"price": 200000,
"attributes": [
"color",
"memory",
"processor"
],
"metadata": {
"test": true,
"vendor": "Online Store"
},
"image_url": "{{internalVoucherifyURL}}"
}
'{
"id": "prod_0bae2dc5a090fd0184",
"source_id": "first_product",
"name": "Samsung Phone",
"price": 200000,
"attributes": [
"color",
"memory",
"processor"
],
"metadata": {
"test": true,
"vendor": "Online Store"
},
"image_url": "https://www.website.com/image.png",
"created_at": "2022-09-12T12:58:22.232Z",
"updated_at": "2022-09-12T12:59:55.890Z",
"object": "product"
}Creates a product object.
📘 Upsert Mode
If you pass an
idor asource_idthat already exists in the product database, Voucherify will return a related product object with updated fields.
curl --request POST \
--url https://{cluster}.voucherify.io/v1/products \
--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",
"price": 200000,
"attributes": [
"color",
"memory",
"processor"
],
"metadata": {
"test": true,
"vendor": "Online Store"
},
"image_url": "{{internalVoucherifyURL}}"
}
'{
"id": "prod_0bae2dc5a090fd0184",
"source_id": "first_product",
"name": "Samsung Phone",
"price": 200000,
"attributes": [
"color",
"memory",
"processor"
],
"metadata": {
"test": true,
"vendor": "Online Store"
},
"image_url": "https://www.website.com/image.png",
"created_at": "2022-09-12T12:58:22.232Z",
"updated_at": "2022-09-12T12:59:55.890Z",
"object": "product"
}Authorizations
Body
Specify the product parameters.
Request schema for POST v1/products.
A unique identifier that represents the product and is assigned by Voucherify.
"prod_5h0wc453_1"
Unique product source ID.
"productSourceID16"
Unique user-defined product name.
"T-shirt"
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.
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.
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.
The HTTPS URL pointing to the .png or .jpg file that will be used to render the product image.
"https://images.com/original.jpg"
Response
Returns a product object if the operation succeeded.
Response body schema for POST v1/products.
Unique product ID assigned by Voucherify.
"prod_0b1da8105693710357"
Unique product source ID.
"productSourceID16"
Unique user-defined product name.
"T-shirt"
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.
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.
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. It can be used to create product collections.
The type of the object represented by JSON. This object stores information about the product.
product The HTTPS URL pointing to the .png or .jpg file that will be used to render the product image.
"https://images.com/original.jpg"
Timestamp representing the date and time when the product was created. The value is shown in the ISO 8601 format.
"2022-05-23T06:52:55.008Z"
Timestamp representing the date and time when the product was updated. The value is shown in the ISO 8601 format.
"2022-05-23T09:24:07.405Z"
Contains information about child SKUs.
Show child attributes
Show child attributes
Was this page helpful?