FAQs

Se ofrece aquí respuesta a una selección de las preguntas más frecuentes.

¿Cómo solicito mis API keys?

Tu administrador de cuentas clave te ayudará, es la persona encargada de determinar el modelo de negocio acorde a sus necesidades.

Debes comunicarte con tu Key Account Manager para solicitar las API Keys necesarias.

¿Qué tipos de envíos están disponibles? ¿Cuál es la nomenclatura?

A la hora de realizar un envío se debe completar el campo "type", ¿Cual es la nomenclatura correcta?.

"type" es un atributo definido para contener un "String" con la nomenclatura del tipo de negocio con el que se generará la guía (trackingNumber). Al crear un envío debes colocar el tipo de negocio que puede ser:

• SAME_DAY
• NEXT_DAY
• ON_DEMAND

Puedes encontrar más información en el sig. URL:
https://ivoy.readme.io/reference/glosario-de-t%C3%A9rminos-api

¿Cómo puedo obtener mi etiqueta en formato ZPL?

Dentro de las variables al crear un envío debe colocar "ZPL" en "labelType":

"variables": {
"labelType": "ZPL",

Puede encontrar informacion detallada en: https://ivoy.readme.io/changelog/zpl_format

¿Puedo editar el los datos del remitente de las etiquetas de mis paquetes?

Si, para modificar los datos del remitente puede crear un nuevo almacén modificando los datos de:

Ejemplo:

"variables": {
      "name": "TiendaMX",
      "referenceId": "MXWH-TEST",
      "description": "MXWH-TEST-DESCRIPTION",
      "location": {
           "address": "Pte 116 #589, Industrial Vallejo, Azcapotzalco, CDMX",
           "zipCode": "02300",
           "instructions": "Referencias/Entre Calles/Fachada",
           "latitude": 19.484950024045098,
           "longitude": -99.15984783069105
      },
      "contact": {
           "name": "John Smith",
           "phone": "[phone]",
           "email": "[email protected]"
      }
 }

}

O bien puede ponerse en contacto con su Key Account Manager para que modifique los datos de un almacén vigente. De ésta manera podrá modificar la información de sus etiquetas.

¿Cuáles son las dimensiones disponibles para los paquetes?

Puedes ver las dimensiones de los paquetes en nuestro apartado https://dash.readme.com/project/ivoy/v4.3.13/refs/dimensiones-de-paquetes

¿Cuántos caracteres me permite consumir el campo Address y de qué tipo?

Puedes ver nuestro glosario de terminos donde encontraras la correcta nomerclatura y la cantidad de caracteres que consume cada atributo en https://ivoy.readme.io/reference/glosario-de-t%C3%A9rminos-api

Lo correcto es colocar el address en el siguiente orden:

Ejemplo:

"location": {
"address": "Pte 116 #589, Industrial Vallejo, Azcapotzalco, CDMX",
"zipCode": "02300",
"instructions": "Referencias/Entre Calles/Fachada",
"latitude": 19.484950024045098,
"longitude": -99.15984783069105
},

Address: Street + External number (Dato Obligatorio) + Internal number (en caso de que existiera) + Neighborhood + State + City

¿Es necesario colocar el external number y el internal number? ¿A que hacen referencia?

Es obligatorio que se coloque el external number para una correcta geo localización del domicilio. Caso contrario puede suceder que el mismo no sea interpretado por el sistema y que por ende no se pueda generar el número de guía o se genere una direccion erronea.

En México se cuenta con:

• Número exterior: hace referencia a la nomenclatura de las subdivisiones externas, por ejemplo, calles, avenidas, manzanas y otros.
• Número interior: hace referencia a la nomenclatura principal del domicilio que se encuentra en una vecindad o una urbanización.

¿Qué sucede si no tengo un external number?

En caso de que no cuentes con un external number debes colocar N/A o un número por defecto. El paquete irá a validación y allí buscarán el punto más cercano al domicilio real.

¿Cómo puedo asociar mi almacén? Al ejecutar "Create store" ¿Cuál sería el response que debería devolver?

Los datos que se colocarán a continuación son un ejemplo, usted debe colocar los que correspondan a su negocio.

Recuerde que su "ReferenceId" luego será su "StoreId" al momento de crear un envío.

¿A qué hace referencia el atributo "reference id" y el "store id"?

Recuerde que puede ver nuestro glosario de términos donde encontrará la definición, nomerclatura y caracteres consumidos por cada atributo en https://ivoy.readme.io/reference/glosario-de-t%C3%A9rminos-api

"referenceId": Atributo definido para contener un "String" con el código del almacén.
"storeId": Atributo definido para contener un "String" con el "referenceId" (código del almacén) del almacén.

¿Por qué mi Zipcode es inválido? ¿Cómo sé si el ZipCode está dentro de la zona de cobertura?

Posiblemente su Zipcode no está dentro de la zona de cobertura, recuerde que puede solicitar el listado de ZipCode validos a su Key Account Manager o al àrea comercial.

Recuerde la nomenclatura de Address y Zipcode:
Address: Street + External number (Dato Obligatorio) + Internal number (en caso de que existiera) + Neighborhood + State + City
ZipCode: Es un número de 5 dígitos, no se coloca en el Address y debe estar dentro de la cobertura válida

Si deseo crear un envío ¿Como llamo al almacén? Al ejecutar "Create delivery" ¿Cuál sería el response que debería devolver?

Cuando desee crear un envío recuerde que su "ReferenceId" luego será su "StoreId" al momento de crear un envío.

Ejemplo:

"variables": {
"input": {
"type": "ON_DEMAND",
"referenceId": "CLIENT_GUIDE",
"storeId": "MXWH-TEST",