Update Shipment Details - Salla Merchants APIs

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/json

Example

{
    "shipment_number": "846984645",
    "order_id": 76587644,
    "tracking_number": "54563653",
    "tracking_link": "https://api.shipengine.com/v1/labels/498498496/track",
    "status": "delivered",
    "status_note": "The shipment has been delivered",
    "pdf_label": "https://api.shipengine.com/v1/downloads/10/F91fByOB-0aJJadf7JLeww/label-63563751.pdf",
    "cost": 40,
    "external_company_name": "Salla Express",
    "policy_options": {
        "boxes": 3,
        "number_of_delivery_attempts": 2,
        "shipment_content_type": "document"
    }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PUT 'https://api.salla.dev/admin/v2/shipments/362985662' \
--header 'Content-Type: application/json' \
--data-raw '{
    "shipment_number": "846984645",
    "order_id": 76587644,
    "tracking_number": "54563653",
    "tracking_link": "https://api.shipengine.com/v1/labels/498498496/track",
    "status": "delivered",
    "status_note": "The shipment has been delivered",
    "pdf_label": "https://api.shipengine.com/v1/downloads/10/F91fByOB-0aJJadf7JLeww/label-63563751.pdf",
    "cost": 40,
    "external_company_name": "Salla Express",
    "policy_options": {
        "boxes": 3,
        "number_of_delivery_attempts": 2,
        "shipment_content_type": "document"
    }
}'

Responses

🟢200Success

application/json

Body

Example

{
    "status": 200,
    "success": true,
    "data": {
        "id": 362985662,
        "order_id": 560695738,
        "order_reference_id": 48927,
        "reference": {
            "external_id": null,
            "external_additional_id": null
        },
        "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"
        },
        "billing_account": "salla",
        "description": null,
        "remarks": null,
        "service_types": [],
        "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": "username@email.com",
            "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
            }
        }
    }
}

🟠422Error Validation