Orders

List Orders

Returns a list of orders for your account.

GET/api/v1/orders

Query Parameters

Parameter	Type	Default	Description
`order_status`	string	-	Filter by order status: `DRAFT`, `SENT_FOR_APPROVAL`, `APPROVED`, `CONFIRMED`, `PARTIALLY_RECEIVED`, `FULLY_RECEIVED`
`order_types`	array	`[FINISHED_GOOD, RAW_MATERIAL]`	Filter by order types: `FINISHED_GOOD`, `RAW_MATERIAL`, `PRODUCTION_ORDER`
`updated_after`	datetime	-	Orders updated after this timestamp (ISO 8601 format, e.g., `2025-01-15T10:30:00Z`)
`date_from`	date	-	Creation date range start (YYYY-MM-DD format, e.g., `2025-01-01`)
`date_to`	date	-	Creation date range end (YYYY-MM-DD format, e.g., `2025-01-31`)
`supplier_names`	array	-	Filter by supplier names

Example Request

curl -X GET "https://api.prediko.io/api/v1/orders?order_status=CONFIRMED" \
  -H "Authorization: Bearer YOUR_API_KEY"

import requests

response = requests.get(
    "https://api.prediko.io/api/v1/orders",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    params={"order_status": "CONFIRMED"}
)
orders = response.json()

const params = new URLSearchParams({
  order_status: "CONFIRMED"
});

const response = await fetch(
  `https://api.prediko.io/api/v1/orders?${params}`,
  {
    headers: { "Authorization": "Bearer YOUR_API_KEY" }
  }
);
const orders = await response.json();

Response

{
  "data": [
    {
      "id": "77de9865-941b-465d-95c0-3614ac2c70dd",
      "reference": "PO-001",
      "order_status": "CONFIRMED",
      "supplier_name": "Acme Corp",
      "order_type": "FINISHED_GOOD",
      "origin": "replenish",
      "quantity_confirmed": 100.0,
      "quantity_received": 50.0,
      "delivery_date": ["2025-02-15"],
      "confirmed_delivery_date": ["2025-02-15"],
      "initial_delivery_date": ["2025-02-15"],
      "warehouse_names": ["Main Warehouse"],
      "cost": 1500.0,
      "currency": "USD",
      "created_at": "2025-01-10T14:30:00.000000"
    }
  ],
  "total": 50
}

Response Fields

Field	Type	Description
`data`	array	List of order objects
`total`	integer	Total number of orders matching the query

Order Object

Field	Type	Description
`id`	string	Unique order identifier (UUID)
`reference`	string	Order/PO name identifier
`order_status`	string	Current order status
`supplier_name`	string	Name of the supplier
`order_type`	string	Type of order (FINISHED_GOOD, RAW_MATERIAL, PRODUCTION_ORDER)
`origin`	string	Order origin (e.g., “replenish”, “plan”, “NEW”)
`quantity_confirmed`	number	Total quantity confirmed
`quantity_received`	number	Total quantity received so far
`delivery_date`	array	Current expected delivery dates
`confirmed_delivery_date`	array	Confirmed delivery dates
`initial_delivery_date`	array	Initial delivery dates
`warehouse_names`	array	List of warehouse names
`cost`	number	Total order cost
`currency`	string	Currency code
`created_at`	datetime	When the order was created

Get Order

Retrieve detailed information about a specific order.

GET/api/v1/orders/{order_id}

Path Parameters

Parameter	Type	Description
`order_id`	string	The unique order identifier

Query Parameters

Parameter	Type	Default	Description
`aggregation_level`	string	`SKU`	Aggregation level: `SKU` (aggregated by SKU), `SKU_LOCATION` (by SKU and warehouse). When `SKU_LOCATION` is used, `warehouse_name` is included in each order part.
`output_format`	string	`JSON`	Output format: `JSON` (standard), `EXCEL` (spreadsheet-friendly), `PDF` (PDF document download)

curl -X GET "https://api.prediko.io/api/v1/orders/PO-001" \
  -H "Authorization: Bearer YOUR_API_KEY"

import requests

order_id = "PO-001"
response = requests.get(
    f"https://api.prediko.io/api/v1/orders/{order_id}",
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)
order = response.json()

PDF Export

To download a PDF of an order:

cURL
Python

curl -X GET "https://api.prediko.io/api/v1/orders/PO-001?output_format=PDF" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -o order.pdf

import requests

order_id = "PO-001"
response = requests.get(
    f"https://api.prediko.io/api/v1/orders/{order_id}",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    params={
        "output_format": "PDF",
        "selected_columns": ["sku_name", "quantity_confirmed", "total_cost"]
    }
)
with open("order.pdf", "wb") as f:
    f.write(response.content)

Response

With `aggregation_level=SKU` (default)

