Authentication v1
- Identity APIs
- User
- Address
- Auth
User Self Service APIs
- Introduction
- User Self Service APIs
- Authentication APIs
Experiences v2 (XM v2)
- XM
- Pages
- Global Components
- Menu
Experiences v1 (XM v1)
- XM
- Pages
- Global Components
- Menu
Product Catalog
- Product Catalog
- Category
- Product
- Attributes
- Bulk Import
Orders v2 (OMS v2)
- Order Management System
- Order
- Order Attribute
- Developer Guide
- Order Return
- Payment Status
- Package Tracking
- Cross Border
- Order Cancellation
- Appeasement
- Allocation
- Configuration
- Fraud Configuration
- Target Configuration
- Location
- Location Attribute
- Inventory Network
- Inventory
- Inventory Counter
- Inventory Bulk Operation
- Inventory Attribute
- Inventory Upload Log
- Shipment
- Shipping Method
- Webhook
- Notification
- Export
- Invoice
- Fraud
- Backorder Preorder Reservation
- List
Orders v1 (OMS v1)
- Order Management System
- Cart
- Bill To
- Ship To
- Wishlist
- Cart Decoupled
- Warehouse
- Inventory
- Attributes
- List
- Tax/Address Validate
- Shipping
- Payments
- Order
Offers v2
- Offers
- Developer Guide
- Promotion
- Price Kind
- Dynamic Pricing Engine
- Segment
- Coupon
- Coupon Codes
- Product
- Price List
- Attributes
- Item
- Price Guard
- Global Exclusion
- Upload Price CSV
- Pricing
- Redemption
- Exports
Offers v1
- Offers
- Login API
- Promotions
- Pricing
Subscriptions (SMT API)
- Subscriptions API
- Cancellation Reasons
- Subscription Discounts
- Subscriptions
- Subscribers
- Orders
Loyalty (Member)
- Member APIs
- Inquire
- Discounts
- Redeem
- Earn
- Members
Dropship
- Dropship API
- Shipments
- Products
- Invoices
- Connections
- Inventory
- Developer Guide
- Returns
- Orders
Cart API
- Cart
- Order Draft
- Attribute
- Adjustments
- Shipping
- Cart
Checkout API
- Checkout
- Checkout
Customer
- Core Concepts
- Customer Service
- Organization
- User Party
- Organization Group Addresses
- User Internal Party
- Organization Contracts
- Party
- Party Contracts
- Contracts
- User
- Search
- User Trait
- Organization Users
- Address
- User Address
- Trait
- Party Address
- Party Trait
- Organization Group Users
- Internal Party
- Contract Pricelist
- Internal Parties Party
- Account
- Party Account
- Organization Addresses
- Organization Groups
- Individual Addresses
- Users Organization
- Individual
Update single order
Update single order, specified by order ID
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Order ID
Details to update order
Order details to be updated
Ship-to address and phone details
Customer's name
Customer's first name
Customer's middle name or initial
Customer's last name
Street address
Street address field 1
Street address field 2
City name
State name
Postal code
Country name
Customer's phone details
Phone number
Phone type
Bill-to address and phone details
Customer's name
Customer's first name
Customer's middle name or initial
Customer's last name
Street address
Street address field 1
Street address field 2
City name
State name
Postal code
Country name
Customer's phone details
Phone number
Phone type
Payment details
Payment identifier details
Last four digits of credit card number
Card expiration date
Payment method
Payment type
Date on which order is scheduled to be created
Order status
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Order ID
Body
Details to update order
Order details to be updated
Ship-to address and phone details
City name
State name
Postal code
Country name
Bill-to address and phone details
City name
State name
Postal code
Country name
Payment details
Payment method
Payment type
Date on which order is scheduled to be created
Order status
SCHEDULED, CANCELED, SUCCESS, SKIPPED, RETRY, SUBMITTED, FAILED Shipping details
Shipment carrier
Shipment method
Shipment instructions
Shipment tax code
Shipping cost
Shipment tax amount (value, not percentage)
Shipment currency code
Order item update details
Number of items
Item weight amount
Item weight unit
Response
Order details after updating order
Brief response status
Full response message
Order details
Order details
Order status
SCHEDULED, CANCELED, SUCCESS, SKIPPED, RETRY, SUBMITTED, FAILED Total order price
Order currency code
Date on which order is scheduled to be created
Customer information
Customer reference ID
Customer locale (language_country)
Customer's email address
Customer's first name
Customer's last name
Customer's contact number
Customer's middle name or initial
Customer's segments
Customer employee ID
Customer status
ACTIVE, INACTIVE true: Customer is deleted<br />false: Customer is not deleted
If isDeleted=true, time at which the customer was deleted<br />If isDeleted=false, NULL
Time customer was created
Most recent time customer was updated
Customer's communications preferences
true: Customer agrees to be contacted via email<br />false: Customer does not want to be contacted via email
true: Customer agrees to be contacted via text message<br />false: Customer does not want to be contacted via text message
Ship-to address and phone details
City name
State name
Postal code
Country name
Bill-to address and phone details
City name
State name
Postal code
Country name
Payment details
Payment method
Payment type
true: Order is deleted<br />false: Order is not deleted
If isDeleted=true, time at which the order was deleted<br />If isDeleted=false, NULL
Order ID
Total tax on order
Total discount for order (amount, not percentage)
Item details
Item ID
Item SKU
Number of items
Item price details
Item weight amount
Item weight unit
Item name
Item description
Tax details
Shipping details
Shipment carrier
Shipment method
Shipment instructions
Shipment tax code
Shipping cost
Shipment tax amount (value, not percentage)
Shipment currency code
Line item ID
Time order was created
Most recent time order was updated
Most recent time order status was updated
Order retry details
Maximum number of retries
Retry type
PAYMENT RETRY, INTENTORY RETRY, GENERIC RETRY Number of days after which to retry
Number of times to retry order
Was this page helpful?