Products
Update shipping details
The SKU, weight and size of a physical product. Stock stays as it is. Requires If-Match.
PATCH/stores/{storeId}/v1/products/{id}/physical
sku is up to 64 characters, weight_grams up to 1,000,000, and length_cm, width_cm and height_cm up to 1,000. Send null to clear a field.
Path parameters
- idstringrequired
Headers
- If-Matchstringrequired
- ETag from a GET of this same resource projection.
Request body
- skustring | null
- weight_gramsnumber | null
- length_cmnumber | null
- width_cmnumber | null
- height_cmnumber | null
Response
- dataobjectrequired
- idstring
- namestring
- descriptionstring
- short_descstring | null
- imagestring | null
- imagesarray<string>
- image_altstring | null
- categorystring | null
- Category name.
- slugstring | null
- keywordsarray<string>
- supported_devicesany
- seo_titlestring | null
- seo_descriptionstring | null
- og_imagestring | null
- product_kindstring
digitalservicephysical- statusstring
activeinactive- pricestring
- Price in SAR.
- old_pricestring | null
- Price before discount.
- price_statestring
- required until a price is set; a new product is created inactive with price 0.00.
requiredready - resource_versioninteger
- physicalobject | null
- Shipping details of a physical product, or null for any other kind.
- skustring | null
- weight_gramsnumber | null
- length_cmnumber | null
- width_cmnumber | null
- height_cmnumber | null
- optionsarray<object>
- namestringrequired
- valuesarray<string>required
- variantsarray<object>
- One row per combination of options. Its quantity is under inventory, with inventory:read.
- optionsobjectrequired
- The value of each option, such as {"Size":"M"}.
- skustring | null
- enabledboolean
- executionobject
- Who executed the request: the app, version, installation and store. Field names here are camelCase.
- appIdstring (uuid)
- versionIdstring (uuid)
- installationIdstring (uuid)
- storeIdstring (uuid)
- requestIdstring (uuid)
- generationinteger
- routeEpochinteger
- appAuthEpochinteger
- grantRevisioninteger
- metaobjectrequired
- request_idstring (uuid)
- The request ID; include it in any support request.
Errors
| HTTP | Code | Meaning |
|---|---|---|
| 428 | PRECONDITION_REQUIRED | No If-Match header. |
| 412 | RESOURCE_CHANGED | The resource changed after you read it; read it again. |
| 404 | RESOURCE_NOT_FOUND | The ID does not exist in this store. |
| 422 | PHYSICAL_PRODUCT_REQUIRED | The product is not physical. |
| 422 | INVALID_PHYSICAL_DETAILS | A value is outside its limits. |
| 403 | SCOPE_REQUIRED | The token does not carry the required scope. |
Shared codes are listed in Errors.