Skip to main content
POST
/
shipping
/
labels
Create a shipping label for an order
curl --request POST \
  --url https://api.salesive.com/api/v1/shipping/labels \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "orderId": "6640c1b2d4e5f60102030406"
}
'
{
  "status": 201,
  "success": true,
  "message": "Create a shipping label for an order",
  "data": {
    "_id": "6651b2c3d4e5f60102030405",
    "orders": [
      "6640c1b2d4e5f60102030406"
    ],
    "carrier": "DHL Express",
    "courier": {
      "id": "dhl",
      "name": "DHL Express",
      "phone": "+2348000000000",
      "email": "courier@example.com"
    },
    "trackingNumber": "SB12345678",
    "trackingCode": "SB12345678",
    "trackingUrl": "https://track.example.com/SB12345678",
    "status": "confirmed",
    "metadata": {
      "label_details": {
        "order_id": "SB12345678",
        "status": "confirmed",
        "tracking_url": "https://track.example.com/SB12345678"
      }
    },
    "createdAt": "2026-06-28T09:00:00.000Z",
    "updatedAt": "2026-06-28T09:05:00.000Z"
  }
}
Generates a courier shipping label for an order’s automatic shipment via the carrier aggregator, then updates the shipment with the returned tracking number, tracking URL, courier contact details and status. Only valid for shipments whose shipping option is of type auto; cached rates must still be valid. Requires the WRITE_SHIPPING scope.

Authorizations

Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.

Body

application/json
orderId
string
required

ObjectId of the order whose automatic shipment should get a label.

Response

Create a shipping label for an order.

Standard Salesive response envelope. The operation-specific payload is carried in data.

status
integer
required

HTTP status code, echoed in the body.

success
boolean
required

Whether the request succeeded.

message
string
required

Human-readable result message.

data
object

A shipment record. Shapes vary slightly by how the shipment was created (manual, automatic label, or ShipDay dispatch); only the most common fields are listed and extra properties may be present.