Developers

Products

Markdown

Publish or hide a product

Shows a product that has a price in the store, or hides it. The price and description stay as they are.

PATCH/stores/{storeId}/v1/products/{id}/status

Path parameters

idstringrequired

Request body

statusstringrequired
active inactive

Response

dataobjectrequired
product_idstring
statusstring
active inactive
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.
409PRODUCT_PRICE_REQUIREDThe product has no price yet, so it cannot be published.
422INVALID_PRODUCT_STATUSstatus is not active or inactive.
403SCOPE_REQUIREDThe token does not carry the required scope.

Shared codes are listed in Errors.

    ↑↓ moveEnter openEsc close