MENU

API Developer Portal

json

API Developer Portal

Introduction

Our APIs are a fast and easy way to integrate our shipping functionality into your business applications and websites. Each API provides access to Estes functionality, allowing you to bypass the traditional HTML forms process and make shipping with Estes a more convenient solution.

To access the full list of our legacy web services, see https://www.estes-express.com/resources/digital-services/api/index.

Our new available REST APIs are:

Shipment Tracking API

Pickup API

How to Use This Developer Portal

  1. Review the steps in Accessing Our APIs to connect to our APIs if you are a TMS Customer or an Individual/Direct Customer.
  2. Review the detailed methods, parameters, responses and error messages of our APIs in this documentation.
  3. See the Data Definitions for detailed information on parameters entered and data returned by our API objects.
  4. Need help understanding an API? See our Examples.

Accessing Our APIs

Step 1: In order to use our APIs, you need to pass a MyEstes username and password. If you do not have a MyEstes profile, you can sign up for one here. If you are a Transportation Management System (TMS), you need to retrieve the MyEstes credentials from each Estes customer you serve–those credentials should be stored as they are required for each call.

Step 2: You will need to generate an API key for the production environment and another API key for the test environment. This only needs to be done once, you may store the API key, and the single key will be used for all new REST APIs. Determine which user type you are from the following:

Step 3: The API Key is used when authenticating your identity and for troubleshooting customer requests. You pass the API Key and the appropriate MyEstes username and password which returns a Bearer Token. See Using API Keys To Authenticate.

Step 4: Once you have a Bearer Token, you pass the bearer token and your API key in the call. See Using the Bearer Token with an API.

TMS API Customers

Obtain Client ID and Secret

Provide the following information in an email to WebSupport@estes-express.com:

You will receive two emails with a client ID and client secret, one for test environment and another for production environment.

Important: Client ID and Secrets are NOT API Keys.

Create Your API Key

With Postman or a similar API tool, pass your client ID and client secret using Basic Authentication using the following method:

Production example only:

curl -X POST 'https://cloudapi.estes-express.com/v1/api-key'
-H 'accept: application/json'
-u ClientID:ClientSecret
ZThkNmM4Y2MtMDY3ZC00ZmY4LTgxYzMtNWJmNjAxNjUzYjYwOjUyZmRmYzA3LTIxODItNjU0Zi0xNjNmLTVmMGY5YTYyMWQ3Mg'

Test example only:

curl -X POST 'https://uat-cloudapi.estes-express.com/v1/api-key'
-H 'accept: application/json'
-u ClientID:ClientSecret
ZThkNmM4Y2MtMDY3ZC00ZmY4LTgxYzMtNWJmNjAxNjUzYjYwOjUyZmRmYzA3LTIxODItNjU0Zi0xNjNmLTVmMGY5YTYyMWQ3Mg'

In the response, you will receive an API Key, your Client ID and a new Client Secret.

Important: This new Client Secret replaces the secret sent in the previous e-mail.

Store your API Key, Client ID and new Client Secret so you may remember it.

Retrieve Your API Key

If you lost or forget the API Key information, use the GET method for /apikey to retrieve it.

Do not forget to use your Client ID and new Client Secret.

Production example only:

curl -X GET 'https://cloudapi.estes-express.com/v1/api-key'
-H 'accept: application/json'
-u ClientID:ClientSecret
ZThkNmM4Y2MtMDY3ZC00ZmY4LTgxYzMtNWJmNjAxNjUzYjYwOjUyZmRmYzA3LTIxODItNjU0Zi0xNjNmLTVmMGY5YTYyMWQ3Mg'

Test example only:

curl -X GET 'https://uat-cloudapi.estes-express.com/v1/api-key'
-H 'accept: application/json'
-u ClientID:ClientSecret
ZThkNmM4Y2MtMDY3ZC00ZmY4LTgxYzMtNWJmNjAxNjUzYjYwOjUyZmRmYzA3LTIxODItNjU0Zi0xNjNmLTVmMGY5YTYyMWQ3Mg'

Delete Your API Key

To delete your API Key, use the DELETE method for /apikey to retrieve it.

Do not forget to use your Client ID and new Client Secret.

Production example only:

curl -X DELETE 'https://cloudapi.estes-express.com/v1/api-key'
-H 'accept: application/json'
-u ClientID:ClientSecret
ZThkNmM4Y2MtMDY3ZC00ZmY4LTgxYzMtNWJmNjAxNjUzYjYwOjUyZmRmYzA3LTIxODItNjU0Zi0xNjNmLTVmMGY5YTYyMWQ3Mg'

Test example only:

curl -X DELETE 'https://uat-cloudapi.estes-express.com/v1/api-key'
-H 'accept: application/json'
-u ClientID:ClientSecret
ZThkNmM4Y2MtMDY3ZC00ZmY4LTgxYzMtNWJmNjAxNjUzYjYwOjUyZmRmYzA3LTIxODItNjU0Zi0xNjNmLTVmMGY5YTYyMWQ3Mg'

Individual/Direct API Customers

For individual or direct customers, you will need your MyEstes Username and
MyEstes Password.

If you do not have a MyEstes profile, you can sign up for one here.

These steps should ONLY be used if you are an Individual or Direct API Customer.

This API Key will ony work for the MyEstes Username and Password used to create the key.

Generate API Keys

To generate an API Key for the production environment, submit a POST request
to the following URL with your MyEstes Username and MyEstes Password as the
username and password in the basic authorization header.

Production example only:

curl -X POST 'https://cloudapi.estes-express.com/v1/api-key'
-H 'accept: application/json'
-u myEstesUsername:myEstesPassword

To generate an API Key for the test environment, submit a POST request to the
following URL with your MyEstes Username and MyEstes Password as the username
and password in the basic authorization header.

Test example only:

curl -X POST 'https://uat-cloudapi.estes-express.com/v1/api-key'
-H 'accept: application/json'
-u myEstesUsername:myEstesPassword

The response will contain the API Key for the chosen environment. Store this information.

Retrieve, Delete and Request New API Keys

