Manage Products
Manage products to create, update, or delete them.
In: header
Query Parameters
Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.
Request Body
application/json
The products to create.
The products to update.
The products to delete.
Response Body
application/json
application/json
text/plain
application/json
application/json
application/json
application/json
curl -X POST "https://{tenant}.api.myxclade.com/admin/products/batch" \ -H "Content-Type: application/json" \ -d '{}'{
"created": [
{
"collection": {
"id": "string",
"title": "string",
"handle": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"products": [
{
"collection": {
"id": "string",
"title": "string",
"handle": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"products": [
{}
],
"metadata": {}
},
"categories": [
{
"category_children": [
{
"category_children": [
{}
],
"parent_category": {},
"products": [
{}
],
"name": "string",
"description": "string",
"id": "string",
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"handle": "string",
"deleted_at": "2019-08-24T14:15:22Z",
"is_active": true,
"is_internal": true,
"rank": 0,
"parent_category_id": "string"
}
],
"parent_category": {
"category_children": [
{}
],
"parent_category": {},
"products": [
{}
],
"name": "string",
"description": "string",
"id": "string",
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"handle": "string",
"deleted_at": "2019-08-24T14:15:22Z",
"is_active": true,
"is_internal": true,
"rank": 0,
"parent_category_id": "string"
},
"products": [
{}
],
"name": "string",
"description": "string",
"id": "string",
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"handle": "string",
"deleted_at": "2019-08-24T14:15:22Z",
"is_active": true,
"is_internal": true,
"rank": 0,
"parent_category_id": "string"
}
],
"variants": [
{}
],
"type": {
"id": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"metadata": {}
},
"tags": [
{
"id": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"metadata": {}
}
],
"length": 0,
"title": "string",
"status": "draft",
"options": [
{
"id": "string",
"title": "string",
"product": {},
"product_id": "string",
"values": [
{
"id": "string",
"value": "string",
"option": {},
"option_id": "string",
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
],
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
],
"description": "string",
"id": "string",
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"handle": "string",
"subtitle": "string",
"is_giftcard": true,
"thumbnail": "string",
"width": 0,
"weight": 0,
"height": 0,
"origin_country": "string",
"hs_code": "string",
"mid_code": "string",
"material": "string",
"collection_id": "string",
"type_id": "string",
"images": [
{
"id": "string",
"url": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"metadata": {},
"rank": 0
}
],
"discountable": true,
"external_id": "string",
"deleted_at": "2019-08-24T14:15:22Z"
}
],
"metadata": {}
},
"categories": [
{
"category_children": [
{}
],
"parent_category": {},
"products": [
{}
],
"name": "string",
"description": "string",
"id": "string",
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"handle": "string",
"deleted_at": "2019-08-24T14:15:22Z",
"is_active": true,
"is_internal": true,
"rank": 0,
"parent_category_id": "string"
}
],
"sales_channels": [
{
"id": "string",
"name": "string",
"description": "string",
"is_disabled": true,
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
],
"variants": [
{
"prices": [
{
"id": "string",
"title": "string",
"currency_code": "usd",
"amount": 0,
"raw_amount": {},
"min_quantity": 0,
"max_quantity": 0,
"price_set_id": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
],
"id": "string",
"title": "string",
"sku": "string",
"barcode": "string",
"ean": "string",
"upc": "string",
"allow_backorder": true,
"manage_inventory": true,
"inventory_quantity": 0,
"hs_code": "string",
"origin_country": "string",
"mid_code": "string",
"material": "string",
"weight": 0,
"length": 0,
"height": 0,
"width": 0,
"variant_rank": 0,
"options": [
{
"id": "string",
"value": "string",
"option": {
"id": "string",
"title": "string",
"product": {},
"product_id": "string",
"values": [
{}
],
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
},
"option_id": "string",
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
],
"product": {},
"product_id": "string",
"calculated_price": {
"id": "string",
"is_calculated_price_price_list": true,
"is_calculated_price_tax_inclusive": true,
"calculated_amount": 0,
"calculated_amount_with_tax": 0,
"calculated_amount_without_tax": 0,
"is_original_price_price_list": true,
"is_original_price_tax_inclusive": true,
"original_amount": 0,
"currency_code": "usd",
"calculated_price": {},
"original_price": {},
"original_amount_with_tax": 0,
"original_amount_without_tax": 0
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"metadata": {},
"inventory_items": [
{
"id": "string",
"variant_id": "string",
"variant": {},
"inventory_item_id": "string",
"inventory": {
"id": "string",
"sku": "string",
"origin_country": "string",
"hs_code": "string",
"requires_shipping": true,
"mid_code": "string",
"material": "string",
"weight": 0,
"length": 0,
"height": 0,
"width": 0,
"title": "string",
"description": "string",
"thumbnail": "string",
"metadata": {},
"location_levels": [
{
"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"inventory_item_id": "string",
"location_id": "string",
"stocked_quantity": 0,
"reserved_quantity": 0,
"incoming_quantity": 0,
"metadata": {},
"inventory_item": {},
"available_quantity": 0
}
]
},
"required_quantity": 0
}
]
}
],
"type": {
"id": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"metadata": {}
},
"tags": [
{
"id": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"metadata": {}
}
],
"length": 0,
"title": "string",
"status": "draft",
"options": [
{
"id": "string",
"title": "string",
"product": {},
"product_id": "string",
"values": [
{}
],
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
],
"description": "string",
"id": "string",
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"handle": "string",
"subtitle": "string",
"is_giftcard": true,
"thumbnail": "string",
"width": 0,
"weight": 0,
"height": 0,
"origin_country": "string",
"hs_code": "string",
"mid_code": "string",
"material": "string",
"collection_id": "string",
"type_id": "string",
"images": [
{
"id": "string",
"url": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"metadata": {},
"rank": 0
}
],
"discountable": true,
"external_id": "string",
"deleted_at": "2019-08-24T14:15:22Z",
"shipping_profile": {
"id": "string",
"name": "string",
"type": "string",
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
}
],
"updated": [
{
"collection": {
"id": "string",
"title": "string",
"handle": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"products": [
{
"collection": {
"id": "string",
"title": "string",
"handle": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"products": [
{}
],
"metadata": {}
},
"categories": [
{
"category_children": [
{
"category_children": [
{}
],
"parent_category": {},
"products": [
{}
],
"name": "string",
"description": "string",
"id": "string",
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"handle": "string",
"deleted_at": "2019-08-24T14:15:22Z",
"is_active": true,
"is_internal": true,
"rank": 0,
"parent_category_id": "string"
}
],
"parent_category": {
"category_children": [
{}
],
"parent_category": {},
"products": [
{}
],
"name": "string",
"description": "string",
"id": "string",
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"handle": "string",
"deleted_at": "2019-08-24T14:15:22Z",
"is_active": true,
"is_internal": true,
"rank": 0,
"parent_category_id": "string"
},
"products": [
{}
],
"name": "string",
"description": "string",
"id": "string",
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"handle": "string",
"deleted_at": "2019-08-24T14:15:22Z",
"is_active": true,
"is_internal": true,
"rank": 0,
"parent_category_id": "string"
}
],
"variants": [
{}
],
"type": {
"id": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"metadata": {}
},
"tags": [
{
"id": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"metadata": {}
}
],
"length": 0,
"title": "string",
"status": "draft",
"options": [
{
"id": "string",
"title": "string",
"product": {},
"product_id": "string",
"values": [
{
"id": "string",
"value": "string",
"option": {},
"option_id": "string",
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
],
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
],
"description": "string",
"id": "string",
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"handle": "string",
"subtitle": "string",
"is_giftcard": true,
"thumbnail": "string",
"width": 0,
"weight": 0,
"height": 0,
"origin_country": "string",
"hs_code": "string",
"mid_code": "string",
"material": "string",
"collection_id": "string",
"type_id": "string",
"images": [
{
"id": "string",
"url": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"metadata": {},
"rank": 0
}
],
"discountable": true,
"external_id": "string",
"deleted_at": "2019-08-24T14:15:22Z"
}
],
"metadata": {}
},
"categories": [
{
"category_children": [
{}
],
"parent_category": {},
"products": [
{}
],
"name": "string",
"description": "string",
"id": "string",
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"handle": "string",
"deleted_at": "2019-08-24T14:15:22Z",
"is_active": true,
"is_internal": true,
"rank": 0,
"parent_category_id": "string"
}
],
"sales_channels": [
{
"id": "string",
"name": "string",
"description": "string",
"is_disabled": true,
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
],
"variants": [
{
"prices": [
{
"id": "string",
"title": "string",
"currency_code": "usd",
"amount": 0,
"raw_amount": {},
"min_quantity": 0,
"max_quantity": 0,
"price_set_id": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
],
"id": "string",
"title": "string",
"sku": "string",
"barcode": "string",
"ean": "string",
"upc": "string",
"allow_backorder": true,
"manage_inventory": true,
"inventory_quantity": 0,
"hs_code": "string",
"origin_country": "string",
"mid_code": "string",
"material": "string",
"weight": 0,
"length": 0,
"height": 0,
"width": 0,
"variant_rank": 0,
"options": [
{
"id": "string",
"value": "string",
"option": {
"id": "string",
"title": "string",
"product": {},
"product_id": "string",
"values": [
{}
],
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
},
"option_id": "string",
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
],
"product": {},
"product_id": "string",
"calculated_price": {
"id": "string",
"is_calculated_price_price_list": true,
"is_calculated_price_tax_inclusive": true,
"calculated_amount": 0,
"calculated_amount_with_tax": 0,
"calculated_amount_without_tax": 0,
"is_original_price_price_list": true,
"is_original_price_tax_inclusive": true,
"original_amount": 0,
"currency_code": "usd",
"calculated_price": {},
"original_price": {},
"original_amount_with_tax": 0,
"original_amount_without_tax": 0
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"metadata": {},
"inventory_items": [
{
"id": "string",
"variant_id": "string",
"variant": {},
"inventory_item_id": "string",
"inventory": {
"id": "string",
"sku": "string",
"origin_country": "string",
"hs_code": "string",
"requires_shipping": true,
"mid_code": "string",
"material": "string",
"weight": 0,
"length": 0,
"height": 0,
"width": 0,
"title": "string",
"description": "string",
"thumbnail": "string",
"metadata": {},
"location_levels": [
{
"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"inventory_item_id": "string",
"location_id": "string",
"stocked_quantity": 0,
"reserved_quantity": 0,
"incoming_quantity": 0,
"metadata": {},
"inventory_item": {},
"available_quantity": 0
}
]
},
"required_quantity": 0
}
]
}
],
"type": {
"id": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"metadata": {}
},
"tags": [
{
"id": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"metadata": {}
}
],
"length": 0,
"title": "string",
"status": "draft",
"options": [
{
"id": "string",
"title": "string",
"product": {},
"product_id": "string",
"values": [
{}
],
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
],
"description": "string",
"id": "string",
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"handle": "string",
"subtitle": "string",
"is_giftcard": true,
"thumbnail": "string",
"width": 0,
"weight": 0,
"height": 0,
"origin_country": "string",
"hs_code": "string",
"mid_code": "string",
"material": "string",
"collection_id": "string",
"type_id": "string",
"images": [
{
"id": "string",
"url": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"metadata": {},
"rank": 0
}
],
"discountable": true,
"external_id": "string",
"deleted_at": "2019-08-24T14:15:22Z",
"shipping_profile": {
"id": "string",
"name": "string",
"type": "string",
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
}
],
"deleted": {
"ids": [
"string"
],
"object": "product",
"deleted": true
}
}{
"message": "Discount must be set to dynamic",
"type": "not_allowed"
}"Unauthorized"{
"message": "Entity with id 1 was not found",
"type": "not_found"
}{
"code": "unknown_error",
"message": "The request conflicted with another request. You may retry the request with the provided Idempotency-Key.",
"type": "QueryRunnerAlreadyReleasedError"
}{
"code": "invalid_request_error",
"message": "Discount with code TEST already exists.",
"type": "duplicate_error"
}{
"code": "api_error",
"message": "An error occured while hashing password",
"type": "database_error"
}Create Product
Create a product.
Export Products
Start a product export process to retrieve a CSV of exported products. You'll receive in the response the transaction ID of the workflow generating the CSV file. To check the status of the execution, send a GET request to `/admin/workflows-executions/export-products/:transaction-id`. Once the execution finishes successfully, a notification is created for the export. You can retrieve the notifications using the `/admin/notification` API route to retrieve the file's download URL.