Skip to content

Latest commit

 

History

History
32 lines (20 loc) · 1.91 KB

Product.md

File metadata and controls

32 lines (20 loc) · 1.91 KB

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.

Properties

Name Type Description
id String Unique product ID assigned by Voucherify.
sourceId String Unique product source ID.
name String Unique user-defined product name.
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 List<String> A list of product attributes whose values you can customize for given SKUs: `[&quot;color&quot;,&quot;size&quot;,&quot;ranking&quot;]`. Each child SKU can have a unique value for a given attribute.
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.
imageUrl String The HTTPS URL pointing to the .png or .jpg file that will be used to render the product image.
createdAt OffsetDateTime Timestamp representing the date and time when the product was created. The value is shown in the ISO 8601 format.
updatedAt OffsetDateTime Timestamp representing the date and time when the product was updated. The value is shown in the ISO 8601 format.
_object ObjectEnum The type of the object represented by JSON. This object stores information about the product.
skus SkusListForProduct

Enum: ObjectEnum

Name Value
PRODUCT "product"