1. Scayle Resource Center
  2. API Reference
  3. Resources
  4. Orders
  5. List Orders

List Orders

Available Filters

  • filters.s
    • type: string
    • searches in orderId and orderKey
  • filters.orderScope
    • type: string
    • options
      • incomingPackages
      • openFulfillment
      • readyForPickup
  • filters.orderType
    • type: string
    • options
      • pickupCollect
      • fulfillment (subject to change to shippingFulfillment)
      • pickupFulfillment
  • filters.orderStatus
    • type: string
    • options
      • confirmed
      • inFulfillment
      • readyForPickup
      • closed
  • filters.orderItemStatus
    • type: string
    • options
      • confirmed
      • delegated
      • waitingForShipment
      • inPicking
      • picked
      • readyForShipping
      • shipped
      • readyForPickup
      • pickedUp
      • canceled
  • filters.date
    • type: date (YYYY-MM-DD)

Sorting

  • sort
    • options
      • orderId
      • createdAt
  • sortDir
    • options
      • asc
      • desc

Get order count by their scope

Provided scopes can be one or multiple.

  • scopes
    • options
      • incomingPackages
      • openFulfillment
      • readyForPickup