Baseet Ship APIv1

Shipping API Reference

Integrate Baseet Ship into your app. Create shipments, track deliveries, and calculate rates programmatically.

Quick Start

Generate an API key in ship.baseet.cc → Settings → API Keys

Authentication

Pass your key as Authorization: Bearer <api_key> on every request

Base URL

https://ship.baseet.cc/api/v1

Endpoints

POST/api/v1/shipmentsShipments

Create a new shipment

Request body

{
  "receiver": { "firstName": "Ahmed", "lastName": "Ali", "phone": "+201001234567" },
  "deliveryAddress": { "line1": "123 Tahrir St", "city": "Cairo", "country": "EG" },
  "codAmount": 250.00,
  "providerId": "<shipping_provider_id>"
}

Response

{
  "shipmentId": "shp_xxx",
  "trackingNumber": "BSTA-xxxxxx",
  "status": "created",
  "labelUrl": "https://..."
}

GET/api/v1/shipments/:idShipments

Get shipment details

Response

{
  "id": "shp_xxx",
  "status": "in_transit",
  "trackingNumber": "BSTA-xxxxxx",
  "receiver": { ... },
  "codAmount": 250.00
}

GET/api/v1/shipments/:id/trackShipments

Live tracking timeline

Response

{
  "status": "in_transit",
  "events": [
    { "status": "picked_up", "timestamp": "...", "location": "Cairo Hub" }
  ]
}

DELETE/api/v1/shipments/:idShipments

Cancel a shipment

Response

{ "cancelled": true }

GET/api/v1/ratesRates

Calculate shipping rates

Response

[
  { "providerId": "xxx", "providerName": "Bosta", "price": 45.00, "currency": "EGP", "estimatedDays": 2 }
]

POST/api/v1/pickupsPickups

Schedule a pickup

Request body

{ "scheduledDate": "2026-04-22", "addressId": "addr_xxx" }

Response

{ "pickupId": "pck_xxx", "scheduledDate": "2026-04-22", "status": "scheduled" }

GET/api/v1/carriersCarriers

List connected carriers

Response

[
  { "id": "xxx", "name": "Bosta", "code": "bosta", "active": true }
]

Error Codes

400Bad Request — missing or invalid parameters401Unauthorized — missing or invalid API key404Not Found — shipment or resource not found409Conflict — duplicate shipment or already cancelled429Too Many Requests — rate limit exceeded500Internal Server Error

Baseet Ship API · support@baseet.cc