Preview Dropship Request
GET/api/sales-orders/:salesOrder/dropship-preview
Previews the supplier cost for each of the order's product lines routed to a dropship (supplier) warehouse, before creating the dropship purchase order.
orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Query parameters:
- warehouse_id (integer, required): The dropship warehouse to preview against. Only lines routed to this warehouse are returned.
Response fields (per line):
- sales_order_line_id (integer): The sales order line.
- product_id (integer): The product on the line.
- supplier_cost (number): The product's unit cost for the warehouse's supplier, rounded to 4 decimal places.
Path parameters:
- salesOrder (required): Sales order ID.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.