order

order.update

Update existing order.

put/order.update.json

Request

  • Base URL: https://api.api2cart.com/v1.1
  • URL: https://api.api2cart.com/v1.1/order.update.json
  • Auth: API key in header x-api-key and API key in header x-store-key

Query parameters

order_idstring required

Defines the orders specified by order id

store_idstring

Defines store id where the order should be found

order_statusstring

Defines new order's status

financial_statusstring

Update order financial status to specified

fulfillment_statusstring

Create order with fulfillment status

cancellation_reasonstring

Defines the cancellation reason when the order will be canceled

order_payment_methodstring

Defines order payment method.<br/>Setting order_payment_method on Shopify will also change financial_status field value to 'paid'

commentstring

Specifies order comment

admin_commentstring

Specifies admin's order comment

admin_private_commentstring

Specifies private admin's order comment

invoice_admin_commentstring

Specifies admin's order invoice comment

date_modifiedstring

Specifies order's modification date

date_finishedstring

Specifies order's finished date

send_notificationsboolean

Send notifications to customer after order status was changed

create_invoiceboolean

Determines whether an invoice should be created if it has not already been created

originstring

The source of the order

tagsstring

Order tags

idempotency_keystring

A unique identifier associated with a specific request. Repeated requests with the same <strong>idempotency_key</strong> return a cached response without re-executing the business logic. <strong>Please note that the cache lifetime is 15 minutes.</strong>

Response

successful operation

return_codeinteger
return_messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.