Shipment Details

This endpoint allows you to return the complete details for a specific shipment by passing the shipment_id as a path parameter.

Scopes

shipping.read- Shipping Read Only

{ "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, "courier_name": "DHL", "courier_logo": "https://company.com/logo.png", "external_company_name": "Salla Express", "shipping_number": "0", "tracking_number": "0", "pickup_id": 12312, "trackable": true, "tracking_link": "https://www.company/tracking/tracking-express.html?submit=1&tracking-id=12345", "label": [], "payment_method": "cod", "source": "api", "status": "creating", "total": { "amount": 100, "currency": "SAR" }, "cash_on_delivery": { "amount": "10.70", "currency": "SAR" }, "packages": [ { "item_id": 2077288690, "external_id": 123542321, "name": "منتج تجريبي", "sku": "6ytrrhrhr", "price": { "amount": "50.00", "currency": "SAR" }, "quantity": 2, "weight": { "value": "1.00", "unit": "kg" }, "options": [ { "name": "Date of receipt", "values": { "name": "Date of receipt", "price": { "amount": 0, "currency": "SAR" }, "value": "2024-12-24" } } ] } ], "ship_from": { "type": "branch", "name": "Riyadh", "email": "", "phone": "0555555555", "country": "السعودية", "city": "RIYADH", "address_line": "7687 طريق الملك فهد الفرعي,الملك فهد,12262, 7687 طريق الملك فهد الفرعي، الملك فهد، الرياض 12262 3010، السعودية, RIYADH,السعودية", "street_number": "7687 طريق الملك فهد الفرعي", "block": "الملك فهد", "postal_code": "12262", "latitude": 24.7431373, "longitude": 46.6570741, "branch_id": 1723506348 }, "ship_to": { "type": "address", "name": "Username", "email": "[email protected]", "phone": "055-555-555", "country": "السعودية", "city": "الرياض", "address_line": " شارع 2345، الحي السلام 95128،, شارع عبدالله سنابل السلام مكة السعوديه,, الرياض, السعودية", "street_number": "2345", "block": "السلام", "postal_code": "95128", "latitude": 21.382590509685, "longitude": 39.773191030685 }, "meta": { "app_id": 1232132, "policy_options": { "types": "", "boxes": "1" } }, "billing_account": "salla" } }

Add the parameter

Authorization

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

Example:

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

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 (Shipment)

optional

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

reference

object

required

created_at

object

required

Date and time of shipment creations.

type

enum<string>

required

Specifies the nature of the shipment, indicating whether it is an outgoing delivery to a customer ("shipment") or a return shipment sent back to the merchant ("return").

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

The full name of the courier or shipping company responsible for transporting and delivering the shipment to its destination.

Example:

Semsa

courier_logo

string

required

A URL pointing to the official logo image of the courier or shipping company, which can be used for display in user interfaces or documentation.

Example:

https://semsa.com/assets/logo.png

external_company_name

string

optional

The name of the external shipping company used for shipments created via the API, if different from the standard courier list.

shipping_number

string

required

The unique shipping number assigned to the shipment by the courier, used for internal tracking and reference within the courier's system.

Example:

192837465

tracking_number

string

required

The unique tracking number provided by the courier, allowing customers and merchants to track the shipment's delivery status online.

Example:

918273645

pickup_id

number

required

A unique identifier for the shipment's pickup event, used to reference and manage the pickup process with the courier or logistics provider.

trackable

boolean

required

Indicates whether the shipment can be tracked online using a tracking number or link provided by the courier.

Example:

true

tracking_link

string

required

A direct URL to the courier's online tracking page for this shipment, allowing real-time status updates and location information.

Example:

https://semsa.com/tracking/order_url.com

label

object

required

Detailed information about the shipment label, including its file format and a link to access the label.

payment_method

enum<string>

required

Specifies the payment method used for the shipment, such as cash on delivery (cod) or pre-paid, determining how the shipping cost is settled.

Allowed values:

codpre_paid

Example:

cod

source

string

required

Indicates the origin of the shipment request, such as the dashboard, API, or other system sources.

Example:

dashboard

status

enum<string>

required

Current status of the shipment in the delivery process, such as created, in_progress, delivered, cancelled, etc.

Allowed values:

createdin_progressin_transitreceived_at_final_hubto_be_reattemptedreattemptedunable_to_deliverdeliveringdeliveredpartially_deliveredshippedcancelledlostdamagedreturn_to_originreturn_in_progress

Example:

in_progress

total

object

required

Details about the total value and currency of the shipment.

cash_on_delivery

object

required

Details about the cash on delivery amount and its currency.

is_international

boolean

required

Indicates whether the shipment is being sent to a destination outside the origin country (international shipping).

Example:

true

total_weight

object

required

Information about the total weight of the shipment and its measurement units.

billing_account

enum<string>

required

Indicates which billing account is used for the shipment charges, such as the merchant's own account or a platform account (e.g., Salla).

Allowed values:

sallamerchant

description

string

optional

A brief summary or explanation of the contents or purpose of the shipment.

remarks

string

optional

Any additional notes, comments, or special delivery instructions related to the shipment.

service_types

array[string]

required

A list of service types requested for the shipment, Example: domestic,international,normal, fulfillment,heavy,express,cash_on_delivery,cold

packages

array [object {8}]

required

A list of packages included in the shipment, each containing detailed information about the items, quantities, weights, and options.

ship_from

object

required

Detailed information about the sender or origin location of the shipment, including contact details and address.

ship_to

object

required

Detailed information about the recipient or destination location of the shipment, including contact details and address.

Request

Responses