List Orders

get

https://api.7shifts.com/v2/company/{company_id}/location/{location_id}/orders

List the orders for this location, from any integration, including their payments and line items. The order_date range is always bounded to the last 90 days, regardless of any other filters supplied.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

company_id

integer

required

The company_id

location_id

integer

required

The 7shifts location these orders belong to.

Query Params

order_date_gte

date-time

Only return orders with an order_date on or after this date. Bounded to at most 90 days in the past.

order_date_lte

date-time

Only return orders with an order_date on or before this date.

modified_gte

date-time

Only return orders modified on or after this date. Cannot be combined with modified_since.

modified_lte

date-time

Only return orders modified on or before this date. Cannot be combined with modified_since.

modified_since

date-time

Only return orders modified on or after this date. Cannot be combined with modified_gte or modified_lte.

status

string

enum

Only return orders with this status.

Allowed:

external_user_id

string | null

Only return orders for this external user id.

cursor

string

Cursor for the next or previous page of results.

limit

int64

The number of results desired per page.

Headers

x-api-version

string

^\d{4}-\d{2}-\d{2}$

7shifts API version

x-company-guid

uuid

Company GUID

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not found

409Conflict

422Unprocessable Entity

500Unexpected error