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>"
        }
      ]
    }
  ]
}
'

import requests

url = "https://api.example.com/api/v1/Orders/{orderNumber}"

payload = {
    "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>"
                }
            ]
        }
    ]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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>'}]
      }
    ]
  })
};

fetch('https://api.example.com/api/v1/Orders/{orderNumber}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/Orders/{orderNumber}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    '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>'
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/Orders/{orderNumber}"

	payload := strings.NewReader("{\n  \"orderNumber\": \"<string>\",\n  \"isOnSitePurchase\": false,\n  \"requestedServiceLevel\": \"<string>\",\n  \"isResidentialAddress\": true,\n  \"shipToAddress\": {\n    \"firstName\": \"<string>\",\n    \"middleName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"companyName\": \"<string>\",\n    \"address1\": \"<string>\",\n    \"address2\": \"<string>\",\n    \"address3\": \"<string>\",\n    \"city\": \"<string>\",\n    \"stateOrProvince\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"countryCode\": \"US\"\n  },\n  \"lineItems\": [\n    {\n      \"lineNumber\": 123,\n      \"sku\": \"<string>\",\n      \"quantity\": 123,\n      \"unitPrice\": 123,\n      \"componentNumber\": 123,\n      \"vasOrderPersonalizations\": [\n        {\n          \"type\": \"<string>\",\n          \"lineNumber\": 123,\n          \"message\": \"<string>\",\n          \"options\": [\n            {\n              \"type\": \"<string>\",\n              \"option\": \"<string>\",\n              \"message\": \"<string>\"\n            }\n          ]\n        }\n      ]\n    }\n  ],\n  \"shipFromWarehouseCode\": \"<string>\",\n  \"requestedShipDate\": \"2023-11-07T05:31:56Z\",\n  \"notificationEmail\": \"<string>\",\n  \"notificationPhoneNumber\": \"<string>\",\n  \"notificationTemplateCode\": \"<string>\",\n  \"orderTypeCode\": \"<string>\",\n  \"giftMessage\": \"<string>\",\n  \"shippingInstructions\": \"<string>\",\n  \"packingSlipCode\": \"<string>\",\n  \"vasOrderPersonalizations\": [\n    {\n      \"type\": \"<string>\",\n      \"lineNumber\": 123,\n      \"message\": \"<string>\",\n      \"options\": [\n        {\n          \"type\": \"<string>\",\n          \"option\": \"<string>\",\n          \"message\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.example.com/api/v1/Orders/{orderNumber}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"orderNumber\": \"<string>\",\n  \"isOnSitePurchase\": false,\n  \"requestedServiceLevel\": \"<string>\",\n  \"isResidentialAddress\": true,\n  \"shipToAddress\": {\n    \"firstName\": \"<string>\",\n    \"middleName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"companyName\": \"<string>\",\n    \"address1\": \"<string>\",\n    \"address2\": \"<string>\",\n    \"address3\": \"<string>\",\n    \"city\": \"<string>\",\n    \"stateOrProvince\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"countryCode\": \"US\"\n  },\n  \"lineItems\": [\n    {\n      \"lineNumber\": 123,\n      \"sku\": \"<string>\",\n      \"quantity\": 123,\n      \"unitPrice\": 123,\n      \"componentNumber\": 123,\n      \"vasOrderPersonalizations\": [\n        {\n          \"type\": \"<string>\",\n          \"lineNumber\": 123,\n          \"message\": \"<string>\",\n          \"options\": [\n            {\n              \"type\": \"<string>\",\n              \"option\": \"<string>\",\n              \"message\": \"<string>\"\n            }\n          ]\n        }\n      ]\n    }\n  ],\n  \"shipFromWarehouseCode\": \"<string>\",\n  \"requestedShipDate\": \"2023-11-07T05:31:56Z\",\n  \"notificationEmail\": \"<string>\",\n  \"notificationPhoneNumber\": \"<string>\",\n  \"notificationTemplateCode\": \"<string>\",\n  \"orderTypeCode\": \"<string>\",\n  \"giftMessage\": \"<string>\",\n  \"shippingInstructions\": \"<string>\",\n  \"packingSlipCode\": \"<string>\",\n  \"vasOrderPersonalizations\": [\n    {\n      \"type\": \"<string>\",\n      \"lineNumber\": 123,\n      \"message\": \"<string>\",\n      \"options\": [\n        {\n          \"type\": \"<string>\",\n          \"option\": \"<string>\",\n          \"message\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/Orders/{orderNumber}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"orderNumber\": \"<string>\",\n  \"isOnSitePurchase\": false,\n  \"requestedServiceLevel\": \"<string>\",\n  \"isResidentialAddress\": true,\n  \"shipToAddress\": {\n    \"firstName\": \"<string>\",\n    \"middleName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"companyName\": \"<string>\",\n    \"address1\": \"<string>\",\n    \"address2\": \"<string>\",\n    \"address3\": \"<string>\",\n    \"city\": \"<string>\",\n    \"stateOrProvince\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"countryCode\": \"US\"\n  },\n  \"lineItems\": [\n    {\n      \"lineNumber\": 123,\n      \"sku\": \"<string>\",\n      \"quantity\": 123,\n      \"unitPrice\": 123,\n      \"componentNumber\": 123,\n      \"vasOrderPersonalizations\": [\n        {\n          \"type\": \"<string>\",\n          \"lineNumber\": 123,\n          \"message\": \"<string>\",\n          \"options\": [\n            {\n              \"type\": \"<string>\",\n              \"option\": \"<string>\",\n              \"message\": \"<string>\"\n            }\n          ]\n        }\n      ]\n    }\n  ],\n  \"shipFromWarehouseCode\": \"<string>\",\n  \"requestedShipDate\": \"2023-11-07T05:31:56Z\",\n  \"notificationEmail\": \"<string>\",\n  \"notificationPhoneNumber\": \"<string>\",\n  \"notificationTemplateCode\": \"<string>\",\n  \"orderTypeCode\": \"<string>\",\n  \"giftMessage\": \"<string>\",\n  \"shippingInstructions\": \"<string>\",\n  \"packingSlipCode\": \"<string>\",\n  \"vasOrderPersonalizations\": [\n    {\n      \"type\": \"<string>\",\n      \"lineNumber\": 123,\n      \"message\": \"<string>\",\n      \"options\": [\n        {\n          \"type\": \"<string>\",\n          \"option\": \"<string>\",\n          \"message\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

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

PATCH

api

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>"
        }
      ]
    }
  ]
}
'

