v1

latestSwagger 2.02026-07-134272111.8 KB
orders

Update an order associated with a given ID in the eCommerce system. The update API uses the PATCH HTTP verb, so only those fields provided in the order object will be updated, and those fields not provided will be left alone. Updating an order with a specified ID that does not exist will result in an error response</strong>

patch/orders/{id}

Path parameters

idstring required

The ID of the order to update in the eCommerce system

Query parameters

actionstring

An action to perform on the order: cancel, reopen or close. If left blank then the order is updated but no action is taken

Headers

Authorizationstring required

The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'

Request body

couponDiscountnumber double
customerIdnumber double
customerTaxExemptboolean
customerTaxIdinteger
customerTaxIdValidboolean
discountnumber double
emailstring
fulfillmentStatusstring

AWAITING_PROCESSING, PROCESSING, SHIPPED, DELIVERED, WILL_NOT_DELIVER, RETURNED, READY_FOR_PICKUP

globalRefererstring
hiddenboolean
membershipBasedDiscountnumber double
orderCommentsstring
paymentModulestring
paymentStatusstring

AWAITING_PAYMENT, PAID, CANCELLED, REFUNDED, PARTIALLY_REFUNDED, INCOMPLETE

privateAdminNotesstring
refererUrlstring
reversedTaxAppliedboolean
sampleboolean
shippingMethodstring
subtotalnumber double
taxnumber double
totalnumber double
totalAndMembershipBasedDiscountnumber double
volumeDiscountnumber double

Response

OK - Everything worked as expected