custom_box

Fetch custom box records matching the supplied arguments.

Arguments

Argument	Type	Required	Default	Description
`id`	`String`	No		Filter by ID; pass the public API ID unless the field name says legacy ID.
`analyze`	`Boolean`	No		If true, the query will only be analyzed (cost estimated) without executing it.

Return Type

CustomBoxQueryResult

Query

query custom_box(
  $id: String,
  $analyze: Boolean
) {
  custom_box(
    id: $id,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...CustomBoxFragment
    
      id
      legacy_id
      account_id
      warehouse_id
      warehouse_identifier
      barcode
      name
      dimensions {
        ...DimensionsFragment
      
        weight
        height
        width
        length
      }
      active
      on_hand
      cost
      packaging_type
      price
    }
  }
}

Variables

{
  "id": "UmVjb3JkOjEyMzQ=",
  "analyze": true
}

Response

{
  "data": {
    "custom_box": {
      "request_id": "UmVjb3JkOjEyMzQ=",
      "complexity": 100,
      "data": {id: "Q3VzdG9tQm94OjEyMzQ="}
    }
  }
}