Skip to main content
POST

Ship all items in a sales order

Scope:inventory:sales-orders.write
https://api.holded.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

salesOrderIdstringrequired

Sales Order ID (24-char hex ObjectId)

Request

python
import requests

url = "https://api.holded.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

200Sales order shipped

Error responses

401Invalid or missing API keyapplication/json
403Insufficient permissionsapplication/json
404Sales order not foundapplication/json