Create or Update Item

Creates or updates a single POS item.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This endpoint can be used to create or update a single POS item.

❗️

Don't use this endpoint to upload the entire product structure.

This is for small updates (for example, when a new item gets added to the catalogue at the POS). Do not make multiple requests to this endpoint with the goal of uploading the entire catalogue, upload items in bulk via the Create Items and Groups endpoint.

We will use the POS ID to look up an existing product. If none is found, we try to look for a product with a matching PLU. Only if an item still can't be found, this endpoint creates a new one.

The POS ID takes precedence over the PLU when looking up a product, so this can be used to update a product's PLU code.

Body Params
string
required

A location ID.

string

The item's ID in the POS.

string
required

The item PLU identifier. This value must be unique.

string
required

The item name.

string
required

The POS ID of the group that the product belongs to.

float
required

The sell price for one unit of the item.

float
required

The tax rate.

boolean
Defaults to true

If false, the product will be marked as inactive.

boolean
Defaults to false

Whether the product is a modifier.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json