carrier_box

Fetch carrier box records matching the supplied arguments.

Arguments

Argument	Type	Required	Description
`box_code`	`String`!	Yes	Filter by box code. Required.
`warehouse_identifier`	`String`	No	Filter by warehouse display identifier, such as Primary or Secondary. Use warehouse_id when an ID is available.
`analyze`	`Boolean`	No	If true, the query will only be analyzed (cost estimated) without executing it.

Return Type

CarrierBoxQueryResult

Query

query carrier_box(
  $box_code: String!,
  $warehouse_identifier: String,
  $analyze: Boolean
) {
  carrier_box(
    box_code: $box_code,
    warehouse_identifier: $warehouse_identifier,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...CarrierBoxFragment
    
      account_id
      box_code
      warehouse_identifier
      warehouse_id
      on_hand
      active
      price
      carrier
      carrier_code
      name
      area
      dimensions {
        ...DimensionsFragment
      
        weight
        height
        width
        length
      }
      international
      barcode
    }
  }
}

Variables

{
  "box_code": "STANDARD",
  "warehouse_identifier": "2",
  "analyze": true
}

Response

{
  "data": {
    "carrier_box": {
      "request_id": "UmVjb3JkOjEyMzQ=",
      "complexity": 100,
      "data": {carrier: "ups", method: "ups_ground"}
    }
  }
}