logo
API docs by Redocly

staging-api.tizo.co (1.0.0)

Download OpenAPI specification:Download

E-mail: rcastano@tizo.app URL: https://www.linkedin.com/company/tizo/ License: Apache 2.0 Terms of Service

Introducción

Esta API contiene todas las funcionalidades de envíos que usted necesita para integrarla en su negocio, en caso de que usted no tenga un sistema existente, le recomendamos que use las apps pronto disponibles en Play Store, Apple Store o se contacte con nosotros y les proveeremos sus credenciales. Entre las principales funcionalidades se encuentran:

  • Creación de envíos usando los distintos aliados de Tizo.
  • Seguimiento en tiempo real, así como el historial de los envíos realizados.
  • Métricas de su negocio, así como algunas variables de su interés.

Además, en el contexto de nuestro sistema, trabajamos con dos entornos distintos: desarrollo y producción. Estos entornos se utilizan para realizar pruebas y desplegar la aplicación final, respectivamente. Para acceder a la funcionalidad de la API en cada uno de estos entornos, es necesario utilizar los enlaces adecuados.

  1. staging-api.tizo.co: Este enlace está configurado para apuntar al entorno de desarrollo de nuestra API. Cuando accedes a staging-api.tizo.co, estás interactuando con una versión de la API que se encuentra en desarrollo activo. Este entorno es utilizado principalmente por los desarrolladores y el equipo de pruebas para probar nuevas funcionalidades, realizar pruebas exhaustivas y detectar posibles errores o problemas antes de implementar los cambios en el entorno de producción. Es importante tener en cuenta que el entorno de desarrollo (staging-api.tizo.co) puede ser inestable en comparación con el entorno de producción, ya que se encuentra en constante desarrollo. Por lo tanto, si estás trabajando con staging-api.tizo.co, ten en cuenta que podrías encontrar errores o comportamientos no deseados que aún no han sido corregidos.

  2. api.tizo.co: Este enlace está configurado para apuntar al entorno de producción de nuestra API. Cuando accedes a api.tizo.com, estás interactuando con la versión estable y finalizada de nuestra API que se utiliza en producción. Este entorno se utiliza para brindar servicio a los usuarios finales y a las aplicaciones en producción que dependen de la API. En el entorno de producción (api.tizo.co), se espera que la API sea estable y libre de errores graves. Se realizan pruebas exhaustivas en el entorno de desarrollo antes de desplegar los cambios en producción, con el objetivo de garantizar la calidad y confiabilidad de la API en este entorno.

Es crucial tener en cuenta la diferencia entre estos dos enlaces y utilizar el enlace correcto según tus necesidades. Si estás desarrollando o realizando pruebas en tu aplicación, deberías utilizar staging-api.tizo.co para interactuar con la API en el entorno de desarrollo. Sin embargo, si estás utilizando tu aplicación en un entorno de producción, asegúrate de utilizar api.tizo.co para acceder a la API estable en producción y proporcionar un servicio confiable a tus usuarios finales.

Comúniquese con nosotros

  • Correos: Para contactarse con el equipo de tizo, escriba un correo a los siguientes e-mails rcastano@tizo.app y a axel.garcia@tizo.app en caso de algún inconveniente con la API.
  • Síguenos en las siguientes plataformas para estar al tanto de las últimas mejoras y novedades: Facebook, Twitter, Instagram.

Run in Postman

Aclaraciones importantes

Headers

Para un mejor uso de nuestra API, debes de tomar en cuenta que cada request que se haga, se recibe los siguientes headers.

Clave Valor
Authorization Token
Content-Type application/json
Accept-Language es, en
User-Agent Navegador donde procede la solicitud

Autenticación.

Para obtener el valor del token necesitas realizar un POST request hacia https://staging-api.tizo.co/api/v1/auth/login con el siguiente body:
{
"username": "your_username",
"password": "your_password",
"typeUser": "store_api"
}

Autenticación

Cambiar contraseña

