XPM

Shipping - Update

Path:

PATCH /shipping/{shippingMethodId}

At any point before the payment, users have the flexibility to change the shipping details. By passing the shippingMethodId, the shipping details can be updated through this endpoint.

Headers

Content-Type: application/json

Consumes

  • application/json

Produces

  • application/json

Parameters

Type: Path

Name: shippingMethodId

Required: true

Type: Body

Name: Shipment details

Required: true

Sample Request

Path

https://{baseurl}api-shipping/shipping/10013

Body

{
"name": "Fedex - Next Day Delivery",
"description": "Guaranteed delivery by 9pm tomorrow.",
"taxCode": "FR123456",
"minimumDays": 1,
"maximumDays": 2,
"cutOffTime": 2100,
"cost": 15.99,
"channel": [100, 200],
"addressType": ["PO","Business"],
"region": "WA",
"updatedBy": "41224d776a326fb40f000001"
}

Response

Response Code: 200

Message: OK

Description: You will see this message when the shipment details are successfully updated.

Sample

{
"_id": "5f15c2775287160007e72209",
"addressType": [
"PO",
"Business"
],
"channel": [
100,
200
],
"name": "Fedex - Next Day Delivery",
"description": "Guaranteed delivery by 9pm tomorrow.",
"taxCode": "FR123456",
"minimumDays": 1,
"maximumDays": 2,
"cutOffTime": 2100,
"cost": 15.99,
"region": "WA",
"createdBy": "41224d776a326fb40f000001",
"shippingMethodId": 10013,
"createdAt": "2020-07-20T16:12:39.294Z",
"updatedAt": "2020-07-20T16:16:36.889Z",
"__v": 0,
"updatedBy": "41224d776a326fb40f000001"
}

Response Code: 404

Message: Not Found

Description: You will see this message when the shipment method is incorrect.

Sample

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

Changelog

  • July-2020 last updated