Get Started
Common Features
Inventory API v1
Receiving API v1
Shipping API v1
System API v1
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",
"generate_sscc": "pack",
"other_shipping_options": {},
"batch_tag": "Smalls-CartA",
"telephone": "865-971-4663",
"email": "[email protected]"
},
"updateAllocationOptions": {
"set": {
"algorithms": [
"default"
]
},
"unset": [
"dynamic_allocation"
]
},
"updateOtherShippingOptions": {
"merge": {
"reference_numbers": {
"invoice": null
}
}
},
"cancel": {
"items": [
"all"
]
},
"hold": {
"until": "2017-07-21T17:32:28Z",
"comment": "<string>"
},
"unhold": {
"comment": "<string>"
},
"updatePriority": {
"operation": "boost",
"amount": 50
},
"lockToWarehouse": {
"warehouse_id": 3
},
"unlockFromWarehouse": {},
"addComment": {
"comment": "<string>"
}
},
"onError": "continue"
}
'{
"loaded": 1,
"committed": 1,
"failed": 1,
"not-found": 1,
"results": [
{
"resource": {
"type": "Order",
"id": 2
},
"status": "committed",
"message": "<string>",
"details": {
"updatePriority": {
"status": "success",
"message": "<string>",
"new_value": 123
},
"lockToWarehouse": {
"status": "success",
"message": "<string>"
},
"unlockFromWarehouse": {
"status": "success",
"message": "<string>"
},
"cancel": {
"status": "success",
"message": "<string>"
},
"hold": {
"status": "success",
"message": "<string>"
},
"unhold": {
"status": "success",
"message": "<string>"
}
}
}
],
"meta": {
"processing_time": 123
}
}Mass update orders
Updates a batch of orders specified by and according to the request body.
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",
"generate_sscc": "pack",
"other_shipping_options": {},
"batch_tag": "Smalls-CartA",
"telephone": "865-971-4663",
"email": "[email protected]"
},
"updateAllocationOptions": {
"set": {
"algorithms": [
"default"
]
},
"unset": [
"dynamic_allocation"
]
},
"updateOtherShippingOptions": {
"merge": {
"reference_numbers": {
"invoice": null
}
}
},
"cancel": {
"items": [
"all"
]
},
"hold": {
"until": "2017-07-21T17:32:28Z",
"comment": "<string>"
},
"unhold": {
"comment": "<string>"
},
"updatePriority": {
"operation": "boost",
"amount": 50
},
"lockToWarehouse": {
"warehouse_id": 3
},
"unlockFromWarehouse": {},
"addComment": {
"comment": "<string>"
}
},
"onError": "continue"
}
'{
"loaded": 1,
"committed": 1,
"failed": 1,
"not-found": 1,
"results": [
{
"resource": {
"type": "Order",
"id": 2
},
"status": "committed",
"message": "<string>",
"details": {
"updatePriority": {
"status": "success",
"message": "<string>",
"new_value": 123
},
"lockToWarehouse": {
"status": "success",
"message": "<string>"
},
"unlockFromWarehouse": {
"status": "success",
"message": "<string>"
},
"cancel": {
"status": "success",
"message": "<string>"
},
"hold": {
"status": "success",
"message": "<string>"
},
"unhold": {
"status": "success",
"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
An object containing all of the actions to be taken on the specified Order ids.
Show child attributes
Show child attributes
Set the value of an order field.
Show child attributes
Show child attributes
An optional merchant-supplied reference for the order. Not a unique identifier.
"O-382227"
Flag to indicate that the order should be shipped in an over-box.
If a signature option is selected, this special service will instruct the carrier's driver to request a physical signature from the shipment recipient at the time of delivery. If it is not an available service, the shipping carrier will return an error when attempting to "Pack and Ship" the order.\
noneNo signature required.anyDirect signature required.indirectIndirect signature required.adultAdult signature required.defaultThe default option for the shipping method will be applied.
none, any, indirect, adult, default "adult"
Flag to indicate whether Saturday delivery is required.
The date by which the customer desires the order to be delivered. The value is only used and is required when the shipping method is a Virtual Shipping Method with the "Desired Delivery Date" option, such as the Cheapest On-Time shipping method.
"2021-02-21"
The Shipping Method.
255"ups_03"
The ID number of a Third Party Billing Account Group. If unset or null, and a default group is configured, the default group will be used. Set to 0 to disable third party billing.
x >= 012
If specified, this will override the configured Packing Slip default greeting for a given order.
65535The "Note" adds a status history to the order that only you and the warehouse staff may see. Adding a note will not affect the way the order is picked and packed and is not required.
65535Flag to indicate that a declared value service is required. If true then either the declared_value
must also be set or the order items must have a unit_declared_value.
true
defaultStore's default policy.all_or_nothingAccept order but do not ship anything until all items are in stock.as_availableNo limit to number or frequency of additional shipments.up_to_XSame as "As Available", but changes to All or Nothing before shipping Xth shipment. When using up_to_X, "X" represent a positive integer number.
default, all_or_nothing, as_available "default"
Reason for export. Only applicable to international orders.
sold, not_sold, gift, sample, repair_return, personal_effects This order's priority. Setting the priority will boost or suppress this order's priority in relation to other orders for the same products. Lower numbers are higher in priority.
0 <= x <= 100The provided object will replace the existing allocation options and null will unset all values.
Date when the order was requested to be shipped.
"2021-02-21T07:00:00Z"
Generate Serial Shipping Container Codes option.
pack, item The provided object will replace the existing allocation options and null will unset all values.
The "Batch Tag" property.
64"Smalls-CartA"
The "Telephone" property.
255"865-971-4663"
Modify the allocation_options object. To replace the entire object with a new one use the setValues action instead.
Show child attributes
Show child attributes
The top-level keys will be added and will replace any existing values without modifying the other keys.
The top-level keys will be unset from the existing object without modifying the other keys.
Perform a deep merge of the provided object with the existing object. All keys with null values in the provided object will be unset.
Unset all values if true.
{
"set": { "algorithms": ["default"] },
"unset": ["dynamic_allocation"]
}Modify the other_shipping_options object. To replace the entire object with a new one use the setValues action instead.
Show child attributes
Show child attributes
The top-level keys will be added and will replace any existing values without modifying the other keys.
The top-level keys will be unset from the existing object without modifying the other keys.
Perform a deep merge of the provided object with the existing object. All keys with null values in the provided object will be unset.
Unset all values if true.
{
"merge": { "reference_numbers": { "invoice": null } }
}Cancel order items.
Show child attributes
Show child attributes
allCancel all order items (includesbackorderedandunfilfulled).unfulfilledCancel all unfulfilled order items (incluesbackordered).backorderedCancel all backordered order items.
1 elementall, unfulfilled, backordered Place an order on hold.
Change the order's priority in relation to other orders for the same products. Lower numbers are higher in priority. The final value is clamped between 0 and 100.
Show child attributes
Show child attributes
boostIncrease the priority byamount(lowers the value).suppressDecrease the priority byamount(raises the value).setSet the priority toamount.
boost, suppress, set The amount to boost, suppress or set according to the operation.
0 <= x <= 100Release warehouse lock.
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.
continue, stop, abort Response
An object with orders mass update results.
The number of entities that were successfully loaded.
x >= 0The number of entities that were successfully updated.
x >= 0The number of entities that failed to be updated.
x >= 0The number of entities that were not found.
x >= 0The list of update results for the requested Order objects.
1Show child attributes
Show child attributes
The completion status of the update action which will also notify of any "user-errors".
committed, user-error, unexpected-error, not-found A descriptive summary of the update result.
If additional details are relevant to the actions taken they may be specified in this field.
Show child attributes
Show child attributes
The resulting change of an order's priority by specified amount (new_value).
Show child attributes
Show child attributes
The resulting action's success status.
success, not-updated The descriptive message regarding the update result.
The new value after applying the update.
The result of a request to lock the order(s) to a particular warehouse.
The result of a request to unlock the order(s) from a particular warehouse.
Was this page helpful?