curl --request POST \
--url https://api.example.com/vendor/products \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"subtitle": "<string>",
"description": "<string>",
"is_giftcard": false,
"discountable": true,
"images": [
{
"url": "<string>"
}
],
"thumbnail": "<string>",
"handle": "<string>",
"status": "draft",
"external_id": "<string>",
"type_id": "<string>",
"collection_id": "<string>",
"categories": [
{
"id": "<string>"
}
],
"tags": [
{
"id": "<string>"
}
],
"options": [
{
"title": "<string>",
"values": [
"<string>"
]
}
],
"variants": [
{
"title": "<string>",
"sku": "<string>",
"ean": "<string>",
"upc": "<string>",
"barcode": "<string>",
"hs_code": "<string>",
"mid_code": "<string>",
"allow_backorder": false,
"manage_inventory": true,
"variant_rank": 123,
"weight": 123,
"length": 123,
"height": 123,
"width": 123,
"origin_country": "<string>",
"material": "<string>",
"metadata": {},
"prices": [
{
"currency_code": "<string>",
"amount": 123,
"min_quantity": 123,
"max_quantity": 123,
"rules": {}
}
],
"options": {},
"inventory_items": [
{
"inventory_item_id": "<string>",
"required_quantity": 123
}
]
}
],
"weight": 123,
"length": 123,
"height": 123,
"width": 123,
"hs_code": "<string>",
"mid_code": "<string>",
"origin_country": "<string>",
"material": "<string>",
"metadata": {},
"sales_channels": [
{
"id": "<string>"
}
],
"additional_data": {}
}
'{
"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>"
}
}Creates a new product for the authenticated vendor.
curl --request POST \
--url https://api.example.com/vendor/products \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"subtitle": "<string>",
"description": "<string>",
"is_giftcard": false,
"discountable": true,
"images": [
{
"url": "<string>"
}
],
"thumbnail": "<string>",
"handle": "<string>",
"status": "draft",
"external_id": "<string>",
"type_id": "<string>",
"collection_id": "<string>",
"categories": [
{
"id": "<string>"
}
],
"tags": [
{
"id": "<string>"
}
],
"options": [
{
"title": "<string>",
"values": [
"<string>"
]
}
],
"variants": [
{
"title": "<string>",
"sku": "<string>",
"ean": "<string>",
"upc": "<string>",
"barcode": "<string>",
"hs_code": "<string>",
"mid_code": "<string>",
"allow_backorder": false,
"manage_inventory": true,
"variant_rank": 123,
"weight": 123,
"length": 123,
"height": 123,
"width": 123,
"origin_country": "<string>",
"material": "<string>",
"metadata": {},
"prices": [
{
"currency_code": "<string>",
"amount": 123,
"min_quantity": 123,
"max_quantity": 123,
"rules": {}
}
],
"options": {},
"inventory_items": [
{
"inventory_item_id": "<string>",
"required_quantity": 123
}
]
}
],
"weight": 123,
"length": 123,
"height": 123,
"width": 123,
"hs_code": "<string>",
"mid_code": "<string>",
"origin_country": "<string>",
"material": "<string>",
"metadata": {},
"sales_channels": [
{
"id": "<string>"
}
],
"additional_data": {}
}
'{
"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>"
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The title of the product.
The subtitle of the product.
The description of the product.
Whether the product is a gift card.
Whether the product can be discounted.
Images of the product.
Show child attributes
The thumbnail of the product.
A unique handle to identify the product.
The status of the product.
draft, proposed The external ID of the product.
The ID of the product type.
The ID of the collection the product belongs to.
Categories the product belongs to.
Show child attributes
Tags associated with the product.
Show child attributes
Product options.
Show child attributes
Product variants.
Show child attributes
The weight of the product.
The length of the product.
The height of the product.
The width of the product.
The HS code of the product.
The MID code of the product.
The country of origin of the product.
The material composition of the product.
Additional metadata for the product.
Sales channels to associate the product with.
Show child attributes
Additional data to use in products hooks.
Created
A product object with its properties
Show child attributes