Developers

Products

Markdown

Get a product

The full product, with an ETag header for later updates.

GET/stores/{storeId}/v1/products/{id}

Path parameters

idstringrequired

Response

dataobjectrequired
idinteger
namestring
descriptionstring
short_descstring | null
imagestring | null
imagesarray<string>
image_altstring | null
categorystring | null
Category name.
slugstring | null
keywordsarray<string>
supported_devicesobject
seo_titlestring | null
seo_descriptionstring | null
og_imagestring | null
product_kindobject
digital service physical
statusobject
active inactive
pricestring
Price in SAR.
old_pricestring | null
Price before discount.
price_stateobject
required until a price is set; a new product is created inactive with price 0.00.required ready
resource_versioninteger
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

HTTPCodeMeaning
404RESOURCE_NOT_FOUNDThe ID does not exist in this store.

Shared codes are listed in Errors.

    ↑↓ moveEnter openEsc close