avanta icon

avanta

Consume avanta API

Actions57

Servicecenter - Tracking → Create or Update

AI-generated

Overview

This node interacts with the Avanta API to create or update tracking information for shipments within the Servicecenter - Tracking resource. It is useful for automating shipment tracking updates, managing shipment statuses, and integrating tracking data into workflows. For example, it can be used to automatically update tracking codes, shipment providers, and statuses when new shipment information is received or changed.

Use Case Examples

  1. Automatically create or update shipment tracking records when new shipment data is received from an e-commerce platform.
  2. Update tracking status and provider information in bulk for multiple shipments using the bulk API option.

Properties

Name Meaning
Request Options Options to customize the API request such as enabling debug mode, ignoring SSL issues, and setting request timeout.
Return to Webhook Whether to return the response to a webhook, requiring a 'Respond to Webhook' node after this node.
Use Bulk API Whether to use the bulk API for processing multiple items.
Dataflow ID Optional override for the dataflow ID; if not set, it is read from webhook input data when triggered via a dataflow profile.
Company ID ID of the company associated with the tracking.
Tracking Code Tracking code for the shipment.
Additional Fields Optional additional fields for the tracking such as creation date, customer order ID, shipment ID, provider, status, and extension attributes.

Output

JSON

  • tracking_id - Internal tracking ID assigned by the system.
  • tracking_code - Tracking code for the shipment.
  • company_id - ID of the company associated with the tracking.
  • status - Current status of the tracking.
  • provider - Shipping provider name.
  • created_at - Creation date of the tracking record.
  • updated_at - Last update date of the tracking record.
  • notice - Additional notice or comments related to the tracking.

Dependencies

  • An API key credential for authenticating with the Avanta API

Troubleshooting

  • Ensure the Company ID and Tracking Code are correctly provided as they are required fields.
  • If using the bulk API, verify that the dataflow ID is correctly set or available in the webhook input data when triggered via a dataflow profile.
  • Enable Debug Mode in Request Options to get detailed API request information for troubleshooting.
  • If SSL certificate validation issues occur, consider enabling 'Ignore SSL Issues' option, but be aware of security risks.
  • Timeout errors may occur if the server is slow to respond; increase the Timeout value in Request Options if needed.

Discussion