Skip to main content
PUT
Update Product
V2 Preview: this endpoint is part of the V2 API preview. Breaking changes may occur.

Overview

PUT /products/{productId} Updates one of your own products via Shopify’s productSet mutation. productId can be a Shopify numeric id, a Shopify GID or a MongoDB ObjectId. Fields you leave out keep their current values.
variants, options, metafields and images replace the stored arrays. Send the full desired set.

Path parameters

productId string required. Shopify numeric id, Shopify GID or MongoDB ObjectId of a product owned by your vendor.

Request body

title, descriptionHtml, productType, vendor, brandName, status (ACTIVE | DRAFT | ARCHIVED), handle, tags[], collections[], options[], variants[], metafields[], seo, category, templateSuffix, isDigital, plus:
  • images[] (max 250): product images, { "src": "<https URL>", "altText": "<optional>" }.
  • medias[] (max 250): downloadable files for digital products. Leave it out to keep the current files.
  • descriptionHtml: send "" to clear the description.
  • vendorId (optional): if sent, it must be your own vendor id. Any other vendor returns 403 FORBIDDEN “Vendor tokens can only assign products to their own vendor”. You can’t move a product to another vendor.
The body is strict: unknown fields return 400 VALIDATION_ERROR with a hint. media → use images / medias; published → use status; description / body_html → use descriptionHtml.

Responses

200 Updated
403 Another vendor
400 Old media field
404

Examples

Update title, status and images
Update and tags
Clear the description