Products
Get products
Endpoint: GET /v10/order-channels/{publicOrderChannelId}/products
The endpoint will fetch a list of products available in the order channel.
caution
This endpoint uses product pagination
Data of response
| Parameter | Required | Default | Description |
|---|---|---|---|
products.* | Yes | An array of products |
Product
| Parameter | Data type | Default | Description |
|---|---|---|---|
id | int | The internal ID of the product | |
name | string | The name of the product | |
item_number | string | The item number of the product. NOTE: This is the number on the product-level, not variant-level. For variant-level refer to sku | |
attributes | array | An array with the attributes on the product. NOTE: For the attribute values look at attributes on the variant | |
description | string | The long description of the product | |
image | string | null | The primary image of the product |
images | array | [] | All images of the product |
meta | object | {} | An object with {"key": "value"} with custom meta data of the order. This is used for storing custom fields |
noos | boolean | false | Is the product considered NOOS? NOTE: This is a product- & variant-level field |
weight | float | 0 | The weight of the product. NOTE: This is a product- & variant-level field |
weight_type | string | g | Either kg for kilograms or g for grams. NOTE: This is a product- & variant-level field |
published | boolean | false | Should this product be published on the order channel? |
sync_data | boolean | false | Should product data be synced to this order channel? |
categories | Array | [] | Array of order channel categories |
collection | string | null | The collection of the product |
tags | Array | [] | A list of tags for this product |
variants | Array | [] | Array of order channel variants |
Order channel categories
| Parameter | Data type | Default | Description |
|---|---|---|---|
name | string | The name of the top category | |
sub_categories | array | [] | An array of sub categories |
sub_categories.* | string | The name of the sub category |
Order channel variants
| Parameter | Data type | Default | Description |
|---|---|---|---|
sku | string | The SKU of the variant. This is unique accross your account | |
attributes | object | An object with {"key": "value"} with the attributes of the variant. This will be Colors, Sizes, etc. | |
ean | string | null | The barcode for this variant |
meta | object | {} | An object with {"key": "value"} with custom meta data of the variant. This is used for storing custom fields |
prices | object | {} | An object of prices for the product. Prices should be keyed by their currency code |
images | array | [] | Array of images. These are the images that "belong to this variant". All images are present in the images array on the product |
noos | boolean | false | Is the variant considered NOOS? NOTE: This is a product- & variant-level field |
weight | float | 0 | The weight of the variant. NOTE: This is a product- & variant-level field |
weight_type | string | g | Either kg for kilograms or g for grams. NOTE: This is a product- & variant-level field |
available | integer | 0 | The inventory of the product |