tote

Returns information about a tote. If barcode is set, but warehouse_id is not, it will default to the assigned warehouse id. If no tote is found with that barcode on the specified warehouse, it will return the next tote with the same barcode on any warehouse. It is recommended to use the id field to avoid ambiguity.

Arguments

ArgumentTypeRequiredDefaultDescription
idStringNo
barcodeStringNo
warehouse_idStringNo

Id of the tote's warehouse. If no warehouse id is provided, it will default to the assigned warehouse id otherwise the request will fail.

analyzeBooleanNo

If true, the query will only be analyzed (cost estimated) without executing it.

Return Type

ToteQueryResult

Query

query tote(
  $id: String,
  $barcode: String,
  $warehouse_id: String,
  $analyze: Boolean
) {
  tote(
    id: $id,
    barcode: $barcode,
    warehouse_id: $warehouse_id,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...ToteFragment
    }
  }
}

Variables

{
  "id": "abc123",
  "barcode": "abc123",
  "warehouse_id": "abc123",
  "analyze": true
}

Response

{
  "data": {
    "tote": {
      "request_id": "abc123",
      "complexity": 987,
      "data": Tote
    }
  }
}