POST
/
vendor
/
products
{
  "product": {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z",
    "title": "<string>",
    "subtitle": "<string>",
    "description": "<string>",
    "handle": "<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",
      "deleted_at": "2023-11-07T05:31:56Z",
      "title": "<string>",
      "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",
        "deleted_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "handle": "<string>",
        "is_active": true,
        "is_internal": true,
        "rank": 123,
        "parent_category": {},
        "category_children": [
          {}
        ],
        "metadata": {
          "car": "white"
        }
      }
    ],
    "variants": [
      {
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z",
        "title": "<string>",
        "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",
            "deleted_at": "2023-11-07T05:31:56Z",
            "value": "<string>",
            "metadata": {
              "car": "white"
            }
          }
        ],
        "metadata": {
          "car": "white"
        }
      }
    ],
    "options": [
      {
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z",
        "title": "<string>",
        "values": [
          {
            "id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z",
            "value": "<string>",
            "metadata": {
              "car": "white"
            }
          }
        ],
        "metadata": {
          "car": "white"
        }
      }
    ],
    "images": [
      {
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z",
        "url": "<string>",
        "rank": 123,
        "metadata": {
          "car": "white"
        }
      }
    ],
    "discountable": true,
    "external_id": "<string>",
    "metadata": {
      "car": "white"
    },
    "rating": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
title
string
required

The title of the product.

subtitle
string

The subtitle of the product.

description
string

The description of the product.

is_giftcard
boolean
default:false

Whether the product is a gift card.

discountable
boolean
default:true

Whether the product can be discounted.

images
object[]

Images of the product.

thumbnail
string

The thumbnail of the product.

handle
string

A unique handle to identify the product.

status
enum<string>
default:draft

The status of the product.

Available options:
draft,
proposed
external_id
string

The external ID of the product.

type_id
string

The ID of the product type.

collection_id
string

The ID of the collection the product belongs to.

categories
object[]

Categories the product belongs to.

tags
object[]

Tags associated with the product.

options
object[]

Product options.

variants
object[]

Product variants.

weight
number

The weight of the product.

length
number

The length of the product.

height
number

The height of the product.

width
number

The width of the product.

hs_code
string

The HS code of the product.

mid_code
string

The MID code of the product.

origin_country
string

The country of origin of the product.

material
string

The material composition of the product.

metadata
object

Additional metadata for the product.

sales_channels
object[]

Sales channels to associate the product with.

additional_data
object

Additional data to use in products hooks.

Response

201 - application/json

Created

product
object

A product object with its properties