v1

latestOpenAPI 3.0.12026-07-242871595.3 MB

INVENTORY

Get all categories of a single item

Retrieves all categories of an item.

get/v3/merchants/{mId}/items/{itemId}/categories

mIdstring required

Merchant identifier.

itemIdstring required

Item identifier.

filterstring

Filter fields to display search results: [modifiedTime, deleted, sortOrder, name, colorCode, id]

expandstring

Expandable fields to display additional nested information: [items]

offsetinteger

Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.

limitinteger

Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000

User-Agentstring required

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

Successful response. Displays all categories information.

idstring

Unique identifier of the category.

namestring required

Category name as it displays in the Register app.

sortOrderinteger

Integer that determines the sort order of the category against other categories.

colorCodestring

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

deletedboolean

Indicates whether the category can be deleted.

modifiedTimeinteger

Time when the category was modified.