Update Shipping Company

Production

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

PUT

/shipping/companies/{company_id}

Shipping Companies

Last modified:2025-04-24 13:54:27

This endpoint allows you to update a custom shipping company associated with the store by passing the company_id as a path parameter.

NOTE

You cannot update a Shipping Company with activation_type set to api.

Scopes

shipping.read_write- Shipping Read & Write

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.salla.dev/admin/v2/shipping/companies/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Shipping Company"
}'

Response Example

200 - Example

{
    "status": 200,
    "success": true,
    "data": {
        "id": 976721503,
        "name": "شحن شركة",
        "app_id": 7654567,
        "activation_type": "api",
        "slug": ""
    }
}

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

string

required

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

Body Params application/json

name

string

required

Shipping Company Name

Example:

Shipping Company

Examples

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

object (ShippingCompany)

optional

Detailed structure of the Shipping company model object showing its fields and data types.

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 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

🟠404Not Found

🟠422Error Validation

🟠401Unauthorized

Modified at 2025-04-24 13:54:27

Shipping Company Details

Delete Shipping Company