Mass update orders
curl --request POST \
--url https://{base_url_domain}/api/global/v1/shipping/orders/massUpdate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"orders": {
"ids": [
2
]
},
"actions": {
"setValues": {
"order_reference": "O-382227",
"require_overbox": false,
"require_signature": "adult",
"require_saturday_delivery": false,
"desired_delivery_date": "2021-02-21",
"shipping_method": "ups_03",
"third_party_billing_group_id": 12,
"custom_greeting": "<string>",
"note": "<string>",
"declared_value_service": true,
"declared_value": {
"amount": 99,
"currency": "USD"
},
"backorder_policy": "default",
"reason_for_export": "sold",
"priority": 50,
"allocation_options": {},
"requested_ship_date": "2021-02-21T07:00:00Z",
"other_shipping_options": {},
"batch_tag": "Smalls-CartA",
"telephone": "865-971-4663",
"email": "celina.goalley@thompson-torp.com"
},
"updateAllocationOptions": {
"set": {
"algorithms": [
"default"
]
},
"unset": [
"dynamic_allocation"
]
},
"updateOtherShippingOptions": {
"merge": {
"reference_numbers": {
"invoice": null
}
}
},
"hold": {
"until": "2017-07-21T17:32:28Z",
"comment": "<string>"
},
"unhold": {
"comment": "<string>"
},
"unlockFromWarehouse": {}
},
"onError": "continue"
}
'import requests
url = "https://{base_url_domain}/api/global/v1/shipping/orders/massUpdate"
payload = {
"orders": { "ids": [2] },
"actions": {
"setValues": {
"order_reference": "O-382227",
"require_overbox": False,
"require_signature": "adult",
"require_saturday_delivery": False,
"desired_delivery_date": "2021-02-21",
"shipping_method": "ups_03",
"third_party_billing_group_id": 12,
"custom_greeting": "<string>",
"note": "<string>",
"declared_value_service": True,
"declared_value": {
"amount": 99,
"currency": "USD"
},
"backorder_policy": "default",
"reason_for_export": "sold",
"priority": 50,
"allocation_options": {},
"requested_ship_date": "2021-02-21T07:00:00Z",
"other_shipping_options": {},
"batch_tag": "Smalls-CartA",
"telephone": "865-971-4663",
"email": "celina.goalley@thompson-torp.com"
},
"updateAllocationOptions": {
"set": { "algorithms": ["default"] },
"unset": ["dynamic_allocation"]
},
"updateOtherShippingOptions": { "merge": { "reference_numbers": { "invoice": None } } },
"hold": {
"until": "2017-07-21T17:32:28Z",
"comment": "<string>"
},
"unhold": { "comment": "<string>" },
"unlockFromWarehouse": {}
},
"onError": "continue"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
orders: {ids: [2]},
actions: {
setValues: {
order_reference: 'O-382227',
require_overbox: false,
require_signature: 'adult',
require_saturday_delivery: false,
desired_delivery_date: '2021-02-21',
shipping_method: 'ups_03',
third_party_billing_group_id: 12,
custom_greeting: '<string>',
note: '<string>',
declared_value_service: true,
declared_value: {amount: 99, currency: 'USD'},
backorder_policy: 'default',
reason_for_export: 'sold',
priority: 50,
allocation_options: {},
requested_ship_date: '2021-02-21T07:00:00Z',
other_shipping_options: {},
batch_tag: 'Smalls-CartA',
telephone: '865-971-4663',
email: 'celina.goalley@thompson-torp.com'
},
updateAllocationOptions: {set: {algorithms: ['default']}, unset: ['dynamic_allocation']},
updateOtherShippingOptions: {merge: {reference_numbers: {invoice: null}}},
hold: {until: '2017-07-21T17:32:28Z', comment: '<string>'},
unhold: {comment: '<string>'},
unlockFromWarehouse: {}
},
onError: 'continue'
})
};
fetch('https://{base_url_domain}/api/global/v1/shipping/orders/massUpdate', 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://{base_url_domain}/api/global/v1/shipping/orders/massUpdate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'orders' => [
'ids' => [
2
]
],
'actions' => [
'setValues' => [
'order_reference' => 'O-382227',
'require_overbox' => false,
'require_signature' => 'adult',
'require_saturday_delivery' => false,
'desired_delivery_date' => '2021-02-21',
'shipping_method' => 'ups_03',
'third_party_billing_group_id' => 12,
'custom_greeting' => '<string>',
'note' => '<string>',
'declared_value_service' => true,
'declared_value' => [
'amount' => 99,
'currency' => 'USD'
],
'backorder_policy' => 'default',
'reason_for_export' => 'sold',
'priority' => 50,
'allocation_options' => [
],
'requested_ship_date' => '2021-02-21T07:00:00Z',
'other_shipping_options' => [
],
'batch_tag' => 'Smalls-CartA',
'telephone' => '865-971-4663',
'email' => 'celina.goalley@thompson-torp.com'
],
'updateAllocationOptions' => [
'set' => [
'algorithms' => [
'default'
]
],
'unset' => [
'dynamic_allocation'
]
],
'updateOtherShippingOptions' => [
'merge' => [
'reference_numbers' => [
'invoice' => null
]
]
],
'hold' => [
'until' => '2017-07-21T17:32:28Z',
'comment' => '<string>'
],
'unhold' => [
'comment' => '<string>'
],
'unlockFromWarehouse' => [
]
],
'onError' => 'continue'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://{base_url_domain}/api/global/v1/shipping/orders/massUpdate"
payload := strings.NewReader("{\n \"orders\": {\n \"ids\": [\n 2\n ]\n },\n \"actions\": {\n \"setValues\": {\n \"order_reference\": \"O-382227\",\n \"require_overbox\": false,\n \"require_signature\": \"adult\",\n \"require_saturday_delivery\": false,\n \"desired_delivery_date\": \"2021-02-21\",\n \"shipping_method\": \"ups_03\",\n \"third_party_billing_group_id\": 12,\n \"custom_greeting\": \"<string>\",\n \"note\": \"<string>\",\n \"declared_value_service\": true,\n \"declared_value\": {\n \"amount\": 99,\n \"currency\": \"USD\"\n },\n \"backorder_policy\": \"default\",\n \"reason_for_export\": \"sold\",\n \"priority\": 50,\n \"allocation_options\": {},\n \"requested_ship_date\": \"2021-02-21T07:00:00Z\",\n \"other_shipping_options\": {},\n \"batch_tag\": \"Smalls-CartA\",\n \"telephone\": \"865-971-4663\",\n \"email\": \"celina.goalley@thompson-torp.com\"\n },\n \"updateAllocationOptions\": {\n \"set\": {\n \"algorithms\": [\n \"default\"\n ]\n },\n \"unset\": [\n \"dynamic_allocation\"\n ]\n },\n \"updateOtherShippingOptions\": {\n \"merge\": {\n \"reference_numbers\": {\n \"invoice\": null\n }\n }\n },\n \"hold\": {\n \"until\": \"2017-07-21T17:32:28Z\",\n \"comment\": \"<string>\"\n },\n \"unhold\": {\n \"comment\": \"<string>\"\n },\n \"unlockFromWarehouse\": {}\n },\n \"onError\": \"continue\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.post("https://{base_url_domain}/api/global/v1/shipping/orders/massUpdate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"orders\": {\n \"ids\": [\n 2\n ]\n },\n \"actions\": {\n \"setValues\": {\n \"order_reference\": \"O-382227\",\n \"require_overbox\": false,\n \"require_signature\": \"adult\",\n \"require_saturday_delivery\": false,\n \"desired_delivery_date\": \"2021-02-21\",\n \"shipping_method\": \"ups_03\",\n \"third_party_billing_group_id\": 12,\n \"custom_greeting\": \"<string>\",\n \"note\": \"<string>\",\n \"declared_value_service\": true,\n \"declared_value\": {\n \"amount\": 99,\n \"currency\": \"USD\"\n },\n \"backorder_policy\": \"default\",\n \"reason_for_export\": \"sold\",\n \"priority\": 50,\n \"allocation_options\": {},\n \"requested_ship_date\": \"2021-02-21T07:00:00Z\",\n \"other_shipping_options\": {},\n \"batch_tag\": \"Smalls-CartA\",\n \"telephone\": \"865-971-4663\",\n \"email\": \"celina.goalley@thompson-torp.com\"\n },\n \"updateAllocationOptions\": {\n \"set\": {\n \"algorithms\": [\n \"default\"\n ]\n },\n \"unset\": [\n \"dynamic_allocation\"\n ]\n },\n \"updateOtherShippingOptions\": {\n \"merge\": {\n \"reference_numbers\": {\n \"invoice\": null\n }\n }\n },\n \"hold\": {\n \"until\": \"2017-07-21T17:32:28Z\",\n \"comment\": \"<string>\"\n },\n \"unhold\": {\n \"comment\": \"<string>\"\n },\n \"unlockFromWarehouse\": {}\n },\n \"onError\": \"continue\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{base_url_domain}/api/global/v1/shipping/orders/massUpdate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"orders\": {\n \"ids\": [\n 2\n ]\n },\n \"actions\": {\n \"setValues\": {\n \"order_reference\": \"O-382227\",\n \"require_overbox\": false,\n \"require_signature\": \"adult\",\n \"require_saturday_delivery\": false,\n \"desired_delivery_date\": \"2021-02-21\",\n \"shipping_method\": \"ups_03\",\n \"third_party_billing_group_id\": 12,\n \"custom_greeting\": \"<string>\",\n \"note\": \"<string>\",\n \"declared_value_service\": true,\n \"declared_value\": {\n \"amount\": 99,\n \"currency\": \"USD\"\n },\n \"backorder_policy\": \"default\",\n \"reason_for_export\": \"sold\",\n \"priority\": 50,\n \"allocation_options\": {},\n \"requested_ship_date\": \"2021-02-21T07:00:00Z\",\n \"other_shipping_options\": {},\n \"batch_tag\": \"Smalls-CartA\",\n \"telephone\": \"865-971-4663\",\n \"email\": \"celina.goalley@thompson-torp.com\"\n },\n \"updateAllocationOptions\": {\n \"set\": {\n \"algorithms\": [\n \"default\"\n ]\n },\n \"unset\": [\n \"dynamic_allocation\"\n ]\n },\n \"updateOtherShippingOptions\": {\n \"merge\": {\n \"reference_numbers\": {\n \"invoice\": null\n }\n }\n },\n \"hold\": {\n \"until\": \"2017-07-21T17:32:28Z\",\n \"comment\": \"<string>\"\n },\n \"unhold\": {\n \"comment\": \"<string>\"\n },\n \"unlockFromWarehouse\": {}\n },\n \"onError\": \"continue\"\n}"
response = http.request(request)
puts response.read_body{
"loaded": 1,
"committed": 1,
"failed": 1,
"not-found": 1,
"results": [
{
"resource": {
"type": "Order",
"id": 2
},
"message": "<string>",
"details": {
"updatePriority": {
"message": "<string>",
"new_value": 123
},
"lockToWarehouse": {
"message": "<string>"
},
"unlockFromWarehouse": {
"message": "<string>"
},
"cancel": {
"message": "<string>"
},
"hold": {
"message": "<string>"
},
"unhold": {
"message": "<string>"
}
}
}
],
"meta": {
"processing_time": 123
}
}Orders
Mass update orders
Updates a batch of orders specified by and according to the request body.
POST
/
v1
/
shipping
/
orders
/
massUpdate
Mass update orders
curl --request POST \
--url https://{base_url_domain}/api/global/v1/shipping/orders/massUpdate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"orders": {
"ids": [
2
]
},
"actions": {
"setValues": {
"order_reference": "O-382227",
"require_overbox": false,
"require_signature": "adult",
"require_saturday_delivery": false,
"desired_delivery_date": "2021-02-21",
"shipping_method": "ups_03",
"third_party_billing_group_id": 12,
"custom_greeting": "<string>",
"note": "<string>",
"declared_value_service": true,
"declared_value": {
"amount": 99,
"currency": "USD"
},
"backorder_policy": "default",
"reason_for_export": "sold",
"priority": 50,
"allocation_options": {},
"requested_ship_date": "2021-02-21T07:00:00Z",
"other_shipping_options": {},
"batch_tag": "Smalls-CartA",
"telephone": "865-971-4663",
"email": "celina.goalley@thompson-torp.com"
},
"updateAllocationOptions": {
"set": {
"algorithms": [
"default"
]
},
"unset": [
"dynamic_allocation"
]
},
"updateOtherShippingOptions": {
"merge": {
"reference_numbers": {
"invoice": null
}
}
},
"hold": {
"until": "2017-07-21T17:32:28Z",
"comment": "<string>"
},
"unhold": {
"comment": "<string>"
},
"unlockFromWarehouse": {}
},
"onError": "continue"
}
'import requests
url = "https://{base_url_domain}/api/global/v1/shipping/orders/massUpdate"
payload = {
"orders": { "ids": [2] },
"actions": {
"setValues": {
"order_reference": "O-382227",
"require_overbox": False,
"require_signature": "adult",
"require_saturday_delivery": False,
"desired_delivery_date": "2021-02-21",
"shipping_method": "ups_03",
"third_party_billing_group_id": 12,
"custom_greeting": "<string>",
"note": "<string>",
"declared_value_service": True,
"declared_value": {
"amount": 99,
"currency": "USD"
},
"backorder_policy": "default",
"reason_for_export": "sold",
"priority": 50,
"allocation_options": {},
"requested_ship_date": "2021-02-21T07:00:00Z",
"other_shipping_options": {},
"batch_tag": "Smalls-CartA",
"telephone": "865-971-4663",
"email": "celina.goalley@thompson-torp.com"
},
"updateAllocationOptions": {
"set": { "algorithms": ["default"] },
"unset": ["dynamic_allocation"]
},
"updateOtherShippingOptions": { "merge": { "reference_numbers": { "invoice": None } } },
"hold": {
"until": "2017-07-21T17:32:28Z",
"comment": "<string>"
},
"unhold": { "comment": "<string>" },
"unlockFromWarehouse": {}
},
"onError": "continue"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
orders: {ids: [2]},
actions: {
setValues: {
order_reference: 'O-382227',
require_overbox: false,
require_signature: 'adult',
require_saturday_delivery: false,
desired_delivery_date: '2021-02-21',
shipping_method: 'ups_03',
third_party_billing_group_id: 12,
custom_greeting: '<string>',
note: '<string>',
declared_value_service: true,
declared_value: {amount: 99, currency: 'USD'},
backorder_policy: 'default',
reason_for_export: 'sold',
priority: 50,
allocation_options: {},
requested_ship_date: '2021-02-21T07:00:00Z',
other_shipping_options: {},
batch_tag: 'Smalls-CartA',
telephone: '865-971-4663',
email: 'celina.goalley@thompson-torp.com'
},
updateAllocationOptions: {set: {algorithms: ['default']}, unset: ['dynamic_allocation']},
updateOtherShippingOptions: {merge: {reference_numbers: {invoice: null}}},
hold: {until: '2017-07-21T17:32:28Z', comment: '<string>'},
unhold: {comment: '<string>'},
unlockFromWarehouse: {}
},
onError: 'continue'
})
};
fetch('https://{base_url_domain}/api/global/v1/shipping/orders/massUpdate', 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://{base_url_domain}/api/global/v1/shipping/orders/massUpdate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'orders' => [
'ids' => [
2
]
],
'actions' => [
'setValues' => [
'order_reference' => 'O-382227',
'require_overbox' => false,
'require_signature' => 'adult',
'require_saturday_delivery' => false,
'desired_delivery_date' => '2021-02-21',
'shipping_method' => 'ups_03',
'third_party_billing_group_id' => 12,
'custom_greeting' => '<string>',
'note' => '<string>',
'declared_value_service' => true,
'declared_value' => [
'amount' => 99,
'currency' => 'USD'
],
'backorder_policy' => 'default',
'reason_for_export' => 'sold',
'priority' => 50,
'allocation_options' => [
],
'requested_ship_date' => '2021-02-21T07:00:00Z',
'other_shipping_options' => [
],
'batch_tag' => 'Smalls-CartA',
'telephone' => '865-971-4663',
'email' => 'celina.goalley@thompson-torp.com'
],
'updateAllocationOptions' => [
'set' => [
'algorithms' => [
'default'
]
],
'unset' => [
'dynamic_allocation'
]
],
'updateOtherShippingOptions' => [
'merge' => [
'reference_numbers' => [
'invoice' => null
]
]
],
'hold' => [
'until' => '2017-07-21T17:32:28Z',
'comment' => '<string>'
],
'unhold' => [
'comment' => '<string>'
],
'unlockFromWarehouse' => [
]
],
'onError' => 'continue'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://{base_url_domain}/api/global/v1/shipping/orders/massUpdate"
payload := strings.NewReader("{\n \"orders\": {\n \"ids\": [\n 2\n ]\n },\n \"actions\": {\n \"setValues\": {\n \"order_reference\": \"O-382227\",\n \"require_overbox\": false,\n \"require_signature\": \"adult\",\n \"require_saturday_delivery\": false,\n \"desired_delivery_date\": \"2021-02-21\",\n \"shipping_method\": \"ups_03\",\n \"third_party_billing_group_id\": 12,\n \"custom_greeting\": \"<string>\",\n \"note\": \"<string>\",\n \"declared_value_service\": true,\n \"declared_value\": {\n \"amount\": 99,\n \"currency\": \"USD\"\n },\n \"backorder_policy\": \"default\",\n \"reason_for_export\": \"sold\",\n \"priority\": 50,\n \"allocation_options\": {},\n \"requested_ship_date\": \"2021-02-21T07:00:00Z\",\n \"other_shipping_options\": {},\n \"batch_tag\": \"Smalls-CartA\",\n \"telephone\": \"865-971-4663\",\n \"email\": \"celina.goalley@thompson-torp.com\"\n },\n \"updateAllocationOptions\": {\n \"set\": {\n \"algorithms\": [\n \"default\"\n ]\n },\n \"unset\": [\n \"dynamic_allocation\"\n ]\n },\n \"updateOtherShippingOptions\": {\n \"merge\": {\n \"reference_numbers\": {\n \"invoice\": null\n }\n }\n },\n \"hold\": {\n \"until\": \"2017-07-21T17:32:28Z\",\n \"comment\": \"<string>\"\n },\n \"unhold\": {\n \"comment\": \"<string>\"\n },\n \"unlockFromWarehouse\": {}\n },\n \"onError\": \"continue\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.post("https://{base_url_domain}/api/global/v1/shipping/orders/massUpdate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"orders\": {\n \"ids\": [\n 2\n ]\n },\n \"actions\": {\n \"setValues\": {\n \"order_reference\": \"O-382227\",\n \"require_overbox\": false,\n \"require_signature\": \"adult\",\n \"require_saturday_delivery\": false,\n \"desired_delivery_date\": \"2021-02-21\",\n \"shipping_method\": \"ups_03\",\n \"third_party_billing_group_id\": 12,\n \"custom_greeting\": \"<string>\",\n \"note\": \"<string>\",\n \"declared_value_service\": true,\n \"declared_value\": {\n \"amount\": 99,\n \"currency\": \"USD\"\n },\n \"backorder_policy\": \"default\",\n \"reason_for_export\": \"sold\",\n \"priority\": 50,\n \"allocation_options\": {},\n \"requested_ship_date\": \"2021-02-21T07:00:00Z\",\n \"other_shipping_options\": {},\n \"batch_tag\": \"Smalls-CartA\",\n \"telephone\": \"865-971-4663\",\n \"email\": \"celina.goalley@thompson-torp.com\"\n },\n \"updateAllocationOptions\": {\n \"set\": {\n \"algorithms\": [\n \"default\"\n ]\n },\n \"unset\": [\n \"dynamic_allocation\"\n ]\n },\n \"updateOtherShippingOptions\": {\n \"merge\": {\n \"reference_numbers\": {\n \"invoice\": null\n }\n }\n },\n \"hold\": {\n \"until\": \"2017-07-21T17:32:28Z\",\n \"comment\": \"<string>\"\n },\n \"unhold\": {\n \"comment\": \"<string>\"\n },\n \"unlockFromWarehouse\": {}\n },\n \"onError\": \"continue\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{base_url_domain}/api/global/v1/shipping/orders/massUpdate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"orders\": {\n \"ids\": [\n 2\n ]\n },\n \"actions\": {\n \"setValues\": {\n \"order_reference\": \"O-382227\",\n \"require_overbox\": false,\n \"require_signature\": \"adult\",\n \"require_saturday_delivery\": false,\n \"desired_delivery_date\": \"2021-02-21\",\n \"shipping_method\": \"ups_03\",\n \"third_party_billing_group_id\": 12,\n \"custom_greeting\": \"<string>\",\n \"note\": \"<string>\",\n \"declared_value_service\": true,\n \"declared_value\": {\n \"amount\": 99,\n \"currency\": \"USD\"\n },\n \"backorder_policy\": \"default\",\n \"reason_for_export\": \"sold\",\n \"priority\": 50,\n \"allocation_options\": {},\n \"requested_ship_date\": \"2021-02-21T07:00:00Z\",\n \"other_shipping_options\": {},\n \"batch_tag\": \"Smalls-CartA\",\n \"telephone\": \"865-971-4663\",\n \"email\": \"celina.goalley@thompson-torp.com\"\n },\n \"updateAllocationOptions\": {\n \"set\": {\n \"algorithms\": [\n \"default\"\n ]\n },\n \"unset\": [\n \"dynamic_allocation\"\n ]\n },\n \"updateOtherShippingOptions\": {\n \"merge\": {\n \"reference_numbers\": {\n \"invoice\": null\n }\n }\n },\n \"hold\": {\n \"until\": \"2017-07-21T17:32:28Z\",\n \"comment\": \"<string>\"\n },\n \"unhold\": {\n \"comment\": \"<string>\"\n },\n \"unlockFromWarehouse\": {}\n },\n \"onError\": \"continue\"\n}"
response = http.request(request)
puts response.read_body{
"loaded": 1,
"committed": 1,
"failed": 1,
"not-found": 1,
"results": [
{
"resource": {
"type": "Order",
"id": 2
},
"message": "<string>",
"details": {
"updatePriority": {
"message": "<string>",
"new_value": 123
},
"lockToWarehouse": {
"message": "<string>"
},
"unlockFromWarehouse": {
"message": "<string>"
},
"cancel": {
"message": "<string>"
},
"hold": {
"message": "<string>"
},
"unhold": {
"message": "<string>"
}
}
}
],
"meta": {
"processing_time": 123
}
}Authorizations
Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.
Body
application/json
An object containing the orders to be updated.
Show child attributes
Show child attributes
An object containing all of the actions to be taken on the specified Order ids.
Show child attributes
Show child attributes
The value determining how errors are to be handled.
continueThe current entity will be rolled back and any remaining entities will continue to be processed.stopThe current entity will be rolled back and the request will stop processing any remaining entities.abortThe entire request will be rolled back.
Available options:
continue, stop, abort Response
An object with orders mass update results.
The number of entities that were successfully loaded.
Required range:
x >= 0The number of entities that were successfully updated.
Required range:
x >= 0The number of entities that failed to be updated.
Required range:
x >= 0The number of entities that were not found.
Required range:
x >= 0The list of update results for the requested Order objects.
Minimum array length:
1Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I