Banners
El endpoint de banners permite la gestión del módulo de banners del eCommerce y realizar acciones como crear nuevos banners, modificar su información básica o administrar las impresiones y clics sobre banners.
</> GET / bannersDevuelve la lista de banners.
</> POST / bannersCreación de un nuevo banner.
</> GET / banners/{id}Devuelve la información del banner indicado mediante identificador interno.
</> PUT / banners/{id}Edición del banner indicado mediante identificador interno.
</> DELETE / banners/{id}Elimina el banner indicado mediante identificador interno.
</> GET / banners/{id}/activityLimitsDevuelve todos los periodos de actividad del banner indicado.
</> POST / banners/{id}/activityLimitsCreación de un periodo de actividad para el banner indicado.
</> DELETE / banners/{id}/activityLimitsElimina todos los periodos de actividad del banner indicado.
</> GET / banners/{id}/bannerItemsDevuelve los filtros asignados al banner indicado.
</> POST / banners/{id}/bannerItemsCreación de un filtro para el banner indicado.
</> DELETE / banners/{id}/bannerItemsElimina todos los filtros asignados del banner indicado.
</> GET / banners/activityLimits/{id}Devuelve la información sobre el periodo de activitad indicado.
</> PUT / banners/activityLimits/{id}Edición del periodo de actividad indicado.
</> DELETE / banners/activityLimits/{id}Elimina el periodo de actividad indicado.
</> GET / banners/bannerItems/{id}Devuelve la información sobre el filtro indicado.
</> DELETE / banners/bannerItems/{id}Elimina el filtro indicado.
</> GET / banners/countDevuelve un valor que indica la cantidad de banners.
</> GET / banners/getId/{pId}Devuelve el identificador interno del banner.
GET /banners
Descripción
Devuelve la lista de banners. 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/banners
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. | |||
| 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. | |||
| 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
{
"BANNERS": [
{
"ACTIVE" : true,
"ACTIVITYLIMITS": [
{
"ACTIVATIONDATE" :"2015-11-02",
"EXPIRATIONDATE" :"2015-11-20",
"ID" : 23535
}
],
"BANNERITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
],
"DATEADDED" :"2015-05-23",
"DESCRIPTION" :"Description abc",
"DONECLICKS" : 12,
"DONEHITS" : 4,
"ID" : 43,
"LANGUAGES": [
{
"BANNERALT" :"banner alt",
"BANNERIMAGE" :"banner.jpg",
"DESTINATIONURL" :"http://www.aaaa.com",
"LANGUAGE" :"ES",
"LINKFOLLOWING" : true
},
{
"BANNERALT" :"banner alt",
"BANNERIMAGE" :"banner.jpg",
"DESTINATIONURL" :"http://www.aaaa.com",
"LANGUAGE" :"EN",
"LINKFOLLOWING" : true
}
],
"LIMITED" : 0,
"NAME" :"Banner 1",
"PAIDITEMS" : 4,
"PID" :"abc",
"POSITION" : 1,
"PRIORITY" : 13,
"TARGET" :"_blank"
}
],
"CURSORS": {
"NEXT" :"http://api.logicommerce.net/v1/banners?page=2&perPage=100",
"PREVIOUS" :""
},
"ITEMS" : 1000,
"PAGERPARAMETERS": {
"PAGE" : 1,
"PERPAGE" : 100
}
}
POST /banners
Descripción
Creación de un nuevo banner.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/banners
Parámetros de entrada JSON
{ "banners": { "activityLimits": [ { "activationDate": datetime "expirationDate": datetime } ], "bannerItems": [ { "id":numeric, "itemType":numeric, "pId":string } ], "languages": [ { "languageCode":string, "bannerAlt": string "bannerImage": string "destinationURL": string "linkFollowing": boolean } ], "limitation":numeric, "pId":string, "target":numeric, "name": string "active": boolean "description": string "doneClicks": numeric "doneHits": numeric "paidItems": numeric "position": numeric "priority": numeric } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| banners | Obligatorio | struct | |
| Bloque de información que contiene la definición de un banner. | |||
| banners/active | Opcional | true | boolean |
| Define si el banner es visible (si está activo). | |||
| banners/activityLimits | Opcional | array [0:n] | |
| Bloque con información sobre los periodos de actividad. | |||
| banners/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). | |||
| banners/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). | |||
| banners/bannerItems | Opcional | array [0:n] | |
| Bloque de información sobre los filtros aplicados a este banner. | |||
| banners/bannerItems/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). | |||
| banners/bannerItems/itemType | Obligatorio | numeric | |
| Tipo de filtro. Valores permitidos: 10 - Usuario, 11 - Grupo de usuario, 30 - Países, 9 - Zonas de países | |||
| banners/bannerItems/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. | |||
| banners/description | Opcional | string | |
| Texto breve a modo de comentario interno. | |||
| banners/doneClicks | Opcional | 0 | numeric |
| Contador de clics. Indica el número de clics que ha recibido. Se puede cambiar para indicar el número inicial del contador | |||
| banners/doneHits | Opcional | 0 | numeric |
| Contador de impresiones. Indica el número de veces que se ha visualizado. Se puede cambiar para indicar el número inicial del contador. | |||
| banners/languages | Opcional | array [0:n] | |
| Bloque con información variable según el idioma. | |||
| banners/languages/bannerAlt | Opcional | string | |
| Texto alternativo para describir la imagen que mostrará el banner. | |||
| banners/languages/bannerImage | Opcional | string | |
| Imagen del banner. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
| banners/languages/destinationURL | Opcional | string | |
| Indica la ruta a la que tiene que enlazar el banner. Puede ser relativa (recomandable si es propia) o absoluta. | |||
| banners/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. | |||
| banners/languages/linkFollowing | Opcional | true | boolean |
| Indica el comportamiento de los bots de indexación en el seguimiento del enlace del banner. Valores permitidos: 1 - follow, 2 - nofollow | |||
| banners/limitation | Obligatorio | numeric | |
| Indica el tipo de limitación al que está sometido el banner. Valores permitidos: 0 - Ilimitado, 1 - Por impresiones, 2 - Por clics. | |||
| banners/name | Obligatorio | string | |
| Indica el nombre del elemento a nivel interno. No se muestra en el Frontoffice. | |||
| banners/pId | Obligatorio | string | |
| Identificador público del banner. | |||
| banners/paidItems | Opcional | 0 | numeric |
| banners/position | Opcional | 1 | numeric |
| Número entero que simboliza la ubicación de este elemento en el Frontoffice. | |||
| banners/priority | Opcional | 0 | numeric |
| Define el orden de presentación de este banner en relación al resto de banners que se encuentran en su mismo nivel. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
| banners/target | Opcional | numeric | |
| Modo de enlace en caso de usar URL de destino. Valores permitidos: 1 - _blank, 2 - _parent, 3 - _self, 4 - _top | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"ACTIVE" : true,
"ACTIVITYLIMITS": [
{
"ACTIVATIONDATE" :"2015-11-02",
"EXPIRATIONDATE" :"2015-11-20",
"ID" : 23535
}
],
"BANNERITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
],
"DATEADDED" :"2015-05-23",
"DESCRIPTION" :"Description abc",
"DONECLICKS" : 12,
"DONEHITS" : 4,
"ID" : 43,
"LANGUAGES": [
{
"BANNERALT" :"banner alt",
"BANNERIMAGE" :"banner.jpg",
"DESTINATIONURL" :"http://www.aaaa.com",
"LANGUAGE" :"ES",
"LINKFOLLOWING" : true
},
{
"BANNERALT" :"banner alt",
"BANNERIMAGE" :"banner.jpg",
"DESTINATIONURL" :"http://www.aaaa.com",
"LANGUAGE" :"EN",
"LINKFOLLOWING" : true
}
],
"LIMITED" : 0,
"NAME" :"Banner 1",
"PAIDITEMS" : 4,
"PID" :"abc",
"POSITION" : 1,
"PRIORITY" : 13,
"TARGET" :"_blank"
}
GET /banners/{id}
Descripción
Devuelve la información del banner indicado mediante identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/banners/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,
"ACTIVITYLIMITS": [
{
"ACTIVATIONDATE" :"2015-11-02",
"EXPIRATIONDATE" :"2015-11-20",
"ID" : 23535
}
],
"BANNERITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
],
"DATEADDED" :"2015-05-23",
"DESCRIPTION" :"Description abc",
"DONECLICKS" : 12,
"DONEHITS" : 4,
"ID" : 43,
"LANGUAGES": [
{
"BANNERALT" :"banner alt",
"BANNERIMAGE" :"banner.jpg",
"DESTINATIONURL" :"http://www.aaaa.com",
"LANGUAGE" :"ES",
"LINKFOLLOWING" : true
},
{
"BANNERALT" :"banner alt",
"BANNERIMAGE" :"banner.jpg",
"DESTINATIONURL" :"http://www.aaaa.com",
"LANGUAGE" :"EN",
"LINKFOLLOWING" : true
}
],
"LIMITED" : 0,
"NAME" :"Banner 1",
"PAIDITEMS" : 4,
"PID" :"abc",
"POSITION" : 1,
"PRIORITY" : 13,
"TARGET" :"_blank"
}
PUT /banners/{id}
Descripción
Edición del banner indicado mediante identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/banners/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "banners": { "languages": [ { "languageCode":string, "bannerAlt": string "bannerImage": string "destinationURL": string "linkFollowing": boolean } ], "limitation":numeric, "name":string, "pId":string, "position":numeric, "target":numeric, "active": boolean "description": string "doneClicks": numeric "doneHits": numeric "paidItems": numeric "priority": numeric } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| banners | Obligatorio | struct | |
| Bloque de información que contiene la definición de un banner. | |||
| banners/active | Opcional | true | boolean |
| Define si el banner es visible (si está activo). | |||
| banners/description | Opcional | string | |
| Texto breve a modo de comentario interno. | |||
| banners/doneClicks | Opcional | 0 | numeric |
| Contador de clics. Indica el número de clics que ha recibido. Se puede cambiar para indicar el número inicial del contador | |||
| banners/doneHits | Opcional | 0 | numeric |
| Contador de impresiones. Indica el número de veces que se ha visualizado. Se puede cambiar para indicar el número inicial del contador. | |||
| banners/languages | Opcional | array [0:n] | |
| Bloque con información variable según el idioma. | |||
| banners/languages/bannerAlt | Opcional | string | |
| Texto alternativo para describir la imagen que mostrará el banner. | |||
| banners/languages/bannerImage | Opcional | string | |
| Imagen del banner. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
| banners/languages/destinationURL | Opcional | string | |
| Indica la ruta a la que tiene que enlazar el banner. Puede ser relativa (recomandable si es propia) o absoluta. | |||
| banners/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. | |||
| banners/languages/linkFollowing | Opcional | true | boolean |
| Indica el comportamiento de los bots de indexación en el seguimiento del enlace del banner. Valores permitidos: 1 - follow, 2 - nofollow | |||
| banners/limitation | Obligatorio | numeric | |
| Indica el tipo de limitación al que está sometido el banner. Valores permitidos: 0 - Ilimitado, 1 - Por impresiones, 2 - Por clics. | |||
| banners/name | Opcional | string | |
| Indica el nombre del elemento a nivel interno. No se muestra en el Frontoffice. | |||
| banners/pId | Opcional | string | |
| Identificador público del banner. | |||
| banners/paidItems | Opcional | 0 | numeric |
| banners/position | Opcional | 1 | numeric |
| Número entero que simboliza la ubicación de este elemento en el Frontoffice. | |||
| banners/priority | Opcional | 0 | numeric |
| Define el orden de presentación de este banner en relación al resto de banners que se encuentran en su mismo nivel. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
| banners/target | Opcional | numeric | |
| Modo de enlace en caso de usar URL de destino. Valores permitidos: 1 - _blank, 2 - _parent, 3 - _self, 4 - _top | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACTIVE" : true,
"ACTIVITYLIMITS": [
{
"ACTIVATIONDATE" :"2015-11-02",
"EXPIRATIONDATE" :"2015-11-20",
"ID" : 23535
}
],
"BANNERITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
],
"DATEADDED" :"2015-05-23",
"DESCRIPTION" :"Description abc",
"DONECLICKS" : 12,
"DONEHITS" : 4,
"ID" : 43,
"LANGUAGES": [
{
"BANNERALT" :"banner alt",
"BANNERIMAGE" :"banner.jpg",
"DESTINATIONURL" :"http://www.aaaa.com",
"LANGUAGE" :"ES",
"LINKFOLLOWING" : true
},
{
"BANNERALT" :"banner alt",
"BANNERIMAGE" :"banner.jpg",
"DESTINATIONURL" :"http://www.aaaa.com",
"LANGUAGE" :"EN",
"LINKFOLLOWING" : true
}
],
"LIMITED" : 0,
"NAME" :"Banner 1",
"PAIDITEMS" : 4,
"PID" :"abc",
"POSITION" : 1,
"PRIORITY" : 13,
"TARGET" :"_blank"
}
DELETE /banners/{id}
Descripción
Elimina el banner indicado mediante identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/banners/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 /banners/{id}/activityLimits
Descripción
Devuelve todos los periodos de actividad del banner indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/banners/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 /banners/{id}/activityLimits
Descripción
Creación de un periodo de actividad para el banner indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/banners/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 /banners/{id}/activityLimits
Descripción
Elimina todos los periodos de actividad del banner indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/banners/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 /banners/{id}/bannerItems
Descripción
Devuelve el filtros asignados al banner indicado.
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/banners/1/bannerItems
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"BANNERITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
]
}
POST /banners/{id}/bannerItems
Descripción
Creación de un filtro para el banner indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/banners/1/bannerItems
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "bannerItems": { "id":numeric, "itemType":numeric, "pId":string } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| bannerItems | Obligatorio | struct | |
| Bloque de información sobre los filtros aplicados a este elemento. | |||
| bannerItems/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). | |||
| bannerItems/itemType | Obligatorio | numeric | |
| Tipo de filtro. Valores permitidos: 10 - Usuario, 11 - Grupo de usuario, 30 - Países, 9 - Zonas de países | |||
| bannerItems/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
{
"BANNERITEMS": {
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
}
DELETE /banners/{id}/bannerItems
Descripción
Elimina todos los filtros asignados del banner indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/banners/1/bannerItems
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"BANNERITEMS": [
]
}
GET /banners/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/banners/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 /banners/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/banners/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 /banners/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/banners/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 /banners/bannerItems/{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/banners/bannerItems/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 /banners/bannerItems/{id}
Descripción
Elimina el filtro indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/banners/bannerItems/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 /banners/count
Descripción
Devuelve un valor que indica la cantidad de banners.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/banners/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 /banners/getId/{pId}
Descripción
Devuelve el identificador interno del banner.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/banners/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
}