Product or variant statuses
Value | Description |
---|---|
ACTIVE | Product is being sold. |
ARCHIVED | Product has been discontinued. |
CollectionIDs
The collectionIDs
- array of strings. It should contain all collection ID's to which product belongs, including parent categories ID's.
Remember to pass all categories using collection endpoint.
Parameters
Parameter | Type | Description |
---|---|---|
productId | string | Product ID in your system |
title | string | Product title |
status | string | Values: ACTIVE, ARCHIVED |
description | string | Product description. We'll limit it to 30 words. |
productUrl | string | Link to product page |
imageUrl | string | Link to product image |
vendor | string | Product vendor |
publishedAt | string (format: date-time) | Product publishing date. Use the https://en.wikipedia.org/wiki/ISO_8601 format. Example: 2017-06-30T17:00:00Z |
tags | array of strings | Array of product tags. |
collectionIds | array of strings | Array of categories ID's. Pass all categories ID's, including all parent categories ID's, to which product belongs. |
trackInventory | boolean | If you want to use inventory numbers for your use cases, send this as true. |
variants | array of objects | Array with product variants. Product must have at least one variant. If your product doesn't have variants, use the product's info as the variant (example: variantID = productID, title=variants.title, etc.) |
variant.variantId | string | Product variant identificator |
variant.title | string | Variant title |
variant.sku | string | Variant's stock keeping unit |
variant.price | integer | Variant price in numbers |
variant.oldPrice | integer | Variant old price in numbers |
variant.currencyCode | string | Currency code of variant prices. Follow ISO 4217:2015 Format: https://en.wikipedia.org/wiki/ISO_4217. |
variant.inventoryQuantity | integer | Variant Inventory Quantity |
Collection
Endpoint: https://callback-service.contlo.com
Parameters
Parameter | Type | Description |
---|---|---|
collectionId | string | Collection ID in your system |
title | string | Collection title |