Get Shipping Methods
Retrieve available shipping methods based on address and cart contents.
Endpoint
POST /api/shop/checkout/shipping-methodsRequest Headers
| Header | Required | Description |
|---|---|---|
Content-Type | Yes | application/json |
X-STOREFRONT-KEY | Yes | Your storefront API key |
Request Body
json
{
"country": "US",
"state": "NY",
"postcode": "10001"
}| Field | Type | Required | Description |
|---|---|---|---|
country | string | Yes | Country code (ISO) |
state | string | Yes | State/Province code |
postcode | string | Yes | Postal code |
Response Fields (200 OK)
| Field | Type | Description |
|---|---|---|
id | integer | Shipping method ID |
code | string | Shipping method code |
name | string | Display name |
description | string | Method description |
price | decimal | Shipping cost |
estimatedDays | integer | Estimated delivery days |
maxDeliveryDate | string | Expected delivery date |
Use Cases
- Display shipping options during checkout
- Calculate shipping cost
- Allow customer to select shipping method
- Show delivery estimates
- Filter methods by location
Notes
- Methods vary by location and product
- Prices may be calculated dynamically
- Some methods may have weight/dimension limits
- International shipping may have restrictions