purchase_orders

Arguments

Argument	Type	Required	Description
`sku`	`String`	No
`warehouse_id`	`String`	No
`created_from`	ISODateTime	No
`created_to`	ISODateTime	No
`updated_from`	DateTime	No	Based on updates to the Purchase Order Line Items
`updated_to`	DateTime	No	Based on updates to the Purchase Order Line Items
`po_date_from`	ISODateTime	No
`po_date_to`	ISODateTime	No
`customer_account_id`	`String`	No	If you are a 3PL you can specify one of your customer's account
`date_closed_from`	ISODateTime	No
`date_closed_to`	ISODateTime	No
`fulfillment_status`	`String`	No
`po_number`	`String`	No
`analyze`	`Boolean`	No	If true, the query will only be analyzed (cost estimated) without executing it.

Return Type

PurchaseOrdersQueryResult

Query

query purchase_orders(
  $sku: String,
  $warehouse_id: String,
  $created_from: ISODateTime,
  $created_to: ISODateTime,
  $updated_from: DateTime,
  $updated_to: DateTime,
  $po_date_from: ISODateTime,
  $po_date_to: ISODateTime,
  $customer_account_id: String,
  $date_closed_from: ISODateTime,
  $date_closed_to: ISODateTime,
  $fulfillment_status: String,
  $po_number: String,
  $analyze: Boolean
) {
  purchase_orders(
    sku: $sku,
    warehouse_id: $warehouse_id,
    created_from: $created_from,
    created_to: $created_to,
    updated_from: $updated_from,
    updated_to: $updated_to,
    po_date_from: $po_date_from,
    po_date_to: $po_date_to,
    customer_account_id: $customer_account_id,
    date_closed_from: $date_closed_from,
    date_closed_to: $date_closed_to,
    fulfillment_status: $fulfillment_status,
    po_number: $po_number,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...PurchaseOrderConnectionFragment
    
      pageInfo {
        ...PageInfoFragment
      
        hasNextPage
        hasPreviousPage
        startCursor
        endCursor
      }
      edges {
        ...PurchaseOrderEdgeFragment
      
        node {
          ...PurchaseOrderFragment
        
          id
          legacy_id
          po_number
          account_id
          warehouse_id
          vendor_id
          created_at
          po_date
          date_closed
          arrived_at
          packing_note
          fulfillment_status
          po_note
          description
          partner_order_number
          subtotal
          discount
          total_price
          tax
          shipping_method
          shipping_carrier
          shipping_name
          shipping_price
          tracking_number
          pdf
          images
          payment_method
          payment_due_by
          payment_note
          locking
          locked_by_user_id
          line_items {
            ...PurchaseOrderLineItemConnectionFragment
          
            pageInfo {
              ...PageInfoFragment
            
              hasNextPage
              hasPreviousPage
              startCursor
              endCursor
            }
            edges {
              ...PurchaseOrderLineItemEdgeFragment
            
              node {
                ...PurchaseOrderLineItemFragment
              
                id
                legacy_id
                po_id
                account_id
                warehouse_id
                vendor_id
                po_number
                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
                vendor {
                  ...VendorFragment
                
                  id
                  legacy_id
                  name
                  email
                  account_number
                  account_id
                  address {
                    ...AddressFragment
                  
                    name
                    address1
                    address2
                    city
                    state
                    country
                    zip
                    phone
                  }
                  currency
                  internal_note
                  default_po_note
                  logo
                  partner_vendor_id
                  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
                    }
                    return_address {
                      ...AddressFragment
                    }
                    company_name
                    company_alias
                    active
                    products {
                      ...ProductConnectionFragment
                    }
                  }
                  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
                    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
                    }
                    cases {
                      ...CaseFragment
                    }
                  }
                  inbounds {
                    ...WarehouseProductInboundConnectionFragment
                  
                    pageInfo {
                      ...PageInfoFragment
                    }
                    edges {
                      ...WarehouseProductInboundEdgeFragment
                    }
                  }
                  locations {
                    ...ItemLocationConnectionFragment
                  
                    pageInfo {
                      ...PageInfoFragment
                    }
                    edges {
                      ...ItemLocationEdgeFragment
                    }
                  }
                }
                expiration_lots {
                  ...LotConnectionFragment
                
                  pageInfo {
                    ...PageInfoFragment
                  
                    hasNextPage
                    hasPreviousPage
                    startCursor
                    endCursor
                  }
                  edges {
                    ...LotEdgeFragment
                  
                    node {
                      ...LotFragment
                    }
                    cursor
                  }
                }
              }
              cursor
            }
          }
          attachments {
            ...PurchaseOrderAttachmentConnectionFragment
          
            pageInfo {
              ...PageInfoFragment
            
              hasNextPage
              hasPreviousPage
              startCursor
              endCursor
            }
            edges {
              ...PurchaseOrderAttachmentEdgeFragment
            
              node {
                ...PurchaseOrderAttachmentFragment
              
                id
                legacy_id
                url
                user_id
                account_id
                po_li_sku
                description
                filename
                file_type
                file_size
                created_at
              }
              cursor
            }
          }
          vendor {
            ...VendorFragment
          
            id
            legacy_id
            name
            email
            account_number
            account_id
            address {
              ...AddressFragment
            
              name
              address1
              address2
              city
              state
              country
              zip
              phone
            }
            currency
            internal_note
            default_po_note
            logo
            partner_vendor_id
            created_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
                  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
                  }
                  cases {
                    ...CaseFragment
                  
                    id
                    legacy_id
                    case_barcode
                    case_quantity
                  }
                }
                cursor
              }
            }
          }
          origin_of_shipment
          tracking_numbers {
            ...PurchaseOrderTrackingNumberConnectionFragment
          
            pageInfo {
              ...PageInfoFragment
            
              hasNextPage
              hasPreviousPage
              startCursor
              endCursor
            }
            edges {
              ...PurchaseOrderTrackingNumberEdgeFragment
            
              node {
                ...PurchaseOrderTrackingNumberFragment
              
                id
                legacy_id
                po_id
                carrier_id
                carrier_value
                tracking_number
              }
              cursor
            }
          }
          ship_date
        }
        cursor
      }
    }
  }
}

Variables

{
  "sku": "abc123",
  "warehouse_id": "abc123",
  "created_from": ISODateTime,
  "created_to": ISODateTime,
  "updated_from": DateTime,
  "updated_to": DateTime,
  "po_date_from": ISODateTime,
  "po_date_to": ISODateTime,
  "customer_account_id": "abc123",
  "date_closed_from": ISODateTime,
  "date_closed_to": ISODateTime,
  "fulfillment_status": "abc123",
  "po_number": "abc123",
  "analyze": true
}

Response

{
  "data": {
    "purchase_orders": {
      "request_id": "abc123",
      "complexity": 987,
      "data": PurchaseOrderConnection
    }
  }
}