Ship all items in a sales order
Scope: inventory:sales-orders.write https://api.alladdin.com/api/v2/sales-orders/{salesOrderId}/ship
Marks the entire sales order as shipped. This creates stock movements in the associated warehouse, reducing inventory for all line items.
Use this when all items in the order are shipped at once. For partial shipments, use the ship-by-lines endpoint instead.
Parameters
Path parameters
salesOrderId string required
Sales Order ID (24-char hex ObjectId)
Request
import requests
url = "https://api.alladdin.com/api/v2/sales-orders/{salesOrderId}/ship"
headers = {
"Authorization": "Bearer YOUR_API_KEY",
"Accept": "application/json",
}
response = requests.post(url, headers=headers)
print(response.json())Responses
Success responses
200 Sales order shipped
Error responses
401 Invalid or missing API key application/json 403 Insufficient permissions application/json 404 Sales order not found application/json