# Plataforma - OnDelivery
# Listar todos los productos - getAllProducts
##### POST https://api.service24gps.com/api/v1/ondelivery/getAllProducts
Obtiene todos los productos de un cliente - distribuidor.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
---|
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/getAllProducts' \
--header 'Cookie: PHPSESSID=999egj9j5mnaevhamfu16s90a9' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"status": "ok",
"message": {
"1": {
"id": "2",
"idcliente_distribuidor": "4220",
"idcliente_sistema": "4221",
"nombre": "Mi Prodducto 2",
"descripcion": "Este es el segundo producto",
"costo": "105",
"impuesto": "16.8",
"idmoneda": "4",
"peso": "99.99",
"volumen": "89.00",
"unidad_peso": "0",
"unidad_volumen": "0",
"idtipo_activo_producto_od": null,
"codigo_producto": null,
"estado": "1",
"valor_unidad_peso": null,
"valor_unidad_volumen": null,
"nombre_moneda": "COP"
},
"2": {
"id": "3",
"idcliente_distribuidor": "4220",
"idcliente_sistema": "4221",
"nombre": "Mi Prodducto 3",
"descripcion": "Este es el tercer producto",
"costo": "200",
"impuesto": "32",
"idmoneda": "4",
"peso": "99.99",
"volumen": "30.00",
"unidad_peso": "0",
"unidad_volumen": "0",
"idtipo_activo_producto_od": null,
"codigo_producto": null,
"estado": "1",
"valor_unidad_peso": null,
"valor_unidad_volumen": null,
"nombre_moneda": "COP"
},
"3": {
"id": "176",
"idcliente_distribuidor": "4220",
"idcliente_sistema": "4221",
"nombre": "Mí producto",
"descripcion": "",
"costo": "43",
"impuesto": "6.88",
"idmoneda": "2",
"peso": "2.00",
"volumen": "3.00",
"unidad_peso": "166",
"unidad_volumen": "156",
"idtipo_activo_producto_od": "5",
"codigo_producto": "",
"estado": "1",
"valor_unidad_peso": "kilogramo",
"valor_unidad_volumen": "Metros cubicos",
"nombre_moneda": "MXN"
}
}
}
}
```
Ver campos de respuesta:
Campo | Descripción
| Formato |
---|
id | Identificador único del producto. | Entero |
idcliente\_distribuidor | Identificador único del distribuidor. | Entero |
idcliente\_sistema | Identificador único del cliente.
| Entero |
nombre
| Nombre del producto.
| Cadena de texto |
descripcion
| Descripción del producto.
| Cadena de texto
|
costo
| Costo.
| Entero
|
impuesto
| Impuesto.
| Flotante
|
idmoneda
| Identificador único de la moneda.
| Entero
|
peso
| Peso.
| Flotante
|
volumen
| Volumen.
| Flotante
|
unidad\_peso
| Unidad de peso.
| Entero
|
unidad\_volumen
| Unidad de volumen.
| Entero
|
idtipo\_activo\_producto\_od
| Identificador único del activo del producto.
| Entero
|
codigo\_producto
| Código del producto
| Cadena de texto
|
estado
| Estado. | Entero
|
valor\_unidad\_peso
| Valor unidad de peso. | Cadena de texto
|
valor\_unidad\_volumen
| Valor unidad de volumen. | Cadena de texto
|
nombre\_moneda
| Nombre de la moneda. | Cadena de texto
|
# Listar clientes - getAllClient
##### POST https://api.service24gps.com/api/v1/ondelivery/getAllClient
Obtiene todos los clientes creados en la plataforma de OnDelivery.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
---|
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/getAllClient' \
--header 'Cookie: PHPSESSID=999egj9j5mnaevhamfu16s90a9' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"1": {
"id": "2",
"nombre": "client 2",
"razon_social": "informatica",
"identificador": null,
"contacts": [],
"address": [
{
"id": "1996",
"nombre": "Direccion 1",
"idpais": "2",
"idprovincia": "11",
"ciudad": "Atizapan de Zaragoza",
"calle": "Av Paseo de zaragoza",
"numero_int": "",
"numero_ext": "52",
"codigo_postal": "0",
"idtipo_domicilio": "0",
"idcliente_od": "2",
"idcontacto_cliente_od": "0",
"latitud": "19.5575007",
"longitud": "-99.2392561",
"estado": "1"
}
]
},
"2": {
"id": "3",
"nombre": "cliente 3",
"razon_social": "mi razon social",
"identificador": null,
"contacts": [],
"address": [
{
"id": "1997",
"nombre": "Direccion 1",
"idpais": "2",
"idprovincia": "11",
"ciudad": "Atizapan de Zaragoza",
"calle": "Paseo de las alamedas",
"numero_int": "",
"numero_ext": "72",
"codigo_postal": "0",
"idtipo_domicilio": "0",
"idcliente_od": "3",
"idcontacto_cliente_od": "0",
"latitud": "19.5509438",
"longitud": "-99.2415031",
"estado": "1"
}
]
},
"3": {
"id": "3870",
"nombre": "Cliente Costa rica",
"razon_social": "N/A",
"identificador": "000000000022",
"contacts": [],
"address": [
{
"id": "2132",
"nombre": "Tienda Costa Rica",
"idpais": "9",
"idprovincia": "219",
"ciudad": "Curridabat",
"calle": "A044",
"numero_int": "",
"numero_ext": "111",
"codigo_postal": "11801",
"idtipo_domicilio": "0",
"idcliente_od": "3870",
"idcontacto_cliente_od": "0",
"latitud": "9.9139642",
"longitud": "-84.0371452",
"estado": "1"
},
{
"id": "2138",
"nombre": "Tienda Costa Rica Centro",
"idpais": "9",
"idprovincia": "219",
"ciudad": "Curridabat",
"calle": "A044",
"numero_int": "",
"numero_ext": "128",
"codigo_postal": "11801",
"idtipo_domicilio": "1",
"idcliente_od": "3870",
"idcontacto_cliente_od": "0",
"latitud": "9.9141155",
"longitud": "-84.0283294",
"estado": "1"
}
]
}
}
}
```
Ver campos de respuesta:
Campo | Descripción
| Formato |
---|
id | Identificador único del cliente. | Entero |
nombre | Nombre del cliente. | Cadena de texto |
razon\_social | Razón social.
| Cadena de texto |
identificador
| Identificador.
| Entero |
contacts
| Contacto del cliente.
| Json
|
address
| Dirección del cliente.
| Json
|
# Listar detalle del pedido - getOrderDetail
##### POST https://api.service24gps.com/api/v1/ondelivery/getOrderDetail
Devuelve el detalle del pedido.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
---|
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
order\_id | Identificador único de la orden. | 5307 |
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'http://dev_api.redgps.com/api/v1/ondelivery/getOrderDetail' \
--header 'Cookie: PHPSESSID=bk9ighpj0cmprh88e7nift0kkb' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
--form 'order_id="5307"'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"id": "5307",
"costo_total": "0",
"timestamp_inicio": "2022-05-12 13:37:00",
"timestamp_fin": "2022-05-15 13:37:00",
"idcliente_od": "27",
"idalmacen_od": "13",
"idstatus_pedido_od": "4",
"subtotal": "0",
"impuesto": "0",
"idmoneda": "57",
"num_factura": "",
"peso_total": "0.00",
"volumen_total": "0.00",
"idcliente_distribuidor": "4220",
"idcliente_sistema": "4221",
"idusuario_sistema": "5163",
"comentarios": "",
"iddomicilio_cliente_od": "436",
"pagado": "0",
"numero_pedido": "0000000046",
"tiempo_servicio": "10",
"cantidad": "0",
"inventario_afectado": "1",
"estado": "1",
"codigo_rastreo": "5608351360120",
"cliente": "Cliente prueba",
"status_pedido": "Cancelado",
"moneda": "EUR",
"idvehiculo_od": null,
"detalle": []
}
}
```
Ver campos de respuesta:
Campo | Descripción
| Formato |
---|
id | Identificador único de la orden. | Entero |
costo\_total
| Costo total.
| Cadena de texto
|
| Fecha inicio. | Timestamp |
| Fecha fin.
| Timestamp
|
idcliente\_od | Identificador único del cliente. | Entero |
idalmacen\_od | Identificador único del almacén. | Entero |
idstatus\_pedido\_od
| Identificador único del pedido.
| Entero |
subtotal
| Subtotal.
| Cadena de texto
|
impuesto
| Impuesto.
| Cadena de texto
|
idmoneda
| Identificador único del tipo de moneda.
| Entero
|
num\_factura
| Número de factura.
| Cadena de texto
|
peso\_total
| Peso total.
| Cadena de texto
|
volumen\_total
| Volumen total.
| Cadena de texto
|
idcliente\_distribuidor
| Identificador único del distribuidor.
| Entero
|
idcliente\_sistema
| Identificador único del cliente.
| Entero
|
idusuario\_sistema
| Identificador único del usuario.
| Entero
|
comentarios | Comentario sobre la orden. | Cadena de texto
|
iddomicilio\_cliente\_od
| Identificador único del domicilio.
| Entero
|
numero\_pedido
| Número del pedido.
| Cadena de texto
|
tiempo\_servicio
| Tiempo del servicio.
| Cadena de texto
|
cantidad
| Cantidad.
| Cadena de texto
|
estado
| Estado de la orden
| Entero
|
codigo\_rastreo
| Código de rastreo.
| Cadena de texto
|
cliente | Nombre del cliente.
| Cadena de texto |
status\_pedido
| Status de la orden.
| Cadena de texto
|
moneda
| Moneda.
| Cadena de texto
|
idvehiculo\_od | Identificador único del vehículo. | Entero |
detalle | detalle de la orden | Array |
# Listar ordenes- getOrders
##### POST https://api.service24gps.com/api/v1/ondelivery/getOrders
Este método lista las ordenes creadas.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
---|
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
begin\_date | Fecha de inicio.
| 2022-05-01 |
end\_date | Fecha fin.
| 2022-05-30 |
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/getOrders' \
--header 'Cookie: PHPSESSID=999egj9j5mnaevhamfu16s90a9' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
--form 'begin_date="2022-05-01"' \
--form 'end_date="2022-05-30"'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": [
{
"id": "5307",
"idcliente_od": "27",
"cliente": "Cliente prueba",
"idstatus_pedido_od": "1",
"status": "Pendiente",
"idmoneda": "57",
"moneda": "EUR",
"timestamp_inicio": "2022-05-12 13:37:00",
"timestamp_fin": "2022-05-15 13:37:00",
"num_factura": "",
"subtotal": "0",
"impuesto": "0",
"costo_total": "0",
"peso_total": "0.00",
"volumen_total": "0.00",
"comentarios": "",
"iddomicilio_cliente_od": "436",
"tiempo_servicio": "10",
"numero_pedido": "0000000046",
"cantidad": "0",
"horario_entrega": "2022-05-12 13:37 - 13:37",
"codigo_rastreo": "5608351360120",
"vehiculo": "Sin activo",
"placa": ""
},
{
"id": "5309",
"idcliente_od": "27",
"cliente": "Cliente prueba",
"idstatus_pedido_od": "1",
"status": "Pendiente",
"idmoneda": "57",
"moneda": "EUR",
"timestamp_inicio": "2022-05-13 13:37:00",
"timestamp_fin": "2022-05-16 13:37:00",
"num_factura": "852526",
"subtotal": "0",
"impuesto": "0",
"costo_total": "0",
"peso_total": "200.00",
"volumen_total": "50.00",
"comentarios": "productos nuevos",
"iddomicilio_cliente_od": "436",
"tiempo_servicio": "10",
"numero_pedido": "0000000048",
"cantidad": "0",
"horario_entrega": "2022-05-13 13:37 - 13:37",
"codigo_rastreo": "5808491360879",
"vehiculo": "Sin activo",
"placa": ""
}
]
}
```
Ver campos de respuesta:
Campo | Descripción
| Formato |
---|
id | Identificador único de la orden. | Entero |
idcliente\_od | Identificador único del cliente. | Entero |
cliente | Nombre del cliente.
| Cadena de texto |
idstatus\_pedido\_od
| Identificador único del pedido.
| Entero |
status
| Status de la orden.
| Cadena de texto
|
idmoneda
| Identificador único del tipo de moneda.
| Entero
|
moneda
| Moneda.
| Cadena de texto
|
| Fecha inicio. | Timestamp |
| Fecha fin.
| Timestamp
|
num\_factura
| Número de factura.
| Cadena de texto
|
subtotal
| Subtotal.
| Cadena de texto
|
impuesto
| Impuesto.
| Cadena de texto
|
costo\_total
| Costo total.
| Cadena de texto
|
peso\_total
| Peso total.
| Cadena de texto
|
volumen\_total
| Volumen total.
| Cadena de texto
|
comentarios | Comentario sobre la orden. | Cadena de texto
|
iddomicilio\_cliente\_od
| Identificador único del domicilio.
| Entero
|
tiempo\_servicio
| Tiempo del servicio.
| Cadena de texto
|
numero\_pedido
| Número del pedido.
| Cadena de texto
|
cantidad
| Cantidad.
| Cadena de texto
|
horario\_entrega
| Horario de entrega.
| Cadena de texto
|
codigo\_rastreo
| Código de rastreo.
| Cadena de texto
|
vehiculo
| Nombre del vehículo.
| Cadena de texto
|
placa
| Placa del vehículo.
| Cadena de texto
|
# Crear orden - createOrder
##### POST https://api.service24gps.com/api/v1/ondelivery/createOrder
Este método permite crear una orden.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
---|
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
inicio | Fecha de inicio.
| 2022-05-01 |
fin | Fecha fin.
| 2022-05-30 |
idcliente\_od | Identificador único del cliente.
| 27 |
idstatus\_pedido\_od | Identificador único del status del pedido.
| 1 |
num\_factura
| Número de factura.
| 852526 |
num\_pedido
| Número de pedido.
| 224
|
comentario
| Comentario sobre el pedido.
| productos nuevos
|
iddomicilio
| Identificador único del domicilio.
| 436
|
pago
| Pago del pedido.
| 0
|
tiempo\_servicio
| Tiempo de servicio.
| 10
|
afecta\_inventario
| Afecta inventario.
| 1
|
idalmacen\_od
| Identificador único del almacén.
| 13
|
detalle
| Detalle de los productos.
| \[{"idproducto\_od":"41","cantidad":"5"}\]
|
peso\_total
| Peso total.
| 200
|
volumen\_total
| Volumen total,
| 50
|
costo\_total
| Costo total.
| 0
|
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/createOrder' \
--header 'Cookie: PHPSESSID=999egj9j5mnaevhamfu16s90a9' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'inicio="2022-05-13 13:37:00"' \
--form 'fin="2022-05-16 13:37:00"' \
--form 'idcliente_od="27"' \
--form 'idstatus_pedido_od="1"' \
--form 'num_factura="852526"' \
--form 'numero_pedido="224"' \
--form 'comentario="productos nuevos"' \
--form 'iddomicilio="436"' \
--form 'pago="0"' \
--form 'tiempo_servicio="10"' \
--form 'afecta_inventario="1"' \
--form 'idalmacen_od="13"' \
--form 'detalle="[{\"idproducto_od\":\"41\",\"cantidad\":\"5\"}]"' \
--form 'peso_total="200"' \
--form 'volumen_total="50"' \
--form 'costo_total="0"'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"id": "5309",
"costo_total": 0,
"timestamp_inicio": "2022-05-13 13:37:00",
"timestamp_fin": "2022-05-16 13:37:00",
"idcliente_od": "27",
"idalmacen_od": "13",
"idstatus_pedido_od": 1,
"subtotal": 0,
"impuesto": 0,
"idmoneda": "57",
"num_factura": "852526",
"peso_total": "200",
"volumen_total": "50",
"idcliente_distribuidor": "4220",
"idcliente_sistema": "4221",
"idusuario_sistema": "5163",
"comentarios": "productos nuevos",
"iddomicilio_cliente_od": "436",
"pagado": 1,
"numero_pedido": "0000000048",
"tiempo_servicio": "10",
"cantidad": 0,
"inventario_afectado": "1",
"estado": 1,
"codigo_rastreo": "5808491360879"
}
}
```
# Editar orden - editOrder
##### POST https://api.service24gps.com/api/v1/ondelivery/editOrder
Este método permite editar una orden.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
---|
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
order\_id | Identificador único de la orden.
| 5309 |
inicio | Fecha de inicio.
| 2022-05-13 13:37:00 |
fin | Fecha fin.
| 2022-05-16 13:37:00 |
idcliente\_od | Identificador único del cliente.
| 27 |
idstatus\_pedido\_od | Identificador único del status del pedido.
| 1 |
num\_factura
| Número de factura.
| 852526 |
num\_pedido
| Número de pedido.
| 224
|
comentario
| Comentario sobre el pedido.
| productos nuevos
|
iddomicilio
| Identificador único del domicilio.
| 436
|
pago
| Pago del pedido.
| 0
|
tiempo\_servicio
| Tiempo de servicio.
| 10
|
afecta\_inventario
| Afecta inventario.
| 1
|
idalmacen\_od
| Identificador único del almacén.
| 13
|
detalle
| Detalle de los productos.
| \[{"idproducto\_od":"41","cantidad":"5"}\]
|
peso\_total
| Peso total.
| 200
|
volumen\_total
| Volumen total,
| 50
|
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/editOrder' \
--header 'Cookie: PHPSESSID=999egj9j5mnaevhamfu16s90a9' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'order_id="5309"' \
--form 'inicio="2022-05-13 13:37:00"' \
--form 'fin="2022-05-16 13:37:00"' \
--form 'idcliente_od="27"' \
--form 'idstatus_pedido_od="1"' \
--form 'num_factura="852526"' \
--form 'numero_pedido="224"' \
--form 'comentario="productos edit nuevos"' \
--form 'iddomicilio="436"' \
--form 'pago="0"' \
--form 'tiempo_servicio="10"' \
--form 'afecta_inventario="1"' \
--form 'idalmacen_od="13"' \
--form 'detalle="[{\"idproducto_od\":\"41\",\"cantidad\":\"3\"}]"' \
--form 'detalle_productos="productos nuevos"' \
--form 'peso_total="200"' \
--form 'volumen_total="50"'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"id": "5309",
"costo_total": 0,
"timestamp_inicio": "2022-05-13 13:37:00",
"timestamp_fin": "2022-05-16 13:37:00",
"idcliente_od": "27",
"idalmacen_od": "13",
"idstatus_pedido_od": 1,
"subtotal": 0,
"impuesto": 0,
"idmoneda": "57",
"num_factura": "852526",
"peso_total": "200",
"volumen_total": "50",
"idcliente_distribuidor": "4220",
"idcliente_sistema": "4221",
"idusuario_sistema": "5163",
"comentarios": "productos edit nuevos",
"iddomicilio_cliente_od": "436",
"pagado": false,
"numero_pedido": "",
"tiempo_servicio": "10",
"cantidad": 0,
"inventario_afectado": "1",
"estado": "1",
"codigo_rastreo": "5808491360879",
"cliente": "cliente x",
"status_pedido": "Pendiente",
"moneda": "EUR",
"idvehiculo_od": null
}
}
```
# Eliminar orden - deleteOrder
##### POST https://api.service24gps.com/api/v1/ondelivery/deleteOrder
Este método permite editar una orden.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
---|
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
order\_id | Identificador único de la orden.
| 5309 |
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'http://dev_api.redgps.com/api/v1/ondelivery/deleteOrder' \
--header 'Cookie: PHPSESSID=bk9ighpj0cmprh88e7nift0kkb' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="SwfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'order_id="5307"'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"status": "ok",
"message": "El pedido ha sido eliminado"
}
}
```
En caso de no encontrarse la orden muestra la siguiente respuesta.
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"status": "error",
"message": "No se encontró el pedido"
}
}
```
# Listar accounts - getAccounts
##### POST https://api.service24gps.com/api/v1/ondelivery/getAccounts
Obtiene el listado de cuentas de los clientes.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
---|
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/getAccounts' \
--header 'Cookie: PHPSESSID=999egj9j5mnaevhamfu16s90a9' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": [
{
"id": "9",
"idcliente_od": "6",
"cliente": "super deux 1",
"idmoneda": "4",
"moneda": "COP",
"saldo": "-10684.56"
},
{
"id": "528",
"idcliente_od": "721",
"cliente": "David Segura",
"idmoneda": "4",
"moneda": "COP",
"saldo": "-343.36"
},
{
"id": "529",
"idcliente_od": "37",
"cliente": "Test propietario",
"idmoneda": "4",
"moneda": "COP",
"saldo": "-487.2"
},
{
"id": "789",
"idcliente_od": "4",
"cliente": "cliente x",
"idmoneda": "57",
"moneda": "EUR",
"saldo": "-3648.2"
}
]
}
```
Ver campos de respuesta:
Campo | Descripción
| Formato |
---|
id | Identificador único del account. | Entero |
idcliente\_od | Identificador único del cliente. | Entero |
cliente | Nombre del cliente
| Cadena de Texto |
idmoneda
| Identificador único de la moneda. | Entero |
moneda
| Moneda.
| Cadena de Texto
|
saldo
| Saldo.
| Flotante
|
# Crear Account - createAccount
##### POST https://api.service24gps.com/api/v1/ondelivery/createAccount
Crea una cuenta para un cliente de OnDelivery ya sea con saldo o sin saldo.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
---|
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
idcliente\_od | Identificador único del cliente. | 4 |
amount | Monto de la cuenta. | 500 |
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'http://dev_api.redgps.com/api/v1/ondelivery/createAccount' \
--header 'Cookie: PHPSESSID=bk9ighpj0cmprh88e7nift0kkb' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idcliente_od="4"' \
--form 'amount="500"'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"account_id": "792"
}
}
```
Ver campos de respuesta:
Campo | Descripción
| Formato |
---|
account\_id | Identificador único del account. | Entero |
# Editar Account - editAccount
##### POST https://api.service24gps.com/api/v1/ondelivery/editAccount
Modifica el monto de una cuenta y registra un movimiento de cuenta.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
---|
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
account\_id | Identificador único de la cuenta. | 792 |
amount | Monto de la cuenta. | 5000 |
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'http://dev_api.redgps.com/api/v1/ondelivery/editAccount' \
--header 'Cookie: PHPSESSID=bk9ighpj0cmprh88e7nift0kkb' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'account_id="792"' \
--form 'amount="5000"'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"account_id": "792"
}
}
```
Ver campos de respuesta:
Campo | Descripción
| Formato |
---|
account\_id | Identificador único del account. | Entero |
# Eliminar Account - deleteAccount
##### POST https://api.service24gps.com/api/v1/ondelivery/deleteAccount
Elimina la cuenta de un cliente y todos los movimientos asociados a la misma.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
---|
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
account\_id | Identificador único de la cuenta. | 792 |
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'http://dev_api.redgps.com/api/v1/ondelivery/editAccount' \
--header 'Cookie: PHPSESSID=bk9ighpj0cmprh88e7nift0kkb' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'account_id="792"' \
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"account": "792"
}
}
```
Ver campos de respuesta:
Campo | Descripción
| Formato |
---|
account | Identificador único del account. | Entero |
# Listar detalle de la cuenta - getAccountDetail
#### POST https://api.service24gps.com/api/v1/ondelivery/getAccountDetail
Obtiene el saldo de la cuenta junto con todos los movimientos realizados.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
---|
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
idcliente | Identificador único del cliente. | 4 |
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'http://dev_api.redgps.com/api/v1/ondelivery/getAccountDetail' \
--header 'Cookie: PHPSESSID=bk9ighpj0cmprh88e7nift0kkb' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
--form 'idcliente_od="4"'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"cuenta": {
"id": "790",
"cliente": "cliente x",
"saldo": "50",
"moneda": "EUR"
},
"movimientos": [
{
"fecha_realizado": "2022-05-13 10:48:00",
"saldo_anterior": "1500",
"monto_operacion": "-1500",
"realizado_por": "DEMO test"
},
{
"fecha_realizado": "2022-05-13 09:39:53",
"saldo_anterior": "0",
"monto_operacion": "3698.2",
"realizado_por": "DEMO test"
}
],
"monto": 3698.2
}
}
```
Ver campos de respuesta:
Campo | Descripción
| Formato |
---|
id | Identificador único del account (cuenta). | Entero |
cliente | Nombre del cliente (cuenta).
| Cadena de Texto |
moneda
| Moneda (cuenta).
| Cadena de Texto
|
saldo
| Saldo (cuenta).
| Flotante
|
fecha\_realizado
| Fecha de movimiento (movimientos).
| Timestamp
|
saldo\_anterior
| Saldo anterior (movimientos).
| Flotante
|
monto\_operacion
| Monto agregado (movimientos).
| Flotante
|
realizado\_por
| Movimiento realizado (movimientos).
| Cadena de Texto
|
monto
| Monto total de la cuenta.
| Flotante
|
# Listar información del dashboard - getDashboardData
POST **https://api.service24gps.com/api/v1/ondelivery/getDashboardData**
Obtiene la información para mostrar en el dashboard.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
---|
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/getDashboardData' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Cookie: PHPSESSID=999egj9j5mnaevhamfu16s90a9' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"deliveries": [],
"orders": [
{
"status": "Pendiente",
"total": "3"
}
],
"clients": [
{
"status": "Con pedido",
"total": 0
},
{
"status": "Sin pedido",
"total": 22
},
{
"status": "Total",
"total": 22
}
],
"vehicles": [
{
"status": "Con entregas",
"total": 0
},
{
"status": "Sin entregas",
"total": 82
},
{
"status": "Total",
"total": 82
}
],
"in_route": []
}
}
```
# Listar almacenes - getAllWareHouse
##### POST https://api.service24gps.com/api/v1/ondelivery/getAllWareHouse
Obtiene todos los almacenes de un distribuidor - cliente.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
---|
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/getAllWareHouse' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Cookie: PHPSESSID=999egj9j5mnaevhamfu16s90a9' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"status": "ok",
"message": {
"0": {
"id": "1",
"nombre": "Almacen del sur",
"idvehiculo": null,
"idcliente_sistema": "4221",
"idcliente_distribuidor": "4220",
"descripcion": "Se encuentra al sur de la ciudad",
"idpais": "2",
"idprovincia": "21",
"ciudad": "Puebla",
"calle": "Av 21 poniente",
"numero_int": "2",
"numero_ext": "3315",
"cp": "72160",
"latitud": "19.0494123",
"longitud": "-98.2281553",
"estado": "1"
},
"1": {
"id": "2",
"nombre": "Almacen del centro",
"idvehiculo": null,
"idcliente_sistema": "4221",
"idcliente_distribuidor": "4220",
"descripcion": "Almacen del centro de la ciudad",
"idpais": "0",
"idprovincia": "0",
"ciudad": "",
"calle": "Av 21 poniente",
"numero_int": "2",
"numero_ext": "3314",
"cp": "72160",
"latitud": "",
"longitud": "",
"estado": "1"
},
"2": {
"id": "3",
"nombre": "Almacen del norte",
"idvehiculo": null,
"idcliente_sistema": "4221",
"idcliente_distribuidor": "4220",
"descripcion": "Almacen del norte de la ciudad",
"idpais": "0",
"idprovincia": "0",
"ciudad": "",
"calle": "Av 21 poniente",
"numero_int": "2",
"numero_ext": "3314",
"cp": "72160",
"latitud": "",
"longitud": "",
"estado": "1"
},
"3": {
"id": "4",
"nombre": "Almacen del noreste",
"idvehiculo": null,
"idcliente_sistema": "4221",
"idcliente_distribuidor": "4220",
"descripcion": "Se encuentra del noreste.....",
"idpais": "0",
"idprovincia": "0",
"ciudad": "",
"calle": "Av 23 Poniente",
"numero_int": "",
"numero_ext": "3000",
"cp": "72180",
"latitud": "",
"longitud": "",
"estado": "1"
}
}
}
}
```
Ver campos de respuesta:
Campo | Descripción
| Formato |
---|
id | Identificador único del almacén. | Entero |
nombre | Nombre del almacén. | Cadena de texto |
idvehiculo | Identificador único del vehículo.
| Entero |
idcliente\_sistema
| Identificador único del cliente.
| Entero |
idcliente\_distribuidor
| Identificador único del distribuidor.
| Entero
|
descripcion
| Descripción del almacén.
| Cadena de texto
|
idpais
| Identificador único del país.
| Entero
|
idprovincia | Identificador único de la provincia. | Entero |
| Nombre de la ciudad.
| Cadena de texto
|
calle
| Calle.
| Cadena de texto
|
numero\_int | Número de interior. | Entero |
numero\_ext | Número de exterior. | Entero |
cp | Código postal. | Cadena de texto |
latitud | Latitud. | Cadena de texto |
longitud | Longitud. | Cadena de texto |
estado | Estado del almacén. | Entero |
# Listar zonas - getAllZones
##### POST https://api.service24gps.com/api/v1/ondelivery/getAllZones
Obtiene todas las zonas de un cliente.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
---|
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/getAllZones' \
--header 'Cookie: PHPSESSID=999egj9j5mnaevhamfu16s90a9' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"status": "ok",
"message": {
"1": {
"id": "2",
"nombre": "Almacen Centro",
"descripcion": "Se encuentra en el centro de la ciudad",
"almacen": "Almacen del sur",
"idalmacen": "1"
},
"2": {
"id": "3",
"nombre": "Almacen Norte.",
"descripcion": "Se encuentra al Norte de la ciudad",
"almacen": "Almacen del sur",
"idalmacen": "1"
},
"3": {
"id": "4",
"nombre": "Almacen Oestre",
"descripcion": "Se encuentra al sur de la ciudad",
"almacen": "Almacen del sur",
"idalmacen": "1"
}
}
}
}
```
Ver campos de respuesta:
Campo | Descripción
| Formato |
---|
id | Identificador único de la zona | Entero |
nombre | Nombre de la zona. | Cadena de texto |
descripcion | Descripción de la zona.
| Cadena de texto |
almacen
| Nombre del almacén.
| Cadena de texto |
idalmacen
| Identificador único del almacén.
| entero
|
# Listar contactos - getAllContactClient
POST **https://api.service24gps.com/api/v1/ondelivery/getAllContactClient**
Obtiene todos los contactos de un cliente.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
---|
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
idcliente | Identificador único del cliente. | 5 |
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/getAllContactClient' \
--header 'Cookie: PHPSESSID=999egj9j5mnaevhamfu16s90a9' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
--form 'idcliente="5"'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"status": "ok",
"message": [
{
"id": "56",
"nombre": "Maria Dolores",
"notas": "RH",
"idcliente_od": "5",
"datos_contacto": "{\"2\":[\"55443322\"],\"4\":[\"ma@gmail.com\"]}",
"estado": "1"
},
{
"id": "57",
"nombre": "Marco",
"notas": "Test",
"idcliente_od": "5",
"datos_contacto": "{\"2\":[\"222275546\"]}",
"estado": "1"
},
{
"id": "208",
"nombre": "Jose Maria",
"notas": "",
"idcliente_od": "5",
"datos_contacto": "{\"2\":[\"66332200\"],\"4\":[\"jmaria@hotmail.com\"]}",
"estado": "1"
},
{
"id": "209",
"nombre": "Juliana Hernandez",
"notas": "",
"idcliente_od": "5",
"datos_contacto": "{\"3\":[\"2223635958\"]}",
"estado": "1"
},
{
"id": "343",
"nombre": "Contacto x",
"notas": "",
"idcliente_od": "5",
"datos_contacto": "{\"3\":[\"1234567890\"],\"4\":[\"my_fake_email@xdxd.com\"]}",
"estado": "1"
}
]
}
}
```
Ver campos de respuesta:
Campo | Descripción
| Formato |
---|
id | Identificador único del contacto. | Entero |
nombre | Nombre del contacto. | Cadena de texto |
notas | Notas.
| Cadena de texto |
idcliente\_od
| Identificador único del cliente.
| Entero |
datos\_contacto
| Datos del contacto.
| Json
|
estado
| Estado
| Entero
|
# Listar información del contacto - getInfoContact
##### POST https://api.service24gps.com/api/v1/ondelivery/getInfoContact
Obtiene la información de un contacto.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
---|
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
idcontacto | Identificador único del contacto. | 56 |
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/getInfoContact' \
--header 'Cookie: PHPSESSID=999egj9j5mnaevhamfu16s90a9' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idcontacto="56"'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"status": "ok",
"message": {
"nombre": "Maria Dolores",
"notas": "RH",
"telefono": "55443322",
"email": "ma@gmail.com"
}
}
}
```
Ver campos de respuesta:
Campo | Descripción
| Formato |
---|
nombre | Nombre del contacto. | Cadena de texto |
notas | Notas.
| Cadena de texto |
telefono
| Teléfono del contacto.
| Cadena de texto |
email
| Email del contacto.
| Cadena de texto
|
# Listar opciones del vehículo - getOptionsVehicle
POST **https://api.service24gps.com/api/v1/ondelivery/getOptionsVehicle**
Obtiene las opciones del vehículo.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
---|
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
idvehiculo | Identificador único del vehículo. | 37922 |
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/getOptionsVehicle' \
--header 'Cookie: PHPSESSID=999egj9j5mnaevhamfu16s90a9' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idvehiculo="37922"'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"status": "ok",
"message": {
"0": {
"id": "6",
"idvehiculo": "37922",
"peso_maximo": "1500.00",
"volumen_maximo": "800.00",
"tipo_lugar_salida": "LUGAR",
"lugar_salida": "36609",
"unidad_peso": "0",
"unidad_volumen": "0",
"cantidad": "0",
"idtipo_activo_producto_od": null,
"inicio_labores": "06:00:00",
"fin_labores": "22:00:00",
"datos_tipo_activo": "{}",
"tipo_carga": "1"
}
}
}
}
```
Ver campos de respuesta:
Campo | Descripción
| Formato |
---|
id | Identificador único. | Entero |
idvehiculo | Identificador único del vehículo. | Entero |
peso\_maximo | Peso máximo.
| Flotante |
volumen\_maximo
| Volumen máximo
| Flotante |
tipo\_lugar\_salida
| Tipo del lugar.
| Cadena de texto
|
unidad\_peso
| Unidad de peso.
| Entero
|
unidad\_volumen
| Unidad de volumen.
| Entero
|
cantidad
| Cantidad.
| Entero
|
idtipo\_activo\_producto\_od
| Identificador único del tipo activo.
| Entero
|
inicio\_labores
| Fecha de inicio.
| time
|
fin\_labores
| Fecha fin.
| time
|
datos\_tipo\_activo
| Datos del tipo activo.
| Json
|
tipo\_carga
| Tipo de carga.
| Entero
|
# Listar inventarios - getInventories
##### POST https://api.service24gps.com/api/v1/ondelivery/getInventories
Obtiene los inventarios de un cliente - distribuidor.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
---|
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/getInventories' \
--header 'Cookie: PHPSESSID=999egj9j5mnaevhamfu16s90a9' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"status": "ok",
"message": {
"1": {
"id": "2",
"idcliente_distribuidor": "4220",
"idcliente_sistema": "4221",
"idalmacen_od": "0",
"idzona_od": "2",
"idproducto_od": "1",
"cantidad": "75",
"subtotal": "4650",
"total": "5394",
"impuesto": "744",
"idmoneda": "2",
"timestamp": "2020-06-25 16:11:08",
"estado": "1",
"nombre_zona": "Almacen Centro",
"nombre_almacen": null,
"nombre_producto": "Mi Prodducto 1.1",
"nombre_moneda": "MXN",
"idproducto": "1"
},
"2": {
"id": "3",
"idcliente_distribuidor": "4220",
"idcliente_sistema": "4221",
"idalmacen_od": "0",
"idzona_od": "2",
"idproducto_od": "2",
"cantidad": "79",
"subtotal": "8295",
"total": "9622.2",
"impuesto": "1327.2",
"idmoneda": "2",
"timestamp": "2020-06-25 16:11:23",
"estado": "1",
"nombre_zona": "Almacen Centro",
"nombre_almacen": null,
"nombre_producto": "Mi Prodducto 2",
"nombre_moneda": "MXN",
"idproducto": "2"
},
"3": {
"id": "4",
"idcliente_distribuidor": "4220",
"idcliente_sistema": "4221",
"idalmacen_od": "0",
"idzona_od": "2",
"idproducto_od": "5",
"cantidad": "74",
"subtotal": "6364",
"total": "7382.24",
"impuesto": "1018.24",
"idmoneda": "2",
"timestamp": "2020-07-02 17:43:30",
"estado": "1",
"nombre_zona": "Almacen Centro",
"nombre_almacen": null,
"nombre_producto": "Mi Prodducto 5",
"nombre_moneda": "MXN",
"idproducto": "5"
}
}
}
}
```
Ver campos de respuesta:
Campo | Descripción
| Formato |
---|
id | Identificador único del inventario. | Entero |
idcliente\_distribuidor | Identificador único del distribuidor. | Entero |
idcliente\_sistema | Identificador único del cliente.
| Entero |
idalmacen\_od
| Identificador único del almacén.
| Entero |
cantidad
| Cantidad.
| Entero
|
subtotal
| Subtotal.
| Entero
|
total
| Total.
| Flotante
|
impuesto
| Impuesto
| Flotante
|
idmoneda
| Identificador único de la moneda.
| Entero
|
timestamp
| Tiempo.
| TimeStamp
|
estado
| Estado.
| Entero
|
nombre\_zona
| Nombre de la zona.
| Cadena de texto
|
nombre\_almacen
| Nombre del almacén.
| Cadena de texto
|
nombre\_producto
| Nombre del producto.
| Cadena de texto
|
nombre\_moneda
| Nombre de la moneda.
| Cadena de texto
|
idproducto
| Identificador único del producto. | Entero
|
# Listar pedidos - getDelivers
##### POST https://api.service24gps.com/api/v1/ondelivery/getDelivers
Este método lista los pedidos del cliente.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
---|
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
begin\_date | Fecha de inicio.
| 2022-05-01 |
end\_date | Fecha fin.
| 2022-05-30 |
add\_past\_orders | -Mostrar pedidos pasados cuando no hay en la fecha solicitada: **1**
-Mostrar solo pedidos con la fecha indicada: 0
| 0 |
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/getDelivers' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Cookie: PHPSESSID=999egj9j5mnaevhamfu16s90a9' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
--form 'begin_date="2022-05-01"' \
--form 'end_date="2022-05-30"' \
--form 'add_past_orders=1'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"message": "Mostrando entregas del día seleccionado",
"deliveries": [
{
"id": "420",
"comentarios": "",
"timestamp_inicio": "2021-04-10 09:00:00",
"timestamp_fin": "2021-04-10 18:00:00",
"idformulario": "15",
"idvehiculo_od": "6",
"idvehiculo": "37922",
"idconductor": "25731",
"peso_maximo": "1500.00",
"volumen_maximo": "800.00",
"lugar_salida": "36609",
"tipo_lugar_salida": "LUGAR",
"pedidos": [
{
"order_id": "3850",
"id_form": "0",
"comments": "",
"timestamp": "2021-04-07 17:14:00",
"status_order": "5",
"orden_entrega": "1",
"iddomicilio_cliente_od": "1995",
"numero_pedido": "",
"codigo_rastreo": "0817131360451",
"subtotal": "103.44",
"impuesto": "16.56",
"costo_total": "120",
"cantidad": "0",
"volumen": "12.00",
"peso": "12.00",
"nombre_cliente": "client 1.1",
"idcliente_od": "1"
}
],
"salida_iniciada": true
},
{
"id": "405",
"comentarios": "",
"timestamp_inicio": "2021-03-26 09:00:00",
"timestamp_fin": "2021-03-26 18:00:00",
"idformulario": "0",
"idvehiculo_od": "6",
"idvehiculo": "37922",
"idconductor": "25731",
"peso_maximo": "1500.00",
"volumen_maximo": "800.00",
"lugar_salida": "36609",
"tipo_lugar_salida": "LUGAR",
"pedidos": [
{
"order_id": "3796",
"id_form": "0",
"comments": "",
"timestamp": "2021-03-26 14:44:51",
"status_order": "7",
"orden_entrega": "3",
"iddomicilio_cliente_od": "666",
"numero_pedido": "",
"codigo_rastreo": "3412171360495",
"subtotal": "296",
"impuesto": "47.36",
"costo_total": "343.36",
"cantidad": "0",
"volumen": "172.00",
"peso": "399.96",
"nombre_cliente": "David Segura",
"idcliente_od": "721"
},
{
"order_id": "3797",
"id_form": "0",
"comments": "",
"timestamp": "2021-03-26 14:44:50",
"status_order": "8",
"orden_entrega": "1",
"iddomicilio_cliente_od": "434",
"numero_pedido": "",
"codigo_rastreo": "1312181360628",
"subtotal": "600",
"impuesto": "96",
"costo_total": "696",
"cantidad": "0",
"volumen": "90.00",
"peso": "299.97",
"nombre_cliente": "super deux 1",
"idcliente_od": "6"
},
{
"order_id": "3798",
"id_form": "0",
"comments": "",
"timestamp": "2021-03-26 14:44:51",
"status_order": "2",
"orden_entrega": "2",
"iddomicilio_cliente_od": "1994",
"numero_pedido": "",
"codigo_rastreo": "1812201360512",
"subtotal": "420",
"impuesto": "67.2",
"costo_total": "487.2",
"cantidad": "0",
"volumen": "356.00",
"peso": "399.96",
"nombre_cliente": "Test propietario",
"idcliente_od": "37"
}
],
"salida_iniciada": true
}
]
}
}
```
Ver campos de respuesta:
Campo | Descripción
| Formato |
---|
id | Identificador único de la orden. | Entero |
comentarios | Comentario sobre la orden. | Cadena de texto
|
| Fecha inicio. | Timestamp |
| Fecha fin.
| Timestamp
|
| Identificador único del formulario.
| Entero
|
| Identificador único del vehículo od.
| Entero
|
| Identificador único del vehículo.
| Entero
|
| Identificador único del conductor.
| Entero
|
peso\_maximo
| Peso máximo.
| Flotante
|
volumen\_maximo
| Volumen máximo.
| Flotante
|
lugar\_salida
| Identificador único del lugar.
| Entero
|
tipo\_lugar\_salida
| Tipo del lugar.
| Cadena de texto
|
pedidos
| Detalle del pedido
| Json
|
salida\_iniciada | Salida iniciada. | Bolean |
# Listar vehículos - vehicleGetAllComplete
POST **https://api.service24gps.com/api/v1/ondelivery/vehicleGetAllComplete**
Este método devuelve el listado de los vehículos.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
---|
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/vehicleGetAllComplete' \
--header 'Cookie: PHPSESSID=6g5p2n9vso19j8vgdc9fcuind1' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": [
{
"id": "13952",
"nombre": "Activo Simulado 1...",
"patente": "MYA-4323",
"idgps": "19567",
"gatewayip": "107.170.254.11",
"conductor": "",
"grupo": null,
"marca": "Porsche",
"modelo": "911",
"color": "",
"anio": "1967",
"numero_serie": "1234567890",
"tipo_vehiculo": "Automovil",
"latitud_salida": "",
"longitud_salida": ""
},
{
"id": "13953",
"nombre": "Lancer123",
"patente": "POP-1234",
"idgps": null,
"gatewayip": null,
"conductor": "Juan Pedro Lopez Diaz",
"grupo": "prueba grupo 2",
"marca": "RAM",
"modelo": "Lancer",
"color": "",
"anio": "2015",
"numero_serie": "1234567890",
"tipo_vehiculo": "Camion",
"latitud_salida": "19.027047",
"longitud_salida": "-98.207274"
},
{
"id": "13954",
"nombre": "Activo Simulado 3",
"patente": "TXT-123",
"idgps": "123123123125",
"gatewayip": "",
"conductor": "",
"grupo": "Grupo NOrte",
"marca": "",
"modelo": "Civic Type R",
"color": "",
"anio": "2018",
"numero_serie": "1234567890",
"tipo_vehiculo": "",
"latitud_salida": "",
"longitud_salida": ""
},
{
"id": "181677",
"nombre": "PRUEBATIPOCOMANDO_",
"patente": "",
"idgps": "PRUEBATIPOCOMANDO",
"gatewayip": "",
"conductor": "",
"grupo": null,
"marca": "",
"modelo": "",
"color": "",
"anio": "0",
"numero_serie": "",
"tipo_vehiculo": "Automovil",
"latitud_salida": "",
"longitud_salida": ""
}
]
}
```
Ver campos de respuesta:
Campo | Descripción
| Formato |
---|
id | Identificador único del vehículo. | Entero |
nombre | Nombre asignado al vehículo | Cadena de Texto |
patente | Patente del vehículo
| Cadena de Texto |
idgps
| identificador gps
| Entero |
gatewayip
| ip del gateway
| Cadena de Texto
|
conductor
| Nombre del conductor
| Cadena de Texto
|
grupo
| Nombre del grupo
| Cadena de Texto
|
marca
| Marca del vehículo | Cadena de Texto
|
modelo
| Modelo del vehículo
| Cadena de Texto
|
color
| Color de vehículo
| Cadena de Texto
|
anio
| Año del vehículo
| Cadena de Texto
|
numero\_serie
| Numero de serie
| Cadena de Texto
|
latitud\_salida
| latitud
| Cadena de Texto
|
longitud\_salida
| longitud
| Cadena de texto
|
# Listar status - getStatuses
##### POST https://api.service24gps.com/api/v1/ondelivery/getStatuses
Este método devuelve los status que puede tener un pedido.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
---|
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/getStatuses' \
--header 'Cookie: PHPSESSID=6g5p2n9vso19j8vgdc9fcuind1' \
--form 'apikey="9e815ce8b91e40379407320cd0a13a98"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": [
{
"id": "1",
"nombre": "Pendiente"
},
{
"id": "2",
"nombre": "En tránsito"
},
{
"id": "3",
"nombre": "Entregado"
},
{
"id": "4",
"nombre": "Cancelado"
},
{
"id": "5",
"nombre": "Programado para entrega"
},
{
"id": "6",
"nombre": "Cliente no encontrado"
},
{
"id": "7",
"nombre": "Entregado y confirmado"
},
{
"id": "8",
"nombre": "En proceso de entrega"
}
]
}
```
# Obtener latitud y longitud - getPositionFromAddress
POST **https://api.service24gps.com/api/v1/ondelivery/getPositionFromAddress**
Obtener latitud y longitud a través del domicilio.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
---|
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
address | Domicilio.
| Av. Paseo de la Reforma, Juárez, Cuauhtémoc, 06500 Ciudad de México, CDMX |
##### Solicitud de ejemplo:
```shell
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/getPositionFromAddress' \
--header 'Cookie: PHPSESSID=999egj9j5mnaevhamfu16s90a9' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
--form 'address="Av. Paseo de la Reforma, Juárez, Cuauhtémoc, 06500 Ciudad de México, CDMX"'
```
##### Respuesta de ejemplo:
```JSON
{
"status": 200,
"data": {
"lat": 19.42911,
"lng": -99.16227
}
}
```
Ver campos de respuesta:
Campo | Descripción
| Formato |
---|
lat | Latitud | Cadena de texto
|
| Longitud | Cadena de texto |