List Purchase Orders

GET /v1/purchaseorders

List all Purchase Orders for an account.

Query parameters

  • page integer

    Page Number

    Minimum value is 1. Default value is 1.

  • pageSize integer

    Page Size

    Default value is 10.

  • status string

    Filter by delivery status

    Values are all or processing. Default value is all.

  • from string

    Filter by orderDate in layout 2006-01-02T15:04:05Z07:00 or 2006-01-02T15:04:05-0700, inclusive

  • to string

    Filter by orderDate in layout 2006-01-02T15:04:05Z07:00 or 2006-01-02T15:04:05-0700, exclusive

Responses

GET /v1/purchaseorders
curl \
 -X GET https://ma-api.maddenanalytics.com/v1/purchaseorders \
 -H "Authorization: $API_KEY"
Response examples (200)
[
  {
    "cancelledDate": "2021-07-19T14:05:22.257Z",
    "completedDate": "2021-07-19T14:05:22.257Z",
    "deliveryStatus": 10,
    "deliveryWindow": "SS24",
    "externalComment": "AW21 - Footwear",
    "externalPurchaseNo": "PO-14534",
    "factory": "Factory B",
    "id": 42,
    "items": [
      {
        "brandName": "Acme",
        "deliveries": [
          {
            "deliveryDate": "2021-10-13T09:05:14.113Z",
            "deliveryID": "RP-14534",
            "quantity": 4
          }
        ],
        "deliveryDate": "2021-07-19T14:05:22.257Z",
        "departureDate": "2021-07-19T14:05:22.257Z",
        "ean": "7340192703345",
        "externalRowID": "21020",
        "externalWarehouseID": "ecom",
        "key": "7340192703345",
        "productName": "Petter",
        "quantity": 4,
        "revisedDeliveryDate": "2021-07-19T14:05:22.257Z",
        "revisedDepartureDate": "2021-07-19T14:05:22.257Z",
        "sku": "123456-001-43",
        "supplier": "Factory B",
        "totalPriceCurrency": "EUR",
        "totalPriceNet": 180,
        "totalPriceVat": 0
      }
    ],
    "label": "string",
    "orderDate": "2021-03-19T14:05:22.257Z",
    "orderType": "Standard",
    "transportMethod": "Air"
  }
]
Response examples (default)
{
  "error": "Error Type (if any)",
  "message": "Message describing the error",
  "statusCode": 400
}