| Code | Description |
|---|---|
| 401 | Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource. |
| 403 | Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource. |
| 404 | Not Found. The requested resource could not be found. |
| 422 | Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors. |
| 500 | Internal Server Error. An unexpected condition was encountered. |
Response (tenant version 1):
{
"page": 1,
"per_page": 50,
"total_pages": 1,
"total_entries": 1,
"entries": [
{
"en": {
"id": 1,
"product_type": "product",
"code": "12345",
"status": "active",
"product_attributes": {
"description": {
"base_type": "html",
"value": "<p style="line-height: 18.5714px;">This is a description.</p>"
},
"short_description": {
"base_type": "html",
"value": "<span style="line-height: 18.5714px;">This is a short description.</span>"
}
},
"name": "Product 12345",
"is_complete": true,
"incomplete_fields": {
"missing_image": false,
"missing_category": false,
"missing_price": false,
"missing_attributes": []
},
"discontinued": false,
"shipping_options": [],
"attribute_set": {
"id": 1,
"name": "Automotive"
},
"product_level": {
"id": 1,
"name": "Products"
},
"product_categories": [
{
"is_primary": false,
"category_id": 1,
"name": "Engine Oil",
"path": "Engine Oil",
"category_set": {
"id": 1,
"name": "default"
}
}
],
"catalogs": [
{
"id": 1,
"name": "Catalog Name"
}
],
"shipping_zones": [
{
"id": 1,
"name": "AU_FREE"
}
],
"media_items": [
{
"id": 1,
"media_item_type": "ImageMediaItem",
"url": "http://s3.amazonaws.com/cc/image1.jpg",
"description": "",
"sort_order": 0,
"is_primary": false,
"is_uploaded": null,
"tag_list": [],
"position": 1
}
],
"inventories": [
{
"id": 1,
"qty": 3,
"stock_availability": "in_stock",
"out_of_stock_threshold": null,
"dispatch_time": 5,
"dispatch_time_unit": "day",
"unit_cost": null,
"style": "static",
"sku": "12345",
"support_shipping": true,
"inventory_source": {
"id": 1,
"name": "MOTUL"
}
}
],
"price_items": [
{
"id": 1,
"amount": 45,
"enabled?": true,
"price_book": {
"id": 1,
"name": "default"
},
"from": null,
"to": null
}
],
"brand": {
"id": 1,
"name": "Brand Name",
"description": null,
"logo_link": ""
},
"dimension": {
"id": 1,
"length": null,
"width": null,
"height": null,
"weight": 5
},
"packed_dimension": {
"id": 2,
"length": null,
"width": null,
"height": null,
"weight": null
}
},
"created_at": "2016-04-15T14:25:38.489+10:00",
"updated_at": "2016-04-27T16:10:51.655+10:00"
}
]
}
Response (tenant version 2. When root_products_only is true. This is the default behaviour):
{
"page": 1,
"per_page": 50,
"total_pages": 1,
"total_entries": 1,
"entries": [
{
"id": 1,
"product_type": "product",
"code": "shirt-a",
"status": "active",
"product_attributes": {
"description": {
"value": "test5",
"base_type": "html"
},
"short_description": {
"value": "test1",
"base_type": "html"
}
},
"name": "Shirt A updated 4",
"discontinued": false,
"children": [
{
"id": 7,
"product_type": "product",
"code": "shirt-a-white",
"status": "active",
"product_attributes": {
"colour": {
"value": "White",
"base_type": "string"
}
},
"name": "shirt-a-white",
"discontinued": false,
"children": [
{
"id": 10,
"product_type": "product",
"code": "shirt-a-white-xlarge",
"status": "active",
"product_attributes": {
"ean": {
"value": "",
"base_type": "string"
},
"gtin": {
"value": "",
"base_type": "string"
},
"hero": {
"value": false,
"base_type": "boolean"
},
"isbn": {
"value": "",
"base_type": "string"
},
"size": {
"value": "",
"base_type": "string"
},
"upca": {
"value": "",
"base_type": "string"
}
},
"name": "shirt-a-white-xlarge",
"discontinued": false,
"children": []
},
{
"id": 8,
"product_type": "product",
"code": "shirt-a-white-small",
"status": "active",
"product_attributes": {
"ean": {
"value": "",
"base_type": "string"
},
"gtin": {
"value": "",
"base_type": "string"
},
"hero": {
"value": false,
"base_type": "boolean"
},
"isbn": {
"value": "",
"base_type": "string"
},
"size": {
"value": "",
"base_type": "string"
},
"upca": {
"value": "",
"base_type": "string"
}
},
"name": "shirt-a-white-small",
"discontinued": false,
"children": []
},
{
"id": 9,
"product_type": "product",
"code": "shirt-a-white-large",
"status": "active",
"product_attributes": {
"ean": {
"value": "",
"base_type": "string"
},
"gtin": {
"value": "",
"base_type": "string"
},
"hero": {
"value": false,
"base_type": "boolean"
},
"isbn": {
"value": "",
"base_type": "string"
},
"size": {
"value": "",
"base_type": "string"
},
"upca": {
"value": "",
"base_type": "string"
}
},
"name": "shirt-a-white-large",
"discontinued": false,
"children": []
}
]
},
{
"id": 2,
"product_type": "product",
"code": "shirt-a-black",
"status": "active",
"product_attributes": {
"colour": {
"value": "black",
"base_type": "string"
}
},
"name": "Shirt A Black updated 2",
"discontinued": false,
"children": [
{
"id": 11,
"product_type": "product",
"code": "shirt-a-black-xlarge",
"status": "active",
"product_attributes": {
"ean": {
"value": "",
"base_type": "string"
},
"gtin": {
"value": "",
"base_type": "string"
},
"hero": {
"value": false,
"base_type": "boolean"
},
"isbn": {
"value": "",
"base_type": "string"
},
"size": {
"value": "",
"base_type": "string"
},
"upca": {
"value": "",
"base_type": "string"
}
},
"name": "shirt-a-black-xlarge",
"discontinued": false,
"children": []
},
{
"id": 3,
"product_type": "product",
"code": "shirt-a-black-small",
"status": "active",
"product_attributes": {
"ean": {
"value": "",
"base_type": "string"
},
"gtin": {
"value": "",
"base_type": "string"
},
"hero": {
"value": false,
"base_type": "boolean"
},
"isbn": {
"value": "",
"base_type": "string"
},
"size": {
"value": "Small",
"base_type": "string"
},
"upca": {
"value": "",
"base_type": "string"
}
},
"name": "Shirt A Black Small updated 1",
"discontinued": false,
"children": []
},
{
"id": 6,
"product_type": "product",
"code": "shirt-a-black-large",
"status": "inactive",
"product_attributes": {
"ean": {
"value": "",
"base_type": "string"
},
"gtin": {
"value": "",
"base_type": "string"
},
"hero": {
"value": false,
"base_type": "boolean"
},
"isbn": {
"value": "",
"base_type": "string"
},
"size": {
"value": "Large",
"base_type": "string"
},
"upca": {
"value": "",
"base_type": "string"
}
},
"name": "shirt-a-black-large",
"discontinued": false,
"children": []
}
]
},
{
"id": 12,
"product_type": "product",
"code": "shirt-a-orange",
"status": "active",
"product_attributes": {
"colour": {
"value": "Orange",
"base_type": "string"
}
},
"name": "shirt-a-orange",
"discontinued": false,
"children": []
}
]
}
]
}
Response (tenant version 2. When root_products_only is false):
{
"page": 1,
"per_page": 50,
"total_pages": 1,
"total_entries": 1,
"entries": [
{
"id": 7,
"product_type": "product",
"code": "shirt-a-white",
"status": "active",
"product_attributes": {
"colour": {
"value": "White",
"base_type": "string"
}
},
"name": "shirt-a-white",
"discontinued": false,
"parent_products": {
"id": 1,
"code": "shirt-a",
"parent_products": {}
},
"children": [
{
"id": 10,
"product_type": "product",
"code": "shirt-a-white-xlarge",
"status": "active",
"product_attributes": {
"ean": {
"value": "",
"base_type": "string"
},
"gtin": {
"value": "",
"base_type": "string"
},
"hero": {
"value": false,
"base_type": "boolean"
},
"isbn": {
"value": "",
"base_type": "string"
},
"size": {
"value": "",
"base_type": "string"
},
"upca": {
"value": "",
"base_type": "string"
}
},
"name": "shirt-a-white-xlarge",
"discontinued": false,
"parent_products": {
"id": 7,
"code": "shirt-a-white",
"parent_products": {
"id": 1,
"code": "shirt-a",
"parent_products": {}
}
},
"children": []
}
]
},
{
"id": 3,
"product_type": "product",
"code": "shirt-a-black-small",
"status": "active",
"product_attributes": {
"ean": {
"value": "",
"base_type": "string"
},
"gtin": {
"value": "",
"base_type": "string"
},
"hero": {
"value": false,
"base_type": "boolean"
},
"isbn": {
"value": "",
"base_type": "string"
},
"size": {
"value": "Small",
"base_type": "string"
},
"upca": {
"value": "",
"base_type": "string"
}
},
"name": "Shirt A Black Small updated 1",
"discontinued": false,
"parent_products": {
"id": 2,
"code": "shirt-a-black",
"parent_products": {
"id": 1,
"code": "shirt-a",
"parent_products": {}
}
},
"children": []
}
]
}
Response (tenant version 5):
{
"page": 1,
"per_page": 50,
"total_pages": 1,
"total_entries": 1,
"entries": [
{
"id": 1775,
"product_type": null,
"code": "shirt-a",
"status": "active",
"product_attributes": null,
"name": "Shirt A",
"class_type": "variation",
"discontinued": false,
"product_class": {
"id": 17,
"name": "Style"
},
"attribute_values": [
{
"attribute_definition_id": 7,
"attribute_definition_code": "country_of_origin",
"data": "Germany"
},
{
"attribute_definition_id": 2,
"attribute_definition_code": "short_description",
"data": "test short description"
},
{
"attribute_definition_id": 14,
"attribute_definition_code": "season",
"data": "Spring"
},
{
"attribute_definition_id": 1,
"attribute_definition_code": "description",
"data": "test description"
}
],
"association_attribute_values": [
{
"attribute_definition_id": 19,
"attribute_definition_code": "npc_association_1",
"associated_code": "npc_entity_1",
"associated_type": "NpcEntity"
}
]
}
]
}
Response with product variations (response_associated_fields=child_product_variations,child_kit_members,parent_product_groups):
{
"page": 1,
"per_page": 50,
"total_pages": 1,
"total_entries": 3,
"entries": [
{
"id": 2,
"code": "t-shirt-red",
"child_product_variations": [
{
"id": 4,
"code": "t-shirt-red-small",
"created_at": "2019-07-22T14:08:52.576+10:00",
"updated_at": "2020-03-17T16:18:45.192+11:00"
},
{
"id": 8,
"code": "t-shirt-red-large",
"created_at": "2019-08-09T11:12:40.425+10:00",
"updated_at": "2019-10-03T10:27:31.592+10:00"
}
]
},
{
"id": 69,
"code": "large-kit",
"child_kit_members": [
{
"id": 28,
"code": "t-shirt-blue-large",
"created_at": "2019-10-31T14:01:19.746+11:00",
"updated_at": "2020-04-14T14:03:31.769+10:00",
"qty": 10
}
]
},
{
"id": 2,
"code": "t-shirt-red",
"parent_product_groups": [
{
"id": 27,
"code": "formal-party-french",
"created_at": "2019-10-25T11:35:01.778+11:00",
"updated_at": "2020-02-07T09:44:55.101+11:00",
"sort_order": null
}
]
}
]
}
| Param name | Description |
|---|---|
|
per_page optional |
Number of objects in one response. Default is 50 Validations:
|
|
page optional |
Page number. Default is 1 Validations:
|
|
created_time_from optional |
ISO_8601 format 2016-05-30T05:13:26Z Validations:
|
|
created_time_to optional |
ISO_8601 format 2016-05-30T05:13:26Z Validations:
|
|
updated_time_from optional |
ISO_8601 format 2016-05-30T05:13:26Z Validations:
|
|
updated_time_to optional |
ISO_8601 format 2016-05-30T05:13:26Z Validations:
|
|
id optional |
Product ID Validations:
|
|
code optional |
Product code Validations:
|
|
name optional |
Product name Validations:
|
|
status optional |
Product status Validations:
|
|
response_product_fields optional |
Version 5 only. One of ‘name’, ‘status’, ‘class_type’. The product information to be included in the product data response. Use comma to join multiple fields. Validations:
|
|
response_associated_fields optional |
Version 5 only. One of ‘product_class’, ‘product_family’, ‘brand’, ‘attribute_values’, ‘association_attribute_values’,‘dimension’, ‘packed_dimension’, ‘product_categories’, ‘catalogs’, ‘shipping_zones’, ‘price_items’, ‘inventories’, ‘media_items’, ‘entity_identifiers’, ‘child_product_variations’, ‘parent_product_kits’, ‘parent_product_groups’, ‘parent_product_variations’, ‘child_kit_members’, ‘child_group_members’. The information related to the product to be included in the product data response. Use comma to join multiple fields. Validations:
|
|
root_products_only optional |
Return products only at the root level. Defaults to true. Only applicable to CC V3 tenants Validations:
|
|
identifier_name optional |
Extra identifier name added via EntityIdentifier endpoint Validations:
|
|
entity_key optional |
Extra entity identifier key added via EntityIdentifier endpoint Validations:
|