PhysicalIdentifiers
List an inventory item's physical identifiers (Preview)
Preview: this operation may change or be removed without a new versioned route or notice period until it is announced as stable (see the API Versioning Policy). Returns all identifiers issued for the item, newest first, including superseded ones (isCurrent=false). Each identifier carries inventoryActive, which is false while the item is soft-deleted. An item with no identifiers returns an empty array.
path Parameters
companyIdThe unique identifier of the company
inventoryIdThe inventory item
Headers
GoSmarter-Api-KeyThe GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
List an inventory item's physical identifiers (Preview) › Responses
The item's identifiers
physicalIdentifierIdcompanyIdinventoryIdidentifierTypeidentifierNamespacegtinidentifierValuebatchLotpayloadissuedAtsupersededAtreissuedFromPhysicalIdentifierIdactivelastModifiedByinventoryActiveisCurrentIssue a physical identifier for an inventory item (Preview)
Preview: this operation may change or be removed without a new versioned route or notice period until it is announced as stable (see the API Versioning Policy). Idempotent: if the item already has a current identifier of the requested type it is returned unchanged (200). Otherwise a new identifier is minted from the company's namespace (201) — a GS1 key (GTIN+serial, GIAI or SSCC) when the company has a GS1 Company Prefix, an internal GSM- code otherwise. Set reissue=true to explicitly supersede the current identifier. With no identifierType, the type of the item's most recent current identifier is used, for a reprint (that identifier is returned) and for a reissue (it is replaced by a new one of the same type); an item with no current identifier gets the default type: GTIN (a serialised GTIN, SGTIN) with a GS1 Company Prefix, INTERNAL without. A GTIN identifier needs a gtin for the item's first GTIN label (400 if missing, including when GTIN is the default); after that gtin may be omitted to reuse the item's existing GTIN, and a supplied gtin must match it (409). Issuing for a soft-deleted item returns 404.
path Parameters
companyIdThe unique identifier of the company
inventoryIdThe inventory item to identify
Headers
GoSmarter-Api-KeyThe GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
Issue a physical identifier for an inventory item (Preview) › Request Body
identifierTypegtinreissueIssue a physical identifier for an inventory item (Preview) › Responses
The item's existing current identifier was returned (no new identifier minted)
Look up a physical identifier by payload (Preview)
Preview: this operation may change or be removed without a new versioned route or notice period until it is announced as stable (see the API Versioning Policy). Accepts a GS1 element string in bracketed form, e.g. (01)09501101530003(21)42, or raw scanner form (GS-separated, optional ]Q3 symbology prefix), or an internal GSM- code. Resolves by identity key (SSCC, GIAI, or GTIN+serial); a stale batch/lot (AI 10) still resolves. Superseded identifiers and labels of hard-deleted items (inventoryId=null) are returned with isCurrent=false. A soft-deleted item's label keeps isCurrent=true (its identifier chain is unchanged) and is flagged with inventoryActive=false. Percent-encode the payload; a literal '+' is kept as '+' (not decoded to a space).
path Parameters
companyIdThe unique identifier of the company
query Parameters
payloadThe scanned or typed identifier payload
Headers
GoSmarter-Api-KeyThe GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
Look up a physical identifier by payload (Preview) › Responses
The matching identifier
physicalIdentifierIdcompanyIdinventoryIdidentifierTypeidentifierNamespacegtinidentifierValuebatchLotpayloadissuedAtsupersededAtreissuedFromPhysicalIdentifierIdactivelastModifiedByinventoryActiveisCurrent
