shipping_plan

Fetch shipping plan 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

ShippingPlanQueryResult

Query

query shipping_plan(
  $id: String,
  $analyze: Boolean
) {
  shipping_plan(
    id: $id,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...ShippingPlanFragment
    
      id
      legacy_id
      account_id
      warehouse_id
      created_at
      fulfillment_status
      warehouse_note
      vendor_po_number
      subtotal
      shipping_price
      total_price
      shipping_method
      shipping_carrier
      shipping_name
      tracking_number
      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
                
                  pageInfo {
                    ...PageInfoFragment
                  
                    hasNextPage
                    hasPreviousPage
                    startCursor
                    endCursor
                  }
                  edges {
                    ...WarehouseProductInboundEdgeFragment
                  
                    node {
                      ...WarehouseProductInboundFragment
                    }
                    cursor
                  }
                }
                locations {
                  ...ItemLocationConnectionFragment
                
                  pageInfo {
                    ...PageInfoFragment
                  
                    hasNextPage
                    hasPreviousPage
                    startCursor
                    endCursor
                  }
                  edges {
                    ...ItemLocationEdgeFragment
                  
                    node {
                      ...ItemLocationFragment
                    }
                    cursor
                  }
                }
              }
              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
          }
        }
      }
      pdf_location
      line_items {
        ...ShippingPlanLineItemConnectionFragment
      
        pageInfo {
          ...PageInfoFragment
        
          hasNextPage
          hasPreviousPage
          startCursor
          endCursor
        }
        edges {
          ...ShippingPlanLineItemEdgeFragment
        
          node {
            ...ShippingPlanLineItemFragment
          
            id
            legacy_id
            account_id
            warehouse_id
            sku
            vendor_sku
            product_id
            variant_id
            quantity
            quantity_received
            quantity_rejected
            price
            product_name
            option_title
            expected_weight_in_lbs
            fulfillment_status
            sell_ahead
            note
            partner_line_item_id
            barcode
            updated_at
            created_at
            product {
              ...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
              
                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
                    }
                    cursor
                  }
                }
              }
              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
                }
                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
                }
              }
              inbounds {
                ...WarehouseProductInboundConnectionFragment
              
                pageInfo {
                  ...PageInfoFragment
                
                  hasNextPage
                  hasPreviousPage
                  startCursor
                  endCursor
                }
                edges {
                  ...WarehouseProductInboundEdgeFragment
                
                  node {
                    ...WarehouseProductInboundFragment
                  
                    id
                    legacy_id
                    sku
                    warehouse_id
                    po_id
                    purchase_order_line_item_id
                    po_date
                    quantity
                    quantity_received
                    quantity_rejected
                    sell_ahead
                    status
                  }
                  cursor
                }
              }
              locations {
                ...ItemLocationConnectionFragment
              
                pageInfo {
                  ...PageInfoFragment
                
                  hasNextPage
                  hasPreviousPage
                  startCursor
                  endCursor
                }
                edges {
                  ...ItemLocationEdgeFragment
                
                  node {
                    ...ItemLocationFragment
                  
                    id
                    legacy_id
                    account_id
                    warehouse_id
                    location_id
                    sku
                    quantity
                    loose_quantity
                    allocated_quantity
                    created_at
                    updated_at
                    location {
                      ...LocationFragment
                    }
                    location_type {
                      ...LocationTypeFragment
                    }
                    expiration_lot {
                      ...LotFragment
                    }
                    lpns {
                      ...LicensePlateNumberConnectionFragment
                    }
                    product {
                      ...ProductFragment
                    }
                    warehouse_product {
                      ...WarehouseProductFragment
                    }
                  }
                  cursor
                }
              }
            }
          }
          cursor
        }
      }
      packages {
        ...ShippingPlanPackageConnectionFragment
      
        pageInfo {
          ...PageInfoFragment
        
          hasNextPage
          hasPreviousPage
          startCursor
          endCursor
        }
        edges {
          ...ShippingPlanPackageEdgeFragment
        
          node {
            ...ShippingPlanPackageFragment
          
            id
            legacy_id
            box_number
            line_items {
              ...ShippingPlanPackageLineItemConnectionFragment
            
              pageInfo {
                ...PageInfoFragment
              
                hasNextPage
                hasPreviousPage
                startCursor
                endCursor
              }
              edges {
                ...ShippingPlanPackageLineItemEdgeFragment
              
                node {
                  ...ShippingPlanPackageLineItemFragment
                
                  id
                  legacy_id
                  sku
                  quantity
                  created_at
                  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
                    }
                  }
                }
                cursor
              }
            }
          }
          cursor
        }
      }
      pallets {
        ...ShippingPlanPalletConnectionFragment
      
        pageInfo {
          ...PageInfoFragment
        
          hasNextPage
          hasPreviousPage
          startCursor
          endCursor
        }
        edges {
          ...ShippingPlanPalletEdgeFragment
        
          node {
            ...ShippingPlanPalletFragment
          
            id
            legacy_id
            kind
            quantity
            floor_loaded
            page_size
          }
          cursor
        }
      }
      origin_of_shipment
      tracking_numbers {
        ...ShippingPlanTrackingNumberConnectionFragment
      
        pageInfo {
          ...PageInfoFragment
        
          hasNextPage
          hasPreviousPage
          startCursor
          endCursor
        }
        edges {
          ...ShippingPlanTrackingNumberEdgeFragment
        
          node {
            ...ShippingPlanTrackingNumberFragment
          
            id
            legacy_id
            po_id
            carrier_id
            carrier_value
            tracking_number
          }
          cursor
        }
      }
    }
  }
}

Variables

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

Response

{
  "data": {
    "shipping_plan": {
      "request_id": "UmVjb3JkOjEyMzQ=",
      "complexity": 100,
      "data": {id: "U2hpcHBpbmdQbGFuOjEyMzQ="}
    }
  }
}