Product
This is an object representing a product.
This entity should be used to map product items from your inventory management system. The aim of products is to build which reflect product-specific campaigns.
All of:
- Product without Skus Object
-
Attributes Description skus See: Skus List For Product
Product without Skus Object
Attributes | Description |
---|---|
idstring | Unique product ID assigned by Voucherify. Example:prod_0b1da8105693710357 |
source_idstring , null | Unique product source ID. Example:productSourceID16 |
namestring , null | Unique user-defined product name. Example:T-shirt |
priceinteger , null | Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as |
attributesarray | A list of product attributes whose values you can customize for given SKUs: |
metadataobject | 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. |
image_urlstring , null | The HTTPS URL pointing to the .png or .jpg file that will be used to render the product image. Example: |
created_atstring | Timestamp representing the date and time when the product was created. The value is shown in the ISO 8601 format. Example:2022-05-23T06:52:55.008Z |
updated_atstring , null | Timestamp representing the date and time when the product was updated. The value is shown in the ISO 8601 format. Example:2022-05-23T09:24:07.405Z |
objectstring | The type of the object represented by JSON. This object stores information about the product. Available values:product |
Skus List For Product
Attributes | Description |
---|---|
objectstring | The type of the object represented by JSON. This object stores information about SKUs. |
data_refstring | Identifies the name of the JSON property that contains the array of SKUs. |
dataarray | A dictionary that contains an array of SKUs. Array of SKU Object |
totalinteger | Total number of SKUs in the product. |
SKU Object
Attributes | Description |
---|---|
idstring | A unique identifier that represents the SKU and is assigned by Voucherify. Example:sku_0b1621b319d248b79f |
source_idstring , null | A unique SKU identifier from your inventory system. Example:sku_source_id_4 |
product_idstring | The parent product's unique ID. Example:prod_0b15f6b9f650c16990 |
skustring , null | Unique user-defined SKU name. Example:Large Pink Shirt |
priceinteger , null | Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as |
currencystring , null | SKU price currency. Example:USD |
attributesobject | The attributes object stores values for all custom attributes inherited by the SKU from the parent product. A set of key/value pairs that are attached to a SKU object and are unique to each SKU within a product family. |
image_urlstring , null | The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image. |
metadataobject | The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format. It can be used to create product collections. |
created_atstring | Timestamp representing the date and time when the SKU was created. The value is shown in the ISO 8601 format. Example:2022-05-17T10:36:30.187Z |
updated_atstring , null | Timestamp representing the date and time when the SKU was updated. The value is shown in the ISO 8601 format. Example:2022-05-17T10:55:09.137Z |
objectstring | The type of the object represented by JSON. This object stores information about the sku |