Download OpenAPI specification:Download
This page lists the REST services exposed by *api.shipnsd.com/book/v1*.
An API key is required to invoke the services. Contact the service owner to get your API key.
NSD Order booking API Example cURL statement
curl -XPOST -d '{"param1":"value1","param2":"value2"}' -H 'API-TOKEN: YOUR_TOKEN' 'https://api.shipnsd.com/bookp/v1'
Example using JWT or OAuth 2.0 token
curl -XPOST -d '{"param1":"value1","param2":"value2"}' -H 'Authorization: Bearer YOUR_TOKEN' 'https://api.shipnsd.com/bookp/v1'
clientId required | string Client account number NSD system, if you don't have this number it can be provided by your account representative |
orderType required | string This the type of order. Supported values are: DELIVERY for delivery order, or RETURN for return order. |
transportationMode required | 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. |
serviceLevel required | string Supported values are: BASIC), BASICPLUS, THRESHOLD, ROC, WHITEGLOVE, DELUXE. Please refer to the business agreement for selection of proper service level. |
declaredValue required | string Declared Value of Freight being shipped |
shipmentReadyTime required | string <date-time> The earliest time the shipment will be ready for pickup. Supported format: yyyy-MM-dd-HH.mm.ss.SSSSSS |
driverNotes | string Notes for the driver making the delivery or pickup, this note will be on the paperwork |
required | object |
required | object |
required | Array of objects |
required | object |
required | object |
required | Array of objects |
{- "clientId": "string",
- "orderType": "string",
- "transportationMode": "string",
- "serviceLevel": "string",
- "declaredValue": "string",
- "shipmentReadyTime": "2019-08-24T14:15:22Z",
- "driverNotes": "string",
- "origin": {
- "id": "string",
- "name": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "state": "string",
- "zip": "string",
- "primaryPhone": "string",
- "secondaryPhone": "string",
- "cell": "string",
- "email": "string",
- "textOptIn": true,
- "emailOptIn": true
}, - "destination": {
- "id": "string",
- "name": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "state": "string",
- "zip": "string",
- "primaryPhone": "string",
- "secondaryPhone": "string",
- "cell": "string",
- "email": "string",
- "textOptIn": true,
- "emailOptIn": true
}, - "productDetails": [
- {
- "productDescription": "string",
- "pieceCount": "string",
- "pieceType": "string",
- "palletCount": "string",
- "weight": "string",
- "length": "string",
- "width": "string",
- "height": "string",
- "commodity": "string",
- "isHazard": true
}
], - "references": {
- "NSDOrderNumber": "string",
- "primaryReference": "string",
- "secondaryReference": "string",
- "tertiaryReference": "string",
- "returnAuthReference": "string",
- "linehaulCarrierName": "string",
- "linehaulCarrierProbill": "string",
- "linehaulETAToNSDTerminal": "2019-08-24T14:15:22Z"
}, - "additionalService": {
- "disposal": true,
- "assembly": true,
- "swap": true,
- "mattressRemoval": true,
- "prescheduled": true,
- "prescheduledStartTime": "2019-08-24T14:15:22Z",
- "prescheduledEndTime": "2019-08-24T14:15:22Z"
}, - "notes": [
- {
- "noteType": "string",
- "theNote": "string"
}
]
}
{- "return": "string",
- "orderNumber": "string",
- "carrier": {
- "name": "string",
- "proNumber": "string"
}, - "terminal": {
- "address": "string",
- "city": "string",
- "state": "string",
- "zip": "string"
}, - "message": "string"
}