REST API Documentation
/nexus/shipments/{id}
Get information about a specific shipment
Parameters
No parameters are accepted for this endpoint.
Exceptions
Code | Message | Description |
---|---|---|
2X307/1 |
INVALID_ID |
The shipment ID does not exist or the authorized user does not have permission to view it |
Response
Name | Type | Description |
---|---|---|
id
|
int | ID number |
status
|
string | Status: 'done' = Shipped; 'pend' = Waiting to be shipped; 'canc' = Canceled |
invoiceId
|
int | Invoice ID Number |
method
|
flatrate object | The shipment method (may be null if using EasyPost) |
items
|
object | The items in the shipment and their quantities |
requestDate
|
datetime | When the shipment was requested |
shipDate
|
datetime | When the shipment was shipped |
address
|
geolocation object | The delivery address |
trackingUrl
|
string | The URL to view tracking information, if available |