Crear
El endpoint de creación nos permite crear el envío, indicando todo el detalle del mismo y su contenido.
Los atributos carrier_id, service_type, logistic_type y destination.point_id (si es envio a sucursal) deben haber sido obtenidos previamente de una cotización.
El Request
Para hacer el request hay tres variantes para informar la carga a despachar, una basada en items sueltos (variante recomendada), una basada paquetes personalizados (sin detalle de items), y otra basada en paquetes con items específicos. El vendedor puede usar cualquiera de estas incluso combinar las mismas en el mismo llamado.
Crear en base a items sueltos
Se debe usar esta opción cuando se quiere indicar unidades de productos vendidas y se quiere dejar en Zippin la decisión de cómo armar paquetes para poder despachar esos items. Ésta modalidad hace uso de la funcionalidad de cajas. Ver cómo funciona el empaquetado automático y la configuración de cajas.
En esta variante se debe enviar un array items con cada item que compondrá el envio. Un item es una unidad de un producto, que se podrá agrupar con otros items en una o mas cajas o paquetes. Luego, cada paquete resultante tendrá su propia etiqueta.
Crear en base a paquetes personalizados
Se debe usar esta opción cuando se quiere indicar específicamente el detalle de los paquetes finales a despachar. Un paquete es un bulto que tendrá su propia etiqueta. Un envío puede estar compuesto de uno o más bultos. A su vez, cada bulto puede tener adentro multiples items, pero para este modo de cotización es irrelevante.
En esta variante se debe enviar un array packages con cada paquete que compondrá el envio.
Crear en base a paquetes con items específicos
Se debe usar esta opción cuando se quiere indicar específicamente cómo se agrupan los items a despachar. Un paquete es un bulto que tendrá su propia etiqueta. Un envío puede estar compuesto de uno o más bultos. A su vez, cada bulto puede tener adentro multiples items. También se podrá definir opcionalmente dentro de que caja se agruparán los items o dejar que el sistema determine automáticamente la más adecuada (Ver cómo funciona el empaquetado automático y la configuración de cajas.).
En esta variante se debe enviar un array packages con cada paquete que compondrá el envío. A su vez, cada bulto puede tener adentro multiples items, que deberán ser definidos de forma especifica creando un array items dentro de cada package informado.
| POST /shipments | |||
|---|---|---|---|
| Parámetros para el body: | |||
| account_id | int | ID de la cuenta | |
| declared_value | decimal | Valor declarado del envío | Ej: 200.50 |
| service_type | string | Código del tipo de servicio (sale de la cotización) | Ej. standard_delivery |
| logistic_type | string | Código del modo de despacho (sale de la cotización) | Ej. crossdock |
| origin_id | int | ID del origen del envío | |
| carrier_id | int | Para indicar con qué transporte crear el envío (sale de la cotización). | |
| source | string | Opcional. Usado en integraciones específicas. | |
| packages | array de Packages (objetos) | ||
| weight | int | Peso en gramos | |
| height length width |
int | Medidas del paquete, en centímetros | |
| classification_id | int |
1 General2 Colchones
|
|
| sku | string | Opcional. Para utilizar un SKU del catálogo. Si se usa, no es necesario indicar ninguno de los otros atributos del paquete. | |
| items | array | Opcional. Para especificar los Items de un paquete. Si se usa, no de se debe indicar SKU y no es necesario indicar ninguno de los otros atributos del paquete. Misma estructura que el array de Items siguiente. | |
| container_id | int | Opcional. Para especificar la caja donde se agruparán los items del paquete. Si se usa, deben estar especificados los items del paquete. | |
| items | array de Items (objetos) | ||
| sku | string | SKU del item | Se intentará vincular a un SKU cargado en el catalogo de Zippin. |
| weight | int | Peso en gramos |
|
| height
length width |
int | Medidas del item, en centímetros |
|
| classification_id | int | 1 General
2 Colchones |
|
| destination | object | ||
| name | string | Nombre y apellido del destinatario | |
| document | string | Documento del destinatario | |
| phone | string | Teléfono del destinatario | |
| string | E-mail del destinatario | ||
| point_id | string | ID del punto de entrega seleccionado (sale de la cotización) | Obligatorio para servicio pickup_point, caso contrario omitir. |
| street | string | Calle de destino (no incluir nro de puerta) | Máx. 50 caracteres. Obligatorio salvo para servicio pickup_point |
| street_number | string | Nro. de puerta del domicilio | Máx. 10 caracteres. Obligatorio salvo para servicio pickup_point |
| street_extras | string | Piso, Depto, aclaraciones | Opcional (nullable) Max. 150 caracteres |
| city | string | Ciudad/Localidad | Ej. San Miguel de Tucuman. Obligatorio salvo para servicio pickup_point |
| state | string | Provincia | Ej. Tucuman. Obligatorio salvo para servicio pickup_point |
| zipcode | int | Código postal | Ej. 4500. Obligatorio salvo para servicio pickup_point |
Ejemplo usando la variante de packages cerrados:
POST https://api.zippin.com.ar/v2/shipments
{
"external_id": "teste210119",
"account_id": 2,
"service_type": "standard_delivery",
"logistic_type": "crossdock",
"carrier_id": 13,
"destination": {
"name": "eee",
"document": "9999",
"street": "999",
"street_number": "99",
"street_extras": null,
"city": "Capital Federal",
"state": "Capital Federal",
"zipcode": "1425",
"phone": "99999999",
"email": "dsdsd@fddm.com"
},
"origin_id": 25,
"declared_value": 1425,
"packages": [
{
"sku_id": null,
"weight": 10000,
"height": 20,
"width": 20,
"length": 20,
"description_1": "test",
"description_2": null,
"description_3": null,
"classification_id": 1
}
]
}
RESPONSE 201
{
"id": 103171,
"external_id": "teste210119",
"delivery_id": null,
"created_at": "2019-02-13T19:30:47+0000",
"account_id": 2,
"parent_shipment_id": null,
"service_type": "standard_delivery",
"logistic_type": "crossdock",
"carrier": {
"id": 13,
"name": "Logicargo",
"logo": "https://zippin-ar.s3.amazonaws.com/carriers/logicargo/nI5FGjiEtlavVu7HDFJKKFqXq7MWGiSyOB6M1gA8.png"
},
"status": "new",
"status_name": "Procesando",
"tracking": "https://app.zippin.com.ar/tracking/103171/2",
"tracking_external": "https://app.zippin.com.ar/tracking/teste210119/2/external_id",
"destination": {
"name": "eee",
"document": "9999",
"street": "999",
"street_number": "99",
"street_extras": null,
"city": "Capital Federal",
"state": "Capital Federal",
"zipcode": "1425",
"phone": "99999999",
"email": "dsdsd@fddm.com"
},
"origin": {
"id": 25,
"name": "Origen Demo",
"document": "22222222",
"street": "Falsa",
"street_number": "123",
"street_extras": null,
"city": "Capital Federal",
"state": "Capital Federal",
"zipcode": "1005",
"phone": "22222222",
"email": "demo@zippin.com.ar"
},
"declared_value": 1425,
"price": 103.31,
"price_incl_tax": 125,
"total_weight": 10000,
"total_volume": 8000,
"packages": [
{
"internal_id": 68885,
"sku_id": null,
"weight": 10000,
"height": 20,
"width": 20,
"length": 20,
"volume": 8000,
"description_1": "test",
"description_2": null,
"description_3": null,
"classification": {
"id": 1,
"name": "General"
}
}
]
}
Ejemplo usando la variante de packages con items específicos:
POST https://api.zippin.com.ar/v2/shipments
{
"external_id": "teste210119",
"account_id": 2,
"service_type": "standard_delivery",
"logistic_type": "crossdock",
"carrier_id": 13,
"destination": {
"name": "eee",
"document": "9999",
"street": "999",
"street_number": "99",
"street_extras": null,
"city": "Capital Federal",
"state": "Capital Federal",
"zipcode": "1425",
"phone": "99999999",
"email": "dsdsd@fddm.com"
},
"origin_id": 25,
"declared_value": 1425,
"packages": [
{
"sku_id": null,
"weight": null,
"height": null,
"width": null,
"length": null,
"description_1": "test",
"description_2": null,
"description_3": null,
"classification_id": 1,
"items": [
{
"weight": 500,
"height": 8,
"width": 8,
"length": 8,
"sku": "iphone"
},
{
"weight": 500,
"height": 8,
"width": 8,
"length": 8,
"sku": "iphone"
}
],
"container_id": 1,
}
]
}
RESPONSE 201
{
"id": 103171,
"external_id": "teste210119",
"delivery_id": null,
"created_at": "2019-02-13T19:30:47+0000",
"account_id": 2,
"parent_shipment_id": null,
"service_type": "standard_delivery",
"logistic_type": "crossdock",
"carrier": {
"id": 13,
"name": "Logicargo",
"logo": "https://zippin-ar.s3.amazonaws.com/carriers/logicargo/nI5FGjiEtlavVu7HDFJKKFqXq7MWGiSyOB6M1gA8.png"
},
"status": "new",
"status_name": "Procesando",
"tracking": "https://app.zippin.com.ar/tracking/103171/2",
"tracking_external": "https://app.zippin.com.ar/tracking/teste210119/2/external_id",
"destination": {
"name": "eee",
"document": "9999",
"street": "999",
"street_number": "99",
"street_extras": null,
"city": "Capital Federal",
"state": "Capital Federal",
"zipcode": "1425",
"phone": "99999999",
"email": "dsdsd@fddm.com"
},
"origin": {
"id": 25,
"name": "Origen Demo",
"document": "22222222",
"street": "Falsa",
"street_number": "123",
"street_extras": null,
"city": "Capital Federal",
"state": "Capital Federal",
"zipcode": "1005",
"phone": "22222222",
"email": "demo@zippin.com.ar"
},
"declared_value": 1425,
"price": 103.31,
"price_incl_tax": 125,
"total_weight": 10000,
"total_volume": 8000,
"packages": [
{
"internal_id": 148121,
"sku_id": null,
"weight": 1100,
"height": 12,
"width": 20,
"length": 17,
"volume": 4080,
"description_1": "2 productos",
"description_2": "Test 1",
"description_3": null,
"classification": {
"id": 1,
"name": "General"
},
"items": [
{
"sku": null,
"description": "iphone",
"must_keep_vertical": 0,
"weight": 500,
"width": 8,
"length": 8,
"height": 8,
"pos_x": 0,
"pos_y": 0,
"pos_z": 0
},
{
"sku": null,
"description": "iphone",
"must_keep_vertical": 0,
"weight": 500,
"width": 8,
"length": 8,
"height": 8,
"pos_x": 8,
"pos_y": 0,
"pos_z": 0
}
],
"container": {
"id": 1,
"description": "Test 1",
"outer_width": 20,
"outer_height": 12,
"outer_length": 17,
"inner_width": 19,
"inner_length": 16,
"inner_height": 11,
"max_weight": 5000
}
}
]
}
Ejemplo usando la variante de items sueltos:
POST https://api.zippin.com.ar/v2/shipments
{
"external_id": "testcosts",
"account_id": "2",
"origin_id": "25",
"service_type": "standard_delivery",
"logistic_type": "crossdock",
"carrier_id": 8,
"declared_value": 9015,
"items": [
{
"weight": 500,
"height": 8,
"width": 8,
"length": 8,
"sku": "iphone"
},
{
"weight": 500,
"height": 8,
"width": 8,
"length": 8,
"sku": "iphone"
}
],
"destination": {
"zipcode": "4400",
"state": "Salta",
"city": "salta",
"name": "TEST",
"document": "3333",
"street": "TEST",
"street_number": "222",
"street_extras": "TEST",
"phone": "00000",
"email": "TEST@test.com"
}
}
RESPONSE 201
{
"id": 151060,
"external_id": "testcosts",
"delivery_id": "0999-00151060",
"carrier_tracking_id": null,
"created_at": "2020-06-09T15:19:07+0000",
"account_id": 2,
"parent_shipment_id": null,
"logistic_type": "crossdock",
"service_type": "standard_delivery",
"carrier": {
"id": 8,
"name": "La Sevillanita",
"logo": "https:\/\/zippin-ar.s3.amazonaws.com\/carriers\/la-sevillanita\/Kt4qo3TsENegNCCnrW70OxQhBqbo7uyfemNRT5bH.png"
},
"status": "new",
"status_name": "Procesando",
"tracking": "http:\/\/app.zippin.com.ar\/track\/151060",
"tracking_external": "http:\/\/app.zippin.com.ar\/track\/2\/testcosts",
"destination": {
"name": "TEST",
"document": "3333",
"street": "TEST",
"street_number": "222",
"street_extras": "TEST",
"city": "Salta",
"state": "Salta",
"zipcode": "4400",
"phone": "00000",
"email": "TEST@test.com"
},
"origin": {
"id": 25,
"name": "Origen Demo",
"document": "22222222",
"street": "Av Luis Maria Campos",
"street_number": "877",
"street_extras": "PRUEBA",
"city": "Capital Federal",
"state": "Capital Federal",
"zipcode": "1005",
"phone": "22222222",
"email": "demo@zippin.com.ar"
},
"declared_value": 9015,
"price": 869.42,
"price_incl_tax": 1052,
"total_weight": 1100,
"total_volume": 4080,
"packages": [
{
"internal_id": 148121,
"sku_id": null,
"weight": 1100,
"height": 12,
"width": 20,
"length": 17,
"volume": 4080,
"description_1": "2 productos",
"description_2": "Test 1",
"description_3": null,
"classification": {
"id": 1,
"name": "General"
},
"items": [
{
"sku": null,
"description": "iphone",
"must_keep_vertical": 0,
"weight": 500,
"width": 8,
"length": 8,
"height": 8,
"pos_x": 0,
"pos_y": 0,
"pos_z": 0
},
{
"sku": null,
"description": "iphone",
"must_keep_vertical": 0,
"weight": 500,
"width": 8,
"length": 8,
"height": 8,
"pos_x": 8,
"pos_y": 0,
"pos_z": 0
}
],
"container": {
"id": 1,
"description": "Test 1",
"outer_width": 20,
"outer_height": 12,
"outer_length": 17,
"inner_width": 19,
"inner_length": 16,
"inner_height": 11,
"max_weight": 5000
}
}
],
"tags": []
}