API platform (v1)

Download OpenAPI specification:Download

                This page lists the REST services exposed by *api.Production.shipnsd.com/book/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

Book Order

NSD Order booking API Example cURL statement

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

Example using JWT token

curl -XPOST -d '{"param1":"value1","param2":"value2"}' -H 'Authorization: Bearer YOUR_JWT_TOKEN' 'https://api.shipnsd.com/book/v1'

Authorizations:

api_key

Request Body schema: application/json

clientId	string Client account number NSD system, if you don't have this number it can be provided by your account representative
orderType	string This the type of order. Supported values are: DELIVERY for delivery order, or RETURN for return order.
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.
serviceLevel	string Supported values are: BASIC), BASICPLUS, THRESHOLD, ROC, WHITEGLOVE, DELUXE. Please refer to the business agreement for selection of proper service level.
declaredValue	string Declared Value of Freight being shipped
shipmentReadyTime	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
origin	object
destination	object
productDetails	Array of objects
references	object
additionalService	object
notes	Array of objects

Responses

200

Success reply

401

Unauthorized

422

Processing error

500

Server error

post /v1

https://api.shipnsd.com/book/v1

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"clientId": "string",
"orderType": "string",
"transportationMode": "string",
"serviceLevel": "string",
"declaredValue": "string",
"shipmentReadyTime": "2020-04-20T16:27:38Z",
"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": "2020-04-20T16:27:38Z"
},
"additionalService": 
{"disposal": true,
"assembly": true,
"swap": true,
"mattressRemoval": true,
"prescheduled": true,
"prescheduledStartTime": "2020-04-20T16:27:38Z",
"prescheduledEndTime": "2020-04-20T16:27:38Z"
},
"notes": 
[
{"noteType": "string",
"theNote": "string"
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"return": "string",
"orderNumber": "string",
"message": "string"
}

Inactive

Inactive services