Skip to main content

Update an existing product

PUT 
/api/v1/sdk/products/:productId

This endpoint updates an existing product. Supports partial updates - only fields provided in the request are modified.

Authentication: Requires Private API Key (sk_*)

Updatable Fields:

  • Product details: name, description, images, metadata
    • Variants: add new, update existing, or modify variant details
    • Pricing and inventory for existing variants
    • Product status (active/inactive)
    • Categories and tags

Important Notes:

  • Existing variants are not deleted unless explicitly specified
    • Price changes affect new orders immediately
    • Changes propagate to active carts in real-time
    • Inventory updates trigger back-in-stock notifications if applicable

Use Cases:

  • Updating product details and descriptions
    • Price changes and promotional updates
    • Adding or modifying product variants
    • Inventory and availability updates

Error Scenarios:

  • 404 NOT FOUND - Product not found (Error code: PRODUCT_NOT_FOUND)
    • 400 BAD REQUEST - Invalid update data (Error code: INVALID_REQUEST or VALIDATION_ERROR)
    • 401 UNAUTHORIZED - Invalid or missing API key (Error code: INVALID_API_KEY)
    • 403 FORBIDDEN - API key doesn't have access to this store (Error code: NO_STORE_ACCESS)

Request​

Responses​

Product updated successfully