v1

latestOpenAPI 3.0.12026-07-242871595.3 MB

INVENTORY

Update Subcategory Information

Updates existing information for a specific subcategory. This operation allows you to rename the subcategory or change its assigned color code. For more information, see Manage Subcategories.

put/v3/merchants/{mId}/categories/{categoryId}/sub_categories/{subcategoryId}

Path parameters

mIdstring required

Merchant identifier.

categoryIdstring required

Unique identifier of the parent category.

subcategoryIdstring required

Unique identifier of the subcategory.

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

Request body

namestring

Subcategory name as it displays in the Register app.

colorCodestring

Hex code of the color assigned to the subcategory and its items. Format: #fff, #ffffff, or #ffffffff.

Example request

{
  "name": "Greek Salad with chicken",
  "colorCode": "#FA6400"
}

Response

Successful response. Subcategory information updated.

idstring required

Unique identifier of the subcategory.

namestring required

Subcategory name as it displays in the Register app.

sortOrderinteger required

Ascending or descending sort order of the subcategory.

colorCodestring

Hex code of the color assigned to the subcategory and its items. Format: #fff, #ffffff, or #ffffffff.

deletedboolean required

Indicates whether the subcategory can be deleted.

Example response

{
  "id": "string",
  "name": "Greek Salad with chicken",
  "parentCategory": {
    "id": "string"
  },
  "colorCode": "#FA6400"
}