Páginas
Este endpoint permite la gestión del módulo de páginas del eCommerce y realizar acciones como la creación o la modificación de su información básica. También permite acciones relacionadas como administrar grupos de página o establecer su jerarquía o anidamiento.
</> POST / pagesCreación de una nueva página.
</> GET / pages/{id}Devuelve la información de la página indicada mediante identificador interno.
</> PUT / pages/{id}Edición de la página indicada mediante identificador interno.
</> DELETE / pages/{id}Elimina la página indicada mediante identificador interno.
</> GET / pages/{id}/activityLimitsDevuelve la información de los periodos de actividad de la página indicada.
</> POST / pages/{id}/activityLimitsCreación de un periodo de actividad para la página indicada.
</> DELETE / pages/{id}/activityLimitsElimina todos los periodos de actividad de la página indicada.
</> GET / pages/{id}/pageItemsDevuelve los filtros asignados a la página indicada.
</> POST / pages/{id}/pageItemsCreación de un filtro para la página indicada.
</> DELETE / pages/{id}/pageItemsElimina todos los filtros de la página indicada.
</> GET / pages/{id}/relatedItemsDevuelve la información de los elementos relacionados de la página indicada.
</> POST / pages/{id}/relatedItemsVincula elementos relacionados a la página indicada.
</> DELETE / pages/{id}/relatedItemsElimina todos los elementos relacionados de una página.
</> GET / pages/activityLimits/{id}Devuelve la información sobre el periodo de activitad indicado.
</> PUT / pages/activityLimits/{id}Edición del periodo de actividad indicado.
</> DELETE / pages/activityLimits/{id}Elimina el periodo de actividad indicado.
</> GET / pages/getId/{pId}Devuelve el identificador interno de la página.
</> GET / pages/pageItems/{id}Devuelve la información sobre el filtro indicado.
</> DELETE / pages/pageItems/{id}Elimina el filtro indicado.
</> GET / pages/relatedItems/{id}Devuelve la información del elemento relacionado indicado.
</> DELETE / pages/relatedItems/{id}Elimina el elemento relacionado indicado.
</> GET / pagesGroupsDevuelve el listado de los grupos de página.
</> POST / pagesGroupsCreación de un grupo de página.
</> GET / pagesGroups/{id}Devuelve la información del grupo de página indicado mediante identificador interno.
</> PUT / pagesGroups/{id}Edición del grupo de página indicado mediante identificador interno.
</> DELETE / pagesGroups/{id}Elimina el grupo de páginas indicado mediante identificador interno.
</> GET / pagesGroups/{id}/pagesDevuelve la información de las páginas del grupo indicado.
</> GET / pagesGroups/{id}/pages/countDevuelve la cantidad de las páginas del grupo indicado. Los parámetros de entrada permiten filtrar esta información.
</> GET / pagesGroups/countDevuelve un valor que indica la cantidad de grupos de páginas.
</> GET / pagesGroups/getId/{pId}Devuelve el identificador interno del grupo de páginas.
POST /pages
Descripción
Creación de una nueva página.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/pages
Parámetros de entrada JSON
{ "pages": { "activityLimits": [ { "activationDate": datetime "expirationDate": datetime } ], "group": { "id":numeric, "pId":string }, "languages": [ { "languageCode":string, "name": string "destinationUrl": string "largeImage": string "largeTitle": string "pageContent": string "smallImage": string "smallTitle": string "target": numeric } ], "pId":string, "pageItems": [ { "id":numeric, "itemType":numeric, "pId":string } ], "parent": { "id":numeric, "pId":string }, "relatedItems": [ { "item": { "id":numeric, "pId":string }, "relatedDefinition": { "id":numeric, "pId":string }, "type":numeric } ], "seo": { "languages": [ { "indexable":boolean, "keyWords":string, "languageCode":string, "linkFollowing":boolean, "metaDescription":string, "particularTitle":string, "urlSeo":string } ] }, "type": { "customType":string, "itemId":numeric, "pageType":string }, "active": boolean "name": string "priority": numeric } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| pages | Obligatorio | struct | |
| Bloque de información que contiene la definición de una página. | |||
| pages/active | Opcional | false | boolean |
| Define si la página es visible (si está activa). | |||
| pages/activityLimits | Opcional | array [0:n] | |
| Bloque con información sobre los periodos de actividad. | |||
| pages/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). | |||
| pages/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). | |||
| pages/group | Opcional | struct | |
| Bloque con la información del grupo de páginas al que pertenece. | |||
| pages/group/id | Opcional | 0 | numeric |
| Identificador interno del grupo de páginas. Opcional en caso que se use identificador público. | |||
| pages/group/pId | Opcional | string | |
| Identificador público del grupo de páginas. Opcional en caso que se use identificador interno. | |||
| pages/languages | Opcional | array [0:n] | |
| Bloque con información variable según el idioma. | |||
| pages/languages/destinationUrl | Opcional | string | |
| En caso que se necesite que al pulsar sobre esta página se redirija a otra ubicación, indica la ruta a la que se tiene que enlazar. Puede ser relativa (recomandable si es propia) o absoluta. | |||
| pages/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. | |||
| pages/languages/largeImage | Opcional | string | |
| Imagen grande de la página. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
| pages/languages/largeTitle | Opcional | string | |
| Icono grande que representará la página. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
| pages/languages/name | Obligatorio | string | |
| Nombre de la página para el idioma seleccionado. | |||
| pages/languages/pageContent | Opcional | string | |
| Contenido de la página para el idioma seleccionado. Se admite HTML. | |||
| pages/languages/smallImage | Opcional | string | |
| Imagen pequeña de la página. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
| pages/languages/smallTitle | Opcional | string | |
| Icono pequeño que representará la página. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
| pages/languages/target | Opcional | 3 | numeric |
| Modo de enlace en caso de usar URL de destino. Valores permitidos: 1 - _blank, 2 - _parent, 3 - _self, 4 - _top | |||
| pages/name | Opcional | string | |
| Indica el nombre del elemento a nivel interno. No se muestra en el Frontoffice. | |||
| pages/pId | Obligatorio | string | |
| Identificador público de la página. | |||
| pages/pageItems | Opcional | array [0:n] | |
| Bloque de información sobre los filtros aplicados a este elemento. | |||
| pages/pageItems/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). | |||
| pages/pageItems/itemType | Obligatorio | numeric | |
| Tipo de filtro. Valores permitidos: 10 - Usuario, 11 - Grupo de usuario, 30 - Países, 9 - Zonas de países | |||
| pages/pageItems/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. | |||
| pages/parent | Opcional | struct | |
| Bloque que especifica el padre de la página (se permite anidamiento). Para las páginas raíz se debe dejar vacío. | |||
| pages/parent/id | Opcional | 0 | numeric |
| Identificador interno de la página padre. Opcional en caso que se use identificador público. | |||
| pages/parent/pId | Opcional | string | |
| Identificador público de la página padre. Opcional en caso que se use identificador interno. | |||
| pages/priority | Opcional | 0 | numeric |
| Define el orden de presentación de esta página en relación al resto de páginas que se encuentran en su mismo nivel. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
| pages/relatedItems | Opcional | array [0:n] | |
| Bloque de información sobre elementos relacionados en esta página | |||
| pages/relatedItems/item | Obligatorio | struct | |
| Bloque para informar sobre el elemento que se relaciona. | |||
| pages/relatedItems/item/id | Opcional | 0 | numeric |
| Identificador interno del elemento a relacionar. Opcional en caso que se use identificador público. | |||
| pages/relatedItems/item/pId | Opcional | string | |
| Identificador público del elemento a relacionar. Opcional en caso que se use identificador interno. | |||
| pages/relatedItems/relatedDefinition | Obligatorio | struct | |
| Bloque para informar sobre la sección en la que se incluirá el elemento que se quiere relacionar. | |||
| pages/relatedItems/relatedDefinition/id | Opcional | 0 | numeric |
| Identificador interno de la sección. Opcional en caso que se use identificador público. | |||
| pages/relatedItems/relatedDefinition/pId | Opcional | string | |
| Identificador público de la sección. Opcional en caso que se use identificador interno. | |||
| pages/relatedItems/type | Obligatorio | numeric | |
| Tipo de elemento. Valores permitidos: 1 - Productos, 2 - Categorías, 3 - Páginas, 5 - Noticias, 6 - Banners, 51 - Posts de blog. | |||
| pages/seo | Opcional | struct | |
| Bloque con información de posicionamiento SEO. | |||
| pages/seo/languages | Opcional | array [0:n] | |
| Bloque con los datos SEO que dependen del idioma. | |||
| pages/seo/languages/indexable | Obligatorio | boolean | |
| Indica a los bots de indexación si la página es indexable o no. Valores permitidos: 1 - index, 2 - noindex | |||
| pages/seo/languages/keyWords | Opcional | string | |
| Palabras clave de la página para el idioma seleccionado. Separadas por coma ','. | |||
| pages/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. | |||
| pages/seo/languages/linkFollowing | Obligatorio | boolean | |
| Indica el comportamiento de los bots de indexación en el seguimiento de los enlaces de la página. Valores permitidos: 1 - follow, 2 - nofollow | |||
| pages/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). | |||
| pages/seo/languages/particularTitle | Opcional | string | |
| Título de la ventana de la categoría para el idioma seleccionado. En navegadores actuales, es el título de la pestaña. Longitud Máxima: 255 (61 recomendado). | |||
| pages/seo/languages/urlSeo | Opcional | string | |
| URL SEO de la categoría 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 categoría. Esta es una ruta amigable que sustituye la ruta de acceso al contenido. Esta ruta es indexada por los buscadores. Caracteres permitidos: abcdefghijklmnopqrstuvwxyz1234567890_- | |||
| pages/type | Obligatorio | struct | |
| Bloque con la información del tipo de página. | |||
| pages/type/customType | Opcional | string | |
| Valor alfanumérico para identificar el tipo de página personalizado. Obligatorio si pageType es 100 o 101. | |||
| pages/type/itemId | Opcional | numeric | |
| Identificador del elemento al que se apunta cuando pageType es 10, 16 o 18. Las páginas de estos tipos sirven como enlaces al elemento que aquí se indica. | |||
| pages/type/pageType | Obligatorio | string | |
| Indica el tipo de contenido o comportamiento que tendrá la página. Valores permitidos: 0 - Normal, 1 - Inicio, 5 - Usuario, 6 - Cesta, 2 - Contacto, 7 - Apadrinamiento (usuario registrado), 9 - Apadrinamiento (usuario no registrado), 8 - Newsletter, 4 - Subpáginas, 3 - Mapa del sitio, 10 - Categoría, 11 - Noticias, 12 - Ofertas, 13 - Novedades, 14 - Política de privacidad, 15 - Condiciones de uso, 16 - Encuesta, 17 - Portada del blog, 18 - Categoría del blog, 19 - Descuentos, 100 - Personalizada, 101 - Módulo. | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"ACTIVITYLIMITS": [
{
"ACTIVATIONDATE" :"2015-11-02",
"EXPIRATIONDATE" :"2015-11-20",
"ID" : 23535
}
],
"GROUP": {
"ID" : 3,
"PID" :"abc"
},
"ID" : 1,
"LANGUAGE": [
{
"DESTINATIONURL" :"",
"LANGUAGE" :"ES",
"LARGEIMAGE" :"",
"LARGETITLE" :"",
"NAME" :"Name",
"PAGECONTENT" :"",
"SMALLIMAGE" :"",
"SMALLTITLE" :"",
"TARGET" : 1
}
],
"NAME" :"Name",
"PAGEITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
],
"PAGETYPE" : 1,
"PARENT": {
"ID" : 3,
"PID" :"abc"
},
"PID" :"abc",
"PRIORITY" : 1,
"RELATEDITEMS": [
{
"ID" : 2,
"ITEMS": {
"BANNERS": [
],
"BLOGPOST": [
],
"CATEGORIES": [
],
"NEWS": [
],
"PAGES": [
],
"PRODUCTS": [
{
"ID" : 43567,
"ITEM": {
"ID" : 13,
"pId" :"abc"
}
}
]
},
"NAME" :"Related Definition 1",
"PID" :"abc"
}
],
"SEO": {
"LANGUAGE": [
{
"INDEXABLE" : true,
"LANGUAGE" :"ES",
"LINKFOLLOWING" : true,
"keyWords" :"",
"metaDescription" :"",
"particularTitle" :"",
"url" :""
}
]
}
}
GET /pages/{id}
Descripción
Devuelve la información de la página indicada mediante identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/pages/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
{
"ACTIVITYLIMITS": [
{
"ACTIVATIONDATE" :"2015-11-02",
"EXPIRATIONDATE" :"2015-11-20",
"ID" : 23535
}
],
"GROUP": {
"ID" : 3,
"PID" :"abc"
},
"ID" : 1,
"LANGUAGE": [
{
"DESTINATIONURL" :"",
"LANGUAGE" :"ES",
"LARGEIMAGE" :"",
"LARGETITLE" :"",
"NAME" :"Name",
"PAGECONTENT" :"",
"SMALLIMAGE" :"",
"SMALLTITLE" :"",
"TARGET" : 1
}
],
"NAME" :"Name",
"PAGEITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
],
"PAGETYPE" : 1,
"PARENT": {
"ID" : 3,
"PID" :"abc"
},
"PID" :"abc",
"PRIORITY" : 1,
"RELATEDITEMS": [
{
"ID" : 2,
"ITEMS": {
"BANNERS": [
],
"BLOGPOST": [
],
"CATEGORIES": [
],
"NEWS": [
],
"PAGES": [
],
"PRODUCTS": [
{
"ID" : 43567,
"ITEM": {
"ID" : 13,
"pId" :"abc"
}
}
]
},
"NAME" :"Related Definition 1",
"PID" :"abc"
}
],
"SEO": {
"LANGUAGE": [
{
"INDEXABLE" : true,
"LANGUAGE" :"ES",
"LINKFOLLOWING" : true,
"keyWords" :"",
"metaDescription" :"",
"particularTitle" :"",
"url" :""
}
]
}
}
PUT /pages/{id}
Descripción
Edición de la página indicada mediante identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/pages/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "pages": { "active":boolean, "group": { "id":numeric, "pId":string }, "languages": [ { "languageCode":string, "name":string, "target":numeric, "destinationUrl": string "largeImage": string "largeTitle": string "pageContent": string "smallImage": string "smallTitle": string } ], "pId":string, "parent": { "id":numeric, "pId":string }, "priority":numeric, "seo": { "languages": [ { "indexable":boolean, "keyWords":string, "languageCode":string, "linkFollowing":boolean, "metaDescription":string, "particularTitle":string, "urlSeo":string } ] }, "type": { "customType":string, "itemId":numeric, "pageType":string }, "name": string } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| pages | Obligatorio | struct | |
| Bloque de información que contiene la definición de una página. | |||
| pages/active | Opcional | false | boolean |
| Define si la página es visible (si está activa). | |||
| pages/group | Opcional | struct | |
| Bloque con la información del grupo de páginas al que pertenece. | |||
| pages/group/id | Opcional | 0 | numeric |
| Identificador interno del grupo de páginas. Opcional en caso que se use identificador público. | |||
| pages/group/pId | Opcional | string | |
| Identificador público del grupo de páginas. Opcional en caso que se use identificador interno. | |||
| pages/languages | Opcional | array [0:n] | |
| Bloque con información variable según el idioma. | |||
| pages/languages/destinationUrl | Opcional | string | |
| En caso que se necesite que al pulsar sobre esta página se redirija a otra ubicación, indica la ruta a la que se tiene que enlazar. Puede ser relativa (recomandable si es propia) o absoluta. | |||
| pages/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. | |||
| pages/languages/largeImage | Opcional | string | |
| Imagen grande de la página. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
| pages/languages/largeTitle | Opcional | string | |
| Icono grande que representará la página. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
| pages/languages/name | Opcional | string | |
| Nombre de la página para el idioma seleccionado. | |||
| pages/languages/pageContent | Opcional | string | |
| Contenido de la página para el idioma seleccionado. Se admite HTML. | |||
| pages/languages/smallImage | Opcional | string | |
| Imagen pequeña de la página. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
| pages/languages/smallTitle | Opcional | string | |
| Icono pequeño que representará la página. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
| pages/languages/target | Opcional | 3 | numeric |
| Modo de enlace en caso de usar URL de destino. Valores permitidos: 1 - _blank, 2 - _parent, 3 - _self, 4 - _top | |||
| pages/name | Opcional | string | |
| Indica el nombre del elemento a nivel interno. No se muestra en el Frontoffice. | |||
| pages/pId | Opcional | string | |
| Identificador público de la página. | |||
| pages/parent | Opcional | struct | |
| Bloque que especifica el padre de la página (se permite anidamiento). Para las páginas raíz se debe dejar vacío. | |||
| pages/parent/id | Opcional | 0 | numeric |
| Identificador interno de la página padre. Opcional en caso que se use identificador público. | |||
| pages/parent/pId | Opcional | string | |
| Identificador público de la página padre. Opcional en caso que se use identificador interno. | |||
| pages/priority | Opcional | 0 | numeric |
| Define el orden de presentación de esta página en relación al resto de páginas que se encuentran en su mismo nivel. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
| pages/seo | Opcional | struct | |
| Bloque con información de posicionamiento SEO. | |||
| pages/seo/languages | Opcional | array [0:n] | |
| Bloque con los datos SEO que dependen del idioma. | |||
| pages/seo/languages/indexable | Opcional | boolean | |
| Indica a los bots de indexación si la página es indexable o no. Valores permitidos: 1 - index, 2 - noindex | |||
| pages/seo/languages/keyWords | Opcional | string | |
| Palabras clave de la página para el idioma seleccionado. Separadas por coma ','. | |||
| pages/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. | |||
| pages/seo/languages/linkFollowing | Opcional | boolean | |
| Indica el comportamiento de los bots de indexación en el seguimiento de los enlaces de la página. Valores permitidos: 1 - follow, 2 - nofollow | |||
| pages/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). | |||
| pages/seo/languages/particularTitle | Opcional | string | |
| Título de la ventana de la categoría para el idioma seleccionado. En navegadores actuales, es el título de la pestaña. Longitud Máxima: 255 (61 recomendado). | |||
| pages/seo/languages/urlSeo | Opcional | string | |
| URL SEO de la categoría 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 categoría. Esta es una ruta amigable que sustituye la ruta de acceso al contenido. Esta ruta es indexada por los buscadores. Caracteres permitidos: abcdefghijklmnopqrstuvwxyz1234567890_- | |||
| pages/type | Obligatorio | struct | |
| Bloque con la información del tipo de página. | |||
| pages/type/customType | Opcional | string | |
| Valor alfanumérico para identificar el tipo de página personalizado. Obligatorio si pageType es 100 o 101. | |||
| pages/type/itemId | Opcional | numeric | |
| Identificador del elemento al que se apunta cuando pageType es 10, 16 o 18. Las páginas de estos tipos sirven como enlaces al elemento que aquí se indica. | |||
| pages/type/pageType | Obligatorio | string | |
| Indica el tipo de contenido o comportamiento que tendrá la página. Valores permitidos: 0 - Normal, 1 - Inicio, 5 - Usuario, 6 - Cesta, 2 - Contacto, 7 - Apadrinamiento (usuario registrado), 9 - Apadrinamiento (usuario no registrado), 8 - Newsletter, 4 - Subpáginas, 3 - Mapa del sitio, 10 - Categoría, 11 - Noticias, 12 - Ofertas, 13 - Novedades, 14 - Política de privacidad, 15 - Condiciones de uso, 16 - Encuesta, 17 - Portada del blog, 18 - Categoría del blog, 19 - Descuentos, 100 - Personalizada, 101 - Módulo. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACTIVITYLIMITS": [
{
"ACTIVATIONDATE" :"2015-11-02",
"EXPIRATIONDATE" :"2015-11-20",
"ID" : 23535
}
],
"GROUP": {
"ID" : 3,
"PID" :"abc"
},
"ID" : 1,
"LANGUAGE": [
{
"DESTINATIONURL" :"",
"LANGUAGE" :"ES",
"LARGEIMAGE" :"",
"LARGETITLE" :"",
"NAME" :"Name",
"PAGECONTENT" :"",
"SMALLIMAGE" :"",
"SMALLTITLE" :"",
"TARGET" : 1
}
],
"NAME" :"Name",
"PAGEITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
],
"PAGETYPE" : 1,
"PARENT": {
"ID" : 3,
"PID" :"abc"
},
"PID" :"abc",
"PRIORITY" : 1,
"RELATEDITEMS": [
{
"ID" : 2,
"ITEMS": {
"BANNERS": [
],
"BLOGPOST": [
],
"CATEGORIES": [
],
"NEWS": [
],
"PAGES": [
],
"PRODUCTS": [
{
"ID" : 43567,
"ITEM": {
"ID" : 13,
"pId" :"abc"
}
}
]
},
"NAME" :"Related Definition 1",
"PID" :"abc"
}
],
"SEO": {
"LANGUAGE": [
{
"INDEXABLE" : true,
"LANGUAGE" :"ES",
"LINKFOLLOWING" : true,
"keyWords" :"",
"metaDescription" :"",
"particularTitle" :"",
"url" :""
}
]
}
}
DELETE /pages/{id}
Descripción
Elimina la página indicada mediante identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/pages/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 /pages/{id}/activityLimits
Descripción
Devuelve la información de los periodos de actividad de la página indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/pages/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 /pages/{id}/activityLimits
Descripción
Creación de un periodo de actividad para la página indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/pages/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 /pages/{id}/activityLimits
Descripción
Elimina todos los periodos de actividad de la página indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/pages/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 /pages/{id}/pageItems
Descripción
Devuelve los filtros asignados a la página 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/pages/1/pageItems
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"PAGEITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
]
}
POST /pages/{id}/pageItems
Descripción
Creación de un filtro para la página indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/pages/1/pageItems
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "pageItems": { "id":numeric, "itemType":numeric, "pId":string } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| pageItems | Obligatorio | struct | |
| Bloque de información sobre los filtros aplicados a este elemento. | |||
| pageItems/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). | |||
| pageItems/itemType | Obligatorio | numeric | |
| Tipo de filtro. Valores permitidos: 10 - Usuario, 11 - Grupo de usuario, 30 - Países, 9 - Zonas de países | |||
| pageItems/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
{
"PAGEITEMS": {
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
}
DELETE /pages/{id}/pageItems
Descripción
Elimina todos los filtros de la página indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/pages/1/pageItems
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"PAGEITEMS": [
]
}
GET /pages/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/pages/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 /pages/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/pages/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 /pages/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/pages/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 /pages/getId/{pId}
Descripción
Devuelve el identificador interno de la página.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/pages/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 /pages/pageItems/{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/pages/pageItems/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 /pages/pageItems/{id}
Descripción
Elimina el filtro indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/pages/pageItems/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 /pagesGroups
Descripción
Devuelve el listado de los grupos de página. 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/pagesGroups
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. | |||
| position | Opcional | 0 | numeric |
| Devuelve elementos de la posición indicada. | |||
| q | Opcional | string | |
| Criterio de búsqueda. | |||
| showOnlyVisible | Opcional | false | boolean |
| Devuelve únicamente elementos visibles. | |||
| sort | Opcional | name | string |
| Variable de ordenación. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ITEMS" : 10,
"PAGESGROUPS": [
{
"ACTIVE" : true,
"ID" : 1,
"LANGUAGES": [
{
"DESCRIPTION" :"",
"LANGUAGE" :"ES",
"NAME" :""
}
],
"NAME" :"Page Group",
"PAGES": [
{
"ACTIVITYLIMITS": [
{
"ACTIVATIONDATE" :"2015-11-02",
"EXPIRATIONDATE" :"2015-11-20",
"ID" : 23535
}
],
"GROUP": {
"ID" : 3,
"PID" :"abc"
},
"ID" : 1,
"LANGUAGE": [
{
"DESTINATIONURL" :"",
"LANGUAGE" :"ES",
"LARGEIMAGE" :"",
"LARGETITLE" :"",
"NAME" :"Name",
"PAGECONTENT" :"",
"SMALLIMAGE" :"",
"SMALLTITLE" :"",
"TARGET" : 1
}
],
"NAME" :"Name",
"PAGEITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
],
"PAGETYPE" : 1,
"PARENT": {
"ID" : 3,
"PID" :"abc"
},
"PID" :"abc",
"PRIORITY" : 1,
"RELATEDITEMS": [
{
"ID" : 2,
"ITEMS": {
"BANNERS": [
],
"BLOGPOST": [
],
"CATEGORIES": [
],
"NEWS": [
],
"PAGES": [
],
"PRODUCTS": [
{
"ID" : 43567,
"ITEM": {
"ID" : 13,
"pId" :"abc"
}
}
]
},
"NAME" :"Related Definition 1",
"PID" :"abc"
}
],
"SEO": {
"LANGUAGE": [
{
"INDEXABLE" : true,
"LANGUAGE" :"ES",
"LINKFOLLOWING" : true,
"keyWords" :"",
"metaDescription" :"",
"particularTitle" :"",
"url" :""
}
]
}
}
],
"PID" :"abc",
"POSITION" : 3
}
]
}
POST /pagesGroups
Descripción
Creación de un grupo de página.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/pagesGroups
Parámetros de entrada JSON
{ "pagesGroups": { "languages": [ { "languageCode":string, "name": string "description": string } ], "pId":string, "position":numeric, "name": string "active": boolean } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| pagesGroups | Obligatorio | struct | |
| Bloque de información que contiene la definición de un grupo de página. | |||
| pagesGroups/active | Opcional | false | boolean |
| Define si el grupo de página es visible (si esta activa). | |||
| pagesGroups/languages | Opcional | array [0:n] | |
| Bloque con los datos SEO que dependen del idioma. | |||
| pagesGroups/languages/description | Opcional | string | |
| Descripción del grupo de página para el idioma seleccionado. | |||
| pagesGroups/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. | |||
| pagesGroups/languages/name | Obligatorio | string | |
| Nombre del grupo de página para el idioma seleccionado. | |||
| pagesGroups/name | Obligatorio | string | |
| Nombre del grupo de página. | |||
| pagesGroups/pId | Obligatorio | string | |
| Identificador público del grupo de página. | |||
| pagesGroups/position | Obligatorio | numeric | |
| Número entero que simboliza la ubicación de este elemento en el Frontoffice. | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"ACTIVE" : true,
"ID" : 1,
"LANGUAGES": [
{
"DESCRIPTION" :"",
"LANGUAGE" :"ES",
"NAME" :""
}
],
"NAME" :"Page Group",
"PAGES": [
{
"ACTIVITYLIMITS": [
{
"ACTIVATIONDATE" :"2015-11-02",
"EXPIRATIONDATE" :"2015-11-20",
"ID" : 23535
}
],
"GROUP": {
"ID" : 3,
"PID" :"abc"
},
"ID" : 1,
"LANGUAGE": [
{
"DESTINATIONURL" :"",
"LANGUAGE" :"ES",
"LARGEIMAGE" :"",
"LARGETITLE" :"",
"NAME" :"Name",
"PAGECONTENT" :"",
"SMALLIMAGE" :"",
"SMALLTITLE" :"",
"TARGET" : 1
}
],
"NAME" :"Name",
"PAGEITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
],
"PAGETYPE" : 1,
"PARENT": {
"ID" : 3,
"PID" :"abc"
},
"PID" :"abc",
"PRIORITY" : 1,
"RELATEDITEMS": [
{
"ID" : 2,
"ITEMS": {
"BANNERS": [
],
"BLOGPOST": [
],
"CATEGORIES": [
],
"NEWS": [
],
"PAGES": [
],
"PRODUCTS": [
{
"ID" : 43567,
"ITEM": {
"ID" : 13,
"pId" :"abc"
}
}
]
},
"NAME" :"Related Definition 1",
"PID" :"abc"
}
],
"SEO": {
"LANGUAGE": [
{
"INDEXABLE" : true,
"LANGUAGE" :"ES",
"LINKFOLLOWING" : true,
"keyWords" :"",
"metaDescription" :"",
"particularTitle" :"",
"url" :""
}
]
}
}
],
"PID" :"abc",
"POSITION" : 3
}
GET /pagesGroups/{id}
Descripción
Devuelve la información del grupo de página indicado mediante identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/pagesGroups/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" : true,
"ID" : 1,
"LANGUAGES": [
{
"DESCRIPTION" :"",
"LANGUAGE" :"ES",
"NAME" :""
}
],
"NAME" :"Page Group",
"PAGES": [
{
"ACTIVITYLIMITS": [
{
"ACTIVATIONDATE" :"2015-11-02",
"EXPIRATIONDATE" :"2015-11-20",
"ID" : 23535
}
],
"GROUP": {
"ID" : 3,
"PID" :"abc"
},
"ID" : 1,
"LANGUAGE": [
{
"DESTINATIONURL" :"",
"LANGUAGE" :"ES",
"LARGEIMAGE" :"",
"LARGETITLE" :"",
"NAME" :"Name",
"PAGECONTENT" :"",
"SMALLIMAGE" :"",
"SMALLTITLE" :"",
"TARGET" : 1
}
],
"NAME" :"Name",
"PAGEITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
],
"PAGETYPE" : 1,
"PARENT": {
"ID" : 3,
"PID" :"abc"
},
"PID" :"abc",
"PRIORITY" : 1,
"RELATEDITEMS": [
{
"ID" : 2,
"ITEMS": {
"BANNERS": [
],
"BLOGPOST": [
],
"CATEGORIES": [
],
"NEWS": [
],
"PAGES": [
],
"PRODUCTS": [
{
"ID" : 43567,
"ITEM": {
"ID" : 13,
"pId" :"abc"
}
}
]
},
"NAME" :"Related Definition 1",
"PID" :"abc"
}
],
"SEO": {
"LANGUAGE": [
{
"INDEXABLE" : true,
"LANGUAGE" :"ES",
"LINKFOLLOWING" : true,
"keyWords" :"",
"metaDescription" :"",
"particularTitle" :"",
"url" :""
}
]
}
}
],
"PID" :"abc",
"POSITION" : 3
}
PUT /pagesGroups/{id}
Descripción
Edición del grupo de página indicado mediante identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/pagesGroups/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "pagesGroups": { "active":boolean, "languages": [ { "languageCode":string, "name":string, "description": string } ], "name":string, "pId":string, "position": numeric } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| pagesGroups | Obligatorio | struct | |
| Bloque de información que contiene la definición de un grupo de página. | |||
| pagesGroups/active | Opcional | false | boolean |
| Define si el grupo de página es visible (si esta activa). | |||
| pagesGroups/languages | Opcional | array [0:n] | |
| Bloque con los datos SEO que dependen del idioma. | |||
| pagesGroups/languages/description | Opcional | string | |
| Descripción del grupo de página para el idioma seleccionado. | |||
| pagesGroups/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. | |||
| pagesGroups/languages/name | Opcional | string | |
| Nombre del grupo de página para el idioma seleccionado. | |||
| pagesGroups/name | Opcional | string | |
| Nombre del grupo de página. | |||
| pagesGroups/pId | Opcional | string | |
| Identificador público del grupo de página. | |||
| pagesGroups/position | Opcional | numeric | |
| Número entero que simboliza la ubicación de este elemento en el Frontoffice. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACTIVE" : true,
"ID" : 1,
"LANGUAGES": [
{
"DESCRIPTION" :"",
"LANGUAGE" :"ES",
"NAME" :""
}
],
"NAME" :"Page Group",
"PAGES": [
{
"ACTIVITYLIMITS": [
{
"ACTIVATIONDATE" :"2015-11-02",
"EXPIRATIONDATE" :"2015-11-20",
"ID" : 23535
}
],
"GROUP": {
"ID" : 3,
"PID" :"abc"
},
"ID" : 1,
"LANGUAGE": [
{
"DESTINATIONURL" :"",
"LANGUAGE" :"ES",
"LARGEIMAGE" :"",
"LARGETITLE" :"",
"NAME" :"Name",
"PAGECONTENT" :"",
"SMALLIMAGE" :"",
"SMALLTITLE" :"",
"TARGET" : 1
}
],
"NAME" :"Name",
"PAGEITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
],
"PAGETYPE" : 1,
"PARENT": {
"ID" : 3,
"PID" :"abc"
},
"PID" :"abc",
"PRIORITY" : 1,
"RELATEDITEMS": [
{
"ID" : 2,
"ITEMS": {
"BANNERS": [
],
"BLOGPOST": [
],
"CATEGORIES": [
],
"NEWS": [
],
"PAGES": [
],
"PRODUCTS": [
{
"ID" : 43567,
"ITEM": {
"ID" : 13,
"pId" :"abc"
}
}
]
},
"NAME" :"Related Definition 1",
"PID" :"abc"
}
],
"SEO": {
"LANGUAGE": [
{
"INDEXABLE" : true,
"LANGUAGE" :"ES",
"LINKFOLLOWING" : true,
"keyWords" :"",
"metaDescription" :"",
"particularTitle" :"",
"url" :""
}
]
}
}
],
"PID" :"abc",
"POSITION" : 3
}
DELETE /pagesGroups/{id}
Descripción
Elimina el grupo de páginas indicado mediante identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/pagesGroups/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 /pagesGroups/{id}/pages
Descripción
Devuelve la información de las páginas del grupo indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/pagesGroups/1/pages
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
| 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. | |||
| 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
{
"ITEMS" : 5,
"PAGES": [
{
"ACTIVITYLIMITS": [
{
"ACTIVATIONDATE" :"2015-11-02",
"EXPIRATIONDATE" :"2015-11-20",
"ID" : 23535
}
],
"GROUP": {
"ID" : 3,
"PID" :"abc"
},
"ID" : 1,
"LANGUAGE": [
{
"DESTINATIONURL" :"",
"LANGUAGE" :"ES",
"LARGEIMAGE" :"",
"LARGETITLE" :"",
"NAME" :"Name",
"PAGECONTENT" :"",
"SMALLIMAGE" :"",
"SMALLTITLE" :"",
"TARGET" : 1
}
],
"NAME" :"Name",
"PAGEITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
],
"PAGETYPE" : 1,
"PARENT": {
"ID" : 3,
"PID" :"abc"
},
"PID" :"abc",
"PRIORITY" : 1,
"RELATEDITEMS": [
{
"ID" : 2,
"ITEMS": {
"BANNERS": [
],
"BLOGPOST": [
],
"CATEGORIES": [
],
"NEWS": [
],
"PAGES": [
],
"PRODUCTS": [
{
"ID" : 43567,
"ITEM": {
"ID" : 13,
"pId" :"abc"
}
}
]
},
"NAME" :"Related Definition 1",
"PID" :"abc"
}
],
"SEO": {
"LANGUAGE": [
{
"INDEXABLE" : true,
"LANGUAGE" :"ES",
"LINKFOLLOWING" : true,
"keyWords" :"",
"metaDescription" :"",
"particularTitle" :"",
"url" :""
}
]
}
}
]
}
GET /pagesGroups/{id}/pages/count
Descripción
Devuelve la cantidad de las páginas del grupo indicado. 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/pagesGroups/1/pages/count
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
| 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. | |||
| 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" : 5
}
GET /pagesGroups/count
Descripción
Devuelve un valor que indica la cantidad de grupos de páginas.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/pagesGroups/count
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| position | Opcional | 0 | numeric |
| Devuelve elementos de la posición indicada. | |||
| q | Opcional | string | |
| Criterio de búsqueda. | |||
| showOnlyVisible | Opcional | false | boolean |
| Devuelve únicamente elementos visibles. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ITEMS" : 5
}
GET /pagesGroups/getId/{pId}
Descripción
Devuelve el identificador interno del grupo de páginas.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/pagesGroups/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
}