Skip to main content

Shipping Method API

The Shipping Method API allows you to programmatically retrieve available shipping methods for orders in your EverShop store. These methods can be presented to customers during checkout to provide shipping options.

Get Available Shipping Methods

Retrieves all available shipping methods that can be applied to orders in your store.

Request Schema (application/json)
No request body required
GET/api/shippingMethods
curl
-H "Accept: application/json"
https://<your domain>/api/shippingMethods
Sample Of Response
{
"data": {
"methods": [
{
"code": "free",
"name": "Free Shipping"
},
{
"code": "standard",
"name": "Standard Shipping",
"cost": 5.99
},
{
"code": "express",
"name": "Express Shipping",
"cost": 15.99
}
]
}
}

Set Shipping Method for Cart

Applies a selected shipping method to a specific shopping cart.

Request Schema (application/json)
Field NameField TypeRequired
method_codestringYes
POST/api/carts/{cart_id}/shippingMethods
curl
-H "Accept: application/json"
-H "Cookie: asid=<your admin cookie>"
https://<your domain>/api/carts/{cart_id}/shippingMethods
Sample Of Response
{
"data": {
"shipping_method": "standard",
"shipping_fee_excl_tax": 5.99,
"shipping_fee_incl_tax": 5.99
}
}

Path Parameters

ParameterTypeRequiredDescription
cart_idstringYesThe UUID of the cart to apply the shipping method to

Get Cart Shipping Method

Retrieves the currently selected shipping method for a specific cart.

Request Schema (application/json)
No request body required
GET/api/carts/{cart_id}/shippingMethods
curl
-H "Accept: application/json"
-H "Cookie: asid=<your admin cookie>"
https://<your domain>/api/carts/{cart_id}/shippingMethods
Sample Of Response
{
"data": {
"shipping_method": "standard",
"shipping_fee_excl_tax": 5.99,
"shipping_fee_incl_tax": 5.99
}
}

Path Parameters

ParameterTypeRequiredDescription
cart_idstringYesThe UUID of the cart to retrieve the shipping method for

Troubleshooting

Common Error Codes

Status CodeDescriptionSolution
400Bad RequestCheck that the shipping method code is valid
401UnauthorizedEnsure your API credentials are correct
404Not FoundVerify the cart ID exists
422Unprocessable EntityThe cart may be missing required information (like shipping address)
500Server ErrorContact support if the issue persists