industry-department-solutions
latest
false
Supply Chain & Retail Solutions API guide
- Overview
- API Resources
Transfers API resource representing inter-location stock movements, such as shipments between distribution centres, stores, and warehouses.
Overview
The Transfers resource represents inter-location stock movements, such as goods shipped from a distribution centre to a store or between warehouses. Each record tracks the movement of a specific product along with planned and actual departure details, delivery quantities, and the current transfer status.
Resource Endpoint
/api/v2/ingest/object/{prefix}TRANSFERS{suffix}
/api/v2/ingest/object/{prefix}TRANSFERS{suffix}
Supported Methods
| Method | Return Type | Description |
|---|---|---|
| POST | Response | Ingest (create/update) Transfers 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
- product_id (string) - Unique identifier for the product being transferred. Part of the composite primary key.
- location_id (string) - Unique identifier for the destination location. Part of the composite primary key.
- order_number (string) - Unique identifier for the transfer order. Part of the composite primary key.
Attributes
| Attribute | Data Type | Required | Description |
|---|---|---|---|
product_id | string | Yes | Unique identifier for the product being transferred |
location_id | string | Yes | Unique identifier for the destination location receiving the stock |
order_number | string | Yes | Unique identifier for this transfer order |
source_id | string | Yes | Identifier of the origin location or supplier dispatching the stock |
ordered_at | timestamp | Yes | Datetime when the transfer was initiated |
ordered_units | integer | Yes | Number of units requested in the transfer |
expected_departure_date | timestamp | Yes | Planned datetime for the stock to depart the origin location |
actual_departure_date | timestamp | No | Actual datetime the stock departed the origin location |
expected_delivery_date | timestamp | Yes | Planned datetime for the stock to arrive at the destination location |
actual_delivery_date | timestamp | No | Actual datetime the stock arrived at the destination location |
delivered_units | integer | No | Number of units actually delivered to the destination location |
status | string | No | Current status of the transfer (for example, "pending", "in_transit", "delivered") |
Relationships
Outbound References
The transfers resource does not reference any downstream resources as foreign keys.
Inbound References
The following resources are referenced by transfers:
- products —
product_id→products.product_id - locations —
location_id→locations.location_id
JSON Representation
{
"solutionName": "INV_OOTB",
"data": [
{
"order_number": "TR-2025-001",
"product_id": "PROD-001",
"location_id": "LOC-001",
"source_id": "LOC-002",
"ordered_at": "2025-01-10 09:00:00",
"ordered_units": 100,
"expected_departure_date": "2025-01-14 06:00:00",
"actual_departure_date": "2025-01-14 07:15:00",
"expected_delivery_date": "2025-01-16 06:00:00",
"actual_delivery_date": "2025-01-16 08:30:00",
"delivered_units": 100,
"status": "delivered"
}
],
"operationType": "UPSERT"
}
{
"solutionName": "INV_OOTB",
"data": [
{
"order_number": "TR-2025-001",
"product_id": "PROD-001",
"location_id": "LOC-001",
"source_id": "LOC-002",
"ordered_at": "2025-01-10 09:00:00",
"ordered_units": 100,
"expected_departure_date": "2025-01-14 06:00:00",
"actual_departure_date": "2025-01-14 07:15:00",
"expected_delivery_date": "2025-01-16 06:00:00",
"actual_delivery_date": "2025-01-16 08:30:00",
"delivered_units": 100,
"status": "delivered"
}
],
"operationType": "UPSERT"
}
Example Request
curl -X POST \
'https://ingestion.peak.ai/api/v2/objects/INV_TRANSFERS_OOTB' \
-H 'Authorization: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"solutionName": "INV_OOTB",
"data": [
{
"order_number": "TR-2025-001",
"product_id": "PROD-001",
"location_id": "LOC-001",
"source_id": "LOC-002",
"ordered_at": "2025-01-10 09:00:00",
"ordered_units": 100,
"expected_departure_date": "2025-01-14 06:00:00",
"actual_departure_date": "2025-01-14 07:15:00",
"expected_delivery_date": "2025-01-16 06:00:00",
"actual_delivery_date": "2025-01-16 08:30:00",
"delivered_units": 100,
"status": "delivered"
}
],
"operationType": "UPSERT"
}'
curl -X POST \
'https://ingestion.peak.ai/api/v2/objects/INV_TRANSFERS_OOTB' \
-H 'Authorization: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"solutionName": "INV_OOTB",
"data": [
{
"order_number": "TR-2025-001",
"product_id": "PROD-001",
"location_id": "LOC-001",
"source_id": "LOC-002",
"ordered_at": "2025-01-10 09:00:00",
"ordered_units": 100,
"expected_departure_date": "2025-01-14 06:00:00",
"actual_departure_date": "2025-01-14 07:15:00",
"expected_delivery_date": "2025-01-16 06:00:00",
"actual_delivery_date": "2025-01-16 08:30:00",
"delivered_units": 100,
"status": "delivered"
}
],
"operationType": "UPSERT"
}'
Important Notes
product_id,location_id, andorder_numbertogether form the composite primary key. All three fields must be provided on every record.location_idrepresents the destination location; the origin is captured insource_id, which may reference either a location or a supplier identifier.expected_departure_dateandexpected_delivery_datecapture the planned dispatch and arrival datetimes; populateactual_departure_date,actual_delivery_date, anddelivered_unitsonce the transfer has been dispatched or completed.- All timestamps must be provided in
YYYY-MM-DD HH:MM:SSformat. - Records are ingested via UPSERT: an existing record with matching primary keys will be updated; otherwise a new record is inserted.