List orders (filtered)

Request

Paged, filterable order list used by the Orderwerks web app. Supplier users see all of the supplier's orders; customer users see their own.

Accepts user session headers only. Integrators should use GET /v1/orders.

Security

UserGuid and UserToken and SupplierGuid

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

includePercentageFillablestring

Compute percentageFillable per order from current inventory (slower).

Enum:"true""false"

queryStringstring

URL-encoded filter string as built by the web app, e.g. filter_shipped=true&is_quote=0. Individual filter keys may also be passed as top-level query parameters.

curl -i -X GET \
  'https://docs.orderwerks.com/_mock/openapi/v1/orders/list?limit=25&offset=0&includePercentageFillable=true&queryString=string' \
  -H 'supplierGuid: YOUR_API_KEY_HERE' \
  -H 'userGuid: YOUR_API_KEY_HERE' \
  -H 'userToken: YOUR_API_KEY_HERE'

Responses

A page of orders.

Bodyapplication/json

successbooleanrequired

ordersArray of objects(Order)required

totalOrdersintegerrequired

resourcestring

Example:"order"

Response

{
  "success": true,
  "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": [ … ]
    }
  ],
  "totalOrders": 0,
  "resource": "order"
}