Retrieve All Shipping Methods
Path:
GET https://{baseurl}/api-shipping/shipping/all
This API enables you to get all the configured shipping methods. To retrieve the shipping methods based on specific criteria (such as address type, channel, and/or region), the Retrieve Available API is recommended. When no shipping method is configured, a blank array is shown in the success response.
Content-Type : application/json
x-site-context : { "date": "2020-08-28T02:35:27.787Z", "channel": 12, "account": 5f493c9f30ec2a0007a94fc8", "stage": "sandbox" }
NA
GET https://{baseurl}/api-shipping/shipping/all
Response Code: 200
Message: OK
Description: You will see this message when all the shipping methods are successfully retrieved.
Sample
[{"_id": "607ef87d22e94700087d0d92","addressType": ["PO","Business"],"channel": [12],"deleted": false,"name": "muhammad Umer waheed","description": "12312","taxCode": "12","minimumDays": 12,"maximumDays": 13,"cutOffTime": 123,"cost": 12,"region": "CA","createdBy": "5fe2330c0ebbf100086392fd","shippingMethodId": 10105,"createdAt": "2021-04-20T15:51:25.263Z","updatedAt": "2021-04-20T19:13:53.385Z","__v": 0},{"_id": "607efded88d9c100086ef6f8","addressType": ["PO","Business"],"channel": [12],"deleted": false,"name": "Ryder Canada","description": "Trust and Speed","taxCode": "CA657","minimumDays": 1,"maximumDays": 4,"cutOffTime": 8,"cost": 9,"region": "CA","createdBy": "5fe160ae4e6fb2000884f84d","shippingMethodId": 10106,"createdAt": "2021-04-20T16:14:37.452Z","updatedAt": "2021-04-20T16:14:37.452Z","__v": 0},{"_id": "607efdee88d9c100086ef6f9","addressType": ["PO","Business"],"channel": [12],"deleted": false,"name": "Ryder Canada","description": "Trust and Speed","taxCode": "CA657","minimumDays": 1,"maximumDays": 4,"cutOffTime": 8,"cost": 9,"region": "CA","createdBy": "5fe160ae4e6fb2000884f84d","shippingMethodId": 10107,"createdAt": "2021-04-20T16:14:38.104Z","updatedAt": "2021-04-20T16:14:38.104Z","__v": 0},{"_id": "607efdee88d9c100086ef6fa","addressType": ["PO","Business"],"channel": [12],"deleted": false,"name": "Ryder Canada","description": "Trust and Speed","taxCode": "CA657","minimumDays": 1,"maximumDays": 4,"cutOffTime": 8,"cost": 9,"region": "CA","createdBy": "5fe160ae4e6fb2000884f84d","shippingMethodId": 10108,"createdAt": "2021-04-20T16:14:38.715Z","updatedAt": "2021-04-20T16:14:38.715Z","__v": 0},{"_id": "607efdef88d9c100086ef6fb","addressType": ["PO","Business"],"channel": [12],"deleted": false,"name": "Ryder Canada","description": "Trust and Speed","taxCode": "CA657","minimumDays": 1,"maximumDays": 4,"cutOffTime": 8,"cost": 9,"region": "CA","createdBy": "5fe160ae4e6fb2000884f84d","shippingMethodId": 10109,"createdAt": "2021-04-20T16:14:39.285Z","updatedAt": "2021-04-20T16:14:39.285Z","__v": 0},{"_id": "607efdf188d9c100086ef6fc","addressType": ["PO","Business"],"channel": [12],"deleted": false,"name": "Ryder Canada","description": "Trust and Speed","taxCode": "CA657","minimumDays": 1,"maximumDays": 4,"cutOffTime": 8,"cost": 9,"region": "CA","createdBy": "5fe160ae4e6fb2000884f84d","shippingMethodId": 10110,"createdAt": "2021-04-20T16:14:41.121Z","updatedAt": "2021-04-20T16:14:41.121Z","__v": 0},{"_id": "607efdf188d9c100086ef6fd","addressType": ["PO","Business"],"channel": [12],"deleted": false,"name": "Ryder Canada","description": "Trust and Speed","taxCode": "CA657","minimumDays": 1,"maximumDays": 4,"cutOffTime": 8,"cost": 9,"region": "CA","createdBy": "5fe160ae4e6fb2000884f84d","shippingMethodId": 10111,"createdAt": "2021-04-20T16:14:41.519Z","updatedAt": "2021-04-20T16:14:41.519Z","__v": 0},{"_id": "607efdf188d9c100086ef6fe","addressType": ["PO","Business"],"channel": [12],"deleted": false,"name": "Ryder Canada","description": "Trust and Speed","taxCode": "CA657","minimumDays": 1,"maximumDays": 4,"cutOffTime": 8,"cost": 9,"region": "CA","createdBy": "5fe160ae4e6fb2000884f84d","shippingMethodId": 10112,"createdAt": "2021-04-20T16:14:41.743Z","updatedAt": "2021-04-20T16:14:41.743Z","__v": 0},{"_id": "607efdf188d9c100086ef6ff","addressType": ["PO","Business"],"channel": [12],"deleted": false,"name": "Ryder Canada","description": "Trust and Speed","taxCode": "CA657","minimumDays": 1,"maximumDays": 4,"cutOffTime": 8,"cost": 9,"region": "CA","createdBy": "5fe160ae4e6fb2000884f84d","shippingMethodId": 10113,"createdAt": "2021-04-20T16:14:41.918Z","updatedAt": "2021-04-20T16:14:41.918Z","__v": 0},{"_id": "607efdf488d9c100086ef700","addressType": ["PO","Business"],"channel": [12],"deleted": false,"name": "Ryder Canada","description": "Trust and Speed","taxCode": "CA657","minimumDays": 1,"maximumDays": 4,"cutOffTime": 8,"cost": 9,"region": "CA","createdBy": "5fe160ae4e6fb2000884f84d","shippingMethodId": 10114,"createdAt": "2021-04-20T16:14:44.567Z","updatedAt": "2021-04-20T16:14:44.567Z","__v": 0},{"_id": "607efdf688d9c100086ef701","addressType": ["PO","Business"],"channel": [12],"deleted": false,"name": "Ryder Canada","description": "Trust and Speed","taxCode": "CA657","minimumDays": 1,"maximumDays": 4,"cutOffTime": 8,"cost": 9,"region": "CA","createdBy": "5fe160ae4e6fb2000884f84d","shippingMethodId": 10115,"createdAt": "2021-04-20T16:14:46.938Z","updatedAt": "2021-04-20T16:14:46.938Z","__v": 0},{"_id": "607efdf788d9c100086ef702","addressType": ["PO","Business"],"channel": [12],"deleted": false,"name": "Ryder Canada","description": "Trust and Speed","taxCode": "CA657","minimumDays": 1,"maximumDays": 4,"cutOffTime": 8,"cost": 9,"region": "CA","createdBy": "5fe160ae4e6fb2000884f84d","shippingMethodId": 10116,"createdAt": "2021-04-20T16:14:47.408Z","updatedAt": "2021-04-20T16:14:47.408Z","__v": 0},{"_id": "607efdf888d9c100086ef703","addressType": ["PO","Business"],"channel": [12],"deleted": false,"name": "Ryder Canada","description": "Trust and Speed","taxCode": "CA657","minimumDays": 1,"maximumDays": 4,"cutOffTime": 8,"cost": 9,"region": "CA","createdBy": "5fe160ae4e6fb2000884f84d","shippingMethodId": 10117,"createdAt": "2021-04-20T16:14:48.240Z","updatedAt": "2021-04-20T16:14:48.240Z","__v": 0},{"_id": "607f7bfaf9ca6c000877bb31","addressType": ["PO","Business"],"channel": [12],"deleted": false,"name": "muhammad Umer waheed 2","description": "12","taxCode": "12","minimumDays": 12,"maximumDays": 14,"cutOffTime": 12,"cost": 12,"region": "CA","createdBy": "5fe2330c0ebbf100086392fd","shippingMethodId": 10118,"createdAt": "2021-04-21T01:12:26.261Z","updatedAt": "2021-04-21T01:12:26.261Z","__v": 0},{"_id": "607f7bfaf9ca6c000877bb32","addressType": ["PO","Business"],"channel": [12],"deleted": false,"name": "muhammad Umer waheed 2","description": "12","taxCode": "12","minimumDays": 12,"maximumDays": 14,"cutOffTime": 12,"cost": 12,"region": "CA","createdBy": "5fe2330c0ebbf100086392fd","shippingMethodId": 10119,"createdAt": "2021-04-21T01:12:26.564Z","updatedAt": "2021-04-21T01:12:26.564Z","__v": 0},{"_id": "607f7bfbf9ca6c000877bb33","addressType": ["PO","Business"],"channel": [12],"deleted": false,"name": "muhammad Umer waheed 2","description": "12","taxCode": "12","minimumDays": 12,"maximumDays": 14,"cutOffTime": 12,"cost": 12,"region": "CA","createdBy": "5fe2330c0ebbf100086392fd","shippingMethodId": 10120,"createdAt": "2021-04-21T01:12:27.069Z","updatedAt": "2021-04-21T01:12:27.069Z","__v": 0},{"_id": "607f7bfbf9ca6c000877bb34","addressType": ["PO","Business"],"channel": [12],"deleted": false,"name": "muhammad Umer waheed 2","description": "12","taxCode": "12","minimumDays": 12,"maximumDays": 14,"cutOffTime": 12,"cost": 12,"region": "CA","createdBy": "5fe2330c0ebbf100086392fd","shippingMethodId": 10121,"createdAt": "2021-04-21T01:12:27.531Z","updatedAt": "2021-04-21T01:12:27.531Z","__v": 0},{"_id": "607f7e431f50be0007a24117","addressType": ["PO","Business"],"channel": [12],"deleted": false,"name": "muhammad Umer waheed 3","description": "123","taxCode": "123","minimumDays": 123,"maximumDays": 145,"cutOffTime": 12,"cost": 123,"region": "CA","createdBy": "5fe2330c0ebbf100086392fd","shippingMethodId": 10122,"createdAt": "2021-04-21T01:22:11.405Z","updatedAt": "2021-04-21T01:22:11.405Z","__v": 0},{"_id": "607f7e43669bc50007338b2c","addressType": ["PO","Business"],"channel": [12],"deleted": false,"name": "muhammad Umer waheed 3","description": "123","taxCode": "123","minimumDays": 123,"maximumDays": 145,"cutOffTime": 12,"cost": 123,"region": "CA","createdBy": "5fe2330c0ebbf100086392fd","shippingMethodId": 10123,"createdAt": "2021-04-21T01:22:11.449Z","updatedAt": "2021-04-21T01:22:11.449Z","__v": 0},{"_id": "607f7e44669bc50007338b2d","addressType": ["PO","Business"],"channel": [12],"deleted": false,"name": "muhammad Umer waheed 3","description": "123","taxCode": "123","minimumDays": 123,"maximumDays": 145,"cutOffTime": 12,"cost": 123,"region": "CA","createdBy": "5fe2330c0ebbf100086392fd","shippingMethodId": 10124,"createdAt": "2021-04-21T01:22:12.150Z","updatedAt": "2021-04-21T01:22:12.150Z","__v": 0},{"_id": "607f7e441f50be0007a24118","addressType": ["PO","Business"],"channel": [12],"deleted": false,"name": "muhammad Umer waheed 3","description": "123","taxCode": "123","minimumDays": 123,"maximumDays": 145,"cutOffTime": 12,"cost": 123,"region": "CA","createdBy": "5fe2330c0ebbf100086392fd","shippingMethodId": 10125,"createdAt": "2021-04-21T01:22:12.186Z","updatedAt": "2021-04-21T01:22:12.186Z","__v": 0},{"_id": "607f7e441f50be0007a24119","addressType": ["PO","Business"],"channel": [12],"deleted": false,"name": "muhammad Umer waheed 3","description": "123","taxCode": "123","minimumDays": 123,"maximumDays": 145,"cutOffTime": 12,"cost": 123,"region": "CA","createdBy": "5fe2330c0ebbf100086392fd","shippingMethodId": 10126,"createdAt": "2021-04-21T01:22:12.902Z","updatedAt": "2021-04-21T01:22:12.902Z","__v": 0},{"_id": "607f7e6d1f50be0007a2411a","addressType": ["PO","Business"],"channel": [12],"deleted": false,"name": "muhammad Umer waheed 4","description": "123","taxCode": "12","minimumDays": 12,"maximumDays": 14,"cutOffTime": 11,"cost": 12,"region": "CA","createdBy": "5fe2330c0ebbf100086392fd","shippingMethodId": 10127,"createdAt": "2021-04-21T01:22:53.338Z","updatedAt": "2021-04-21T01:22:53.338Z","__v": 0}]
Error Code: 403
Message: Forbidden
Description: You will see this error when the account number is incorrect in the x-site-context (for a multi-tenent client).
{"message": "Forbidden"}
June - 2021
July - 2020 First updated