TRANXACT.AI Help

Supply Chain · Collaboration

Shipping Notices

What the supplier says is on its way. Receiving one stages a goods receipt, so it arrives the same way as anything else.

Type REST11 operationsBase path /api/scm/asnPublished as /api/v1/asn

Download specification (OpenAPI 3.1) Screen: Shipping Notices

Overview

PackageSupply Chain
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Supply Chain › Shipping Notices 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.
Tablescm.asn · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

11 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/scm/asnList shipping notices

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "asn_no": "ASN-000001",
      "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "po_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "supplier_reference": "text",
      "ship_date": "2026-10-30",
      "expected_date": "2026-10-30",
      "carrier": "text",
      "tracking_no": "TRA-000001",
      "container_count": 10,
      "sscc": "text",
      "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "line_count": 10,
      "total_quantity": "12.0000"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/scm/asn?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/asn/{id}Read one asn

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "asn_no": "ASN-000001",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "po_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_reference": "text",
  "ship_date": "2026-10-30",
  "expected_date": "2026-10-30",
  "carrier": "text",
  "tracking_no": "TRA-000001",
  "container_count": 10,
  "sscc": "text",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "line_count": 10,
  "total_quantity": "12.0000"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/scm/asn/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/asnCreate a asn

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
supplier_iduuidYesSupplier
po_iduuidNoAgainst order
supplier_referencetextNoTheir reference
ship_datedateNoShipped
expected_datedateNoExpected
carriertextNoCarrier
tracking_notextNoTracking number
container_countintegerNoContainers
sscctextNoSSCC
warehouse_iduuidNoArriving at

Sample body

{
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "po_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_reference": "text",
  "ship_date": "2026-10-30",
  "expected_date": "2026-10-30"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "asn_no": "ASN-000001",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "po_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_reference": "text",
  "ship_date": "2026-10-30",
  "expected_date": "2026-10-30",
  "carrier": "text",
  "tracking_no": "TRA-000001",
  "container_count": 10,
  "sscc": "text",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "line_count": 10,
  "total_quantity": "12.0000"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/asn" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","po_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","supplier_reference":"text","ship_date":"2026-10-30","expected_date":"2026-10-30"}'
PUT/api/scm/asn/{id}Change a asn

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
supplier_iduuidYesSupplier
po_iduuidNoAgainst order
supplier_referencetextNoTheir reference
ship_datedateNoShipped
expected_datedateNoExpected
carriertextNoCarrier
tracking_notextNoTracking number
container_countintegerNoContainers
sscctextNoSSCC
warehouse_iduuidNoArriving at

Sample body

{
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "po_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "asn_no": "ASN-000001",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "po_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_reference": "text",
  "ship_date": "2026-10-30",
  "expected_date": "2026-10-30",
  "carrier": "text",
  "tracking_no": "TRA-000001",
  "container_count": 10,
  "sscc": "text",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "line_count": 10,
  "total_quantity": "12.0000"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/scm/asn/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","po_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
DELETE/api/scm/asn/{id}Delete a asn

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/scm/asn/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/asn/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (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, withLines

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/asn/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
POST/api/scm/asn/{id}/receiveReceive

Path parameters

NameTypeDescription
idstring (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/asn/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/receive" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/asn/{parentId}/linesLines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/scm/asn/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/asn/{parentId}/linesLines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, 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/asn/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/scm/asn/{parentId}/lines/{lineId}Lines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, 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/asn/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/scm/asn/{parentId}/lines/{lineId}Lines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, 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/asn/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a asn, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
asn_notextread onlyAsn no
supplier_iduuidread, writeSupplier
po_iduuidread, writeAgainst order
supplier_referencetextread, writeTheir reference
ship_datedateread, writeShipped
expected_datedateread, writeExpected
carriertextread, writeCarrier
tracking_notextread, writeTracking number
container_countintegerread, writeContainers
sscctextread, writeSSCC
warehouse_iduuidread, writeArriving at
line_countintegerread onlyLine count
total_quantitynumericread onlyTotal quantity
statustextread onlyStatus
receipt_iduuidread onlyReceipt id
received_attimestamp with time zoneread onlyReceived at
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
edi_interchange_iduuidread onlyEdi interchange id
submitted_viatextread onlySubmitted via
portal_user_iduuidread onlyPortal user id

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Supply Chain › Shipping Notices for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.