Este endpoint te permite cambiar la contraseña de un usuario ya logueado. Para hacerlo necesitas registrar la antigua contraseña y la nueva contraseña que deseas tener. El mensaje de respuesta estará compuesto por el tipo de usuario y la información del usuario que acaba de cambiar su contraseña.

Request Body schema: application/json

Estructura de datos para cambiar contraseña

password
required
string <password> >= 2 characters

Nueva Contraseña

oldPassword
required
string <password> >= 2 characters

Antigua Contraseña

Responses

Request samples

Content type
application/json
{
  • "password": "nuevacontra",
  • "oldPassword": "antiguacontra"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Se han actualizado las credenciales de acceso.",
  • "status": 200
}

Inicio de sesión

Este método te permite iniciar sesión con un nombre de usuario, una contraseña y un tipo de usuario

Request Body schema: application/json

Estructura de datos para iniciar sesión

username
required
string

Username del usuario

password
required
string non-empty

Contraseña del usuario

typeUser
required
string
Enum: "store" "store_api"

Establece que tipo de usuario

Responses

Request samples

Content type
application/json
{
  • "username": "username12",
  • "password": "contraseña",
  • "typeUser": "store"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Hello!",
  • "status": 200
}

Recuperar contraseña

Este método te permite recuperar la cuenta si se ha olvidado los datos de inicio de sesión de la misma, lo que se necesitaría son 3 datos; el tipo de método por el que deseas recuperarlo, el tipo de usuario y un dato que puede ser el correo, usuario o teléfono. Dependiendo del método que ha seleccionado para la recuperación de la contraseña se le enviará un link a su correo o teléfono para que pueda restablecer su contraseña.

Request Body schema: application/json

Estructura de datos para recuperar la cuenta.

method
required
string
Enum: "email" "sms"

Método para recuperar la contraseña

wordToMatch
required
string
Enum: "your_email" "your_username" "your_phonenumber"

Palabra que debe coincidir con la palabra de recuperación

typeUser
required
string

Tipo de usuario

Responses

Request samples

Content type
application/json
{
  • "method": "email",
  • "wordToMatch": "m_yoni3",
  • "typeUser": "vendor"
}

Response samples

Content type
application/json
{
  • "message": "Se ha enviado las instrucciones para recuperar la contraseña.",
  • "status": 200
}

Refrescar token

Este método necesita el token anterior para poder obtener un token nuevo. Adicionalmente, se sobre entiende que tiene la misma duración que el primer token obtenido (una semana).

Request Body schema: application
any

Este método no solicita ningún dato de entrada

Responses

Request samples 

var client = new RestClient("https://staging-api.tizo.co/api/v1/auth/refresh-token/");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "eyJhbGciOiJIUzUxMiJ9.eyJyb2xlIjoic3RvcmVfYXBpIiwidXNlcm5hbWUiOiJzdG9yZV8xMSIsImlhdCI6MTY2ODE4MDY3MywiZXhwIjoxNjY4Nzg1NDczfQ.Epg1NeTr_R2de8jUQW-B2eJxyEFpC00CaJMmxsHHFbP9tkHBWhU7eTLIe47GHWchyy_-z-WthaloG92yFeblHg");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Response samples

Content type
application/json
{
  • "message": "Token aún vigente!!",
  • "status": 200
}

Envíos

Buscar envío por código de envío

Este método te permite buscar un envío por medio de su código de envío y devuelve los datos del mismo.

query Parameters
codeDelivery
string
Example: codeDelivery=5443185F-3FD5-42B1-AF56-4A3128E996A7

Código del envío

Request Body schema: application
any

Este método no solicita ningún dato de entrada

Responses

Request samples 

var client = new RestClient("https://staging-api.tizo.co/api/v1/delivery/get/?codeDelivery=5443185F-3FD5-42B1-AF56-4A3128E996A7");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "eyJhbGciOiJIUzUxMiJ9.eyJyb2xlIjoic3RvcmVfYXBpIiwidXNlcm5hbWUiOiJzdG9yZV8xMSIsImlhdCI6MTY2ODE4MDY3MywiZXhwIjoxNjY4Nzg1NDczfQ.Epg1NeTr_R2de8jUQW-B2eJxyEFpC00CaJMmxsHHFbP9tkHBWhU7eTLIe47GHWchyy_-z-WthaloG92yFeblHg");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Envio encontrado",
  • "status": 200
}

