[lightMode]

List Estimate Rates

GET/shipping/companies/estimate-rate

[updatedIn] 2 months ago

This endpoint allows you to fetch all of the shipping companies' estimate rates, based on the customer's order address

Request

Authorization: OAuth 2.0

Add the parameter

Authorization

to [header]，whose value is to concatenate the Token after the Bearer.

[api.label.example]

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

[message.queryParameter]

city_id

integer

required

City ID. Get a list of City IDs from here

country_id

integer

required

Country ID. Get a list of Country IDs from here

order_id

integer

optional

Order ID. Get a list of Order IDs from here

geocode

string

optional

Geographic Location Code

postal_code

string

optional

Address Postal Code value

Request samples

[api.label.responses]

Success(200)

Error Validation(422)

HTTP Code: 200

Content Type : JSONapplication/json

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 (EstimateRates) {7}]

optional

integer

required

Estimated Rate ID

company_id

integer | null

required

Shipping company unique identifier. List of sipping companies can be found here

title

string

required

Shipping company title

logo

string

required

Shipping company logo

working_days

string

required

Shipping company working hours

total

object

required

services

array [object {2}]

required

{
  "status": 200,
  "success": true,
  "data": [
    {
      "id": 534427805,
      "company_id": 1892382264,
      "title": "ريدبوكس",
      "logo": "https://cdn.salla.sa/qGNRv/EHSZest9WHlDTmTJjJnEWqgUu75NLQ5gNJin0FhA.png",
      "working_days": "[استلم طلبك من خزائن ريد بوكس الذكية RedBox، بالوقت المناسب لك، الإيداع سيكون من 1-3 أيام]",
      "total": {
        "amount": 14,
        "currency": "SAR"
      },
      "services": [
        {
          "name": "cod",
          "amount": {
            "amount": 0,
            "currency": "SAR"
          }
        }
      ]
    },
    {
      "id": 1680687267,
      "company_id": 941683204,
      "title": "ارامكس - هيمو",
      "logo": "https://cdn.salla.sa/qGNRv/EHSZest9WHlDTmTJjJnEWqgUu75NLQ5gNJin0FhA.png",
      "working_days": "من 1 - 2  يوم عمل",
      "total": {
        "amount": 24,
        "currency": "SAR"
      },
      "services": [
        {
          "name": "cod",
          "amount": {
            "amount": 8,
            "currency": "SAR"
          }
        }
      ]
    },
    {
      "id": 1055252317,
      "company_id": 1926022186,
      "title": "dhl - هيمو",
      "logo": "https://cdn.salla.sa/qGNRv/EHSZest9WHlDTmTJjJnEWqgUu75NLQ5gNJin0FhA.png",
      "working_days": "7 -20 يوم عمل",
      "total": {
        "amount": 28,
        "currency": "SAR"
      },
      "services": [
        {
          "name": "cod",
          "amount": {
            "amount": 0,
            "currency": "SAR"
          }
        }
      ]
    },
    {
      "id": 1130138841,
      "company_id": 478065722,
      "title": "سمسا",
      "logo": "https://cdn.salla.sa/qGNRv/xPQymWwCmTITkScYSnApzJO7eQLm5PrsRCltN6uo.png",
      "working_days": "١ - ٣ أيام عمل",
      "total": {
        "amount": 28,
        "currency": "SAR"
      },
      "services": [
        {
          "name": "cod",
          "amount": {
            "amount": 0,
            "currency": "SAR"
          }
        }
      ]
    },
    {
      "id": 1172876926,
      "company_id": null,
      "title": "HeMo Hassan",
      "logo": "https://cdn.salla.sa/qGNRv/EHSZest9WHlDTmTJjJnEWqgUu75NLQ5gNJin0FhA.png",
      "working_days": "خلال يومين من إتمام عملية الدفع",
      "total": {
        "amount": 50,
        "currency": "SAR"
      },
      "services": [
        {
          "name": "cod",
          "amount": {
            "amount": 0,
            "currency": "SAR"
          }
        }
      ]
    }
  ]
}

[updatedIn] 2 months ago