Crear Entrega Simple

POST https://api.persat.com.ar/v1/deliveries

Headers

Name	Type	Description
Authorization*	String	Bearer API_KEY
Content-Type*	String	application/json

Request Body

Name	Type	Description
_id*	String	Identificador de la entrega. Debe ser único.
labels_ids	Array of Numbers	Array de numeros con el id de las etiquetas
delivery_data.schema_id*	Number	Identificador de la plantilla/esquema de la entrega
delivery_data.service_time	Number	Duración en minutos estimada de la entrega
delivery_data.wt	[number, number]	Ventana horaria de visita. Array de 2 posiciones indicando inicio y fin de la visita en minutos. Por ej: Si hay que visitar entre las 08:00 y las 15:00, se debe recibir [840, 900]
delivery_data.capacity	Number	Dimension x. Puede ser Peso, volumen, cantidad.
delivery_data.contact*	JSON Object
delivery_data.contact.name*	String	Nombre del contacto que va a recibir la entrega.
delivery_data.contact.phone	String	Telefono del contacto
delivery_data.contact.email	String	Email del contacto
delivery_data.position*	JSON Object
delivery_data.position.address*	JSON Object
delivery_data.position.address.clean*	String	Direccion "limpia". Nombrede la calle + altura. Ej: Rivadavia 1200, Caba
delivery_data.position.address.extra_info*	String	Datos extra de la direccion. Ej: Piso, Color de la puerta, etc
delivery_data.position.location	Array Numbers	[longitud, latitud] Indicando donde se va a realiar la entrega
delivery_data.instructions*	JSON Object

400: Bad Request Error en alguno de los campos enviados. userMessage contiene informacipon adicional.

{
    "success": false,
    "error": {
        "status": 400,
        "type": "BAD_REQUEST",
        "userMessage": "\"_id\" es obligatorio. Debe ser un string identificando la entrega. Max: 50 caracteres"
    }
}

200: OK La consulta se ejecutó con éxito

{
    "success": true,
    "data": {
        "_id": "ASDKSAL23",
        "state": "FINISHED",
        "created": "2022-05-12T13:26:19.292Z",
        "source_tag":"Jose 19/07/2021 17:19:24",
        "labels_ids": [
            133
        ],
        "due_date": "2022-05-14T00:00:00.000Z",
        "client": {
            "id": 12816,
            "name": "Zapatería Don José",
            "uid_client": "CL565LK"
        },
        "delivery_data": {
            "schema_id": 5,
            "service_time": 150,
            "wt": [480, 1080],
            "capacity": 278,
            "contact": {
                "name": "Jose Perez",
                "phone": "5555-5555",
                "email": "[e-mail]"
            },
            "position": {
                "address": {
                    "clean": "Av. Independencia 1987",
                    "extra_info": "Piso 1A"
                },
                "location": [
                    -58.49390429,
                    -34.677806633
                ]
            },
            "instructions": {
                "FWtQn2m9v": "Entregar zapatos color Rojo",
                "FWJt5MLSn": 5687.00,
                "FWBsxBUIQ": "Cobrar"
            },
            "results": {
                "formvalues": {
                    "FW40IlFW1": "El cliente quedo conforme",
                    "FWy1RBJ2j": "Cobrado",
                    "FWGa6f4zq": 5687.00,
                    "FW_FINAL_STATE": "DELIVERED"
                },
                "log": [
                    {
                        "user_name": "[e-mail]",
                        "user_real_name": "Pedro Lopez",
                        "user_id": 37,
                        "date": "2022-05-12T14:10:24.000Z"
                    },
                    {
                        "user_name": "[e-mail]",
                        "user_real_name": "Pedro Lopez",
                        "user_id": 37,
                        "date": "2022-05-13T14:43:37.867Z"
                    }
                ]
            },
            "rework": {
                "retry": 1,
                "prev": "ASDKSAL22",
                "next": "ASDKSAL22-R3"
            }
        },
        "assignation_info": {
            "date": "2022-05-12T00:00:00.000Z",
            "device_id": 18,
            "device_name": "Vechiculo AB 123 LK",
            "route_id": 1652362114021
        }
    }
}

409: Conflict Conflicto. El identificador de entrega ya existe dentro de Persat

{
    "success": false,
    "error": {
        "status": 409,
        "type": "CONFLICT",
        "userMessage": "El nro. de entrega ya existe"
    }
}

Ejemplo de request

body

{
    "_id": "ASDKSAL23",
    "labels_ids": [133],
    "delivery_data": {
        "schema_id": 5,    
    	"service_time": 150,
    	"capacity": 278,
        "wt": [480, 1080],
        "contact": {
            "name": "Jose Perez",
            "phone": "5555-5555",
            "email": "[e-mail]"
        },        
        "instructions": {
            "FWtQn2m9v": "Entregar zapatos color Rojo",
            "FWJt5MLSn": 5687.00,
            "FWBsxBUIQ": "Cobrar"
        },            
        "position": {
            "address": {
                "clean": "Av. Independencia 1987",
                "extra_info": "Piso 1A"
            },
            "location": [
                -58.49390429,
                -34.677806633
            ]
        }
    }
}

Los campos se explican en Obtener Entrega, pero durante la inserción hay muchos campos que son opcionales.

labels_ids: En caso de no enviarlo en la consulta, labels_ids tomará el valor definido por defecto en la plantilla/esquema para esta entrega (schema_id)

delivery_data.service_time: En caso de no enviarlo en la consulta, service_time tomará el valor definido por defecto en la plantilla/esquema para esta entrega (schema_id)

delivery_data.wt: En caso de no enviarlo en la consulta, su valor será null y por lo tanto indicará que la entrega no tiene restricción de horario alguna. Es decir que puede ser realizada a cualquier hora del dia.

delivery_data.capacity: En caso de no enviarlo en la consulta, capacity tomará el valor 0

delivery_data.contact.phone: En caso de no enviarlo en la consulta, phone tomará el valor ""

delivery_data.contact.email: En caso de no enviarlo en la consulta, phone tomará el valor ""

delivery_data.position.location: En caso de no enviarlo en la consulta, la entrega se creará correctamente, pero no se podrá mmodificar su estado hasta que un usuario corrija el valor de posición.