Áreas
Endpoint para gestionar el apartado de áreas. Está compuesto por una colección de recursos que permiten realizar todas las acciones de administración asociadas, como crear nuevas áreas, modificarlas o eliminarlas. También permite acciones más comunes como establecer filtros de filtros de usuarios/grupos y/o países/zonas.
</> GET / areasDevuelve el listado de áreas.
</> POST / areasCreación de una nueva área.
</> GET / areas/{id}Devuelve la información del área indicada mediante identificador interno.
</> PUT / areas/{id}Edición del área indicada mediante identificador interno.
</> DELETE / areas/{id}Elimina el área indicada mediante identificador interno.
</> GET / areas/{id}/activityLimitsDevuelve la información de los periodos de actividad del área indicada.
</> POST / areas/{id}/activityLimitsCreación de un periodo de actividad para el área indicada.
</> DELETE / areas/{id}/activityLimitsElimina todos los periodos de actividad del área indicada.
</> GET / areas/{id}/areaItemsDevuelve los filtros asignados al área indicada.
</> POST / areas/{id}/areaItemsCreación de un filtro para el área indicada.
</> DELETE / areas/{id}/areaItemsElimina todos los filtros asignados del área indicada.
</> GET / areas/activityLimits/{id}Devuelve la información sobre el periodo de activitad indicado.
</> PUT / areas/activityLimits/{id}Edición del periodo de actividad indicado.
</> DELETE / areas/activityLimits/{id}Elimina el periodo de actividad indicado.
</> GET / areas/areaItems/{id}Devuelve la información sobre el filtro indicado.
</> DELETE / areas/areaItems/{id}Elimina el filtro indicado.
</> GET / areas/countDevuelve un valor que indica la cantidad de áreas.
</> GET / areas/getCategoryRoleDevuelve la información del área con rol de categoría.
</> GET / areas/getId/{pId}Devuelve el identificador interno del área.
GET /areas
Descripción
Devuelve el listado de áreas. 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/areas
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| countryCode | Opcional | string | |
| Devuelve elementos asociados al país. Formato ISO 3166-1 alpha-2. Más información en el recurso: util/countries. | |||
| fields | Opcional | string | |
| Lista de campos a devolver. | |||
| groupId | Opcional | 0 | numeric |
| Devuelve elementos asociados al grupo indicado mediante identificador interno. | |||
| languageCode | Opcional | string | |
| Devuelve elementos asociados al idioma. Formato ISO 639-1 de dos dígitos. | |||
| 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. | |||
| showOnlyVisible | Opcional | false | boolean |
| Devuelve únicamente elementos visibles. | |||
| sort | Opcional | name | string |
| Variable de ordenación. | |||
| userId | Opcional | 0 | numeric |
| Devuelve elementos asociados al usuario indicado mediante identificador interno. | |||
| zoneId | Opcional | 0 | numeric |
| Devuelve elementos asociados a la zona indicada mediante identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"AREAS": [
{
"ACTIVE" : 1,
"ACTIVITYLIMITS": [
{
"ACTIVATIONDATE" :"2015-11-02",
"EXPIRATIONDATE" :"2015-11-20",
"ID" : 23535
}
],
"AREAITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
],
"CATEGORYROLE" : true,
"ID" : 43,
"LANGUAGES": [
{
"DESCRIPTION" :"",
"LANGUAGE" :"ES",
"NAME" :"Area Language 1"
}
],
"NAME" :"Area 1",
"PID" :"abcd",
"POSITION" : 12,
"PRIORITY" : 1,
"SEO": {
"LANGUAGES": [
{
"KEYWORDS" :"",
"LANGUAGE" :"ES",
"METADESCRIPTION" :"",
"PARTICULARTITLE" :"",
"URLSEO" :""
}
]
}
}
],
"ITEMS" : 7
}
POST /areas
Descripción
Creación de una nueva área.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/areas
Parámetros de entrada JSON
{ "areas": { "activityLimits": [ { "activationDate": datetime "expirationDate": datetime } ], "areaItems": [ { "id":numeric, "itemType":numeric, "pId":string } ], "languages": [ { "languageCode":string, "description": string "indexable": boolean "linkFollowing": boolean "name": string } ], "name":string, "pId":string, "seo": { "languages": [ { "keywords":string, "languageCode":string, "metaDescription":string, "particularTitle":string, "urlSeo":string } ] }, "categoryRole": boolean "active": boolean "position": numeric "priority": numeric } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| areas | Obligatorio | struct | |
| Bloque de información que contiene la definición de un área. | |||
| areas/active | Opcional | false | boolean |
| Define si el área es visible (si esta activa). | |||
| areas/activityLimits | Opcional | array [0:n] | |
| Bloque con información sobre los periodos de actividad. | |||
| areas/activityLimits/activationDate | Obligatorio | datetime | |
| Fecha en la que el elemento se activará. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
| areas/activityLimits/expirationDate | Obligatorio | datetime | |
| Fecha de expiración. Es el último día en que el elemento está activo. Al día siguiente a esta fecha el elemento se desactivará. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
| areas/areaItems | Opcional | array [0:n] | |
| Bloque de información sobre los filtros aplicados a este elemento. | |||
| areas/areaItems/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). | |||
| areas/areaItems/itemType | Obligatorio | numeric | |
| Tipo de filtro. Valores permitidos: 10 - Usuario, 11 - Grupo de usuario, 30 - Países, 9 - Zonas de países | |||
| areas/areaItems/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. | |||
| areas/categoryRole | Obligatorio | boolean | |
| Indica si el área tiene rol de categorías. Esto implica que las categorías y productos que contiene el área son las que se cargan y visualizan por defecto en el FrontOffice. | |||
| areas/languages | Opcional | array [0:n] | |
| Bloque con información variable según el idioma. | |||
| areas/languages/description | Opcional | string | |
| Descripción del área para el idioma seleccionado. | |||
| areas/languages/indexable | Opcional | true | boolean |
| areas/languages/languageCode | Obligatorio | string | |
| Indica el código de idioma. Formato ISO 639-1 de dos dígitos. Más información en el recurso: util/languages. | |||
| areas/languages/linkFollowing | Opcional | true | boolean |
| areas/languages/name | Opcional | string | |
| Nombre del área para el idioma seleccionado. | |||
| areas/name | Obligatorio | string | |
| Indica el nombre del elemento a nivel interno. No se muestra en el Frontoffice. | |||
| areas/pId | Obligatorio | string | |
| Identificador público del área. | |||
| areas/position | Opcional | 1 | numeric |
| Número entero que simboliza la ubicación de este elemento en el Frontoffice. | |||
| areas/priority | Opcional | 0 | numeric |
| Define el orden de presentación de este área en relación al resto de áreas que se encuentran en su mismo nivel. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
| areas/seo | Opcional | struct | |
| Bloque con información de posicionamiento SEO. | |||
| areas/seo/languages | Opcional | array [0:n] | |
| Bloque con los datos SEO que dependen del idioma. | |||
| areas/seo/languages/keywords | Opcional | string | |
| Palabras clave del área para el idioma seleccionado. Separadas por coma ','. | |||
| areas/seo/languages/languageCode | Obligatorio | string | |
| Indica el código de idioma. Formato ISO 639-1 de dos dígitos. Más información en el recurso: util/languages. | |||
| areas/seo/languages/metaDescription | Opcional | string | |
| Contenido del metatag de descripción para el idioma seleccionado.La etiqueta meta descripción nos ayuda a indicar cuál es el contenido de nuestra página, de este modo los buscadores de internet, recogen esta información y clasifican la página en una temática en función del contenido. Longitud Máxima: 255 (156 recomendado). | |||
| areas/seo/languages/particularTitle | Opcional | string | |
| Título de la ventana del área para el idioma seleccionado. En navegadores actuales, es el título de la pestaña. Longitud Máxima: 255 (61 recomendado). | |||
| areas/seo/languages/urlSeo | Opcional | string | |
| URL SEO del área para el idioma seleccionado. Debe ser única entre todas las URL SEO incluso entre las URL de otros módulos (productos, marcas,…), incluidas las URL de otros idiomas de la misma área. Esta es una ruta amigable que sustituye la ruta de acceso al contenido. Esta ruta es indexada por los buscadores. Caracteres permitidos: abcdefghijklmnopqrstuvwxyz1234567890_- | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"ACTIVE" : 1,
"ACTIVITYLIMITS": [
{
"ACTIVATIONDATE" :"2015-11-02",
"EXPIRATIONDATE" :"2015-11-20",
"ID" : 23535
}
],
"AREAITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
],
"CATEGORYROLE" : true,
"ID" : 43,
"LANGUAGES": [
{
"DESCRIPTION" :"",
"LANGUAGE" :"ES",
"NAME" :"Area Language 1"
}
],
"NAME" :"Area 1",
"PID" :"abcd",
"POSITION" : 12,
"PRIORITY" : 1,
"SEO": {
"LANGUAGES": [
{
"KEYWORDS" :"",
"LANGUAGE" :"ES",
"METADESCRIPTION" :"",
"PARTICULARTITLE" :"",
"URLSEO" :""
}
]
}
}
GET /areas/{id}
Descripción
Devuelve la información del área indicada mediante identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/areas/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
| fields | Opcional | string | |
| Lista de campos a devolver. | |||
| languageCode | Opcional | string | |
| Devuelve elementos asociados al idioma. Formato ISO 639-1 de dos dígitos. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACTIVE" : 1,
"ACTIVITYLIMITS": [
{
"ACTIVATIONDATE" :"2015-11-02",
"EXPIRATIONDATE" :"2015-11-20",
"ID" : 23535
}
],
"AREAITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
],
"CATEGORYROLE" : true,
"ID" : 43,
"LANGUAGES": [
{
"DESCRIPTION" :"",
"LANGUAGE" :"ES",
"NAME" :"Area Language 1"
}
],
"NAME" :"Area 1",
"PID" :"abcd",
"POSITION" : 12,
"PRIORITY" : 1,
"SEO": {
"LANGUAGES": [
{
"KEYWORDS" :"",
"LANGUAGE" :"ES",
"METADESCRIPTION" :"",
"PARTICULARTITLE" :"",
"URLSEO" :""
}
]
}
}
PUT /areas/{id}
Descripción
Edición del área indicada mediante identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/areas/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "areas": { "active":boolean, "categoryRole":boolean, "languages": [ { "languageCode":string, "description": string "indexable": boolean "linkFollowing": boolean "name": string } ], "pId":string, "position":numeric, "priority":numeric, "seo": { "languages": [ { "keywords":string, "languageCode":string, "metaDescription":string, "particularTitle":string, "urlSeo":string } ] }, "name": string } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| areas | Obligatorio | struct | |
| Bloque de información que contiene la definición de un área. | |||
| areas/active | Opcional | false | boolean |
| Define si el área es visible (si esta activa). | |||
| areas/categoryRole | Opcional | boolean | |
| Indica si el área tiene rol de categorías. Esto implica que las categorías y productos que contiene el área son las que se cargan y visualizan por defecto en el FrontOffice. | |||
| areas/languages | Opcional | array [0:n] | |
| Bloque con información variable según el idioma. | |||
| areas/languages/description | Opcional | string | |
| Descripción del área para el idioma seleccionado. | |||
| areas/languages/indexable | Opcional | true | boolean |
| areas/languages/languageCode | Obligatorio | string | |
| Indica el código de idioma. Formato ISO 639-1 de dos dígitos. Más información en el recurso: util/languages. | |||
| areas/languages/linkFollowing | Opcional | true | boolean |
| areas/languages/name | Opcional | string | |
| Nombre del área para el idioma seleccionado. | |||
| areas/name | Opcional | string | |
| Indica el nombre del elemento a nivel interno. No se muestra en el Frontoffice. | |||
| areas/pId | Opcional | string | |
| Identificador público del área. | |||
| areas/position | Opcional | 1 | numeric |
| Número entero que simboliza la ubicación de este elemento en el Frontoffice. | |||
| areas/priority | Opcional | 0 | numeric |
| Define el orden de presentación de este área en relación al resto de áreas que se encuentran en su mismo nivel. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
| areas/seo | Opcional | struct | |
| Bloque con información de posicionamiento SEO. | |||
| areas/seo/languages | Opcional | array [0:n] | |
| Bloque con los datos SEO que dependen del idioma. | |||
| areas/seo/languages/keywords | Opcional | string | |
| Palabras clave del área para el idioma seleccionado. Separadas por coma ','. | |||
| areas/seo/languages/languageCode | Obligatorio | string | |
| Indica el código de idioma. Formato ISO 639-1 de dos dígitos. Más información en el recurso: util/languages. | |||
| areas/seo/languages/metaDescription | Opcional | string | |
| Contenido del metatag de descripción para el idioma seleccionado.La etiqueta meta descripción nos ayuda a indicar cuál es el contenido de nuestra página, de este modo los buscadores de internet, recogen esta información y clasifican la página en una temática en función del contenido. Longitud Máxima: 255 (156 recomendado). | |||
| areas/seo/languages/particularTitle | Opcional | string | |
| Título de la ventana del área para el idioma seleccionado. En navegadores actuales, es el título de la pestaña. Longitud Máxima: 255 (61 recomendado). | |||
| areas/seo/languages/urlSeo | Opcional | string | |
| URL SEO del área para el idioma seleccionado. Debe ser única entre todas las URL SEO incluso entre las URL de otros módulos (productos, marcas,…), incluidas las URL de otros idiomas de la misma área. Esta es una ruta amigable que sustituye la ruta de acceso al contenido. Esta ruta es indexada por los buscadores. Caracteres permitidos: abcdefghijklmnopqrstuvwxyz1234567890_- | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACTIVE" : 1,
"ACTIVITYLIMITS": [
{
"ACTIVATIONDATE" :"2015-11-02",
"EXPIRATIONDATE" :"2015-11-20",
"ID" : 23535
}
],
"AREAITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
],
"CATEGORYROLE" : true,
"ID" : 43,
"LANGUAGES": [
{
"DESCRIPTION" :"",
"LANGUAGE" :"ES",
"NAME" :"Area Language 1"
}
],
"NAME" :"Area 1",
"PID" :"abcd",
"POSITION" : 12,
"PRIORITY" : 1,
"SEO": {
"LANGUAGES": [
{
"KEYWORDS" :"",
"LANGUAGE" :"ES",
"METADESCRIPTION" :"",
"PARTICULARTITLE" :"",
"URLSEO" :""
}
]
}
}
DELETE /areas/{id}
Descripción
Elimina el área indicada mediante identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/areas/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 /areas/{id}/activityLimits
Descripción
Devuelve la información de los periodos de actividad del área indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/areas/1/activityLimits
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACTIVITYLIMITS": [
{
"ACTIVATIONDATE" :"2015-11-02",
"EXPIRATIONDATE" :"2015-11-20",
"ID" : 23535
}
]
}
POST /areas/{id}/activityLimits
Descripción
Creación de un periodo de actividad para el área indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/areas/1/activityLimits
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "activityLimits": { "activationDate": datetime "expirationDate": datetime } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| activityLimits | Obligatorio | struct | |
| Bloque con información sobre los periodos de actividad. | |||
| activityLimits/activationDate | Obligatorio | datetime | |
| Fecha en la que el elemento se activará. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
| activityLimits/expirationDate | Obligatorio | datetime | |
| Fecha de expiración. Es el último día en que el elemento está activo. Al día siguiente a esta fecha el elemento se desactivará. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"ACTIVITYLIMITS": [
{
"ACTIVATIONDATE" :"2015-11-02",
"EXPIRATIONDATE" :"2015-11-20",
"ID" : 23535
}
]
}
DELETE /areas/{id}/activityLimits
Descripción
Elimina todos los periodos de actividad del área indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/areas/1/activityLimits
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACTIVITYLIMITS": [
]
}
GET /areas/{id}/areaItems
Descripción
Devuelve los filtros asignados al área 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/areas/1/areaItems
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"AREAITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
]
}
POST /areas/{id}/areaItems
Descripción
Creación de un filtro para el área indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/areas/1/areaItems
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "areaItems": { "id":numeric, "itemType":numeric, "pId":string } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| areaItems | Obligatorio | struct | |
| Bloque de información sobre los filtros aplicados a este elemento. | |||
| areaItems/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). | |||
| areaItems/itemType | Obligatorio | numeric | |
| Tipo de filtro. Valores permitidos: 10 - Usuario, 11 - Grupo de usuario, 30 - Países, 9 - Zonas de países | |||
| areaItems/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
{
"AREAITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
]
}
DELETE /areas/{id}/areaItems
Descripción
Elimina todos los filtros asignados del área indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/areas/1/areaItems
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"AREAITEMS": [
]
}
GET /areas/activityLimits/{id}
Descripción
Devuelve la información sobre el periodo de activitad indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/areas/activityLimits/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
{
"ACTIVATIONDATE" :"2015-11-02",
"EXPIRATIONDATE" :"2015-11-20",
"ID" : 23535
}
PUT /areas/activityLimits/{id}
Descripción
Edición del periodo de actividad indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/areas/activityLimits/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "activityLimits": { "activationDate":datetime, "expirationDate":datetime } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| activityLimits | Obligatorio | struct | |
| Bloque con información sobre los periodos de actividad. | |||
| activityLimits/activationDate | Opcional | datetime | |
| Fecha en la que el elemento se activará. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
| activityLimits/expirationDate | Opcional | datetime | |
| Fecha de expiración. Es el último día en que el elemento está activo. Al día siguiente a esta fecha el elemento se desactivará. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACTIVATIONDATE" :"2015-11-02",
"EXPIRATIONDATE" :"2015-11-20",
"ID" : 23535
}
DELETE /areas/activityLimits/{id}
Descripción
Elimina el periodo de actividad indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/areas/activityLimits/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 /areas/areaItems/{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/areas/areaItems/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 /areas/areaItems/{id}
Descripción
Elimina el filtro indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/areas/areaItems/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 /areas/count
Descripción
Devuelve un valor que indica la cantidad de áreas.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/areas/count
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| countryCode | Opcional | string | |
| Devuelve elementos asociados al país. Formato ISO 3166-1 alpha-2. Más información en el recurso: util/countries. | |||
| groupId | Opcional | 0 | numeric |
| Devuelve elementos asociados al grupo indicado mediante identificador interno. | |||
| 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. | |||
| showOnlyVisible | Opcional | false | boolean |
| Devuelve únicamente elementos visibles. | |||
| userId | Opcional | 0 | numeric |
| Devuelve elementos asociados al usuario indicado mediante identificador interno. | |||
| zoneId | Opcional | 0 | numeric |
| Devuelve elementos asociados a la zona indicada mediante identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ITEMS" : 143
}
GET /areas/getCategoryRole
Descripción
Devuelve la información del área con rol de categoría.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/areas/getCategoryRole
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| fields | Opcional | string | |
| Lista de campos a devolver. | |||
| languageCode | Opcional | string | |
| Devuelve elementos asociados al idioma. Formato ISO 639-1 de dos dígitos. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACTIVE" : 1,
"ACTIVITYLIMITS": [
{
"ACTIVATIONDATE" :"2015-11-02",
"EXPIRATIONDATE" :"2015-11-20",
"ID" : 23535
}
],
"AREAITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
],
"CATEGORYROLE" : true,
"ID" : 43,
"LANGUAGES": [
{
"DESCRIPTION" :"",
"LANGUAGE" :"ES",
"NAME" :"Area Language 1"
}
],
"NAME" :"Area 1",
"PID" :"abcd",
"POSITION" : 12,
"PRIORITY" : 1,
"SEO": {
"LANGUAGES": [
{
"KEYWORDS" :"",
"LANGUAGE" :"ES",
"METADESCRIPTION" :"",
"PARTICULARTITLE" :"",
"URLSEO" :""
}
]
}
}
GET /areas/getId/{pId}
Descripción
Devuelve el identificador interno del área.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/areas/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" : 13
}