[v1] ShipmentStatus
Megan Stanage
Overview
This endpoint gets the latest status from the LTL shipment using PRO numbers or alternate reference IDs.
POST /ShipmentStatus
| Property | Data Type | Notes |
|---|---|---|
| includeTransactions | boolean | Gets or sets a flag that dictates if this request should include transactions in the response. |
| isProduction | boolean | Gets or sets a flag that dictates to send to test or production endpoints. |
| pickupDate | string | Gets or sets the pickup date.
|
| Property | Data Type | Notes |
|---|---|---|
| integrationName | string | Gets or sets the name of the carrier's integration. |
| carrierName | string | Gets or sets the name of the carrier used for the provided integration. |
| credentialSetName | string | Gets or sets the identifier for the set of account credentials to be looked up for the provided integration. |
| billingAccountNumber | string | Gets or sets the account number to be billed for this request. |
| thirdPartyBillingAccountNumber | string | Gets or sets the account number to be billed when the request requires another account to pay. |
| carrierServiceName | string | Gets or sets the carrier integration service name |
| documentFormat | enum | Gets or sets the document format.
|
Shipment status reference number information.
| Property | Data Type | Notes |
|---|---|---|
| proNumber | string | Gets or sets pro number value. |
| billOfLadingNumber | string | Gets or sets bill of lading number value. |
| purchaseOrderNumber | string | Gets or sets purchase order number value. |
| pickupNumber | string | Gets or sets pickup number value. |
| customerReferenceNumber | string | Gets or sets customer reference number value. |
Address representing where the goods are being shipped from.
| Property | Data Type | Notes |
|---|---|---|
| countryCode | string | Gets or sets the country code, expecting ISO2 formatting. |
| postalCode | string | Gets or sets the postal code in different country formats. |
| city | string | Gets or sets the name of the city. |
| addressLines | string | Gets or sets the address lines that represent the street address. |
| stateProvinceCode | string | Gets or sets the state or province code in the expected country format. |
| companyName | string | Gets or sets the name of the company that this address represents. |
| name | string | Gets or sets the name of the contact. |
| emailAddress | string | Gets or sets the email address of the contact. |
| phoneNumber | string | Gets or sets the phone number of the contact. |
Address representing where the goods are being shipped to.
| Property | Data Type | Notes |
|---|---|---|
| countryCode | string | Gets or sets the country code, expecting ISO2 formatting. |
| postalCode | string | Gets or sets the postal code in different country formats. |
| city | string | Gets or sets the name of the city. |
| addressLines | string | Gets or sets the address lines that represent the street address. |
| stateProvinceCode | string | Gets or sets the state or province code in the expected country format. |
| companyName | string | Gets or sets the name of the company that this address represents. |
| name | string | Gets or sets the name of the contact. |
| emailAddress | string | Gets or sets the email address of the contact. |
| phoneNumber | string | Gets or sets the phone number of the contact. |
Shipment status response provided back to external systems from status operation executed in a specified carrier integration's webservice.
| Property | Data Type | Notes |
|---|---|---|
| runTime | integer | Gets or sets the run time for creating a response for the incoming request in the LTL API.
|
Defines message structure for API response.
| Property | Data Type | Notes |
|---|---|---|
| value | string | Gets or sets the message text content. |
| severity | enum | Gets or sets the type of message severity.
|
Carrier shipment status response provided from status operation executed in a specified carrier integration's webservice.
| Property | Data Type | Notes |
|---|---|---|
| weight | number | Gets or sets weight.
|
| shipFromResponse | ||
| shipToResponse | ||
| status |
Defines message structure for API response.
| Property | Data Type | Notes |
|---|---|---|
| value | string | Gets or sets the message text content. |
| severity | enum | Gets or sets the type of message severity.
|
Transaction model containing request and response information.
| Property | Data Type | Notes |
|---|---|---|
| transactionId | string | Gets or sets the transaction ID used for the request. |
| endpoint | string | Gets or sets the endpoint used for the request. |
| request | string | Gets or sets the transaction request content. |
| response | Gets or sets the transaction response content. |
Shipment status reference number information.
| Property | Data Type | Notes |
|---|---|---|
| proNumber | string | Gets or sets pro number value. |
| billOfLadingNumber | string | Gets or sets bill of lading number value. |
| purchaseOrderNumber | string | Gets or sets purchase order number value. |
| pickupNumber | string | Gets or sets pickup number value. |
| customerReferenceNumber | string | Gets or sets customer reference number value. |
ShipFrom address for API response.
| Property | Data Type | Notes |
|---|---|---|
| countryCode | string | Gets or sets the country code, expecting ISO2 formatting. |
| postalCode | string | Gets or sets the postal code in different country formats. |
| city | string | Gets or sets the name of the city. |
| addressLines | string | Gets or sets the address lines that represent the street address. |
| stateProvinceCode | string | Gets or sets the state or province code in the expected country format. |
| companyName | string | Gets or sets the name of the company that this address represents. |
| name | string | Gets or sets the name of the contact. |
| emailAddress | string | Gets or sets the email address of the contact. |
| phoneNumber | string | Gets or sets the phone number of the contact. |
| countryCodeIso3 | string | Gets or sets the country code in ISO3 format. |
| countryName | string | Gets or sets the country name. |
ShipTo address for API response.
| Property | Data Type | Notes |
|---|---|---|
| countryCode | string | Gets or sets the country code, expecting ISO2 formatting. |
| postalCode | string | Gets or sets the postal code in different country formats. |
| city | string | Gets or sets the name of the city. |
| addressLines | string | Gets or sets the address lines that represent the street address. |
| stateProvinceCode | string | Gets or sets the state or province code in the expected country format. |
| companyName | string | Gets or sets the name of the company that this address represents. |
| name | string | Gets or sets the name of the contact. |
| emailAddress | string | Gets or sets the email address of the contact. |
| phoneNumber | string | Gets or sets the phone number of the contact. |
| countryCodeIso3 | string | Gets or sets the country code in ISO3 format. |
| countryName | string | Gets or sets the country name. |
Shipment status information.
| Property | Data Type | Notes |
|---|---|---|
| code | string | Gets or sets status code. |
| lastUpdated | string | Gets or sets last updated.
|
| description | string | Gets or sets description. |
Shipment status current location information.
| Property | Data Type | Notes |
|---|---|---|
| countryCodeIso2 | string | Gets or sets the country code, expecting ISO2 formatting. |
| postalCode | string | Gets or sets the postal code in different country formats. |
| city | string | Gets or sets the name of the city. |
| addressLines | string | Gets or sets the address lines that represent the street address. |
| stateProvinceCode | string | Gets or sets the state or province code in the expected country format. |
| companyName | string | Gets or sets the name of the company that this address represents. |
| name | string | Gets or sets the name of the contact. |
| emailAddress | string | Gets or sets the email address of the contact. |
| phoneNumber | string | Gets or sets the phone number of the contact. |
| countryCodeIso3 | string | Gets or sets the country code in ISO3 format. |
| countryName | string | Gets or sets the country name. |