Skip to main content
GET
/
shipping
/
shipments
/
sync
Sync a shipment's status from the carrier
curl --request GET \
  --url https://api.salesive.com/api/v1/shipping/shipments/sync \
  --header 'Authorization: Bearer <token>'
{
  "status": 200,
  "success": true,
  "message": "Sync a shipment's status from the carrier",
  "data": {
    "_id": "6651b2c3d4e5f60102030405",
    "orders": [
      "6640c1b2d4e5f60102030406"
    ],
    "carrier": "DHL Express",
    "trackingNumber": "SB12345678",
    "trackingUrl": "https://track.example.com/SB12345678",
    "status": "in_transit",
    "metadata": {
      "label_details": {
        "order_id": "SB12345678",
        "status": "in_transit",
        "tracking_url": "https://track.example.com/SB12345678"
      }
    },
    "createdAt": "2026-06-28T09:00:00.000Z",
    "updatedAt": "2026-06-28T11:00:00.000Z"
  }
}
Re-fetches the latest label status from the carrier aggregator for an order’s shipment and maps it onto the local shipment status and tracking details. The shipment must already have a generated label. The order must belong to the store bound to the app token. Requires the READ_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.

Query Parameters

​
orderId
string
required

ObjectId of the order whose shipment should be synced.

Response

Sync a shipment's status from the carrier.

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.