Skip to main content
PUT
/
shipday
/
status
/
{shipdayOrderId}
Update a ShipDay order's status
curl --request PUT \
  --url https://api.salesive.com/api/v1/shipday/status/{shipdayOrderId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "PICKED_UP"
}
'
{
  "status": 200,
  "success": true,
  "message": "Update a ShipDay order's status",
  "data": {
    "success": true,
    "response": "Order status updated successfully"
  }
}
Updates the delivery status of the given ShipDay order in the store’s connected ShipDay account. The response is passed through from ShipDay’s external API. 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.

Path Parameters

​
shipdayOrderId
string
required

The ShipDay order id.

Body

application/json
​
status
string
required

New delivery status. One of STARTED, PICKED_UP, READY_TO_DELIVER, ALREADY_DELIVERED, INCOMPLETE, FAILED_DELIVERY.

Response

Update 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

Result of a ShipDay action, passed through from ShipDay's external API.