Get Started
API Endpoints
- Addresses
- Shipments
- Checkout
- Condition Reports
Shipments
Get Shipment
Copy
{
"data": {
"id": 1,
"title": "Secured local capability",
"value": 7431,
"status": 2,
"box": 2,
"length": 37,
"height": 21,
"depth": 1,
"service": 1,
"fulfillment_address": {
"id": 2,
"name": "Gaylord-Ratke",
"email": "warren25@hotmail.com",
"phone": "+12069536978",
"line_1": "684 Kiley Cape",
"line_2": "Suite 269",
"city": "Bednarburgh",
"region": "Idaho",
"post_code": "29709",
"country": 1,
"created_at": "2024-12-09 15:39:37",
"updated_at": "2024-12-09 15:39:37"
},
"destination_address": {
"id": 3,
"name": "Weissnat-Larkin",
"email": "weimann.aylin@gmail.com",
"phone": "+12069536978",
"line_1": "141 Chaim Mountains",
"line_2": "Apt. 556",
"city": "Lake Kamron",
"region": "South Dakota",
"post_code": "43650-3558",
"country": 1,
"created_at": "2024-12-09 15:39:37",
"updated_at": "2024-12-09 15:39:37"
},
"created_at": "2024-12-09 15:39:37",
"updated_at": "2024-12-09 15:39:37"
}
}
Overview
This endpoint can be used to get a single shipment.
Endpoint: /api/v1/shipments/{shipment_id}
Method: GET
URL Parameters
The ID of the shipment you wish to .
Response
If the shipment is successfully retrieved, the API will return a 200 OK
status code.
The response will contain the following content:
Copy
{
"data": {
"id": 1,
"title": "Secured local capability",
"value": 7431,
"status": 2,
"box": 2,
"length": 37,
"height": 21,
"depth": 1,
"service": 1,
"fulfillment_address": {
"id": 2,
"name": "Gaylord-Ratke",
"email": "warren25@hotmail.com",
"phone": "+12069536978",
"line_1": "684 Kiley Cape",
"line_2": "Suite 269",
"city": "Bednarburgh",
"region": "Idaho",
"post_code": "29709",
"country": 1,
"created_at": "2024-12-09 15:39:37",
"updated_at": "2024-12-09 15:39:37"
},
"destination_address": {
"id": 3,
"name": "Weissnat-Larkin",
"email": "weimann.aylin@gmail.com",
"phone": "+12069536978",
"line_1": "141 Chaim Mountains",
"line_2": "Apt. 556",
"city": "Lake Kamron",
"region": "South Dakota",
"post_code": "43650-3558",
"country": 1,
"created_at": "2024-12-09 15:39:37",
"updated_at": "2024-12-09 15:39:37"
},
"created_at": "2024-12-09 15:39:37",
"updated_at": "2024-12-09 15:39:37"
}
}
Copy
{
"data": {
"id": 1,
"title": "Secured local capability",
"value": 7431,
"status": 2,
"box": 2,
"length": 37,
"height": 21,
"depth": 1,
"service": 1,
"fulfillment_address": {
"id": 2,
"name": "Gaylord-Ratke",
"email": "warren25@hotmail.com",
"phone": "+12069536978",
"line_1": "684 Kiley Cape",
"line_2": "Suite 269",
"city": "Bednarburgh",
"region": "Idaho",
"post_code": "29709",
"country": 1,
"created_at": "2024-12-09 15:39:37",
"updated_at": "2024-12-09 15:39:37"
},
"destination_address": {
"id": 3,
"name": "Weissnat-Larkin",
"email": "weimann.aylin@gmail.com",
"phone": "+12069536978",
"line_1": "141 Chaim Mountains",
"line_2": "Apt. 556",
"city": "Lake Kamron",
"region": "South Dakota",
"post_code": "43650-3558",
"country": 1,
"created_at": "2024-12-09 15:39:37",
"updated_at": "2024-12-09 15:39:37"
},
"created_at": "2024-12-09 15:39:37",
"updated_at": "2024-12-09 15:39:37"
}
}
Assistant
Responses are generated using AI and may contain mistakes.