AWB Update

Goal is to return SAP with the tracking/awb reference given by the carrier to a consignment., SAP CPI will provide an endpoint based on the XSD provided by Viya.

Endpoint Definition

Request

  • Request-Urls: :
TBD
  • Request-Method: POST
  • Accept: application/xml; charset=utf-8
  • Accept-encoding: gzip, deflate
  • TBD

Request Body

Tracking XML - AWB Update
<?xml version="1.0" encoding="UTF-8" ?>
<milestone>
<carrier>
<name>DHL</name>
<reference>SAPCARRIERCODE:VENDORID:9483743</reference>
<integration>dhl-my-dhl-api</integration>
<equipment>
<licencePlate>AB-123-CD</licencePlate>
</equipment>
</carrier>
<trackingReference>
<customer>309239032902</customer>
<carrier>6135449611</carrier>
<viya>498fasd0</viya>
</trackingReference>
<event>
<eventDatetime>2024-02-12T18:49:00Z</eventDatetime>
<eventDescription>Tracking referene </eventDescription>
<scannedBy></scannedBy>
<eventMessage></eventMessage>
<eventType>
<original>
<code>Tracking_reference</code>
<description>New tracking reference</description>
</original>
<translated>
<code>AWB_UPDATE</code>
<description></description>
</translated>
</eventType>
</event>
</milestone>

Response

Response Headers

  • Content-type: application/xml; charset=utf-8

Responses:

Technical Reponses

202 Accepted

  • Payload: No Content

401 Unauthorized

  • Payload: No Content

500 Server Error

  • Payload: No Content

503 Service Unavailable

  • Payload: No Content

Function Responses

TODO: Determine endpoint response structure

Potential errors:

  • Tracking reference already exists