{
  "id": "77de9865-941b-465d-95c0-3614ac2c70dd",
  "reference": "13-jan",
  "order_status": "PARTIALLY_RECEIVED",
  "supplier_name": "VANS",
  "order_type": "FINISHED_GOOD",
  "origin": "replenish",
  "quantity_confirmed": 15.0,
  "quantity_received": 6.0,
  "delivery_date": ["2026-01-18", "2026-01-20"],
  "confirmed_delivery_date": ["2026-01-15", "2026-01-18", "2026-01-20", "2026-01-25"],
  "initial_delivery_date": ["2026-01-15", "2026-01-18", "2026-01-20"],
  "warehouse_names": ["Paris Warehouse", "Paris WH", "Shop location"],
  "cost": 0.0,
  "currency": "EUR",
  "created_at": "2026-01-12T15:03:58.161156",
  "order_parts": [
    {
      "id": "49b89a4b-f8fc-4b4e-a6c7-b0702d384d4b",
      "sku_name": "VN-08-white-5",
      "product_name": "VANS | OLD SKOOL (BUTTERFLY) TRUE WHITE | BLACK",
      "is_material": false,
      "supplier_name": "VANS",
      "supplier_currency": "eur",
      "options": {
        "Color": "white",
        "Size": "5"
      },
      "url": "https://cdn.shopify.com/s/files/1/...",
      "quantity_confirmed": 10.0,
      "received": 6.0,
      "in_transit": 7.0,
      "confirmed_delivery_date": "2026-01-25",
      "initial_delivery_date": "2026-01-20",
      "total_cost": 0.0,
      "barcode": "NaN",
      "moq_met": false,
      "missing_moq": 10,
      "moq": 300,
      "moq_type": "PRODUCT",
      "is_composite": false,
      "pack_quantity": 1,
      "pack_type": "SKU",
      "pack_met": true,
      "packs_to_order": 10.0,
      "is_closed": false
    }
  ]
}

With `aggregation_level=SKU_LOCATION`

When using SKU_LOCATION, each order part includes the warehouse_name field:

{
  "id": "77de9865-941b-465d-95c0-3614ac2c70dd",
  "reference": "13-jan",
  "order_status": "PARTIALLY_RECEIVED",
  "supplier_name": "VANS",
  "order_type": "FINISHED_GOOD",
  "origin": "replenish",
  "quantity_confirmed": 15.0,
  "quantity_received": 6.0,
  "delivery_date": ["2026-01-18", "2026-01-20"],
  "confirmed_delivery_date": ["2026-01-15", "2026-01-18", "2026-01-20", "2026-01-25"],
  "initial_delivery_date": ["2026-01-15", "2026-01-18", "2026-01-20"],
  "warehouse_names": ["Paris Warehouse", "Paris WH", "Shop location"],
  "cost": 0.0,
  "currency": "EUR",
  "created_at": "2026-01-12T15:03:58.161156",
  "order_parts": [
    {
      "id": "49b89a4b-f8fc-4b4e-a6c7-b0702d384d4b",
      "sku_name": "VN-08-white-5",
      "product_name": "VANS | OLD SKOOL (BUTTERFLY) TRUE WHITE | BLACK",
      "warehouse_name": "Paris Warehouse",
      "is_material": false,
      "supplier_name": "VANS",
      "supplier_currency": "eur",
      "options": {
        "Color": "white",
        "Size": "5"
      },
      "url": "https://cdn.shopify.com/s/files/1/...",
      "quantity_confirmed": 10.0,
      "received": 6.0,
      "in_transit": 7.0,
      "confirmed_delivery_date": "2026-01-25",
      "initial_delivery_date": "2026-01-20",
      "total_cost": 0.0,
      "barcode": "NaN",
      "moq_met": false,
      "missing_moq": 10,
      "moq": 300,
      "moq_type": "PRODUCT",
      "is_composite": false,
      "pack_quantity": 1,
      "pack_type": "SKU",
      "pack_met": true,
      "packs_to_order": 10.0,
      "is_closed": false
    }
  ]
}

Order Part Object

Field	Type	Description
`id`	string	Unique part identifier
`sku_name`	string	SKU identifier
`product_name`	string	Product name
`warehouse_name`	string	Warehouse name (only included when `aggregation_level=SKU_LOCATION`)
`is_material`	boolean	Whether this is a raw material
`supplier_name`	string	Supplier name for this line
`supplier_currency`	string	Supplier’s currency
`options`	object	Product variant options (e.g., Color, Size)
`url`	string	Product image URL
`quantity_confirmed`	number	Confirmed quantity
`received`	number	Quantity received
`in_transit`	number	Quantity in transit
`confirmed_delivery_date`	string	Confirmed delivery date for this line
`initial_delivery_date`	string	Initial delivery date
`total_cost`	number	Total cost for this line
`barcode`	string	Product barcode
`moq_met`	boolean	Whether minimum order quantity is met
`missing_moq`	number	Units missing to meet MOQ
`moq`	number	Minimum order quantity
`moq_type`	string	MOQ type (e.g., `PRODUCT`, `SUPPLIER`)
`is_composite`	boolean	Whether this is a composite/bundle product
`pack_quantity`	number	Pack quantity
`pack_type`	string	Pack type (e.g., `SKU`)
`pack_met`	boolean	Whether pack quantity is met
`packs_to_order`	number	Number of packs to order
`is_closed`	boolean	Whether this line is closed. `true` when `received` ≠ `quantity_confirmed` but no more deliveries are expected

