Plantillas de personalización
El endpoint de plantillas de personalización permite la gestión del módulo de personalizaciones para realizar acciones como creación, modificación de la información básica o asignar elementos de filtrado como usuarios, grupos, paises o zonas. Estas plantillas establecen definiciones que se pueden vincular posteriomente a productos y categorías para particularizar precios o propiedades.
</> GET / definitionsDevuelve la lista de plantillas de personalización.
</> POST / definitionsCreación de una nueva plantilla de personalización.
</> GET / definitions/{id}Devuelve la información de la plantilla de personalización indicada mediante identificador interno.
</> PUT / definitions/{id}Edición de la plantilla de personalización indicada mediante identificador interno.
</> DELETE / definitions/{id}Elimina la plantilla de personalización indicada mediante identificador interno.
</> GET / definitions/{id}/definitionItemsDevuelve los filtros asignados a la plantilla de personalización indicada.
</> POST / definitions/{id}/definitionItemsCreación de un filtro para la plantilla de personalización indicada.
</> DELETE / definitions/{id}/definitionItemsElimina todos los filtros asignados de la plantilla de personalización indicada.
</> GET / definitions/definitionItems/{id}Devuelve la información sobre el filtro indicado.
</> DELETE / definitions/definitionItems/{id}Elimina el filtro indicado.
</> GET / definitions/getId/{pId}Devuelve el identificador interno de la plantilla de personalización.
GET /definitions
Descripción
Devuelve la lista de plantillas de personalización.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/definitions
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| fields | Opcional | string | |
| Lista de campos a devolver. | |||
| page | Opcional | 1 | numeric |
| Nº de página solicitada. | |||
| perPage | Opcional | 100 | numeric |
| Cantidad de elementos por página. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"DEFINITIONS": [
{
"DEFINITIONITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
],
"DESCRIPTION" :"Description abc",
"ID" : 43,
"NAME" :"Definition 1",
"PID" :"abc"
}
],
"ITEMS" : 1000
}
POST /definitions
Descripción
Creación de una nueva plantilla de personalización. Una vez creada, la plantilla establece una definición que podrá ser vinculada posteriomente a un producto o categoría para poder particularizar precios y/o propiedades.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/definitions
Parámetros de entrada JSON
{ "definitions": { "definitionItems": [ { "id":numeric, "pId":string, "itemType": numeric } ], "description":string, "name":string, "pId":string } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| definitions | Obligatorio | struct | |
| Bloque con información sobre la plantilla (definición). | |||
| definitions/definitionItems | Opcional | array [0:n] | |
| Bloque de información sobre los filtros aplicados a esta definición. | |||
| definitions/definitionItems/id | Opcional | 0 | numeric |
| Identificador interno del elemento que filtra. En caso que itemType sea 30, es el identificador del país en formato ISO 3166-1 numeric. Opcional en caso que se use identificador público (si lo tiene, en caso contrario es obligatorio). | |||
| definitions/definitionItems/itemType | Opcional | 0 | numeric |
| Tipo de filtro. Valores permitidos: 10 - Usuario, 11 - Grupo de usuario, 30 - Países, 9 - Zonas de países | |||
| definitions/definitionItems/pId | Opcional | string | |
| Identificador público del elemento que filtra (si lo tiene). En caso que itemType sea 30, es el identificador del país en formato ISO 3166-1 alpha-2. Opcional en caso que se use identificador interno. | |||
| definitions/description | Opcional | string | |
| Texto breve a modo de comentario interno. | |||
| definitions/name | Obligatorio | string | |
| Indica el nombre del elemento a nivel interno. | |||
| definitions/pId | Obligatorio | string | |
| Identificador público de la definición. | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"DEFINITIONITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
],
"DESCRIPTION" :"Description abc",
"ID" : 43,
"NAME" :"Definition 1",
"PID" :"abc"
}
GET /definitions/{id}
Descripción
Devuelve la información de la plantilla de personalización indicada mediante identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/definitions/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
{
"DEFINITIONITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
],
"DESCRIPTION" :"Description abc",
"ID" : 43,
"NAME" :"Definition 1",
"PID" :"abc"
}
PUT /definitions/{id}
Descripción
Edición de la plantilla de personalización indicada mediante identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/definitions/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "definitions": { "description":string, "name":string, "pId":string } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| definitions | Obligatorio | struct | |
| Bloque con información sobre la plantilla (definición). | |||
| definitions/description | Opcional | string | |
| Texto breve a modo de comentario interno. | |||
| definitions/name | Opcional | string | |
| Indica el nombre del elemento a nivel interno. | |||
| definitions/pId | Opcional | string | |
| Identificador público de la definición. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"DEFINITIONITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
],
"DESCRIPTION" :"Description abc",
"ID" : 43,
"NAME" :"Definition 1",
"PID" :"abc"
}
DELETE /definitions/{id}
Descripción
Elimina la plantilla de personalización indicada mediante identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/definitions/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 /definitions/{id}/definitionItems
Descripción
Devuelve los filtros asignados a la plantilla de personalización indicada.
Los tipos de filtro devueltos (itemType) son: 10 - Usuario, 11 - Grupo de usuario, 30 - Países, 9 - Zonas de países.
Los tipos de filtro devueltos (itemType) son: 10 - Usuario, 11 - Grupo de usuario, 30 - Países, 9 - Zonas de países.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/definitions/1/definitionItems
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"DEFINITIONITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
]
}
POST /definitions/{id}/definitionItems
Descripción
Creación de un filtro para la plantilla de personalización indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/definitions/1/definitionItems
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "definitionItems": { "id":numeric, "pId":string, "itemType": numeric } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| definitionItems | Obligatorio | struct | |
| Bloque de información sobre los filtros aplicados a esta definición. | |||
| definitionItems/id | Opcional | 0 | numeric |
| Identificador interno del elemento que filtra. En caso que itemType sea 30, es el identificador del país en formato ISO 3166-1 numeric. Opcional en caso que se use identificador público (si lo tiene, en caso contrario es obligatorio). | |||
| definitionItems/itemType | Opcional | 0 | numeric |
| Tipo de filtro. Valores permitidos: 10 - Usuario, 11 - Grupo de usuario, 30 - Países, 9 - Zonas de países | |||
| definitionItems/pId | Opcional | string | |
| Identificador público del elemento que filtra (si lo tiene). En caso que itemType sea 30, es el identificador del país en formato ISO 3166-1 alpha-2. Opcional en caso que se use identificador interno. | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"DEFINITIONITEMS": {
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
}
DELETE /definitions/{id}/definitionItems
Descripción
Elimina todos los filtros asignados de la plantilla de personalización indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/definitions/1/definitionItems
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"DEFINITIONITEMS": [
]
}
GET /definitions/definitionItems/{id}
Descripción
Devuelve la información sobre el filtro indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/definitions/definitionItems/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" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
DELETE /definitions/definitionItems/{id}
Descripción
Elimina el filtro indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/definitions/definitionItems/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 /definitions/getId/{pId}
Descripción
Devuelve el identificador interno de la plantilla de personalización.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/definitions/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
}