API Explorer

You are viewing an old version of the API

All Versions

Update order

Beta

- PUT /v2/orders/{order_id}

Updates an open order by adding, replacing, or deleting fields.

Open in API Reference

Access Tokens Sign in to populate your access tokens from the developer dashboard Sign In

Parameters

order_id

The ID of the order to update.

string

Body

fields_to_clear

The dot notation paths fields to clear. For example, line_items[uid].note. For more information, see Deleting fields.

string[]

idempotency_key

A value you specify that uniquely identifies this update request.

If you are unsure whether a particular update was applied to an order successfully, you can reattempt it with the same idempotency key without worrying about creating duplicate updates to the order. The latest order version is returned.

For more information, see Idempotency.

Max Length 192

string

order

The sparse order containing only the fields to update and the version to which the update is being applied.

Order

location_id

The ID of the seller location that this order is associated with.

Min Length 1

string

customer_id

The ID of the customer associated with the order.

IMPORTANT: You should specify a customer_id if you want the corresponding payment transactions to be explicitly linked to the customer in the Seller Dashboard. If this field is omitted, the customer_id assigned to any underlying Payment objects is ignored and might result in the creation of new instant profiles.

Max Length 191

string

discounts

The list of all discounts associated with the order.

Discounts can be scoped to either ORDER or LINE_ITEM. For discounts scoped to LINE_ITEM, an OrderLineItemAppliedDiscount must be added to each line item that the discount applies to. For discounts with ORDER scope, the server generates an OrderLineItemAppliedDiscount for every line item.

IMPORTANT: If LINE_ITEM scope is set on any discounts in this field, using the deprecated line_items.discounts field results in an error. Use line_items.applied_discounts instead.

OrderLineItemDiscount [ ]

fulfillments

Details about order fulfillment.

Orders can only be created with at most one fulfillment. However, orders returned by the API might contain multiple fulfillments.

Fulfillment [ ]

line_items

The line items included in the order.

OrderLineItem [ ]

metadata

Application-defined data attached to this order. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (such as personally identifiable information or card details).

Keys written by applications must be 60 characters or less and must be in the character set [a-zA-Z0-9_-]. Entries can also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character.

Values have a maximum length of 255 characters.

An application can have up to 10 entries per metadata field.

Entries written by applications are private and can only be read or modified by the same application.

For more information, see Metadata.

Map<string, string>

pricing_options

Pricing options for an order. The options affect how the order's price is calculated. They can be used, for example, to apply automatic price adjustments that are based on preconfigured pricing rules.

OrderPricingOptions

reference_id

A client-specified ID to associate an entity in another system with this order.

Max Length 40

string

service_charges

A list of service charges applied to the order.

OrderServiceCharge [ ]

source

The origination details of the order.

OrderSource

state

The current state of the order.

string

Select state

OPEN Indicates that the order is open. Open orders can be updated.
COMPLETED Indicates that the order is completed. Completed orders are fully paid. This is a terminal state.
CANCELED Indicates that the order is canceled. Canceled orders are not paid. This is a terminal state.
DRAFT Indicates that the order is in a draft state. Draft orders can be updated, but cannot be paid or fulfilled. For more information, see Create Orders.

taxes

The list of all taxes associated with the order.

Taxes can be scoped to either ORDER or LINE_ITEM. For taxes with LINE_ITEM scope, an OrderLineItemAppliedTax must be added to each line item that the tax applies to. For taxes with ORDER scope, the server generates an OrderLineItemAppliedTax for every line item.

On reads, each tax in the list includes the total amount of that tax applied to the order.

IMPORTANT: If LINE_ITEM scope is set on any taxes in this field, using the deprecated line_items.taxes field results in an error. Use line_items.applied_taxes instead.

OrderLineItemTax [ ]

ticket_name

A short-term identifier for the order (such as a customer first name, table number, or auto-generated order number that resets daily).

Max Length 30

string

version

The version number, which is incremented each time an update is committed to the order. Orders not created through the API do not include a version number and therefore cannot be updated.