Saltar al contenido
Guías
EN
Referencia de API
establesettings:read

Listar métodos de envío

Lista métodos de envío con búsqueda y filtros por estado, visibilidad en el checkout, tipo o perfil. Con onlyAvailable=true, filtra según las capacidades de las ubicaciones; postalCode solo se usa para comprobar la cobertura de entrega local.

GET/v1/shipping/methods

Lista métodos de envío con búsqueda y filtros por estado, visibilidad en el checkout, tipo o perfil. Con onlyAvailable=true, filtra según las capacidades de las ubicaciones; postalCode solo se usa para comprobar la cobertura de entrega local.

Autorización

bearerAuth
AutorizaciónBearer <token>

Token de acceso OAuth 2.0 emitido por Ecomiq Auth.

Ubicación: header

Parámetros de consulta

limit?integer

Cantidad máxima de resultados por devolver.

Formatoint32
cursor?string

Cursor opaco de la respuesta anterior. Omítelo en la primera página.

search?string

Filtro de texto libre. Los campos consultados dependen del recurso.

sortBy?string

Campo de ordenamiento. Los valores admitidos dependen del recurso.

sortDirection?string

Dirección del ordenamiento: asc o desc.

Valor en

  • "asc"
  • "desc"
isActive?boolean
visibleInCheckout?boolean
onlyAvailable?boolean
postalCode?string
type?string

Valor en

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

Cuerpo de la respuesta

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}