Puntos de oficina

Obtener puntos de oficina para una tarifa

   GET /api/v1/office_points

Devuelve los puntos de oficina que un cliente puede usar para una tarifa cotizada, en la dirección solicitada. Los puntos de oficina están filtrados por cobertura y restricciones de la tarifa y ordenados del más cercano al destino. Usa el id de un punto de oficina como office_delivery_point_id u office_pickup_point_id al crear el envío.

Parámetros de la solicitud:

get/api/v1/office_points

Request

  • Base URL: https://api-pro.skydropx.com
  • URL: https://api-pro.skydropx.com/api/v1/office_points
  • Auth: HTTP bearer

Query parameters

rate_idstring required
Example:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

El ID único de la tarifa obtenido de la cotización (GET /api/v1/quotations/{id}).

direction'delivery' | 'pickup'
Example:delivery

Dirección del punto de oficina — delivery (el destinatario recoge en la sucursal) o pickup (el remitente entrega en la sucursal). Por defecto delivery.

limitinteger
Example:15

Número máximo de puntos de oficina a devolver (del más cercano primero). Por defecto 15.

Response

Devuelve la lista de puntos de oficina aplicables

Example response

{
  "data": [
    {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "type": "office_point",
      "attributes": {
        "name": "Sucursal Centro",
        "carrier_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "country_code": "MX",
        "postal_code": "64000",
        "postal_code_label": "C.P. 64000",
        "area_level1": "Nuevo León",
        "area_level2": "Monterrey",
        "area_level3": "Centro",
        "street1": "Av. Principal 123",
        "street2": "Local 5",
        "latitude": 25.6866,
        "longitude": -100.3161,
        "short_address": "Av. Principal 123, 64000 Monterrey, Nuevo León"
      }
    }
  ],
  "meta": {
    "total": 3
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.