carrier_boxes

Fetch carrier boxes matching the supplied arguments.

Arguments

Argument	Type	Required	Description
`warehouse_id`	`String`	No	Filter by public API warehouse ID. Use this ID field when selecting a warehouse; warehouse fields are display values or nested objects.
`warehouse_identifier`	`String`	No	Filter by warehouse display identifier, such as Primary or Secondary. Use warehouse_id when an ID is available.
`carrier`	`String`	No	Filter by carrier.
`only_active`	`Boolean`	No	Whether to show only active boxes.
`only_in_stock`	`Boolean`	No	Whether to only show boxes in stock.
`analyze`	`Boolean`	No	If true, the query will only be analyzed (cost estimated) without executing it.

Return Type

CarrierBoxesQueryResult

Query

query carrier_boxes(
  $warehouse_id: String,
  $warehouse_identifier: String,
  $carrier: String,
  $only_active: Boolean,
  $only_in_stock: Boolean,
  $analyze: Boolean
) {
  carrier_boxes(
    warehouse_id: $warehouse_id,
    warehouse_identifier: $warehouse_identifier,
    carrier: $carrier,
    only_active: $only_active,
    only_in_stock: $only_in_stock,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...CarrierBoxConnectionFragment
    
      pageInfo {
        ...PageInfoFragment
      
        hasNextPage
        hasPreviousPage
        startCursor
        endCursor
      }
      edges {
        ...CarrierBoxEdgeFragment
      
        node {
          ...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
        }
        cursor
      }
      total_count
    }
  }
}

Variables

{
  "warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
  "warehouse_identifier": "2",
  "carrier": "ups",
  "only_active": true,
  "only_in_stock": true,
  "analyze": true
}

Response

{
  "data": {
    "carrier_boxes": {
      "request_id": "UmVjb3JkOjEyMzQ=",
      "complexity": 100,
      "data": [{carrier: "ups", method: "ups_ground"}]
    }
  }
}