Update a category

Name, image, sort order and visibility. Requires If-Match.

PATCH/stores/{storeId}/v1/categories/{id}

Scopecategories:writeManage categories

Path parameters

idstringrequired

Headers

If-Matchstringrequired

Request body

namestring
imagestring | null
visibleboolean
sort_orderinteger

Response

dataobjectrequired
idinteger
namestring
imagestring | null
sort_orderinteger
visibleboolean
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

HTTP	Code	Meaning
428	`PRECONDITION_REQUIRED`	No If-Match header.
412	`RESOURCE_CHANGED`	The resource changed after you read it; read it again.

Shared codes are listed in Errors.

curl -X PATCH "https://larm.sa/stores/$STORE_ID/v1/categories/12" \ -H "Authorization: Bearer $ACCESS_TOKEN" \ -H "If-Match: $ETAG" \ -H "Content-Type: application/json" \ -d '{ "visible": false }'

{ "data": { "id": 12, "name": "Top-up cards", "image": null, "sort_order": 2, "visible": false, "resource_version": 4 }, "execution": { "appId": "1f2e3d4c-5b6a-4978-8695-a4b3c2d1e0f9", "versionId": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "installationId": "c7e4a1f2-6b3d-4e8a-9c05-1d2f3a4b5c6d", "storeId": "5b1d7a62-0c4e-4f38-9a51-2e7b3c9d8f10", "requestId": "3f0c2b8e-7a51-4c1e-9d0a-5b6f1e2d4c3a", "generation": 1, "routeEpoch": 4, "appAuthEpoch": 1, "grantRevision": 2 }, "meta": { "request_id": "3f0c2b8e-7a51-4c1e-9d0a-5b6f1e2d4c3a" } }