Carrier Support
Report the external incident id for a carrier issue
After you receive a CARRIER_ISSUE_UPDATED webhook and create the incident in your own TMS, call this endpoint with the carrierIssueId from that webhook and your incident id (externalId). Augment stores the correlation so subsequent CARRIER_ISSUE_UPDATED events for the same issue include your externalId — letting you update the existing incident in place instead of creating a duplicate.
The call is idempotent: sending it again for the same carrierIssueId just updates the stored externalId. It is optional — if you never call it, events keep arriving without an externalId and nothing else changes.
post/v2/carrier-issues/external-ref
Request
- Base URLhttps://api.prod.goaugment.com
- AuthHTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Example request
{
"carrierIssueId": "01JCARRIERISSUERECORD00001",
"externalId": "TMS-INC-30275"
}Response
External reference recorded
Changes
No recorded changes to this operation across all 1 revision of this API.