Skip to content
Guides
ES
API reference
stablesettings:read

List shipping methods

Get a paginated list of shipping methods with optional filtering

GET/v1/shipping/methods

Get a paginated list of shipping methods with optional filtering

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
visibleInCheckout?boolean
onlyAvailable?boolean
postalCode?string
type?string

Value in

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

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"
{  "data": [    {      "id": "string",      "storeId": "string",      "sellerId": null,      "name": "string",      "displayName": "string",      "type": "regular",      "isActive": true,      "visibleInCheckout": true,      "sortOrder": 0,      "shippingProfileId": null,      "minOrderAmount": null,      "maxOrderAmount": null,      "minWeight": null,      "maxWeight": null,      "allowSplitFulfillment": true,      "availableDays": [],      "basePrice": 0.1,      "currency": "string",      "estimatedDeliveryDays": null,      "estimatedDeliveryHours": null,      "allowShowCalendar": true,      "metadata": {},      "connectionId": null,      "pickupPointIds": [],      "rates": null,      "createdOn": "2019-08-24T14:15:22Z",      "updatedOn": null    }  ],  "hasNextPage": true,  "nextCursor": null,  "totalCount": null}