Skip to main content

Container Type Management API

Version 1.0 — April 2026

Authentication: All requests require an IdToken from the Login API. See Authentication to obtain one and Errors for authorization errors.

Create Container Types API​

Create Container Types API allows you to create one or multiple container types. Container types define the classification for containers (e.g., Bin, Pallet, Tote).

Endpoint Details​

  • URL: https://api.xemelgo.com/graphql
  • Method: POST

Properties​

PropertyTypeDescriptionRequired
idStringUnique identifier for the container typeYes
numberStringContainer type number or SKUNo
nameStringDisplay name for the container typeNo
descriptionStringDescription of the container typeNo
quantityIntExpected quantity for this container typeNo
unitStringUnit of measure for the container typeNo
imagePathStringPublic image URL for the container typeNo
customPropertiesAWSJSONAdditional customer-specific properties for the container typeNo

Headers​

Authorization – $idToken

Request Body​

Input can consist of multiple container type objects:

mutation {
createContainerTypes(
input: {
containerTypes: [
{
id: "Bin"
number: "BIN-001"
name: "Bin"
description: "Standard storage bin"
quantity: 50
unit: "pcs"
imagePath: "https://example.com/images/bin.png"
}
{
id: "Pallet"
number: "PAL-001"
name: "Pallet"
description: "Standard wooden pallet"
quantity: 20
unit: "pcs"
}
]
}
) {
containerTypeIds
}
}

Status Code - 200

Response Body​

{
"data": {
"createContainerTypes": {
"containerTypeIds": ["Bin", "Pallet"]
}
}
}

Response contains a list of all the Container Type IDs that were created.

Errors​

See authorization errors.


Update Container Types API​

Update Container Types API allows you to update one or multiple container types at the same time.

Endpoint Details​

  • URL: https://api.xemelgo.com/graphql
  • Method: POST

Properties​

PropertyTypeDescriptionRequired/Updatable
idStringUnique identifier for the container type to updateYes / No
numberStringContainer type number or SKUNo / Yes
nameStringDisplay name for the container typeNo / Yes
descriptionStringDescription of the container typeNo / Yes
quantityIntExpected quantity for this container typeNo / Yes
unitStringUnit of measure for the container typeNo / Yes
imagePathStringPublic image URL for the container typeNo / Yes
customPropertiesAWSJSONAdditional customer-specific properties for the container typeNo / Yes

Headers​

Authorization – $idToken

Request Body​

Here is an example payload for updating 2 container types:

mutation {
updateContainerTypes(
input: {
containerTypes: [
{ id: "Bin", number: "BIN-002", description: "Updated storage bin" }
{ id: "Pallet", quantity: 30, unit: "units" }
]
}
) {
containerTypeIds
}
}

Status Code - 200

Response Body​

{
"data": {
"updateContainerTypes": {
"containerTypeIds": ["Bin", "Pallet"]
}
}
}

Response contains a list of all the Container Type IDs that were updated.

Errors​

See authorization errors.

Additional Errors​

ErrorError code
Partial Update409

Partial Update (Bin is updated but Tote is not found in the DB)​

{
"data": {
"updateContainerTypes": {
"containerTypeIds": ["Bin"]
}
},
"errors": [
{
"path": ["updateContainerTypes"],
"data": null,
"errorType": null,
"errorInfo": null,
"locations": [{ "line": 2, "column": 5, "sourceName": null }],
"message": "containerTypeId: Tote not found in DB"
}
]
}

List Container Types API​

List Container Types API allows you to retrieve all container types and view their details. Results can be filtered and paginated.

Endpoint Details​

  • URL: https://api.xemelgo.com/graphql
  • Method: POST

Input Properties​

PropertyTypeDescriptionRequired
filterStringFilter expression for container type propertiesNo
nextTokenStringPagination token for the next pageNo

Response Properties​

PropertyTypeDescription
containerTypes[ContainerType]List of container types (see table below)
nextTokenStringToken for retrieving the next page

containerTypes​

PropertyTypeDescription
idStringContainer type identifier
numberStringContainer type number or SKU
nameStringDisplay name for the container type
descriptionStringDescription of the container type
quantityIntExpected quantity for this container type
unitStringUnit of measure
imagePathStringPublic image URL for the container type
customPropertiesAWSJSONAdditional custom properties

Headers​

Authorization – $idToken

Request Body​

query containerTypes($filter: String, $nextToken: String) {
containerTypes(input: { filter: $filter, nextToken: $nextToken }) {
nextToken
containerTypes {
id
number
name
description
quantity
unit
imagePath
customProperties
}
}
}

Status Code - 200

Response Body​

{
"data": {
"containerTypes": {
"nextToken": null,
"containerTypes": [
{
"id": "Bin",
"number": "BIN-002",
"name": "Bin",
"description": "Updated storage bin",
"quantity": 50,
"unit": "pcs",
"imagePath": "https://example.com/images/bin.png",
"customProperties": {}
},
{
"id": "Pallet",
"number": "PAL-001",
"name": "Pallet",
"description": "Standard wooden pallet",
"quantity": 30,
"unit": "units",
"imagePath": null,
"customProperties": {}
}
]
}
}
}

Errors​

See authorization errors.