Theme switcher

Update a Custom Order

Path Parameters

order_store_idinteger Required
order_numberstring Required

Body Parameters

orderobject

Custom order information

Show child attributes

Response

200
Object

Update a Custom Order

Response Attributes

idnumber
order_store_typestring
order_store_idstring
order_store_namestring
order_idstring
external_idstring
order_numberstring
sub_order_countstring
order_datestring
payment_statusstring
order_statusstring
shipment_statusstring
items_totalstring

The total cost of all items on the order

tax_totalstring

The total tax amount for the order

totalstring

items_total + tax_total + shipping_total

shipping_totalstring

The amount your system charged the end customer for shipping

notesstring
tagsstring

Tags allow you to add specific indicators to orders. They can indicate which warehouse should fulfill the order, or if some special work is needed to process the order.

itemsarray

Show child attributes

billing_addressobject

Show child attributes

shipping_addressobject

Show child attributes

external_customer_emailstring
external_customer_idstring

The id for the customer in your system

shipping_methodstring

The shipping method/service that your customer picked at checkout, or your system designated based upon delivery windows.

ship_by_datestring

Target ship date

created_atstring
updated_atstring
Was this section helpful?

PUT

/

Select
1

Response

Was this section helpful?
View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot