Create Product Alias

Required permission: write_products

Add an alias (alternate barcode) to a product. Scanning the alias barcode resolves to the product, with quantity units per scan. The barcode must not already be used by another alias or product of the same client. Product aliases must be enabled for the organization.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required
≥ 1

The ID of the product to add the alias to.

string
required
length between 1 and 255

The alias barcode. Surrounding spaces are trimmed. Must be unique among the client's product aliases and product barcodes.

integer
required
≥ 1

The number of units of the product that one scan of the alias barcode represents. Use 1 for a plain alternate barcode.

string
required
length between 1 and 255

The unit of measurement for the alias (e.g. each, case, pallet).

Responses

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