External module "sdk-sales/src/sdk/getOrderHistory"

getOrderHistory

• getOrderHistory(start?: number, pageSize?: number, options?: Options): Promise<APIErrorResponse | PaginatedOrders>

• Parameters

  • Default value start: number = 0

  • Default value pageSize: number = 10

  • Default value options: Options = {}

  Returns Promise<APIErrorResponse | PaginatedOrders>

  A Promise resolving to an object with pagination info and an array of past orders. When successful, it will append orders to Sales.orders array.

  On success (resolves)

  {
  "start": 0,
  "pageSize": 10,
  "maxResults": 27,
  "orders": [
    {
      "orderNumber": "27JAD89AS",
      "orderDate": "2019-06-05T17:42:54.266Z",
      "orderType": "Parent or Renewal",
      "orderStatus": "Pending,PartiallyPaid,Paid,Cancelled",
      "totalAmount": 10,
      "tax": 10,
      "currency": "USD",
      "products": [
        {
          "sku": "ABCD1234",
          "name": "shoe",
          "quantity": 1
        }
      ],
      "paymentGateway": "PaymentExpress,Spreedly,SlimPayCredit,PayULATAM",
      "lastFour": "1234",
      "nameOnPayment": "Mister Money",
      "creditCardBrand": "Visa"
    }
  ]
  }