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"
}
'import requests
url = "https://api.salesive.com/api/v1/shipday/dispatch"
payload = { "orderId": "6640c1b2d4e5f60102030406" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({orderId: '6640c1b2d4e5f60102030406'})
};
fetch('https://api.salesive.com/api/v1/shipday/dispatch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.salesive.com/api/v1/shipday/dispatch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'orderId' => '6640c1b2d4e5f60102030406'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.salesive.com/api/v1/shipday/dispatch"
payload := strings.NewReader("{\n \"orderId\": \"6640c1b2d4e5f60102030406\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.salesive.com/api/v1/shipday/dispatch")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"orderId\": \"6640c1b2d4e5f60102030406\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.salesive.com/api/v1/shipday/dispatch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"orderId\": \"6640c1b2d4e5f60102030406\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}
}{
"status": 401,
"success": false,
"message": "Authentication required",
"data": null
}{
"status": 403,
"success": false,
"message": "Insufficient scope",
"data": null
}Shipday
Dispatch an order to ShipDay
Dispatch an order to ShipDay. Requires the WRITE_SHIPDAY scope.
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"
}
'import requests
url = "https://api.salesive.com/api/v1/shipday/dispatch"
payload = { "orderId": "6640c1b2d4e5f60102030406" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({orderId: '6640c1b2d4e5f60102030406'})
};
fetch('https://api.salesive.com/api/v1/shipday/dispatch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.salesive.com/api/v1/shipday/dispatch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'orderId' => '6640c1b2d4e5f60102030406'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.salesive.com/api/v1/shipday/dispatch"
payload := strings.NewReader("{\n \"orderId\": \"6640c1b2d4e5f60102030406\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.salesive.com/api/v1/shipday/dispatch")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"orderId\": \"6640c1b2d4e5f60102030406\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.salesive.com/api/v1/shipday/dispatch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"orderId\": \"6640c1b2d4e5f60102030406\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}
}{
"status": 401,
"success": false,
"message": "Authentication required",
"data": null
}{
"status": 403,
"success": false,
"message": "Insufficient scope",
"data": null
}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
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
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.
HTTP status code, echoed in the body.
Whether the request succeeded.
Human-readable result message.
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.
Show child attributes
Show child attributes
Was this page helpful?

