Light Mode

Shipping Company Details

GET/shipping/companies/{company_id}

Last modified: 3 months ago

This endpoint allows you to fetch details of shipping companies for your store.

`shipping.read`- Shipping Read Only

Request

Authorization: Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example

Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379

Path Params

company_id

number

required

Shipping Company ID

Request samples

Responses

Success(200)

Not Found(404)

HTTP Code: 200

Content Type : JSONapplication/json

status

number

optional

Response Status Code

Example:

200

success

boolean

optional

Whether or not the response is successful

Default:

true

data

object

optional

number

optional

Shipping Company ID

Example:

346226214

name

string

optional

Shipping Company Name

Example:

Shipping Company

app_id

string | null

optional

Shipping Application ID

Example:

505994491

activation_type

enum<string> | enum<null>

optional

Shipping Company Activation Type

Allowed values:

apimanualnull

Example:

api

slug

string | null

optional

Shipping Company Slug

Example:

shipping-company

{
  "status": 200,
  "success": true,
  "data": {
    "id": 976721503,
    "name": "Shipping Company",
    "app_id": "505994491",
    "activation_type": "api",
    "slug": "shipping-company"
  }
}

Last modified: 3 months ago