Buscar envío por Id

Este método te permite buscar un envío por medio de su Id y devuelve los datos del mismo.

query Parameters
idDelivery
string
Example: idDelivery=304

Id del envío

Request Body schema: application
any

Este método no solicita ningún dato de entrada

Responses

Request samples 

var client = new RestClient("https://staging-api.tizo.co/api/v1/delivery/get/?idDelivery=304");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "eyJhbGciOiJIUzUxMiJ9.eyJyb2xlIjoic3RvcmVfYXBpIiwidXNlcm5hbWUiOiJzdG9yZV8xMSIsImlhdCI6MTY2ODE4MDY3MywiZXhwIjoxNjY4Nzg1NDczfQ.Epg1NeTr_R2de8jUQW-B2eJxyEFpC00CaJMmxsHHFbP9tkHBWhU7eTLIe47GHWchyy_-z-WthaloG92yFeblHg");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Envio encontrado",
  • "status": 200
}

Crear un envío

Este método te permite crear un envío. Es importante destacar colocar la categoría correcta, puesto que dependiendo de ella se notifican a los couriers que aceptan esta categoría. No se debitará el envío hasta que se confirme la orden.

Request Body schema: application/json

Estructura de datos para la creación de un envío, en caso de que el usuario no pague con tarjeta de crédito.

idStore
integer

ID de la tienda

idBranchStore
integer

ID de la sucursal de la tienda

description
string

Descripción del envío

Array of objects

Puntos de recogida y entrega

Array of objects
customerName
string

Nombre del cliente

customerPhone
string

Teléfono del cliente

customerEmail
string

Correo electrónico del cliente

deliveryTime
string <date-time>

Fecha y hora de entrega

deliveryTimeInMilliseconds
integer

Tiempo de entrega en milisegundos

imagePreview
string <uri>

URL de la imagen de previsualización

collectMoney
number

Monto a cobrar

isTest
boolean

Indica si es una prueba

lineBusiness
string

Línea de negocio

object
totalValue
number

Valor total

Responses

Request samples

Content type
application/json
{
  • "idStore": 1,
  • "idBranchStore": 1,
  • "description": "Envío desde la App",
  • "waypoints": [
    ],
  • "items": [
    ],
  • "customerName": "Agapito Díaz",
  • "customerPhone": "5512345678",
  • "customerEmail": "tucorreo@correo.com",
  • "deliveryTime": "2022-04-22T12:10:32Z",
  • "deliveryTimeInMilliseconds": 1212121212,
  • "imagePreview": "https://www.google.com.mx/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png",
  • "collectMoney": 100,
  • "isTest": false,
  • "lineBusiness": "LOGISTICS",
  • "selectedMethod": {
    },
  • "totalValue": 0
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Envío Creado",
  • "status": 200
}

Crear un envío con pago en tarjeta de crédito

Este método te permite crear un envío. Es importante destacar colocar la categoría correcta, puesto que dependiendo de ella se notifican a los couriers que aceptan esta categoría. No se debitará el envío hasta que se confirme la orden.

Request Body schema: application/json

Estructura de datos para la creación de un envío, en caso de que el usuario pague con tarjeta de crédito.

idStore
integer

Id de la tienda

idBranchStore
integer

Id de la sucursal de la tienda

customerEmail
string

Correo Electrónico del cliente

deliveryTypeCode
string

Código del tipo de envío

description
string

Descripción del envío

isTest
boolean

El envío es de prueba

Array of objects
object
Array of objects

Responses

Request samples

Content type
application/json
{
  • "idStore": 3,
  • "idBranchStore": 3,
  • "customerEmail": "john.smith@example.com",
  • "deliveryTypeCode": "DELIVERY",
  • "description": "Con descripcion",
  • "isTest": true,
  • "items": [
    ],
  • "selectedMethod": {
    },
  • "waypoints": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Envío Creado",
  • "status": 200
}

