Sales Orders API Queries

salesOrder

Retrieves a single Sales Order

This query retrieves a sales order given its Order Nr.

{
  salesOrder(orderNr: 12345) {
    orderNr
    orderDate
    paymentMethod {
      ...languages
    }
    paymentCondition {
      ...languages
    }
    deliveryCondition {
      ...languages
    }
    dateRequestedDelivery
    quantity
    valueNetExVat
    deliveryCharge
    adminCharge
    salesTaxValue
    grandTotal
    isCompleted
    lines {
      lineNr
      productCode
      productColourCode
      assortmentCode
      price
      quantity
      valueNetExVat
      subLines {
        ean13
        sizeCode
        quantity
      }
    }
  }
}

fragment languages on Translatable {
  nl
  de
  en
}

salesOrders

Retrieves all Sales Orders (paginated), and filtered if desired

This query searches all a customer's sales orders. It is paginated with a maximum of 10 orders per result set. This means that multiple requests may be necessary to retrieve all your sales orders.

 

This can be controlled using the Skip and Take parameters. For example, the first request would be Skip:0 & Take:10, the second request would be Skip:10 & Take:10, the third request would be Skip:20 & Take:10, and so on. You can use the TotalResults field to determine how many requests are needed.

 

It is possible to filter the results using several criteria, such as returning only the open orders. Use the Documentation Explorer to see what the options are.

{
  salesOrders(options: {skip: 0, take: 10}) {
    totalResults
    numResults
    results {
      orderNr
      orderDate
      clientReferenceNumber
      clientOrderNumber
      dateRequestedDelivery
      isWhiteLabel
      quantity
      valueNetExVat
      deliveryCharge
      adminCharge
      salesTaxValue
      grandTotal
      openOrderQty
      deliveredQty
      invoicedQty
      cancelledQty
      isCompleted
    }
  }
}