Salla Docs
Merchant API
  • Merchant API
  • Salla OAuth 2.0
Partner APIs
  • App API
  • Shipment API
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Change Log
Salla CLI
Merchant API
  • Merchant API
  • Salla OAuth 2.0
Partner APIs
  • App API
  • Shipment API
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Change Log
Salla CLI
Salla - Opensource
Salla - Developers Community
  1. Shipments
  • Welcome 👋
  • Get Started
  • Create Your First App
  • Authorization
  • Webhooks
  • Conditional Webhooks
  • Security Considerations
  • Multi-Language Support
  • Responses
  • Pagination
  • Rate Limiting
  • Versioning
  • Change Log
  • Support
  • APIs
    • Orders
      • Create Order
      • List Orders
      • Order Details
      • Create Drafted Order
      • Update Order
      • Duplicate Order
      • Order Actions
    • Order Status
      • Update Order Status
      • Create Custom Order Status
      • List Order Statuses
      • Order Status Details
      • Update Custom Order Status
      • Update Bulk Orders Statuses
      • Sort Orders Statuses
    • Order Histories
      • List Order Histories
      • Create Order History
    • Order Tags
      • Create Order Tag
      • List Order Tags
      • Delete Order Tag
    • Order Invoice
      • Create Invoice
      • List Invoices
      • Invoice Details
      • Send Order Invoice
      • Create Order Invoice
    • Order Reservations
      • List Order Reservations
    • Order Items
      • List Order Items
      • Create Order Item
      • Update Order Item
      • Delete Order Item
    • Products
      • Create Product
      • List Products
      • Product Details
      • Update Product
      • Delete Product
      • Change Product Status
      • Product Details By SKU
      • Update Product By SKU
      • Delete Product By SKU
      • Update Product Price By SKU
      • Update Bulk Product Prices
      • Import Products
      • Bulk Product Actions
    • Product Options
      • Create Product Option
      • Product Option Details
      • Update Product Option
      • Delete Product Option
    • Product Quantity
      • List Product Quantities
      • Update Bulk Quantities
      • List Quantity Change Reasons
      • List Quantity Audit
      • Update Bulk Quantities by SKU
      • Update Quantity
      • Update Quantity By SKU
    • Product Variants
      • List Product Variants
      • Product Variant Details
      • Update Product Variant
      • Update Product Variant Quantity
    • Product Tags
      • Create Product Tag
      • List Product Tags
    • Product Images
      • Attach Image by SKU
      • Attach Video by SKU
      • Attach Youtube Video
      • Attach Image
      • Update Image
      • Delete Image
    • Product Option Values
      • Create Product Option Value
      • Product Option Value Details
      • Update Product Option Value
      • Delete Product Option Value
    • Abandoned Carts
      • List Abandoned Carts
      • Abandoned Cart Details
    • Customer Groups
      • Create Customer Group
      • List Customer Groups
      • Add Customers To Group Customer
      • Update Default Customer Group
      • Update Customer Group
      • Delete Customer Group
    • Customers
      • Create Customer
      • List Customers
      • Customer Details
      • Update Customer
      • Delete Customer
      • Ban Customer
      • Un-Ban customer
      • Import Customers
    • Digitals Product
      • Attach Digital Code
      • Attach Digital File
      • Delete Digital File
    • Categories
      • Create Category
      • List Categories
      • Category Details
      • Update Category
      • Delete Category
      • Category Children
      • Categories Search
      • List Category Products
    • Exports
      • Export Orders
      • Exports Logs
      • List Export Templates
      • Create Export Template
      • Update Export Template
      • Delete Export Template
      • List Export Columns
      • Export Customers
      • Export Custom URLs
      • Export Products
    • Shipments
      • Create Shipment
        POST
      • List Shipments
        GET
      • Shipment Details
        GET
      • Shipment Tracking
        GET
      • Update Shipment Details
        PUT
      • Cancel Shipment
        POST
      • Return Shipment
        POST
    • Shipping Companies
      • List Shipping Companies
      • Shipping Company Details
      • List Estimate Rates
      • Create Shipping Company
      • Update Shipping Company
      • Delete Shipping Company
      • Shipping Company Options
    • Shipping Zones
      • Create Shipping Zone
      • List Shipping Zones
      • Shipping Zone Details
      • Update Shipping Zone
      • Delete Shipping Zone
    • Shipping Rules
      • List Shipping Rules
      • Shipping Rule Details
      • Delete Shipping Rule
    • Countries
      • List Countries
      • Country Details
    • Product Option Templates
      • List Option Templates
      • Option Template Details
      • Delete Option Template
      • Update Option Template
      • Create Option Template
    • Taxes
      • Create Tax
      • List Taxes
      • Tax Details
      • Update Tax
      • Delete Tax
    • Coupons
      • Create Coupon
      • List Coupons
      • Coupon Details
      • Update Coupon
      • Delete Coupon
      • List Coupon Codes
    • Affiliates
      • List Affiliates
      • Affiliate Details
      • Create Affiliate
      • Update Affiliate
      • Delete Affiliate
    • Order Assignment
      • List Auto Assignment Rules
      • Order Assigned Employees Details
      • Update Auto Assignment Rule
      • Create Auto Assignment Rules
    • Special Offers
      • Create Special Offer
      • List Special Offers
      • Special Offer Details
      • Update Special Offer
      • Delete Special Offer
      • Change Special Offer Status
    • Transactions
      • List Transactions
      • Transaction Details
      • Update Transaction
    • Payments
      • Available Payment Methods
      • List Banks
      • Payment Bank Details
    • Settlements
      • List Instant Settlements
      • Create Instant Settlement
      • Update Instant Settlement
      • Instant Settlement Details
    • Settings
      • Settings List
      • Update Setting Slug
      • Setting Details
    • Merchant
      • User Information Details
      • Store Information
    • Brands
      • Create Brand
      • List Brands
      • Brand Details
      • Update Brand
      • Delete Brand
    • Branches
      • Create Branch
      • List Branches
      • Branch Details
      • Update Branch
      • Delete Branch
    • Currencies
      • Activate Currencies
      • List Currencies
      • List Available Currencies
    • SEO
      • List SEO Settings
      • Update SEO Settings
    • Cities
      • List Cities
    • DNS Records
      • List DNS Records
      • Create DNS Record
      • Delete DNS Record
    • Languages
      • Add Language
      • List Languages
      • Update Language
    • Employees
      • List Employees
    • Advertisements
      • Create Advertisement
      • List Advertisements
      • Advertisement Details
      • Update Advertisement
      • Delete Advertisement
    • Webhooks
      • List Active Webhooks
      • List Events
      • Register Webhook
      • Deactivate Webhook
      • Update Webhook
    • Custom URLs
      • Import Custom URLs
    • Loyalty Points
      • Customer Loyalty Points
      • Update Customer Loyalty Points
    • Reviews
      • List Reviews
      • Review Details
      • Update Review
  • Webhooks - Store Events
    • Order
    • Product
    • Customer
    • Shippings
    • Shipments
    • Brand
    • Invoice
    • Category
    • Store
    • Special Offer
    • Cart
    • Miscellaneous
  1. Shipments