Confirmar un envío

Este método te permite confirmar el envío y así empezar el flujo de los procesos.

query Parameters
codeDelivery
string
Example: codeDelivery=5443185F-3FD5-42B1-AF56-4A3128E996A7

Código del envío

Request Body schema: application
any

Este método no solicita ningún dato de entrada

Responses

Request samples 

var client = new RestClient("https://staging-api.tizo.co/api/v1/delivery/confirm/6ce15dac-83d2-4631-a32d-12b753da8fbc");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "eyJhbGciOiJIUzUxMiJ9.eyJyb2xlIjoidmVuZG9yIiwidXNlcm5hbWUiOiJ2X2dhYnJpZWxfNiIsImlhdCI6MTY1NzgwOTQ2MSwiZXhwIjoxNjU4NDE0MjYxfQ.N_rPvlIFgpj_mK8mcWzDbKEgud6bJeSNc5cOKqzyYTvWeCqStlzUCQjeyoNt98GwqpEU-4jdI35jMk83bahzpg");
request.AddHeader("Content-Type", "application/json");
var body = @"{}";
request.AddParameter("application/json", body,  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Envío confirmado.",
  • "status": 200
}

Estimar un envío

Este método te permite estimar los gastos del envío. Es importante destacar colocar la categoría correcta, puesto que dependiendo de ella se notifican a los couriers que aceptan esta categoría.

Request Body schema: application/json

Estructura de datos para la estimación de un envio

type
string

Tipo de solicitud

Array of objects
Array of objects
deliveryTime
string

Hora de entrega

isTest
boolean

Indica si es una prueba

idStore
integer

ID de la tienda

collectMoney
number <float>

Dinero a recoger

lineBusiness
string

Línea de negocio

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "waypoints": [
    ],
  • "items": [
    ],
  • "deliveryTime": "string",
  • "isTest": true,
  • "idStore": 0,
  • "collectMoney": 0,
  • "lineBusiness": "string"
}

Response samples

Content type
application/json
{
  • "messages": [
    ],
  • "status": 0,
  • "data": {
    }
}

Listar todos tus envíos

Este método te permite visualizar todos los envíos realizados por el usuario.

Request Body schema: application
any

Este método no solicita ningún dato de entrada

Responses

Request samples 

var client = new RestClient("https://staging-api.tizo.co/api/v1/delivery/");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "eyJhbGciOiJIUzUxMiJ9.eyJyb2xlIjoidmVuZG9yIiwidXNlcm5hbWUiOiJ2X2dhYnJpZWxfNiIsImlhdCI6MTY1NzgwOTQ2MSwiZXhwIjoxNjU4NDE0MjYxfQ.N_rPvlIFgpj_mK8mcWzDbKEgud6bJeSNc5cOKqzyYTvWeCqStlzUCQjeyoNt98GwqpEU-4jdI35jMk83bahzpg");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Envíos encontrados",
  • "status": 200
}

Información de los envíos y paquetes

Buscar un estado de envío

Este método te permite buscar un estado del envío por medio de su Id y devuelve los datos del mismo.

path Parameters
idStatusDelivery
required
string

ID del estado del envío

Request Body schema: application
any

Este método no solicita ningún dato de entrada

Responses

Request samples 

var client = new RestClient("https://staging-api.tizo.co/api/v1/system-data/status-deliveries/1/");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "eyJhbGciOiJIUzUxMiJ9.eyJyb2xlIjoic3RvcmVfYXBpIiwidXNlcm5hbWUiOiJzdG9yZV8yIiwiaWF0IjoxNjU4MTU0Mjc3LCJleHAiOjE2NTg3NTkwNzd9.u6b7ap-7vYikiIBwJ8ugj7rTM_0nVkuMXVlI-Mz7ayXmPT661F9--p-QfbcOcPtewQliHWqktS5P8YYNgPH3uA");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Estado del envío encontrado",
  • "status": 200
}

