Recolecciones

Recupera los envíos por recolectar

   GET /api/v2/pickups/eligible_shipments?page={page}&per_page={per_page}

Devuelve los envíos que todavía se pueden recolectar, agrupados igual que en la plataforma: por origen, paquetería y tipo de operación. Cada grupo se puede mandar tal cual a POST /api/v2/pickups en shipment_ids. La respuesta se pagina por grupos.

get/api/v2/pickups/eligible_shipments

Request

  • Base URL: https://api-pro.skydropx.com
  • URL: https://api-pro.skydropx.com/api/v2/pickups/eligible_shipments
  • Auth: HTTP bearer

Query parameters

pageinteger
Example:1

Número de página a recuperar

per_pageinteger
Example:20

Número de elementos por página (máximo 20, por defecto 20)

Response

Retorna una colección paginada de grupos de envíos

Example response

{
  "groups": [
    {
      "origin_address_id": "397f7fb2a1f50c44b86056a2a92e8fa3",
      "carrier": "fedex",
      "type": "national_no_ltl",
      "shipment_ids": [
        "6c001743-9bed-4818-9820-1265576ef422",
        "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d"
      ]
    }
  ],
  "meta": {
    "current_page": 1,
    "next_page": 2,
    "total_pages": 3,
    "total_count": 45
  }
}

Changes

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