Updates an existing order.

{
  "isSuccess": true,
  "message": "<string>",
  "payload": [
    "<string>"
  ]
}

PATCH

api

Orders

{orderNumber}

{
  "isSuccess": true,
  "message": "<string>",
  "payload": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

Enter the Bearer AccessToken; Example: 'Bearer 12345abcdef'

Path Parameters

orderNumber

string

required

Body

application/json

orderNumber

string

required

The customer order number

Minimum string length: 1

isOnSitePurchase

boolean

default:false

required

Is this an On Site purchase

requestedServiceLevel

string

required

The carrier service to use. Examples include:

FEDGROUND
UPS2DAY
UPSOVERNIGHT
UP1
UP2
UPO
UPSGROUND
WILLCALL

Minimum string length: 1

isResidentialAddress

boolean

default:true

required

Is the address a residential address

shipToAddress

object

required

A standard Address object

Show child attributes

shipToAddress.firstName

string | null

Maximum string length: 80

shipToAddress.middleName

string | null

Maximum string length: 80

shipToAddress.lastName

string | null

Maximum string length: 80

shipToAddress.companyName

string | null

Maximum string length: 80

shipToAddress.address1

string | null

Maximum string length: 80

shipToAddress.address2

string | null

Maximum string length: 80

shipToAddress.address3

string | null

Maximum string length: 80

shipToAddress.city

string | null

Maximum string length: 80

shipToAddress.stateOrProvince

string | null

Maximum string length: 2

shipToAddress.postalCode

string | null

Maximum string length: 10

shipToAddress.countryCode

string | null

default:US

Maximum string length: 2

lineItems

object[]

required

The order line items

Show child attributes

lineItems.lineNumber

integer<int32>

required

EDITING: The number of the line. 1,2,3,4,5 etc ADDING NEW: Leave Blank

lineItems.sku

string

required

The customer Sku

Minimum string length: 1

lineItems.quantity

integer<int32>

required

How many

lineItems.unitPrice

number<double>

required

Price per unit

lineItems.componentNumber

integer<int32> | null

Leave this blank

lineItems.vasOrderPersonalizations

object[] | null

Value added service personalizations

Show child attributes

lineItems.vasOrderPersonalizations.type

string

required

Required string length: 1 - 80

lineItems.vasOrderPersonalizations.lineNumber

integer<int32> | null

The line number of the SKU this personalization is assigned to. Not required for order header

lineItems.vasOrderPersonalizations.message

string | null

Messaging about the set of value added services

Maximum string length: 2000

lineItems.vasOrderPersonalizations.options

object[] | null

A collection of specific value added services

Show child attributes

lineItems.vasOrderPersonalizations.options.type

string

required

The type of the value added service. Eg a ribbon

Required string length: 1 - 80

lineItems.vasOrderPersonalizations.options.option

string | null

An option applied to the type. eg the color of the type's ribbon.

Maximum string length: 80

lineItems.vasOrderPersonalizations.options.message

string | null

Messaging about the value added service

Maximum string length: 2000

shipFromWarehouseCode

string | null

The From warehouse (Code)

"GLW" - Glenwillow,
"WDI" - Green Island,
"PSO" - Paso Robles,
"SMA" - Santa Maria,
"SHW" - Willamette Valley
"DAL" - Dallas

requestedShipDate

string<date-time> | null

Future ship date. Enter the date you want the order to be processed. We will hold the orders until that date.

eg 2023-12-15

notificationEmail

string | null

Maximum string length: 240

notificationPhoneNumber

string | null

Phone number

Maximum string length: 40

notificationTemplateCode

string | null

The notification to use

orderTypeCode

string | null

The Type of Order (code)

"CLUB" - Club Order
"STND" - Daily Order
"SPCL" - Special Order
"VC"   - Visitor Center
"DAILY" - Daily Order
"SPECIAL" - Special Order
"CORP" - Corp Order

giftMessage

string | null

Gift Message

Maximum string length: 2000

shippingInstructions

string | null

Shipping Instructions

Maximum string length: 1000

packingSlipCode

string | null

The packing slip code

Maximum string length: 80

vasOrderPersonalizations

object[] | null

Value added service personalizations

Show child attributes

vasOrderPersonalizations.type

string

required

Required string length: 1 - 80

vasOrderPersonalizations.lineNumber

integer<int32> | null

The line number of the SKU this personalization is assigned to. Not required for order header

vasOrderPersonalizations.message

string | null

Messaging about the set of value added services

Maximum string length: 2000

vasOrderPersonalizations.options

object[] | null

A collection of specific value added services

Show child attributes

vasOrderPersonalizations.options.type

string

required

The type of the value added service. Eg a ribbon

Required string length: 1 - 80

vasOrderPersonalizations.options.option

string | null

An option applied to the type. eg the color of the type's ribbon.

Maximum string length: 80

vasOrderPersonalizations.options.message

string | null

Messaging about the value added service

Maximum string length: 2000

Response

200 - application/json

Generic container for all service responses

isSuccess

boolean

Was the request successful. If not, the message will have more information.

message

string | null

Any error message

payload

string[] | null

The payload object of the response

Gets a single order based on the order number.Gets the full detail about an order

⌘I

API Documentation

AccessToken

Finances

Inventories

Orders

Products

Shipments

Transfers

Authorizations

Path Parameters

Body

Response