Buscar un paso del envío

Este método te permite buscar un paso del envío por medio de su Id y devuelve los datos del mismo.

path Parameters
idStepDeliveries
required
string

ID del paso del envío

Request Body schema: application
any

Este método no solicita ningún dato de entrada

Responses

Request samples 

var client = new RestClient("https://staging-api.tizo.co/api/v1/system-data/steps-deliveries/36/");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "eyJhbGciOiJIUzUxMiJ9.eyJyb2xlIjoic3RvcmVfYXBpIiwidXNlcm5hbWUiOiJzdG9yZV8yIiwiaWF0IjoxNjU4MTU0Mjc3LCJleHAiOjE2NTg3NTkwNzd9.u6b7ap-7vYikiIBwJ8ugj7rTM_0nVkuMXVlI-Mz7ayXmPT661F9--p-QfbcOcPtewQliHWqktS5P8YYNgPH3uA");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Paso del envío encontrado",
  • "status": 200
}

Listar capacidades de envío

Este método te permite visualizar todos las capacidades de envío registrados en el sistema.

Authorizations:
None
Request Body schema: application
any

Este método no solicita ningún dato de entrada

Responses

Request samples 

var client = new RestClient("http://staging-api.tizo.co/api/v1/system-data/capacities/");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "eyJhbGciOiJIUzUxMiJ9.eyJyb2xlIjoidmVuZG9yIiwidXNlcm5hbWUiOiJ2X2FkcmlhbmFfOSIsImlhdCI6MTY4NjU4MzM4MCwiZXhwIjoxNjkxODY3MzgwfQ.8AaS0pzsWQhar3y-c04gXiZUQ18K5voz2n_8G0SFItXgnp21kb9Eg-0a27dCEVAL60f0fU6gLhoJeKouEBufFg");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Paso del envío encontrado",
  • "status": 200
}

Listar capacidades de envío dependiendo de las categoría seleccionada

Este método te permite visualizar todos las capacidades de envío que pertenecen a una categoría seleccionada.

Authorizations:
None
Request Body schema: application
any

Este método no solicita ningún dato de entrada

Responses

Request samples 

var client = new RestClient("http://staging-api.tizo.co/api/v1/system-data/item-categories/5/capacities/");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "eyJhbGciOiJIUzUxMiJ9.eyJyb2xlIjoidmVuZG9yIiwidXNlcm5hbWUiOiJ2X2FkcmlhbmFfOSIsImlhdCI6MTY4NjU4MzM4MCwiZXhwIjoxNjkxODY3MzgwfQ.8AaS0pzsWQhar3y-c04gXiZUQ18K5voz2n_8G0SFItXgnp21kb9Eg-0a27dCEVAL60f0fU6gLhoJeKouEBufFg");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Item Category capacity retrieved successfully",
  • "status": 200
}

Listar las categorías de los paquetes

Este método te permite visualizar todas las categorías de los paquetes existentes.

Request Body schema: application
any

Este método no solicita ningún dato de entrada

Responses

Request samples 

var client = new RestClient("https://staging-api.tizo.co/api/v1/system-data/item-categories/");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "eyJhbGciOiJIUzUxMiJ9.eyJyb2xlIjoidmVuZG9yIiwidXNlcm5hbWUiOiJ2X2F4ZWxfOSIsImlhdCI6MTY1ODE2NDM4OCwiZXhwIjoxNjU4NzY5MTg4fQ.vvLtYB4O73futNvwzTZt2LhFzNV--XvMfTT5-62YWtxX-9CY6X4-UtIVDkCR_MX4YqX83AcCXiquHAb8uNHIjw");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Lista de categorías de paquetes encontrados",
  • "status": 200
}

Listar los estados de los envíos

Este método te permite visualizar todos los estados de envíos registrados en el sistema.

Request Body schema: application
any

Este método no solicita ningún dato de entrada

Responses

Request samples 

