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>'import requests
url = "https://api.salesive.com/api/v1/shipping/shipments/sync"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.salesive.com/api/v1/shipping/shipments/sync', 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/shipping/shipments/sync",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.salesive.com/api/v1/shipping/shipments/sync"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.salesive.com/api/v1/shipping/shipments/sync")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.salesive.com/api/v1/shipping/shipments/sync")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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"
}
}{
"status": 401,
"success": false,
"message": "Authentication required",
"data": null
}{
"status": 403,
"success": false,
"message": "Insufficient scope",
"data": null
}Shipping
Sync a shipment's status from the carrier
Sync a shipment’s status from the carrier. Requires the READ_SHIPPING scope.
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>'import requests
url = "https://api.salesive.com/api/v1/shipping/shipments/sync"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.salesive.com/api/v1/shipping/shipments/sync', 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/shipping/shipments/sync",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.salesive.com/api/v1/shipping/shipments/sync"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.salesive.com/api/v1/shipping/shipments/sync")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.salesive.com/api/v1/shipping/shipments/sync")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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"
}
}{
"status": 401,
"success": false,
"message": "Authentication required",
"data": null
}{
"status": 403,
"success": false,
"message": "Insufficient scope",
"data": null
}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
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
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.
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?

