Skip to content
Guides
ES
API reference
stablesettings:read

List pickup points

Get a paginated list of pickup points with optional filtering

GET/v1/shipping/pickup-points

Get a paginated list of pickup points 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
locationId?null|string
city?string
zone?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/pickup-points"
{  "data": [    {      "id": "string",      "storeId": "string",      "locationId": null,      "connectionId": null,      "sellerId": null,      "isExternal": true,      "externalId": null,      "name": "string",      "description": null,      "state": null,      "city": null,      "neighborhood": null,      "postalCode": null,      "address": "string",      "addressNumber": null,      "reference": null,      "observations": null,      "latitude": null,      "longitude": null,      "deliveryTimeInMinutes": null,      "leadTimeInMinutes": null,      "isSellerPickupPoint": true,      "contactName": null,      "contactPhone": null,      "contactEmail": null,      "schedule": [        {          "day": "monday",          "openTime": "14:15:22Z",          "closeTime": "14:15:22Z",          "duration": "string"        }      ],      "hasCoordinates": true,      "status": "inactive",      "createdOn": "2019-08-24T14:15:22Z",      "updatedOn": null    }  ],  "hasNextPage": true,  "nextCursor": null,  "totalCount": null}