shipments

Fetch shipments matching the supplied arguments.

Arguments

Argument	Type	Required	Description
`ids`	[`String`]	No	List of ids of shipments to include in the query.
`customer_account_id`	`String`	No	If you are a 3PL you can specify one of your customer's account.
`order_id`	`String`	No	Filter by order ID; pass the public API ID unless the field name says legacy ID.
`date_from`	ISODateTime	No	Inclusive start of the date range, in ISO-8601 datetime format.
`date_to`	ISODateTime	No	Inclusive end of the date range, in ISO-8601 datetime format.
`order_date_from`	ISODateTime	No	Inclusive start of the order date range, in ISO-8601 datetime format.
`order_date_to`	ISODateTime	No	Inclusive end of the order date range, in ISO-8601 datetime format.
`tracking_number`	`String`	No	Filter by tracking number.
`alternate_tracking_id`	`String`	No	Filter by alternate tracking ID; pass the public API ID unless the field name says legacy ID.
`voided`	`Boolean`	No	When true, filters results where voided applies; when false, filters where it does not.
`analyze`	`Boolean`	No	If true, the query will only be analyzed (cost estimated) without executing it.

Return Type

ShipmentsQueryResult

Query

query shipments(
  $ids: [String],
  $customer_account_id: String,
  $order_id: String,
  $date_from: ISODateTime,
  $date_to: ISODateTime,
  $order_date_from: ISODateTime,
  $order_date_to: ISODateTime,
  $tracking_number: String,
  $alternate_tracking_id: String,
  $voided: Boolean,
  $analyze: Boolean
) {
  shipments(
    ids: $ids,
    customer_account_id: $customer_account_id,
    order_id: $order_id,
    date_from: $date_from,
    date_to: $date_to,
    order_date_from: $order_date_from,
    order_date_to: $order_date_to,
    tracking_number: $tracking_number,
    alternate_tracking_id: $alternate_tracking_id,
    voided: $voided,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...ShipmentConnectionFragment
    
      pageInfo {
        ...PageInfoFragment
      
        hasNextPage
        hasPreviousPage
        startCursor
        endCursor
      }
      edges {
        ...ShipmentEdgeFragment
      
        node {
          ...ShipmentFragment
        
          id
          legacy_id
          order_id
          user_id
          warehouse_id
          pending_shipment_id
          address {
            ...AddressFragment
          
            name
            address1
            address2
            city
            state
            country
            zip
            phone
          }
          profile
          picked_up
          needs_refund
          refunded
          delivered
          shipped_off_shiphero
          dropshipment
          completed
          created_date
          line_items {
            ...ShipmentLineItemConnectionFragment
          
            pageInfo {
              ...PageInfoFragment
            
              hasNextPage
              hasPreviousPage
              startCursor
              endCursor
            }
            edges {
              ...ShipmentLineItemEdgeFragment
            
              node {
                ...ShipmentLineItemFragment
              
                id
                legacy_id
                line_item_id
                shipment_id
                shipping_label_id
                quantity
                line_item {
                  ...LineItemFragment
                
                  id
                  legacy_id
                  sku
                  partner_line_item_id
                  product_id
                  quantity
                  price
                  product_name
                  option_title
                  fulfillment_status
                  quantity_pending_fulfillment
                  quantity_shipped
                  warehouse
                  quantity_allocated
                  backorder_quantity
                  custom_options
                  custom_barcode
                  eligible_for_return
                  customs_value
                  warehouse_id
                  locked_to_warehouse_id
                  subtotal
                  barcode
                  created_at
                  updated_at
                  order_id
                  shipped_line_item_lots {
                    ...ShippedLineItemLotFragment
                  
                    id
                    legacy_id
                    line_item_id
                    lot_id
                    lot_name
                    lot_expiration_date
                    quantity
                  }
                  serial_numbers {
                    ...LineItemSerialNumberFragment
                  
                    id
                    legacy_id
                    sku
                    line_item_id
                    serial_number
                    scanned
                    created_at
                    updated_at
                  }
                  promotion_discount
                  product {
                    ...ProductFragment
                  
                    id
                    legacy_id
                    account_id
                    name
                    sku
                    price
                    value
                    value_currency
                    barcode
                    country_of_manufacture
                    dimensions {
                      ...DimensionsFragment
                    }
                    tariff_code
                    kit
                    kit_build
                    no_air
                    final_sale
                    customs_value
                    customs_description
                    not_owned
                    dropship
                    needs_serial_number
                    thumbnail
                    large_thumbnail
                    created_at
                    updated_at
                    product_note
                    virtual
                    ignore_on_invoice
                    ignore_on_customs
                    active
                    needs_lot_tracking
                    is_assembly
                    packer_note
                    size
                    style
                    vendor_part_number
                    consumer_package_code
                    buyer_part_number
                    buyer_style_number
                    auto_pack
                    warehouse_products {
                      ...WarehouseProductFragment
                    }
                    fba_inventory {
                      ...FbaInventoryFragment
                    }
                    images {
                      ...ProductImageFragment
                    }
                    tags
                    vendors {
                      ...ProductVendorFragment
                    }
                    components {
                      ...ProductFragment
                    }
                    kit_components {
                      ...KitComponentFragment
                    }
                    assembly_components {
                      ...AssemblyComponentFragment
                    }
                    cases {
                      ...CaseFragment
                    }
                  }
                  tote_picks {
                    ...TotePickFragment
                  
                    id
                    legacy_id
                    sku
                    created_at
                    updated_at
                    tote_id
                    current
                    picked_quantity
                    quantity
                    inventory_bin
                    line_item {
                      ...LineItemFragment
                    }
                    location {
                      ...LocationFragment
                    }
                    deducted
                  }
                }
                lot {
                  ...LotFragment
                
                  id
                  legacy_id
                  account_id
                  po_id
                  name
                  sku
                  created_at
                  updated_at
                  expires_at
                  received_at
                  is_active
                  locations {
                    ...LocationConnectionFragment
                  
                    pageInfo {
                      ...PageInfoFragment
                    }
                    edges {
                      ...LocationEdgeFragment
                    }
                  }
                  purchase_orders {
                    ...PurchaseOrderConnectionFragment
                  
                    pageInfo {
                      ...PageInfoFragment
                    }
                    edges {
                      ...PurchaseOrderEdgeFragment
                    }
                  }
                }
                lots {
                  ...ShippedLineItemLotFragment
                
                  id
                  legacy_id
                  line_item_id
                  lot_id
                  lot_name
                  lot_expiration_date
                  quantity
                }
              }
              cursor
            }
          }
          shipping_labels {
            ...ShippingLabelFragment
          
            id
            legacy_id
            account_id
            shipment_id
            order_id
            box_id
            box_name
            status
            tracking_number
            alternate_tracking_id
            order_number
            order_account_id
            carrier
            shipping_name
            shipping_method
            cost
            box_code
            device_id
            delivered
            picked_up
            refunded
            needs_refund
            profile
            partner_fulfillment_id
            full_size_to_print
            packing_slip
            warehouse
            warehouse_id
            insurance_amount
            carrier_account_id
            source
            created_date
            tracking_url
            dimensions {
              ...DimensionsFragment
            
              weight
              height
              width
              length
            }
            label {
              ...LabelResourceFragment
            
              pdf_location
              paper_pdf_location
              thermal_pdf_location
              image_location
            }
            address {
              ...AddressFragment
            
              name
              address1
              address2
              city
              state
              country
              zip
              phone
            }
            order {
              ...OrderFragment
            
              id
              legacy_id
              order_number
              partner_order_id
              shop_name
              fulfillment_status
              order_date
              total_tax
              subtotal
              total_discounts
              total_price
              box_name
              ready_to_ship
              auto_print_return_label
              custom_invoice_url
              account_id
              updated_at
              created_at
              email
              profile
              gift_note
              packing_note
              required_ship_date
              shipping_lines {
                ...ShippingLinesFragment
              
                title
                carrier
                method
                price
              }
              shipping_address {
                ...OrderAddressFragment
              
                first_name
                last_name
                company
                address1
                address2
                city
                state
                state_code
                zip
                country
                country_code
                email
                phone
              }
              billing_address {
                ...OrderAddressFragment
              
                first_name
                last_name
                company
                address1
                address2
                city
                state
                state_code
                zip
                country
                country_code
                email
                phone
              }
              tags
              line_items {
                ...LineItemQuerySpecConnectionFragment
              
                pageInfo {
                  ...PageInfoFragment
                
                  hasNextPage
                  hasPreviousPage
                  startCursor
                  endCursor
                }
                edges {
                  ...LineItemQuerySpecEdgeFragment
                
                  node {
                    ...LineItemFragment
                  
                    id
                    legacy_id
                    sku
                    partner_line_item_id
                    product_id
                    quantity
                    price
                    product_name
                    option_title
                    fulfillment_status
                    quantity_pending_fulfillment
                    quantity_shipped
                    warehouse
                    quantity_allocated
                    backorder_quantity
                    custom_options
                    custom_barcode
                    eligible_for_return
                    customs_value
                    warehouse_id
                    locked_to_warehouse_id
                    subtotal
                    barcode
                    created_at
                    updated_at
                    order_id
                    shipped_line_item_lots {
                      ...ShippedLineItemLotFragment
                    }
                    serial_numbers {
                      ...LineItemSerialNumberFragment
                    }
                    promotion_discount
                    product {
                      ...ProductFragment
                    }
                    tote_picks {
                      ...TotePickFragment
                    }
                  }
                  cursor
                }
                total_count
              }
              authorizations {
                ...AuthorizationFragment
              
                transaction_id
                authorized_amount
                postauthed_amount
                refunded_amount
                card_type
                date
              }
              holds {
                ...OrderHoldsFragment
              
                fraud_hold
                address_hold
                shipping_method_hold
                operator_hold
                payment_hold
                client_hold
              }
              shipments {
                ...ShipmentFragment
              }
              returns {
                ...ReturnFragment
              
                id
                legacy_id
                account_id
                order_id
                partner_id
                reason
                status
                label_type
                label_cost
                labels {
                  ...RMALabelTypeFragment
                
                  id
                  legacy_id
                  tracking_number
                  status
                  created_date
                  carrier
                  shipping_method
                  cost
                  dimensions {
                    ...DimensionsFragment
                  
                    weight
                    height
                    width
                    length
                  }
                  length
                  width
                  height
                  weight
                  to_name
                  address1
                  address2
                  address_city
                  address_state
                  address_zip
                  address_country
                  pdf_location
                }
                cost_to_customer
                shipping_carrier
                shipping_method
                dimensions {
                  ...DimensionsFragment
                
                  weight
                  height
                  width
                  length
                }
                address {
                  ...AddressFragment
                
                  name
                  address1
                  address2
                  city
                  state
                  country
                  zip
                  phone
                }
                line_items {
                  ...ReturnLineItemFragment
                
                  id
                  legacy_id
                  account_id
                  line_item_id
                  warehouse_id
                  product_id
                  return_id
                  quantity
                  quantity_received
                  restock
                  condition
                  is_component
                  type
                  reason
                  created_at
                  updated_at
                  line_item {
                    ...LineItemFragment
                  
                    id
                    legacy_id
                    sku
                    partner_line_item_id
                    product_id
                    quantity
                    price
                    product_name
                    option_title
                    fulfillment_status
                    quantity_pending_fulfillment
                    quantity_shipped
                    warehouse
                    quantity_allocated
                    backorder_quantity
                    custom_options
                    custom_barcode
                    eligible_for_return
                    customs_value
                    warehouse_id
                    locked_to_warehouse_id
                    subtotal
                    barcode
                    created_at
                    updated_at
                    order_id
                    shipped_line_item_lots {
                      ...ShippedLineItemLotFragment
                    }
                    serial_numbers {
                      ...LineItemSerialNumberFragment
                    }
                    promotion_discount
                    product {
                      ...ProductFragment
                    }
                    tote_picks {
                      ...TotePickFragment
                    }
                  }
                  product {
                    ...ProductFragment
                  
                    id
                    legacy_id
                    account_id
                    name
                    sku
                    price
                    value
                    value_currency
                    barcode
                    country_of_manufacture
                    dimensions {
                      ...DimensionsFragment
                    }
                    tariff_code
                    kit
                    kit_build
                    no_air
                    final_sale
                    customs_value
                    customs_description
                    not_owned
                    dropship
                    needs_serial_number
                    thumbnail
                    large_thumbnail
                    created_at
                    updated_at
                    product_note
                    virtual
                    ignore_on_invoice
                    ignore_on_customs
                    active
                    needs_lot_tracking
                    is_assembly
                    packer_note
                    size
                    style
                    vendor_part_number
                    consumer_package_code
                    buyer_part_number
                    buyer_style_number
                    auto_pack
                    warehouse_products {
                      ...WarehouseProductFragment
                    }
                    fba_inventory {
                      ...FbaInventoryFragment
                    }
                    images {
                      ...ProductImageFragment
                    }
                    tags
                    vendors {
                      ...ProductVendorFragment
                    }
                    components {
                      ...ProductFragment
                    }
                    kit_components {
                      ...KitComponentFragment
                    }
                    assembly_components {
                      ...AssemblyComponentFragment
                    }
                    cases {
                      ...CaseFragment
                    }
                  }
                  warehouse {
                    ...WarehouseFragment
                  
                    id
                    legacy_id
                    account_id
                    identifier
                    dynamic_slotting
                    invoice_email
                    phone_number
                    profile
                    address {
                      ...AddressFragment
                    }
                    return_address {
                      ...AddressFragment
                    }
                    company_name
                    company_alias
                    active
                    products {
                      ...ProductConnectionFragment
                    }
                  }
                }
                total_items_expected
                total_items_received
                total_items_restocked
                created_at
                display_issue_refund
                order {
                  ...OrderFragment
                }
                exchanges {
                  ...ReturnExchangeFragment
                
                  id
                  legacy_id
                  exchange_order_id
                  return_id
                  account_id
                  exchange_order {
                    ...OrderFragment
                  }
                  exchange_items {
                    ...ReturnExchangeItemFragment
                  
                    id
                    legacy_id
                    return_item_id
                    sku
                    quantity
                  }
                  original_return {
                    ...ReturnFragment
                  }
                }
                return_history {
                  ...ReturnHistoryFragment
                
                  id
                  legacy_id
                  return_id
                  account_id
                  user_id
                  created_at
                  body
                }
                attachments {
                  ...ReturnAttachmentFragment
                
                  id
                  legacy_id
                  account_id
                  user_id
                  return_id
                  return_item_id
                  url
                  filename
                  file_type
                  description
                  created_at
                }
              }
              rma_labels {
                ...RMALabelFragment
              
                id
                legacy_id
                account_id
                order_id
                rma_id
                shipment_id
                shipping_name
                tracking_number
                status
                carrier
                shipping_method
                cost
                box_code
                dimensions {
                  ...DimensionsFragment
                
                  weight
                  height
                  width
                  length
                }
                address {
                  ...AddressFragment
                
                  name
                  address1
                  address2
                  city
                  state
                  country
                  zip
                  phone
                }
                paper_pdf_location
                thermal_pdf_location
                pdf_location
                image_location
                delivered
                picked_up
                refunded
                needs_refund
                profile
                full_size_to_print
                partner_fulfillment_id
                created_at
                updated_at
              }
              flagged
              saturday_delivery
              ignore_address_validation_errors
              skip_address_validation
              priority_flag
              allocation_priority
              allocations {
                ...OrderWarehouseAllocationFragment
              
                order_id
                warehouse_id
                allocated_at
                allocation_reference
                ready_to_ship
                line_items {
                  ...OrderLineItemAllocationFragment
                
                  order_id
                  warehouse_id
                  allocated_at
                  line_item_id
                  sku
                  quantity_allocated
                  is_kit_component
                  allocation_reference
                }
                is_locked
              }
              source
              third_party_shipper {
                ...OrderThirdPartyShipperFragment
              
                account_number
                zip
                country
              }
              gift_invoice
              allow_partial
              require_signature
              adult_signature_required
              alcohol
              expected_weight_in_oz
              insurance
              insurance_amount
              currency
              has_dry_ice
              allow_split
              hold_until_date
              incoterms
              tax_id
              tax_type
              dry_ice_weight_in_lbs
              ftr_exemption
              ftr_exemption_value
              address_is_business
              tote_qa
              do_not_print_invoice
              ignore_payment_capture_errors
              service_point_id
              partner_source_name
              order_history {
                ...OrderHistoryFragment
              
                id
                legacy_id
                order_id
                user_id
                account_id
                username
                order_number
                information
                created_at
                order {
                  ...OrderFragment
                }
              }
              merged_orders {
                ...MergedOrderFragment
              
                order_id
                is_master
              }
              attachments {
                ...OrderAttachmentQuerySpecConnectionFragment
              
                pageInfo {
                  ...PageInfoFragment
                
                  hasNextPage
                  hasPreviousPage
                  startCursor
                  endCursor
                }
                edges {
                  ...OrderAttachmentQuerySpecEdgeFragment
                
                  node {
                    ...OrderAttachmentFragment
                  
                    id
                    legacy_id
                    order_id
                    account_id
                    description
                    url
                    filename
                    file_type
                    file_size
                    created_at
                  }
                  cursor
                }
                total_count
              }
              wholesale_order {
                ...WholesaleOrderFragment
              
                id
                legacy_id
                version
                fulfillment_flow
                shipping_option
                staging_location_id
                picking_flow
                outbound_progress
                pickup_date
                status
                status_message
                preparation_date
                is_packed_externally
                packing_layout
                order_type
                gs1_labels_required
                trading_partner_id
                trading_partner_name
                store_location_number
                store_address1
                store_city
                store_country
                store_state
                store_zip
                distribution_center
                distribution_center_number
                purchase_order_type
                vendor
                vendor_id
                requested_delivery_date
                ship_not_before_date
                ship_no_later_than_date
                depositor_order_number
                department
                department_number
                division
                service_level
                internal_supplier_number
                terms_of_sale
                retailer_notes
                quote_number
                sales_requirement_code
                reference_fields
                order_id
                order {
                  ...OrderFragment
                }
                wholesale_shipping_details {
                  ...WholesaleShippingDetailsFragment
                
                  id
                  legacy_id
                  account_number
                  scac
                  carrier
                  shipping_method
                  bill_of_lading
                  cost
                  trailer_number
                  pro_number
                  gs1_company_prefix
                  courier
                }
                wholesale_line_items {
                  ...WholesaleLineItemsQuerySpecConnectionFragment
                
                  pageInfo {
                    ...PageInfoFragment
                  
                    hasNextPage
                    hasPreviousPage
                    startCursor
                    endCursor
                  }
                  edges {
                    ...WholesaleLineItemsQuerySpecEdgeFragment
                  
                    node {
                      ...WholesaleLineItemFragment
                    }
                    cursor
                  }
                  total_count
                }
              }
            }
            shipment_line_items {
              ...ShipmentLineItemConnectionFragment
            
              pageInfo {
                ...PageInfoFragment
              
                hasNextPage
                hasPreviousPage
                startCursor
                endCursor
              }
              edges {
                ...ShipmentLineItemEdgeFragment
              
                node {
                  ...ShipmentLineItemFragment
                
                  id
                  legacy_id
                  line_item_id
                  shipment_id
                  shipping_label_id
                  quantity
                  line_item {
                    ...LineItemFragment
                  
                    id
                    legacy_id
                    sku
                    partner_line_item_id
                    product_id
                    quantity
                    price
                    product_name
                    option_title
                    fulfillment_status
                    quantity_pending_fulfillment
                    quantity_shipped
                    warehouse
                    quantity_allocated
                    backorder_quantity
                    custom_options
                    custom_barcode
                    eligible_for_return
                    customs_value
                    warehouse_id
                    locked_to_warehouse_id
                    subtotal
                    barcode
                    created_at
                    updated_at
                    order_id
                    shipped_line_item_lots {
                      ...ShippedLineItemLotFragment
                    }
                    serial_numbers {
                      ...LineItemSerialNumberFragment
                    }
                    promotion_discount
                    product {
                      ...ProductFragment
                    }
                    tote_picks {
                      ...TotePickFragment
                    }
                  }
                  lot {
                    ...LotFragment
                  
                    id
                    legacy_id
                    account_id
                    po_id
                    name
                    sku
                    created_at
                    updated_at
                    expires_at
                    received_at
                    is_active
                    locations {
                      ...LocationConnectionFragment
                    }
                    purchase_orders {
                      ...PurchaseOrderConnectionFragment
                    }
                  }
                  lots {
                    ...ShippedLineItemLotFragment
                  
                    id
                    legacy_id
                    line_item_id
                    lot_id
                    lot_name
                    lot_expiration_date
                    quantity
                  }
                }
                cursor
              }
            }
            package_number
            parcelview_url
            tracking_status
            in_shipping_container
            shipping_container_id
            last_mile_labels {
              ...LastMileLabelFragment
            
              id
              legacy_id
              shipping_carrier
              shipping_method
              tracking_number
              tracking_url
            }
            serial_numbers {
              ...LineItemSerialNumberFragment
            
              id
              legacy_id
              sku
              line_item_id
              serial_number
              scanned
              created_at
              updated_at
            }
          }
          warehouse {
            ...WarehouseFragment
          
            id
            legacy_id
            account_id
            identifier
            dynamic_slotting
            invoice_email
            phone_number
            profile
            address {
              ...AddressFragment
            
              name
              address1
              address2
              city
              state
              country
              zip
              phone
            }
            return_address {
              ...AddressFragment
            
              name
              address1
              address2
              city
              state
              country
              zip
              phone
            }
            company_name
            company_alias
            active
            products {
              ...ProductConnectionFragment
            
              pageInfo {
                ...PageInfoFragment
              
                hasNextPage
                hasPreviousPage
                startCursor
                endCursor
              }
              edges {
                ...ProductEdgeFragment
              
                node {
                  ...ProductFragment
                
                  id
                  legacy_id
                  account_id
                  name
                  sku
                  price
                  value
                  value_currency
                  barcode
                  country_of_manufacture
                  dimensions {
                    ...DimensionsFragment
                  
                    weight
                    height
                    width
                    length
                  }
                  tariff_code
                  kit
                  kit_build
                  no_air
                  final_sale
                  customs_value
                  customs_description
                  not_owned
                  dropship
                  needs_serial_number
                  thumbnail
                  large_thumbnail
                  created_at
                  updated_at
                  product_note
                  virtual
                  ignore_on_invoice
                  ignore_on_customs
                  active
                  needs_lot_tracking
                  is_assembly
                  packer_note
                  size
                  style
                  vendor_part_number
                  consumer_package_code
                  buyer_part_number
                  buyer_style_number
                  auto_pack
                  warehouse_products {
                    ...WarehouseProductFragment
                  
                    id
                    legacy_id
                    account_id
                    sku
                    warehouse_id
                    warehouse_identifier
                    price
                    value
                    value_currency
                    on_hand
                    inventory_bin
                    inventory_overstock_bin
                    reserve_inventory
                    replenishment_level
                    replenishment_max_level
                    replenishment_increment
                    reorder_amount
                    reorder_level
                    backorder
                    allocated
                    available
                    non_sellable_quantity
                    in_tote
                    custom
                    customs_value
                    created_at
                    updated_at
                    sell_ahead
                    active
                    warehouse {
                      ...WarehouseFragment
                    }
                    product {
                      ...ProductFragment
                    }
                    inbounds {
                      ...WarehouseProductInboundConnectionFragment
                    }
                    locations {
                      ...ItemLocationConnectionFragment
                    }
                  }
                  fba_inventory {
                    ...FbaInventoryFragment
                  
                    id
                    legacy_id
                    quantity
                    marketplace_id
                    merchant_id
                  }
                  images {
                    ...ProductImageFragment
                  
                    src
                    position
                  }
                  tags
                  vendors {
                    ...ProductVendorFragment
                  
                    vendor_id
                    vendor_sku
                    price
                  }
                  components {
                    ...ProductFragment
                  }
                  kit_components {
                    ...KitComponentFragment
                  
                    id
                    legacy_id
                    account_id
                    sku
                    quantity
                  }
                  assembly_components {
                    ...AssemblyComponentFragment
                  
                    id
                    legacy_id
                    account_id
                    sku
                    quantity
                  }
                  cases {
                    ...CaseFragment
                  
                    id
                    legacy_id
                    case_barcode
                    case_quantity
                  }
                }
                cursor
              }
            }
          }
          order {
            ...OrderFragment
          
            id
            legacy_id
            order_number
            partner_order_id
            shop_name
            fulfillment_status
            order_date
            total_tax
            subtotal
            total_discounts
            total_price
            box_name
            ready_to_ship
            auto_print_return_label
            custom_invoice_url
            account_id
            updated_at
            created_at
            email
            profile
            gift_note
            packing_note
            required_ship_date
            shipping_lines {
              ...ShippingLinesFragment
            
              title
              carrier
              method
              price
            }
            shipping_address {
              ...OrderAddressFragment
            
              first_name
              last_name
              company
              address1
              address2
              city
              state
              state_code
              zip
              country
              country_code
              email
              phone
            }
            billing_address {
              ...OrderAddressFragment
            
              first_name
              last_name
              company
              address1
              address2
              city
              state
              state_code
              zip
              country
              country_code
              email
              phone
            }
            tags
            line_items {
              ...LineItemQuerySpecConnectionFragment
            
              pageInfo {
                ...PageInfoFragment
              
                hasNextPage
                hasPreviousPage
                startCursor
                endCursor
              }
              edges {
                ...LineItemQuerySpecEdgeFragment
              
                node {
                  ...LineItemFragment
                
                  id
                  legacy_id
                  sku
                  partner_line_item_id
                  product_id
                  quantity
                  price
                  product_name
                  option_title
                  fulfillment_status
                  quantity_pending_fulfillment
                  quantity_shipped
                  warehouse
                  quantity_allocated
                  backorder_quantity
                  custom_options
                  custom_barcode
                  eligible_for_return
                  customs_value
                  warehouse_id
                  locked_to_warehouse_id
                  subtotal
                  barcode
                  created_at
                  updated_at
                  order_id
                  shipped_line_item_lots {
                    ...ShippedLineItemLotFragment
                  
                    id
                    legacy_id
                    line_item_id
                    lot_id
                    lot_name
                    lot_expiration_date
                    quantity
                  }
                  serial_numbers {
                    ...LineItemSerialNumberFragment
                  
                    id
                    legacy_id
                    sku
                    line_item_id
                    serial_number
                    scanned
                    created_at
                    updated_at
                  }
                  promotion_discount
                  product {
                    ...ProductFragment
                  
                    id
                    legacy_id
                    account_id
                    name
                    sku
                    price
                    value
                    value_currency
                    barcode
                    country_of_manufacture
                    dimensions {
                      ...DimensionsFragment
                    }
                    tariff_code
                    kit
                    kit_build
                    no_air
                    final_sale
                    customs_value
                    customs_description
                    not_owned
                    dropship
                    needs_serial_number
                    thumbnail
                    large_thumbnail
                    created_at
                    updated_at
                    product_note
                    virtual
                    ignore_on_invoice
                    ignore_on_customs
                    active
                    needs_lot_tracking
                    is_assembly
                    packer_note
                    size
                    style
                    vendor_part_number
                    consumer_package_code
                    buyer_part_number
                    buyer_style_number
                    auto_pack
                    warehouse_products {
                      ...WarehouseProductFragment
                    }
                    fba_inventory {
                      ...FbaInventoryFragment
                    }
                    images {
                      ...ProductImageFragment
                    }
                    tags
                    vendors {
                      ...ProductVendorFragment
                    }
                    components {
                      ...ProductFragment
                    }
                    kit_components {
                      ...KitComponentFragment
                    }
                    assembly_components {
                      ...AssemblyComponentFragment
                    }
                    cases {
                      ...CaseFragment
                    }
                  }
                  tote_picks {
                    ...TotePickFragment
                  
                    id
                    legacy_id
                    sku
                    created_at
                    updated_at
                    tote_id
                    current
                    picked_quantity
                    quantity
                    inventory_bin
                    line_item {
                      ...LineItemFragment
                    }
                    location {
                      ...LocationFragment
                    }
                    deducted
                  }
                }
                cursor
              }
              total_count
            }
            authorizations {
              ...AuthorizationFragment
            
              transaction_id
              authorized_amount
              postauthed_amount
              refunded_amount
              card_type
              date
            }
            holds {
              ...OrderHoldsFragment
            
              fraud_hold
              address_hold
              shipping_method_hold
              operator_hold
              payment_hold
              client_hold
            }
            shipments {
              ...ShipmentFragment
            }
            returns {
              ...ReturnFragment
            
              id
              legacy_id
              account_id
              order_id
              partner_id
              reason
              status
              label_type
              label_cost
              labels {
                ...RMALabelTypeFragment
              
                id
                legacy_id
                tracking_number
                status
                created_date
                carrier
                shipping_method
                cost
                dimensions {
                  ...DimensionsFragment
                
                  weight
                  height
                  width
                  length
                }
                length
                width
                height
                weight
                to_name
                address1
                address2
                address_city
                address_state
                address_zip
                address_country
                pdf_location
              }
              cost_to_customer
              shipping_carrier
              shipping_method
              dimensions {
                ...DimensionsFragment
              
                weight
                height
                width
                length
              }
              address {
                ...AddressFragment
              
                name
                address1
                address2
                city
                state
                country
                zip
                phone
              }
              line_items {
                ...ReturnLineItemFragment
              
                id
                legacy_id
                account_id
                line_item_id
                warehouse_id
                product_id
                return_id
                quantity
                quantity_received
                restock
                condition
                is_component
                type
                reason
                created_at
                updated_at
                line_item {
                  ...LineItemFragment
                
                  id
                  legacy_id
                  sku
                  partner_line_item_id
                  product_id
                  quantity
                  price
                  product_name
                  option_title
                  fulfillment_status
                  quantity_pending_fulfillment
                  quantity_shipped
                  warehouse
                  quantity_allocated
                  backorder_quantity
                  custom_options
                  custom_barcode
                  eligible_for_return
                  customs_value
                  warehouse_id
                  locked_to_warehouse_id
                  subtotal
                  barcode
                  created_at
                  updated_at
                  order_id
                  shipped_line_item_lots {
                    ...ShippedLineItemLotFragment
                  
                    id
                    legacy_id
                    line_item_id
                    lot_id
                    lot_name
                    lot_expiration_date
                    quantity
                  }
                  serial_numbers {
                    ...LineItemSerialNumberFragment
                  
                    id
                    legacy_id
                    sku
                    line_item_id
                    serial_number
                    scanned
                    created_at
                    updated_at
                  }
                  promotion_discount
                  product {
                    ...ProductFragment
                  
                    id
                    legacy_id
                    account_id
                    name
                    sku
                    price
                    value
                    value_currency
                    barcode
                    country_of_manufacture
                    dimensions {
                      ...DimensionsFragment
                    }
                    tariff_code
                    kit
                    kit_build
                    no_air
                    final_sale
                    customs_value
                    customs_description
                    not_owned
                    dropship
                    needs_serial_number
                    thumbnail
                    large_thumbnail
                    created_at
                    updated_at
                    product_note
                    virtual
                    ignore_on_invoice
                    ignore_on_customs
                    active
                    needs_lot_tracking
                    is_assembly
                    packer_note
                    size
                    style
                    vendor_part_number
                    consumer_package_code
                    buyer_part_number
                    buyer_style_number
                    auto_pack
                    warehouse_products {
                      ...WarehouseProductFragment
                    }
                    fba_inventory {
                      ...FbaInventoryFragment
                    }
                    images {
                      ...ProductImageFragment
                    }
                    tags
                    vendors {
                      ...ProductVendorFragment
                    }
                    components {
                      ...ProductFragment
                    }
                    kit_components {
                      ...KitComponentFragment
                    }
                    assembly_components {
                      ...AssemblyComponentFragment
                    }
                    cases {
                      ...CaseFragment
                    }
                  }
                  tote_picks {
                    ...TotePickFragment
                  
                    id
                    legacy_id
                    sku
                    created_at
                    updated_at
                    tote_id
                    current
                    picked_quantity
                    quantity
                    inventory_bin
                    line_item {
                      ...LineItemFragment
                    }
                    location {
                      ...LocationFragment
                    }
                    deducted
                  }
                }
                product {
                  ...ProductFragment
                
                  id
                  legacy_id
                  account_id
                  name
                  sku
                  price
                  value
                  value_currency
                  barcode
                  country_of_manufacture
                  dimensions {
                    ...DimensionsFragment
                  
                    weight
                    height
                    width
                    length
                  }
                  tariff_code
                  kit
                  kit_build
                  no_air
                  final_sale
                  customs_value
                  customs_description
                  not_owned
                  dropship
                  needs_serial_number
                  thumbnail
                  large_thumbnail
                  created_at
                  updated_at
                  product_note
                  virtual
                  ignore_on_invoice
                  ignore_on_customs
                  active
                  needs_lot_tracking
                  is_assembly
                  packer_note
                  size
                  style
                  vendor_part_number
                  consumer_package_code
                  buyer_part_number
                  buyer_style_number
                  auto_pack
                  warehouse_products {
                    ...WarehouseProductFragment
                  
                    id
                    legacy_id
                    account_id
                    sku
                    warehouse_id
                    warehouse_identifier
                    price
                    value
                    value_currency
                    on_hand
                    inventory_bin
                    inventory_overstock_bin
                    reserve_inventory
                    replenishment_level
                    replenishment_max_level
                    replenishment_increment
                    reorder_amount
                    reorder_level
                    backorder
                    allocated
                    available
                    non_sellable_quantity
                    in_tote
                    custom
                    customs_value
                    created_at
                    updated_at
                    sell_ahead
                    active
                    warehouse {
                      ...WarehouseFragment
                    }
                    product {
                      ...ProductFragment
                    }
                    inbounds {
                      ...WarehouseProductInboundConnectionFragment
                    }
                    locations {
                      ...ItemLocationConnectionFragment
                    }
                  }
                  fba_inventory {
                    ...FbaInventoryFragment
                  
                    id
                    legacy_id
                    quantity
                    marketplace_id
                    merchant_id
                  }
                  images {
                    ...ProductImageFragment
                  
                    src
                    position
                  }
                  tags
                  vendors {
                    ...ProductVendorFragment
                  
                    vendor_id
                    vendor_sku
                    price
                  }
                  components {
                    ...ProductFragment
                  }
                  kit_components {
                    ...KitComponentFragment
                  
                    id
                    legacy_id
                    account_id
                    sku
                    quantity
                  }
                  assembly_components {
                    ...AssemblyComponentFragment
                  
                    id
                    legacy_id
                    account_id
                    sku
                    quantity
                  }
                  cases {
                    ...CaseFragment
                  
                    id
                    legacy_id
                    case_barcode
                    case_quantity
                  }
                }
                warehouse {
                  ...WarehouseFragment
                
                  id
                  legacy_id
                  account_id
                  identifier
                  dynamic_slotting
                  invoice_email
                  phone_number
                  profile
                  address {
                    ...AddressFragment
                  
                    name
                    address1
                    address2
                    city
                    state
                    country
                    zip
                    phone
                  }
                  return_address {
                    ...AddressFragment
                  
                    name
                    address1
                    address2
                    city
                    state
                    country
                    zip
                    phone
                  }
                  company_name
                  company_alias
                  active
                  products {
                    ...ProductConnectionFragment
                  
                    pageInfo {
                      ...PageInfoFragment
                    }
                    edges {
                      ...ProductEdgeFragment
                    }
                  }
                }
              }
              total_items_expected
              total_items_received
              total_items_restocked
              created_at
              display_issue_refund
              order {
                ...OrderFragment
              }
              exchanges {
                ...ReturnExchangeFragment
              
                id
                legacy_id
                exchange_order_id
                return_id
                account_id
                exchange_order {
                  ...OrderFragment
                }
                exchange_items {
                  ...ReturnExchangeItemFragment
                
                  id
                  legacy_id
                  return_item_id
                  sku
                  quantity
                }
                original_return {
                  ...ReturnFragment
                }
              }
              return_history {
                ...ReturnHistoryFragment
              
                id
                legacy_id
                return_id
                account_id
                user_id
                created_at
                body
              }
              attachments {
                ...ReturnAttachmentFragment
              
                id
                legacy_id
                account_id
                user_id
                return_id
                return_item_id
                url
                filename
                file_type
                description
                created_at
              }
            }
            rma_labels {
              ...RMALabelFragment
            
              id
              legacy_id
              account_id
              order_id
              rma_id
              shipment_id
              shipping_name
              tracking_number
              status
              carrier
              shipping_method
              cost
              box_code
              dimensions {
                ...DimensionsFragment
              
                weight
                height
                width
                length
              }
              address {
                ...AddressFragment
              
                name
                address1
                address2
                city
                state
                country
                zip
                phone
              }
              paper_pdf_location
              thermal_pdf_location
              pdf_location
              image_location
              delivered
              picked_up
              refunded
              needs_refund
              profile
              full_size_to_print
              partner_fulfillment_id
              created_at
              updated_at
            }
            flagged
            saturday_delivery
            ignore_address_validation_errors
            skip_address_validation
            priority_flag
            allocation_priority
            allocations {
              ...OrderWarehouseAllocationFragment
            
              order_id
              warehouse_id
              allocated_at
              allocation_reference
              ready_to_ship
              line_items {
                ...OrderLineItemAllocationFragment
              
                order_id
                warehouse_id
                allocated_at
                line_item_id
                sku
                quantity_allocated
                is_kit_component
                allocation_reference
              }
              is_locked
            }
            source
            third_party_shipper {
              ...OrderThirdPartyShipperFragment
            
              account_number
              zip
              country
            }
            gift_invoice
            allow_partial
            require_signature
            adult_signature_required
            alcohol
            expected_weight_in_oz
            insurance
            insurance_amount
            currency
            has_dry_ice
            allow_split
            hold_until_date
            incoterms
            tax_id
            tax_type
            dry_ice_weight_in_lbs
            ftr_exemption
            ftr_exemption_value
            address_is_business
            tote_qa
            do_not_print_invoice
            ignore_payment_capture_errors
            service_point_id
            partner_source_name
            order_history {
              ...OrderHistoryFragment
            
              id
              legacy_id
              order_id
              user_id
              account_id
              username
              order_number
              information
              created_at
              order {
                ...OrderFragment
              }
            }
            merged_orders {
              ...MergedOrderFragment
            
              order_id
              is_master
            }
            attachments {
              ...OrderAttachmentQuerySpecConnectionFragment
            
              pageInfo {
                ...PageInfoFragment
              
                hasNextPage
                hasPreviousPage
                startCursor
                endCursor
              }
              edges {
                ...OrderAttachmentQuerySpecEdgeFragment
              
                node {
                  ...OrderAttachmentFragment
                
                  id
                  legacy_id
                  order_id
                  account_id
                  description
                  url
                  filename
                  file_type
                  file_size
                  created_at
                }
                cursor
              }
              total_count
            }
            wholesale_order {
              ...WholesaleOrderFragment
            
              id
              legacy_id
              version
              fulfillment_flow
              shipping_option
              staging_location_id
              picking_flow
              outbound_progress
              pickup_date
              status
              status_message
              preparation_date
              is_packed_externally
              packing_layout
              order_type
              gs1_labels_required
              trading_partner_id
              trading_partner_name
              store_location_number
              store_address1
              store_city
              store_country
              store_state
              store_zip
              distribution_center
              distribution_center_number
              purchase_order_type
              vendor
              vendor_id
              requested_delivery_date
              ship_not_before_date
              ship_no_later_than_date
              depositor_order_number
              department
              department_number
              division
              service_level
              internal_supplier_number
              terms_of_sale
              retailer_notes
              quote_number
              sales_requirement_code
              reference_fields
              order_id
              order {
                ...OrderFragment
              }
              wholesale_shipping_details {
                ...WholesaleShippingDetailsFragment
              
                id
                legacy_id
                account_number
                scac
                carrier
                shipping_method
                bill_of_lading
                cost
                trailer_number
                pro_number
                gs1_company_prefix
                courier
              }
              wholesale_line_items {
                ...WholesaleLineItemsQuerySpecConnectionFragment
              
                pageInfo {
                  ...PageInfoFragment
                
                  hasNextPage
                  hasPreviousPage
                  startCursor
                  endCursor
                }
                edges {
                  ...WholesaleLineItemsQuerySpecEdgeFragment
                
                  node {
                    ...WholesaleLineItemFragment
                  
                    id
                    legacy_id
                    line_item {
                      ...LineItemFragment
                    }
                    unit_of_measure
                    staged_inventory {
                      ...StagedInventoryItemTypeFragment
                    }
                  }
                  cursor
                }
                total_count
              }
            }
          }
          total_packages
          ready_to_ship
        }
        cursor
      }
      total_count
    }
  }
}

Variables

{
  "ids": ["U2hpcG1lbnQ6MTIzNA==", "U2hpcG1lbnQ6NTY3OA=="],
  "customer_account_id": "QWNjb3VudDoxMjM0",
  "order_id": "T3JkZXI6MTIzNA==",
  "date_from": "2026-07-09T15:30:00Z",
  "date_to": "2026-07-09T15:30:00Z",
  "order_date_from": "2026-07-09T15:30:00Z",
  "order_date_to": "2026-07-09T15:30:00Z",
  "tracking_number": "1Z999AA10123456784",
  "alternate_tracking_id": "UmVjb3JkOjEyMzQ=",
  "voided": true,
  "analyze": true
}

Response

{
  "data": {
    "shipments": {
      "request_id": "UmVjb3JkOjEyMzQ=",
      "complexity": 100,
      "data": [{id: "U2hpcG1lbnRDb25uZWN0aW9uOjEyMzQ="}]
    }
  }
}