Documentation Powered by ReDoc

API platform (v1)

Download OpenAPI specification:Download

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

Authentication

api_key

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

Active

Active services

Rate Quote

The rate quote API is using TMW TRUCKMATE Rate Quote SOAP Web Service.   Example cURL statement

curl -XPOST -d '{"param1":"value1","param2":"value2"}' -H 'API-TOKEN: YOUR_TOKEN' 'https://api.staging.shipnsd.com/rate/v1'

  Example using JWT token

curl -XPOST -d '{"param1":"value1","param2":"value2"}' -H 'Authorization: Bearer YOUR_JWT_TOKEN' 'https://api.staging.shipnsd.com/rate/v1'
Authorizations:
api_key
Request Body schema: application/json
clientID
string

Client account number in NSD system, if you don't have this number it can be provided by your account representative

transportationMode
string

Mode of transportation. Supported values are: LM for Last Mile service, or DD Door to Door service. Please refer to the business agreement for selection of proper mode.

orderType
string

This is the type of order. Supported values are: DELIVERY for delivery order, or RETURN for return order.

serviceLevel
string

Supported values are: BASIC, BASICPLUS, THRESHOLD, ROC, WHITEGLOVE, DELUXE. Please refer to the business agreement for selection of proper service level.

declaredValue
number

What is the declared value of the item? Ignore or enter 0 if your contract does not include declared value pricing

origin
object
destination
object
productDetails
Array of objects

Responses

200

Success reply

401

Unauthorized

422

Processing error

500

Server error

post /v1
https://api.staging.shipnsd.com/rate/v1

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "clientID": "string",
  • "transportationMode": "string",
  • "orderType": "string",
  • "serviceLevel": "string",
  • "declaredValue": 0,
  • "origin":
    {
    },
  • "destination":
    {
    },
  • "productDetails":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "rate": 0,
  • "quoteNumber": "string"
}

Inactive

Inactive services