Error Responses

Status	Description
404	Order not found
401	Invalid or missing API key

Create or Update Orders

Create or update purchase orders using UPSERT semantics. Uses purchase_order_name as the unique identifier for idempotent operations.

POST/api/v1/orders

Request Body

Field	Type	Required	Description
`data`	array	Yes	Array of PO line items (minimum 1)
`date_format`	string	No	Date format for delivery dates. Default: `YYYY-MM-DD`

PO Line Item Fields

Field	Type	Required	Description
`sku`	string	Yes	Exact SKU identifier
`warehouse`	string	Yes	Warehouse name
`quantity_ordered`	integer	Yes	Total ordered quantity
`quantity_received`	integer	No	Total received so far (cumulative, default: 0)
`supplier`	string	Yes	Supplier name
`purchase_order_name`	string	Yes	Stable PO identifier for updates
`delivery`	string	Yes	Expected delivery date (format depends on `date_format`)
`status`	string	Yes	`DRAFT`, `PARTIALLY_RECEIVED`, or `FULLY_RECEIVED`

Date Formats

The date_format parameter accepts:

JavaScript format: YYYY-MM-DD, DD/MM/YYYY, MM/DD/YYYY
Python strptime format: %Y-%m-%d, %d/%m/%Y, %m/%d/%Y

Status Lifecycle

DRAFT: PO created, nothing received
PARTIALLY_RECEIVED: Some units received
FULLY_RECEIVED: All units received

Example Request

cURL
Python

curl -X POST "https://api.prediko.io/api/v1/orders" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "data": [
      {
        "sku": "SKU-001",
        "warehouse": "Main Warehouse",
        "quantity_ordered": 100,
        "quantity_received": 0,
        "supplier": "Acme Corp",
        "purchase_order_name": "PO-001",
        "delivery": "2025-02-15",
        "status": "DRAFT"
      }
    ]
  }'

import requests

response = requests.post(
    "https://api.prediko.io/api/v1/orders",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
        "data": [
            {
                "sku": "SKU-001",
                "warehouse": "Main Warehouse",
                "quantity_ordered": 100,
                "quantity_received": 0,
                "supplier": "Acme Corp",
                "purchase_order_name": "PO-001",
                "delivery": "2025-02-15",
                "status": "DRAFT"
            }
        ]
    }
)
result = response.json()

Response

On success, the response includes an order_ids array containing the IDs of all created or updated orders:

{
  "errors": [],
  "created_orders": {
    "77de9865-941b-465d-95c0-3614ac2c70dd": "PO-001"
  },
  "order_ids": ["77de9865-941b-465d-95c0-3614ac2c70dd"]
}

Field	Type	Description
`order_ids`	array	List of order IDs that were created or updated
`created_orders`	object	Mapping of order ID to purchase order reference name
`errors`	array	List of errors (empty on full success)

Example: Recording a Receipt

To record units received, send the updated cumulative quantity:

curl -X POST "https://api.prediko.io/api/v1/orders" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "data": [
      {
        "sku": "SKU-001",
        "warehouse": "Main Warehouse",
        "quantity_ordered": 100,
        "quantity_received": 50,
        "supplier": "Acme Corp",
        "purchase_order_name": "PO-001",
        "delivery": "2025-02-15",
        "status": "PARTIALLY_RECEIVED"
      }
    ]
  }'

Update Order Status

Update the status of one or more orders.

PATCH/api/v1/orders/status

Request Body

Field	Type	Required	Description
`order_ids`	array	Yes	List of order IDs to update
`order_status`	string	Yes	New status: `DRAFT`, `SENT_FOR_APPROVAL`, `APPROVED`, `CONFIRMED`, `PARTIALLY_RECEIVED`, or `FULLY_RECEIVED`

Example Request

curl -X PATCH "https://api.prediko.io/api/v1/orders/status" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "order_ids": ["PO-001", "PO-002"],
    "order_status": "CONFIRMED"
  }'

Delete Order

Delete an order by ID.

DELETE/api/v1/orders/{order_id}

Path Parameters

Parameter	Type	Description
`order_id`	string	The unique order identifier

Example Request

curl -X DELETE "https://api.prediko.io/api/v1/orders/PO-001" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "message": "Order 'PO-001' deleted successfully"
}

Error Responses

Status	Description
404	Order not found
401	Invalid or missing API key

Orders

List Orders

Query Parameters

Example Request

Response

Response Fields

Order Object

Get Order

Path Parameters

Query Parameters

Example Request

PDF Export

Response

With aggregation_level=SKU (default)

With aggregation_level=SKU_LOCATION

Order Part Object

Error Responses

Create or Update Orders

Request Body

PO Line Item Fields

Date Formats

Status Lifecycle

Example Request

Response

Example: Recording a Receipt

Update Order Status

Request Body

Example Request

Delete Order

Path Parameters

Example Request

Response

Error Responses

With `aggregation_level=SKU` (default)

With `aggregation_level=SKU_LOCATION`