Light Mode

List Shipping Companies

Production

GEThttps://api.salla.dev/admin/v2/shipping/companies/

Last modified: 2 months ago

This endpoint allows you to list all active shipping companies associated with the store.

:::note
If the "activation_type" is set to:

manual : which means that the shipping company is from the merchant side (not available to be linked from salla dashboard)
api : which means it has been linked through salla.
:::
`shipping.read`- Shipping Read Only

Request

Authorization: OAuth 2.0

Add the parameter

Authorization

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

Example

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Request samples

Responses

Success(200)

HTTP Code: 200

Content Type : JSONapplication/json

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

array[object (ShippingCompany) {5}]

optional

number

required

A unique identifier associated with a specific shipping company or carrier. Shipping companies list can be found here

Example:

441225901

name

string

required

The formal name or title of a carrier responsible for the transportation and delivery of goods.

Example:

DHL

app_id

string

required

A unique identifier associated with a shipping or logistics application.

Example:

112233445

activation_type

enum<string>

required

the method or process by which a shipping company or carrier activates its services, such as whether it's manual or API.

Allowed values:

manualapi

slug

string | null

required

A short form would be the unique and URL-friendly identifier for a shipping company's name. If the activation_type is set to manual, a null is returned; otherwise, you will receive a value.

Example:

dhl

pagination

object (Pagination)

optional

For a better response behavior as well as maintain the best security level, All retrieving API endpoints use a mechanism to retrieve data in chunks called pagination. Pagination working by return only a specific number of records in each response, and through passing the page number you can navigate the different pages.

count

number

required

Number of returned results.

total

number

required

Number of all results.

perPage

number

required

Number of results per page.

<= 65

currentPage

number

required

Number of current page.

totalPages

number

required

Number of total pages.

links

object

required

Array of linkes to next and previous pages.

{
  "status": 200,
  "success": true,
  "data": [
    {
      "id": 1723506348,
      "name": "سمسا",
      "app_id": "1683195908",
      "activation_type": "manual",
      "slug": null
    },
    {
      "id": 989286562,
      "name": "ارامكس",
      "app_id": "1311345502",
      "activation_type": "manual",
      "slug": null
    },
    {
      "id": 2079537577,
      "name": "البريد السعودي | سُبل",
      "app_id": "88903443",
      "activation_type": "manual",
      "slug": null
    },
    {
      "id": 814202285,
      "name": "DHL Express",
      "app_id": "827885927",
      "activation_type": "api",
      "slug": "dhl-express"
    },
    {
      "id": 1130931637,
      "name": "Ajeek",
      "app_id": "1499493023",
      "activation_type": "api",
      "slug": "ajeek"
    },
    {
      "id": 665151403,
      "name": "أي مكان",
      "app_id": "944213936",
      "activation_type": "manual",
      "slug": null
    },
    {
      "id": 915304371,
      "name": "UPS",
      "app_id": "1218344689",
      "activation_type": "api",
      "slug": "ups"
    },
    {
      "id": 1764372897,
      "name": "فتشر",
      "app_id": "2099547131",
      "activation_type": "api",
      "slug": "fetcher"
    },
    {
      "id": 1378987453,
      "name": "mlcGO",
      "app_id": "1720219575",
      "activation_type": "manual",
      "slug": null
    },
    {
      "id": 349994915,
      "name": "سلاسة",
      "app_id": "456034465",
      "activation_type": "manual",
      "slug": null
    },
    {
      "id": 1096243131,
      "name": "Storage Station",
      "app_id": "1353087977",
      "activation_type": "api",
      "slug": "storage-station"
    }
  ]
}

Last modified: 2 months ago