Light Mode

Update Shipping Company

PUT/shipping/companies/{company_id}

Last modified: a month 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

Inherited from project

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

string

required

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

name

string

required

Shipping Company Name

Example:

Shipping Company

{
  "name": "Shipping Company"
}

Request samples

Responses

Success(200)

Not Found(404)

Error Validation(422)

Unauthorized(401)

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

#/definitions/1307399

optional

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

Last modified: a month ago