Supply Chain · Drop-Ship
Drop-Ship Orders
Sales order lines the vendor ships straight to the customer: the vendor order behind each, and how far it has got. Nothing here touches your own stock.
/api/scm/drop-ship-ordersPublished as /api/v1/drop-ship-ordersDownload specification (OpenAPI 3.1) Screen: Drop-Ship Orders
Overview
| Package | Supply Chain |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Supply Chain › Drop-Ship Orders on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | scm.drop_ship_lines · kept per company (and organisational unit where it has one) |
| Record | Read only; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
8 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/drop-ship-ordersList drop-ship orders
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"so_no": "SO-000001",
"so_status": "draft",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"customer_name": "Example",
"ship_to_address": "text",
"line_no": 10,
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_no": "ITE-000001",
"item_name": "Example",
"quantity": "12.0000",
"qty_delivered": "12.0000"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/drop-ship-orders?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/drop-ship-orders/{id}Read one drop-ship line
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"so_no": "SO-000001",
"so_status": "draft",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"customer_name": "Example",
"ship_to_address": "text",
"line_no": 10,
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_no": "ITE-000001",
"item_name": "Example",
"quantity": "12.0000",
"qty_delivered": "12.0000"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/drop-ship-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/drop-ship-orders/{id}/raiseRaise
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/drop-ship-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/raise" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/drop-ship-orders/lines/{id}/fulfilmentLines fulfilment
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
fulfilment, supplierId; fulfilment one of stock|drop_ship|direct_shipResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/drop-ship-orders/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/fulfilment" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"fulfilment":"value","supplierId;":"value"}'POST/api/scm/drop-ship-ordersPost drop-ship orders
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/drop-ship-orders" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/drop-ship-orders/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/drop-ship-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'PUT/api/scm/drop-ship-orders/{id}Put drop-ship orders
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/drop-ship-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/scm/drop-ship-orders/{id}Delete drop-ship orders
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/scm/drop-ship-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a drop-ship line, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
sales_order_id | uuid | read only | Sales order id |
so_no | text | read only | So no |
so_status | text | read only | So status |
account_id | uuid | read only | Account id |
customer_name | text | read only | Customer name |
ship_to_address | text | read only | Ship to address |
line_no | integer | read only | Line no |
item_id | uuid | read only | Item id |
item_no | text | read only | Item no |
item_name | text | read only | Item name |
quantity | numeric | read only | Quantity |
qty_delivered | numeric | read only | Qty delivered |
qty_invoiced | numeric | read only | Qty invoiced |
unit_price | numeric | read only | Unit price |
fulfilment | text | read only | Fulfilment |
supplier_id | uuid | read only | Supplier id |
supplier_name | text | read only | Supplier name |
po_id | uuid | read only | Po id |
po_no | text | read only | Po no |
po_status | text | read only | Po status |
supplier_ack_status | text | read only | Supplier ack status |
drop_ship_status | text | read only | Drop ship status |
created_at | timestamp with time zone | read only | Created at |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Supply Chain › Drop-Ship Orders for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.