XM

Shipping - Get By ID

Path:

GET /api-shipping/shipping/{shipMethodId}

This endpoint faciliates retrieval of a shipping details based on the specified ShipMethodId.

Headers

Consumes

  • application/json

Produces

  • application/json

Parameters

Type: Path

Name: ShipMethodId Required: true

Sample Request

{baseurl}/api-shipping/shipping/10001

Response

Response Code: 200

Message: OK

You will see this message when the shipment details are successfully retrieved for the specified shipMethodId.

Sample

{
"_id": "5ecfcd9e8adb6b00082ec8cd",
"addressType": [
"PO"
],
"channel": [
100,
200
],
"cost": 5.99,
"createdBy": "41224d776a326fb40f000001",
"cutOffTime": 1600,
"description": "Cathal Testing this write in",
"maximumDays": 4,
"minimumDays": 2,
"name": "Cathal Test",
"region": "US",
"taxCode": "FR123456",
"shippingMethodId": 10001,
"createdAt": "2020-05-28T14:41:34.964Z",
"updatedAt": "2020-05-28T14:41:34.964Z",
"__v": 0
}

Response Code: 404

Message: Not Found

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

Sample

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

Changelog

  • July-2020 last updated