XM

Shipping - Get All

Path:

GET /api-shipping/shipping/all

This endpoint enables your customers to retrieve all the available shipping options.

To retrieve the shipping methods based on specific addressType, Channel, and/or Region, the Get Available endpoint is recommended.

Headers

Consumes

  • application/json

Produces

  • application/json

Parameters

NA

Sample Request

{baseurl}/api-shipping/shipping/all

Response

Response Code: 200

Message: OK

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

Sample

[
{
"_id": "5e335eefa8b1a43b7dfdc143",
"addressType": [
"APO",
"MPO",
"PO",
"Business",
"Residence"
],
"channel": [
12
],
"name": "FJD",
"description": "FJD Local Shipping",
"taxCode": "FR020000",
"cost": 195,
"region": "NY",
"createdBy": "41224d776a326fb40f000001",
"shipMethodId": 10376,
"createdAt": "2020-01-30T22:55:43.765Z",
"updatedAt": "2020-01-30T22:55:43.765Z",
"__v": 0
},
{
"_id": "5e335eefa8b1a43b7dfdc144",
"addressType": [
"APO",
"MPO",
"PO",
"Business",
"Residence"
],
"channel": [
12
],
"name": "FJD",
"description": "FJD Local Shipping",
"taxCode": "FR020000",
"cost": 195,
"region": "NJ",
"createdBy": "41224d776a326fb40f000001",
"shipMethodId": 10377,
"createdAt": "2020-01-30T22:55:43.773Z",
"updatedAt": "2020-01-30T22:55:43.773Z",
"__v": 0
},
{
"_id": "5e335eefa8b1a43b7dfdc145",
"addressType": [
"APO",
"MPO",
"PO",
"Business",
"Residence"
],
"channel": [
12
],
"name": "FJD",
"description": "FJD Local Shipping",
"taxCode": "FR020000",
"cost": 195,
"region": "CT",
"createdBy": "41224d776a326fb40f000001",
"shipMethodId": 10378,
"createdAt": "2020-01-30T22:55:43.777Z",
"updatedAt": "2020-01-30T22:55:43.777Z",
"__v": 0
},
{
"_id": "5e335eefa8b1a43b7dfdc146",
"addressType": [
"APO",
"MPO",
"PO",
"Business",
"Residence"
],
"channel": [
12
],
"name": "FJD",
"description": "FJD Local Shipping",
"taxCode": "FR020000",
"cost": 195,
"region": "DE",
"createdBy": "41224d776a326fb40f000001",
"shipMethodId": 10379,
"createdAt": "2020-01-30T22:55:43.781Z",
"updatedAt": "2020-01-30T22:55:43.781Z",
"__v": 0
},
{
"_id": "5e335eefa8b1a43b7dfdc150",
"addressType": [
"APO",
"MPO",
"PO",
"Business",
"Residence"
],
"channel": [
12
],
"name": "Ukay",
"description": "Ukay National Shipping",
"taxCode": "FR020000",
"cost": 550,
"region": "IN",
"createdBy": "41224d776a326fb40f000001",
"shipMethodId": 10389,
"createdAt": "2020-01-30T22:55:43.814Z",
"updatedAt": "2020-01-30T22:55:43.814Z",
"__v": 0
},
{
"_id": "5e335eefa8b1a43b7dfdc16f",
"addressType": [
"APO",
"MPO",
"PO",
"Business",
"Residence"
],
"channel": [
12
],
"name": "Ukay",
"description": "Ukay National Shipping",
"taxCode": "FR020000",
"cost": 550,
"region": "WA",
"createdBy": "41224d776a326fb40f000001",
"shipMethodId": 10420,
"createdAt": "2020-01-30T22:55:43.910Z",
"updatedAt": "2020-01-30T22:55:43.910Z",
"__v": 0
},
{
"_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"
}
]

Changelog

  • Last updated - July 2020