API Documentation
- GETList Products
- POSTCreate a Product
- GETGet a Product
- POSTUpdate a Product
- DELDelete a Product
- GETGet Product Applicable Attributes
- POSTAssign brand to the Product
- POSTCreate option for product
- POSTUpdate a Product option
- DELDelete a Product option
- POSTUpdate a Product status
- POSTCreate variant for product
- POSTUpdate a Product variant
- DELDelete a Product variant
- GET
{
"product": {
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"title": "<string>",
"handle": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"subtitle": "<string>",
"description": "<string>",
"is_giftcard": true,
"status": "draft",
"thumbnail": "<string>",
"width": 123,
"weight": 123,
"length": 123,
"height": 123,
"origin_country": "<string>",
"hs_code": "<string>",
"mid_code": "<string>",
"material": "<string>",
"collection": {
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"title": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"handle": "<string>",
"metadata": {
"car": "white"
}
},
"type": {
"id": "<string>",
"value": "<string>",
"metadata": {
"car": "white"
}
},
"tags": [
{
"id": "<string>",
"value": "<string>",
"metadata": {
"car": "white"
}
}
],
"categories": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"handle": "<string>",
"is_active": true,
"is_internal": true,
"rank": 123,
"parent_category": "<unknown>",
"category_children": "<array>",
"metadata": {
"car": "white"
}
}
],
"variants": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"title": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"sku": "<string>",
"barcode": "<string>",
"ean": "<string>",
"upc": "<string>",
"allow_backorder": true,
"manage_inventory": true,
"hs_code": "<string>",
"origin_country": "<string>",
"mid_code": "<string>",
"material": "<string>",
"weight": 123,
"length": 123,
"height": 123,
"width": 123,
"options": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"value": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {
"car": "white"
}
}
],
"metadata": {
"car": "white"
}
}
],
"options": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"title": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"values": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"value": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {
"car": "white"
}
}
],
"metadata": {
"car": "white"
}
}
],
"images": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"url": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"rank": 123,
"metadata": {
"car": "white"
}
}
],
"discountable": true,
"external_id": "<string>",
"metadata": {
"car": "white"
},
"rating": "<string>"
}
}Create option for product
Creates option for product.
{
"product": {
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"title": "<string>",
"handle": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"subtitle": "<string>",
"description": "<string>",
"is_giftcard": true,
"status": "draft",
"thumbnail": "<string>",
"width": 123,
"weight": 123,
"length": 123,
"height": 123,
"origin_country": "<string>",
"hs_code": "<string>",
"mid_code": "<string>",
"material": "<string>",
"collection": {
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"title": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"handle": "<string>",
"metadata": {
"car": "white"
}
},
"type": {
"id": "<string>",
"value": "<string>",
"metadata": {
"car": "white"
}
},
"tags": [
{
"id": "<string>",
"value": "<string>",
"metadata": {
"car": "white"
}
}
],
"categories": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"handle": "<string>",
"is_active": true,
"is_internal": true,
"rank": 123,
"parent_category": "<unknown>",
"category_children": "<array>",
"metadata": {
"car": "white"
}
}
],
"variants": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"title": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"sku": "<string>",
"barcode": "<string>",
"ean": "<string>",
"upc": "<string>",
"allow_backorder": true,
"manage_inventory": true,
"hs_code": "<string>",
"origin_country": "<string>",
"mid_code": "<string>",
"material": "<string>",
"weight": 123,
"length": 123,
"height": 123,
"width": 123,
"options": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"value": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {
"car": "white"
}
}
],
"metadata": {
"car": "white"
}
}
],
"options": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"title": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"values": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"value": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {
"car": "white"
}
}
],
"metadata": {
"car": "white"
}
}
],
"images": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"url": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"rank": 123,
"metadata": {
"car": "white"
}
}
],
"discountable": true,
"external_id": "<string>",
"metadata": {
"car": "white"
},
"rating": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the Product.
Query Parameters
Comma-separated fields to include in the response.
Body
Response
OK
A product object with its properties
Show child attributes
Show child attributes
The unique identifier of the product.
The date with timezone at which the resource was created.
The date with timezone at which the resource was last updated.
The title of the product.
A unique handle for the product.
The date with timezone at which the resource was deleted.
The subtitle of the product.
A description of the product.
Whether the product is a gift card.
The status of the product.
draft, proposed, published, rejected URL to the product's thumbnail.
The width of the product.
The weight of the product.
The length of the product.
The height of the product.
The origin country of the product.
The HS Code of the product.
The MID Code of the product.
The material of the product.
The associated product collection.
Show child attributes
Show child attributes
The unique identifier of the product collection.
The date with timezone at which the resource was created.
The date with timezone at which the resource was last updated.
The title of the product collection.
The date with timezone at which the resource was deleted.
The handle of the product collection.
An optional key-value map with additional details.
{ "car": "white" }The associated product categories.
Show child attributes
Show child attributes
The unique identifier of the product category.
The date with timezone at which the resource was created.
The date with timezone at which the resource was last updated.
The name of the product category.
The date with timezone at which the resource was deleted.
The handle of the product category.
Whether the product category is active.
Whether the product category is internal.
The rank of the category among sibling categories.
The parent category.
Show child attributes
Show child attributes
The child categories.
An optional key-value map with additional details.
{ "car": "white" }The associated product variants.
Show child attributes
Show child attributes
The unique identifier of the product variant.
The date with timezone at which the resource was created.
The date with timezone at which the resource was last updated.
The title of the product variant.
The date with timezone at which the resource was deleted.
The SKU of the product variant.
The barcode of the product variant.
The EAN of the product variant.
The UPC of the product variant.
Whether the product variant can be ordered when it's out of stock.
Whether the product variant's inventory should be managed by the core system.
The HS Code of the product variant.
The origin country of the product variant.
The MID Code of the product variant.
The material of the product variant.
The weight of the product variant.
The length of the product variant.
The height of the product variant.
The width of the product variant.
The associated product option values.
Show child attributes
Show child attributes
The unique identifier of the product option value.
The date with timezone at which the resource was created.
The date with timezone at which the resource was last updated.
The value of the product option value.
The date with timezone at which the resource was deleted.
An optional key-value map with additional details.
{ "car": "white" }An optional key-value map with additional details.
{ "car": "white" }The associated product options.
Show child attributes
Show child attributes
The unique identifier of the product option.
The date with timezone at which the resource was created.
The date with timezone at which the resource was last updated.
The title of the product option.
The date with timezone at which the resource was deleted.
The associated product option values.
Show child attributes
Show child attributes
The unique identifier of the product option value.
The date with timezone at which the resource was created.
The date with timezone at which the resource was last updated.
The value of the product option value.
The date with timezone at which the resource was deleted.
An optional key-value map with additional details.
{ "car": "white" }An optional key-value map with additional details.
{ "car": "white" }The associated product images.
Show child attributes
Show child attributes
The unique identifier of the product image.
The date with timezone at which the resource was created.
The date with timezone at which the resource was last updated.
The URL of the product image.
The date with timezone at which the resource was deleted.
The rank of the product image.
An optional key-value map with additional details.
{ "car": "white" }Whether the product can be discounted.
The ID of the product in an external system.
An optional key-value map with additional details.
{ "car": "white" }The average rating from customer reviews