Sign in

v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
INVENTORY

Get all categories

Retrieves all categories. Items display on the Register app within categories in the order in which they are added to a category. Items may be associated with one or more categories or may not be associated with any category. Categories display in the Register app based on the sort order value for each category.

get/v3/merchants/{mId}/categories

Path parameters

mIdstring required

Merchant identifier.

Query parameters

filterstring

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

expandstring

Additional information provided as an expanded response: [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

Headers

User-Agentstring required

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

Response

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.