Update Shipment Details

Production
https://api.salla.dev/admin/v2
Production
https://api.salla.dev/admin/v2
PUT
https://api.salla.dev/admin/v2
/shipments/{shipment_id}
Shipments
Last modified:2025-04-27 12:22:08
This endpoint allows you to update specific shipment details by passing the shipment_id as a path parameter.
Breaking Change Notice
Effective January 20th, 2025, the status variable will be a required field in the request payload.
Scopes
shipping.read_write- Shipping Read & Write

Request

Authorization
Add the parameter
Authorization
to Headers
,whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
Path Params
shipment_id
number 
required
Shipment ID. Get a list of Shipment IDs from here
Example:
362985662
Body Params application/json
tracking_link
string 
optional
A URL that provides a link to the tracking information for the shipment.
Example:
https://xyz-shipping.com/v1/labels/498498496/track
shipment_number
string 
required
A unique identifier for the shipment that distinguishes it from other shipments.
Example:
846984645
tracking_number
string 
optional
A unique identifier for the tracking information associated with the shipment.
Example:
54563653
status
enum<string> 
required
The current status of the shipment.
Effective January 20th, 2025, the status variable will be a required field in the request payload.
Allowed values:
createdin_progressdeliveringdeliveredshippedcancelled
Example:
delivered
status_note
string 
optional
The note field provides additional shipment information relevant factors, as it is used to clarify the shipment status and provide context.
Example:
Parcel has been picked up by our logistics partner
pdf_label
string 
optional
A PDF label that contains information about the shipment, such as the sender's and recipient's address, tracking number, and other relevant details.
Example:
https://xyz-shipping/v1/downloads/10/F91fByOB-0aJJadf7JLeww/label-63563751.pdf
cost
integer 
optional
The actual cost of the shipment that the Merchant will be charged for, which is calculated per the shipping company's actual costs. Ensure to include VAT in the cost.
Example:
40
external_company_name
string 
optional
The name of the shipping company for shipments created via the API
Example
{
  "order_id": 76587644,
  "tracking_link": "https://api.shipengine.com/v1/labels/498498496/track",
  "shipment_number": "846984645",
  "tracking_number": "54563653",
  "status": "delivered",
  "pdf_label": "https://api.shipengine.com/v1/downloads/10/F91fByOB-0aJJadf7JLeww/label-63563751.pdf",
  "cost": 40,
  "external_company_name": "Salla Express"
}

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",
    "pdf_label": "https://api.shipengine.com/v1/downloads/10/F91fByOB-0aJJadf7JLeww/label-63563751.pdf",
    "cost": 40,
    "external_company_name":"Salla Express"
}'

