Update Order

Create or fully replace an order and its payments and line items. The request body is the complete order: any payments or line items left out are removed. Returns 200 for both create and update, with the saved order and a warnings array for any references that could not be resolved. The first order sent for a location sets that location's cutover date from its order_date, and the cutover date cannot be changed afterwards. Orders dated before the cutover date are not readable, so send historical orders oldest first.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The company_id

string
required
length ≥ 1

The POS system's unique identifier for the order.

integer
required

The 7shifts location this order belongs to.

Body Params
string | null

The external_id of the revenue center this order belongs to.

string | null

The external_id of the dining option for this order.

string | null

The POS system's identifier for the employee who owns the order.

date-time
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.

date-time | null

When the order was closed. Set this when status becomes closed. ISO 8601 with a UTC offset; stored and returned in UTC.

date-time | null

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.

integer
required

Order net total in cents, as calculated by the POS.

integer
required

Order gross total in cents, as calculated by the POS.

integer | null

Tax total in cents.

integer | null

Discount total in cents.

integer | null

Fee total in cents.

integer | null

Total in cents of non-revenue items on the order, such as gift card sales.

number | null

Number of items on the order.

string
required

Order status: open, closed, voided, deleted, or refund. Orders that are open, closed, or refund count toward sales. Voided and deleted orders are excluded regardless of the totals sent.

date-time | null

When this record was created in the POS.

date-time | null

When this record was last modified in the POS.

payments
array of objects
required

The payments

payments*
line_items
array of objects
required

The line_items

line_items*
Headers
string
^\d{4}-\d{2}-\d{2}$

7shifts API version

uuid

Company GUID

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json