Get Sale Order List

This endpoint returns the list of sale orders owned by the account.

Request

You can get the sale order list by making a GET request to sale-orders resource and the api key.

curl -i https://services.rxrise.com/api/v1/sale-orders?apiKey=YOUR_API_KEY

Pagination

You can paginate the list passing skip and limit as query parameters:

curl -i https://services.rxrise.com/api/v1/sale-orders?skip=10&limit=20&apiKey=YOUR_API_KEY

By default skip is equal to 0 and limit equal to 10.

Response

The response is a list of sale orders and the current pagination of the request.

{
  "results": [
    {
      "id": 1,
      "subtotal": 100.0,
      "status": "pending",
      "trackingNumber": "",
      "trackingUrl": "",
      "shippingCarrier": "",
      "sellerId": 1,
      "buyerId": 2,
      "soPrefix": "SO-1",
      "poPrefix": "PO-1",
      "orderId": 1,
      "createdAt": "2021-11-18T00:00:00.570Z",
      "updatedAt": "2021-11-18T00:00:00.570Z"
    }
  ],
  "pagination": {
    "limit": 1,
    "skip": 0,
    "total": 1
  }
}

Error list

These are the errors returned by this endpoint:

Code	Message	Reason
500	Internal Server Error	Service Not Available