| Name | Description | Type | Additional information |
|---|---|---|---|
| cbl |
MVOCC Carrier Bill of Lading Number from the RegisterForTracking request method. |
string |
None. |
| load |
Optional Load Type. FCL| Full Container Load | LCL: Less than Container Load | BCO: Beneficial Cargo Owner |
string |
None. |
| updated_cbl |
Autocorrected CBL. This value is null unless the account is enabled for autocorrection. |
string |
None. |
| updatedAlternateShipmentReferenceNumber |
Autocorrected alternateShipmentReference. This value is null unless the account is enabled for autocorrection. |
string |
None. |
| cnt |
Container Number from the RegisterForTracking request method. |
string |
None. |
| hbl |
Optional House Bill Number |
string |
None. |
| scac |
Isolated SCAC. This value is not consumed unless the account is enabled for a separate requests. |
string |
None. |
| alternateShipmentReference |
Optional Alternate Shipment Reference |
RegisterAlternateShipmentReference |
None. |
| enablecallback |
Enable or disable callback |
boolean |
None. |
| callbackauthkey |
Only applies if callbacks have special authentication requirements Pre-specified Key e.g.: BASIC | OAUTH2 |
string |
None. |
| callbackurl |
Callback URL |
string |
None. |
| callback |
[New Beta] Replaces legacy parameters for callback options |
RegisterCallback |
None. |
| refs |
Conditional List of References (At least 1 unique reference is required) Illegal Chars ',' '|' '\' '/' ';' |
Collection of string |
None. |
| customattributes |
Conditional Custom Attributes: Must be mutually agreed upon with AES Admin |
RegisterAttributes |
None. |
| registrationId |
Unique Identifier for the registered request. . |
string |
None. |
| subscription |
Subscription [callback] object containing the subscriptionId. |
RegisterForTrackingSubscriptionResponse |
None. |
| ack |
A flag indicating success or failure of the web service response back to the client. Default is success. |
AcknowledgeType |
None. |
| exceptions |
Message back to client. Mostly used when a web service failure occurs. |
Collection of ResponseExceptionDto |
None. |
| ctoken |
Optional Client Token |
string |
None. |