7S7shifts
Orders

List Orders

Changed on

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.

get/v2/company/{company_id}/location/{location_id}/orders

Request

  • Base URL
    https://api.7shifts.com
  • Auth
    • OAuth 2
      Authorization codehttps://app.7shifts.com/oauth2/authorize
      Client credentials
      Password
      Token URLhttps://app.7shifts.com/oauth2/token
    • or API key in cookie 7session

Path parameters

company_idinteger required

The company_id

location_idinteger required

The 7shifts location these orders belong to.

Query parameters

order_date_gtestring date-time

It is one representation of ISO8601/RFC3339 date time format.

Example:2023-12-31T15:45:23-06:00

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

order_date_ltestring date-time

It is one representation of ISO8601/RFC3339 date time format.

Example:2023-12-31T15:45:23-06:00

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

modified_gtestring date-time

It is one representation of ISO8601/RFC3339 date time format.

Example:2023-12-31T15:45:23-06:00

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

modified_ltestring date-time

It is one representation of ISO8601/RFC3339 date time format.

Example:2023-12-31T15:45:23-06:00

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

modified_sincestring date-time

It is one representation of ISO8601/RFC3339 date time format.

Example:2023-12-31T15:45:23-06:00

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

status'open' | 'closed' | 'voided' | 'deleted' | 'refund'

Only return orders with this status.

external_user_idstring nullable

Only return orders for this external user id.

cursorstring

Cursor for the next or previous page of results.

limitinteger

The number of results desired per page.

Headers

x-api-versionstring

An API version

Example:2022-05-01

7shifts API version

x-company-guidstring uuid

Company GUID

Response

OK

object'pos_order' required

Example response

{
  "data": [
    {
      "external_id": "10001-ext-id-order",
      "location_id": 24705,
      "revenue_center_external_id": "5678-ext-id-bar",
      "dining_option_external_id": "1234-ext-id-dine-in",
      "external_user_id": "42-ext-id-employee",
      "order_date": "2023-12-31T15:45:23-06:00",
      "closed_date": "2023-12-31T15:45:23-06:00",
      "external_business_date": "2023-12-31T15:45:23-06:00",
      "net_total": 3000,
      "gross_total": 3399,
      "tax": 399,
      "item_count": 2,
      "external_created": "2023-12-31T15:45:23-06:00",
      "external_modified": "2023-12-31T15:45:23-06:00",
      "created": "2023-12-31T21:45:23+00:00",
      "modified": "2023-12-31T21:45:23+00:00",
      "payments": [
        {
          "external_id": "20001-ext-id-payment",
          "order_external_id": "10001-ext-id-order",
          "external_user_id": "42-ext-id-employee",
          "total": 4500,
          "tips": 900,
          "payment_type": "credit",
          "payment_source_type": "visa",
          "status": "closed",
          "external_created": "2023-12-31T15:45:23-06:00",
          "external_modified": "2023-12-31T15:45:23-06:00",
          "created": "2023-12-31T21:45:23+00:00",
          "modified": "2023-12-31T21:45:23+00:00"
        }
      ],
      "line_items": [
        {
          "external_id": "30001-ext-id-line-item",
          "order_external_id": "10001-ext-id-order",
          "quantity": 2,
          "net_total": 2000,
          "gross_total": 2200,
          "is_revenue_item": true,
          "status": "closed",
          "external_created": "2023-12-31T15:45:23-06:00",
          "external_modified": "2023-12-31T15:45:23-06:00",
          "created": "2023-12-31T21:45:23+00:00",
          "modified": "2023-12-31T21:45:23+00:00"
        }
      ],
      "warnings": [
        {
          "code": "unresolved_revenue_center",
          "message": "Revenue center has not been pushed yet; a placeholder was created.",
          "external_id": "5678-ext-id-bar"
        }
      ]
    }
  ]
}

Changes