v1

latestOpenAPI 3.0.0Apache 2.02026-07-142008071.1 MB
V1Transactions

UpdateOrder

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

actionstring required

The action to perform on the order (COMPLETE, CANCEL, or REFUND).

canceled_notestring

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

completed_notestring

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

refunded_notestring

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

shipped_tracking_numberstring

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

Response

Success

btc_price_satoshinumber

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

btc_receive_addressstring

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

buyer_emailstring

The email address of the order's buyer.

buyer_notestring

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

canceled_notestring

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

completed_notestring

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

created_atstring

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

expires_atstring

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

idstring

The order's unique identifier.

payment_idstring

The unique identifier of the payment associated with the order.

promo_codestring

The promo code provided by the buyer, if any.

recipient_namestring

The name of the order's buyer.

recipient_phone_numberstring

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

refunded_notestring

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

statestring

Whether the tax is an ADDITIVE tax or an INCLUSIVE tax.

updated_atstring

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