Crear Envío

POST/shipping/v1

El endpoint /shipping/v1/ se usa para crear un nuevo envío de una tarjeta innominada. Ten en cuenta que para crear un envío, es requisito que hayas creado un lote de tarjetas innominadas.

Consideraciones

El campo region se corresponde con:

Provincia en Argentina
Estado en Brasil
Estado en Colombia
Estado en Mexico

El campo courier.tracking_url de la respuesta, estará disponible una vez que el envío sea confirmado por el partner logístico correspondiente. Hasta entonces, tendrá valor nulo

Para Brasil

Si operas en Brasil, el taxIdentificationNumber siempre será obligatorio.
Los campos documentNumber y documentType no serán requeridos.
El campo additional_info no está disponible para su uso.
Además, deberás completar el campo region con el código UF de dos caracteres. Ejemplo: 'SP' para São Paulo
- Rondônia (RO)
- Acre (AC)
- Amazonas (AM)
- Roraima (RR)
- Pará (PA)
- Amapá (AP)
- Tocantins (TO)
- Maranhão (MA)
- Piauí (PI)
- Ceará (CE)
- Rio Grande do Norte (RN)
- Paraíba (PB)
- Pernambuco (PE)
- Alagoas (AL)
- Sergipe (SE)
- Bahia (BA)
- Minas Gerais (MG)
- Espírito Santo (ES)
- Rio de Janeiro (RJ)
- São Paulo (SP)
- Paraná (PR)
- Santa Catarina (SC)
- Rio Grande do Sul (RS)
- Mato Grosso do Sul (MS)
- Mato Grosso (MT)
- Goiás (GO)
- Distrito Federal (DF)

Para Colombia

Si operas en Colombia, el campo zip_code es opcional, es decir que podrás no enviarlo.
El campo additional_info no está disponible para su uso.

Para México

El campo additional_info estará disponible únicamente para envíos que utilicen logística 99 Minutos.

Envio de tarjetas innominadas desde deposito

Puedes asociar un envío con el usuario al que le enviarás la tarjeta especificando el user_id en el body del shipment.

Parámetros disponibles

Header Parameters

AuthorizationStringrequired

x-idempotency-keyStringrequired

Cuerpo de solicitud

application/json

shipment_typeenumrequired

affinity_group_idstringrequired

countrystringrequired

addressobjectrequired10 propiedades

receiverobjectrequired6 propiedades

user_idstring

Detalle de respuestas

401

No autorizado

403

Acceso denegado

Ejemplo de solicitud

{
  "shipment_type": "CARD_FROM_WAREHOUSE",
  "affinity_group_id": "afg-20MpN8vmIPj77ujhb9cS8ctstN2",
  "country": "ARG",
  "address": {
    "street_name": "Libertador",
    "street_number": "539",
    "floor": "2",
    "apartment": "B",
    "city": "Buenos Aires",
    "region": "Buenos Aires",
    "country": "Argentina",
    "zip_code": "5346",
    "neighborhood": "example_value",
    "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"
}

Ejemplo de código

curl -X POST "https://api.pomelo.la/shipping/v1" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-idempotency-key: fRwX12Dg3345AD" \
  -d '{
  "shipment_type": "CARD_FROM_WAREHOUSE",
  "affinity_group_id": "afg-20MpN8vmIPj77ujhb9cS8ctstN2",
  "country": "ARG",
  "address": {
    "street_name": "Libertador",
    "street_number": "539",
    "floor": "2",
    "apartment": "B",
    "city": "Buenos Aires",
    "region": "Buenos Aires",
    "country": "Argentina",
    "zip_code": "5346",
    "neighborhood": "example_value",
    "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"
}'

Ejemplo de respuesta (201)Envío creado.

{
  "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"
}

Crear Lote de Multi-Tarjetas

Obtener Envío