Delete Shipping Address
This DELETE API allows you to remove an existing shipping address associated with a specific company.
Endpoint Details
- URL:
/shippingAddress/{company_id} - Method:
DELETE - Authentication: Bearer Token (required)
Path Parameters
| Parameter | Type | Description |
|---|---|---|
company_id | string | The unique identifier of the company from which the shipping address needs to be deleted. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
id | string | A unique identifier representing the specific shipping address to be deleted. (required) |
Authentication
You must provide a valid accessToken in the request headers to authenticate and access this endpoint.
Authentication Headers
| Header | Type | Description |
|---|---|---|
accessToken | string | A valid access token is required. |
Request Body
No request body is required for this DELETE operation.
Response
Success Response
| Status Code | Description |
|---|---|
| 200 OK | Shipping address was successfully deleted. |
Success Response Body Structure
| Field | Type | Description |
|---|---|---|
success | boolean | Indicates if the deletion was successful. |
message | string | Message indicating the result of the delete operation. |
Sample Response Body
{
"success": true,
"message": "Shipping address deleted successfully"
}
Error Responses
| Status Code | Description |
|---|---|
| 400 Bad Request | Invalid request format or missing parameters. |
| 401 Unauthorized | Invalid or missing access token. |
| 403 Forbidden | Access denied. |
| 404 Not Found | Company or shipping address not found. |
| 500 Internal Server Error | Server encountered an error. |
Notes
- Ensure that the
company_idin the URL corresponds to the actual ID of the company under which the shipping address is being deleted. - The API requires a valid access token for authentication to successfully delete the shipping address.
- Deletions are permanent and cannot be undone. Ensure that the correct address is confirmed with the
idbefore performing this operation.