--- title: "List Orders" method: GET path: "/v2/company/{company_id}/location/{location_id}/orders" tags: ["Orders"] --- # List Orders `GET /v2/company/{company_id}/location/{location_id}/orders` ## Request - Base URL: `https://api.7shifts.com` - URL: `https://api.7shifts.com/v2/company/{company_id}/location/{location_id}/orders` - Auth: one of: - OAuth 2 - Authorization code: `https://app.7shifts.com/oauth2/authorize` - Client credentials - Password - Token URL: `https://app.7shifts.com/oauth2/token` - API key in cookie `7session` 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. ## Path parameters - `company_id` integer, required - `location_id` integer, required ## Query parameters - `order_date_gte` string, date-time: It is one representation of ISO8601/RFC3339 date time format. - `order_date_lte` string, date-time: It is one representation of ISO8601/RFC3339 date time format. - `modified_gte` string, date-time: It is one representation of ISO8601/RFC3339 date time format. - `modified_lte` string, date-time: It is one representation of ISO8601/RFC3339 date time format. - `modified_since` string, date-time: It is one representation of ISO8601/RFC3339 date time format. - `status` 'open' | 'closed' | 'voided' | 'deleted' | 'refund' - `external_user_id` string, nullable - `cursor` string - `limit` integer ## Headers - `x-api-version` string: An API version - `x-company-guid` string, uuid ## Response `200` OK - PosOrderPaginated - `object` 'pos_order', required - `data` PosOrder[], required - `external_id` string, required: The POS system's unique identifier for the order. - `location_id` integer, required: The 7shifts location this order belongs to. - `revenue_center_external_id` string, nullable, required: The external_id of the revenue center this order belongs to. - `dining_option_external_id` string, nullable, required: The external_id of the dining option for this order. - `external_user_id` string, nullable, required: The POS system's identifier for the employee who owns the order. - `order_date` string, date-time, nullable, required: When the order was placed. Sets the cutover date on a location's first order. ISO 8601 with a UTC offset; stored and returned in UTC. - `closed_date` string, date-time, nullable, required: When the order was closed. Set this when status becomes closed. ISO 8601 with a UTC offset; stored and returned in UTC. - `external_business_date` string, date-time, nullable, required: The POS business date, used for daily sales roll-ups that can run past midnight. Send a full ISO 8601 date-time with a UTC offset; stored and returned in UTC. - `net_total` integer, required: Order net total in cents, as calculated by the POS. - `gross_total` integer, required: Order gross total in cents, as calculated by the POS. - `tax` integer, nullable, required: Tax total in cents. - `discounts` integer, nullable, required: Discount total in cents. - `fees` integer, nullable, required: Fee total in cents. - `non_revenue_total` integer, nullable, required: Total in cents of non-revenue items on the order, such as gift card sales. - `item_count` number, nullable, required: Number of items on the order. - `status` 'open' | 'closed' | 'voided' | 'deleted' | 'refund', required - `external_created` string, date-time, nullable, required: When this record was created in the POS. - `external_modified` string, date-time, nullable, required: When this record was last modified in the POS. - `created` string, date-time, nullable, required: The 7shifts creation timestamp. - `modified` string, date-time, nullable, required: The 7shifts last-modified timestamp. - `payments` PosPayment[], required: The payments - `external_id` string, nullable: The POS system's unique identifier for the payment. - `order_external_id` string, nullable: The external_id of the parent order. Not needed when sent inline with the order. - `external_user_id` string, nullable: The POS system's identifier for the employee who took the payment. - `total` integer, required: Payment total in cents, as calculated by the POS. - `tips` integer, nullable: Tip amount on this payment in cents. - `gratuities` integer, nullable: Gratuity amount on this payment in cents. - `fees` integer, nullable: Fee amount in cents. - `discounts` integer, nullable: Discount amount in cents. - `payment_type` string, nullable: Payment type: credit, cash, other, or unknown_source. - `payment_source_type` string, nullable: Free-form tender detail from the POS, such as a card brand. - `status` string, nullable: Payment status. Uses a different set of values from order status: open, closed, paid, deleted, PROCESSING, AUTHORIZED_AT_RISK, AUTHORIZED, ERROR, ERROR_NETWORK, DENIED, PROCESSING_VOID, VOIDED_AT_RISK, CANCELLED, CAPTURE_IN_PROGRESS, CAPTURED, or VOIDED. - `external_created` string, date-time, nullable: When this record was created in the POS. - `external_modified` string, date-time, nullable: When this record was last modified in the POS. - `created` string, date-time, nullable: The 7shifts creation timestamp. - `modified` string, date-time, nullable: The 7shifts last-modified timestamp. - `line_items` PosLineItem[], required: The line_items - `external_id` string, nullable: The POS system's unique identifier for the line item. - `order_external_id` string, nullable: The external_id of the parent order. Not needed when sent inline with the order. - `sales_category_external_ids` string[], required: The external_ids of the sales categories this line item belongs to. - `quantity` number, required: The quantity sold. - `net_total` integer, required: Line-item net total in cents. - `gross_total` integer, required: Line-item gross total in cents. - `discounts` integer, nullable: Discount amount in cents. - `fees` integer, nullable: Fee amount in cents. - `is_revenue_item` boolean, required: Whether the line item contributes to revenue. - `status` string, required: Line-item status: open, closed, voided, deleted, or refund. Voided and deleted line items are excluded from sales regardless of the totals sent. - `external_created` string, date-time, nullable: When this record was created in the POS. - `external_modified` string, date-time, nullable: When this record was last modified in the POS. - `created` string, date-time, nullable: The 7shifts creation timestamp. - `modified` string, date-time, nullable: The 7shifts last-modified timestamp. - `warnings` PosOrderWarning[], required: The warnings - `code` string, required: A machine-readable warning code. - `message` string, required: A human-readable description of the warning. - `external_id` string, required: The external_id that could not be resolved. - `meta` object, required - `cursor` Cursor - `current` string, nullable, required: The current cursor. - `prev` string, nullable, required: A cursor for navigating to the previous page. - `next` string, nullable, required: A cursor for navigating to the next page. - `count` integer, nullable, required: The total items in the current cursor. ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `404`: Not found - `409`: Conflict - `422`: Unprocessable Entity - `500`: Unexpected error ## Changes - **2026-11-03** `40e0ef40dfcd`: 1 info - endpoint added [Operation history](https://skmtc.dev/7shifts/apis/7shifts-api/changes/v2/company/:company_id/location/:location_id/orders/get.md) --- [API](https://skmtc.dev/7shifts/apis/7shifts-api.md) - [All operations](https://skmtc.dev/7shifts/apis/7shifts-api/llms.txt) - [OpenAPI document](https://skmtc.dev/7shifts/apis/7shifts-api/revisions/40e0ef40dfcd?raw)