En este apartado encontrarás el significado de los atributos incluidos en la API.
API KEYS
"Authorization": "Bearer {{API_KEY}}", Atributo definido dentro del Header de su petición de tipo "String" con un tamaño mínimo de 36 caracteres y un máximo de 37 caracteres actualmente.
"x-ivoy-user": "{{USER_ID}}", Atributo definido dentro del Header de su petición de tipo "String" con un tamaño mínimo de 35 y un máximo de 37 caracteres actualmente.
NOTA: Es importante contar con API KEYS para poder realizar cualquier solicitud a nuestros servicios.
Crear un almacén.
"name": Atributo de tipo "String" ; máx 100 caracteres; RegEx [0-9][a-Z] . Define nombre del almacén.
"referenceId": Atributo de tipo "String" ; máx 100 caracteres; RegEx [0-9][a-Z]. Define el código del almacén.
"description": Atributo de tipo "String"; máx de 100 caracteres. RegEx [0-9][a-Z]. Define la descripción del almacén.
"address": Atributo de tipo "String"; máx 255 caracteres. RegEx [0-9][a-Z]. Define la dirección del almacén con la siguiente estructura: calle, número exterior, número interior (si aplica), colonia, estado, ciudad, código postal.
"zipCode": Atributo de tipo "Int"; min-máx 5 dígitos. RegEx [0-9]. Define el código postal de la dirección del almacén.
"instructions": Atributo de tipo "String"; máx 100 caracteres. RegEx [0-9][a-Z]. Define las referencias del domicilio, por ejemplo entre que calles se encuentra la dirección del almacén.
"latitude": Atributo de tipo "Double"; máx de 20 caracteres. RegEx [0-9]. Define la latitud de la dirección del almacén.
"longitude": Atributo de tipo "Double"; máx de 20 caracteres. RegEx [0-9]. Define la longitud de la dirección del almacén (va siempre como negativo).
"name": Atributo de tipo "String"; min de 20 caracteres, máx de 50 caracteres. RegEx [0-9][a-Z] Define el nombre de la persona responsable del almacén.
"phone": Atributo de tipo "String"; min de 10 caracteres, máx 13 caracteres (si se agrega LADA). RegEx [0-9]. Define el número telefónico de la persona responsable del almacén.
"email": Atributo de tipo "String" ; min 20 caracteres , máx 50 caracteres. RegEx [0-9][a-Z][!#$%&'*+-/=?^_`{}|~] . Define el correo de la persona responsable del almacén.
Crear un envío.
"type": Atributo definido para contener un "String" con la nomenclatura del tipo de negocio con el que se generará la guía (trackingNumber).
| Nomenclatura. | Tipo de negocio. |
|---|---|
| SAME_DAY | Same Day: Mismo día |
| NEXT_DAY | Next Day: Siguiente día |
| ON_DEMAND | On Demand: Bajo demanda |
"referenceId": Atributo de tipo "String". máx 100 caracteres. RegEx [0-9][a-Z]. Define la guía interna del cliente.
"storeId": Atributo de tipo "String". máx 100 caracteres. RegEx [0-9][a-Z]. Define el "referenceId" del Almacén asociado al código del almacén.
"address": Atributo de tipo "String". máx 255 caracteres. RegEx [0-9][a-Z]. Define la dirección del destinatario, con la siguiente estructura: calle, número exterior, número interior (si aplica), colonia, estado, ciudad, código postal.
"zipCode": Atributo de tipo "Int"; min-máx 5 dígitos. RegEx [0-9]. Define el código postal de la dirección del destinatario.
"latitude": Atributo de tipo "Double"; máx de 20 caracteres. RegEx [0-9]. Define la latitud de la dirección del destinatario.
"longitude": Atributo de tipo "Double"; máx de 20 caracteres. RegEx [0-9]. Define la longitud de la dirección del destinatario (va siempre como negativo).
"instructions": Atributo de tipo "String"; máx 100 caracteres. RegEx [0-9][a-Z]. Define las referencias del domicilio del destinatario, por ejemplo entre que calles se encuentra la dirección del destinatario.
"name": Atributo de tipo "String"; min 20 caracteres, máx 50 caracteres. RegEx [0-9][a-Z]. Define el nombre del destinatario.
"phone": Atributo de tipo "String"; min de 10 caracteres, máx 13 caracteres (si se agrega LADA). RegEx [0-9]. Define el número telefónico del destinatario.
"email": Atributo de tipo "String"; min 20 caracteres , máx 50 caracteres. RegEx [0-9][a-Z][!#$%&'*+-/=?^_`{}|~] . Define el correo de la persona responsable del almacén. Define el correo del destinatario.
Dimensions
"height": Atributo de tipo "Double"; máx de 3 caracteres. RegEx [0-9] Define la altura del producto.
"width": Atributo de tipo "Double"; máx de 3 caracteres. RegEx [0-9] Define el ancho del producto.
"length": Atributo de tipo "Double"; máx de 3 caracteres. RegEx [0-9] Define la profundidad del producto.
"weight": Atributo de tipo "Double"; máx de 3 caracteres. RegEx [0-9] Define el peso del producto.
Items
"quantity": Atributo de tipo "Int"; min 1 digito. RegEx [1-9]. Define la cantidad por producto en el envío.
"description": Atributo de tipo "String"; máx 100 caracteres. RegEx [0-9][a-Z] Define la descripción del producto.
Obtener último estatus.
"trackingNumber": Atributo de tipo "String"; RegEx [0-9][a-Z]. Define el número de guía.
Obtener historial.
"trackingNumber": Atributo de tipo "String"; RegEx [0-9][a-Z]. Define el número de guía.