GET
/
v1
/
purchase-order
Get all purchase orders
curl --request GET \
  --url http://localhost:3001/v1/purchase-order \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "purchaseOrderNumber": "<string>",
      "externalId": "<string>",
      "orderDate": "2023-11-07T05:31:56Z",
      "deliveryDate": "2023-11-07T05:31:56Z",
      "supplierId": "<string>",
      "lineItems": [
        {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "productCode": 123,
          "title": "<string>",
          "description": "<string>",
          "quantity": 123,
          "unit": 123,
          "unitPrice": 123,
          "totalPrice": 123,
          "discount": 123,
          "taxRate": 123,
          "taxAmount": 123
        }
      ]
    }
  ],
  "meta": {
    "page": 123,
    "take": 123,
    "itemCount": 123,
    "pageCount": 123,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
order
enum<string>
default:ASC

Choose between ascending and descending order.

Available options:
ASC,
DESC
​
page
number
default:1

Specify the number of the page you want to retrieve.

Required range: x >= 1
​
take
number
default:10

Specify the number of items you want to retrieve per page.

Required range: 1 <= x <= 100
​
purchaseOrderNumber
string

Filter purchase orders by purchase order number.

​
externalId
string

Filter purchase orders by external ID.

​
supplierId
string

Filter purchase orders by supplier ID.

Response

200 - application/json

The response is of type object.