The OrderSync API is a REST API that can be used to pull status, shipping, and invoice information about a Purchase Order (PO) that has been fulfilled and/or synced by OrderSync. Both Purchase Orders that have been fulfilled by OrderSync, and those that have been fulfilled by other means are "synced" on a regular schedule from all supplier portals and include status, shipping, and invoice date (where applicable)
All accessible endpoint in this API have the following base URL:
Base URL
https://api.withordersync.com/api/v2
All requests to any of the endpoints in the API must be authenticated with an API key (see Authentication):
Example Request:
curl -X GET "https://api.withordersync.com/api/v2/orders/by-po/PO12345" \
-H "X-API-Key: pk_live_your_key_here"
A call to the API can either return the Purchase Order Status Payload for the requested POs, or return an error (see Responses).
Example Response Payload:
{
"data": [
{
"po_number": "999999",
"order_date": "2025-00-00T00:00:00+00:00",
"request_date": "2026-00-00T00:00:00+00:00",
"status": "delivered",
"shipping_address": "FULL ADDRESS STRING",
"suppliers": [
"Acushnet"
],
"total": 1000.00,
"quantity": 10,
"items": [
{
"supplier_order_id": "1111111111",
"product_name": "Titleist Clubs",
"quantity": 10,
"status": "delivered",
"supplier_name": "Acushnet",
"price": 120,
"total": 100,
"estimated_delivery_date": "00/00/2026",
"tracking": {
"tracking_number": "XXXXXXXXXXXX",
"tracking_url": "https://www.fedex.com/apps/fedextrack/?tracknumbers=XXXXXXXXXXXX",
"carrier": "fedex",
"actual_delivery_date": "2026-00-00T00:00:00-00:00",
"shipped_date": "2026-03-14T02:58:50.889958+00:00",
"latest_checkpoint": {
"message": "Delivered",
"location": "ADDRESS",
"timestamp": "2026-00-00T00:00:00-00:00"
}
}
}
],
"drop_ship": false,
"invoices": [
{
"invoice_number": "12345678",
"supplier_order_id": "1111111111",
"invoice_date": "2026-00-00T00:00:00+00:00",
"due_date": "2026-00-00T00:00:00+00:00",
"payment_terms": "Net 60 Days",
"subtotal_amount": 1000.00,
"tax_amount": 0,
"shipping_amount": 0,
"total_amount": 1000.00,
"currency": "USD",
"status": "paid",
"supplier_name": "Acushnet",
"updated_at": "2026-00-00T00:00:00.000000+00:00",
"download_url": INVOICE DOWNLOAD LINK
}
]
}
],
"meta": {
"total": 1,
"page": 1,
"limit": 1,
"has_more": false
}
}
The first step to using the API is to create an API key. You will find the instructions on how to create a key on the Authentication & API Keys page.