Skip to content
docs
Guides
ES
Fulfillment & ShippingMethods
settings:read

List shipping methods

Lists shipping methods with search and active, checkout, type, and profile filters. With onlyAvailable enabled, filters by location capability; postalCode applies only to local-delivery coverage.

GET/v1/shipping/methods

Lists shipping methods with search and active, checkout, type, and profile filters. With onlyAvailable enabled, filters by location capability; postalCode applies only to local-delivery coverage.

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Query Parameters

limit?integer

Maximum number of results to return.

Formatint32
cursor?string

Opaque cursor from the previous response. Omit it on the first page.

search?string

Free-text filter. Which fields it covers depends on the resource.

sortBy?string

Field to sort by. Accepted values depend on the resource.

sortDirection?string

Sort direction: asc or desc.

Value in

  • "asc"
  • "desc"
isActive?boolean

Only active items.

visibleInCheckout?boolean
onlyAvailable?boolean
postalCode?string
type?string

Only this type.

Value in

  • "regular"
  • "express"
  • "sameDay"
  • "pickup"
  • "localDelivery"
shippingProfileId?string

Identifier of the shipping profile.

Header Parameters

Authorization*string

OAuth 2.0 bearer token.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/shipping/methods" \  -H "Authorization: Bearer <token>"
{  "data": [    {      "id": "7204558912004325301",      "storeId": "7204558912004325301",      "sellerId": "7204558912004325301",      "name": "Example resource",      "displayName": "Example resource",      "type": "regular",      "isActive": false,      "visibleInCheckout": false,      "sortOrder": 1,      "shippingProfileId": "7204558912004325301",      "minOrderAmount": 1,      "maxOrderAmount": 1,      "minWeight": 1,      "maxWeight": 1,      "allowSplitFulfillment": false,      "availableDays": [        "monday"      ],      "basePrice": 1,      "currency": "PEN",      "estimatedDeliveryDays": 1,      "estimatedDeliveryHours": 1,      "allowShowCalendar": false,      "metadata": {},      "connectionId": "7204558912004325301",      "pickupPointIds": [        "example"      ],      "rates": [        {          "id": "7204558912004325301",          "storeId": "7204558912004325301",          "sellerId": "7204558912004325301",          "shippingMethodId": "7204558912004325301",          "type": "flat",          "price": 1,          "currency": "PEN",          "minOrderPrice": 1,          "maxOrderPrice": 1,          "postalCodes": [            "example"          ],          "isActive": false,          "description": "Example description.",          "discountPercentage": 1,          "zoneCode": "example_code",          "minWeight": 1,          "maxWeight": 1,          "minValue": 1,          "maxValue": 1,          "basePrice": 1,          "pricePerKg": 1,          "pricePerUnit": 1,          "taxIncluded": false,          "surcharge": 1,          "metadata": {},          "createdOn": "2026-08-01T15:30:00Z",          "updatedOn": "2026-08-01T15:30:00Z"        }      ],      "createdOn": "2026-08-01T15:30:00Z",      "updatedOn": "2026-08-01T15:30:00Z"    }  ],  "hasNextPage": false,  "nextCursor": "example",  "totalCount": 1}