Salla Docs
Merchant API
  • Merchant API
  • Salla OAuth 2.0
Partner APIs
  • App API
  • Shipment API
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Change Log
Salla CLI
Merchant API
  • Merchant API
  • Salla OAuth 2.0
Partner APIs
  • App API
  • Shipment API
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Change Log
Salla CLI
Salla - Opensource
Salla - Developers Community
  1. Shipping Companies
  • Publish App
  • Change Log
  • Getting Started
  • Migration to the New API
  • Shipping Management
    • Create App
    • App Cycle
    • Setup App
    • Test App
  • Order Fulfilment
    • Create App
    • App Cycle
    • Setup App
    • Test App
  • Shipments
    • Create Shipment
      POST
    • List Shipments
      GET
    • Update Shipment Details
      PUT
    • Shipment Details
      GET
    • Cancel Shipments
      POST
    • Return Shipments
      POST
    • Shipment Tracking
      GET
  • Shipping Companies
    • List Shipping Companies
      GET
    • Shipping Company Details
      GET
  1. Shipping Companies

List Shipping Companies

Production
https://api.salla.dev/admin/v2
Production
https://api.salla.dev/admin/v2
GET
https://api.salla.dev/admin/v2
/shipping/companies/
Shipping Companies
Last modified:2024-09-26 09:30:21
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.
Scopes
shipping.read- Shipping Read Only

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.salla.dev/admin/v2/shipping/companies/'

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
array[object (Shipping Company) {5}] 
optional
id
number 
optional
A unique identifier associated with a specific shipping company or carrier.
Example:
441225901
name
string 
optional
The formal name or title of a company or carrier responsible for the transportation and delivery of goods, packages, or shipments, and it is used to identify the specific entity handling the shipping services.
Example:
DHL
app_id
string 
optional
A unique identifier associated with a shipping or logistics application.
Example:
112233445
activation_type
enum<string> 
optional
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 
optional
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
Example
{
  "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"
    }
  ]
}
Modified at 2024-09-26 09:30:21
Previous
Shipping Companies
Next
Shipping Company Details