Recolecciones

Programa una recolección

   POST /api/v1/pickups/

Este endpoint permite programar una recolección

Parámetros de la solicitud:

  • reference_shipment_id: Id del envio a recolectar
  • packages: Número de paquetes a recolectar
  • total_weight: Peso total de los paquetes a recolectar
  • scheduled_from: Fecha y hora de inicio de franja horaria de recolección
  • scheduled_to: Fecha y hora final de franja horaria de recolección

[!note] Evita cancelaciones por duplicidad agrupando los paquetes con el mismo origen y fecha en una sola recolección.

post/api/v1/pickups/

Request

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

Request body

Example request

{
  "pickup": {
    "reference_shipment_id": "0ac5adcc-a13d-427d-81dd-9ddd70b2f660",
    "packages": 5,
    "total_weight": "30.0",
    "scheduled_from": "2024-09-24 09:00:00",
    "scheduled_to": "2024-09-24 14:00:00"
  }
}

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": 1,
      "total_weight": "30.0",
      "scheduled_from": "2024-09-20T09:00:00.000-06:00",
      "scheduled_to": "2024-09-20T14:00:00.000-06:00",
      "created_at": "2024-09-19T07:43:46.614-06:00",
      "updated_at": "2024-09-19T07:43:46.614-06:00",
      "error_reason": "Error al programar la recolección",
      "reschedule_remaining_days": 9
    },
    "relationships": {
      "reference_shipment": {
        "data": {
          "id": "d4ad5784-4f71-4474-9f34-e2a6f8366d5e",
          "type": "shipment"
        }
      },
      "address": {
        "data": {
          "id": "901e4d68-a147-4fdf-9078-c252a672611c",
          "type": "address"
        }
      }
    }
  },
  "included": [
    {
      "type": "address",
      "attributes": {
        "id": "0ac5adcc-a13d-427d-81dd-9ddd70b2f660",
        "area_level1": "Ciudad de México",
        "area_level2": "Venustiano Carranza",
        "area_level3": "Romero rubio",
        "name": "Juan",
        "postal_code": "15400",
        "country_code": "MX",
        "address_type": "from",
        "street1": "Persia 143",
        "company": "Company name",
        "phone": "3453453453453",
        "email": "juan@mail.com",
        "reference": "porton",
        "apartment_number": "Apartamento 404"
      }
    }
  ]
}

Changes

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