Skip to content

Orders

Sales orders. Orders are created in the PRELIMINARY state and, unless remainInPreliminary is set, are submitted automatically into the supplier's workflow.

Operations

List orders

Request

Paged list of the supplier's orders, newest first, with a reduced projection of each order and its lines (Order_Items carry id, item_no, qty, note and the item's id, name, sku).

API key and secret only. Requests without x-apiKey / x-apiSecret are rejected with a plain-text 400.

Security
ApiKey and ApiSecret
Query
limitinteger, [ 1 .. 100 ]

Number of rows per page.

Default:25
offsetinteger, >= 0

Zero-based page number. The server skips offset * limit rows.

Default:0
from_updated_atstring

Return only orders updated at or after this UTC timestamp (YYYY-MM-DD HH:mm:ss or ISO-8601).

Example:from_updated_at=2026-09-01 00:00:00
namestring

Filter by order number (contains match).

guidstring, (uuid)

Return the single order with this GUID.

curl -i -X GET \
  'https://docs.orderwerks.com/_mock/openapi/v1/orders?limit=25&offset=0&from_updated_at=2026-09-01%2000%3A00%3A00&name=string&guid=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-apiKey: YOUR_API_KEY_HERE' \
  -H 'x-apiSecret: YOUR_API_KEY_HERE'

Responses

A page of orders.

Bodyapplication/json
ordersArray of objects(Order)required
countintegerrequired

Number of orders in this page (not the total).

Response
{
  "orders": [
    {
      "id": 0,
      "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
      "name": "string",
      "api_guid": "string",
      "supplier_id": 0,
      "vendor_id": 0,
      "user_id": 0,
      "catalog_id": 0,
      "price_group_id": 0,
      "category_id": 0,
      "parent_order_id": 0,
      "client_id": 0,
      "project_id": 0,
      "sales_rep_id": 0,
      "ship_to_id": 0,
      "order_state_id": 0,
      "order_source_id": 0,
      "po_no": "string",
      "invoice_no": "string",
      "description": "string",
      "note": "string",
      "internal_note": "string",
      "shipping_instructions": "string",
      "is_quote": true,
      "is_sample": true,
      "is_local_pickup": true,
      "is_local_delivery": true,
      "is_shipped": true,
      "partially_shipped": true,
      "is_on_hold": true,
      "is_cancelled": true,
      "sub_total": 0,
      "tax": 0,
      "shipping": 0,
      "labor": 0,
      "discount": 0,
      "discount_total": 0,
      "other": 0,
      "grand_total": 0,
      "delivery_date": "string",
      "ship_date": "string",
      "do_not_ship_before_date": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "Order_Items": [ … ],
      "Ship_To": { … },
      "Vendor": { … },
      "Catalog": { … },
      "Price_Group": { … },
      "Category": { … },
      "Order_State": { … },
      "User": { … },
      "Supplier": { … },
      "Client": { … },
      "Parent_Order": { … },
      "Order_Detail": {},
      "Order_State_Logs": [ … ],
      "Assigned_Users": [ … ]
    }
  ],
  "count": 0
}