Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB
V1Transactions

V1UpdateOrder

Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions:

put/v1/{location_id}/orders/{order_id}

Path parameters

location_idstring required

The ID of the order's associated location.

order_idstring required

The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint

Request body

action'COMPLETE' | 'CANCEL' | 'REFUND' required
shipped_tracking_numberstring nullable

The tracking number of the shipment associated with the order. Only valid if action is COMPLETE.

completed_notestring nullable

A merchant-specified note about the completion of the order. Only valid if action is COMPLETE.

refunded_notestring nullable

A merchant-specified note about the refunding of the order. Only valid if action is REFUND.

canceled_notestring nullable

A merchant-specified note about the canceling of the order. Only valid if action is CANCEL.

Response

Success

idstring

The order's unique identifier.

buyer_emailstring nullable

The email address of the order's buyer.

recipient_namestring nullable

The name of the order's buyer.

recipient_phone_numberstring nullable

The phone number to use for the order's delivery.

state'PENDING' | 'OPEN' | 'COMPLETED' | 'CANCELED' | 'REFUNDED' | 'REJECTED'
created_atstring

The time when the order was created, in ISO 8601 format.

updated_atstring

The time when the order was last modified, in ISO 8601 format.

expires_atstring nullable

The time when the order expires if no action is taken, in ISO 8601 format.

payment_idstring nullable

The unique identifier of the payment associated with the order.

buyer_notestring nullable

A note provided by the buyer when the order was created, if any.

completed_notestring nullable

A note provided by the merchant when the order's state was set to COMPLETED, if any

refunded_notestring nullable

A note provided by the merchant when the order's state was set to REFUNDED, if any.

canceled_notestring nullable

A note provided by the merchant when the order's state was set to CANCELED, if any.

promo_codestring nullable

The promo code provided by the buyer, if any.

btc_receive_addressstring nullable

For Bitcoin transactions, the address that the buyer sent Bitcoin to.

btc_price_satoshinumber nullable

For Bitcoin transactions, the price of the buyer's order in satoshi (100 million satoshi equals 1 BTC).