XM

Shipping - Get Available

Path:

GET /shipping/all?addressType=Residence&channel=12&region=CA

This API faciliates retrieving shipping methods based on the specific attributes such as addressType, Channel, and/or Region. To retrieve all the available shipment methods, the Get All endpoint is used.

Headers

Consumes

  • application/json

Produces

  • application/json

Parameters

Type: Path Name: AddressType, Channel, and Region

Required: true

Sample Request

{baseurl}/api-shipping/shipping/all?addressType=Residence&channel=12&region=CA

Response Code: 200

Message: OK

Description: You will see this message when the shipment details are successfully retrieved for the attributes specified in the path.

Sample

[
{
"_id": "5e335eefa8b1a43b7dfdc14a",
"addressType": [
"APO",
"MPO",
"PO",
"Business",
"Residence"
],
"channel": [
12
],
"name": "Ukay",
"description": "Ukay National Shipping",
"taxCode": "FR020000",
"cost": 550,
"region": "CA",
"createdBy": "41224d776a326fb40f000001",
"shipMethodId": 10383,
"createdAt": "2020-01-30T22:55:43.796Z",
"updatedAt": "2020-01-30T22:55:43.796Z",
"__v": 0
}
]

Note: In case of incorrect query data, a blank array is returned

Changelog

  • Last updated - July-2020