Return Shipment

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

Scopes

shipping.read_write- Shipping Read & Write

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

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>

required

Shipment status.

Allowed values:

creatingcreatedpendingdeliveredreturnedin_progresscancelleddelivering

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-16 23:37:59.000000",
            "timezone_type": 3,
            "timezone": "Asia/Riyadh"
        },
        "type": "return",
        "courier_id": 814202285,
        "courier_name": "DHL",
        "courier_logo": "https://company.com/logo.png",
        "external_company_name": "external name",
        "shipping_number": "23424234354434",
        "tracking_number": "23424234354434",
        "pickup_id": 987996,
        "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": 9876,
                "name": "منتج تجريبي",
                "sku": "6ytrrhrhr",
                "price": {
                    "amount": "50.00",
                    "currency": "SAR"
                },
                "quantity": 2,
                "weight": {
                    "value": "1.00",
                    "unit": "kg"
                },
                "options": []
            }
        ],
        "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": null,
            "policy_options": {
                "boxes": 2
            }
        },
        "billing_account": "salla"
    }
}

🟠422Error Validation

Request

Request samples

Responses