Creación

Este recurso permite generar un envío en tu cuenta de Zippin.


POST https://api.zippin.com.ar/v1/shipment/create

Parámetros

Nombre Tipo Requerido Observaciones
shipment
Object Si Objeto con todos los datos de envio
Envio (shipment)
Nombre Tipo Requerido Observaciones
account_id
Integer Si ID de cuenta de Zippin
externalId
String Si ID externo de envio
declaredValue
Decimal Si Valor declarado de la orden a cotizar (Ej: 20.50)
destination
Object Si Cotiene Datos de Destino
origin_address_id
Integer Si ID de direccion precargada de origen Ver mas
packages
Array Si Contiene las medidas de los paquetes a enviar
NOTA: si tiene una direccion precargada de origen puede solo enviar el ID de la misma
Destino (destination)
Objeto Json que contiene los datos del destino del o los paquetes
Nombre Tipo Requerido Observaciones
name
String Si Nombre del destinatario
document
String Si documento de identidad del destinatario
street
String Si Nombre de la calle o avenida de destino (Calle Bolivar)
street_number
Integer Si Altura de la calle de destino (Ej: 1954)
street_extras
String Si Numero de piso y apartamento de destino (Ej: Piso 1, Apto 2)
city
String Si Nombre de la localidad de destino
state
String Si Nombre de la provincia de destino
zipcode
Integer Si Codigo postal de destino
phone
String Si Numero de télefono de destinatario
email
String Si Email de destinatario
Paquetes (packages)
Array de objetos Json con las medidas del o de los paquetes a enviar
Nombre Tipo Requerido Observaciones
classification
Integer|String No Clasificación de producto del paquete. Puedes indicar la opción por su ID o por el nombre. Por defecto usaremos la "General". Ver todas las opciones.
weight
Integer Si Peso del paquete expresado en gramos (gr)
height
Integer Si Altura del paquete expresado en centimetros (cm)
width
Integer Si Ancho del paquete expresado en centimetros (cm)
length
Integer Si Largo del paquete expresado en centimetros (cm)
description_1
String No Breve descripcion del paquete. Idealmente sugerimos poner el EAN o SKU del bulto en este campo.
description_2
String No Breve descripcion del paquete. Sugerimos poner el nombre del producto.
description_3
String No Breve descripcion del paquete

Ejemplo

Request

https://api.zippin.com.ar/v1/shipment/create?account_id=[TU_ACCOUNT_ID]
curl -H "Content-Type: application/json" -X POST -d
'{
    "shipment":
    {
        "account_id": 2,
        "externalId": "090017288888888",
        "declaredValue": 395.26,
        "origin_address_id": 2,
        "packages": [
            {
                "classification": 2,
                "weight": 29500,
                "height": 30,
                "width": 160,
                "length": 190,
                "description_1": "77722288833",
                "description_2": "Colchon 190x160",
                "description_3": "Colchon Dormilón"
            }
        ],
        "destination": {
            "name": "Thorin Oakenshield",
            "document": "232221124",
            "street": "Av. Siempreviva",
            "street_number": 2544,
            "street_extras": "Piso 1 Apto 2",
            "city": "Capital Federal",
            "state": "Capital Federal",
            "zipcode": 1421,
            "phone": "1144790667",
            "email": "thorinoakenshield@gmail.com"
        }
    }
}'

Response OK

{
    "status": "Success",
    "shipments_id": 101174
}

Response Error

{
    "status":"error",
    "errors":[
        "No puede ser cotizable el envio"
    ]
}