Ship specific lines in a sales order
Scope: inventory:sales-orders.write https://api.alladdin.com/api/v2/sales-orders/{salesOrderId}/ship-by-lines
Partially ships specific line items of a sales order. Use this when you can only fulfill part of the order.
Specify which lines and quantities to ship. Stock movements are created only for the shipped items. The order remains open until all lines are fully shipped.
Parameters
Path parameters
salesOrderId string required
Sales Order ID (24-char hex ObjectId)
Request body
object lines[] object[]
Line items to ship
item_line_position integer
Zero-based position of the line item
units number
Number of units to ship
Request
import requests
url = "https://api.alladdin.com/api/v2/sales-orders/{salesOrderId}/ship-by-lines"
headers = {
"Authorization": "Bearer YOUR_API_KEY",
"Accept": "application/json",
}
payload = {
"lines": [
{
"item_line_position": 0,
"units": 0
}
]
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Responses
Success responses
200 Sales order shipped by lines
Error responses
400 Bad request application/json 401 Invalid or missing API key application/json 403 Insufficient permissions application/json 404 Sales order not found application/json