Advanced ship notice (ASN) retrieve API

Test endpoint:
https://transact.ti.com/v2/store/orders/T10999999/advanced-shipment-notices/test
https://transact.ti.com/v2/store/orders/T10999999/advanced-shipment-notices/499999999/test

Production endpoint:
https://transact.ti.com/v2/store/orders/{Order Number}/advanced-shipment-notices/
https://transact.ti.com/v2/store/orders/{Order Number}/advanced-shipment-notices/{Waybill Number}

After you have packed your order, and it is ready to ship, TI will generate shipment tracking information. Use the advanced ship notification (ASN) API to retrieve detailed information about your shipped orders, including tracking numbers, carrier details and commercial invoices.

The ASN API offers:

  • Real-time updates: The push API will send a webhook to your system to notify that your order is ready to shipped and can be used to trigger automation flows.
  • Detailed shipment information: Get tracking numbers, carrier information and commercial invoices.
  • Flexible retrieval options: Retrieve information for entire orders by order number or for specific shipments by waybill number.

Steps to use the ASN API:

  1. Authentication: You will need your assigned API key and secret to authenticate with the API.
  2. Retrieving shipment information:
    • Entire order: Provide the order number in your request.
    • Specific shipment: Include the waybill number you received earlier or found in your myTI order history.
  3. API response: You will receive a response with a status code (200 OK) and a JSON containing shipping details.
  4. Retrieve specific order details:
    • To get detailed information about a specific order, query the order API with the order number.
    • For example: "https://transact.ti.com/v2/store/orders/T999999999"

Testing the API:

A testing environment is available for you to experiment with the API before using it with live data. When testing:

  • Use the provided test endpoint URL
  • The order ID should always be passed as T10999999 and the waybill number should always be passed as 0499999999.

https://transact.ti.com/v2/store/orders/T10999999/advanced-shipment-notices/test?requestCommercialInvoicePDF=true&requestWaybillPDF=true 

or

https://transact.ti.com/v2/store/orders/T10999999/advanced-shipment-notices/499999999/test?requestCommercialInvoicePDF=true&requestWaybillPDF=true

Additional notes:

  • Your access token allows for multiple requests within a session, as long as it is valid.
  • The API is available in push or retrieve implementations. See push notification setup for more information.

 

Example request for retrieve:

curl --request GET \
--url 'https://transact.ti.com/v2/store/orders/{orderNumber}/advanced-shipment-notices/{wayBillNumber}'
--header 'Authorization: Bearer {access_token}' \