Recolecciones

Programa una recolección múltiple

   POST /api/v2/pickups

Programa una sola recolección para múltiples envíos. Todos los shipment_ids deben pertenecer al mismo grupo de GET /api/v2/pickups/eligible_shipments: mismo origen, misma paquetería y mismo tipo de operación, y estar disponibles para recolección. La franja horaria debe empezar y terminar el mismo día.

Parámetros de la solicitud:

  • shipment_ids: IDs de los envíos a recolectar. Deben formar un solo grupo de los que devuelve eligible_shipments.
  • packages: Número de paquetes a recolectar. Opcional: si no se envía, se calcula a partir de los envíos. Un número mayor le pide a la paquetería capacidad extra.
  • total_weight: Peso total a recolectar. Opcional: si no se envía, se calcula a partir de los envíos.
  • scheduled_from: Fecha y hora de inicio de la franja horaria de recolección
  • scheduled_to: Fecha y hora de fin de la franja horaria de recolección. Debe ser el mismo día que scheduled_from.
  • include_manifest: Si es true, se genera el manifiesto en PDF de los envíos de la recolección. Se genera en segundo plano y se consulta después en manifest_url.
post/api/v2/pickups

Request

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

Request body

Example request

{
  "pickup": {
    "shipment_ids": [
      "6c001743-9bed-4818-9820-1265576ef422",
      "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d"
    ],
    "packages": 2,
    "total_weight": "30.0",
    "scheduled_from": "2026-10-01 09:00:00",
    "scheduled_to": "2026-10-01 14:00:00",
    "include_manifest": true
  }
}

Response

Retorna la recolección programada

Example response

{
  "data": {
    "id": "ed06f78a-8757-488c-bb82-31964449aea0",
    "type": "pickup",
    "attributes": {
      "id": "ed06f78a-8757-488c-bb82-31964449aea0",
      "status": "scheduled",
      "request_number": "123456789",
      "packages": 3,
      "total_weight": "30.0",
      "scheduled_from": "2026-10-01T09:00:00.000-06:00",
      "scheduled_to": "2026-10-01T14:00:00.000-06:00",
      "created_at": "2026-09-30T08:55:50.992-06:00",
      "updated_at": "2026-09-30T08:55:50.992-06:00",
      "manifest_url": "https://example.com/rails/active_storage/blobs/manifest.pdf"
    },
    "relationships": {
      "shipments": {
        "data": [
          {
            "id": "d4ad5784-4f71-4474-9f34-e2a6f8366d5e",
            "type": "shipment"
          }
        ]
      },
      "address": {
        "data": {
          "id": "901e4d68-a147-4fdf-9078-c252a672611c",
          "type": "simple_address"
        }
      }
    }
  },
  "included": [
    {
      "attributes": {
        "id": "0ac5adcc-a13d-427d-81dd-9ddd70b2f660",
        "carrier_name": "FEDEX",
        "service_name": "Express Saver",
        "service_code": "fedex_express_saver",
        "shipment_scope": "national",
        "estimated_delivery_days": 3,
        "workflow_status": "success",
        "payment_status": "paid",
        "total": "500.0",
        "source": "api",
        "carrier_id": "91dd6bde-fd08-4bf2-b12d-d79c98b0f7ab",
        "service_id": "91dd6bde-fd08-4bf2-b12d-d79c98b0f7ab",
        "master_tracking_number": "234234234233",
        "original_shipment_id": "0199977a-e032-78bf-a335-00a9ae3cfdff",
        "error_detail": {
          "error_code": "ERR_INVALID_ADDRESS",
          "error_message": "La dirección de destino no es válida",
          "error_message_detail": "Token no válido"
        },
        "order_detail_url": "https://example.com/order_detail.pdf"
      }
    }
  ]
}

Changes

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