curl --request POST \
--url https://{client_id}.shipstream.app/api/global/v1/shipping/orders/massUpdate \
--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": "celina.goalley@thompson-torp.com"
},
"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
}
}
Updates a batch of orders specified by and according to the request body.
curl --request POST \
--url https://{client_id}.shipstream.app/api/global/v1/shipping/orders/massUpdate \
--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": "celina.goalley@thompson-torp.com"
},
"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
}
}
An object with orders mass update results.
The response is of type object
.