var client = new RestClient("https://staging-api.tizo.co/api/v1/system-data/status-deliveries/");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "eyJhbGciOiJIUzUxMiJ9.eyJyb2xlIjoidmVuZG9yIiwidXNlcm5hbWUiOiJ2X2F4ZWxfOSIsImlhdCI6MTY1ODE2NDM4OCwiZXhwIjoxNjU4NzY5MTg4fQ.vvLtYB4O73futNvwzTZt2LhFzNV--XvMfTT5-62YWtxX-9CY6X4-UtIVDkCR_MX4YqX83AcCXiquHAb8uNHIjw");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Lista de los estados de los envíos encontrados",
  • "status": 200
}

Listar los pasos de los envíos

Este método te permite visualizar todos los pasos de envíos registrados en el sistema.

Request Body schema: application
any

Este método no solicita ningún dato de entrada

Responses

Request samples 

var client = new RestClient("https://staging-api.tizo.co/api/v1/system-data/steps-deliveries/");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "eyJhbGciOiJIUzUxMiJ9.eyJyb2xlIjoidmVuZG9yIiwidXNlcm5hbWUiOiJ2X2F4ZWxfOSIsImlhdCI6MTY1ODE2NDM4OCwiZXhwIjoxNjU4NzY5MTg4fQ.vvLtYB4O73futNvwzTZt2LhFzNV--XvMfTT5-62YWtxX-9CY6X4-UtIVDkCR_MX4YqX83AcCXiquHAb8uNHIjw");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Lista de los pasos de los envíos encontrados",
  • "status": 200
}

Sucursales

Actualizar la sucursal

Este método sirve para actualizar los datos de una sucursal

path Parameters
idStore
required
string

ID de la tienda

idBranch
required
string

ID de la sucursal de la tienda

Request Body schema: application/json

Estructura de datos para la actualización de una sucursal

name
string

Nombre de la sucursal

idMunicipality
integer

Id de la Municipalidad

addressGeo
string

Direccion de la sucursal

addressHuman
string

Dirección de la sucursal versión Nicaraguense

latitude
float

Latitud de la sucursal

longitude
float

Longitud de la sucursal

active
boolean

Estado de la sucursal de la tienda

personInCharge
string

Persona encargada de la sucursal

phone
string

Teléfono de la sucursal

Responses

Request samples

Content type
application/json
{
  • "name": "name",
  • "idMunicipality": 0,
  • "addressGeo": "De la rotonda de Rubén Darío 1c al sur, 2c abajo, Managua 14003, Nicaragua",
  • "addressHuman": "Tamarindo",
  • "latitude": 12.121212,
  • "longitude": -12.121212,
  • "active": true,
  • "personInCharge": "Juan Perez",
  • "phone": "8884-2939"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Sucursal actualizada con éxito",
  • "status": 200
}

Buscar una sucursal

Este método sirve para buscar una sucursal por medio del ID y mostrar sus datos.

path Parameters
idStore
required
string

ID de la tienda

idBranch
required
string

ID de la sucursal de la tienda

Request Body schema: application
any

Este método no solicita ningún dato de entrada

Responses

Request samples 

var client = new RestClient("https://staging-api.tizo.co/api/v1/vendors/stores/:idStore/branches/:idBranch/");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "eyJhbGciOiJIUzUxMiJ9.eyJyb2xlIjoidmVuZG9yIiwidXNlcm5hbWUiOiJ2X2dhYnJpZWxfNiIsImlhdCI6MTY1NzgwOTQ2MSwiZXhwIjoxNjU4NDE0MjYxfQ.N_rPvlIFgpj_mK8mcWzDbKEgud6bJeSNc5cOKqzyYTvWeCqStlzUCQjeyoNt98GwqpEU-4jdI35jMk83bahzpg");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Sucursal actualizada con éxito",
  • "status": 200
}

Eliminar una sucursal

Este método sirve para eliminar una de las sucursales existentes que tenga una tienda

path Parameters
idStore
required
string

ID de la tienda

idBranch
required
string

ID de la sucursal de la tienda

Request Body schema: application
any

Este método no solicita ningún dato de entrada

Responses

Request samples 

