The OrderSync API is a REST API that can be used to pull status and shipping information about a Purchase Order (PO) that has been fulfilled by OrderSync.
All accessible endpoint in this API have the following base URL:
Base URL
https://api.withordersync.com/api/v1
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/v1/orders/by-po/PO12345" \
-H "X-API-Key: pk_live_your_key_here"
A call to the API can either return the Order Status Payload for the requested POs, or return an error (see Responses).
Example Response Payload:
{
"data": [
{
"order_id": "fb2c6b0c-...",
"order_status_id": "7a3d1c1e-...",
"supplier_order_id": "OEM-123",
"order_date": "2024-10-02T14:15:22.000Z",
"po_number": "PO12345",
"item": "Titleist GT 2 Left Hand 9.0 Driver",
"customer": "John Smith",
"supplier": "acushnet",
"status": "in_transit",
"tracking_numbers": ["1Z9999..."],
"tracking_urls": ["https://carrier.example/track/1Z9999..."],
"carrier": "ups",
"eta": "2026-12-25",
"delivery_date": null
}
],
"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.