Responses

🟢200Success
application/json
Body
status
number 
optional
Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.
success
boolean 
optional
Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.
data
object 
optional
id
number 
required
A unique identifier for the shipment. Shipment list can be found here.
Example:
987654321
order_id
number 
required
A unique identifier for the order associated with the shipment. List of orders can be found here
Example:
123456789
order_reference_id
number  | null 
required
This field refers to a reference ID that can be used to look up additional information about the order
created_at
object 
required
Date and time of shipment creations.
type
enum<string> 
required
Shipment type.
Allowed values:
returnshipment
Example:
shipment
courier_id
integer 
required
Shipment courier identification. Find a complete list of Shipment companies here
Example:
1723506348
courier_name
string 
required
Shipment courier name.
Example:
Semsa
courier_logo
string 
required
Shipment courier logo.
Example:
https://semsa.com/assets/logo.png
external_company_name
string 
optional
The name of the shipping company for shipments created via the API.
shipping_number
string 
required
Shipment shipping number.
Example:
192837465
tracking_number
string 
required
Shipment tracking number
Example:
918273645
pickup_id
number 
required
Shipment pickup unique identifier.
trackable
boolean 
required
Whether or not the shipment is trackable.
Example:
true
tracking_link
string 
required
Shipment tracking link
Example:
https://semsa.com/tracking/order_url.com
label
object 
required
Shipment label details.
payment_method
enum<string> 
required
Shipment payment method
Allowed values:
codpre_paid
Example:
cod
source
string 
required
Shipment source.
Example:
dashboard
status
enum<string> 
optional
Shipment Status
Allowed values:
createdin_progressdeliveringdeliveredshippedcancelled
Example:
in_progress
total
object 
required
Shipment total.
cash_on_delivery
object 
required
Shipment cash on delivery details.
is_international
boolean 
required
Whether or not the shipment is shipped internationally
Example:
true
total_weight
object 
required
Shipment total weight.
packages
array [object {8}] 
required
Shipment packages details.
ship_from
object 
required
Shipment source details.
ship_to
object 
required
Shipment destination details.
meta
object 
required
"Metadata" is data that describes other data, providing details on its creation, format, and context.
billing_account
enum<string> 
required
The type of the company billing account
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"
    },
    "external_company_name": "Salla Express",
    "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": [
      {
        "item_id": 2077288690,
        "external_id": null,
        "name": "Apple Watch",
        "sku": "6ytrrhrhr",
        "price": {
          "amount": "1000.00",
          "currency": "SAR"
        },
        "quantity": 2,
        "weight": {
          "value": "0.10",
          "unit": "kg"
        }
      },
      {
        "item_id": 2077288690,
        "external_id": null,
        "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"
  }
}
🟠422Error Validation
Modified at 2025-04-27 12:22:08
Previous
Shipment Tracking
Next
Cancel Shipment