var client = new RestClient("https://staging-api.tizo.co/api/v1/vendors/stores/:idStore/branches/:idBranch/");
client.Timeout = -1;
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "eyJhbGciOiJIUzUxMiJ9.eyJyb2xlIjoidmVuZG9yIiwidXNlcm5hbWUiOiJ2X2F4ZWxfOSIsImlhdCI6MTY1ODE2NDM4OCwiZXhwIjoxNjU4NzY5MTg4fQ.vvLtYB4O73futNvwzTZt2LhFzNV--XvMfTT5-62YWtxX-9CY6X4-UtIVDkCR_MX4YqX83AcCXiquHAb8uNHIjw");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Response samples

Content type
application/json
{
  • "message": "Sucursal eliminada con éxito",
  • "status": 200
}

Listar las sucursales de una tienda

Este método sirve para visualizar todas las sucursales que tiene una tienda

path Parameters
idStore
required
string

ID de la tienda

Request Body schema: application
any

Este método no solicita ningún dato de entrada

Responses

Request samples 

var client = new RestClient("https://staging-api.tizo.co/api/v1/vendors/stores/0/branches");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "eyJhbGciOiJIUzUxMiJ9.eyJyb2xlIjoidmVuZG9yIiwidXNlcm5hbWUiOiJ2X2dhYnJpZWxfNiIsImlhdCI6MTY1NzgwOTQ2MSwiZXhwIjoxNjU4NDE0MjYxfQ.N_rPvlIFgpj_mK8mcWzDbKEgud6bJeSNc5cOKqzyYTvWeCqStlzUCQjeyoNt98GwqpEU-4jdI35jMk83bahzpg");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Sucursal encontrada con éxito.",
  • "status": 200
}

Tiendas

Buscar la bolsa de crédito

Este método sirve para buscar la bolsa de crédito de una tienda

path Parameters
idStore
required
string

ID de la tienda

Request Body schema: application
any

Este método no solicita ningún dato de entrada

Responses

Request samples 

var client = new RestClient("https://staging-api.tizo.co/api/v1/vendors/stores/0/credit-bag/");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "eyJhbGciOiJIUzUxMiJ9.eyJyb2xlIjoidmVuZG9yIiwidXNlcm5hbWUiOiJ2X2F4ZWxfOSIsImlhdCI6MTY1ODMyNzMzMywiZXhwIjoxNjU4OTMyMTMzfQ.JB8oNrBgDqQyymETvZBarNQjs6vRx-zdwVnGvjlqLdB7GgtI8B-yj7haPdqG0OSrFltgMp2HN5msNR268qJlxw");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Success",
  • "status": 200
}

Producto

Crear un Producto

Este método sirve para crear nuevos Productos

Authorizations:
None
Request Body schema: application/json

Estructura de datos para la creación de los productos

object
Array of objects

Responses

Request samples

Content type
application/json
{
  • "productInfo": {
    },
  • "productOptionsPricing": [
    ]
}

Response samples

Content type
application/json
{
  • "productInfo": {
    },
  • "productOptionsPricing": [
    ]
}

Actualizacion Producto

Este método sirve para actualizacion nuevos Productos

Authorizations:
None
Request Body schema: application/json

Estructura de datos para la Actualizacion de los productos

object
Array of objects

Responses

Request samples

Content type
application/json
{
  • "productInfo": {
    },
  • "productOptionsPricing": [
    ]
}

Response samples

Content type
application/json
{
  • "productInfo": {
    },
  • "productOptionsPricing": [
    ]
}

List de los Producto

Este método sirve para Listar nuevos Productos

Authorizations:
None
Request Body schema: application/json

Estructura de datos para la lista de los productos

Array of objects
total
integer

Total de productos

page
integer

Página actual

size
integer

Cantidad de productos por página

totalPages
integer

Total de páginas

messages
Array of strings

Responses

Request samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 0,
  • "page": 0,
  • "size": 0,
  • "totalPages": 0,
  • "messages": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 0,
  • "page": 0,
  • "size": 0,
  • "totalPages": 0,
  • "messages": [
    ]
}