GET
/shipping/v1Buscar Envios
El endpoint /shipping/v1/ te permite buscar un grupo de envios según los atributos que especifiques.
Podrás filtrar y ordenar los envíos siguiendo esta documentación.
Los atributos para ordenar son:
shipment_typestatusstatus_detailcreated_at
Parámetros disponibles
Header Parameters
AuthorizationStringrequired
Query Parameters
filter[id]String
filter[shipment_type]enum
filter[batch_id]String
filter[email]String
filter[status]String
filter[batch_status]String
filter[document_number]String
filter[start_date]String
filter[end_date]String
filter[start_due_delivery_date]String
filter[end_due_delivery_date]String
filter[country_code]String
filter[user_id]String
page[size]Number
page[number]Number
sortString
Detalle de respuestas
400
Request inválido
401
No autorizado
403
Acceso denegado
Ejemplo de código
curl -X GET "https://api.pomelo.la/shipping/v1?filter[id]=example_value&filter[shipment_type]=SINGLE_CARD&filter[batch_id]=example_value&filter[email]=example_value&filter[status]=example_value&filter[batch_status]=example_value&filter[document_number]=example_value&filter[start_date]=example_value&filter[end_date]=example_value&filter[start_due_delivery_date]=example_value&filter[end_due_delivery_date]=example_value&filter[country_code]=example_value&filter[user_id]=example_value&page[size]=123&page[number]=123&sort=pid, shipment_type, status, status_detail" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY"Ejemplo de respuesta (200)OK
{
"data": [
{
"id": "shi-23hJL4bm94q9BFEd2sGhBjY6xbH",
"external_tracking_id": "f923da123",
"status": "CREATED",
"status_detail": "CREATED",
"shipment_type": "SINGLE_CARD",
"affinity_group_id": "afg-20MpN8vmIPj77ujhb9cS8ctstN2",
"affinity_group_name": "Pomelo Nominate Basic Physical",
"courier": {
"company": "ANDREANI",
"tracking_url": "https://www.api.qa.com/#!/informacionEnvio/360000070874590"
},
"country_code": "ARG",
"created_at": "2020-07-10 15:00:00.000",
"batch": {
"id": "bch-23WEkAaZsqubbke9pYVAt9sG81e",
"quantity": 100,
"has_stock": true,
"status": "PENDING"
},
"address": {
"street_name": "Libertador",
"street_number": "539",
"floor": "2",
"apartment": "B",
"city": "Buenos Aires",
"region": "Buenos Aires",
"country": "Argentina",
"zip_code": "5346",
"neighborhood": "string",
"additional_info": "Torre 2. Casa amarilla"
},
"receiver": {
"full_name": "Gonzalo Iglesias",
"email": "[email protected]",
"document_type": "dni",
"document_number": "243432423",
"tax_identification_number": "38912151888",
"telephone_number": "53454342"
},
"user_id": "usr-20MpN8vmIPj77ujhb9cS8ctstN2",
"due_delivery_date": "2020-07-20T00:00:00.000Z",
"courier_additional_info": {
"status": "ENTREGA",
"status_detail": "ENTREGA CERTIFICADA",
"received_by": "Franco Iglesias"
},
"request_status": "PENDING_UPDATE_ADDRESS"
}
],
"meta": {
"pagination": {
"total_pages": 1,
"current_page": 0
},
"filter": [
{
"key": "status",
"value": [
"TRACKED",
"IN_TRANSIT"
]
}
]
}
}