[lightMode]

Delete Shipping Company

DELETE/shipping/companies/{company_id}

[updatedIn] 8 days ago

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

`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

integer

required

Company ID

Request samples

[api.label.responses]

Deleted Successfully(200)

Not Found(404)

Deleted Successfully

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.Response status Code

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 (DeleteSuccess)

optional

message

string

required

A message or data structure that is generated or returned when a deletion operation is successful.

code

number

required

A numerical or alphanumeric code that is used in various software and web development contexts to convey information about the outcome of a request or operation.

{
  "status": 200,
  "success": true,
  "data": {
    "message": "تم حذف الشركة بنجاح",
    "code": 200
  }
}

[updatedIn] 8 days ago