Etiquetas
Endpoint para gestionar el apartado de etiquetas.
</> GET / customTagGroupsDevuelve el listado de grupos de etiquetas
</> POST / customTagGroupsCreación de un nuevo grupo de etiquetas
</> GET / customTagGroups/{id}Devuelve la información del grupo de etiquetas indicado mediante el identificador interno.
</> PUT / customTagGroups/{id}Edición del grupo de etiquetas indicado mediante el indentificador interno.
</> DELETE / customTagGroups/{id}Elimina el grupo de etiquetas indicado mediante el indentificador interno.
</> GET / customTagGroups/getId/{pId}Devuelve el identificador interno del grupo de etiquetas.
</> GET / customTagsDevuelve el listado de etiquetas.
</> POST / customTagsCreación de una nueva etiqueta.
</> GET / customTags/{id}Devuelve la información de la etiqueta indicada mediante el identificador interno.
</> PUT / customTags/{id}Edición de la etiqueta indicada mediante el indentificador interno.
</> DELETE / customTags/{id}Elimina la etiqueta indicada mediante el indentificador interno.
</> GET / customTags/{id}/groupsDevuelve el listado de grupos de etiquetas vinculadas
</> POST / customTags/{id}/groupsVinculación de un grupo de etiquetas
</> DELETE / customTags/{id}/groupsDesvincula todos los grupos de etiquetas
</> DELETE / customTags/{id}/groups/{groupId}Desvincula un grupo de etiquetas
</> GET / customTags/{id}/rangesDevuelve el listado de rangos de la etiqueta indicada mediante el identificador interno.
</> POST / customTags/{id}/rangesCreación de un nuevo rango para la etiqueta indicada mediante el identificador interno.
</> GET / customTags/{id}/valuesDevuelve los valores de la etiqueta indicado mediante el identificador interno.
</> POST / customTags/{id}/valuesCreación de un valor de etiqueta indicado de tipo desplegable mediante el indentificador interno.
</> DELETE / customTags/{id}/valuesElimina el valor de etiqueta indicado mediante el indentificador interno.
</> GET / customTags/getId/{pId}Devuelve el identificador interno de la etiqueta.
</> GET / customTags/rangeIntervalConditions/{id}Devuelve la información de la condición indicada mediante el identificador interno.
</> PUT / customTags/rangeIntervalConditions/{id}Edición de la condición indicada mediante el identificador interno.
</> DELETE / customTags/rangeIntervalConditions/{id}Elimina la condición indicada mediante el identificador interno.
</> GET / customTags/rangeIntervals/{id}Devuelve la información del intervalo indicado mediante el identificador interno.
</> PUT / customTags/rangeIntervals/{id}Edición del intervalo indicado mediante el identificador interno.
</> DELETE / customTags/rangeIntervals/{id}Elimina el intervalo indicado mediante el identificador interno.
</> GET / customTags/rangeIntervals/{id}/conditionsDevuelve el listado de condiciones del intervalo indicado mediante el identificador interno.
</> POST / customTags/rangeIntervals/{id}/conditionsCreación de una nueva condición para el intervalo indicado mediante el identificador interno.
</> GET / customTags/ranges/{id}Devuelve la información del rango indicado mediante el identificador interno.
</> PUT / customTags/ranges/{id}Edición del rango indicado mediante el identificador interno.
</> DELETE / customTags/ranges/{id}Elimina el rango indicado mediante el identificador interno.
</> GET / customTags/ranges/{id}/intervalsDevuelve el listado de intervalos del rango indicado mediante el identificador interno.
</> POST / customTags/ranges/{id}/intervalsCreación de un nuevo intervalo para el rango indicado mediante el identificador interno.
</> GET / customTags/values/{id}Devuelve la información del valor de etiqueta indicado mediante el identificador interno.
</> PUT / customTags/values/{id}Edición del valor de etiqueta indicado mediante el indentificador interno.
</> DELETE / customTags/values/{id}Elimina el valor de etiqueta indicado mediante el indentificador interno.
GET/customTagGroups
Descripción
Devuelve el listado de grupos de etiquetas
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTagGroups
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| itemType | Opcional | 0 | numeric |
| Devuelve el grupo de etiquetas con el itemType especificado. Valores permitidos: 1 - Productos, 2 - Categorías, 3 - Páginas, 10 - Accounts, 13 - Pedidos | |||
| page | Opcional | 1 | numeric |
| Nº de página solicitada. | |||
| perPage | Opcional | 100 | numeric |
| Cantidad de elementos por página. | |||
| position | Opcional | 0 | numeric |
| Devuelve elementos de la posición indicada. | |||
| priority | Opcional | 0 | numeric |
| Devuelve elementos de la prioridad indicada. | |||
| q | Opcional | string | |
| Criterio de búsqueda. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"CURSORS": {
"NEXT" :"https://api-sync.logicommerce.cloud/v1/customTagGroups?page=3&perPage=100",
"PREVIOUS" :"https://api-sync.logicommerce.cloud/v1/customTagGroups?page=1&perPage=100"
},
"CUSTOMTAGGROUPS": [
{
"COMPARABLE" : false,
"ID" : 11,
"ITEMTYPE" : 3,
"LANGUAGES": [
{
"DESCRIPTION" :"Label group description",
"LANGUAGE" :"ES",
"NAME" :"Label group name"
},
{
"DESCRIPTION" :"Label group description",
"LANGUAGE" :"EN",
"NAME" :"Label group name"
}
],
"NAME" :"c",
"PARENT": {
"ID" : 2,
"PID" :"parent"
},
"PID" :"c",
"POSITION" : 1,
"PRIORITY" : 1
}
],
"ITEMS" : 1000,
"PAGERPARAMETERS": {
"PAGE" : 2,
"PERPAGE" : 100
}
}
POST/customTagGroups
Descripción
Creación de un nuevo grupo de etiquetas
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTagGroups
Parámetros de entrada JSON
{ "customTagGroups": { "comparable":boolean, "itemType":numeric, "languages": [ { "description":string, "languageCode":string, "name":string } ], "name":string, "pId":string, "position":numeric, "priority":numeric } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| customTagGroups | Obligatorio | struct | |
| Bloque de información que contiene la definición del grupo de etiquetas. | |||
| customTagGroups/comparable | Opcional | true | boolean |
| Booleano que indica que el grupo de etiquetas se tendrá en cuenta en el comparador de productos de la tienda | |||
| customTagGroups/itemType | Obligatorio | numeric | |
| Número entero que indica el tipo de grupo de etiqueta. Valores permitidos: 1 - Productos, 2 - Categorías, 3 - Páginas, 10 - Accounts, 13 - Pedidos | |||
| customTagGroups/languages | Opcional | array [0:n] | |
| Bloque con información variable según el idioma | |||
| customTagGroups/languages/description | Opcional | string | |
| Descripción del elemento para el idioma especificado | |||
| customTagGroups/languages/languageCode | Obligatorio | string | |
| Etiqueta de idioma según el estándar internacional BCP 47. Las etiquetas base (p.ej. 'en') deben corresponder a un idioma base conectado al commerce; las variantes regionales (p.ej. 'en-US') deben corresponder a un idioma regionalizado conectado al commerce y requieren que el array 'languages' contenga también una entrada para su idioma base. | |||
| customTagGroups/languages/name | Opcional | string | |
| Nombre del elemento para el idioma especificado | |||
| customTagGroups/name | Obligatorio | string | |
| Nombre del elemento | |||
| customTagGroups/pId | Obligatorio | string | |
| Identificador público del elemento | |||
| customTagGroups/position | Obligatorio | numeric | |
| Número entero que simboliza la ubicación de este elemento en el Frontoffice. | |||
| customTagGroups/priority | Obligatorio | numeric | |
| Define el orden de presentación de este grupo de etiquetas en relación al resto de grupos que se encuentran en su mismo nivel. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"COMPARABLE" : false,
"ID" : 11,
"ITEMTYPE" : 3,
"LANGUAGES": [
{
"DESCRIPTION" :"Label group description",
"LANGUAGE" :"ES",
"NAME" :"Label group name"
},
{
"DESCRIPTION" :"Label group description",
"LANGUAGE" :"EN",
"NAME" :"Label group name"
}
],
"NAME" :"c",
"PARENT": {
"ID" : 2,
"PID" :"parent"
},
"PID" :"c",
"POSITION" : 1,
"PRIORITY" : 1
}
GET/customTagGroups/{id}
Descripción
Devuelve la información del grupo de etiquetas indicado mediante el identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTagGroups/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"COMPARABLE" : false,
"ID" : 11,
"ITEMTYPE" : 3,
"LANGUAGES": [
{
"DESCRIPTION" :"Label group description",
"LANGUAGE" :"ES",
"NAME" :"Label group name"
},
{
"DESCRIPTION" :"Label group description",
"LANGUAGE" :"EN",
"NAME" :"Label group name"
}
],
"NAME" :"c",
"PARENT": {
"ID" : 2,
"PID" :"parent"
},
"PID" :"c",
"POSITION" : 1,
"PRIORITY" : 1
}
PUT/customTagGroups/{id}
Descripción
Edición del grupo de etiquetas indicado mediante el indentificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTagGroups/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "customTagGroups": { "comparable":boolean, "languages": [ { "description":string, "languageCode":string, "name":string } ], "name":string, "pId":string, "position":numeric, "priority":numeric } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| customTagGroups | Obligatorio | struct | |
| Bloque de información que contiene la definición del grupo de etiquetas. | |||
| customTagGroups/comparable | Opcional | true | boolean |
| Booleano que indica que el grupo de etiquetas se tendrá en cuenta en el comparador de productos de la tienda | |||
| customTagGroups/languages | Opcional | array [0:n] | |
| Bloque con información variable según el idioma | |||
| customTagGroups/languages/description | Opcional | string | |
| Descripción del elemento para el idioma especificado | |||
| customTagGroups/languages/languageCode | Obligatorio | string | |
| Etiqueta de idioma según el estándar internacional BCP 47. Las etiquetas base (p.ej. 'en') deben corresponder a un idioma base conectado al commerce; las variantes regionales (p.ej. 'en-US') deben corresponder a un idioma regionalizado conectado al commerce y requieren que el array 'languages' contenga también una entrada para su idioma base. | |||
| customTagGroups/languages/name | Opcional | string | |
| Nombre del elemento para el idioma especificado | |||
| customTagGroups/name | Opcional | string | |
| Nombre del elemento | |||
| customTagGroups/pId | Opcional | string | |
| Identificador público del elemento | |||
| customTagGroups/position | Opcional | numeric | |
| Número entero que simboliza la ubicación de este elemento en el Frontoffice. | |||
| customTagGroups/priority | Opcional | numeric | |
| Define el orden de presentación de este grupo de etiquetas en relación al resto de grupos que se encuentran en su mismo nivel. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"COMPARABLE" : false,
"ID" : 11,
"ITEMTYPE" : 3,
"LANGUAGES": [
{
"DESCRIPTION" :"Label group description",
"LANGUAGE" :"ES",
"NAME" :"Label group name"
},
{
"DESCRIPTION" :"Label group description",
"LANGUAGE" :"EN",
"NAME" :"Label group name"
}
],
"NAME" :"c",
"PARENT": {
"ID" : 2,
"PID" :"parent"
},
"PID" :"c",
"POSITION" : 1,
"PRIORITY" : 1
}
DELETE/customTagGroups/{id}
Descripción
Elimina el grupo de etiquetas indicado mediante el indentificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTagGroups/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 1
}
GET/customTagGroups/getId/{pId}
Descripción
Devuelve el identificador interno del grupo de etiquetas.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTagGroups/getId/abc
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| pId | Obligatorio | string | |
| Identificador público. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 143
}
GET/customTags
Descripción
Devuelve el listado de etiquetas. Los parámetros de entrada permiten filtrar esta información.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| controlType | Opcional | 0 | numeric |
| Devuelve las etiquetas con el controlType especificado. Valores permitidos: 1 - Booleano, 2 - Numérico, 3 - Texto corto, 4 - Fecha, 5 - Selector, 6 - Imagen, 7 - Texto largo, 9 - Selección múltiple, 10 - Selección única con imagen, 11 - Selección múltiple con imagen | |||
| itemType | Opcional | 0 | numeric |
| Devuelve las etiquetas con el itemType especificado. Valores permitidos: 1 - Productos, 2 - Categorías, 3 - Páginas, 10 - Accounts, 13 - Pedidos | |||
| page | Opcional | 1 | numeric |
| Nº de página solicitada. | |||
| perPage | Opcional | 100 | numeric |
| Cantidad de elementos por página. | |||
| position | Opcional | 0 | numeric |
| Devuelve elementos de la posición indicada. | |||
| priority | Opcional | 0 | numeric |
| Devuelve elementos de la prioridad indicada. | |||
| q | Opcional | string | |
| Criterio de búsqueda. | |||
| sort | Opcional | id | string |
| Variable de ordenación. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"CURSORS": {
"NEXT" :"https://api-sync.logicommerce.cloud/v1/customTags?page=3&perPage=100",
"PREVIOUS" :"https://api-sync.logicommerce.cloud/v1/customTags?page=1&perPage=100"
},
"CUSTOMTAGS": [
{
"ACTIVE" : true,
"COMPARABLE" : false,
"CONTROLTYPE" : 3,
"DEFAULTVALUE" :"",
"FILTERABLE" : false,
"GROUPS": [
{
"GROUP": {
"ID" : 123,
"PID" :"pId"
},
"PRIORITY" : 1
}
],
"HIGHLIGHT" : false,
"ID" : 3,
"INORDERS" : 0,
"ITEMTYPE" : 2,
"LANGUAGES": [
{
"DEFAULTVALUE" :"",
"ID" : 6,
"LANGUAGE" :"ES",
"NAME" :"Tamaño"
}
],
"MAXVALUE" :"5",
"MINVALUE" :"1",
"NAMEONFEED" :"features",
"PID" :"size",
"PLUGINID" : 0,
"POSITION" : 10,
"PRIORITY" : 0,
"REQUIRED" : false,
"SEARCHABLE" : false,
"SHOWINSEARCH" : false,
"VALUEFORALLLANGUAGES" : false
}
],
"ITEMS" : 1000,
"PAGERPARAMETERS": {
"PAGE" : 2,
"PERPAGE" : 100
}
}
POST/customTags
Descripción
Creación de una nueva etiqueta.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags
Parámetros de entrada JSON
{ "customTags": { "active":boolean, "comparable":boolean, "controlType":numeric, "defaultValue":string, "filterable":boolean, "groups": [ { "group": { "id":numeric, "pId":string }, "priority":numeric } ], "inOrders":boolean, "itemType":numeric, "languages": [ { "defaultValue":string, "languageCode":string, "name":string } ], "maxValue":string, "minValue":string, "nameOnFeed":string, "pId":string, "position":numeric, "priority":numeric, "required":boolean, "searchable":boolean, "valueForAllLanguages":boolean } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| customTags | Obligatorio | struct | |
| Bloque de información que contiene la definición de la etiquetas. | |||
| customTags/active | Obligatorio | boolean | |
| Booleano que indica si la etiqueta está activa. | |||
| customTags/comparable | Opcional | true | boolean |
| Booleano que indica que el grupo de etiquetas se tendrá en cuenta en el comparador de productos de la tienda | |||
| customTags/controlType | Obligatorio | numeric | |
| Número entero que indica el tipo de control de la etiqueta. Valores permitidos: 1 - Booleano, 2 - Numérico, 3 - Texto corto, 4 - Fecha, 5 - Selector, 6 - Imagen, 7 - Texto largo, 9 - Selección múltiple, 10 - Selección única con imagen, 11 - Selección múltiple con imagen | |||
| customTags/defaultValue | Opcional | string | |
| Valor por defecto de la etiqueta. Solo útil si la etiqueta es multiidioma. | |||
| customTags/filterable | Opcional | true | boolean |
| Booleano que indica que la etiqueta se mostrarà en el filtro de la tienda. | |||
| customTags/groups | Opcional | array [0:n] | |
| Bloque de información que contiene la definición de la vinculación de grupo | |||
| customTags/groups/group | Obligatorio | struct | |
| Bloque de información que contiene el identificador de grupo. | |||
| customTags/groups/group/id | Opcional | 0 | numeric |
| Identificador interno del elemento. Opcional en caso que se use identificador público (si lo tiene, en caso contrario es obligatorio). | |||
| customTags/groups/group/pId | Opcional | string | |
| Identificador público del elemento(si lo tiene). Opcional en caso que se use identificador interno. | |||
| customTags/groups/priority | Obligatorio | numeric | |
| Prioridad | |||
| customTags/inOrders | Opcional | true | boolean |
| Booleano que indica que la etiqueta se exportará en el pedido. | |||
| customTags/itemType | Obligatorio | numeric | |
| Número entero que indica el tipo de etiqueta. Valores permitidos: 1 - Productos, 2 - Categorías, 3 - Páginas, 10 - Accounts, 13 - Pedidos | |||
| customTags/languages | Opcional | array [0:n] | |
| Bloque con información variable según el idioma | |||
| customTags/languages/defaultValue | Opcional | string | |
| Valor por defecto de la etiqueta. Solo útil si la etiqueta está marcada como idiomas únicos. | |||
| customTags/languages/languageCode | Obligatorio | string | |
| Etiqueta de idioma según el estándar internacional BCP 47. Las etiquetas base (p.ej. 'en') deben corresponder a un idioma base conectado al commerce; las variantes regionales (p.ej. 'en-US') deben corresponder a un idioma regionalizado conectado al commerce y requieren que el array 'languages' contenga también una entrada para su idioma base. | |||
| customTags/languages/name | Opcional | string | |
| Nombre del elemento para el idioma especificado | |||
| customTags/maxValue | Opcional | string | |
| Establece valor máximo que puede tener la etiqueta | |||
| customTags/minValue | Opcional | string | |
| Establece valor mínimo que puede tener la etiqueta | |||
| customTags/nameOnFeed | Opcional | string | |
| Nombre para el feed | |||
| customTags/pId | Obligatorio | string | |
| Identificador público del elemento | |||
| customTags/position | Obligatorio | numeric | |
| Número entero que simboliza la ubicación de este elemento en el Frontoffice. | |||
| customTags/priority | Obligatorio | numeric | |
| Define el orden de presentación de la etiqueta en relación al resto de etiquetas que se encuentran en su mismo nivel. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
| customTags/required | Opcional | true | boolean |
| Booleano que indica si el valor para la etiqueta es obligatorio. | |||
| customTags/searchable | Opcional | true | boolean |
| Booleano que indica si los valores de etiqueta pueden ser buscables en la tienda. | |||
| customTags/valueForAllLanguages | Obligatorio | boolean | |
| Booleano que indica si los valores de la etiqueta seran únicos por idioma o multiidioma. Valores permitidos: false - Únicos: Los valores pueden ser diferentes para cada idioma, true - Múltiples idiomas: Los valores son los mismos para todos los idiomas. | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"ACTIVE" : true,
"COMPARABLE" : false,
"CONTROLTYPE" : 3,
"DEFAULTVALUE" :"",
"FILTERABLE" : false,
"GROUPS": [
{
"GROUP": {
"ID" : 123,
"PID" :"pId"
},
"PRIORITY" : 1
}
],
"HIGHLIGHT" : false,
"ID" : 3,
"INORDERS" : 0,
"ITEMTYPE" : 2,
"LANGUAGES": [
{
"DEFAULTVALUE" :"",
"ID" : 6,
"LANGUAGE" :"ES",
"NAME" :"Tamaño"
}
],
"MAXVALUE" :"5",
"MINVALUE" :"1",
"NAMEONFEED" :"features",
"PID" :"size",
"PLUGINID" : 0,
"POSITION" : 10,
"PRIORITY" : 0,
"REQUIRED" : false,
"SEARCHABLE" : false,
"SHOWINSEARCH" : false,
"VALUEFORALLLANGUAGES" : false
}
GET/customTags/{id}
Descripción
Devuelve la información de la etiqueta indicada mediante el identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACTIVE" : true,
"COMPARABLE" : false,
"CONTROLTYPE" : 3,
"DEFAULTVALUE" :"",
"FILTERABLE" : false,
"GROUPS": [
{
"GROUP": {
"ID" : 123,
"PID" :"pId"
},
"PRIORITY" : 1
}
],
"HIGHLIGHT" : false,
"ID" : 3,
"INORDERS" : 0,
"ITEMTYPE" : 2,
"LANGUAGES": [
{
"DEFAULTVALUE" :"",
"ID" : 6,
"LANGUAGE" :"ES",
"NAME" :"Tamaño"
}
],
"MAXVALUE" :"5",
"MINVALUE" :"1",
"NAMEONFEED" :"features",
"PID" :"size",
"PLUGINID" : 0,
"POSITION" : 10,
"PRIORITY" : 0,
"REQUIRED" : false,
"SEARCHABLE" : false,
"SHOWINSEARCH" : false,
"VALUEFORALLLANGUAGES" : false
}
PUT/customTags/{id}
Descripción
Edición de la etiqueta indicada mediante el indentificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "customTags": { "active":boolean, "comparable":boolean, "controlType":numeric, "defaultValue":string, "filterable":boolean, "inOrders":boolean, "itemType":numeric, "languages": [ { "defaultValue":string, "languageCode":string, "name":string } ], "maxValue":string, "minValue":string, "nameOnFeed":string, "pId":string, "position":numeric, "priority":numeric, "required":boolean, "searchable":boolean, "valueForAllLanguages":boolean } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| customTags | Obligatorio | struct | |
| Bloque de información que contiene la definición de la etiquetas. | |||
| customTags/active | Opcional | boolean | |
| Booleano que indica si la etiqueta está activa. | |||
| customTags/comparable | Opcional | true | boolean |
| Booleano que indica que el grupo de etiquetas se tendrá en cuenta en el comparador de productos de la tienda | |||
| customTags/controlType | Opcional | numeric | |
| Número entero que indica el tipo de control de la etiqueta. Valores permitidos: 1 - Booleano, 2 - Numérico, 3 - Texto corto, 4 - Fecha, 5 - Selector, 6 - Imagen, 7 - Texto largo, 9 - Selección múltiple, 10 - Selección única con imagen, 11 - Selección múltiple con imagen | |||
| customTags/defaultValue | Opcional | string | |
| Valor por defecto de la etiqueta. Solo útil si la etiqueta es multiidioma. | |||
| customTags/filterable | Opcional | true | boolean |
| Booleano que indica que la etiqueta se mostrarà en el filtro de la tienda. | |||
| customTags/inOrders | Opcional | true | boolean |
| Booleano que indica que la etiqueta se exportará en el pedido. | |||
| customTags/itemType | Opcional | numeric | |
| Número entero que indica el tipo de etiqueta. Valores permitidos: 1 - Productos, 2 - Categorías, 3 - Páginas, 10 - Accounts, 13 - Pedidos | |||
| customTags/languages | Opcional | array [0:n] | |
| Bloque con información variable según el idioma | |||
| customTags/languages/defaultValue | Opcional | string | |
| Valor por defecto de la etiqueta. Solo útil si la etiqueta está marcada como idiomas únicos. | |||
| customTags/languages/languageCode | Obligatorio | string | |
| Etiqueta de idioma según el estándar internacional BCP 47. Las etiquetas base (p.ej. 'en') deben corresponder a un idioma base conectado al commerce; las variantes regionales (p.ej. 'en-US') deben corresponder a un idioma regionalizado conectado al commerce y requieren que el array 'languages' contenga también una entrada para su idioma base. | |||
| customTags/languages/name | Opcional | string | |
| Nombre del elemento para el idioma especificado | |||
| customTags/maxValue | Opcional | string | |
| Establece valor máximo que puede tener la etiqueta | |||
| customTags/minValue | Opcional | string | |
| Establece valor mínimo que puede tener la etiqueta | |||
| customTags/nameOnFeed | Opcional | string | |
| Nombre para el feed | |||
| customTags/pId | Opcional | string | |
| Identificador público del elemento | |||
| customTags/position | Opcional | numeric | |
| Número entero que simboliza la ubicación de este elemento en el Frontoffice. | |||
| customTags/priority | Opcional | numeric | |
| Define el orden de presentación de la etiqueta en relación al resto de etiquetas que se encuentran en su mismo nivel. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
| customTags/required | Opcional | true | boolean |
| Booleano que indica si el valor para la etiqueta es obligatorio. | |||
| customTags/searchable | Opcional | true | boolean |
| Booleano que indica si los valores de etiqueta pueden ser buscables en la tienda. | |||
| customTags/valueForAllLanguages | Opcional | boolean | |
| Booleano que indica si los valores de la etiqueta seran únicos por idioma o multiidioma. Valores permitidos: false - Únicos: Los valores pueden ser diferentes para cada idioma, true - Múltiples idiomas: Los valores son los mismos para todos los idiomas. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACTIVE" : true,
"COMPARABLE" : false,
"CONTROLTYPE" : 3,
"DEFAULTVALUE" :"",
"FILTERABLE" : false,
"GROUPS": [
{
"GROUP": {
"ID" : 123,
"PID" :"pId"
},
"PRIORITY" : 1
}
],
"HIGHLIGHT" : false,
"ID" : 3,
"INORDERS" : 0,
"ITEMTYPE" : 2,
"LANGUAGES": [
{
"DEFAULTVALUE" :"",
"ID" : 6,
"LANGUAGE" :"ES",
"NAME" :"Tamaño"
}
],
"MAXVALUE" :"5",
"MINVALUE" :"1",
"NAMEONFEED" :"features",
"PID" :"size",
"PLUGINID" : 0,
"POSITION" : 10,
"PRIORITY" : 0,
"REQUIRED" : false,
"SEARCHABLE" : false,
"SHOWINSEARCH" : false,
"VALUEFORALLLANGUAGES" : false
}
DELETE/customTags/{id}
Descripción
Elimina la etiqueta indicada mediante el indentificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 1
}
GET/customTags/{id}/groups
Descripción
Devuelve el listado de grupos de etiquetas vinculadas
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags/1/groups
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"GROUPS": [
{
"GROUP": {
"ID" : 123,
"PID" :"Pid"
},
"PRIORITY" : 1
}
]
}
POST/customTags/{id}/groups
Descripción
Vinculación de un grupo de etiquetas
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags/1/groups
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "groups": { "group": { "id":numeric, "pId":string }, "priority":numeric } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| groups | Obligatorio | struct | |
| Bloque de información que contiene la definición de la vinculación de grupo | |||
| groups/group | Obligatorio | struct | |
| Bloque de información que contiene el identificador de grupo. | |||
| groups/group/id | Opcional | 0 | numeric |
| Identificador interno del elemento. Opcional en caso que se use identificador público (si lo tiene, en caso contrario es obligatorio). | |||
| groups/group/pId | Opcional | string | |
| Identificador público del elemento(si lo tiene). Opcional en caso que se use identificador interno. | |||
| groups/priority | Obligatorio | numeric | |
| Prioridad | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"GROUPS": [
{
"GROUP": {
"ID" : 123,
"PID" :"Pid"
},
"PRIORITY" : 1
}
]
}
DELETE/customTags/{id}/groups
Descripción
Desvincula todos los grupos de etiquetas
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags/1/groups
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"GROUPS": [
]
}
DELETE/customTags/{id}/groups/{groupId}
Descripción
Desvincula un grupo de etiquetas
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags/1/groups/{groupId}
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"GROUPS": [
{
"GROUP": {
"ID" : 123,
"PID" :"Pid"
},
"PRIORITY" : 1
}
]
}
GET/customTags/{id}/ranges
Descripción
Devuelve el listado de rangos de la etiqueta indicada mediante el identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags/1/ranges
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"RANGES": [
{
"ACTIVE" : true,
"CUSTOMTAGID" : 1,
"ID" : 1,
"INTERVALS": [
{
"ID" : 1,
"PRIORITY" : 1
}
],
"NAME" :"Range A"
}
]
}
POST/customTags/{id}/ranges
Descripción
Creación de un nuevo rango para la etiqueta indicada mediante el identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags/1/ranges
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "ranges": { "active":boolean, "intervals": [ { "conditions": [ { "conditionType":numeric, "operator":numeric, "value":string } ], "languages": [ { "description":string, "languageCode":string, "name":string } ], "priority":numeric } ], "name":string } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| ranges | Obligatorio | struct | |
| Bloque de información que contiene la definición del rango. | |||
| ranges/active | Opcional | true | boolean |
| Booleano que indica si el rango está activo. | |||
| ranges/intervals | Opcional | array [0:n] | |
| Lista opcional de intervalos a crear dentro del rango. | |||
| ranges/intervals/conditions | Opcional | array [0:n] | |
| Lista de condiciones que definen cuándo aplica este intervalo. | |||
| ranges/intervals/conditions/conditionType | Obligatorio | numeric | |
| Operador de comparación para la condición. Valores permitidos: 1 - Igual (EQ), 2 - No igual (NEQ), 3 - Mayor que (GT), 4 - Mayor o igual que (GTE), 5 - Menor que (LT), 6 - Menor o igual que (LTE) | |||
| ranges/intervals/conditions/operator | Opcional | numeric | |
| Operador lógico para combinar esta condición con la siguiente. Valores permitidos: 1 - AND, 2 - OR | |||
| ranges/intervals/conditions/value | Obligatorio | string | |
| Valor con el que comparar usando el tipo de condición especificado. | |||
| ranges/intervals/languages | Opcional | array [0:n] | |
| Bloque con información variable según el idioma. | |||
| ranges/intervals/languages/description | Opcional | string | |
| Descripción del intervalo para el idioma especificado. | |||
| ranges/intervals/languages/languageCode | Obligatorio | string | |
| Etiqueta de idioma según el estándar internacional BCP 47. Las etiquetas base (p.ej. 'en') deben corresponder a un idioma base conectado al commerce; las variantes regionales (p.ej. 'en-US') deben corresponder a un idioma regionalizado conectado al commerce y requieren que el array 'languages' contenga también una entrada para su idioma base. | |||
| ranges/intervals/languages/name | Opcional | string | |
| Nombre del intervalo para el idioma especificado. | |||
| ranges/intervals/priority | Obligatorio | numeric | |
| Número entero que define el orden de evaluación del intervalo. Los valores menores tienen mayor prioridad. | |||
| ranges/name | Obligatorio | string | |
| Nombre del rango. | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"ACTIVE" : true,
"CUSTOMTAGID" : 1,
"ID" : 1,
"INTERVALS": [
{
"CONDITIONS": [
{
"CONDITIONTYPE" : 4,
"CUSTOMTAGRANGEINTERVALID" : 1,
"ID" : 1,
"VALUE" :"10"
}
],
"ID" : 1,
"LANGUAGES": [
{
"DESCRIPTION" :"",
"LANGUAGE" :"ES",
"NAME" :"Range A"
}
],
"PRIORITY" : 1
}
],
"NAME" :"Range A"
}
GET/customTags/{id}/values
Descripción
Devuelve los valores de la etiqueta indicado mediante el identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags/1/values
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"VALUES": [
{
"ID" : 9,
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"VALUE" :"vNEW"
},
{
"LANGUAGE" :"EN",
"VALUE" :"vNEW"
}
],
"PID" :"vNEWINTERNAL1",
"VALUE" :""
}
]
}
POST/customTags/{id}/values
Descripción
Creación de un valor de etiqueta indicado de tipo desplegable mediante el indentificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags/1/values
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "values": { "image":string, "languages": [ { "languageCode":string, "value":string } ], "numericValue":numeric, "pId":string } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| values | Obligatorio | struct | |
| Bloque de información que contiene la definición del valor de etiquetas. | |||
| values/image | Opcional | string | |
| Ruta de la imagen del valor de etiqueta. Aplicable cuando el controlType es de tipo imagen seleccionable (10 - Selección única con imagen, 11 - Selección múltiple con imagen). | |||
| values/languages | Opcional | array [0:n] | |
| Bloque con información variable según el idioma | |||
| values/languages/languageCode | Obligatorio | string | |
| Etiqueta de idioma según el estándar internacional BCP 47. Las etiquetas base (p.ej. 'en') deben corresponder a un idioma base conectado al commerce; las variantes regionales (p.ej. 'en-US') deben corresponder a un idioma regionalizado conectado al commerce y requieren que el array 'languages' contenga también una entrada para su idioma base. | |||
| values/languages/value | Obligatorio | string | |
| Valor | |||
| values/numericValue | Opcional | numeric | |
| Valor numérico utilizado para la evaluación de intervalos basados en rangos. | |||
| values/pId | Obligatorio | string | |
| Identificador público del elemento | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"ID" : 9,
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"VALUE" :"vNEW"
},
{
"LANGUAGE" :"EN",
"VALUE" :"vNEW"
}
],
"PID" :"vNEWINTERNAL1",
"VALUE" :""
}
DELETE/customTags/{id}/values
Descripción
Elimina el valor de etiqueta indicado mediante el indentificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags/1/values
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 1
}
GET/customTags/getId/{pId}
Descripción
Devuelve el identificador interno de la etiqueta.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags/getId/abc
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| pId | Obligatorio | string | |
| Identificador público. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 143
}
GET/customTags/rangeIntervalConditions/{id}
Descripción
Devuelve la información de la condición indicada mediante el identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags/rangeIntervalConditions/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"CONDITIONTYPE" : 4,
"CUSTOMTAGRANGEINTERVALID" : 1,
"ID" : 1,
"VALUE" :"10"
}
PUT/customTags/rangeIntervalConditions/{id}
Descripción
Edición de la condición indicada mediante el identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags/rangeIntervalConditions/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "conditions": { "conditionType":numeric, "operator":numeric, "value":string } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| conditions | Obligatorio | struct | |
| Bloque de información que contiene la definición de la condición. | |||
| conditions/conditionType | Opcional | numeric | |
| Operador de comparación para la condición. Valores permitidos: 1 - Igual (EQ), 2 - No igual (NEQ), 3 - Mayor que (GT), 4 - Mayor o igual que (GTE), 5 - Menor que (LT), 6 - Menor o igual que (LTE) | |||
| conditions/operator | Opcional | numeric | |
| Operador lógico para combinar esta condición con la siguiente. Valores permitidos: 1 - AND, 2 - OR | |||
| conditions/value | Opcional | string | |
| Valor con el que comparar usando el tipo de condición especificado. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"CONDITIONTYPE" : 4,
"CUSTOMTAGRANGEINTERVALID" : 1,
"ID" : 1,
"VALUE" :"10"
}
DELETE/customTags/rangeIntervalConditions/{id}
Descripción
Elimina la condición indicada mediante el identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags/rangeIntervalConditions/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 1
}
GET/customTags/rangeIntervals/{id}
Descripción
Devuelve la información del intervalo indicado mediante el identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags/rangeIntervals/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"CONDITIONS": [
{
"CONDITIONTYPE" : 4,
"CUSTOMTAGRANGEINTERVALID" : 1,
"ID" : 1,
"VALUE" :"10"
}
],
"CUSTOMTAGRANGEID" : 1,
"ID" : 1,
"LANGUAGES": [
{
"DESCRIPTION" :"",
"LANGUAGE" :"ES",
"NAME" :"Interval A"
}
],
"PRIORITY" : 1
}
PUT/customTags/rangeIntervals/{id}
Descripción
Edición del intervalo indicado mediante el identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags/rangeIntervals/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "intervals": { "languages": [ { "description":string, "languageCode":string, "name":string } ], "priority":numeric } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| intervals | Obligatorio | struct | |
| Bloque de información que contiene la definición del intervalo. | |||
| intervals/languages | Opcional | array [0:n] | |
| Bloque con información variable según el idioma. | |||
| intervals/languages/description | Opcional | string | |
| Descripción del intervalo para el idioma especificado. | |||
| intervals/languages/languageCode | Obligatorio | string | |
| Etiqueta de idioma según el estándar internacional BCP 47. Las etiquetas base (p.ej. 'en') deben corresponder a un idioma base conectado al commerce; las variantes regionales (p.ej. 'en-US') deben corresponder a un idioma regionalizado conectado al commerce y requieren que el array 'languages' contenga también una entrada para su idioma base. | |||
| intervals/languages/name | Opcional | string | |
| Nombre del intervalo para el idioma especificado. | |||
| intervals/priority | Opcional | numeric | |
| Número entero que define el orden de evaluación del intervalo. Los valores menores tienen mayor prioridad. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"CONDITIONS": [
{
"CONDITIONTYPE" : 4,
"CUSTOMTAGRANGEINTERVALID" : 1,
"ID" : 1,
"VALUE" :"10"
}
],
"CUSTOMTAGRANGEID" : 1,
"ID" : 1,
"LANGUAGES": [
{
"DESCRIPTION" :"",
"LANGUAGE" :"ES",
"NAME" :"Interval A"
}
],
"PRIORITY" : 1
}
DELETE/customTags/rangeIntervals/{id}
Descripción
Elimina el intervalo indicado mediante el identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags/rangeIntervals/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 1
}
GET/customTags/rangeIntervals/{id}/conditions
Descripción
Devuelve el listado de condiciones del intervalo indicado mediante el identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags/rangeIntervals/1/conditions
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"CONDITIONS": [
{
"CONDITIONTYPE" : 4,
"CUSTOMTAGRANGEINTERVALID" : 1,
"ID" : 1,
"VALUE" :"10"
}
]
}
POST/customTags/rangeIntervals/{id}/conditions
Descripción
Creación de una nueva condición para el intervalo indicado mediante el identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags/rangeIntervals/1/conditions
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "conditions": { "conditionType":numeric, "operator":numeric, "value":string } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| conditions | Obligatorio | struct | |
| Bloque de información que contiene la definición de la condición. | |||
| conditions/conditionType | Obligatorio | numeric | |
| Operador de comparación para la condición. Valores permitidos: 1 - Igual (EQ), 2 - No igual (NEQ), 3 - Mayor que (GT), 4 - Mayor o igual que (GTE), 5 - Menor que (LT), 6 - Menor o igual que (LTE) | |||
| conditions/operator | Opcional | numeric | |
| Operador lógico para combinar esta condición con la siguiente. Valores permitidos: 1 - AND, 2 - OR | |||
| conditions/value | Obligatorio | string | |
| Valor con el que comparar usando el tipo de condición especificado. | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"CONDITIONTYPE" : 4,
"CUSTOMTAGRANGEINTERVALID" : 1,
"ID" : 1,
"VALUE" :"10"
}
GET/customTags/ranges/{id}
Descripción
Devuelve la información del rango indicado mediante el identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags/ranges/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACTIVE" : true,
"CUSTOMTAGID" : 1,
"ID" : 1,
"INTERVALS": [
{
"CONDITIONS": [
{
"CONDITIONTYPE" : 4,
"CUSTOMTAGRANGEINTERVALID" : 1,
"ID" : 1,
"VALUE" :"10"
}
],
"ID" : 1,
"LANGUAGES": [
{
"DESCRIPTION" :"",
"LANGUAGE" :"ES",
"NAME" :"Range A"
}
],
"PRIORITY" : 1
}
],
"NAME" :"Range A"
}
PUT/customTags/ranges/{id}
Descripción
Edición del rango indicado mediante el identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags/ranges/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "ranges": { "active":boolean, "name":string } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| ranges | Obligatorio | struct | |
| Bloque de información que contiene la definición del rango. | |||
| ranges/active | Opcional | boolean | |
| Booleano que indica si el rango está activo. | |||
| ranges/name | Opcional | string | |
| Nombre del rango. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACTIVE" : true,
"CUSTOMTAGID" : 1,
"ID" : 1,
"INTERVALS": [
{
"CONDITIONS": [
{
"CONDITIONTYPE" : 4,
"CUSTOMTAGRANGEINTERVALID" : 1,
"ID" : 1,
"VALUE" :"10"
}
],
"ID" : 1,
"LANGUAGES": [
{
"DESCRIPTION" :"",
"LANGUAGE" :"ES",
"NAME" :"Range A"
}
],
"PRIORITY" : 1
}
],
"NAME" :"Range A"
}
DELETE/customTags/ranges/{id}
Descripción
Elimina el rango indicado mediante el identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags/ranges/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 1
}
GET/customTags/ranges/{id}/intervals
Descripción
Devuelve el listado de intervalos del rango indicado mediante el identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags/ranges/1/intervals
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"INTERVALS": [
{
"ID" : 1,
"PRIORITY" : 1
}
]
}
POST/customTags/ranges/{id}/intervals
Descripción
Creación de un nuevo intervalo para el rango indicado mediante el identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags/ranges/1/intervals
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "intervals": { "conditions": [ { "conditionType":numeric, "operator":numeric, "value":string } ], "languages": [ { "description":string, "languageCode":string, "name":string } ], "priority":numeric } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| intervals | Obligatorio | struct | |
| Bloque de información que contiene la definición del intervalo. | |||
| intervals/conditions | Opcional | array [0:n] | |
| Lista de condiciones que definen cuándo aplica este intervalo. | |||
| intervals/conditions/conditionType | Obligatorio | numeric | |
| Operador de comparación para la condición. Valores permitidos: 1 - Igual (EQ), 2 - No igual (NEQ), 3 - Mayor que (GT), 4 - Mayor o igual que (GTE), 5 - Menor que (LT), 6 - Menor o igual que (LTE) | |||
| intervals/conditions/operator | Opcional | numeric | |
| Operador lógico para combinar esta condición con la siguiente. Valores permitidos: 1 - AND, 2 - OR | |||
| intervals/conditions/value | Obligatorio | string | |
| Valor con el que comparar usando el tipo de condición especificado. | |||
| intervals/languages | Opcional | array [0:n] | |
| Bloque con información variable según el idioma. | |||
| intervals/languages/description | Opcional | string | |
| Descripción del intervalo para el idioma especificado. | |||
| intervals/languages/languageCode | Obligatorio | string | |
| Etiqueta de idioma según el estándar internacional BCP 47. Las etiquetas base (p.ej. 'en') deben corresponder a un idioma base conectado al commerce; las variantes regionales (p.ej. 'en-US') deben corresponder a un idioma regionalizado conectado al commerce y requieren que el array 'languages' contenga también una entrada para su idioma base. | |||
| intervals/languages/name | Opcional | string | |
| Nombre del intervalo para el idioma especificado. | |||
| intervals/priority | Obligatorio | numeric | |
| Número entero que define el orden de evaluación del intervalo. Los valores menores tienen mayor prioridad. | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"CONDITIONS": [
{
"CONDITIONTYPE" : 4,
"CUSTOMTAGRANGEINTERVALID" : 1,
"ID" : 1,
"VALUE" :"10"
}
],
"CUSTOMTAGRANGEID" : 1,
"ID" : 1,
"LANGUAGES": [
{
"DESCRIPTION" :"",
"LANGUAGE" :"ES",
"NAME" :"Interval A"
}
],
"PRIORITY" : 1
}
GET/customTags/values/{id}
Descripción
Devuelve la información del valor de etiqueta indicado mediante el identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags/values/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 9,
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"VALUE" :"vNEW"
},
{
"LANGUAGE" :"EN",
"VALUE" :"vNEW"
}
],
"PID" :"vNEWINTERNAL1",
"VALUE" :""
}
PUT/customTags/values/{id}
Descripción
Edición del valor de etiqueta indicado mediante el indentificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags/values/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "values": { "image":string, "languages": [ { "languageCode":string, "value":string } ], "numericValue":numeric, "pId":string } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| values | Obligatorio | struct | |
| Bloque de información que contiene la definición del valor de etiquetas. | |||
| values/image | Opcional | string | |
| Ruta de la imagen del valor de etiqueta. Aplicable cuando el controlType es de tipo imagen seleccionable (10 - Selección única con imagen, 11 - Selección múltiple con imagen). | |||
| values/languages | Opcional | array [0:n] | |
| Bloque con información variable según el idioma | |||
| values/languages/languageCode | Obligatorio | string | |
| Etiqueta de idioma según el estándar internacional BCP 47. Las etiquetas base (p.ej. 'en') deben corresponder a un idioma base conectado al commerce; las variantes regionales (p.ej. 'en-US') deben corresponder a un idioma regionalizado conectado al commerce y requieren que el array 'languages' contenga también una entrada para su idioma base. | |||
| values/languages/value | Opcional | string | |
| Valor | |||
| values/numericValue | Opcional | numeric | |
| Valor numérico utilizado para la evaluación de intervalos basados en rangos. | |||
| values/pId | Opcional | string | |
| Identificador público del elemento | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 9,
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"VALUE" :"vNEW"
},
{
"LANGUAGE" :"EN",
"VALUE" :"vNEW"
}
],
"PID" :"vNEWINTERNAL1",
"VALUE" :""
}
DELETE/customTags/values/{id}
Descripción
Elimina el valor de etiqueta indicado mediante el indentificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/customTags/values/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 1
}