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.

Body·

required
application/json

Correlates a carrier issue from a CARRIER_ISSUE_UPDATED webhook with the matching incident id in your TMS.

  • carrierIssueId
    Type: string
    required

    The correlation token from the CARRIER_ISSUE_UPDATED webhook payload.

  • externalId
    Type: string
    required

    The incident id in your TMS.

Responses

  • 204

    External reference recorded

  • 422

    Invalid payload

Request Example for post/v2/carrier-issues/external-ref
curl https://api.prod.goaugment.com/v2/carrier-issues/external-ref \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Basic username:password' \
  --data '{
  "carrierIssueId": "01JCARRIERISSUERECORD00001",
  "externalId": "TMS-INC-30275"
}'
No Body

External reference recorded

Previous
Carrier Support
Next
Purchase Order Management