import requests

url = "https://api.example.com/api/v1/Orders/{orderNumber}"

payload = {
    "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>"
                }
            ]
        }
    ]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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>'}]
      }
    ]
  })
};

fetch('https://api.example.com/api/v1/Orders/{orderNumber}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/Orders/{orderNumber}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    '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>'
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/Orders/{orderNumber}"

	payload := strings.NewReader("{\n  \"orderNumber\": \"<string>\",\n  \"isOnSitePurchase\": false,\n  \"requestedServiceLevel\": \"<string>\",\n  \"isResidentialAddress\": true,\n  \"shipToAddress\": {\n    \"firstName\": \"<string>\",\n    \"middleName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"companyName\": \"<string>\",\n    \"address1\": \"<string>\",\n    \"address2\": \"<string>\",\n    \"address3\": \"<string>\",\n    \"city\": \"<string>\",\n    \"stateOrProvince\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"countryCode\": \"US\"\n  },\n  \"lineItems\": [\n    {\n      \"lineNumber\": 123,\n      \"sku\": \"<string>\",\n      \"quantity\": 123,\n      \"unitPrice\": 123,\n      \"componentNumber\": 123,\n      \"vasOrderPersonalizations\": [\n        {\n          \"type\": \"<string>\",\n          \"lineNumber\": 123,\n          \"message\": \"<string>\",\n          \"options\": [\n            {\n              \"type\": \"<string>\",\n              \"option\": \"<string>\",\n              \"message\": \"<string>\"\n            }\n          ]\n        }\n      ]\n    }\n  ],\n  \"shipFromWarehouseCode\": \"<string>\",\n  \"requestedShipDate\": \"2023-11-07T05:31:56Z\",\n  \"notificationEmail\": \"<string>\",\n  \"notificationPhoneNumber\": \"<string>\",\n  \"notificationTemplateCode\": \"<string>\",\n  \"orderTypeCode\": \"<string>\",\n  \"giftMessage\": \"<string>\",\n  \"shippingInstructions\": \"<string>\",\n  \"packingSlipCode\": \"<string>\",\n  \"vasOrderPersonalizations\": [\n    {\n      \"type\": \"<string>\",\n      \"lineNumber\": 123,\n      \"message\": \"<string>\",\n      \"options\": [\n        {\n          \"type\": \"<string>\",\n          \"option\": \"<string>\",\n          \"message\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.example.com/api/v1/Orders/{orderNumber}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"orderNumber\": \"<string>\",\n  \"isOnSitePurchase\": false,\n  \"requestedServiceLevel\": \"<string>\",\n  \"isResidentialAddress\": true,\n  \"shipToAddress\": {\n    \"firstName\": \"<string>\",\n    \"middleName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"companyName\": \"<string>\",\n    \"address1\": \"<string>\",\n    \"address2\": \"<string>\",\n    \"address3\": \"<string>\",\n    \"city\": \"<string>\",\n    \"stateOrProvince\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"countryCode\": \"US\"\n  },\n  \"lineItems\": [\n    {\n      \"lineNumber\": 123,\n      \"sku\": \"<string>\",\n      \"quantity\": 123,\n      \"unitPrice\": 123,\n      \"componentNumber\": 123,\n      \"vasOrderPersonalizations\": [\n        {\n          \"type\": \"<string>\",\n          \"lineNumber\": 123,\n          \"message\": \"<string>\",\n          \"options\": [\n            {\n              \"type\": \"<string>\",\n              \"option\": \"<string>\",\n              \"message\": \"<string>\"\n            }\n          ]\n        }\n      ]\n    }\n  ],\n  \"shipFromWarehouseCode\": \"<string>\",\n  \"requestedShipDate\": \"2023-11-07T05:31:56Z\",\n  \"notificationEmail\": \"<string>\",\n  \"notificationPhoneNumber\": \"<string>\",\n  \"notificationTemplateCode\": \"<string>\",\n  \"orderTypeCode\": \"<string>\",\n  \"giftMessage\": \"<string>\",\n  \"shippingInstructions\": \"<string>\",\n  \"packingSlipCode\": \"<string>\",\n  \"vasOrderPersonalizations\": [\n    {\n      \"type\": \"<string>\",\n      \"lineNumber\": 123,\n      \"message\": \"<string>\",\n      \"options\": [\n        {\n          \"type\": \"<string>\",\n          \"option\": \"<string>\",\n          \"message\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/Orders/{orderNumber}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"orderNumber\": \"<string>\",\n  \"isOnSitePurchase\": false,\n  \"requestedServiceLevel\": \"<string>\",\n  \"isResidentialAddress\": true,\n  \"shipToAddress\": {\n    \"firstName\": \"<string>\",\n    \"middleName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"companyName\": \"<string>\",\n    \"address1\": \"<string>\",\n    \"address2\": \"<string>\",\n    \"address3\": \"<string>\",\n    \"city\": \"<string>\",\n    \"stateOrProvince\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"countryCode\": \"US\"\n  },\n  \"lineItems\": [\n    {\n      \"lineNumber\": 123,\n      \"sku\": \"<string>\",\n      \"quantity\": 123,\n      \"unitPrice\": 123,\n      \"componentNumber\": 123,\n      \"vasOrderPersonalizations\": [\n        {\n          \"type\": \"<string>\",\n          \"lineNumber\": 123,\n          \"message\": \"<string>\",\n          \"options\": [\n            {\n              \"type\": \"<string>\",\n              \"option\": \"<string>\",\n              \"message\": \"<string>\"\n            }\n          ]\n        }\n      ]\n    }\n  ],\n  \"shipFromWarehouseCode\": \"<string>\",\n  \"requestedShipDate\": \"2023-11-07T05:31:56Z\",\n  \"notificationEmail\": \"<string>\",\n  \"notificationPhoneNumber\": \"<string>\",\n  \"notificationTemplateCode\": \"<string>\",\n  \"orderTypeCode\": \"<string>\",\n  \"giftMessage\": \"<string>\",\n  \"shippingInstructions\": \"<string>\",\n  \"packingSlipCode\": \"<string>\",\n  \"vasOrderPersonalizations\": [\n    {\n      \"type\": \"<string>\",\n      \"lineNumber\": 123,\n      \"message\": \"<string>\",\n      \"options\": [\n        {\n          \"type\": \"<string>\",\n          \"option\": \"<string>\",\n          \"message\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "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

lineItems

object[]

required

The order line items

Show child attributes

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

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

Updates an existing order.

Authorizations

Path Parameters

Body

Response