industry-department-solutions

latest

false

Supply Chain & Retail Solutions API guide

Last updated Apr 16, 2026

Purchase Order

Overview

The purchase_order resource represents purchase orders for products at specific locations. This resource tracks order details, delivery status, and fulfillment information.

Resource Endpoint

/api/v2/ingest/object/{prefix}PURCHASE_ORDER{suffix}
/api/v2/ingest/object/{prefix}PURCHASE_ORDER{suffix}

Supported Methods

Method	Return Type	Description
POST	Response	Ingest (create/update) purchase order records via UPSERT operation

Request Headers

Header	Required	Description
`Authorization`	Yes	Your Personal Access Token (PAT) from platform.peak.ai
`Content-Type`	Yes	Must be `application/json`

Properties

Primary Keys

order_number (string) - Unique order identifier
product_id (string) - Foreign key reference to products

Attributes

Attribute	Data Type	Required	Description
`order_number`	string	Yes	Unique order number (Primary Key)
`product_id`	string	Yes	Product identifier (Primary Key, Foreign Key)
`location_id`	string	No	Location identifier (Foreign Key)
`order_due_date_at`	datetime	No	When the order is due to be delivered
`ordered_at`	datetime	No	When the order was placed
`ordered_units`	integer	No	Number of units ordered
`purchase_order_id`	string	No	Alternative purchase order identifier
`status`	string	No	Current status of the order
`delivered_units`	integer	No	Number of units delivered
`receipted_units`	integer	No	Number of units receipted/confirmed
`receipt_date`	date	No	Date when goods were receipted
`actual_departure_at`	datetime	No	Actual departure timestamp
`expected_departure_at`	datetime	No	Expected departure timestamp
`created_at`	datetime	No	Timestamp when the record was created
`updated_at`	datetime	No	Timestamp when the record was last updated

Relationships

Outbound References

None

Inbound References

product - Foreign key product_id references product
location - Foreign key location_id references location

JSON Representation

{
  "solutionName": "QP_OOTB",
  "data": [
    {
      "order_number": "PO-2025-001",
      "product_id": "PROD-001",
      "location_id": "LOC-UK-001",
      "order_due_date_at": "2025-02-15T00:00:00Z",
      "ordered_at": "2025-01-20T10:30:00Z",
      "ordered_units": 500,
      "purchase_order_id": "PO-2025-001",
      "status": "In Transit",
      "delivered_units": 0,
      "receipted_units": 0,
      "receipt_date": null,
      "actual_departure_at": "2025-01-22T08:00:00Z",
      "expected_departure_at": "2025-01-21T08:00:00Z",
      "created_at": "2025-01-20T10:30:00Z",
      "updated_at": "2025-01-28T10:00:00Z"
    }
  ],
  "operationType": "UPSERT"
}
{
  "solutionName": "QP_OOTB",
  "data": [
    {
      "order_number": "PO-2025-001",
      "product_id": "PROD-001",
      "location_id": "LOC-UK-001",
      "order_due_date_at": "2025-02-15T00:00:00Z",
      "ordered_at": "2025-01-20T10:30:00Z",
      "ordered_units": 500,
      "purchase_order_id": "PO-2025-001",
      "status": "In Transit",
      "delivered_units": 0,
      "receipted_units": 0,
      "receipt_date": null,
      "actual_departure_at": "2025-01-22T08:00:00Z",
      "expected_departure_at": "2025-01-21T08:00:00Z",
      "created_at": "2025-01-20T10:30:00Z",
      "updated_at": "2025-01-28T10:00:00Z"
    }
  ],
  "operationType": "UPSERT"
}

Example Request

curl -X POST \
  'https://service.peak.ai/ingestion-api/api/v2/ingest/object/QP_PURCHASE_ORDER_OOTB' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "solutionName": "QP_OOTB",
    "data": [
      {
        "order_number": "PO-2025-001",
        "product_id": "PROD-001",
        "location_id": "LOC-UK-001",
        "order_due_date_at": "2025-02-15T00:00:00Z",
        "ordered_at": "2025-01-20T10:30:00Z",
        "ordered_units": 500,
        "purchase_order_id": "PO-2025-001",
        "status": "In Transit",
        "delivered_units": 0,
        "receipted_units": 0,
        "receipt_date": null,
        "actual_departure_at": "2025-01-22T08:00:00Z",
        "expected_departure_at": "2025-01-21T08:00:00Z",
        "created_at": "2025-01-20T10:30:00Z",
        "updated_at": "2025-01-28T10:00:00Z"
      }
    ],
    "operationType": "UPSERT"
  }'
curl -X POST \
  'https://service.peak.ai/ingestion-api/api/v2/ingest/object/QP_PURCHASE_ORDER_OOTB' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "solutionName": "QP_OOTB",
    "data": [
      {
        "order_number": "PO-2025-001",
        "product_id": "PROD-001",
        "location_id": "LOC-UK-001",
        "order_due_date_at": "2025-02-15T00:00:00Z",
        "ordered_at": "2025-01-20T10:30:00Z",
        "ordered_units": 500,
        "purchase_order_id": "PO-2025-001",
        "status": "In Transit",
        "delivered_units": 0,
        "receipted_units": 0,
        "receipt_date": null,
        "actual_departure_at": "2025-01-22T08:00:00Z",
        "expected_departure_at": "2025-01-21T08:00:00Z",
        "created_at": "2025-01-20T10:30:00Z",
        "updated_at": "2025-01-28T10:00:00Z"
      }
    ],
    "operationType": "UPSERT"
  }'

Important Notes

Foreign Key Dependencies: Can reference products and locations
Order Tracking: Tracks the full lifecycle from order placement to receipt
Fulfillment Status: Monitor ordered vs delivered vs receipted units
Departure Tracking: Captures both expected and actual departure times
Custom Attributes: Additional custom attributes can be added using the /PURCHASE_ORDER/add-attribute endpoint
Data Validation: All attributes are validated according to their defined data types

product - Product information
location - Delivery location
stock - Stock levels affected by purchase orders

Was this page helpful?

PREVIOUSProduct Pricing Daily

NEXTSale

Supply Chain & Retail Solutions API guide

Overview​

Resource Endpoint​

Supported Methods​

Request Headers​

Properties​

Primary Keys​

Attributes​

Relationships​

Outbound References​

Inbound References​

JSON Representation​

Example Request​

Important Notes​

Related Resources​