[lightMode]

Update Shipping Company

PUT/shipping/companies/{company_id}

[updatedIn] 2 months ago

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

`shipping.read_write`- Shipping Read & Write

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.pathParameter]

company_id

string

required

name

string

required

Shipping Company Name

Example:

Shipping Company

{
  "name": "Shipping Company"
}

Request samples

[api.label.responses]

Success(200)

Not Found(404)

Error Validation(422)

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

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

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

[updatedIn] 2 months ago