Documentation Powered by ReDoc

API platform (v1)

Download OpenAPI specification:Download

                This page lists the REST services exposed by *api.staging.shipnsd.com/route/v1*.
                An API key is required to invoke the services. Contact the service owner to get your API key.

Authentication

api_key

Regular API token

Security Scheme Type API Key
Header parameter name: API-Token

oauth2

JWT or OAuth 2.0 token

Security Scheme Type API Key
Header parameter name: Authorization

Active

Active services

Route Query

NSD Routing API for Door to Door and Last Mile orders.

For querying a Last Mile order, Client ID and Destination Zip code can be used to query the Last mile agent that will be delivering the freight without entering a freight bill.

For querying Door to Door orders, Client ID and Freight Bill number are required.   Example cURL statement

curl -XGET -H 'API-TOKEN: YOUR_TOKEN' 'https://api.staging.shipnsd.com/route/v1?param1=value1&param2=value2'

  Example using JWT or OAuth 2.0 token

curl -XGET -H 'Authorization: Bearer YOUR_TOKEN' 'https://api.staging.shipnsd.com/route/v1?param1=value1&param2=value2'
Authorizations:
api_key
query Parameters
freightBillNumber
string

The NSD assigned Freight Bill number

clientID
required
integer

Your ClientID that was assigned during your onboarding.

destinationZipCode
string

The zipcode of the final consignee

Responses

Response samples

Content type
application/json
{
  • "result": "string",
  • "carrier": {
    },
  • "terminal": {
    }
}

Inactive

Inactive services