Products
Update a Product
Storefront API
- Authentication
- Account
- Account / Address
- Account / Credit Cards
- Account / Orders
- Order Status
- Cart
- Cart / Line Items
- Cart / Other
- Cart / Coupons
- Checkout
- Checkout / State
- Checkout / Shipments
- Checkout / Payments
- Checkout / Store Credit
- Stripe
- Products
- Vendors
- Stores
- Taxons
- Countries
- CMS Pages
- Menus
- Wishlists
- Wishlists / Wished Items
- Digital Downloads
Platform API
- Authentication
- Addresses
- Adjustments
- Classifications
- CMS Pages
- CMS Sections
- Countries
- Data Feeds
- Digital Links
- Digital Assets
- Line Items
- Menu Items
- Menus
- Option Types
- Option Values
- Orders
- Payment Methods
- Payments
- Products
- Promotion Actions
- Promotion Categories
- Promotion Rules
- Promotions
- Roles
- Shipments
- Shipping Categories
- Shipping Methods
- States
- Stock Items
- Stock Locations
- Store Credit Categories
- Store Credit Types
- Store Credits
- Tax Categories
- Tax Rates
- Taxonomies
- Taxons
- Users
- Variants
- Vendors
- Webhook Events
- Webhook Subscribers
- Wished Items
- Wishlists
- Zones
Products
Update a Product
Updates a Product
PATCH
/
api
/
v2
/
platform
/
products
/
{id}
curl --request PATCH \
--url http://{defaultHost}/api/v2/platform/products/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"product": {
"name": "<string>",
"description": "<string>",
"available_on": "<string>",
"discontinue_on": "<string>",
"permalink": "<string>",
"meta_description": "<string>",
"meta_keywords": "<string>",
"price": "<string>",
"sku": "<string>",
"deleted_at": "<string>",
"prototype_id": "<string>",
"option_values_hash": "<string>",
"weight": "<string>",
"height": "<string>",
"width": "<string>",
"depth": "<string>",
"shipping_category_id": "<string>",
"tax_category_id": "<string>",
"cost_currency": "<string>",
"cost_price": "<string>",
"compare_at_price": "<string>",
"option_type_ids": "<string>",
"taxon_ids": "<string>",
"public_metadata": {},
"private_metadata": {}
}
}'
{
"data": {
"id": "171",
"type": "product",
"attributes": {
"name": "Twirling Bottom",
"description": "Ut quod iusto optio quos labore. Blanditiis in sunt sequi dolores eveniet reprehenderit maxime. Iusto consequuntur itaque nostrum placeat.\nLaboriosam labore vero voluptatibus suscipit consectetur possimus qui. Ullam commodi corporis cumque voluptatem neque non explicabo. Quaerat atque error nesciunt recusandae rem unde qui quas. Labore perspiciatis consectetur quisquam voluptatibus similique officiis ipsam enim. Labore neque reprehenderit et tempore.\nEa minus nostrum placeat quibusdam laudantium. Illo voluptates in suscipit consequatur harum. Omnis tempora facilis distinctio quos repudiandae ex sapiente. Amet optio temporibus voluptas doloribus.\nOdio at porro commodi repudiandae quia quas. Ut sequi atque accusamus voluptatum consequatur delectus explicabo. Nobis laboriosam facere molestias consectetur saepe totam eos ea. Possimus atque adipisci sequi dolorum excepturi quo. Ad esse dolorum accusantium fugiat quaerat.\nVoluptas libero magnam earum reprehenderit ullam at veritatis. Magni culpa id quidem hic ad. Quidem ipsum est vero ut eaque veniam. Corrupti sint ratione maxime aspernatur itaque quo nostrum. Qui architecto ducimus quisquam iste saepe ullam.",
"available_on": "2021-11-08T19:34:54.192Z",
"deleted_at": null,
"slug": "product-1706992",
"meta_description": null,
"meta_keywords": null,
"created_at": "2022-11-08T19:34:54.210Z",
"updated_at": "2022-11-08T19:34:54.468Z",
"promotionable": true,
"meta_title": null,
"discontinue_on": null,
"public_metadata": {},
"private_metadata": {},
"status": "active",
"make_active_at": "2021-11-08T19:34:54.192Z",
"display_compare_at_price": null,
"display_price": "$33.21",
"purchasable": true,
"in_stock": false,
"backorderable": true,
"available": true,
"currency": "USD",
"price": "33.21",
"compare_at_price": null
},
"relationships": {
"tax_category": {
"data": {
"id": "112",
"type": "tax_category"
}
},
"primary_variant": {
"data": {
"id": "238",
"type": "variant"
}
},
"default_variant": {
"data": {
"id": "238",
"type": "variant"
}
},
"variants": {
"data": []
},
"option_types": {
"data": []
},
"product_properties": {
"data": []
},
"taxons": {
"data": []
},
"images": {
"data": []
}
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Query Parameters
Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>
Body
application/json
Was this page helpful?
curl --request PATCH \
--url http://{defaultHost}/api/v2/platform/products/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"product": {
"name": "<string>",
"description": "<string>",
"available_on": "<string>",
"discontinue_on": "<string>",
"permalink": "<string>",
"meta_description": "<string>",
"meta_keywords": "<string>",
"price": "<string>",
"sku": "<string>",
"deleted_at": "<string>",
"prototype_id": "<string>",
"option_values_hash": "<string>",
"weight": "<string>",
"height": "<string>",
"width": "<string>",
"depth": "<string>",
"shipping_category_id": "<string>",
"tax_category_id": "<string>",
"cost_currency": "<string>",
"cost_price": "<string>",
"compare_at_price": "<string>",
"option_type_ids": "<string>",
"taxon_ids": "<string>",
"public_metadata": {},
"private_metadata": {}
}
}'
{
"data": {
"id": "171",
"type": "product",
"attributes": {
"name": "Twirling Bottom",
"description": "Ut quod iusto optio quos labore. Blanditiis in sunt sequi dolores eveniet reprehenderit maxime. Iusto consequuntur itaque nostrum placeat.\nLaboriosam labore vero voluptatibus suscipit consectetur possimus qui. Ullam commodi corporis cumque voluptatem neque non explicabo. Quaerat atque error nesciunt recusandae rem unde qui quas. Labore perspiciatis consectetur quisquam voluptatibus similique officiis ipsam enim. Labore neque reprehenderit et tempore.\nEa minus nostrum placeat quibusdam laudantium. Illo voluptates in suscipit consequatur harum. Omnis tempora facilis distinctio quos repudiandae ex sapiente. Amet optio temporibus voluptas doloribus.\nOdio at porro commodi repudiandae quia quas. Ut sequi atque accusamus voluptatum consequatur delectus explicabo. Nobis laboriosam facere molestias consectetur saepe totam eos ea. Possimus atque adipisci sequi dolorum excepturi quo. Ad esse dolorum accusantium fugiat quaerat.\nVoluptas libero magnam earum reprehenderit ullam at veritatis. Magni culpa id quidem hic ad. Quidem ipsum est vero ut eaque veniam. Corrupti sint ratione maxime aspernatur itaque quo nostrum. Qui architecto ducimus quisquam iste saepe ullam.",
"available_on": "2021-11-08T19:34:54.192Z",
"deleted_at": null,
"slug": "product-1706992",
"meta_description": null,
"meta_keywords": null,
"created_at": "2022-11-08T19:34:54.210Z",
"updated_at": "2022-11-08T19:34:54.468Z",
"promotionable": true,
"meta_title": null,
"discontinue_on": null,
"public_metadata": {},
"private_metadata": {},
"status": "active",
"make_active_at": "2021-11-08T19:34:54.192Z",
"display_compare_at_price": null,
"display_price": "$33.21",
"purchasable": true,
"in_stock": false,
"backorderable": true,
"available": true,
"currency": "USD",
"price": "33.21",
"compare_at_price": null
},
"relationships": {
"tax_category": {
"data": {
"id": "112",
"type": "tax_category"
}
},
"primary_variant": {
"data": {
"id": "238",
"type": "variant"
}
},
"default_variant": {
"data": {
"id": "238",
"type": "variant"
}
},
"variants": {
"data": []
},
"option_types": {
"data": []
},
"product_properties": {
"data": []
},
"taxons": {
"data": []
},
"images": {
"data": []
}
}
}
}