Skip to main content
GET
/
shipday
/
sync
/
{shipdayOrderId}
Sync a ShipDay order's status
curl --request GET \
  --url https://api.salesive.com/api/v1/shipday/sync/{shipdayOrderId} \
  --header 'Authorization: Bearer <token>'
{
  "status": 200,
  "success": true,
  "message": "Sync a ShipDay order's status",
  "data": {
    "orderId": 987654321,
    "orderNumber": "ORD-1024",
    "orderStatus": {
      "orderState": "ACTIVE",
      "accepted": true
    },
    "trackingLink": "https://app.shipday.com/track/987654321",
    "assignedCarrier": {
      "id": 55,
      "name": "Jane Driver"
    }
  }
}
Fetches the latest order detail for the given ShipDay order id from the store’s connected ShipDay account. The response is passed through from ShipDay’s external API. Requires the READ_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.

Path Parameters

​
shipdayOrderId
string
required

The ShipDay order id (as returned when the order was dispatched).

Response

Sync a ShipDay order's status.

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

Order detail passed through verbatim from ShipDay's external API.