Salla Docs

Shipping Company Options

Production

https://api.salla.dev/admin/v2

GET

shipping/companies/{company_id}/options

Shipping Companies

Last modified:2025-02-02 12:23:10

This endpoint is used to show the shipping company's options when issuing an AWB for an order

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.salla.dev/admin/v2shipping/companies/1723506348/options'

Response Example

200 - Success

{
    "status": 200,
    "success": true,
    "data": [
        {
            "name": "boxes",
            "label": "عدد الكراتين",
            "type": "items",
            "format": "dropdown-list",
            "required": true,
            "description": "",
            "options": [
                {
                    "value": 1,
                    "label": 1
                },
                {
                    "value": 2,
                    "label": 2
                },
                {
                    "value": 3,
                    "label": 3
                },
                {
                    "value": 4,
                    "label": 4
                },
                {
                    "value": 5,
                    "label": 5
                },
                {
                    "value": 6,
                    "label": 6
                },
                {
                    "value": 7,
                    "label": 7
                },
                {
                    "value": 8,
                    "label": 8
                },
                {
                    "value": 9,
                    "label": 9
                },
                {
                    "value": 10,
                    "label": 10
                }
            ]
        },
        {
            "name": "without_products",
            "label": "عدم ارسال تفاصيل المنتجات في البوليصة",
            "type": "boolean",
            "format": "checkbox",
            "required": false,
            "description": ""
        }
    ]
}

Request

Authorization

Add the parameter

Authorization

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

Example:

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

Path Params

company_id

integer

required

Unique identification number assigned to a Shipping Company. Get a list of Shpping companies IDs here

Example:

1723506348

Responses

🟢200Success

application/json

Body

status

integer

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

array[object (shippingCompanyOptions) {7}]

optional

name

string

optional

The label used to describe a specific option

label

string

optional

The title used to describe a specific option associated with a company.

type

string

optional

Type of the company option, it can be items or a boolean
Allowed values: items, boolean,number, string,collection, static

format

string

optional

The format of the company option can be a dropdown-list or checkbox.

Allowed values: dropdown-list,radio-list, checkbox, switch, text, number, slider

required

boolean

optional

This is to indicate if the company option is obligatory.

description

string

optional

A detailed information about an option or attribute associated with a company.

options

array [object {2}]

optional

🟠404error_notFound_404

Modified at 2025-02-02 12:23:10

Create Shipping Company

List Shipping Companies