Update tracking state
El tracking state de un envío representa el estado de preparación del mismo luego de que la orden se envió.
Los posibles estados son:
- no_tracking: todavía no comenzó el proceso de envío.
- pending_manifest: el shipment se envió y está pendiente de ser facturado (factura y remito).
- pending_tracking: el pedido fue facturado y está pendiente de generar la guía para el envió.
- ready_for_picking: se generó la guía y está pendiente que sea retirado por el operador logístico.
- pending_picking: se generó la guía y está pendiente que sea retirado por el operador logístico.
- ready_for_pickup: se generó la guía y está pendiente que sea retirado por el operador logístico.
- in_distribution: el operador logístico se lo llevó para tratamiento en su planta
- in_transit: el pedido está en camino a la casa del cliente.
- first_visit: el opreador logístico no encontró a nadie en el domicilio de entrega.
- second_visit: el opreador logístico no encontró a nadie en el domicilio de entrega.
- delivered: el pedido fue entregado.
- failed: el pedido falló.
- cancelled: el pedido fue canacelado.
Para modificar el tracking state de un envío y así indicar el avance en el flow de entrega, debemos hacer el siguiente request:
PUT /shipments/:shipment_number/fire?e={nuevo_estado}
para cada estado dejamos debajo el evento correspondiente para enviar a la api:
PENDING_MANIFEST = 'pending_manifest'
PENDING_TRACKING = 'pending_tracking'
IN_TRANSIT = 'in_transit'
IN_DISTRIBUTION = 'in_distribution'
FIRST_VISIT = 'first_visit'
SECOND_VISIT = 'second_visit'
RETURNED = 'returned'
DELIVERED = 'deliver'
CANCELLED = 'cancelled'
FAILED = 'failed'
READY_FOR_PICKUP = 'ready_for_pickup'
READY_FOR_PICKING = 'ready_for_picking'
PENDING_PICKING = 'pending_picking'
Cambiar el método de envío elegido
Esta api permite modificar el método de envío elegido para una orden.
PUT /shipments/:shipment_number/
{
"shipment":
{
"selected_shipping_rate_id": 11883215
}
}
Para saber que valor enviar en el parámetro selected_shipping_rate_id debemos hacer el siguiente request:
En el array 'shipping_rates', encontrarán los envíos disponibles.
En el siguiente ejemplo, en caso de querer utilizar el medio 'retiro en sucursal clastia', deberán enviar en la api descripta arriba el id: 11883216.
GET /shipments/:shipment_number/
{
"id": 654991,
"tracking": null,
"number": "H58129931646",
"cost": "0.0",
"shipped_at": null,
"state": "pending",
"delivery_note_id": null,
"invoice_id": null,
"source_type": "Spree::Order",
"source_id": 1241391,
"credit_note": null,
"is_pickup?": true,
"created_at": "2017-11-21T15:24:39.561-03:00",
"order_id": "W055190341",
"stock_location_name": "WINERY",
"merchant_name": "Winery",
"tracking_state": "no_tracking",
"shipping_company": "WINERY",
"service_cost": null,
"return_service_cost": null,
"return_tracking": null,
"shipping_rates": [
{
"id": 11883215,
"name": "Envío Estandar",
"cost": "0.0",
"selected": false,
"shipping_method_id": 253,
"shipping_method_name": "Envío Estandar",
"shipping_method_admin_name": "ENVIO_ESTANDAR",
"shipping_method_display_on": "",
"display_cost": "$0"
},
{
"id": 11883216,
"name": "Retiro en sucursal clastia",
"cost": "0.0",
"selected": true,
"shipping_method_id": 257,
"shipping_method_name": "Retiro en sucursal clastia",
"shipping_method_admin_name": "RETIRO_SUCURSAL_CLASTIA",
"shipping_method_display_on": "both",
"display_cost": "$0"
}
],
"selected_shipping_rate": {
"id": 11883216,
"name": "Retiro en sucursal winery",
"cost": "0.0",
"selected": true,
"shipping_method_id": 257,
"shipping_method_name": "Retiro en sucursal winery",
"shipping_method_admin_name": "RETIRO_SUCURSAL_WINERY",
"shipping_method_display_on": "both",
"display_cost": "$0"
},
"shipping_method": {
"id": 257,
"name": "Retiro en sucursal winery",
"zones": [
{
"id": 3401,
"name": "GBA",
"description": "GBA"
},
{
"id": 3400,
"name": "CABA",
"description": "CABA"
},
{
"id": 3399,
"name": "INT 2",
"description": "INT 2"
},
{
"id": 3398,
"name": "INT 1",
"description": "INT 1"
}
],
"shipping_categories": [
{
"id": 1,
"name": "Default"
}
]
},
"shipping_methods": [
{
"id": 253,
"name": "Envío Estandar",
"zones": [
{
"id": 3399,
"name": "INT 2",
"description": "INT 2"
},
{
"id": 3398,
"name": "INT 1",
"description": "INT 1"
},
{
"id": 3401,
"name": "GBA",
"description": "GBA"
},
{
"id": 3400,
"name": "CABA",
"description": "CABA"
},
{
"id": 3402,
"name": "Local",
"description": null
},
{
"id": 3403,
"name": "Regional",
"description": null
},
{
"id": 3404,
"name": "Nacional 1",
"description": null
},
{
"id": 3405,
"name": "Nacional 2",
"description": null
}
],
"shipping_categories": [
{
"id": 1,
"name": "Default"
}
]
},
{
"id": 257,
"name": "Retiro en sucursal winery",
"zones": [
{
"id": 3401,
"name": "GBA",
"description": "GBA"
},
{
"id": 3400,
"name": "CABA",
"description": "CABA"
},
{
"id": 3399,
"name": "INT 2",
"description": "INT 2"
},
{
"id": 3398,
"name": "INT 1",
"description": "INT 1"
}
],
"shipping_categories": [
{
"id": 1,
"name": "Default"
}
]
}
],
"inventory_units": [
{
"id": 1408597,
"state": "on_hand",
"variant_id": 18494,
"order_id": 1241391,
"shipment_id": 654991,
"return_authorization_id": null
},
{
"id": 1408596,
"state": "on_hand",
"variant_id": 18494,
"order_id": 1241391,
"shipment_id": 654991,
"return_authorization_id": null
},
{
"id": 1408595,
"state": "on_hand",
"variant_id": 18494,
"order_id": 1241391,
"shipment_id": 654991,
"return_authorization_id": null
},
{
"id": 1408594,
"state": "on_hand",
"variant_id": 53888,
"order_id": 1241391,
"shipment_id": 654991,
"return_authorization_id": null
},
{
"id": 1408593,
"state": "on_hand",
"variant_id": 53888,
"order_id": 1241391,
"shipment_id": 654991,
"return_authorization_id": null
}
],
"adjustments": [],
"manifest": [
{
"quantity": 3,
"states": {
"on_hand": 3
},
"variant": {
"id": 18494,
"name": "CHANDON ROSÉ",
"sku": "0500507531E",
"price": "257.0",
"weight": "0.0",
"height": "1.0",
"width": "1.0",
"depth": "1.0",
"is_master": true,
"cost_price": null,
"slug": "chandon-rose",
"description": "Desde sus inicios, Chandon Argentina contó con el asesoramiento de los técnicos de Moët & Chandon, que tenía para ese entonces más de 200 años de experiencia: fundada en 1743, sus productos ya eran famosos en todo el mundo. \nEstos orígenes explican la perfecta combinación entre tradición y modernidad que desde siempre caracterizó a Chandon Argentina, así como su constante preocupación por la calidad y su permanente búsqueda de la excelencia.\n\nCATA\n\nVista: Salmón brillante. Se logran tonalidades únicas gracias al corte específico del vino base blanco, con un porcentaje bien definido de Malbec .\nAroma: El fruto personaliza a este verdadero Brut Rosé de Chandon.\n\nPorcentaje de alcohol: 12%\nMaridaje: Es ideal como aperitivo o para acompañar aves con salsas de hongos y carnes rojas grilladas.\nOrigen: Argentina",
"track_inventory": true,
"product_id": 9799,
"position": 59,
"afored_weight": 1,
"model_site": null,
"model_supplier": null,
"parent_id": null,
"display_pvp_price": "$257",
"pvp_price": "257.0",
"display_discount_percentage": "0%",
"column": null,
"corridor": null,
"row": null,
"options_text": "",
"stock_count": 180,
"in_stock": true,
"can_supply": true,
"backordered": false,
"option_values": [],
"images": [
{
"id": 39318,
"position": 1,
"attachment_content_type": "image/jpeg",
"attachment_file_name": "Chandon_rose_estuche.jpg",
"type": "Spree::Image",
"attachment_updated_at": "2017-04-26T13:49:43.128-03:00",
"attachment_width": 688,
"attachment_height": 1271,
"alt": "CHANDON ROSÉ",
"viewable_type": "Spree::Variant",
"viewable_id": 18494,
"mini_url": "/spree/products/39318/mini/Chandon_rose_estuche.jpg?1493225383",
"small_url": "/spree/products/39318/small/Chandon_rose_estuche.jpg?1493225383",
"product_url": "/spree/products/39318/product/Chandon_rose_estuche.jpg?1493225383",
"large_url": "/spree/products/39318/large/Chandon_rose_estuche.jpg?1493225383",
"gallery_thumb_url": "/spree/products/39318/gallery_thumb/Chandon_rose_estuche.jpg?1493225383",
"gallery_small_url": "/spree/products/39318/gallery_small/Chandon_rose_estuche.jpg?1493225383",
"gallery_large_url": "/spree/products/39318/gallery_large/Chandon_rose_estuche.jpg?1493225383",
"category_thumb_url": "/spree/products/39318/category_thumb/Chandon_rose_estuche.jpg?1493225383",
"moto_mini_url": "/spree/products/39318/moto_mini/Chandon_rose_estuche.jpg?1493225383",
"moto_product_url": "/spree/products/39318/moto_product/Chandon_rose_estuche.jpg?1493225383",
"moto_gallery_thumb_url": "/spree/products/39318/moto_gallery_thumb/Chandon_rose_estuche.jpg?1493225383",
"moto_gallery_small_url": "/spree/products/39318/moto_gallery_small/Chandon_rose_estuche.jpg?1493225383",
"moto_gallery_large_url": "/spree/products/39318/moto_gallery_large/Chandon_rose_estuche.jpg?1493225383",
"moto_category_thumb_url": "/spree/products/39318/moto_category_thumb/Chandon_rose_estuche.jpg?1493225383",
"winery_gallery_thumb_url": "/spree/products/39318/winery_gallery_thumb/Chandon_rose_estuche.jpg?1493225383",
"winery_gallery_small_url": "/spree/products/39318/winery_gallery_small/Chandon_rose_estuche.jpg?1493225383",
"winery_gallery_large_url": "/spree/products/39318/winery_gallery_large/Chandon_rose_estuche.jpg?1493225383",
"winery_category_thumb_url": "/spree/products/39318/winery_category_thumb/Chandon_rose_estuche.jpg?1493225383",
"farmar_gallery_thumb_url": "/spree/products/39318/farmar_gallery_thumb/Chandon_rose_estuche.jpg?1493225383",
"farmar_gallery_small_url": "/spree/products/39318/farmar_gallery_small/Chandon_rose_estuche.jpg?1493225383",
"farmar_gallery_large_url": "/spree/products/39318/farmar_gallery_large/Chandon_rose_estuche.jpg?1493225383",
"farmar_category_thumb_url": "/spree/products/39318/farmar_category_thumb/Chandon_rose_estuche.jpg?1493225383"
}
],
"product_properties": [
{
"id": 84620,
"product_id": 9799,
"property_id": 2131,
"value": "ROSÉ",
"property_name": "VINO_VARIETAL",
"presentation": "VARIETAL"
},
{
"id": 84621,
"product_id": 9799,
"property_id": 2876,
"value": "BODEGA CHANDON",
"property_name": "VINO_BODEGA",
"presentation": "BODEGA"
},
{
"id": 84623,
"product_id": 9799,
"property_id": 2133,
"value": "750 Ml",
"property_name": "VINO_VOLUMEN",
"presentation": "VOLUMEN"
}
],
"brand": {
"id": 2199,
"name": "CHANDON"
},
"user_groups_prices": []
}
},
{
"quantity": 2,
"states": {
"on_hand": 2
},
"variant": {
"id": 53888,
"name": "VEGA SICILIA ÚNICO MAGNUM",
"sku": "VEG00006",
"price": "49000.0",
"weight": "1.0",
"height": "1.0",
"width": "1.0",
"depth": "1.0",
"is_master": true,
"cost_price": null,
"slug": "vega-sicilia-unico-magnum",
"description": "",
"track_inventory": true,
"product_id": 37243,
"position": 99999,
"afored_weight": 1,
"model_site": null,
"model_supplier": null,
"parent_id": null,
"display_pvp_price": "$49.000",
"pvp_price": "49000.0",
"display_discount_percentage": "0%",
"column": null,
"corridor": null,
"row": null,
"options_text": "",
"stock_count": 0,
"in_stock": false,
"can_supply": false,
"backordered": false,
"option_values": [],
"images": [
{
"id": 76236,
"position": 1,
"attachment_content_type": "image/jpeg",
"attachment_file_name": "Vega-Sicilia-Unico-2007.ES-TE-0006-07a.jpg",
"type": "Spree::Image",
"attachment_updated_at": "2017-09-11T12:28:09.853-03:00",
"attachment_width": 690,
"attachment_height": 2300,
"alt": "",
"viewable_type": "Spree::Variant",
"viewable_id": 53888,
"mini_url": "/spree/products/76236/mini/Vega-Sicilia-Unico-2007.ES-TE-0006-07a.jpg?1505143689",
"small_url": "/spree/products/76236/small/Vega-Sicilia-Unico-2007.ES-TE-0006-07a.jpg?1505143689",
"product_url": "/spree/products/76236/product/Vega-Sicilia-Unico-2007.ES-TE-0006-07a.jpg?1505143689",
"large_url": "/spree/products/76236/large/Vega-Sicilia-Unico-2007.ES-TE-0006-07a.jpg?1505143689",
"gallery_thumb_url": "/spree/products/76236/gallery_thumb/Vega-Sicilia-Unico-2007.ES-TE-0006-07a.jpg?1505143689",
"gallery_small_url": "/spree/products/76236/gallery_small/Vega-Sicilia-Unico-2007.ES-TE-0006-07a.jpg?1505143689",
"gallery_large_url": "/spree/products/76236/gallery_large/Vega-Sicilia-Unico-2007.ES-TE-0006-07a.jpg?1505143689",
"category_thumb_url": "/spree/products/76236/category_thumb/Vega-Sicilia-Unico-2007.ES-TE-0006-07a.jpg?1505143689",
"moto_mini_url": "/spree/products/76236/moto_mini/Vega-Sicilia-Unico-2007.ES-TE-0006-07a.jpg?1505143689",
"moto_product_url": "/spree/products/76236/moto_product/Vega-Sicilia-Unico-2007.ES-TE-0006-07a.jpg?1505143689",
"moto_gallery_thumb_url": "/spree/products/76236/moto_gallery_thumb/Vega-Sicilia-Unico-2007.ES-TE-0006-07a.jpg?1505143689",
"moto_gallery_small_url": "/spree/products/76236/moto_gallery_small/Vega-Sicilia-Unico-2007.ES-TE-0006-07a.jpg?1505143689",
"moto_gallery_large_url": "/spree/products/76236/moto_gallery_large/Vega-Sicilia-Unico-2007.ES-TE-0006-07a.jpg?1505143689",
"moto_category_thumb_url": "/spree/products/76236/moto_category_thumb/Vega-Sicilia-Unico-2007.ES-TE-0006-07a.jpg?1505143689",
"winery_gallery_thumb_url": "/spree/products/76236/winery_gallery_thumb/Vega-Sicilia-Unico-2007.ES-TE-0006-07a.jpg?1505143689",
"winery_gallery_small_url": "/spree/products/76236/winery_gallery_small/Vega-Sicilia-Unico-2007.ES-TE-0006-07a.jpg?1505143689",
"winery_gallery_large_url": "/spree/products/76236/winery_gallery_large/Vega-Sicilia-Unico-2007.ES-TE-0006-07a.jpg?1505143689",
"winery_category_thumb_url": "/spree/products/76236/winery_category_thumb/Vega-Sicilia-Unico-2007.ES-TE-0006-07a.jpg?1505143689",
"farmar_gallery_thumb_url": "/spree/products/76236/farmar_gallery_thumb/Vega-Sicilia-Unico-2007.ES-TE-0006-07a.jpg?1505143689",
"farmar_gallery_small_url": "/spree/products/76236/farmar_gallery_small/Vega-Sicilia-Unico-2007.ES-TE-0006-07a.jpg?1505143689",
"farmar_gallery_large_url": "/spree/products/76236/farmar_gallery_large/Vega-Sicilia-Unico-2007.ES-TE-0006-07a.jpg?1505143689",
"farmar_category_thumb_url": "/spree/products/76236/farmar_category_thumb/Vega-Sicilia-Unico-2007.ES-TE-0006-07a.jpg?1505143689"
}
],
"product_properties": [
{
"id": 306327,
"product_id": 37243,
"property_id": 2131,
"value": "BLEND",
"property_name": "VINO_VARIETAL",
"presentation": "VARIETAL"
},
{
"id": 306328,
"product_id": 37243,
"property_id": 2876,
"value": "BODEGA TEMPOS VEGA SICILIA",
"property_name": "VINO_BODEGA",
"presentation": "BODEGA"
},
{
"id": 306330,
"product_id": 37243,
"property_id": 2133,
"value": "1,5 Lt",
"property_name": "VINO_VOLUMEN",
"presentation": "VOLUMEN"
}
],
"brand": {
"id": 7451,
"name": "VEGA SICILIA"
},
"user_groups_prices": []
}
}
]
}