Skip to main content
POST
/
shipday
/
dispatch
Dispatch an order to ShipDay
curl --request POST \
  --url https://api.salesive.com/api/v1/shipday/dispatch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "orderId": "6640c1b2d4e5f60102030406"
}
'
{
  "status": 201,
  "success": true,
  "message": "Dispatch an order to ShipDay",
  "data": {
    "_id": "6651b2c3d4e5f60102030405",
    "orders": [
      "6640c1b2d4e5f60102030406"
    ],
    "carrier": "ShipDay",
    "courier": {
      "name": "Jane Driver"
    },
    "trackingNumber": "987654321",
    "trackingCode": "987654321",
    "trackingUrl": "https://app.shipday.com/track/987654321",
    "status": "pending",
    "metadata": {
      "orderId": 987654321,
      "trackingLink": "https://app.shipday.com/track/987654321"
    },
    "createdAt": "2026-06-28T09:00:00.000Z",
    "updatedAt": "2026-06-28T09:00:00.000Z"
  }
}
Sends an order to the store’s connected ShipDay account as a delivery, then creates a local shipment recording the ShipDay order id, tracking link and assigned agent. The order must belong to the store bound to the app token. Requires the WRITE_SHIPDAY 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 to dispatch to ShipDay.

Response

Dispatch an order to ShipDay.

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.