Properties
| Name | Type | Required | Description |
|---|---|---|---|
| active | bool |
❌ | Indicates whether the product is currently being sold. Default is false. |
| attributes | dict |
❌ | Up to 5 alphanumeric key-value pairs defined by the merchant. Each key must match a string in the attributes list of the corresponding product object. |
| created_at | float |
❌ | Time of creation of this SKU, in Unix time. Response only. |
| currency | str |
❌ | |
| id_ | str |
❌ | ID of the SKU object. Alphanumeric characters and underscores. Defined by the merchant, or a string starting with sku. |
| image | str |
❌ | URL of image associated with the product. |
| inventory | dict |
❌ | Contains the following fields: type - One of the following values: finite - Physical objects that can be counted. infinite - Products such as downloadable software. bucket - Products that are sold by measurable quantity. quantity - The number of units available in inventory. Integer. Relevant when type is finite. value - The status of the product on hand in inventory. Relevant when type is bucket. One of the following: in_stock - A normal amount of product is available in inventory. limited - There is enough product in inventory for small orders only. * out_of_stock - No product remains in inventory. |
| metadata | dict |
❌ | A JSON object defined by the client. |
| package_dimensions | SkuPackageDimensions |
❌ | Physical attributes of the SKU item. Contains the following fields, height length weight width These fields are represented as numbers, but it is the responsibility of the merchant to define and interpret the relevant units of length and weight. |
| price | float |
❌ | Price of one unit. Decimal. |
| product | str |
❌ | ID of the product that this SKU relates to. |
| updated_at | float |
❌ | Time that this product was last updated, in Unix time. Response only. |