Marcas
Endpoint para gestionar el apartado de marcas. Está compuesto por una colección de recursos que permiten realizar todas las acciones de administración asociadas, como por ejemplo crear nuevas marcas, ocultar o borrar marcas, etc.
</> GET / brandsDevuelve el listado de todas las marcas actuales.
</> POST / brandsCreación de una marca.
</> GET / brands/{id}Devuelve la información de la marca indicada mediante identificador interno.
</> PUT / brands/{id}Edición de una marca indicada mediante identificador interno.
</> DELETE / brands/{id}Elimina la marca indicada mediante identificador interno.
</> GET / brands/{id}/productsDevuelve la lista de productos de la marca indicada.
</> POST / brands/{id}/productsVincula productos a la marca indicada.
</> DELETE / brands/{id}/productsDesvincula productos de la marca indicada.
</> DELETE / brands/{id}/products/{productId}Desvincula un producto determinado de la marca indicada.
</> GET / brands/countDevuelve un valor que indica la cantidad de marcas.
</> GET / brands/getId/{pId}Devuelve el identificador interno de la marca.
GET /brands
Descripción
Devuelve el listado de todas las marcas actuales. 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/brands
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| fields | Opcional | string | |
| Lista de campos a devolver. | |||
| idList | Opcional | string | |
| Lista de los identificadores internos de marca que han de ser devueltos. | |||
| 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. | |||
| q | Opcional | string | |
| Criterio de búsqueda. | |||
| showOnlyVisible | Opcional | false | boolean |
| Devuelve únicamente elementos visibles. | |||
| sort | Opcional | id | string |
| Variable de ordenación. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"BRANDS": [
{
"ACTIVE" : true,
"DATEADDED" :"2015-01-10",
"HIGHLIGHT" : false,
"ID" : 1,
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"LARGEIMAGE" :"",
"LARGETITLEIMAGE" :"",
"LONGDESCRIPTION" :"",
"NAME" :"",
"SHORTDESCRIPTION" :"",
"SMALLIMAGE" :"",
"SMALLTITLEIMAGE" :""
}
],
"PID" :"sdfsdf",
"SALE" : false,
"SEO": {
"LANGUAGES": [
{
"KEYWORDS" :"",
"METADESCRIPTION" :"",
"PARTICULARTITLE" :"",
"URLSEO" :""
}
]
}
}
],
"ITEMS" : 10
}
POST /brands
Descripción
Creación de una marca.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/brands
Parámetros de entrada JSON
{ "brands": { "active":boolean, "highlight":boolean, "languages": [ { "languageCode":string, "indexable": boolean "largeImage": string "largeTitleImage": string "linkFollowing": boolean "longDescription": string "name": string "shortDescription": string "smallImage": string "smallTitleImage": string } ], "pId":string, "priority":numeric, "sale":boolean, "seo": { "languages": [ { "indexable":boolean, "keyWords":string, "languageCode":string, "linkFollowing":boolean, "metaDescription":string, "particularTitle":string, "urlSeo":string } ] } } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| brands | Obligatorio | struct | |
| Bloque de información que contiene la definición de una marca. | |||
| brands/active | Opcional | false | boolean |
| Define si la marca es visible (si esta activa). | |||
| brands/highlight | Opcional | false | boolean |
| Define si la marca esta en novedad. Los valores admitidos son el 0 y el 1. Esta característica es informativa, el hecho de marcar la marca como novedad no altera los productos que esta contiene. | |||
| brands/languages | Opcional | array [0:n] | |
| Bloque con información variable según el idioma. | |||
| brands/languages/indexable | Opcional | true | boolean |
| brands/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. | |||
| brands/languages/largeImage | Opcional | string | |
| Imagen grande de la marca para el idioma seleccionado. Se debe indicar la ruta (relativa si es propia) de la imagen. No incluya este campo a no ser que se lo pidan desde Trilogi. | |||
| brands/languages/largeTitleImage | Opcional | string | |
| Imagen grande de título de la marca para el idioma seleccionado. Se debe indicar la ruta (relativa si es propia) de la imagen. No incluya este campo a no ser que se lo pidan desde Trilogi. | |||
| brands/languages/linkFollowing | Opcional | true | boolean |
| brands/languages/longDescription | Opcional | string | |
| Descripción larga de la marca para el idioma seleccionado. Solo debe especificarse si el diseño de la web lo contempla. | |||
| brands/languages/name | Opcional | string | |
| Nombre de la marca para el idioma seleccionado. | |||
| brands/languages/shortDescription | Opcional | string | |
| Descripción corta de la marca para el idioma seleccionado. Solo debe especificarse si el diseño de la web lo contempla. | |||
| brands/languages/smallImage | Opcional | string | |
| Imagen pequeña de la marca para el idioma seleccionado. Se debe indicar la ruta (relativa si es propia) de la imagen. No incluya este campo a no ser que se lo pidan desde Trilogi. | |||
| brands/languages/smallTitleImage | Opcional | string | |
| Imagen pequeña de título de la marca para el idioma seleccionado. Se debe indicar la ruta (relativa si es propia) de la imagen. No incluya este campo a no ser que se lo pidan desde Trilogi. | |||
| brands/pId | Obligatorio | string | |
| Identificador público de la marca. | |||
| brands/priority | Opcional | 0 | numeric |
| Define el orden de presentación de esta marca en relación al resto de marcas que se encuentran en su mismo nivel. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
| brands/sale | Obligatorio | boolean | |
| Define si la marca esta en oferta. Los valores admitidos son el 0 y el 1. Esta característica es informativa, el hecho de marcar la marca como oferta no altera los productos que esta contiene. | |||
| brands/seo | Opcional | struct | |
| Bloque con información de posicionamiento SEO. | |||
| brands/seo/languages | Opcional | array [0:n] | |
| Bloque con los datos SEO que dependen del idioma. | |||
| brands/seo/languages/indexable | Opcional | false | boolean |
| brands/seo/languages/keyWords | Opcional | string | |
| Palabras clave de la marca para el idioma seleccionado. Separadas por coma ','. | |||
| brands/seo/languages/languageCode | Obligatorio | string | |
| brands/seo/languages/linkFollowing | Opcional | false | boolean |
| brands/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). | |||
| brands/seo/languages/particularTitle | Opcional | string | |
| Título de la ventana de la marca para el idioma seleccionado. En navegadores actuales, es el título de la pestaña. Longitud Máxima: 255 (61 recomendado). | |||
| brands/seo/languages/urlSeo | Opcional | string | |
| URL SEO de la marca 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 marca. 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" : true,
"DATEADDED" :"2015-01-10",
"HIGHLIGHT" : false,
"ID" : 1,
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"LARGEIMAGE" :"",
"LARGETITLEIMAGE" :"",
"LONGDESCRIPTION" :"",
"NAME" :"",
"SHORTDESCRIPTION" :"",
"SMALLIMAGE" :"",
"SMALLTITLEIMAGE" :""
}
],
"PID" :"sdfsdf",
"SALE" : false,
"SEO": {
"LANGUAGES": [
{
"KEYWORDS" :"",
"METADESCRIPTION" :"",
"PARTICULARTITLE" :"",
"URLSEO" :""
}
]
}
}
GET /brands/{id}
Descripción
Devuelve la información de la marca indicada mediante identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/brands/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,
"DATEADDED" :"2015-01-10",
"HIGHLIGHT" : false,
"ID" : 1,
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"LARGEIMAGE" :"",
"LARGETITLEIMAGE" :"",
"LONGDESCRIPTION" :"",
"NAME" :"",
"SHORTDESCRIPTION" :"",
"SMALLIMAGE" :"",
"SMALLTITLEIMAGE" :""
}
],
"PID" :"sdfsdf",
"SALE" : false,
"SEO": {
"LANGUAGES": [
{
"KEYWORDS" :"",
"METADESCRIPTION" :"",
"PARTICULARTITLE" :"",
"URLSEO" :""
}
]
}
}
PUT /brands/{id}
Descripción
Edición de una marca indicada mediante identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/brands/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "brands": { "languages": [ { "languageCode":string, "indexable": boolean "largeImage": string "largeTitleImage": string "linkFollowing": boolean "longDescription": string "name": string "shortDescription": string "smallImage": string "smallTitleImage": string } ], "pId":string, "priority":numeric, "seo": { "languages": [ { "keyWords":string, "languageCode":string, "metaDescription":string, "particularTitle":string, "urlSeo":string } ] }, "active": boolean "highlight": boolean "sale": boolean } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| brands | Obligatorio | struct | |
| Bloque de información que contiene la definición de una marca. | |||
| brands/active | Opcional | false | boolean |
| Define si la marca es visible (si esta activa). | |||
| brands/highlight | Opcional | boolean | |
| Define si la marca esta en novedad. Los valores admitidos son el 0 y el 1. Esta característica es informativa, el hecho de marcar la marca como novedad no altera los productos que esta contiene. | |||
| brands/languages | Opcional | array [0:n] | |
| Bloque con información variable según el idioma. | |||
| brands/languages/indexable | Opcional | true | boolean |
| brands/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. | |||
| brands/languages/largeImage | Opcional | string | |
| Imagen grande de la marca para el idioma seleccionado. Se debe indicar la ruta (relativa si es propia) de la imagen. No incluya este campo a no ser que se lo pidan desde Trilogi. | |||
| brands/languages/largeTitleImage | Opcional | string | |
| Imagen grande de título de la marca para el idioma seleccionado. Se debe indicar la ruta (relativa si es propia) de la imagen. No incluya este campo a no ser que se lo pidan desde Trilogi. | |||
| brands/languages/linkFollowing | Opcional | true | boolean |
| brands/languages/longDescription | Opcional | string | |
| Descripción larga de la marca para el idioma seleccionado. Solo debe especificarse si el diseño de la web lo contempla. | |||
| brands/languages/name | Opcional | string | |
| Nombre de la marca para el idioma seleccionado. | |||
| brands/languages/shortDescription | Opcional | string | |
| Descripción corta de la marca para el idioma seleccionado. Solo debe especificarse si el diseño de la web lo contempla. | |||
| brands/languages/smallImage | Opcional | string | |
| Imagen pequeña de la marca para el idioma seleccionado. Se debe indicar la ruta (relativa si es propia) de la imagen. No incluya este campo a no ser que se lo pidan desde Trilogi. | |||
| brands/languages/smallTitleImage | Opcional | string | |
| Imagen pequeña de título de la marca para el idioma seleccionado. Se debe indicar la ruta (relativa si es propia) de la imagen. No incluya este campo a no ser que se lo pidan desde Trilogi. | |||
| brands/pId | Opcional | string | |
| Identificador público de la marca. | |||
| brands/priority | Opcional | 0 | numeric |
| Define el orden de presentación de esta marca en relación al resto de marcas que se encuentran en su mismo nivel. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
| brands/sale | Opcional | boolean | |
| Define si la marca esta en oferta. Los valores admitidos son el 0 y el 1. Esta característica es informativa, el hecho de marcar la marca como oferta no altera los productos que esta contiene. | |||
| brands/seo | Opcional | struct | |
| Bloque con información de posicionamiento SEO. | |||
| brands/seo/languages | Opcional | array [0:n] | |
| Bloque con los datos SEO que dependen del idioma. | |||
| brands/seo/languages/keyWords | Opcional | string | |
| Palabras clave de la marca para el idioma seleccionado. Separadas por coma ','. | |||
| brands/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. | |||
| brands/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). | |||
| brands/seo/languages/particularTitle | Opcional | string | |
| Título de la ventana de la marca para el idioma seleccionado. En navegadores actuales, es el título de la pestaña. Longitud Máxima: 255 (61 recomendado). | |||
| brands/seo/languages/urlSeo | Opcional | string | |
| URL SEO de la marca 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 marca. 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" : true,
"DATEADDED" :"2015-01-10",
"HIGHLIGHT" : false,
"ID" : 1,
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"LARGEIMAGE" :"",
"LARGETITLEIMAGE" :"",
"LONGDESCRIPTION" :"",
"NAME" :"",
"SHORTDESCRIPTION" :"",
"SMALLIMAGE" :"",
"SMALLTITLEIMAGE" :""
}
],
"PID" :"sdfsdf",
"SALE" : false,
"SEO": {
"LANGUAGES": [
{
"KEYWORDS" :"",
"METADESCRIPTION" :"",
"PARTICULARTITLE" :"",
"URLSEO" :""
}
]
}
}
DELETE /brands/{id}
Descripción
Elimina la marca indicada mediante identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/brands/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 /brands/{id}/products
Descripción
Devuelve la lista de productos de la marca indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/brands/1/products
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"PRODUCTS": [
{
"ID" : 123
}
]
}
POST /brands/{id}/products
Descripción
Vincula productos a la marca indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/brands/1/products
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "products": { "id":numeric, "pId":string } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| products | Obligatorio | struct | |
| Bloque de información sobre los productos vinculados a esta marca. | |||
| products/id | Opcional | 0 | numeric |
| Identificador interno del producto que se vincula. Opcional en caso que se use identificador público. | |||
| products/pId | Opcional | string | |
| Identificador público del producto que se vincula. Opcional en caso que se use identificador interno. | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"PRODUCTS": [
{
"ID" : 123
}
]
}
DELETE /brands/{id}/products
Descripción
Desvincula productos de la marca indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/brands/1/products
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"PRODUCTS": [
]
}
DELETE /brands/{id}/products/{productId}
Descripción
Desvincula un producto determinado de la marca indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/brands/1/products/{productId}
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
| productId | Obligatorio | numeric | |
| Identificador interno de producto. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 123
}
GET /brands/count
Descripción
Devuelve un valor que indica la cantidad de marcas.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/brands/count
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| idList | Opcional | string | |
| Lista de los identificadores internos de marca que han de ser devueltos. | |||
| q | Opcional | string | |
| Criterio de búsqueda. | |||
| showOnlyVisible | Opcional | false | boolean |
| Devuelve únicamente elementos visibles. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ITEMS" : 143
}
GET /brands/getId/{pId}
Descripción
Devuelve el identificador interno de la marca.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/brands/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
}