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.

You should specify a customer_id on the order (or the payment) to ensure that transactions are reliably linked to customers. Omitting this field 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[0] Fulfillment [ ]

delivery_details FulfillmentDeliveryDetails

metadata

Application-defined data attached to this fulfillment. 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>

pickup_details

Contains details for a pickup fulfillment. These details are required when the fulfillment type is PICKUP.

FulfillmentPickupDetails

auto_complete_duration

The duration of time after which an open and accepted pickup fulfillment is automatically moved to the COMPLETED state. The duration must be in RFC 3339 format (for example, "P1W3D").

If not set, this pickup fulfillment remains accepted until it is canceled or completed.

Example for 2 days, 12 hours, 30 minutes, and 15 seconds: P2DT12H30M15S

string

cancel_reason

A description of why the pickup was canceled. The maximum length: 100 characters.

Max Length 100

string

curbside_pickup_details

Specific details for curbside pickup. These details can only be populated if is_curbside_pickup is set to true.

FulfillmentPickupDetailsCurbsidePickupDetails

expires_at

The timestamp indicating when this fulfillment expires if it is not accepted. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). The expiration time can only be set up to 7 days in the future. If expires_at is not set, this pickup fulfillment is automatically accepted when placed.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

string

is_curbside_pickup

If set to true, indicates that this pickup order is for curbside pickup, not in-store pickup.

boolean

note

A note to provide additional instructions about the pickup fulfillment displayed in the Square Point of Sale application and set by the API.

Max Length 500

string

pickup_at

The timestamp that represents the start of the pickup window. Must be in RFC 3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".

For fulfillments with the schedule type ASAP, this is automatically set to the current time plus the expected duration to prepare the fulfillment.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

string

pickup_window_duration

The window of time in which the order should be picked up after the pickup_at timestamp. Must be in RFC 3339 duration format, e.g., "P1W3D". Can be used as an informational guideline for merchants.

Example for 2 days, 12 hours, 30 minutes, and 15 seconds: P2DT12H30M15S

string

prep_time_duration

The duration of time it takes to prepare this fulfillment. The duration must be in RFC 3339 format (for example, "P1W3D").

Example for 2 days, 12 hours, 30 minutes, and 15 seconds: P2DT12H30M15S

string

recipient

Information about the person to pick up this fulfillment from a physical location.

FulfillmentRecipient

address

The address of the fulfillment recipient. This field is required.

If provided, the address overrides the corresponding customer profile value indicated by customer_id.

Address

customer_id

The ID of the customer associated with the fulfillment.

If customer_id is provided, the fulfillment recipient's display_name, email_address, and phone_number are automatically populated from the targeted customer profile. If these fields are set in the request, the request values override the information from the customer profile. If the targeted customer profile does not contain the necessary information and these fields are left unset, the request results in an error.

Max Length 191

string

display_name

The display name of the fulfillment recipient. This field is required.

If provided, the display name overrides the corresponding customer profile value indicated by customer_id.

Max Length 255

string

email_address

The email address of the fulfillment recipient.

If provided, the email address overrides the corresponding customer profile value indicated by customer_id.

Max Length 255

string

phone_number

The phone number of the fulfillment recipient. This field is required.

If provided, the phone number overrides the corresponding customer profile value indicated by customer_id.

Max Length 17

string

schedule_type

The schedule type of the pickup fulfillment. Defaults to SCHEDULED.

string

Select schedule_type

SCHEDULED Indicates that the fulfillment will be picked up at a scheduled pickup time.
ASAP Indicates that the fulfillment will be picked up as soon as possible and should be prepared immediately.

shipment_details

Contains details for a shipment fulfillment. These details are required when the fulfillment type is SHIPMENT.

A shipment fulfillment's relationship to fulfillment state: PROPOSED: A shipment is requested. RESERVED: Fulfillment accepted. Shipment processing. PREPARED: Shipment packaged. Shipping label created. COMPLETED: Package has been shipped. CANCELED: Shipment has been canceled. FAILED: Shipment has failed.

FulfillmentShipmentDetails

state

The state of the fulfillment.

string

Select state

PROPOSED Indicates that the fulfillment has been proposed.
RESERVED Indicates that the fulfillment has been reserved.
PREPARED Indicates that the fulfillment has been prepared.
COMPLETED Indicates that the fulfillment was successfully completed.
CANCELED Indicates that the fulfillment was canceled.
FAILED Indicates that the fulfillment failed to be completed, but was not explicitly canceled.

type

The type of the fulfillment.

string

Select type

PICKUP A recipient to pick up the fulfillment from a physical location.

uid

A unique ID that identifies the fulfillment only within this order.

Max Length 60

string

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).

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.