Update Shipment Details
Production
Production
PUT
https://api.salla.dev/admin/v2/shipments/{shipment_id}
Shipments
Last modified:2025-02-05 08:33:34
Breaking Change Notice
Scopes
shipping.read_write
- Shipping Read & WriteRequest
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************
Path Params
Body Params application/json
tracking_link
string
optional
Example:
https://xyz-shipping.com/v1/labels/498498496/track
shipment_number
string
required
Example:
846984645
tracking_number
string
optional
Example:
54563653
status
enum<string>
required
Allowed values:
createdin_progressdeliveringdeliveredshippedcancelled
Example:
delivered
status_note
string
optional
Example:
Parcel has been picked up by our logistics partner
pdf_label
string
optional
Example:
https://xyz-shipping/v1/downloads/10/F91fByOB-0aJJadf7JLeww/label-63563751.pdf
cost
integer
optional
Example:
40
external_company_name
string
optional
Example
{
"order_id": 76587644,
"tracking_link": "https://api.shipengine.com/v1/labels/498498496/track",
"shipment_number": "846984645",
"tracking_number": "54563653",
"status": "delivered",
"status_note": "Parcel has been picked up by our logistics partner",
"pdf_label": "https://api.shipengine.com/v1/downloads/10/F91fByOB-0aJJadf7JLeww/label-63563751.pdf",
"cost": 40
}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://api.salla.dev/admin/v2/shipments/362985662' \
--header 'Content-Type: application/json' \
--data-raw '{
"order_id": 76587644,
"tracking_link": "https://api.shipengine.com/v1/labels/498498496/track",
"shipment_number": "846984645",
"tracking_number": "54563653",
"status": "delivered",
"status_note": "Parcel has been picked up by our logistics partner",
"pdf_label": "https://api.shipengine.com/v1/downloads/10/F91fByOB-0aJJadf7JLeww/label-63563751.pdf",
"cost": 40
}'
Responses
🟢200Success
application/json
Body
status
number
optional
success
boolean
optional
data
object (Shipment)
optional
id
number
required
Example:
987654321
order_id
number
required
Example:
123456789
order_reference_id
number | null
required
created_at
object
required
type
enum<string>
required
Allowed values:
returnshipment
Example:
shipment
courier_id
integer
required
Example:
1723506348
courier_name
string
required
Example:
Semsa
courier_logo
string
required
Example:
https://semsa.com/assets/logo.png
external_company_name
string
optional
shipping_number
string
required
Example:
192837465
tracking_number
string
required
Example:
918273645
pickup_id
number
required
trackable
boolean
required
Example:
true
tracking_link
string
required
Example:
https://semsa.com/tracking/order_url.com
label
object
required
payment_method
enum<string>
required
Allowed values:
codpre_paid
Example:
cod
source
string
required
Example:
dashboard
status
enum<string>
required
Allowed values:
creatingcreatedpendingdeliveredreturnedin_progresscancelleddelivering
Example:
in_progress
total
object
required
cash_on_delivery
object
required
is_international
boolean
required
Example:
true
total_weight
object
required
packages
array [object {8}]
required
ship_from
object
required
ship_to
object
required
meta
object
required
billing_account
enum<string>
required
Allowed values:
sallamerchant
Example
{
"status": 200,
"success": true,
"data": {
"id": 362985662,
"order_id": 560695738,
"order_reference_id": 48927,
"created_at": {
"date": "2023-01-12 14:19:08.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
},
"type": "shipment",
"courier": {
"id": 814202285,
"name": "DHL",
"logo": "https://company.com/logo.png"
},
"shipping_number": "0",
"tracking_number": "0",
"pickup_id": null,
"trackable": true,
"tracking_link": "https://www.company/tracking/tracking-express.html?submit=1&tracking-id=12345",
"label": [],
"payment_method": "cod",
"source": "api",
"status": {
"id": 566146469,
"name": "بإنتظار المراجعة",
"slug": "under_review"
},
"total": {
"amount": 7000,
"currency": "SAR"
},
"cash_on_delivery": {
"amount": 15,
"currency": "SAR"
},
"packages": [
{
"name": "Apple Watch",
"sku": "6ytrrhrhr",
"price": {
"amount": "1000.00",
"currency": "SAR"
},
"quantity": 2,
"weight": {
"value": "0.10",
"unit": "kg"
}
},
{
"name": "Apple Iphone 14 Pro Max",
"sku": "6ytrrhrhr3332",
"price": {
"amount": "5000.00",
"currency": "SAR"
},
"quantity": 1,
"weight": {
"value": "0.50",
"unit": "kg"
}
}
],
"ship_from": {
"type": "branch",
"branch_id": 1723506348,
"name": "Riyadh",
"email": null,
"phone": "0555555555",
"country": "السعودية",
"city": "الرياض",
"address_line": "7687 طريق الملك فهد الفرعي، الملك فهد، الرياض 12262 3010، السعودية",
"street_number": "7687 طريق الملك فهد الفرعي",
"block": "الملك فهد",
"postal_code": "12262",
"geo_coordinates": {
"lat": "24.7431373",
"lng": "46.6570741"
}
},
"ship_to": {
"type": "address",
"name": "Username",
"email": "[email protected]",
"phone": "050-948-0868",
"country": "السعودية",
"city": "الرياض",
"address_line": "شارع عبدالله سنابل السلام مكة السعوديه",
"street_number": "2345",
"block": "السلام",
"postal_code": "95128",
"geo_coordinates": {
"lat": "21.382590509685",
"lng": "39.773191030685"
}
},
"meta": {
"app_id": null,
"policy_options": {
"boxes": 2
}
},
"billing_account": "salla"
}
}
🟠422Validation Error
Modified at 2025-02-05 08:33:34