Skip to main content
PATCH
/
api
/
v1
/
Orders
/
{orderNumber}
Updates an existing order.
curl --request PATCH \
  --url https://api.example.com/api/v1/Orders/{orderNumber} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "orderNumber": "<string>",
  "isOnSitePurchase": false,
  "requestedServiceLevel": "<string>",
  "isResidentialAddress": true,
  "shipToAddress": {
    "firstName": "<string>",
    "middleName": "<string>",
    "lastName": "<string>",
    "companyName": "<string>",
    "address1": "<string>",
    "address2": "<string>",
    "address3": "<string>",
    "city": "<string>",
    "stateOrProvince": "<string>",
    "postalCode": "<string>",
    "countryCode": "US"
  },
  "lineItems": [
    {
      "lineNumber": 123,
      "sku": "<string>",
      "quantity": 123,
      "unitPrice": 123,
      "componentNumber": 123,
      "vasOrderPersonalizations": [
        {
          "type": "<string>",
          "lineNumber": 123,
          "message": "<string>",
          "options": [
            {
              "type": "<string>",
              "option": "<string>",
              "message": "<string>"
            }
          ]
        }
      ]
    }
  ],
  "shipFromWarehouseCode": "<string>",
  "requestedShipDate": "2023-11-07T05:31:56Z",
  "notificationEmail": "<string>",
  "notificationPhoneNumber": "<string>",
  "notificationTemplateCode": "<string>",
  "orderTypeCode": "<string>",
  "giftMessage": "<string>",
  "shippingInstructions": "<string>",
  "packingSlipCode": "<string>",
  "vasOrderPersonalizations": [
    {
      "type": "<string>",
      "lineNumber": 123,
      "message": "<string>",
      "options": [
        {
          "type": "<string>",
          "option": "<string>",
          "message": "<string>"
        }
      ]
    }
  ]
}
'
{
  "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

lineItems
object[]
required

The order line items

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

Email

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

Response

200 - application/json

OK

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