XM

Shipping - Delete

Path:

DEL /api-shipping/shipping/{shipMethodId}

Through this endpoint, your have the flexibility to delete a shipping method.

Headers

x-api-key: d41d8cd98f00b204e9800998ecf8427e

Consumes

  • application/json

Produces

  • application/json

Parameters

Type: Path

Name: shipMethodId Required: true

Sample Request

{{baseurl}/api-shipping/shipping/10003

Response

Response Code: 200

Message: OK

Description: You will see this message when the shipment is deleted for the specified shipMethodId.

Sample

{
"_id": "5f15bef85287160007e72202",
"addressType": [
"PO",
"Business"
],
"channel": [
100,
200
],
"name": "DHL - Next Day Delivery",
"description": "Guaranteed delivery by 9pm tomorrow.",
"taxCode": "FR123456",
"minimumDays": 2,
"maximumDays": 4,
"cutOffTime": 1600,
"cost": 5.99,
"region": "WA",
"createdBy": "41224d776a326fb40f000001",
"shippingMethodId": 10006,
"createdAt": "2020-07-20T15:57:44.817Z",
"updatedAt": "2020-07-20T15:57:44.817Z",
"__v": 0
}

Response Code: 404

Message: Not Found

Description: You will see this messsage when the shipMethodId is incorrect.

Sample

{
"code": "SHIPPING_METHOD_NOT_DELETED",
"message": "Shipping Method Not Found."
}

Changelog

  • July-2020 last updated