Skip to main content
POST
/
vendor
/
products
/
{id}
Update a Product
curl --request POST \
  --url https://api.example.com/vendor/products/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "discountable": true,
  "is_giftcard": true,
  "options": [
    {
      "id": "<string>",
      "title": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "variants": [
    {
      "id": "<string>",
      "title": "<string>",
      "prices": [
        {
          "id": "<string>",
          "currency_code": "<string>",
          "amount": 123,
          "min_quantity": 123,
          "max_quantity": 123,
          "rules": {}
        }
      ],
      "sku": "<string>",
      "ean": "<string>",
      "upc": "<string>",
      "barcode": "<string>",
      "hs_code": "<string>",
      "mid_code": "<string>",
      "allow_backorder": true,
      "manage_inventory": true,
      "variant_rank": 123,
      "weight": 123,
      "length": 123,
      "height": 123,
      "width": 123,
      "origin_country": "<string>",
      "material": "<string>",
      "metadata": {},
      "options": {}
    }
  ],
  "subtitle": "<string>",
  "description": "<string>",
  "images": [
    {
      "url": "<string>"
    }
  ],
  "thumbnail": "<string>",
  "handle": "<string>",
  "type_id": "<string>",
  "external_id": "<string>",
  "collection_id": "<string>",
  "categories": [
    {
      "id": "<string>"
    }
  ],
  "tags": [
    {
      "id": "<string>"
    }
  ],
  "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>"
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The ID of the Product.

Query Parameters

fields
string

Comma-separated fields to include in the response.

Body

application/json
title
string

The title of the product.

discountable
boolean

Whether the product can be discounted.

is_giftcard
boolean

Whether the product is a gift card.

options
object[]

The product options to update.

variants
object[]

The product variants to update.

subtitle
string | null

The subtitle of the product.

description
string | null

The description of the product.

images
object[]

Images of the product.

thumbnail
string | null

The thumbnail of the product.

handle
string | null

The handle of the product.

type_id
string | null

The ID of the product type.

external_id
string | null

The external ID of the product.

collection_id
string | null

The ID of the collection the product belongs to.

categories
object[]

Product category IDs to associate with the product.

tags
object[]

Product tag IDs to associate with the product.

weight
number | null

The weight of the product.

length
number | null

The length of the product.

height
number | null

The height of the product.

width
number | null

The width of the product.

hs_code
string | null

The HS code of the product.

mid_code
string | null

The MID code of the product.

origin_country
string | null

The country of origin of the product.

material
string | null

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

200 - application/json

OK

product
Product · object

A product object with its properties