Shipping API
Manage shipping rates, carriers, and tracking information.
GET
/admin/shipping/rates
Get available shipping rates for an address
Query Parameters
?zip=62701&country=US&weight=5&service=priorityResponse
{
"success": true,
"data": [
{
"carrier": "ups",
"service": "Ground",
"rate": 12.50,
"estimated_days": 5
}
]
}
POST
/admin/orders/{id}/ship
Create a shipment for an order
Request Body
{
"carrier": "ups",
"service": "Ground",
"weight": 5.5,
"tracking_number": "1Z999AA10123456784"
}Response
{
"success": true,
"data": {
"shipment_id": "ship_001",
"tracking_number": "1Z999AA10123456784",
"carrier": "ups",
"shipped_at": "2026-03-20T10:00:00Z"
}
}Locations API
Manage warehouse/storage locations and inventory transfers.
GET
/admin/locations
List all inventory locations
Response
{
"success": true,
"data": [
{
"id": "loc_001",
"name": "Main Warehouse",
"type": "warehouse",
"address": "123 Storage Lane"
}
]
}
POST
/admin/locations
Create a new location
Request Body
{
"name": "Secondary Warehouse",
"type": "warehouse",
"address": "456 Storage Ave"
}Response
{
"success": true,
"data": {
"id": "loc_002",
"name": "Secondary Warehouse",
"created_at": "2026-03-20T10:00:00Z"
}
}
POST
/admin/inventory/transfer
Transfer inventory between locations
Request Body
{
"product_id": "prod_123",
"from_location": "loc_001",
"to_location": "loc_002",
"quantity": 50
}Response
{
"success": true,
"data": {
"transfer_id": "tf_001",
"product_id": "prod_123",
"quantity": 50,
"transferred_at": "2026-03-20T10:00:00Z"
}
}