GoSmarter Logo
GoSmarter API Gateway

PhysicalIdentifiers


List an inventory item's physical identifiers (Preview)

GET
https://api.gosmarter.ai
/api/company/{companyId}/inventory/{inventoryId}/physical-identifiers

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.

List an inventory item's physical identifiers (Preview) › path Parameters

companyId
​string · uuid · required

The unique identifier of the company

inventoryId
​string · uuid · required

The inventory item

List an inventory item's physical identifiers (Preview) › Headers

GoSmarter-Api-Key
​string · required

The 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

physicalIdentifierId
​string · uuid
companyId
​string · uuid
inventoryId
​string · uuid
identifierType
​string
identifierNamespace
​string
gtin
​string
identifierValue
​string
batchLot
​string
payload
​string
​gs1Element[]
issuedAt
​string · date-time
supersededAt
​string · date-time
reissuedFromPhysicalIdentifierId
​string · uuid
active
​boolean
lastModifiedBy
​string · uuid
inventoryActive
​boolean
isCurrent
​boolean

Issue a physical identifier for an inventory item (Preview)

POST
https://api.gosmarter.ai
/api/company/{companyId}/inventory/{inventoryId}/physical-identifiers

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.

Issue a physical identifier for an inventory item (Preview) › path Parameters

companyId
​string · uuid · required

The unique identifier of the company

inventoryId
​string · uuid · required

The inventory item to identify

Issue a physical identifier for an inventory item (Preview) › Headers

GoSmarter-Api-Key
​string · required

The 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

identifierType
​string
gtin
​string
reissue
​boolean

Issue a physical identifier for an inventory item (Preview) › Responses

The item's existing current identifier was returned (no new identifier minted)

created
​boolean
supersededPhysicalIdentifierId
​string · uuid
warnings
​string[]

Look up a physical identifier by payload (Preview)

GET
https://api.gosmarter.ai
/api/company/{companyId}/physical-identifiers/lookup

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).

Look up a physical identifier by payload (Preview) › path Parameters

companyId
​string · uuid · required

The unique identifier of the company

Look up a physical identifier by payload (Preview) › query Parameters

payload
​string · required

The scanned or typed identifier payload

Look up a physical identifier by payload (Preview) › Headers

GoSmarter-Api-Key
​string · required

The 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

physicalIdentifierId
​string · uuid
companyId
​string · uuid
inventoryId
​string · uuid
identifierType
​string
identifierNamespace
​string
gtin
​string
identifierValue
​string
batchLot
​string
payload
​string
​gs1Element[]
issuedAt
​string · date-time
supersededAt
​string · date-time
reissuedFromPhysicalIdentifierId
​string · uuid
active
​boolean
lastModifiedBy
​string · uuid
inventoryActive
​boolean
isCurrent
​boolean