Skip to main content

API Configuration Documentation

This document outlines the configuration for a set of API operations related to shipment management. The configuration is divided into three main sections: parameters, create, update, and status, each serving a different purpose in the API interaction process.

Parameters​

The parameters section defines the inputs required for various API operations. Each parameter includes metadata such as displayName, displayType, placeholder, description, and validation rules. This metadata enhances the user interface by providing clear instructions and constraints for input values.

Example Parameter: Operation​

  • Name: operation
  • Display Name: Operation
  • Display Type: select
  • Placeholder: Select an operation
  • Description: Select the operation you want to perform.
  • Validation: Required

Create​

The create section outlines the configuration for creating a new shipment. It includes the HTTP method, URL, headers, body structure, and response handling. This section also specifies additional parameters specific to the creation process, such as identifier, reference_id, and journey_type.

Endpoint Configuration​

  • Method: POST
  • Headers: Includes an account-token for authentication.

Update​

The update section provides details for updating existing shipments. Similar to the create section, it defines the method, URL, headers, and parameters required for the update operation. The method is notably set to DELETE, indicating that this operation may be used to remove a shipment or update its status.

Endpoint Configuration​

  • Method: DELETE

Status​

The status section is dedicated to fetching the status of a shipment. It requires the awb_number as a parameter and outlines the GET request to retrieve status updates.

Endpoint Configuration​

  • Method: GET

Conclusion​

This configuration provides a comprehensive guide for interacting with the shipment management API, detailing the required parameters, operations, and response handling for creating, updating, and checking the status of shipments.