No se ha encontrado nada

E-shop API – configuración

Sube al portal los datos de la tienda a partir de los cuales se componen las notificaciones: la activación de las versiones de idioma, la lista de idiomas, la lista de tiendas (multitienda), los estados de los pedidos y los estados de las devoluciones. Envíe solo los elementos que quiera cambiar; los demás se quedan como están. La respuesta siempre devuelve los valores actuales de todos los elementos.

URL de la API

URL a la que se envían las solicitudes HTTP:

https://portal.bulkgate.com/api/1.0/eshop/setup
Nota

Si la solicitud no llega a su destino, repítala en el servidor de respaldo backup1.bulkgate.com.

Métodos HTTP admitidos

  • POST - application/json
POST /api/1.0/eshop/setup HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json

Tabla de parámetros

NOMBRE DEL PARÁMETRO VALOR OBLIGATORIO VALOR PREDETERMINADO
application_id ID de aplicación Sí -
application_token Token de aplicación Sí -
language_mutation Activación de las versiones de idioma: true o false No Sin cambios
languages Idiomas de la tienda: objeto código: nombre No Sin cambios
stores Tiendas (multitienda): objeto id: nombre No Sin cambios
order_status_list Estados de los pedidos: objeto id: nombre No Sin cambios
return_status_list Estados de las devoluciones: objeto id: nombre No Sin cambios

Cada elemento enviado sustituye la lista completa: las entradas que no incluya desaparecerán del portal.

Cómo utiliza el portal los elementos

Versiones de idioma

Si language_mutation está activado, las notificaciones al cliente tienen un texto propio para cada idioma de la lista languages. El portal elige entonces el texto según el parámetro language, que envía con cada evento. Con las versiones de idioma desactivadas, cada notificación al cliente tiene un único texto y el idioma se ignora. Las notificaciones a los administradores tienen siempre un único texto.

El código de idioma es lo que envía en el parámetro language: de 1 a 16 caracteres entre letras, cifras y guion bajo, p. ej. es o en_us. El guion no está permitido.

Tiendas

El id de la tienda es lo que envía en el parámetro shop_id. Las notificaciones se configuran para cada tienda por separado. El id tiene de 1 a 20 caracteres entre letras, cifras y guion bajo. Una tienda sin multitienda envía una única tienda con el id 0: los eventos sin shop_id le pertenecen precisamente a ella.

El portal introduce el nombre de la tienda según el shop_id del evento en la variable <shop_name>, si no la envía usted mismo. Si la tienda con ese id no está en la lista, se utiliza la primera tienda de la lista.

Estados de pedidos y devoluciones

Para cada estado de la lista, el portal ofrece en las secciones SMS del cliente y Admin SMS una notificación de cambio de estado. El id del estado es el valor que envía en la variable order_status_id (cambio de estado del pedido o return_status_id (cambio de estado de la devolución. El id tiene de 1 a 29 caracteres entre letras, cifras, guion bajo y guion, p. ej. ready-for-pickup.

Las listas de estados pueden estar vacías; la lista de idiomas y la de tiendas, no. El nombre de cada entrada es un texto no vacío de 255 caracteres como máximo.

Ejemplo de solicitud

POST /api/1.0/eshop/setup HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "language_mutation": true, "languages": { "es": "Español", "en": "English" }, "stores": { "0": "BulkGate Shop ES", "1": "BulkGate Shop PT" }, "order_status_list": { "processing": "En preparación", "completed": "Completado", "cancelled": "Cancelado" } }

La solicitud anterior no cambia los estados de las devoluciones.

Respuesta

En caso de éxito devuelve los valores actuales de todos los elementos. Las listas son siempre un objeto, aunque estén vacías:

{ "data": { "language_mutation": true, "languages": { "es": "Español", "en": "English" }, "stores": { "0": "BulkGate Shop ES", "1": "BulkGate Shop PT" }, "order_status_list": { "processing": "En preparación", "completed": "Completado", "cancelled": "Cancelado" }, "return_status_list": {} } }

Una solicitud sin elementos no cambia nada y solo devuelve la configuración actual.

En caso de error:

{ "type": "invalid_languages", "code": 400, "error": "Invalid languages", "detail": "Invalid identifier 'cs-CZ'." }

Donde:

  • type y error (descripción del error) se encuentran en la tabla de tipos de error
  • code es el código de error HTTP
  • detail es información adicional sobre el error

Tipos de error

Si algún elemento no supera la validación, el portal no guarda nada.

TIPO CUÁNDO SE PRODUCE
invalid_languages La lista de idiomas está vacía o contiene un código o un nombre no válido.
invalid_stores La lista de tiendas está vacía o contiene un id o un nombre no válido.
invalid_order_status_list La lista de estados de los pedidos contiene un id o un nombre no válido.
invalid_return_status_list La lista de estados de las devoluciones contiene un id o un nombre no válido.
invalid_input_parameters Un parámetro desconocido, una lista indicada de otra forma que como objeto (p. ej. como texto) o un language_mutation que no es un valor booleano.
unknown_identity Falta application_id o application_token, o no son válidos.
¿Le ha resultado útil esta página?