The TradeDirect Shipments API facilitates the management of external trade shipments within the TradeDirect system, providing robust endpoints for creating, managing, and finalizing international and domestic shipments. This includes deleting master, small package, and LTL shipments, as well as closing out master shipments to ensure seamless trade operations.
- Streamlined External Trade Management: Simplify the process of creating and managing international and domestic shipments with a unified API.
- Secure Access: OAuth2 and JWT-based authentication ensure secure and reliable API usage for global trade operations.
- Flexible Shipment Handling: Provides the ability to delete small package and LTL shipments, ensuring efficient management of shipment records across borders.
- Comprehensive Shipment Closure: Enables closing out master shipments, ensuring proper finalization of shipment processes for external trade.
Delete master shipment
This API allows users to delete a master shipment identified by a unique shipment identifier (USI) and the shipper's account number. The master shipment and its associated child shipments will be permanently removed.
path Parameters
query Parameters
Master shipment deleted successfully
Missing or Invalid parameter
Invalid Authentication Information
Resource not found
Internal Server Error
- curl
- Node.js
- JavaScript
- PHP
- Python
- C#
- Java
- 400
- 401
- 404
- 500
{- "response": {
- "errors": [
- {
- "code": "400001",
- "message": "Missing or Invalid parameter: {field name}"
}
]
}
}Delete small package shipment
Deletes a small package child shipment identified by a unique shipment identifier (USI) representing the master shipment and the shipment's tracking number.
path Parameters
child shipment deleted successfully
Missing or Invalid parameter
Invalid Authentication Information
Resource not found
Internal Server Error
- curl
- Node.js
- JavaScript
- PHP
- Python
- C#
- Java
- 400
- 401
- 404
- 500
{- "response": {
- "errors": [
- {
- "code": "400001",
- "message": "Missing or Invalid parameter: {field name}"
}
]
}
}Closeout a Master Shipment
Transitions a master shipment to a closed state, finalizing its processing. Identified by a unique shipment identifier (USI).
path Parameters
header Parameters
Request Body schema: application/json
Request payload containing shipment details required to close out a master shipment.
required | object Contains all the details of the shipment. | ||||||||
| |||||||||
Closeout performed on the provided master shipment successfully.
Closeout performed on the provided master that is partial success.
Missing or Invalid parameter
Invalid Authentication Information
Resource not found
Resource not found
Internal Server Error
- Payload
- curl
- Node.js
- JavaScript
- PHP
- Python
- C#
- Java
{- "shipment": {
- "shipper": {
- "accountNumber": "1234WW"
}, - "packages": [
- {
- "numberOfIdenticalUnits": 1,
- "handlingUnits": {
- "type": "BOXES",
- "dimensions": {
- "length": 48,
- "width": 40,
- "height": 36,
- "unitOfMeasurement": "IN"
}, - "packageWeight": {
- "weight": 10,
- "unitOfMeasurement": "LBS"
}, - "freightClass": 150,
- "transportationService": {
- "airService": 1,
- "groundService": 1
}
}
}
]
}
}- 200
- 207
- 400
- 401
- 404
- 422
- 500
{- "invoiceLabelResponse": {
- "files": [
- {
- "data": "base64encodedstring",
- "fileFormat": "PDF",
- "referenceId": "INV123456"
}
]
}, - "bolLabelResponse": {
- "files": [
- {
- "data": "baseencodedstring",
- "fileFormat": "PDF",
- "referenceId": "BOL123456"
}
]
}, - "palletLabelResponses": {
- "files": [
- {
- "opTyp": "PDF",
- "lblNmbr": "PLT123456",
- "lblData": "base64encodedstring"
}
]
}
}Delete Less Than Truckload (LTL) child shipment
Deletes a Less Than Truckload (LTL) child shipment identified by a unique shipment identifier (USI) and a sub pro number.
path Parameters
LTL Child Shipment Deleted Successfully
Missing or Invalid parameter
Invalid Authentication Information
Resource not found
Internal Server Error
- curl
- Node.js
- JavaScript
- PHP
- Python
- C#
- Java
- 400
- 401
- 404
- 500
{- "response": {
- "errors": [
- {
- "code": "400001",
- "message": "Missing or Invalid parameter: {field name}"
}
]
}
}Genereate Documents and Labels for LTL Shipments and Closeout
Generates documents and labels for master/ltl shipments identified by a unique shipment identifier (USI).
header Parameters
Request Body schema: application/json
Request payload containing shipment details required to generate documents
Documents generated successfully for provided USI. See base64-data-samples document for data sample.
Missing or Invalid parameter
Invalid Authentication Information
Resource not found
Resource not found
Internal Server Error
- Payload
- curl
- Node.js
- JavaScript
- PHP
- Python
- C#
- Java
{- "requestedDoc": "BOL",
- "docFormat": "PDF",
- "usiNumber": "578299028T",
- "shipperAccountNumber": "1234WW"
}- 200
- 400
- 401
- 404
- 422
- 500
{- "documents": {
- "cci": "3MtNcTKd2VKWu0...br62U"
}
}