To retrieve a previously issued API Key for production environment, submit a
GET request to the following URL with your MyEstes Username and MyEstes Password
as the username and password in the basic authorization header. See this CURL
example (for test environment, you need to change the domain to:
https://uat-cloudapi.estes-express.com):

curl -X GET 'https://cloudapi.estes-express.com/v1/api-key'
-H 'accept: application/json'
-u myEstesUsername:myEstesPassword

To delete the previously issued API Key for production environment, submit a
DELETE request to the following URL with your MyEstes Username and MyEstes
Password as the username and password in the basic authorization header. (For
test environment, you need to change the domain to:
https://uat-cloudapi.estes-express.com):

curl -X DELETE 'https://cloudapi.estes-express.com/v1/api-key'
-H 'accept: application/json'
-u myEstesUsername:myEstesPassword

To request a new API Key, submit a POST request to generate a new key (as explained above).

Using API Keys To Authenticate

Request Bearer Token

When using our APIs and Web Services, you must pass the API Key using the /authenticate method to request a bearer token.

For all customers, MyEstes credentials (MyEstes username and password) must be passed in the header.

Production environment example:

curl -X POST "https://cloudapi.estes-express.com/authenticate" -H "accept: application/json" -H "apikey: 0101010101"

Test environment example:

curl -X POST "https://uat-cloudapi.estes-express.com/authenticate" -H "accept: application/json" -H "apikey: 0101010101"

The response JSON will contain the bearer token. (See JSON example on right.)

Bearer Token JSON Sample  
{
"access_token":
"eyJhbGciOiJSUzI1NiIsImtpZCI6Imp3dC1zaWduLWNlcnQifQ.eyJzY29wZSI6IiIsImNsaWVudF9pZCI6ImtvbmciLCJpc3MiOiJodHRwczovL2ZlZGVyYXRpb24tcWEuZ3NrLmNvbSIsImV4cCI6MTUzOTk3MzQyM30.IRvv0m8QKuOSDbhnlYx11bdvjk3PJBgz0cV7cSO4c1Phxfo4dRvLBvKx3TBnlaHwNYx4k3BcPEP5yDeflEVGVAhM0Is1potXWJfTQsH4PECZHEJNa7eoJFMKo9FKOutLoPg5avY2V0Oq0EU1wO8cTfrC2hNyJxfMMAYtK7pfB0u_a3ZyWLLWH9LN6xztYM86eh7QavHyns3__-uGy0O-imFDJ3Oi0SdKA1XYQDnqNhvN8J9omOVVMxEBuRdTeldM0lbeLxpWmXybQotIbMFGRVFUrwSIU6OxPA3wHyuL6F7p53C2ZsJXP463Sx2Y-9SILvVsuFtKWiUjbUn2--141g",
"token_type": "Bearer",
"expires_in": 35999
}

Using the Bearer Token with an API

The bearer token is an expiring security value string which permits access to an API’s method. You must include the bearer token with your API Key when making API requests. For TMS providers, the bearer token can only be used with one set of MyEstes credentials. Do not pass the bearer token among other customer credentials.

Example: Using Your API Key and Bearer Token with Shipment Tracking API

The Authorization parameter {TOKEN_HERE} is the bearer token (the access_token string)returned after requesting authentication.

The apikey parameter is your API key {YOUR_API_KEY}.

Production environment example:

curl -X GET “https://cloudapi.estes-express.com/v1/shipments/history?pro=0000000000" -H "accept: application/json" -H "Authorization: Bearer {TOKEN_HERE}" -H "apikey: {YOUR_API_KEY}"

Test environment example:

curl -X GET "https://uat-cloudapi.estes-express.com/v1/shipments/history?pro=0000000000" -H "accept: application/json" -H "Authorization: Bearer {TOKEN_HERE}" -H "apikey: {YOUR_API_KEY}"

For additional help, see the Examples.

(API keys are not used with Estes legacy web services. To review older web services, see https://www.estes-express.com/resources/digital-services/api/index.)

API Key

POST /v1/api-key

PRODUCTION SERVER: https://cloudapi.estes-express.com

Description

Create API key for an API consumer.
For TMS users, input the supplied ClientID and ClientSecret as Username & Password for basic auth.
MyEstes credentials can be used as well.
Note when an API key is generated for TMS users, a new ClientSecret will be provided for future requests to retrieve or delete the key.

Responses

Code Description
201 API key has been generated. Response will contain the API Key.
For TMS users response will also contain Client Id, and a new Client Secret for future use.
For MyEstes users, response will contain Username for informational purposes.
Response Schema  

{
    "application/json": {
        "schema": {
            "type": "object",
            "properties": {
                "data": {
                    "type": "object",
                    "properties": {
                        "apiKey": {
                            "type": "string"
                        },
                        "apiClientId": {
                            "type": "string"
                        },
                        "apiClientSecret": {
                            "type": "string"
                        },
                        "myEstesUsername": {
                            "type": "string"
                        }
                    }
                },
                "error": {
                    "type": "object",
                    "properties": {
                        "code": {
                            "type": "integer",
                            "format": "int32"
                        },
                        "message": {
                            "type": "string"
                        },
                        "details": {
                            "type": "string"
                        }
                    }
                }
            }
        }
    }
} 
Code Description
401 Not authenticated. Data object will be empty.
Code Description
409 Conflict. API key is already assigned. Data object will be empty.
Code Description
500 Internal server error. Data object will be empty.
Code Description
503 Service unavailable. Response body will be empty.

GET /v1/api-key

PRODUCTION SERVER: https://cloudapi.estes-express.com

Description

Get the API key of API consumer

Responses

Code Description
200 Return API key.
Response Schema  

{
    "application/json": {
        "schema": {
            "type": "object",
            "properties": {
                "data": {
                    "type": "object",
                    "properties": {
                        "apiKey": {
                            "type": "string"
                        },
                        "apiClientId": {
                            "type": "string"
                        }
                    }
                },
                "error": {
                    "$ref": "#/paths/~1v1~1api-key/post/responses/201/content/application~1json/schema/properties/error"
                }
            }
        }
    }
} 
Code Description
400 Bad request. API key has not been generated yet. Data object will be empty.
Code Description
401 Not authenticated. Data object will be empty.
Code Description
500 Internal server error. Data object will be empty.
Code Description
503 Service unavailable. Response body will be empty.

DELETE /v1/api-key

PRODUCTION SERVER: https://cloudapi.estes-express.com

Description

Delete API key of consumer

Responses

Code Description
204 API key deleted.
Code Description
400 Bad request. API key has not been generated yet. Data object will be empty.
Code Description
401 Not authenticated. Data object will be empty.
Code Description
500 Internal server error. Data object will be empty.
Code Description
503 Service unavailable. Response body will be empty.

Authentication

POST /authenticate

PRODUCTION SERVER: https://cloudapi.estes-express.com

Description

Provides a bearer token for an authenticated user that is required to access other APIs. The credentials of the user should be passed in the request using an Authorization header of the Basic authentication type.

Responses

Code Description
200 OK (Successfully authenticated.)
Response Schema  

{
    "application/json": {
        "schema": {
            "type": "object",
            "properties": {
                "token": {
                    "type": "string"
                }
            }
        }
    }
} 
Code Description
401 Authentication information is missing or invalid.
Code Description
500 Internal server error.
Code Description
503 Service unavailable.

Pickup

POST /v1/pickup-requests

TEST SERVER: https://uat-cloudapi.estes-express.com
PRODUCTION SERVER: https://cloudapi.estes-express.com

Description

Create a new pickup request. The request should include an Authorization header with a valid bearer token corresponding to the user associated with the pickup request.

Request

Complete details to create a new pickup request.

Request Schema  

{
    "application/json": {
        "schema": {
            "type": "object",
            "properties": {
                "shipper": {
                    "properties": {
                        "shipperName": {
                            "type": "string"
                        },
                        "accountCode": {
                            "type": "string"
                        },
                        "shipperAddress": {
                            "required": [
                                "addressInfo"
                            ],
                            "properties": {
                                "addressInfo": {
                                    "properties": {
                                        "addressLine1": {
                                            "type": "string"
                                        },
                                        "addressLine2": {
                                            "type": "string"
                                        },
                                        "city": {
                                            "type": "string"
                                        },
                                        "stateProvince": {
                                            "type": "string"
                                        },
                                        "postalCode": {
                                            "type": "string"
                                        },
                                        "postalCode4": {
                                            "type": "string"
                                        },
                                        "countryAbbrev": {
                                            "type": "string"
                                        }
                                    },
                                    "type": "object"
                                }
                            },
                            "type": "object"
                        },
                        "shipperContacts": {
                            "properties": {
                                "shipperContact": {
                                    "type": "array",
                                    "items": {
                                        "type": "object",
                                        "properties": {
                                            "contactInfo": {
                                                "properties": {
                                                    "name": {
                                                        "properties": {
                                                            "firstName": {
                                                                "type": "string"
                                                            },
                                                            "middleName": {
                                                                "type": "string"
                                                            },
                                                            "lastName": {
                                                                "type": "string"
                                                            }
                                                        },
                                                        "type": "object"
                                                    },
                                                    "email": {
                                                        "type": "string"
                                                    },
                                                    "phone": {
                                                        "properties": {
                                                            "areaCode": {
                                                                "type": "number"
                                                            },
                                                            "number": {
                                                                "type": "number"
                                                            },
                                                            "extension": {
                                                                "type": "number"
                                                            }
                                                        },
                                                        "type": "object"
                                                    },
                                                    "fax": {
                                                        "properties": {
                                                            "areaCode": {
                                                                "type": "number"
                                                            },
                                                            "number": {
                                                                "type": "number"
                                                            }
                                                        },
                                                        "type": "object"
                                                    },
                                                    "receiveNotifications": {
                                                        "type": "string"
                                                    },
                                                    "notificationMethod": {
                                                        "type": "string"
                                                    }
                                                },
                                                "type": "object"
                                            }
                                        }
                                    }
                                }
                            },
                            "type": "object"
                        }
                    },
                    "type": "object"
                },
                "requestAction": {
                    "type": "string"
                },
                "paymentTerms": {
                    "type": "string"
                },
                "pickupDate": {
                    "type": "string"
                },
                "pickupStartTime": {
                    "type": "string"
                },
                "pickupEndTime": {
                    "type": "string"
                },
                "totalPieces": {
                    "type": "string"
                },
                "totalWeight": {
                    "type": "string"
                },
                "totalHandlingUnits": {
                    "type": "string"
                },
                "hazmatFlag": {
                    "type": "string"
                },
                "expeditedCode": {
                    "type": "string"
                },
                "whoRequested": {
                    "type": "string"
                },
                "trailer": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "properties": {
                            "trailerInfo": {
                                "properties": {
                                    "id": {
                                        "type": "string"
                                    },
                                    "length": {
                                        "type": "string"
                                    },
                                    "type": {
                                        "type": "string"
                                    }
                                },
                                "type": "object"
                            }
                        }
                    }
                },
                "referenceNumbers": {
                    "properties": {
                        "referenceNumber": {
                            "type": "array",
                            "example": [
                                {
                                    "referenceInfo": {
                                        "type": "PRO",
                                        "value": "0062020915",
                                        "required": "N",
                                        "totalPieces": 0,
                                        "totalWeight": 0
                                    }
                                },
                                {
                                    "referenceInfo": {
                                        "type": "PON",
                                        "value": "API31082020",
                                        "required": "N",
                                        "totalPieces": 0,
                                        "totalWeight": 0
                                    }
                                },
                                {
                                    "referenceInfo": {
                                        "type": "BOL",
                                        "value": "API08312020",
                                        "required": "N",
                                        "totalPieces": 0,
                                        "totalWeight": 0
                                    }
                                },
                                {
                                    "referenceInfo": {
                                        "type": "EUI",
                                        "value": "APIE10022020",
                                        "required": "N",
                                        "totalPieces": 0,
                                        "totalWeight": 0
                                    }
                                },
                                {
                                    "referenceInfo": {
                                        "type": "LDN",
                                        "value": "APIL10022020",
                                        "required": "N",
                                        "totalPieces": 0,
                                        "totalWeight": 0
                                    }
                                },
                                {
                                    "referenceInfo": {
                                        "type": "SNO",
                                        "value": "APIS10022020",
                                        "required": "N",
                                        "totalPieces": 0,
                                        "totalWeight": 0
                                    }
                                }
                            ],
                            "items": {
                                "type": "object",
                                "properties": {
                                    "referenceInfo": {
                                        "properties": {
                                            "type": {
                                                "type": "string"
                                            },
                                            "value": {
                                                "type": "string"
                                            },
                                            "required": {
                                                "type": "string"
                                            },
                                            "totalPieces": {
                                                "type": "number"
                                            },
                                            "totalWeight": {
                                                "type": "number"
                                            }
                                        },
                                        "type": "object"
                                    }
                                }
                            }
                        }
                    },
                    "type": "object"
                },
                "commodities": {
                    "properties": {
                        "commodity": {
                            "type": "array",
                            "items": {
                                "type": "object",
                                "properties": {
                                    "commodityInfo": {
                                        "properties": {
                                            "code": {
                                                "type": "string"
                                            },
                                            "packageCode": {
                                                "type": "string"
                                            },
                                            "description": {
                                                "type": "string"
                                            },
                                            "hazmat": {
                                                "required": [
                                                    "hazmatCode",
                                                    "hazmatFlag"
                                                ],
                                                "properties": {
                                                    "hazmatCode": {
                                                        "type": "string"
                                                    },
                                                    "hazmatFlag": {
                                                        "type": "string"
                                                    }
                                                },
                                                "type": "object"
                                            },
                                            "pieces": {
                                                "type": "string"
                                            },
                                            "weight": {
                                                "type": "string"
                                            },
                                            "nmfcNumber": {
                                                "type": "string"
                                            },
                                            "nmfcSubNumber": {
                                                "type": "string"
                                            }
                                        },
                                        "type": "object"
                                    }
                                }
                            }
                        }
                    },
                    "type": "object"
                },
                "comments": {
                    "properties": {
                        "comment": {
                            "type": "array",
                            "items": {
                                "type": "object",
                                "properties": {
                                    "commentInfo": {
                                        "required": [
                                            "type",
                                            "commentText"
                                        ],
                                        "properties": {
                                            "type": {
                                                "type": "string"
                                            },
                                            "commentText": {
                                                "type": "string"
                                            }
                                        },
                                        "type": "object"
                                    }
                                }
                            }
                        }
                    },
                    "type": "object"
                },
                "consignee": {
                    "type": "object",
                    "properties": {
                        "accountCode": {
                            "type": "string"
                        },
                        "accountName": {
                            "type": "string"
                        }
                    }
                },
                "thirdParty": {
                    "type": "object",
                    "properties": {
                        "accountCode": {
                            "type": "string"
                        },
                        "accountName": {
                            "type": "string"
                        }
                    }
                },
                "addresses": {
                    "required": [
                        "address"
                    ],
                    "properties": {
                        "address": {
                            "type": "array",
                            "items": {
                                "type": "object",
                                "properties": {
                                    "addressInfo": {
                                        "properties": {
                                            "addressType": {
                                                "type": "string"
                                            },
                                            "addressLine1": {
                                                "type": "string"
                                            },
                                            "addressLine2": {
                                                "type": "string"
                                            },
                                            "city": {
                                                "type": "string"
                                            },
                                            "stateProvince": {
                                                "type": "string"
                                            },
                                            "postalCode": {
                                                "type": "string"
                                            },
                                            "postalCode4": {
                                                "type": "string"
                                            },
                                            "countryAbbrev": {
                                                "type": "string"
                                            }
                                        },
                                        "type": "object"
                                    }
                                }
                            }
                        }
                    },
                    "type": "object"
                },
                "contacts": {
                    "required": [
                        "contact"
                    ],
                    "properties": {
                        "contact": {
                            "type": "array",
                            "items": {
                                "type": "object",
                                "properties": {
                                    "contactInfo": {
                                        "required": [
                                            "contactType",
                                            "name",
                                            "email",
                                            "phone",
                                            "fax",
                                            "receiveNotifications",
                                            "notificationMethod"
                                        ],
                                        "properties": {
                                            "contactType": {
                                                "type": "string"
                                            },
                                            "name": {
                                                "required": [
                                                    "firstName",
                                                    "middleName",
                                                    "lastName"
                                                ],
                                                "properties": {
                                                    "firstName": {
                                                        "type": "string"
                                                    },
                                                    "middleName": {
                                                        "type": "string"
                                                    },
                                                    "lastName": {
                                                        "type": "string"
                                                    }
                                                },
                                                "type": "object"
                                            },
                                            "email": {
                                                "type": "string"
                                            },
                                            "phone": {
                                                "required": [
                                                    "areaCode",
                                                    "number",
                                                    "extension"
                                                ],
                                                "properties": {
                                                    "areaCode": {
                                                        "type": "string"
                                                    },
                                                    "number": {
                                                        "type": "string"
                                                    },
                                                    "extension": {
                                                        "type": "string"
                                                    }
                                                },
                                                "type": "object"
                                            },
                                            "fax": {
                                                "required": [
                                                    "areaCode",
                                                    "number"
                                                ],
                                                "properties": {
                                                    "areaCode": {
                                                        "type": "number"
                                                    },
                                                    "number": {
                                                        "type": "number"
                                                    }
                                                },
                                                "type": "object"
                                            },
                                            "receiveNotifications": {
                                                "type": "string"
                                            },
                                            "notificationMethod": {
                                                "type": "string"
                                            }
                                        },
                                        "type": "object"
                                    }
                                }
                            }
                        }
                    },
                    "type": "object"
                },
                "notifications": {
                    "required": [
                        "notification"
                    ],
                    "properties": {
                        "notification": {
                            "type": "array",
                            "items": {
                                "type": "object",
                                "properties": {
                                    "notificationInfo": {
                                        "required": [
                                            "type"
                                        ],
                                        "properties": {
                                            "type": {
                                                "type": "string"
                                            }
                                        },
                                        "type": "object"
                                    }
                                }
                            }
                        }
                    },
                    "type": "object"
                }
            }
        }
    }
} 

Responses

Code Description
201 Data object will contain the newly created pickup request.
Response Schema  

{
    "application/json": {
        "schema": {
            "type": "object",
            "properties": {
                "data": {
                    "type": "object",
                    "properties": {
                        "requestNumber": {
                            "type": "string"
                        }
                    }
                },
                "error": {
                    "type": "object",
                    "properties": {
                        "code": {
                            "type": "integer",
                            "format": "int32"
                        },
                        "message": {
                            "type": "string"
                        },
                        "details": {
                            "type": "string"
                        },
                        "validationFailures": {
                            "type": "array",
                            "items": {
                                "type": "object",
                                "properties": {
                                    "description": {
                                        "type": "string"
                                    },
                                    "field": {
                                        "type": "string"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
} 
Code Description
400 Missing or invalid body params. Data object will be empty.
Code Description
401 Not authenticated. Data object will be empty.
Code Description
500 Internal server error. Data object will be empty.
Code Description
503 Service unavailable. Response body will be empty.

PUT /v1/pickup-requests

TEST SERVER: https://uat-cloudapi.estes-express.com
PRODUCTION SERVER: https://cloudapi.estes-express.com

Description

Update specific pickup request associated with an account. The request should include an Authorization header with a valid bearer token corresponding to the user associated with the pickup request.

Request

Details to be updated for a specific pickup request.

Request Schema  

{
    "application/json": {
        "schema": {
            "type": "object",
            "properties": {
                "requestNumber": {
                    "type": "string"
                },
                "shipper": {
                    "required": [
                        "shipperName",
                        "accountCode",
                        "shipperAddress",
                        "shipperContacts"
                    ],
                    "properties": {
                        "shipperName": {
                            "type": "string"
                        },
                        "accountCode": {
                            "type": "string"
                        },
                        "shipperAddress": {
                            "required": [
                                "addressInfo"
                            ],
                            "properties": {
                                "addressInfo": {
                                    "required": [
                                        "addressLine1",
                                        "addressLine2",
                                        "city",
                                        "stateProvince",
                                        "postalCode",
                                        "postalCode4",
                                        "countryAbbrev"
                                    ],
                                    "properties": {
                                        "addressLine1": {
                                            "type": "string"
                                        },
                                        "addressLine2": {
                                            "type": "string"
                                        },
                                        "city": {
                                            "type": "string"
                                        },
                                        "stateProvince": {
                                            "type": "string"
                                        },
                                        "postalCode": {
                                            "type": "string"
                                        },
                                        "postalCode4": {
                                            "type": "string"
                                        },
                                        "countryAbbrev": {
                                            "type": "string"
                                        }
                                    },
                                    "type": "object"
                                }
                            },
                            "type": "object"
                        },
                        "shipperContacts": {
                            "required": [
                                "shipperContact"
                            ],
                            "properties": {
                                "shipperContact": {
                                    "type": "array",
                                    "items": {
                                        "type": "object",
                                        "properties": {
                                            "id": {
                                                "type": "number"
                                            },
                                            "operation": {
                                                "required": [
                                                    "operationType"
                                                ],
                                                "properties": {
                                                    "operationType": {
                                                        "type": "string"
                                                    }
                                                },
                                                "type": "object"
                                            },
                                            "contactInfo": {
                                                "required": [
                                                    "name",
                                                    "email",
                                                    "phone",
                                                    "fax",
                                                    "receiveNotifications",
                                                    "notificationMethod"
                                                ],
                                                "properties": {
                                                    "name": {
                                                        "required": [
                                                            "firstName",
                                                            "middleName",
                                                            "lastName"
                                                        ],
                                                        "properties": {
                                                            "firstName": {
                                                                "type": "string"
                                                            },
                                                            "middleName": {
                                                                "type": "string"
                                                            },
                                                            "lastName": {
                                                                "type": "string"
                                                            }
                                                        },
                                                        "type": "object"
                                                    },
                                                    "email": {
                                                        "type": "string"
                                                    },
                                                    "phone": {
                                                        "required": [
                                                            "areaCode",
                                                            "number",
                                                            "extension"
                                                        ],
                                                        "properties": {
                                                            "areaCode": {
                                                                "type": "number"
                                                            },
                                                            "number": {
                                                                "type": "number"
                                                            },
                                                            "extension": {
                                                                "type": "number"
                                                            }
                                                        },
                                                        "type": "object"
                                                    },
                                                    "fax": {
                                                        "required": [
                                                            "areaCode",
                                                            "number"
                                                        ],
                                                        "properties": {
                                                            "areaCode": {
                                                                "type": "number"
                                                            },
                                                            "number": {
                                                                "type": "number"
                                                            }
                                                        },
                                                        "type": "object"
                                                    },
                                                    "receiveNotifications": {
                                                        "type": "string"
                                                    },
                                                    "notificationMethod": {
                                                        "type": "string"
                                                    }
                                                },
                                                "type": "object"
                                            }
                                        }
                                    }
                                }
                            },
                            "type": "object"
                        }
                    },
                    "type": "object"
                },
                "requestAction": {
                    "type": "string"
                },
                "paymentTerms": {
                    "type": "string"
                },
                "pickupDate": {
                    "type": "string"
                },
                "pickupStartTime": {
                    "type": "string"
                },
                "pickupEndTime": {
                    "type": "string"
                },
                "totalPieces": {
                    "type": "string"
                },
                "totalWeight": {
                    "type": "string"
                },
                "totalHandlingUnits": {
                    "type": "string"
                },
                "hazmatFlag": {
                    "type": "string"
                },
                "expeditedCode": {
                    "type": "string"
                },
                "whoRequested": {
                    "type": "string"
                },
                "trailer": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "properties": {
                            "trailerInfo": {
                                "properties": {
                                    "id": {
                                        "type": "string"
                                    },
                                    "length": {
                                        "type": "string"
                                    },
                                    "type": {
                                        "type": "string"
                                    }
                                },
                                "type": "object"
                            }
                        }
                    }
                },
                "referenceNumbers": {
                    "properties": {
                        "referenceNumber": {
                            "type": "array",
                            "example": [
                                {
                                    "referenceInfo": {
                                        "type": "PRO",
                                        "value": "0062020915",
                                        "required": "N",
                                        "totalPieces": 0,
                                        "totalWeight": 0
                                    }
                                },
                                {
                                    "referenceInfo": {
                                        "type": "PON",
                                        "value": "API31082020",
                                        "required": "N",
                                        "totalPieces": 0,
                                        "totalWeight": 0
                                    }
                                },
                                {
                                    "referenceInfo": {
                                        "type": "BOL",
                                        "value": "API08312020",
                                        "required": "N",
                                        "totalPieces": 0,
                                        "totalWeight": 0
                                    }
                                },
                                {
                                    "referenceInfo": {
                                        "type": "EUI",
                                        "value": "APIE10022020",
                                        "required": "N",
                                        "totalPieces": 0,
                                        "totalWeight": 0
                                    }
                                },
                                {
                                    "referenceInfo": {
                                        "type": "LDN",
                                        "value": "APIL10022020",
                                        "required": "N",
                                        "totalPieces": 0,
                                        "totalWeight": 0
                                    }
                                },
                                {
                                    "referenceInfo": {
                                        "type": "SNO",
                                        "value": "APIS10022020",
                                        "required": "N",
                                        "totalPieces": 0,
                                        "totalWeight": 0
                                    }
                                }
                            ],
                            "items": {
                                "type": "object",
                                "properties": {
                                    "id": {
                                        "type": "number"
                                    },
                                    "operation": {
                                        "properties": {
                                            "operationType": {
                                                "type": "string"
                                            }
                                        },
                                        "type": "object"
                                    },
                                    "referenceInfo": {
                                        "properties": {
                                            "type": {
                                                "type": "string"
                                            },
                                            "value": {
                                                "type": "string"
                                            },
                                            "required": {
                                                "type": "string"
                                            },
                                            "totalPieces": {
                                                "type": "number"
                                            },
                                            "totalWeight": {
                                                "type": "number"
                                            }
                                        },
                                        "type": "object"
                                    }
                                }
                            }
                        }
                    },
                    "type": "object"
                },
                "commodities": {
                    "properties": {
                        "commodity": {
                            "type": "array",
                            "items": {
                                "type": "object",
                                "properties": {
                                    "id": {
                                        "type": "number"
                                    },
                                    "operation": {
                                        "properties": {
                                            "operationType": {
                                                "type": "string"
                                            }
                                        },
                                        "type": "object"
                                    },
                                    "commodityInfo": {
                                        "properties": {
                                            "code": {
                                                "type": "string"
                                            },
                                            "packageCode": {
                                                "type": "string"
                                            },
                                            "description": {
                                                "type": "string"
                                            },
                                            "hazmat": {
                                                "properties": {
                                                    "hazmatCode": {
                                                        "type": "string"
                                                    },
                                                    "hazmatFlag": {
                                                        "type": "string"
                                                    }
                                                },
                                                "type": "object"
                                            },
                                            "pieces": {
                                                "type": "string"
                                            },
                                            "weight": {
                                                "type": "string"
                                            },
                                            "nmfcNumber": {
                                                "type": "string"
                                            },
                                            "nmfcSubNumber": {
                                                "type": "string"
                                            }
                                        },
                                        "type": "object"
                                    }
                                }
                            }
                        }
                    },
                    "type": "object"
                },
                "comments": {
                    "properties": {
                        "comment": {
                            "type": "array",
                            "items": {
                                "type": "object",
                                "properties": {
                                    "id": {
                                        "type": "number"
                                    },
                                    "operation": {
                                        "properties": {
                                            "operationType": {
                                                "type": "string"
                                            }
                                        },
                                        "type": "object"
                                    },
                                    "commentInfo": {
                                        "properties": {
                                            "type": {
                                                "type": "string"
                                            },
                                            "commentText": {
                                                "type": "string"
                                            }
                                        },
                                        "type": "object"
                                    }
                                }
                            }
                        }
                    },
                    "type": "object"
                },
                "consignee": {
                    "type": "object",
                    "properties": {
                        "accountCode": {
                            "type": "string"
                        },
                        "accountName": {
                            "type": "string"
                        }
                    }
                },
                "thirdParty": {
                    "type": "object",
                    "properties": {
                        "accountCode": {
                            "type": "string"
                        },
                        "accountName": {
                            "type": "string"
                        }
                    }
                },
                "addresses": {
                    "properties": {
                        "address": {
                            "type": "array",
                            "items": {
                                "type": "object",
                                "properties": {
                                    "id": {
                                        "type": "number"
                                    },
                                    "operation": {
                                        "properties": {
                                            "operationType": {
                                                "type": "string"
                                            }
                                        },
                                        "type": "object"
                                    },
                                    "addressInfo": {
                                        "properties": {
                                            "addressType": {
                                                "type": "string"
                                            },
                                            "addressLine1": {
                                                "type": "string"
                                            },
                                            "addressLine2": {
                                                "type": "string"
                                            },
                                            "city": {
                                                "type": "string"
                                            },
                                            "stateProvince": {
                                                "type": "string"
                                            },
                                            "postalCode": {
                                                "type": "string"
                                            },
                                            "postalCode4": {
                                                "type": "string"
                                            },
                                            "countryAbbrev": {
                                                "type": "string"
                                            }
                                        },
                                        "type": "object"
                                    }
                                }
                            }
                        }
                    },
                    "type": "object"
                },
                "contacts": {
                    "properties": {
                        "contact": {
                            "type": "array",
                            "items": {
                                "type": "object",
                                "properties": {
                                    "id": {
                                        "type": "number"
                                    },
                                    "operation": {
                                        "properties": {
                                            "operationType": {
                                                "type": "string"
                                            }
                                        },
                                        "type": "object"
                                    },
                                    "contactInfo": {
                                        "properties": {
                                            "contactType": {
                                                "type": "string"
                                            },
                                            "name": {
                                                "properties": {
                                                    "firstName": {
                                                        "type": "string"
                                                    },
                                                    "middleName": {
                                                        "type": "string"
                                                    },
                                                    "lastName": {
                                                        "type": "string"
                                                    }
                                                },
                                                "type": "object"
                                            },
                                            "email": {
                                                "type": "string"
                                            },
                                            "phone": {
                                                "properties": {
                                                    "areaCode": {
                                                        "type": "string"
                                                    },
                                                    "number": {
                                                        "type": "string"
                                                    },
                                                    "extension": {
                                                        "type": "string"
                                                    }
                                                },
                                                "type": "object"
                                            },
                                            "fax": {
                                                "properties": {
                                                    "areaCode": {
                                                        "type": "number"
                                                    },
                                                    "number": {
                                                        "type": "number"
                                                    }
                                                },
                                                "type": "object"
                                            },
                                            "receiveNotifications": {
                                                "type": "string"
                                            },
                                            "notificationMethod": {
                                                "type": "string"
                                            }
                                        },
                                        "type": "object"
                                    }
                                }
                            }
                        }
                    },
                    "type": "object"
                },
                "notifications": {
                    "properties": {
                        "notification": {
                            "type": "array",
                            "items": {
                                "type": "object",
                                "properties": {
                                    "id": {
                                        "type": "number"
                                    },
                                    "operation": {
                                        "properties": {
                                            "operationType": {
                                                "type": "string"
                                            }
                                        },
                                        "type": "object"
                                    },
                                    "notificationInfo": {
                                        "properties": {
                                            "type": {
                                                "type": "string"
                                            }
                                        },
                                        "type": "object"
                                    }
                                }
                            }
                        }
                    },
                    "type": "object"
                }
            }
        }
    }
} 

Responses

Code Description
200 Data object will contain the updated pickup request.
Response Schema  

{
    "application/json": {
        "schema": {
            "$ref": "#/paths/~1v1~1pickup-requests/post/responses/201/content/application~1json/schema"
        }
    }
} 
Code Description
400 Missing or invalid path or/and body params. Data object will be empty.
Code Description
401 Not authenticated. Data object will be empty.
Code Description
404 No pickup request found. Data object will be empty.
Code Description
500 Internal server error. Data object will be empty.
Code Description
503 Service unavailable. Response body will be empty.

GET /v1/pickup-requests/{requestNumber}

TEST SERVER: https://uat-cloudapi.estes-express.com
PRODUCTION SERVER: https://cloudapi.estes-express.com

Description

Returns details of pickup request associated with a specific request number. The request should include an Authorization header with a valid bearer token corresponding to the user associated with the pickup request.

Parameters

Parameter Passed Type Max Min Required Description
requestNumber path string true The pickup request number

Responses

Code Description
200 Data object will contain the pickup request details for that specific request number.
Response Schema  

{
    "application/json": {
        "schema": {
            "type": "object",
            "properties": {
                "data": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "properties": {
                            "requestNumber": {
                                "type": "string"
                            },
                            "reconciledPros": {
                                "type": "array",
                                "items": {
                                    "type": "string"
                                }
                            },
                            "allProsPickedUpAtStop": {
                                "type": "array",
                                "items": {
                                    "type": "string"
                                }
                            },
                            "status": {
                                "properties": {
                                    "conciseStatus": {
                                        "type": "string"
                                    },
                                    "expandedStatus": {
                                        "type": "string"
                                    },
                                    "referenceDate": {
                                        "type": "string"
                                    },
                                    "referenceTime": {
                                        "type": "string"
                                    },
                                    "reasonCode": {
                                        "type": "string"
                                    },
                                    "reason": {
                                        "type": "string"
                                    }
                                },
                                "type": "object"
                            },
                            "shipper": {
                                "properties": {
                                    "name": {
                                        "type": "string"
                                    },
                                    "accountCode": {
                                        "type": "string"
                                    },
                                    "address": {
                                        "properties": {
                                            "line": {
                                                "type": "array",
                                                "items": {
                                                    "type": "string"
                                                }
                                            },
                                            "city": {
                                                "type": "string"
                                            },
                                            "state": {
                                                "type": "string"
                                            },
                                            "postalCode": {
                                                "type": "string"
                                            },
                                            "country": {
                                                "type": "string"
                                            }
                                        },
                                        "type": "object"
                                    },
                                    "contacts": {
                                        "type": "array",
                                        "items": {
                                            "type": "object",
                                            "properties": {
                                                "type": {
                                                    "type": "string"
                                                },
                                                "name": {
                                                    "type": "string"
                                                },
                                                "email": {
                                                    "type": "string"
                                                },
                                                "phone": {
                                                    "type": "string"
                                                },
                                                "fax": {
                                                    "type": "string"
                                                },
                                                "receiveNotifications": {
                                                    "type": "string"
                                                },
                                                "notificationMethod": {
                                                    "type": "string"
                                                }
                                            }
                                        }
                                    }
                                },
                                "type": "object"
                            },
                            "requestAction": {
                                "type": "string"
                            },
                            "paymentTerms": {
                                "type": "string"
                            },
                            "totalPieces": {
                                "type": "number"
                            },
                            "totalWeight": {
                                "type": "number"
                            },
                            "totalHandlingUnits": {
                                "type": "number"
                            },
                            "hazmatFlag": {
                                "type": "string"
                            },
                            "expeditedCode": {
                                "type": "string"
                            },
                            "whoRequested": {
                                "type": "string"
                            },
                            "userName": {
                                "type": "string"
                            },
                            "userAccount": {
                                "type": "string"
                            },
                            "thirdPartyName": {
                                "type": "string"
                            },
                            "thirdPartyAccountCode": {
                                "type": "string"
                            },
                            "consigneeName": {
                                "type": "string"
                            },
                            "consigneeAccountCode": {
                                "type": "string"
                            },
                            "appointment": {
                                "type": "object",
                                "properties": {
                                    "rescheduleReasonCode": {
                                        "type": "string"
                                    },
                                    "rescheduleReasonDescription": {
                                        "type": "string"
                                    },
                                    "requestedPickupDate": {
                                        "type": "string"
                                    },
                                    "startTime": {
                                        "type": "string"
                                    },
                                    "endTime": {
                                        "type": "string"
                                    }
                                }
                            },
                            "appointmentHistory": {
                                "type": "array",
                                "items": {
                                    "type": "object",
                                    "properties": {
                                        "rescheduleReasonCode": {
                                            "type": "string"
                                        },
                                        "rescheduleReasonDescription": {
                                            "type": "string"
                                        },
                                        "requestedPickupDate": {
                                            "type": "string"
                                        },
                                        "startTime": {
                                            "type": "string"
                                        },
                                        "endTime": {
                                            "type": "string"
                                        },
                                        "createdDate": {
                                            "type": "string"
                                        },
                                        "createdTime": {
                                            "type": "string"
                                        }
                                    }
                                }
                            },
                            "transportEvent": {
                                "properties": {
                                    "driver": {
                                        "type": "string"
                                    },
                                    "driverCoordinates": {
                                        "type": "array",
                                        "items": {
                                            "type": "string"
                                        }
                                    },
                                    "estimatedPickupDate": {
                                        "type": "string"
                                    },
                                    "estimatedPickupTime": {
                                        "type": "string"
                                    },
                                    "stopsAway": {
                                        "type": "string"
                                    },
                                    "lastUpdatedDate": {
                                        "type": "string"
                                    },
                                    "lastUpdatedTime": {
                                        "type": "string"
                                    }
                                },
                                "type": "object"
                            },
                            "trailers": {
                                "type": "array",
                                "items": {
                                    "type": "object",
                                    "properties": {
                                        "id": {
                                            "type": "string"
                                        },
                                        "length": {
                                            "type": "string"
                                        },
                                        "type": {
                                            "type": "string"
                                        }
                                    }
                                }
                            },
                            "referenceNumbers": {
                                "type": "array",
                                "items": {
                                    "type": "object",
                                    "properties": {
                                        "type": {
                                            "type": "string"
                                        },
                                        "value": {
                                            "type": "string"
                                        }
                                    }
                                }
                            },
                            "commodities": {
                                "type": "array",
                                "items": {
                                    "type": "object",
                                    "properties": {
                                        "code": {
                                            "type": "string"
                                        },
                                        "packageCode": {
                                            "type": "string"
                                        },
                                        "description": {
                                            "type": "string"
                                        },
                                        "hazmat": {
                                            "properties": {
                                                "hazmatCode": {
                                                    "type": "string"
                                                },
                                                "hazmatFlag": {
                                                    "type": "string"
                                                }
                                            },
                                            "type": "object"
                                        },
                                        "pieces": {
                                            "type": "number"
                                        },
                                        "weight": {
                                            "type": "number"
                                        },
                                        "nmfcNumber": {
                                            "type": "string"
                                        },
                                        "nmfcSubNumber": {
                                            "type": "string"
                                        }
                                    }
                                }
                            },
                            "comments": {
                                "type": "array",
                                "items": {
                                    "type": "object",
                                    "properties": {
                                        "text": {
                                            "type": "string"
                                        }
                                    }
                                }
                            },
                            "addresses": {
                                "type": "array",
                                "items": {
                                    "type": "object",
                                    "properties": {
                                        "type": {
                                            "type": "string"
                                        },
                                        "line": {
                                            "type": "array",
                                            "items": {
                                                "type": "string"
                                            }
                                        },
                                        "city": {
                                            "type": "string"
                                        },
                                        "state": {
                                            "type": "string"
                                        },
                                        "postalCode": {
                                            "type": "string"
                                        },
                                        "country": {
                                            "type": "string"
                                        }
                                    }
                                }
                            },
                            "contacts": {
                                "type": "array",
                                "items": {
                                    "type": "object",
                                    "properties": {
                                        "type": {
                                            "type": "string"
                                        },
                                        "name": {
                                            "type": "string"
                                        },
                                        "email": {
                                            "type": "string"
                                        },
                                        "phone": {
                                            "type": "string"
                                        },
                                        "fax": {
                                            "type": "string"
                                        },
                                        "receiveNotifications": {
                                            "type": "string"
                                        },
                                        "notificationMethod": {
                                            "type": "string"
                                        }
                                    }
                                }
                            },
                            "notifications": {
                                "type": "array",
                                "items": {
                                    "type": "object",
                                    "properties": {
                                        "type": {
                                            "type": "string"
                                        }
                                    }
                                }
                            },
                            "originTerminal": {
                                "properties": {
                                    "number": {
                                        "type": "string"
                                    },
                                    "name": {
                                        "type": "string"
                                    },
                                    "address": {
                                        "properties": {
                                            "line": {
                                                "type": "array",
                                                "items": {
                                                    "type": "string"
                                                }
                                            },
                                            "city": {
                                                "type": "string"
                                            },
                                            "state": {
                                                "type": "string"
                                            },
                                            "postalCode": {
                                                "type": "string"
                                            },
                                            "country": {
                                                "type": "string"
                                            }
                                        },
                                        "type": "object"
                                    },
                                    "telephone": {
                                        "type": "string"
                                    },
                                    "fax": {
                                        "type": "string"
                                    },
                                    "email": {
                                        "type": "string"
                                    }
                                },
                                "type": "object"
                            }
                        }
                    }
                },
                "error": {
                    "type": "object",
                    "properties": {
                        "code": {
                            "type": "integer",
                            "format": "int32"
                        },
                        "message": {
                            "type": "string"
                        },
                        "details": {
                            "type": "string"
                        },
                        "validationFailures": {
                            "type": "array",
                            "items": {
                                "type": "object",
                                "properties": {
                                    "description": {
                                        "type": "string"
                                    },
                                    "field": {
                                        "type": "string"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
} 
Code Description
400 Missing or invalid path parameter. Data object will be empty.
Code Description
401 Not authenticated. Data object will be empty.
Code Description
403 Not authorized. Data object will be empty.
Code Description
404 No pickup request found. Data object will be empty.
Code Description
500 Internal server error. Data object will be empty.
Code Description
503 Service unavailable. Response body will be empty.

DELETE /v1/pickup-requests/{requestNumber}

TEST SERVER: https://uat-cloudapi.estes-express.com
PRODUCTION SERVER: https://cloudapi.estes-express.com

Description

Delete pickup request associated with an account. The request should include an Authorization header with a valid bearer token corresponding to the user associated with the pickup request.

Parameters

Parameter Passed Type Max Min Required Description
requestNumber path string true The pickup request number used to delete a specific pickup request.

Request

Contains comment to be saved

Request Schema  

{
    "application/json": {
        "schema": {
            "type": "object",
            "properties": {
                "comment": {
                    "type": "object",
                    "properties": {
                        "type": {
                            "type": "string"
                        },
                        "text": {
                            "type": "string"
                        }
                    }
                }
            }
        }
    }
} 

Responses

Code Description
200 Data object will contain request number of the specific pickup request.
Response Schema  

{
    "application/json": {
        "schema": {
            "type": "object",
            "properties": {
                "data": {
                    "type": "object",
                    "properties": {
                        "requestNumber": {
                            "type": "string"
                        }
                    }
                },
                "error": {
                    "$ref": "#/paths/~1v1~1pickup-requests~1%7BrequestNumber%7D/get/responses/200/content/application~1json/schema/properties/error"
                }
            }
        }
    }
} 
Code Description
400 Missing or invalid path parameter. Data object will be empty.
Code Description
401 Not authenticated. Data object will be empty.
Code Description
404 No pickup request found. Data object will be empty.
Code Description
500 Internal server error. Data object will be empty.
Code Description
503 Service unavailable. Response body will be empty.

Shipment Tracking

GET /v1/shipments/history

PRODUCTION SERVER: https://cloudapi.estes-express.com

Description

Returns details of shipment tracking history based on PRO or Reference Number.
Either a PRO or Reference Number (PO, BOL, LDN, PUR, EXL, or interline-pro) is required.
If not a payer on the shipment, financial charge information will be excluded from the response.
If not authorized for the shipment, a redacted payload will be returned.
Requires a valid bearer token in the Authorization header of the request.

Parameters

Parameter Passed Type Max Min Required Description
pro query number 10 10 N/A PRO tracking number
po query string 15 1 N/A Purchase Order number
bol query string 25 1 N/A Bill Of Lading number
pur query string 10 1 N/A Pickup Request number
ldn query string 25 1 N/A Load number
exl query string 25 1 N/A EXLA-ID number
interline-pro query string 15 1 N/A Interline PRO (From/To)
party-to query boolean false For PO, BOL, LDN, PUR, EXL, or Interline-pro lookups, determines whether to only see results which your account is party to, or all results for the reference number

Responses

Code Description
200 Returns details of shipment history based on PRO
Response Schema  

{
    "application/json": {
        "schema": {
            "type": "object",
            "properties": {
                "data": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "properties": {
                            "pro": {
                                "type": "string"
                            },
                            "documentReference": {
                                "type": "array",
                                "description": "The document reference contains additional BOL & PO numbers, and other document references",
                                "items": {
                                    "type": "object",
                                    "properties": {
                                        "id": {
                                            "type": "string"
                                        },
                                        "documentType": {
                                            "type": "string"
                                        }
                                    }
                                }
                            },
                            "pickupRequestNumber": {
                                "type": "string"
                            },
                            "pickupDate": {
                                "type": "string"
                            },
                            "pickupTime": {
                                "type": "string"
                            },
                            "expeditedCode": {
                                "type": "string"
                            },
                            "expeditedDescription": {
                                "type": "string"
                            },
                            "isResidential": {
                                "type": "boolean"
                            },
                            "isTruckload": {
                                "type": "boolean"
                            },
                            "status": {
                                "type": "object",
                                "properties": {
                                    "conciseStatus": {
                                        "type": "string"
                                    },
                                    "expandedStatus": {
                                        "type": "string"
                                    },
                                    "referenceDate": {
                                        "type": "string"
                                    },
                                    "referenceTime": {
                                        "type": "string"
                                    },
                                    "reasonCode": {
                                        "type": "string"
                                    },
                                    "reason": {
                                        "type": "string"
                                    },
                                    "quantity": {
                                        "type": "string"
                                    },
                                    "packageType": {
                                        "type": "string"
                                    },
                                    "packageDescription": {
                                        "type": "string"
                                    }
                                }
                            },
                            "deliveryDate": {
                                "type": "string"
                            },
                            "deliveryTime": {
                                "type": "string"
                            },
                            "receivedBy": {
                                "type": "string"
                            },
                            "estimatedDelivery": {
                                "type": "object",
                                "properties": {
                                    "startDate": {
                                        "type": "string"
                                    },
                                    "startTime": {
                                        "type": "string"
                                    },
                                    "endDate": {
                                        "type": "string"
                                    },
                                    "endTime": {
                                        "type": "string"
                                    }
                                }
                            },
                            "transitDays": {
                                "type": "string"
                            },
                            "driverInfo": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string"
                                    },
                                    "geoCoordinates": {
                                        "type": "array",
                                        "items": {
                                            "type": "string"
                                        }
                                    },
                                    "stopsAway": {
                                        "type": "string"
                                    }
                                }
                            },
                            "appointment": {
                                "type": "object",
                                "properties": {
                                    "status": {
                                        "type": "string"
                                    },
                                    "startDate": {
                                        "type": "string"
                                    },
                                    "startTime": {
                                        "type": "string"
                                    },
                                    "endDate": {
                                        "type": "string"
                                    },
                                    "endTime": {
                                        "type": "string"
                                    }
                                }
                            },
                            "appointmentHistory": {
                                "type": "array",
                                "items": {
                                    "type": "object",
                                    "properties": {
                                        "status": {
                                            "type": "string"
                                        },
                                        "startDate": {
                                            "type": "string"
                                        },
                                        "startTime": {
                                            "type": "string"
                                        },
                                        "endDate": {
                                            "type": "string"
                                        },
                                        "endTime": {
                                            "type": "string"
                                        },
                                        "createdDate": {
                                            "type": "string"
                                        },
                                        "createdTime": {
                                            "type": "string"
                                        }
                                    }
                                }
                            },
                            "piecesCount": {
                                "type": "string"
                            },
                            "totalWeight": {
                                "type": "string"
                            },
                            "freightCharges": {
                                "type": "string"
                            },
                            "terms": {
                                "type": "string"
                            },
                            "consigneeParty": {
                                "type": "object",
                                "properties": {
                                    "accountNumber": {
                                        "type": "string"
                                    },
                                    "name": {
                                        "type": "string"
                                    },
                                    "address": {
                                        "$ref": "#/paths/~1v1~1shipments~1history/get/responses/200/content/application~1json/schema/properties/data/items/properties/thirdParty/properties/address"
                                    },
                                    "geoCoordinates": {
                                        "type": "array",
                                        "items": {
                                            "type": "string"
                                        }
                                    }
                                }
                            },
                            "shipperParty": {
                                "$ref": "#/paths/~1v1~1shipments~1history/get/responses/200/content/application~1json/schema/properties/data/items/properties/consigneeParty"
                            },
                            "thirdParty": {
                                "type": "object",
                                "properties": {
                                    "accountNumber": {
                                        "type": "string"
                                    },
                                    "name": {
                                        "type": "string"
                                    },
                                    "address": {
                                        "type": "object",
                                        "properties": {
                                            "line": {
                                                "type": "array",
                                                "items": {
                                                    "type": "string"
                                                }
                                            },
                                            "city": {
                                                "type": "string"
                                            },
                                            "state": {
                                                "type": "string"
                                            },
                                            "postalCode": {
                                                "type": "string"
                                            },
                                            "country": {
                                                "type": "string"
                                            }
                                        }
                                    }
                                }
                            },
                            "destinationTerminal": {
                                "type": "object",
                                "properties": {
                                    "number": {
                                        "type": "string"
                                    },
                                    "name": {
                                        "type": "string"
                                    },
                                    "address": {
                                        "$ref": "#/paths/~1v1~1shipments~1history/get/responses/200/content/application~1json/schema/properties/data/items/properties/thirdParty/properties/address"
                                    },
                                    "geoCoordinates": {
                                        "type": "array",
                                        "items": {
                                            "type": "string"
                                        }
                                    },
                                    "telephone": {
                                        "type": "string"
                                    },
                                    "fax": {
                                        "type": "string"
                                    },
                                    "email": {
                                        "type": "string"
                                    }
                                }
                            },
                            "originTerminal": {
                                "$ref": "#/paths/~1v1~1shipments~1history/get/responses/200/content/application~1json/schema/properties/data/items/properties/destinationTerminal"
                            },
                            "interlineFrom": {
                                "type": "object",
                                "properties": {
                                    "pro": {
                                        "type": "string"
                                    },
                                    "scacCode": {
                                        "type": "string"
                                    }
                                }
                            },
                            "interlineTo": {
                                "$ref": "#/paths/~1v1~1shipments~1history/get/responses/200/content/application~1json/schema/properties/data/items/properties/interlineFrom"
                            },
                            "disclaimers": {
                                "type": "array",
                                "items": {
                                    "type": "string"
                                }
                            },
                            "movementHistory": {
                                "type": "array",
                                "items": {
                                    "type": "object",
                                    "properties": {
                                        "id": {
                                            "type": "string"
                                        },
                                        "description": {
                                            "type": "string"
                                        },
                                        "location": {
                                            "type": "object",
                                            "properties": {
                                                "id": {
                                                    "type": "string"
                                                },
                                                "name": {
                                                    "type": "string"
                                                },
                                                "code": {
                                                    "type": "string"
                                                },
                                                "address": {
                                                    "type": "array",
                                                    "items": {
                                                        "$ref": "#/paths/~1v1~1shipments~1history/get/responses/200/content/application~1json/schema/properties/data/items/properties/thirdParty/properties/address"
                                                    }
                                                },
                                                "geoCoordinates": {
                                                    "type": "array",
                                                    "items": {
                                                        "type": "string"
                                                    }
                                                }
                                            }
                                        },
                                        "contact": {
                                            "type": "object",
                                            "properties": {
                                                "telephone": {
                                                    "type": "string"
                                                },
                                                "fax": {
                                                    "type": "string"
                                                }
                                            }
                                        },
                                        "transportEventTypeCode": {
                                            "type": "string"
                                        },
                                        "statusHistory": {
                                            "type": "array",
                                            "items": {
                                                "$ref": "#/paths/~1v1~1shipments~1history/get/responses/200/content/application~1json/schema/properties/data/items/properties/status"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "error": {
                    "type": "object",
                    "properties": {
                        "code": {
                            "type": "integer",
                            "format": "int32"
                        },
                        "message": {
                            "type": "string"
                        },
                        "details": {
                            "type": "string"
                        }
                    }
                }
            }
        }
    }
} 
Code Description
403 Not authorized. Data object will be empty.
Code Description
500 Internal server error. Data object will be empty.
Code Description
503 Service unavailable. Response body will be empty.

Components

BasicAuth

{
    "type": "http",
    "scheme": "basic"
} 

ApiKeyAuth

{
    "type": "apiKey",
    "in": "header",
    "name": "apikey",
    "description": "Unique identifier provided to the client by Estes Express."
} 

bearerAuth

{
    "type": "http",
    "scheme": "bearer",
    "bearerFormat": "JWT",
    "description": "Token returned by the authentication API for the user."
} 

Examples

The examples listed here consist of a CURL (https request) statement with necessary parameters or request body followed by a response in JSON format.

Examples are for illustrative purposes only. You need a valid API key and bearer authentication token. See Accessing Our Apis for more information.

1. You want to create a pickup request.

CURL:

curl --location --request POST 'https://cloudapi.estes-express.com/v1/pickup-requests' \
--header 'apikey: apikey-here' \
--header 'Authorization: Bearer your-token-here' \
--header 'Content-Type: application/json' \
--data-raw '{
    "shipper": {
        "shipperName": "ACCEPTANCE TESTER",
        "accountCode": "123456",
        "shipperAddress": {
            "addressInfo": {
                "addressLine1": "30 FIREMENS WAY",
                "addressLine2": "",                
                "city": "POUGHKEEPSIE",
                "stateProvince": "NY",
                "postalCode": 12603,
                "postalCode4": "",                
                "countryAbbrev": "US"
            }
        },
        "shipperContacts": {
            "shipperContact": [
                {
                    "contactInfo": {
                        "name": {
                            "firstName": "SARAH",
                            "middleName": "RANDAZZO X115",
                            "lastName": "INC"
                        },
                        "email": "info@promptlogistics.com",
                        "phone": {
                            "areaCode": 845,
                            "number": 4736780,
                            "extension": 1234
                        },
                        "receiveNotifications": "Y",
                        "notificationMethod": "E"
                    }
                }
            ]
        }
    },
    "requestAction": "LL",
    "paymentTerms": "PPD",
    "pickupDate": "2020-07-24",
    "pickupStartTime": 1000,
    "pickupEndTime": 1600,
    "totalPieces": 188,
    "totalWeight": 3720,
    "totalHandlingUnits": "8",
    "hazmatFlag": "",
    "expeditedCode": "",    
    "whoRequested": "3",
    "trailer": [
        {
        "trailerInfo": {
            "id": "12345",
            "length": "22",
            "type": ""
        }
        }
    ],    
    "referenceNumbers": {
        "referenceNumber": [
        {
            "referenceInfo": {
            "type": "PRO",
            "value": "0062020915",
            "required": "N",
            "totalPieces": 0,
            "totalWeight": 0
            }
        },
        {
            "referenceInfo": {
            "type": "PON",
            "value": "API31082020",
            "required": "N",
            "totalPieces": 0,
            "totalWeight": 0
            }
        },
        {
            "referenceInfo": {
            "type": "BOL",
            "value": "API08312020",
            "required": "N",
            "totalPieces": 0,
            "totalWeight": 0
            }
        },
        {
            "referenceInfo": {
            "type": "EUI",
            "value": "APIE10022020",
            "required": "N",
            "totalPieces": 0,
            "totalWeight": 0
            }
        },
        {
            "referenceInfo": {
            "type": "LDN",
            "value": "APIL10022020",
            "required": "N",
            "totalPieces": 0,
            "totalWeight": 0
            }
        },
        {
            "referenceInfo": {
            "type": "SNO",
            "value": "APIS10022020",
            "required": "N",
            "totalPieces": 0,
            "totalWeight": 0
            }
        }
        ]
    },
    "commodities": {
        "commodity": [
            {
                "commodityInfo": {
                    "code": "50",
                    "packageCode": "PT",
                    "description": "WIPES",
                        "hazmat": {
                        "hazmatCode": "UN1030",
                        "hazmatFlag": "X"
                        },
                    "pieces": "2",
                    "weight": "200",
                    "nmfcNumber": "SOS050820",
                    "nmfcSubNumber": "2020"
                }
            },
            {
                "commodityInfo": {
                    "code": "50",
                    "packageCode": "CT",
                    "description": "CHIPS",
                    "pieces": "2",
                    "weight": "200",
                    "nmfcNumber": "28032020",
                    "nmfcSubNumber": "2803"
                }
            }
        ]
    },
    "comments": {
        "comment": [
        {
            "commentInfo": {
            "type": "",
            "commentText": "SOME TEXT"
            }
        }
        ]
    },
    "consignee": {
        "accountCode": "",
        "accountName": ""
    },
    "thirdParty": {
        "accountCode": "",
        "accountName": ""
    },
    "addresses": {
        "address": [
            {
                "addressInfo": {
                    "addressType": "C",
                    "addressLine1": "2110 LINCOLN HWY",
                    "addressLine2": "",                    
                    "city": "EDISON",
                    "stateProvince": "NJ",
                    "postalCode": 12603,
                    "countryAbbrev": "US"
                }
            },
            {
                "addressInfo": {
                    "addressType": 3,
                    "addressLine1": "212 2nd Suite 205A",
                    "addressLine2": "",                     
                    "city": "Lakewood",
                    "stateProvince": "NJ",
                    "postalCode": 12603,
                    "countryAbbrev": "US"
                }
            }
        ]
    },
    "contacts": {
        "contact": [
            {
                "contactInfo": {
                    "contactType": "S",
                    "name": {
                        "firstName": "SARAH",
                        "middleName": "RANDAZZO X115 BABYVISION",
                        "lastName": "INC"
                    },
                    "email": "info@promptlogistics.com",
                    "phone": {
                        "areaCode": 845,
                        "number": 4736780,
                        "extension": 1234
                    },
                    "receiveNotifications": "Y",
                    "notificationMethod": "E"
                }
            },
            {
                "contactInfo": {
                    "contactType": "C",
                    "name": {
                        "firstName": "NEWPORT",
                        "lastName": "LOGISTICS"
                    },
                    "email": "info@promptlogistics.com",
                    "phone": {
                        "areaCode": 732,
                        "number": 2871440,
                        "extension": 225
                    },
                    "receiveNotifications": "Y",
                    "notificationMethod": "E"
                }
            },
            {
                "contactInfo": {
                    "contactType": 3,
                    "name": {
                        "firstName": "Prompt",
                        "lastName": "Logistics"
                    },
                    "email": "info@promptlogistics.com",
                    "phone": {
                        "areaCode": 732,
                        "number": 9058686,
                        "extension": 1234
                    },
                    "receiveNotifications": "Y",
                    "notificationMethod": "E"
                }
            },
            {
                "contactInfo": {
                    "contactType": "A",
                    "name": {
                        "firstName": "Michelle",
                        "lastName": "Gutin"
                    },
                    "email": "michael@promptlogistics.com",
                    "phone": {
                        "areaCode": 732,
                        "number": 9058686,
                        "extension": 1234
                    },
                    "receiveNotifications": "Y",
                    "notificationMethod": "E"
                }
            }
        ],
        "notifications": {
            "notification": [
            {
                "notificationInfo": {
                "type": ""
                }
            }
            ]
        }
    }
}'


RESPONSE SCHEMA:

{
    "data": {
        "requestNumber": "66307782"
    },
    "error": {
        "code": 0,
        "message": "",
        "details": "",
        "validationFailures": null
    }
}

2. You want to update a pickup request (update by the following: date, pieces, weight, contacts, reference IDs)

CURL:

curl --location --request PUT 'https://cloudapi.estes-express.com/v1/pickup-requests' \
--header 'apikey: apikey-here' \
--header 'Authorization: Bearer your-token-here' \
--header 'Content-Type: application/json' \
--data-raw '{
    "requestNumber": "66263321",
    "shipper": {
        "shipperName": "ACCEPTANCE TESTER",
        "accountCode": "123456",
        "shipperAddress": {
            "addressInfo": {
                "addressLine1": "30 FIREMENS WAY",
                "addressLine2": "",                
                "city": "POUGHKEEPSIE",
                "stateProvince": "NY",
                "postalCode": 12603,
                "postalCode4": "",                
                "countryAbbrev": "US"
            }
        },
        "shipperContacts": {
            "shipperContact": [
                {
                    "contactInfo": {
                        "name": {
                            "firstName": "SARAH",
                            "middleName": "RANDAZZO X115",
                            "lastName": "INC"
                        },
                        "email": "info@promptlogistics.com",
                        "phone": {
                            "areaCode": 845,
                            "number": 4736780,
                            "extension": 1234
                        },
                        "receiveNotifications": "Y",
                        "notificationMethod": "E"
                    }
                }
            ]
        }
    },
    "requestAction": "LL",
    "paymentTerms": "PPD",
    "pickupDate": "2020-07-24",
    "pickupStartTime": 1000,
    "pickupEndTime": 1600,
    "totalPieces": 188,
    "totalWeight": 3720,
    "totalHandlingUnits": "8",
    "hazmatFlag": "",
    "expeditedCode": "",    
    "whoRequested": "3",
    "trailer": [
        {
        "trailerInfo": {
            "id": "12345",
            "length": "22",
            "type": ""
        }
        }
    ],    
    "referenceNumbers": {
        "referenceNumber": [
        {
            "referenceInfo": {
            "type": "PRO",
            "value": "0062020915",
            "required": "N",
            "totalPieces": 0,
            "totalWeight": 0
            }
        },
        {
            "referenceInfo": {
            "type": "PON",
            "value": "API31082020",
            "required": "N",
            "totalPieces": 0,
            "totalWeight": 0
            }
        },
        {
            "referenceInfo": {
            "type": "BOL",
            "value": "API08312020",
            "required": "N",
            "totalPieces": 0,
            "totalWeight": 0
            }
        },
        {
            "referenceInfo": {
            "type": "EUI",
            "value": "APIE10022020",
            "required": "N",
            "totalPieces": 0,
            "totalWeight": 0
            }
        },
        {
            "referenceInfo": {
            "type": "LDN",
            "value": "APIL10022020",
            "required": "N",
            "totalPieces": 0,
            "totalWeight": 0
            }
        },
        {
            "referenceInfo": {
            "type": "SNO",
            "value": "APIS10022020",
            "required": "N",
            "totalPieces": 0,
            "totalWeight": 0
            }
        }
        ]
    },
    "commodities": {
        "commodity": [
            {
                "commodityInfo": {
                    "code": "100",
                    "packageCode": "PT",
                    "description": "NOVELTIES",
                    "hazmat": {
                        "hazmatCode": "",
                        "hazmatFlag": ""
                    },                    
                    "pieces": 188,
                    "weight": 3720,
                    "nmfcNumber": "",
                    "nmfcSubNumber": ""                    
                }
            }
        ]
    },
    "comments": {
        "comment": [
        {
            "commentInfo": {
            "type": "",
            "commentText": "SOME TEXT"
            }
        }
        ]
    },
    "consignee": {
        "accountCode": "",
        "accountName": ""
    },
    "thirdParty": {
        "accountCode": "",
        "accountName": ""
    },
    "addresses": {
        "address": [
            {
                "addressInfo": {
                    "addressType": "C",
                    "addressLine1": "2110 LINCOLN HWY",
                    "addressLine2": "",                    
                    "city": "EDISON",
                    "stateProvince": "NJ",
                    "postalCode": 12603,
                    "countryAbbrev": "US"
                }
            },
            {
                "addressInfo": {
                    "addressType": 3,
                    "addressLine1": "212 2nd Suite 205A",
                    "addressLine2": "",                     
                    "city": "Lakewood",
                    "stateProvince": "NJ",
                    "postalCode": 12603,
                    "countryAbbrev": "US"
                }
            }
        ]
    },
    "contacts": {
        "contact": [
            {
                "contactInfo": {
                    "contactType": "S",
                    "name": {
                        "firstName": "SARAH",
                        "middleName": "RANDAZZO X115 BABYVISION",
                        "lastName": "INC"
                    },
                    "email": "info@promptlogistics.com",
                    "phone": {
                        "areaCode": 845,
                        "number": 4736780,
                        "extension": 1234
                    },
                    "receiveNotifications": "Y",
                    "notificationMethod": "E"
                }
            },
            {
                "contactInfo": {
                    "contactType": "C",
                    "name": {
                        "firstName": "NEWPORT",
                        "lastName": "LOGISTICS"
                    },
                    "email": "info@promptlogistics.com",
                    "phone": {
                        "areaCode": 732,
                        "number": 2871440,
                        "extension": 225
                    },
                    "receiveNotifications": "Y",
                    "notificationMethod": "E"
                }
            },
            {
                "contactInfo": {
                    "contactType": 3,
                    "name": {
                        "firstName": "Prompt",
                        "lastName": "Logistics"
                    },
                    "email": "info@promptlogistics.com",
                    "phone": {
                        "areaCode": 732,
                        "number": 9058686,
                        "extension": 1234
                    },
                    "receiveNotifications": "Y",
                    "notificationMethod": "E"
                }
            },
            {
                "contactInfo": {
                    "contactType": "A",
                    "name": {
                        "firstName": "Michelle",
                        "lastName": "Gutin"
                    },
                    "email": "michael@promptlogistics.com",
                    "phone": {
                        "areaCode": 732,
                        "number": 9058686,
                        "extension": 1234
                    },
                    "receiveNotifications": "Y",
                    "notificationMethod": "E"
                }
            }
        ],
        "notifications": {
            "notification": [
            {
                "notificationInfo": {
                "type": ""
                }
            }
            ]
        }
    }
}'

RESPONSE SCHEMA:

{
    "data": {
        "requestNumber": "66307782"
    },
    "error": {
        "code": 0,
        "message": "",
        "details": "",
        "validationFailures": null
    }
}

3. You want to cancel a pickup request

Pass the pickup request number in the call.

CURL:

curl --location --request DELETE 'https://cloudapi.estes-express.com/v1/pickup-requests/66263321' \
--header 'apikey: apikey-here' \
--header 'Authorization: Bearer your-token-here' \
--header 'Content-Type: application/json' \
--data-raw '{
    "requestNumber": "66307782",
    "comment": {
        "type": "ABC",
        "text": "Sample text for comment"
    }
}'

RESPONSE SCHEMA:

{
    "data": {
        "requestNumber": "66307782"
    },
    "error": {
        "code": 0,
        "message": "",
        "details": "",
        "validationFailures": null
    }
}

4. You want to get Pickup Status information

Pass the pickup request number in the call.

CURL:

curl --location --request GET 'https://cloudapi.estes-express.com/v1/pickup-requests/66263321' \
--header 'apikey: apikey-here' \
--header 'Authorization: Bearer your-token-here'

RESPONSE SCHEMA:

{
    "data": [
    {
        "requestNumber": "64245876",
        "reconciledPros": [
            "0000000000",
            "1111111111",
            "2222222222"
        ],
        "allProsPickedUpAtStop": [
                "0058091375",
                "0058091376",
                "0058091377",
                "0058091378",
                "0058091379"
        ],                
        "status": {
            "conciseStatus": "Milestone/Concise Status",
            "expandedStatus": "Friendly Status/Expanded Status",
            "referenceDate": "2020-04-22",
            "referenceTime": "16:19:55-04:00",
            "reasonCode": "XYZ",
            "reason": "StatusReason"
        },
        "shipper": {
            "name": "OMEGA CHEMICAL",
            "accountCode": "2895833",
            "address": {
                "line": [
                    "600 W 41ST ST"
                ],
                "city": "CHICAGO",
                "state": "IL",
                "postalCode": "60609",
                "country": "USA"
            },
            "contacts": [
                {
                    "type": "S",
                    "name": "Dispatch",
                    "email": "custsrv@estes-express.com",
                    "phone": "(908) 226-1166",
                    "fax": "19082261155",
                    "receiveNotifications": "NotifCode",
                    "notificationMethod": "MethodCode"
                }
            ]
        },
        "requestAction": "LL",
        "paymentTerms": "PPD",
        "totalPieces": 5,
        "totalWeight": 500,
        "totalHandlingUnits": 2,
        "hazmatFlag": "Y",
        "expeditedCode": "E",
        "whoRequested": "S",
        "userName": "OMEGA1",
        "userAccount": "2895833",
        "thirdPartyName": "OMEGA CHEMICAL PRODUCTS",
        "thirdPartyAccountCode": "5019812",
        "consigneeName": "REBTEX INC",
        "consigneeAccountCode": "2673640",
        "appointment": {
            "rescheduleReasonCode": "Reschedule Code",
            "rescheduleReasonDescription": "Reschedule Reason",
            "requestedPickupDate": "2020-04-21",
            "startTime": "07:15:00-05:00",
            "endTime": "23:15:00-05:00"
        },
        "appointmentHistory": [
            {
                "rescheduleReasonCode": "Reschedule Code",
                "rescheduleReasonDescription": "Reschedule Reason",
                "requestedPickupDate": "2020-06-09",
                "startTime": "10:30:00-05:00",
                "endTime": "23:30:00-05:00",
                "createdDate": "2020-06-09",
                "createdTime": "06:00:05+0000"
            }
        ],
        "transportEvent": {
            "driver": "HAROLD",
            "driverCoordinates": [
                "-77.6097281",
                "37.6597617"
            ],
            "estimatedPickupDate": "2020-04-21",
            "estimatedPickupTime": "00:00:00-05:00",
            "stopsAway": "1",
            "lastUpdatedDate": "2020-04-22",
            "lastUpdatedTime": "09:16:41-05:00"
        },
        "trailers": [
            {
                "id": "520645",
                "length": "53.00",
                "type": "TrailerType"
            }
        ],
        "referenceNumbers": [
            {
                "type": "PON",
                "value": "SOS220420201"
            },
            {
                "type": "BOL",
                "value": "SOS042220201"
            }
        ],
        "commodities": [
            {
                "code": "50",
                "packageCode": "",
                "description": "UN1030, REFRIGERANT GAS R 152A, 2.1,,{TESTING  Flammable Gas}",
                "hazmat": {
                    "hazmatCode": "UN1030",
                    "hazmatFlag": "X"
                },
                "pieces": 5,
                "weight": 500,
                "nmfcNumber": "SOS2204201",
                "nmfcSubNumber": "22042"
            },
            {
                "code": "FSC",
                "packageCode": "",
                "description": "Fuel Surcharge added at 21.10%",
                "hazmat": {
                    "hazmatCode": "",
                    "hazmatFlag": ""
                },
                "pieces": 0,
                "weight": 0,
                "nmfcNumber": "",
                "nmfcSubNumber": ""
            }
        ],
        "comments": [
            {
                "text": "PICKUP CREATED FOR SOS TESTING"
            },
            {
                "text": "INTEGRATION TESTING PICKUP"
            }
        ],
        "addresses": [
            {
                "type": "A",
                "line": [
                    "322 MITCHELL BLVD"
                ],
                "city": "WEATHERFORD",
                "state": "TX",
                "postalCode": "76087",
                "country": "USA"
            },
            {
                "type": "C",
                "line": [
                    "40 INDUSTRIAL PKWY"
                ],
                "city": "SOMERVILLE",
                "state": "NJ",
                "postalCode": "08807",
                "country": "USA"
            },
            {
                "type": "3",
                "line": [
                    "322 MITCHELL BLVD"
                ],
                "city": "WEATHERFORD",
                "state": "TX",
                "postalCode": "76087",
                "country": "USA"
            }
        ],
        "contacts": [
            {
                "type": "A",
                "name": "Dispatch",
                "email": "custsrv@estes-express.com",
                "phone": "(908) 226-1166",
                "fax": "19082261155",
                "receiveNotifications": "NotifCode",
                "notificationMethod": "MethodCode"
            },
            {
                "type": "C",
                "name": "Dispatch",
                "email": "custsrv@estes-express.com",
                "phone": "(908) 226-1166",
                "fax": "19082261155",
                "receiveNotifications": "NotifCode",
                "notificationMethod": "MethodCode"
            },
            {
                "type": "3",
                "name": "Dispatch",
                "email": "custsrv@estes-express.com",
                "phone": "(908) 226-1166",
                "fax": "19082261155",
                "receiveNotifications": "NotifCode",
                "notificationMethod": "MethodCode"
            }
        ],
        "notifications": [
            {
                "type": "RCV"
            },
            {
                "type": "ACC"
            }
        ],
        "originTerminal": {
            "number": "028",
            "name": "CHICAGO",
            "address": {
                "line": [
                    "8700 Joliet Road"
                ],
                "city": "McCook",
                "state": "IL",
                "postalCode": "60525",
                "country": "USA"
            },
            "telephone": "(708) 443-5087",
            "fax": "17084477314",
            "email": "custsrv@estes-express.com"
        }
    }
    ],
    "error": {
        "code": 0,
        "message": "",
        "details": "",
        "validationFailures": null
    }
}

5. You want to get shipment tracking with full movement history

Returns details of shipment history based on PRO or Reference Number.
Either a PRO or Reference Number (PO, BOL, PUR, LDN, EXL or interline-pro) is required.

Available Parameters

Parameter Passed Type Max Min Required Description
pro query string N/A PRO-tracking number
po query string N/A Purchase Order number
bol query string N/A Bill Of Lading number
pur query string N/A Pickup Request number
ldn query string N/A Load number for shipment tracking
exl query string N/A EXL-ID number
interline-pro query string N/A Interline pro for shipment tracking
CURL:

curl --location --request GET 'https://cloudapi.estes-express.com/v1/shipments/history?pro=1710510386' \
--header 'apikey: apikey-here' \
--header 'Authorization: Bearer your-token-here'

RESPONSE SCHEMA:

{
    "data": [
        {
            "pro": "0378062552",
            "documentReference": [
                {
                    "ID": "0070434506",
                    "documentType": "PUR"
                },
                {
                    "ID": "POAPIPARAMETERS",
                    "documentType": "PON"
                },
                {
                    "ID": "BOL123",
                    "documentType": "BOL"
                },
                {
                    "ID": "LDN123",
                    "documentType": "LDN"
                }
            ],
            "pickupRequestNumber": "70434506",
            "pickupDate": "2021-03-24",
            "pickupTime": "",
            "expeditedCode": "",
            "expeditedDescription": "",
            "isResidential": true,
            "isTruckload": true,     
            "status": {
                "conciseStatus": "Driver Check-In",
                "expandedStatus": "Awaiting Delivery - Freight Given to Interline Partner",
                "referenceDate": "2021-03-25",
                "referenceTime": "12:56:47-05:00",
                "reasonCode": "DI",
                "reason": "Awaiting Delivery - Freight Given to Interline Partner",
                "packageType": "Type A",
                "packageDescription": "Description of package"
            },
            "deliveryDate": "2021-03-25",
            "deliveryTime": "11:00:00-05:00",
            "receivedBy": "EXAMPLE API",
            "estimatedDelivery": {
                "startDate": "2021-03-27",
                "startTime": "10:00:00-05:00",
                "endDate": "2021-03-27",
                "endTime": "15:30:00-05:00"
            },
            "transitDays": "",            
            "driverInfo": {
                "name": "Jim Bob",
                "geoCoordinates": [
                    "-80.838269",
                    "35.345886"
                ],
                "stopsAway": "10"
            },
            "appointment": {
                "status": "Customer requested appointment",
                "startDate": "2021-03-27",
                "startTime": "10:00:00-05:00",
                "endDate": "2021-03-27",
                "endTime": "15:30:00-05:00"
            },
            "appointmentHistory": [
                {
                    "status": "Customer requested appointment",
                    "startDate": "2021-03-27",
                    "startTime": "10:00:00-05:00",
                    "endDate": "2021-03-27",
                    "endTime": "15:30:00-05:00",
                    "createdDate": "2021-03-24",
                    "createdTime": "22:19:46+0000"
                }
            ],
            "piecesCount": "15",
            "totalWeight": "1500",
            "freightCharges": "",
            "terms": "",            
            "consigneeParty": {
                "accountNumber": "2485132",
                "name": "ACME PRINTING",
                "address": {
                    "line": [
                        "971 GREENLICK CT"
                    ],
                    "city": "COLUMBIA",
                    "state": "TN",
                    "postalCode": "38401",
                    "country": "US"
                },
                "geoCoordinates": [
                ""
                ]                
            },
            "shipperParty": {
                "accountNumber": "3797434",
                "name": "SHIP LESS",
                "address": {
                    "line": [
                        "302 RUTHERFORD LN"
                    ],
                    "city": "COLUMBIA",
                    "state": "TN",
                    "postalCode": "38401",
                    "country": "US"
                },
                "geoCoordinates": [
                ""
                ]
            },
            "thirdParty": {
                "accountNumber": "3797434",
                "name": "SHIP LESS",
                "address": {
                    "line": [
                        "302 RUTHERFORD LN"
                    ],
                    "city": "COLUMBIA",
                    "state": "TN",
                    "postalCode": "38401",
                    "country": "US"
                }
            },
            "destinationTerminal": {
                "number": "037",
                "name": "NASHVILLE",
                "address": {
                    "line": [
                        "123 Threet Industrial Rd"
                    ],
                    "city": "Smyrna",
                    "state": "TN",
                    "postalCode": "37167",
                    "country": "US"
                },
                "telephone": "(615) 220-2112",
                "fax": "16152209263",
                "email": "custsrv@estes-express.com"
            },
            "originTerminal": {
                "number": "001",
                "name": "NEW YORK",
                "address": {
                    "line": [
                        "1616 Fleet Street"
                    ],
                    "city": "Long Island City",
                    "state": "NY",
                    "postalCode": "11722",
                    "country": "US"
                },
                "geoCoordinates": [
                ""
                ],
                "telephone": "(202) 111-2112",
                "fax": "2020393894",
                "email": "custsrv@estes-express.com"
            },            
            "interlineFrom": {
                "pro": "ILFROM378062552",
                "scacCode": "ALMX"
            },
            "interlineTo": {
                "pro": "ILTO03252021037",
                "scacCode": "FRID"
            },
            "disclaimers": [
                "string"
            ],
            "movementHistory": [
                {
                    "id": "Pickup",
                    "description": "Actual Pickup",
                    "location": {
                        "id": "010",
                        "name": "Charlotte",
                        "code": "CHA",
                        "address": {
                            "line": [
                                "10815 Reames Road"
                            ],
                            "city": "Charlotte",
                            "state": "NC",
                            "postalCode": "28269",
                            "country": "US"
                        },
                        "geoCoordinates": [
                            "-80.838269",
                            "35.345886"
                        ]
                    },
                    "contact": {
                        "telephone": "",
                        "fax": ""
                    },
                    "transportEventTypeCode": "Actual Pickup",
                    "statusHistory": [
                        {
                            "conciseStatus": "Pickup Completed - ODS",
                            "expandedStatus": "Pickup Completed - ODS",
                            "referenceDate": "2021-03-24",
                            "referenceTime": "17:19:45-05:00",
                            "reasonCode": "DI",
                            "reason": "Awaiting Delivery - Freight Given to Interline Partner",
                            "quantity": "10",
                            "packageType": "",
                            "packageDescription": "" 
                        }
                    ]
                    }
                ]
                }
            ],
    "error": {
        "code": 0,
        "message": "",
        "details": ""
    }
}

Data Definitions

Definitions for data fields passed through APIs are listed here by their API object.

Some data fields are classes – they contain other fields within their JSON objects.

Additional fields within classes are followed by the row contains.

Pickup Request

Field Description
requestNumber A reference number given to the customer by the time-critical team when they request a time-critical shipment. The number is used to identify the request in the system throughout the shipping process.
reconciledPros PRO Number is a pre-assigned, 10-digit freight bill number given to each shipment to serve as a tracking number. PRO is an acronym for Progressive Rotating Order. reconcilePros indicates the pro or array of pros linked to the specific pickup request. Note: the absence of reconcilePros does not necessarily mean the freight has not been picked up, nor moving towards its destination – this means Estes has not yet been able to link any pros to the pickup request. It may take additional time for reconciliation at which time the field will be populated.
allProsPickedUpAtStop Every PROs picked up at a stop which could belong to other pickup requests and other customer requests. See reconciledPros for more information.
status A class to describe the condition or position of an object.
contains conciseStatus consists of milestone status explaining the current position of the freight or Pro in question.
• Pickup Accepted
• Driver Enroute
• Driver Arrived
• Departed Pickup Location
• Pickup Complete
expandedStatus A detailed description expanding on the current position of the freight or Pro in question
• Pickup Request Accepted
• Dispatcher Reject Reason – see table
• Driver En Route to Pickup Location
• Driver Arrived at Pickup Location
• Loading at Pickup Location
• Pickup Stop Completed
• Driver Pickup No Service Reason – see table
• Tracking Number Has Been Assigned
referenceDate Date the most recent status was applied
referenceTime Time the most recent status was applied
reasonCode The reason for this status condition or position, expressed as a code. See the following:
• See Dispatcher Reject Reason
• See Driver Pickup No Service Reason
reason The reason for this status condition or position, expressed as text. See the following.
• See Dispatcher Reject Reason
• See Driver Pickup No Service Reason
shipper This is the address of the pickup location. Although it’s optional, either it or the accountCode must be indicated. If an accountCode is provided, the shipper address (pickup location) is pulled from the Estes account master by the account code. If an address is provided in addition to the account code, the address associated with the account code will override the information provided in the shipperAddress element. NOTE: Shipper contains several classes including name, address and contacts.
contains name The name of this branch or division of an organization.
accountCode
address A class to define common information related to an address.
contains line An unstructured address line.
city The name of a city, town, or village.
state A territorial division of a country, such as a county or state, expressed as text.
postalCode The postal identifier for this address according to the relevant national postal service, such as a ZIP code or Post Code.
country The country in which this address is situated.
contacts A class that contains contact information
contains type The type of this contract, expressed as text, such as “Cost plus award fee” and “Cost plus fixed fee” from UNCEFACT Contract Type code list.
name The name of this contact. It is recommended that this be used for a functional name and not a personal name.
email The primary email address of this contact.
phone The primary telephone number of this contact.
fax The primary fax number of this contact.
receiveNotifications Boolean
notificationMethod This code indicates the method of notification if the receiveNotifications element is enabled for the contact (Y). Valid values are listed below:
• E — Email
• F — Fax (NOTE Fax-based notifications are unavailable at this time.)
requestAction This is the pickup action to perform. If the request is for Estes to pick up a full trailer, choose HE (to indicate empty) or HL (to indicate loaded). If you need Estes to drop off an empty trailer, choose SE. If the request is for a pickup of freight from your dock that is not a trailer-load, then pass LL (or don’t pass this element, and it will default to LL). If Estes must call to set up an appointment before arriving, then pass AP. Valid values are listed below:
• AP — Appointment required
• HE — LTL hook empty
• HL — LTL hook loaded
• LL — LTL live load [default]
• SE — LTL spot/drop empty
paymentTerms These are the requested payment terms to apply to any resulting shipments picked up. Valid values include:
• COL — Collect
• PPD — Prepaid
totalPieces
totalWeight The total declared weight of the goods in this consignment, including packaging but excluding the carrier’s equipment.
totalHandlingUnits
hazmatFlag Use this to indicate the requirement to pick up hazardous materials. Cite additional details and specify the identity and type of hazardous materials in the request’s commodity elements area.
expeditedCode This is an optional code indicating the priority of the resulting shipment after successful pickup. Valid values are listed below:
• (BLANK) — normal [default]
• E — Estes Forwarding
• G — Guaranteed
• H — Hot
whoRequested This optional code indicates the party that requested the pickup. The following are the valid values:
• (BLANK) — Unknown
• C — Consignee
• S — Shipper
• 3 — 3rd party
• 4 — 4th party
userName
userAccount
thirdPartyName Name of Third Party Payer of Invoice – aka Bill To Name
thirdPartyAccountCode Account Code of Third Party Payer of Invoice – aka Bill To Account
consigneeName Name of Customer receiving the freight
consigneeAccountCode Account Code of Customer receiving the freight
appointment class
contains rescheduleReasonCode The code entered is assigned a reason for the reschedule – see table
rescheduleReasonDescription A detailed description for the rescheduled Pickup request – see table
requestedPickupDate The date customer is requesting the pickup to occur
startTime This is a 4-digit time with a 2-digit hour and 2-digit minute that indicates the start of the time-window when the client expects Estes to execute the pickup.
endTime This is a 4-digit time with a 2-digit hour and 2-digit minute that indicates the end of the time-window when the client expects Estes to execute the pickup.
appointmentHistory class
contains
rescheduleReasonCode The code entered to identify the reason for the reschedule – see table
rescheduleReasonDescription A detailed description for the rescheduled Pickup request. – see table
requestedPickupDate The date on which this period begins.
startTime This is a 4-digit time with a 2-digit hour and 2-digit minute that indicates the start of the time-window when the client expects Estes to execute the pickup.
endTime This is a 4-digit time with a 2-digit hour and 2-digit minute that indicates the end of the time-window when the client expects Estes to execute the pickup.
createdDate The date when the Pickup request was submitted
createdTime The time when the Pickup request was submitted
transportEvent An event associated with this Transportation Status report.
contains driver Describes a person responsible for driving the transport means.
driverCoordinates
estimatedPickupDate
estimatedPickupTime
stopsAway
lastUpdatedDate
lastUpdatedTime
trailers The part of the rig used to haul goods. A trailer is hooked to an engine-powered tractor.
contains id
length Use this optional code if the request directs Estes to hook or drop off a trailer at the pickup location. The following are the valid values:
• (BLANK) — Trailer length not specified
• 20 — 20 feet
• 28 — 28 feet
• 40 — 40 feet
• 45 — 45 feet
• 48 — 48 feet
• 53 — 53 feet
type This optional code indicates the trailer type if the request requires Estes to hook up or drop off a trailer at the pickup location. The following are the valid values:
• (BLANK) — Trailer type not specified
• CT — Straight Container
• LG — Lift Gate
• RD — Roll Door
• SD — Side Door
• ST — Swing Door Truck
referenceNumbers class
contains type Identifies the document the reference number is associated with when the pickup request was created. Example: The reference number is from a BOL. See examples of in Pickup Request.
value Used in each referenceNumber element of the optional unbounded referenceNumbers element, this code defines the type of reference number passed in that element. Below are the valid values:
AID - Appointment ID
ARN - Amazon Reference Number
AUT - Authorization Number
BOL - Shipper Bill of Lading Number
DOC - Dock Door Number
DPT - Consignee Department Number
EXL - Estes Unique ID EUID# or CUID#
HO - Homeowner Name
LDN - Load Number ID
NUM - Shipper Reference Numbers
PKG - Sipper Package ID
PON - Purchase Order Number
PRO - Estes PRO#
PU# - Pickup Number from the Customer
RAU - Shipper Return Authorization
SID - Ship ID#
SNO - Shipper Numbers
commodities class
contains code Used in each commodity element of the optional unbounded commodities element, this unique commodity code defines the type of commodity being passed. It supports custom commodity code values or you may leave it blank (an empty string) and it will default to “MISC” (without quotes). If you are unsure what to pass, use MISC.
packageCode Used in each commodity element of the optional unbounded commodities element, this is a unit of measure for the commodity. Valid values are listed below :
• BD — Bundles
• BG — Bags
• BK — Buckets
• BL — Bales
• BR — Barrels
• BX — Boxes
• CN — Cans
• CR — Crates
• CS — Cases
• CT — Cartons
• CY — Cylinders
• DR — Drums
• JC — Jerrican
• KT — Kits
• PC — Pieces
• PK — Packages
• PL — Pails
• PT — Pallets
• RE — Reels
• RL — Rolls
• SK — Skids
• TL — Truckload
• TO — Totes
description
hazmat Hazardous Materials: The Transportation Safety Act of 1974 defines hazardous material as “a substance or material in quantity and form which may pose an unreasonable risk to health and safety or property when transported in commerce.” Consists of hazmatCode and hazmatFlag.
contains hazmatCode The hazmat element is optional. If the commodity is not hazardous, omit this element from the commodity being passed to prevent validations from requiring its child elements. Used in each commodity element of the optional unbounded commodities element, this is required if the adjacent hazmat flag has a value. It must start with one of the two values listed here to be a valid industry standard hazardous material code.
• NA
• UN
hazmatFlag Used in each commodity element of the optional unbounded commodities element, the hazmat code here represents the type of hazmat commodity. Valid values are listed below:
• (BLANK)
• C — Corrosive
• D — Dangerous
• E — Explosives
• F — Flammable
• G — Flammable gas
• H — Hazardous
• L — Chlorine
• M — Combustible
• N — Nonflammable gas
• P — Poison
• R — Radioactive
• S — Flammable solid
• X — Oxidizer
pieces The number of pieces of transport handling equipment (pallets, boxes, cases, etc.) in this consignment.
weight The total declared weight of the goods in this consignment, including packaging but excluding the carrier’s equipment.
nmfcNumber
nmfcSubNumber
comments Used in each comment element of the optional unbounded comments element, the type code here indicates the type of comment. Valid values are listed below:
• CCM — Consignee Comment
• CSI — Consignee Special Instruction
• SCM — Shipper/Stop Comment
• SSI — Shipper/Stop Special Instruction
• 3CM — 3rd Party Comment
• 3SI — 3rd Party Special Instruction
• 4CM — 4th Party Comment
• 4SI — 4th Party Special Instruction
• 5CM — 5th Party Comment
• 5SI — 5th Party Special Instruction
• 6CM — 6th Party Comment
• 6SI — 6th Party Special Instruction
addresses A class to define common information related to an address.
contains type Used in each address element of the optional unbounded addresses element, the type code here indicates the type of address being passed. Valid values are listed below:
• C — Consignee Address
• 3 — 3rd Party Address
• 4 — 4th Party Address
• 5 — 5th Party Address
• 6 — 6th Party Address
line An unstructured address line.
city The name of a city, town, or village.
state A territorial division of a country, such as a county or state, expressed as text.
postalCode The postal identifier for this address according to the relevant national postal service, such as a ZIP code or Post Code.
country The country in which this address is situated.
contacts Used in each contact element of the optional unbounded contacts element, the type code here indicates the type of contact being passed. Valid values are listed below:
contains • A — Actual Submitter
• C — Consignee Contact
• R — Requested Response Contact
• S — Shipper Contact
• 3 — Third Party Contact
• 4 — Fourth Party Contact
• 5 — Fifth Party Contact
• 6 — Sixth Party Contact
name The name of this contact. It is recommended that this be used for a functional name and not a personal name.
email The primary email address of this contact.
phone The primary telephone number of this contact.
fax The primary fax number of this contact.
receiveNotifications Boolean
notificationMethod This code indicates the method of notification if the receiveNotifications element is enabled for the contact (Y). Valid values are listed below:
• E — Email
• F — Fax (NOTE Fax-based notifications are unavailable at this time.)
notifications You can subscribe to automatic notification emails, which are sent at key events throughout the pickup lifecycle. This code indicates the type of event to subscribe to for automatic notifications. (Valid values are listed below.) It’s also possible to pass multiple notification elements with a different type on each to receive notifications when more than one of the following events occur. The notifications will be sent to all contacts passed with the receiveNotifications element set to Y via a valid associated email address.
• ACC — Terminal accepted pickup
• BGN — Work has begun
• RCV — Pickup request received
• RJT — Pickup request rejected
• WRK — Pickup request worked (Estes has the freight.)
originTerminal class The terminal at which freight is received from the shipper.
contains number
name
address A class to define common information related to an address.
contains
line An unstructured address line.
city The name of a city, town, or village.
state A territorial division of a country, such as a county or state, expressed as text.
postalCode The postal identifier for this address according to the relevant national postal service, such as a ZIP code or Post Code.
country The country in which this address is situated.
telephone The primary telephone number of this contact.
fax The primary fax number of this contact.
email The primary email address of this contact.

Dispatcher Reject Reasons

Milestone Grouping Pickup Reject Reason Code FRIENDLY VERBIAGE
Pickup Completed CC Pickup Request Canceled by Customer
Pickup Completed CCR Pickup Request Canceled by Customer
Pickup Completed DP Duplicate Request - Freight Being Tracked with Different Number
Pickup Completed NE Pickup Request Closed - Equipment Not Available
Pickup Completed RS Pickup Request Closed - Please Reschedule
Pickup Completed XC Pickup Request Closed - Capacity Constraints
Pickup Completed IP Pickup Request Closed - Freight Improperly Packaged
Pickup Completed NF Pickup Request Closed - No Freight Available
Pickup Completed NH Pickup Request Closed - Prohibited or Restricted Freight
Pickup Completed NR Pickup Request Closed - Freight Not Ready
Pickup Completed ST Pickup Request Closed - Shipper Location on Strike
Pickup Completed TC Pickup Request Closed - Freight Released to Alternate Carrier By Shipper
Pickup Completed UC Pickup Request Closed - Unable to Contact Shipper to Make Appointment for Pickup
Pickup Completed UK Pickup Request Closed - Shipper Has No Knowledge of Freight
Pickup Completed UL Pickup Request Closed - Unable to Locate Pickup Location
Pickup Completed WHEN {Pickup Reject Reason Code} does not map into one of these codes and TRANSPORT EVENT is “Rejected the Request”: Pickup Request Canceled
Pickup Completed WHEN {Pickup Reject Reason Code} does not map into one of these codes and TRANSPORT EVENT is “No freight received”: Pickup Request Canceled

Driver Pickup No Service Reasons

Milestone Grouping FRIENDLY VERBIAGE
Departed Pickup Location Pickup Exception - Will Attempt Next Business Day
Departed Pickup Location Pickup Attempted - Freight Picked Up Under Different Pickup Request
Departed Pickup Location Pickup Exception - Will Attempt Next Business Day
Departed Pickup Location Pickup Attempted - Shipper Holiday - Will Attempt Next Business Day
Departed Pickup Location Pickup Attempted - Freight Improperly Packaged - Reschedule Required
Departed Pickup Location Pickup Attempted - Shipper Unavailable - Will Return Later Today
Departed Pickup Location Pickup Attempted - Shipper Unavailable - Will Return Later Today
Departed Pickup Location Pickup Attempted - No Freight Available - Reschedule Required
Departed Pickup Location Pickup Attempted - Shipper Unavailable - Will Return Later Today
Departed Pickup Location Pickup Attempted - Shipper Location on Strike - Reschedule Required
Departed Pickup Location Pickup Attempted - Prohibited or Restricted Freight
Departed Pickup Location Pickup Exception - Will Attempt Next Business Day
Departed Pickup Location Pickup Attempted - Will Return Later Today
Departed Pickup Location Pickup Attempted - Freight Released to Alternate Carrier By Shipper
Departed Pickup Location Pickup Attempted - Shipper Had No Knowledge of Freight - Reschedule Required
Departed Pickup Location Pickup Attempted - Freight Released to Alternate Carrier By Shipper
Departed Pickup Location Pickup Attempted - Unable to Locate Pickup Location - Reschedule Required

Reschedule Reason Codes

Pickup Appointment Date Change Reason Code FRIENDLY PICKUP STATUS VERBIAGE
BK Pickup Rescheduled - Equipment Not Available
CC Pickup Rescheduled - Shipper Unavailable
CO Pickup Rescheduled - Daily Route Constraint
CR Pickup Rescheduled - Customer Request
DE Pickup Rescheduled - Dispatcher Planning
HO Pickup Rescheduled - Shipper Holiday
NF Pickup Rescheduled - Freight Not Available
NS Pickup Rescheduled - Area Not Serviced Today
OR Pickup Rescheduled - Origin Capacity Constraint
RL Pickup Rescheduled - Received Request Too Late
SK Pickup Rescheduled - Shipper Has No Knowledge of Freight
WE Pickup Rescheduled - Inclement Weather

Shipment History

Field Description
pro PRO-tracking number
documentReference The document reference contains additional BOL & PO numbers, and other document references. References are data type strings. Example: “BOL”
contains ID
documentType Document type code
pickupRequestNumber
pickupDate The actual pickup date.
pickupTime The actual pickup time.
expeditedCode This is an optional code indicating the priority of the resulting shipment after successful pickup. Valid values are listed below:
• (BLANK) — normal [default]
• E — Estes Forwarding
• G — Guaranteed
• H — Hot
expeditedDescription see expeditedCode for description.
isResidential Boolean value
isTruckload Boolean value
status A class to describe the condition or position of an object.
contains conciseStatus consists of milestone status explaining the current position of the freight or Pro in question
• Departed Pickup Location
• In Transit
• Out for Delivery
• Delivered
expandedStatus A detailed description expanding on the current position of the freight or Pro in question. See the following:
• Shipment picked up
• Loaded at Estes facility at {Terminal Name}, {Terminal State} ({Terminal Number})
• Trailer Closed at Estes facility at {Terminal Name}, {Terminal State} ({Terminal Number})
• Departed Estes facility at {Terminal Name}, {Terminal State} ({Terminal Number})
• Departed Estes facility at {last Terminal Name not equal to 900 series}, {Terminal State} ({Terminal Number})
• En route to Estes facility at {Terminal Name}, {Terminal State} ({Terminal Number})
• Departed Estes facility at {last Terminal Name not equal to 900 series}, {Terminal State} ({Terminal Number})
• Arrived at Estes facility at {Terminal Name}, {Terminal State} ({Terminal Number})
• Departed Estes facility at {last Terminal Name not equal to 900 series}, {Terminal State} ({Terminal Number})
• Loaded at Estes facility at {Terminal Name}, {Terminal State} ({Terminal Number})
• Departed Estes facility at {last Terminal Name not equal to 900 series}, {Terminal State} ({Terminal Number})
• Trailer Closed at Estes facility at {Terminal Name}, {Terminal State} ({Terminal Number})
• Departed Estes facility at {last Terminal Name not equal to 900 series}, {Terminal State} ({Terminal Number})
• En route to delivery facility at {Terminal Name}, {Terminal State} ({Terminal Number})
• Arrived at {Terminal Name}, {Terminal State} ({Terminal Number}) delivery facility
• Arrived at {Terminal Name}, {Terminal State} ({Terminal Number}) delivery facility
• Arrived at {Terminal Name}, {Terminal State} ({Terminal Number}) delivery facility
• Loaded for delivery at {Terminal Name}, {Terminal State} ( {Terminal Number}) delivery facility
• Trailer Closed for delivery at {Terminal Name}, {Terminal State} ( {Terminal Number}) delivery facility
• Assigned to Driver at {Terminal Name}, {Terminal State} ( {Terminal Number}) delivery facility
• Out for delivery
• Arrived at delivery location
• Unloaded at delivery location
• Driver Delivery No Service Reason – see table
• Dispatcher Bring Back Reason – see table
referenceDate Date the most recent status was applied
referenceTime Time the most recent status was applied
reasonCode The reason for this status condition or position, expressed as a code. See the following:
• See Driver Delivery No Service Reason
• See Dispatcher Bring Back Reason
reason The reason for this status condition or position, expressed as text. See the following:
• See Driver Delivery No Service Reason
• See Dispatcher Bring Back Reason
packageType
packageDescription
deliveryDate The actual date of delivery.
deliveryTime The actual time of delivery.
receivedBy
estimatedDelivery Object - The period estimated for delivery.
contains startDate The date on which this period begins.
startTime The time at which this period begins.
endDate The date on which this period ends.
endTime The time at which this period ends.
transitDays
driverInfo class
contains name
geoCoordinates
stopsAway
appointment
contains status
startDate
startTime This is a 4-digit time with a 2-digit hour and 2-digit minute that indicates the start of the time-window when the client expects Estes to execute the pickup.
endDate
endTime This is a 4-digit time with a 2-digit hour and 2-digit minute that indicates the end of the time-window when the client expects Estes to execute the pickup.
appointmentHistory Object
contains status
startDate
startTime This is a 4-digit time with a 2-digit hour and 2-digit minute that indicates the start of the time-window when the client expects Estes to execute the pickup.
endDate
endTime This is a 4-digit time with a 2-digit hour and 2-digit minute that indicates the end of the time-window when the client expects Estes to execute the pickup.
createdDate The date when the Pickup request is submitted
createdTime The time when the Pickup request is submitted
piecesCount
totalWeight
freightCharges
terms
consigneeParty Object - The designated recipient (customer) of a shipment as indicated on the Bill of Lading.
contains accountNumber Used in each referenceNumber element of the optional unbounded referenceNumbers element, this code defines the type of reference number passed in that element. Below are the valid values:
AID - Appointment ID
ARN - Amazon Reference Number
AUT - Authorization Number
BOL - Shipper Bill of Lading Number
DOC - Dock Door Number
DPT - Consignee Department Number
EXL - Estes Unique ID EUID# or CUID#
HO - Homeowner Name
LDN - Load Number ID
NUM - Shipper Reference Numbers
PKG - Sipper Package ID
PON - Purchase Order Number
PRO - Estes PRO#
PU# - Pickup Number from the Customer
RAU - Shipper Return Authorization
SID - Ship ID#
SNO - Shipper Numbers
name The name of this branch or division of an organization.
address class
line (items) An unstructured address line.
city The name of a city, town, or village.
state the state abbreviation
postalCode The postal identifier for this address according to the relevant national postal service, such as a ZIP code or Post Code.
country The country in which this address is situated.
geoCoordinates
shipperParty Object - The designated shipper as indicated on the Bill of Lading.
contains accountNumber Used in each referenceNumber element of the optional unbounded referenceNumbers element, this code defines the type of reference number passed in that element. Below are the valid values:
AID - Appointment ID
ARN - Amazon Reference Number
AUT - Authorization Number
BOL - Shipper Bill of Lading Number
DOC - Dock Door Number
DPT - Consignee Department Number
EXL - Estes Unique ID EUID# or CUID#
HO - Homeowner Name
LDN - Load Number ID
NUM - Shipper Reference Numbers
PKG - Sipper Package ID
PON - Purchase Order Number
PRO - Estes PRO#
PU# - Pickup Number from the Customer
RAU - Shipper Return Authorization
SID - Ship ID#
SNO - Shipper Numbers
name The name of this branch or division of an organization.
address class
line (items) An unstructured address line.
city The name of a city, town, or village.
state the state abbreviation
postalCode The postal identifier for this address according to the relevant national postal service, such as a ZIP code or Post Code.
country The country in which this address is situated.
geoCoordinates
thirdParty Object - The designated third party of a shipment as indicated on the Bill of Lading.
contains accountNumber Used in each referenceNumber element of the optional unbounded referenceNumbers element, this code defines the type of reference number passed in that element. Below are the valid values:
AID - Appointment ID
ARN - Amazon Reference Number
AUT - Authorization Number
BOL - Shipper Bill of Lading Number
DOC - Dock Door Number
DPT - Consignee Department Number
EXL - Estes Unique ID EUID# or CUID#
HO - Homeowner Name
LDN - Load Number ID
NUM - Shipper Reference Numbers
PKG - Sipper Package ID
PON - Purchase Order Number
PRO - Estes PRO#
PU# - Pickup Number from the Customer
RAU - Shipper Return Authorization
SID - Ship ID#
SNO - Shipper Numbers
name The name of this branch or division of an organization.
address class
line (items) An unstructured address line.
city The name of a city, town, or village.
state the state abbreviation
postalCode The postal identifier for this address according to the relevant national postal service, such as a ZIP code or Post Code.
country The country in which this address is situated.
destinationTerminal Object - The terminal that will deliver the shipment within the geographical area that the terminal serves.
contains: number
name The name of this branch or division of an organization.
address references consigneeParty/address - A class to define common information related to an address.
geoCoordinates
telephone The primary telephone number of this contact.
fax The primary fax number of this contact.
email The primary email address of this contact.
originTerminal Object - The terminal where the delivery originates within the geographical area that the terminal serves.
contains: number
name The name of this branch or division of an organization.
address references consigneeParty/address - A class to define common information related to an address.
geoCoordinates
telephone The primary telephone number of this contact.
fax The primary fax number of this contact.
email The primary email address of this contact.
interlineFrom class
contains pro Interline pro for shipment tracking
scacCode
interlineTo class
contains pro Interline pro for shipment tracking
scacCode
disclaimers
movementHistory Object (this section includes current history and the running history of the movement of freight)
contains id
description
location contains
id
name
code
address contains
line
city
state
postalCode
country
geoCoordinates
contact contains
telephone
fax
transportEventTypeCode
statusHistory contains
conciseStatus
expandedStatus
referenceDate
referenceTime
reasonCode
reason
quantity
packageType
packageDescription

Driver Delivery No Service Codes

Milestone Grouping PEGA No Service and Exception Code Friendly Verbiage
Delivered BBC Delivery Completed - OK
Out for Delivery CutOffResolved Unable to Deliver - Will Reattempt Tomorrow
Delivered DD Delivery Completed - Damage Noted
Out for Delivery Departed Departed Delivery Location
Delivered DO Delivery Completed - Overage Noted
Delivered DS Delivery Completed - Shortage Noted
Delivered DSW Delivery Completed - Shortage Noted, Shrink Wrap Intact
Out for Delivery EndofDayResolved Unable to Deliver - Will Attempt Tomorrow
Out for Delivery HL Delivery Attempted - Customer Holiday
Out for Delivery LT Out for Delivery
Delivered NB Delivery Completed - Delivery Receipt Unavailable
Delivered NF Delivery Attempted - Freight Unavailable
Out for Delivery NR Delivery Attempted - No Receiving Personnel
Delivered PL Delivery Completed - Shortage Noted
Delivered PR Delivery Completed - Partially Refused
Delivered RD Delivery Attempted - Damage Noted, Freight Refused
Delivered RF Delivery Attempted - Freight Refused
Delivered RS Delivery Attempted - Shortage Noted, Freight Refused
Delivered SND Delivery in Progress – Freight Given to Consignee for Unloading
Out for Delivery ST Delivery Attempted - Customer on Strike
Out for Delivery UL Delivery Attempted - Unable to Locate Customer
Out for Delivery UP Delivery Attempted - Awaiting Payment

Dispatcher Bring Back Reason Codes

Milestone Grouping Delivery status Bring Back Code Friendly Reason Code Description
In Transit N AGT Awaiting Delivery - Freight Given to Final Delivery Agent
Out for Delivery N BK Delivery Attempted - Breakdown
Out for Delivery N BRK Delivery in Progress - Documents Submitted to Broker
Delivered Y CLO Delivery Completed - Closed Out
Out for Delivery N CO Unable to Deliver - Will Attempt Tomorrow
Out for Delivery N CT Delivery Attempted - CT
Delivered Y CTI Delivery Completed - Delivered to Interline Partner
Delivered * DB Undelivered - Duplicate Billing
Out for Delivery N DCA Undelivered - Declaration Accepted
Delivered Y DD Delivery Completed - Damage Noted
Delivered Y DDI Delivery Completed - Delivered to Interline with Damage Noted
In Transit Y DI Awaiting Delivery - Freight Given to Interline Partner
Delivered Y DM Delivery Completed - Delivered to Broker at Border
Delivered Y DMP Delivery Completed - Refused and Estes Handling Disposal
Delivered Y DO Delivery Completed - Overage Noted
Delivered Y DOI Delivery Completed - Delivered to Interline Partner
Delivered Y DPR Delivery Completed - Partially Refused
Delivered Y DPU Delivery Completed - Freight Picked up from Dock
Delivered * DRC Undelivered - Reconsigned
Delivered N DRD Delivery Attempted - Damage Noted, Freight Refused
Delivered N DRF Delivery Attempted - Freight Refused
Delivered N DRS Delivery Attempted - Shortage Noted, Freight Refused
Delivered Y DS Delivery Completed - Shortage Noted
Delivered Y DSI Delivery Completed - Delivered Short to Interline
Delivered Y DSW Delivery Completed - Shortage Noted, Shrink Wrap Intact
Delivered R DTS Undelivered - Returned to Shipper
Out for Delivery N EQ Delivery Attempted - Special Equipment Required
Out for Delivery N EXL Delivery in Progress - Freight Given to Estes LTL
Out for Delivery N HF Delivery Attempted - Held Freight(Hazard/Poison/Freeze)
Out for Delivery N HL Delivery Attempted - Customer Holiday
Out for Delivery N INB Delivery in Progress - Freight In Bond
Out for Delivery N L2L Awaiting Delivery - Freight Given to Final Delivery Agent
Out for Delivery N LT Out for Delivery
Delivered N NB Delivery Completed - Delivery Receipt Unavailable
Delivered N NF Delivery Attempted - Freight Unavailable
Delivered Y NFT Delivery Completed - No Freight Over 30 Days
Out for Delivery N NR Delivery Attempted - No Receiving Personnel
Out for Delivery N OH Delivery Attempted - On Hand
Delivered Y OK Delivery Completed - OK
Delivered Y OP Delivery Completed - Container(s) Open
Out for Delivery N OV Delivery Attempted - Overage
Delivered Y PL Delivery Completed - Shortage Noted
Delivered Y PR Delivery Completed - Partially Refused
Out for Delivery N PUD Out for Delivery
Out for Delivery N PW Delivery Attempted - Poor Weather Conditions
Out for Delivery N RCC Awaiting Delivery - Customs Released
Delivered * RCN Undelivered - Reconsigned
Delivered N RD Delivery Attempted - Damage Noted, Freight Refused
Out for Delivery N RDD Awaiting Delivery - Freight Given to Final Delivery Agent
Delivered N RF Delivery Attempted - Freight Refused
Delivered N RS Delivery Attempted - Shortage Noted, Freight Refused
Delivered I RTI Undelivered - Returned to Interline
Delivered * RTS Undelivered - Returned to Shipper
Delivered N SND Delivery in Progress - Freight Given to Consignee for Unloading
Delivered * SSR Undelivered - No Freight Shipper Load and Count
Out for Delivery N ST Delivery Attempted - Customer on Strike
Out for Delivery N UL Delivery Attempted - Unable to Locate Consignee
Out for Delivery N UNL Delivery Attempted - UNL
Out for Delivery N UP Delivery Attempted - Awaiting Payment
Out for Delivery N WDL Delivery Attempted - Weather Delay

Invoice

Field Description
invoiceID An identifier for this document, assigned by the sender.
trailerNumber
issueDate The date, assigned by the sender, on which this document was issued.
pro PRO Number: A pre-assigned, 10-digit freight bill number given to each shipment to serve as a tracking number. PRO is an acronym for Progressive Rotating Order.
dueDate The date on which Invoice is due.
invoiceVersion
freightBillEntryDate
billToIndicator
consignorAssignedID An identifier for this consignment, assigned by the consignor.
consigneeParty Object - A party to which goods are consigned.
contains accountNumber An identifier for this party.
name A name for this party.
address Object
line An unstructured address line.
city The name of a city, town, or village.
state A territorial division of a country, such as a county or state, expressed as text.
postalCode The postal identifier for this address according to the relevant national postal service, such as a ZIP code or Post Code.
country The primary country of this contact.
telephone
shipperParty references consigneeParty
po
bol Bill of Lading - A legal document signed by the shipper and carrier tendering the responsibility of the freight to the carrier. The BOL states pertinent information for the shipment such as the complete address of the shipper and consignee, number of pieces, description, weight, and any hazardous material information.
additionalDocumentReference Object contains additional document references
contains documentType The type of document being referenced, expressed as text.
id
documentTypeCode example (BOL)
accountingSupplierParty references consigneeParty
accountingCustomerParty references consigneeParty
allowanceCharge object - An allowance or charge covered by these delivery terms.
contains discountFunction
totalDiscount
totalDiscountPercentage
reasonCode
reason
fuelsurchargePercentage
fuelsurchargeAmount
payableAmount The amount of the monetary total to be paid.
totalFreightCharges The total monetary amount of all charges.
chargeTotalAmount
amountPaid
currencyCode
invoiceLine object - A line describing an invoice item.
contains id
note Free-form text pertinent to this document, conveying information that is not contained explicitly in other structures.
quantity
extendedAmount The total amount for this invoice line, including allowance charges but net of taxes.
itemDescription
hazmat object - identifies the hazmat code and undgCode
code A code signifying a kind of hazard for a material.
undgCode
weight
unitOfMeasure
cwtRate
specialRate object - contains the code and cost of the special rate.
code
cost
documentReference A reference to a document associated with this invoice line.
contains
documentType The type of document being referenced, expressed as text.
id
documentTypeCode The type of document being referenced, expressed as a code.
commodityCode The harmonized international commodity code for cross border and regulatory (customs and trade statistics) purposes.
consigneeDepartmnent
nmfcNumber
nmfcSubNumber
firstArrivalPortLocation object - The first arrival location in a transport. This would be a port for sea, an airport for air, a terminal for rail, or a border post for land crossing.
contains: id
description Text describing the attribute that applies to the condition.
city
state
lastExitPortLocation object references firstArrivalPortLocation
totalPieces
grossWeightMeasure The entire weight of a shipment including containers and packaging materials.
invoiceType A code signifying the type of the Invoice.
scacCode
pickupDate The actual pickup date.
deliveryDate The actual date of delivery.
billingTerms
imageRetrievalResult A string which indicates an image is available for the retrieved invoice. If “SUCCESS”, there will be data in the images object.
images object
contains url The url locater for the image.
documentType The document type.
data
contentType The content type.

Push Services

Requesting Webhook Subscriptions Using Push

With a data subscription request, the subscriber will receive Pickup and/or Shipment Tracking information about their account whenever there is a change to that data, provided you have subscribed to both.

The Push API service sends a JSON payload to the URL designated by the customer.

The subscription output matches the JSON payloads from Pickup API and Shipment Tracking API, depending on the requested event.

Requirements

To subscribe, you must have a My Estes account number. Sign Up for a MyEstes account.

Submit your request via email to WebSupport@estes-express.com. Your request must include the following information:

Subscription Events

Delete Subscriptions

In the future, a delete subscriptions mechanism will be made available. To cancel a subscription at this time, submit an email to WebSupport@estes-express.com.

Remember to include your My Estes account number in the email.

Geo Location

Geo Location (GPS) data represents the physical location of freight at key points while in transit. The timing and availability of geo location information is dependent on the stage of the transit lifecycle. For example, there are more triggering events when freight is Out for Delivery than when moving through the Line Haul network. Data is collected through Driver Hand Held (HH) devices and the Line Haul Central Dispatch network. Be aware that GPS data may not be available during transit depending on certain conditions.

The following table indicates the availability of geo location data returned by the Tracking API:

Freight Movement (Location) Geo Location Data Availability
Origin Terminal for Pickup Yes at time of terminal departure
Stops Away From Pickup Yes at each stop
Pick Up Yes at location arrival
Return to Origin Terminal Yes but updated only after departing terminal in Line Haul
Hub(s) Yes
Line Haul Meet Point* Yes
Destination Terminal Yes
Stops Away from Delivery Yes at each stop
Delivery Location Yes at location arrival

* Certain Line Haul Meet Point locations may not be on the Central Dispatch network and may not have GPS data.

Geo Location data is presented in longitude, latitude order.

The following example is presented in this JSON fragment returned from Shipment Tracking and Pickup APIs.

"geoCoordinates": [
"-72.900644",
"41.547504"
],