categorías
Endpoint para gestionar el apartado de categorías. Está compuesto por una colección de recursos que permiten realizar todas las acciones de administración asociadas, como crear nuevas categorías, asignar productos a una categoría, ocultar o eliminar categorías, etc. También permite acciones más comunes como establecer filtros de usuarios/grupos y/o países/zonas o asociar etiquetas u otros elementos a una categoría concreta.
</> GET / categoriesDevuelve el listado de todas las categorías actuales.
</> POST / categoriesCreación de una categoría.
</> GET / categories/{id}Devuelve la información de la categoría indicada mediante identificador interno.
</> PUT / categories/{id}Edición de una categoría indicada mediante identificador interno.
</> DELETE / categories/{id}Elimina la categoría indicada mediante identificador interno.
</> GET / categories/{id}/activityLimitsDevuelve la información de los periodos de actividad de la categoría indicada.
</> POST / categories/{id}/activityLimitsCreación de un periodo de actividad para la categoría indicada.
</> DELETE / categories/{id}/activityLimitsElimina todos los periodos de actividad de la categoría indicada.
</> GET / categories/{id}/categoryItemsDevuelve los filtros asignados a la categoría indicada.
</> POST / categories/{id}/categoryItemsCreación de un filtro para la categoría indicada.
</> DELETE / categories/{id}/categoryItemsElimina todos los filtros asignados de la categoría indicada.
</> GET / categories/{id}/customTagsDevuelve las etiquetas de la categoría indicada.
</> POST / categories/{id}/customTagsVincula etiquetas a la categoría indicada.
</> DELETE / categories/{id}/customTagsDesvincula etiquetas de la categoría indicada.
</> GET / categories/{id}/customTags/{customTagId}Devuelve la información de una etiqueta determinada de la categoría indicada.
</> PUT / categories/{id}/customTags/{customTagId}Edición de una etiqueta determinada de la categoría indicada.
</> DELETE / categories/{id}/customTags/{customTagId}Desvincula una etiqueta determinada de la categoría indicada.
</> GET / categories/{id}/pricesDevuelve las definiciones de precios de la categoría indicada.
</> POST / categories/{id}/pricesCreación de definiciones de precios para la categoría indicada.
</> DELETE / categories/{id}/pricesElimina todas las definiciones de precios de la categoría indicada.
</> GET / categories/{id}/productsDevuelve la lista de productos de la categoría indicada.
</> POST / categories/{id}/productsVincula productos a la categoría indicada.
</> DELETE / categories/{id}/productsDesvincula productos de la categoría indicada.
</> DELETE / categories/{id}/products/{productId}Desvincula un producto determinado de la categoría indicada.
</> GET / categories/{id}/relatedItemsDevuelve la información de los elementos relacionados de la categoría indicada.
</> POST / categories/{id}/relatedItemsVincula elementos relacionados a la categoría indicada.
</> DELETE / categories/{id}/relatedItemsElimina todos los elementos relacionados de la categoría indicada.
</> GET / categories/activityLimits/{id}Devuelve la información sobre el periodo de activitad indicado.
</> PUT / categories/activityLimits/{id}Edición del periodo de actividad indicado.
</> DELETE / categories/activityLimits/{id}Elimina el periodo de actividad indicado.
</> GET / categories/categoryItems/{id}Devuelve la información sobre el filtro indicado.
</> DELETE / categories/categoryItems/{id}Elimina el filtro indicado.
</> GET / categories/countDevuelve un valor que indica la cantidad de categorías.
</> GET / categories/getId/{pId}Devuelve el identificador interno de la categoría.
</> PUT / categories/prices/{id}Edición de la definición de precios indicada mediante identificador interno.
</> DELETE / categories/prices/{id}Elimina la definición de precios indicada.
</> GET / categories/relatedItems/{id}Devuelve la información del elemento relacionado indicado.
</> DELETE / categories/relatedItems/{id}Elimina el elemento relacionado indicado.
GET /categories
Descripción
Devuelve el listado de todas las categorías 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/categories
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| areaId | Opcional | 0 | numeric |
| Devuelve las categorías contenidas en el área con el identificador interno indicado. | |||
| 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. | |||
| idList | Opcional | string | |
| Lista de los identificadores internos de categoría 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. | |||
| parentId | Opcional | 0 | numeric |
| Devuelve las subcategorías contenidas en la categoría con el identificador interno indicado. | |||
| perPage | Opcional | 100 | numeric |
| Cantidad de elementos por página. | |||
| 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 | id | 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
{
"CATEGORIES": [
{
"ACTIVE" : true,
"ACTIVITYLIMITS": [
{
"ACTIVATIONDATE" :"2015-11-02",
"EXPIRATIONDATE" :"2015-11-20",
"ID" : 23535
}
],
"AREA": {
"ID" : 123,
"PID" :"abc"
},
"AVAILABILITY": {
"ID" : 123,
"PID" :"abc"
},
"CATEGORYITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
],
"CUSTOMTAGS": {
"GENERAL": [
{
"ACTIVE" : true,
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
},
"VALUE" :"123"
}
],
"LANGUAGES": [
{
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
},
"LANGUAGES": [
{
"ACTIVE" : true,
"LANGUAGE" :"ES",
"VALUE" :"123"
}
]
}
],
"SELECTABLE": [
{
"ACTIVE" : true,
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
},
"VALUE": {
"ID" : 1,
"PID" :"abc"
}
}
]
},
"DATEADDED" :"2015-01-10",
"HIGHLIGHT" : false,
"ID" : 1,
"LANGUAGES": [
{
"DESTINATIONURL" :"",
"LANGUAGE" :"ES",
"LARGEIMAGE" :"",
"LARGETITLEIMAGE" :"",
"LONGDESCRIPTION" :"",
"NAME" :"",
"SHORTDESCRIPTION" :"",
"SMALLIMAGE" :"",
"SMALLTITLEIMAGE" :"",
"TARGET" :""
}
],
"PARENT": {
"ID" : 9,
"PID" :"abc"
},
"PID" :"sdfsdf",
"PRIORITY" : 34,
"PRODFIRST" : false,
"PRODUCTS": [
{
"ID" : 123,
"PID" :"abc"
}
],
"RELATEDITEMS": [
{
"ID" : 2,
"ITEMS": {
"BANNERS": [
],
"BLOGPOST": [
],
"CATEGORIES": [
],
"NEWS": [
],
"PAGES": [
],
"PRODUCTS": [
{
"ID" : 43567,
"ITEM": {
"ID" : 13,
"pId" :"abc"
}
}
]
},
"NAME" :"Related Definition 1",
"PID" :"abc"
}
],
"SALE" : false,
"SEO": {
"LANGUAGES": [
{
"KEYWORDKS" :"",
"METADESCRIPTION" :"",
"PARTICULARTITLE" :"",
"URL" :""
}
]
},
"SUBCATEGORIES": [
{
"ID" : 123,
"PID" :"abc"
}
]
}
],
"CURSORS": {
"NEXT" :"http://api.logicommerce.net/v1/categories?page=2&perPage=100",
"PREVIOUS" :""
},
"ITEMS" : 10,
"PAGERPARAMETERS": {
"PAGE" : 1,
"PERPAGE" : 100
}
}
POST /categories
Descripción
Creación de una categoría.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/categories
Parámetros de entrada JSON
{ "categories": { "active":boolean, "activityLimits": [ { "activationDate": datetime "expirationDate": datetime } ], "area": { "id":numeric, "pId":string }, "availability": { "id":numeric, "pId":string }, "categoryItems": [ { "id":numeric, "itemType":numeric, "pId":string } ], "customTags": [ { "customTag": { "id":numeric, "pId":string }, "general": { "value":string, "active": boolean }, "group": { "id":numeric, "pId":string }, "languages": [ { "languageCode":string, "value":string, "active": boolean } ], "selectable": { "active":boolean, "value": { "id":numeric, "pId":string } } } ], "highlight":boolean, "languages": [ { "languageCode":string, "target":numeric, "destinationURL": string "indexable": boolean "largeImage": string "largeTitleImage": string "linkFollowing": boolean "longDescription": string "name": string "shortDescription": string "smallImage": string "smallTitleImage": string } ], "pId":string, "parent": { "id":numeric, "pId":string }, "prices": [ { "definition": { "id":numeric, "pId":string }, "fare": { "id":numeric, "pId":string }, "percentPrice":numeric, "percentPriceOverrideCustomPrices":boolean, "showBasePrice":boolean, "useRetailPrice":boolean } ], "prodFirst":boolean, "relatedItems": [ { "item": { "id":numeric, "pId":string }, "relatedDefinition": { "id":numeric, "pId":string }, "type":numeric } ], "sale":boolean, "seo": { "languages": [ { "indexable":boolean, "keyWords":string, "languageCode":string, "linkFollowing":boolean, "metaDescription":string, "particularTitle":string, "urlSeo":string } ] }, "includeSubcategories": boolean "priority": numeric } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| categories | Obligatorio | struct | |
| Bloque de información que contiene la definición de una categoría. | |||
| categories/active | Opcional | false | boolean |
| Define si la categoría es visible (si esta activa). | |||
| categories/activityLimits | Opcional | array [0:n] | |
| Bloque con información sobre los periodos de actividad. | |||
| categories/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). | |||
| categories/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). | |||
| categories/area | Opcional | struct | |
| Bloque que define en que área de la tienda se ubicara esta categoría. Si este código de área queda en blanco y no tiene código de categoría padre, quedará colgando de la raíz de categorías. | |||
| categories/area/id | Opcional | 0 | numeric |
| Identificador interno del área. Opcional en caso que se use identificador público. | |||
| categories/area/pId | Opcional | string | |
| Identificador público del área. Opcional en caso que se use identificador interno. | |||
| categories/availability | Opcional | struct | |
| Bloque de información sobre disponibilidad de productos. La disponibilidad vinculada se heredará a todos los productos cuya categoría principal sea esta. La disponibilidad se puede redefinir a nivel de producto. | |||
| categories/availability/id | Opcional | 0 | numeric |
| Identificador interno de la disponibilidad de productos. Opcional en caso que se use identificador público. | |||
| categories/availability/pId | Opcional | string | |
| Identificador público de la disponibilidad de productos. Opcional en caso que se use identificador interno. | |||
| categories/categoryItems | Opcional | array [0:n] | |
| Bloque de información sobre los filtros aplicados a este elemento. | |||
| categories/categoryItems/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). | |||
| categories/categoryItems/itemType | Obligatorio | numeric | |
| Tipo de filtro. Valores permitidos: 10 - Usuario, 11 - Grupo de usuario, 30 - Países, 9 - Zonas de países | |||
| categories/categoryItems/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. | |||
| categories/customTags | Opcional | array [0:n] | |
| Bloque para vincular etiquetas de tipo categoría, para esta categoría en concreto. | |||
| categories/customTags/customTag | Obligatorio | struct | |
| Bloque de información asociada a una etiqueta en concreto. Dependiendo del tipo de etiqueta, se debe añadir a continuación bloques del tipo general, languages o selectable. | |||
| categories/customTags/customTag/id | Opcional | 0 | numeric |
| Indica el identificador interno de la etiqueta. Debe existir previamente. Opcional en caso que se use identificador público. | |||
| categories/customTags/customTag/pId | Opcional | string | |
| Indica el identificador público de la etiqueta. Debe existir previamente. Opcional en caso que se use identificador interno. | |||
| categories/customTags/general | Opcional | struct | |
| Bloque para etiquetas cuyos valores no dependen del idioma | |||
| categories/customTags/general/active | Opcional | false | boolean |
| Define la visibilidad de la etiqueta. | |||
| categories/customTags/general/value | Opcional | string | |
| Define el valor de la etiqueta. | |||
| categories/customTags/group | Opcional | struct | |
| Bloque para informar del grupo de etiquetas en caso que la etiqueta pertenezca a más de uno. | |||
| categories/customTags/group/id | Opcional | 0 | numeric |
| Identificador interno del grupo de etiquetas. Opcional en caso que se use identificador público. | |||
| categories/customTags/group/pId | Opcional | string | |
| Identificador público del grupo de etiquetas. Opcional en caso que se use identificador interno. | |||
| categories/customTags/languages | Opcional | array [0:n] | |
| Bloque para etiquetas cuyos valores dependen del idioma. | |||
| categories/customTags/languages/active | Opcional | false | boolean |
| Define la visibilidad de la etiqueta. | |||
| categories/customTags/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. | |||
| categories/customTags/languages/value | Opcional | string | |
| Define el valor de la etiqueta. | |||
| categories/customTags/selectable | Opcional | struct | |
| Bloque para etiquetas cuyos valores estan predefinidos a modo de selector desplegable. | |||
| categories/customTags/selectable/active | Obligatorio | boolean | |
| Define la visibilidad de la etiqueta. | |||
| categories/customTags/selectable/value | Opcional | struct | |
| Bloque para identificar la opción del desplegable. | |||
| categories/customTags/selectable/value/id | Opcional | 0 | numeric |
| Identificador interno del valor que se quiere asignar. Opcional en caso que se use identificador público. | |||
| categories/customTags/selectable/value/pId | Opcional | string | |
| Identificador público del valor que se quiere asignar. Opcional en caso que se use identificador interno. | |||
| categories/highlight | Obligatorio | boolean | |
| Define si la categoría esta en novedad. Los valores admitidos son el 0 y el 1. Esta característica es informativa, el hecho de marcar la categoría como novedad no altera los productos que esta contiene. | |||
| categories/includeSubcategories | Opcional | true | boolean |
| Define si se deben visualizar también todos los productos de las subcategorías contenidas en esta categoría. Los valores admitidos son el 0 y el 1. Si se establece a 0 solo se mostrarán, si los tuviera, productos directamente contenidos en esta categoría. | |||
| categories/languages | Opcional | array [0:n] | |
| Bloque con información variable según el idioma. | |||
| categories/languages/destinationURL | Opcional | string | |
| En caso que se necesite que al pulsar sobre esta categoría 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. | |||
| categories/languages/indexable | Opcional | true | boolean |
| categories/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. | |||
| categories/languages/largeImage | Opcional | string | |
| Imagen grande de la categoría 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. | |||
| categories/languages/largeTitleImage | Opcional | string | |
| Imagen grande de título de la categoría 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. | |||
| categories/languages/linkFollowing | Opcional | true | boolean |
| categories/languages/longDescription | Opcional | string | |
| Descripción larga de la categoría para el idioma seleccionado. Solo debe especificarse si el diseño de la web lo contempla. | |||
| categories/languages/name | Opcional | string | |
| Nombre de la categoría para el idioma seleccionado. | |||
| categories/languages/shortDescription | Opcional | string | |
| Descripción corta de la categoría para el idioma seleccionado. Solo debe especificarse si el diseño de la web lo contempla. | |||
| categories/languages/smallImage | Opcional | string | |
| Imagen pequeña de la categoría 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. | |||
| categories/languages/smallTitleImage | Opcional | string | |
| Imagen pequeña de título de la categoría 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. | |||
| categories/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 | |||
| categories/pId | Obligatorio | string | |
| Identificador público de la categoría. | |||
| categories/parent | Opcional | struct | |
| Bloque que especifica el identificador del padre de la categoría. Para las categorías raíz se debe dejar vacío. Corresponde con alguno de los códigos de categoría definidos dentro del mismo post, o bien que ya existan previamente en la base de datos. Si en algún caso el archivo tuviera un código de categoría raíz, que apunte a alguna categoría no definida, dicha categoría quedaría colgando de la raíz del árbol de categorías. | |||
| categories/parent/id | Opcional | 0 | numeric |
| Identificador interno de la categoría padre. Opcional en caso que se use identificador público. | |||
| categories/parent/pId | Opcional | string | |
| Identificador público de la categoría padre. Opcional en caso que se use identificador interno. | |||
| categories/prices | Opcional | array [0:n] | |
| Bloque de información sobre los precios por categoría. | |||
| categories/prices/definition | Opcional | struct | |
| Bloque con información sobre las personalizaciones. Las personalizaciones se basan en una vinculación a una definición, que son conjuntos de propiedades bajo un condicionante. La definición debe existir previamente. Si se espcifica indica que el descuento se aplica a una definición determinada. | |||
| categories/prices/definition/id | Opcional | 0 | numeric |
| Identificador interno de la definición. Opcional en caso que se use identificador público. | |||
| categories/prices/definition/pId | Opcional | string | |
| Identificador público de la definición. Opcional en caso que se use identificador interno. | |||
| categories/prices/fare | Opcional | struct | |
| Bloque de definición de la tarifa. Debe existir previamente. Si se espcifica indica que el descuento se aplica a una tarifa determinada. | |||
| categories/prices/fare/id | Opcional | 0 | numeric |
| Identificador interno de la tarifa. Opcional en caso que se use identificador público. | |||
| categories/prices/fare/pId | Opcional | string | |
| Identificador público de la tarifa. Opcional en caso que se use identificador interno. | |||
| categories/prices/percentPrice | Opcional | 0 | numeric |
| Indica el valor del porcentaje que se usará para calcular el precio final de un producto. Puede ser positivo (incremento) o negativo (descuento). | |||
| categories/prices/percentPriceOverrideCustomPrices | Opcional | false | boolean |
| Indica sobre qué política de precios se debe aplicar el cálculo del porcentaje. Valores permitidos: true - Se ignoran personalizaciones o tarifas y el cáculo del porcentaje se realizará siempre sobre el precio base (tarifa base) del producto, false - El cálculo del porcentaje se realizará sobre el precio de la personalización o tarifa definida que corresponda. | |||
| categories/prices/showBasePrice | Opcional | false | boolean |
| Indica que debe mostrarse (o no) el precio base con el valor existente antes de realizar el cálculo del precio, a modo de precio anterior o 'tachado'. | |||
| categories/prices/useRetailPrice | Opcional | true | boolean |
| Indica que el cálculo del porcentaje se realizará sobre el precio de oferta, si lo tuviera. Se debe tener en cuenta que si este parámetro es false, no se define o es true pero no existe oferta, el porcentaje se aplicará sobre el precio base. | |||
| categories/priority | Opcional | numeric | |
| Define el orden de presentación de esta categoría en relación al resto de categorías que se encuentran en su mismo nivel. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
| categories/prodFirst | Obligatorio | boolean | |
| Define, para la categoría, si al acceder a su página se quiere mostrar primero los productos. Los valores admitidos son el 0 y el 1. Si el valor es 1 se muestran primero los productos y después las sub-categorías, sino al revés. | |||
| categories/relatedItems | Opcional | array [0:n] | |
| Bloque de información sobre elementos relacionados en esta categoría. | |||
| categories/relatedItems/item | Obligatorio | struct | |
| Bloque para informar sobre el elemento que se relaciona. | |||
| categories/relatedItems/item/id | Opcional | 0 | numeric |
| Identificador interno del elemento a relacionar. Opcional en caso que se use identificador público. | |||
| categories/relatedItems/item/pId | Opcional | string | |
| Identificador público del elemento a relacionar. Opcional en caso que se use identificador interno. | |||
| categories/relatedItems/relatedDefinition | Obligatorio | struct | |
| Bloque para informar sobre la sección en la que se incluirá el elemento que se quiere relacionar. | |||
| categories/relatedItems/relatedDefinition/id | Opcional | 0 | numeric |
| Identificador interno de la sección. Opcional en caso que se use identificador público. | |||
| categories/relatedItems/relatedDefinition/pId | Opcional | string | |
| Identificador público de la sección. Opcional en caso que se use identificador interno. | |||
| categories/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. | |||
| categories/sale | Obligatorio | boolean | |
| Define si la categoría esta en oferta. Los valores admitidos son el 0 y el 1. Esta característica es informativa, el hecho de marcar la categoría como oferta no altera los productos que esta contiene. | |||
| categories/seo | Opcional | struct | |
| Bloque con información de posicionamiento SEO. | |||
| categories/seo/languages | Opcional | array [0:n] | |
| Bloque con los datos SEO que dependen del idioma. | |||
| categories/seo/languages/indexable | Opcional | false | boolean |
| categories/seo/languages/keyWords | Opcional | string | |
| Palabras clave de la categoría para el idioma seleccionado. Separadas por coma ','. | |||
| categories/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. | |||
| categories/seo/languages/linkFollowing | Opcional | false | boolean |
| categories/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). | |||
| categories/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). | |||
| categories/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_- | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"ACTIVE" : true,
"ACTIVITYLIMITS": [
{
"ACTIVATIONDATE" :"2015-11-02",
"EXPIRATIONDATE" :"2015-11-20",
"ID" : 23535
}
],
"AREA": {
"ID" : 123,
"PID" :"abc"
},
"AVAILABILITY": {
"ID" : 123,
"PID" :"abc"
},
"CATEGORYITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
],
"CUSTOMTAGS": {
"GENERAL": [
{
"ACTIVE" : true,
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
},
"VALUE" :"123"
}
],
"LANGUAGES": [
{
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
},
"LANGUAGES": [
{
"ACTIVE" : true,
"LANGUAGE" :"ES",
"VALUE" :"123"
}
]
}
],
"SELECTABLE": [
{
"ACTIVE" : true,
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
},
"VALUE": {
"ID" : 1,
"PID" :"abc"
}
}
]
},
"DATEADDED" :"2015-01-10",
"HIGHLIGHT" : false,
"ID" : 1,
"LANGUAGES": [
{
"DESTINATIONURL" :"",
"LANGUAGE" :"ES",
"LARGEIMAGE" :"",
"LARGETITLEIMAGE" :"",
"LONGDESCRIPTION" :"",
"NAME" :"",
"SHORTDESCRIPTION" :"",
"SMALLIMAGE" :"",
"SMALLTITLEIMAGE" :"",
"TARGET" :""
}
],
"PARENT": {
"ID" : 9,
"PID" :"abc"
},
"PID" :"sdfsdf",
"PRIORITY" : 34,
"PRODFIRST" : false,
"PRODUCTS": [
{
"ID" : 123,
"PID" :"abc"
}
],
"RELATEDITEMS": [
{
"ID" : 2,
"ITEMS": {
"BANNERS": [
],
"BLOGPOST": [
],
"CATEGORIES": [
],
"NEWS": [
],
"PAGES": [
],
"PRODUCTS": [
{
"ID" : 43567,
"ITEM": {
"ID" : 13,
"pId" :"abc"
}
}
]
},
"NAME" :"Related Definition 1",
"PID" :"abc"
}
],
"SALE" : false,
"SEO": {
"LANGUAGES": [
{
"KEYWORDKS" :"",
"METADESCRIPTION" :"",
"PARTICULARTITLE" :"",
"URL" :""
}
]
},
"SUBCATEGORIES": [
{
"ID" : 123,
"PID" :"abc"
}
]
}
GET /categories/{id}
Descripción
Devuelve la información de la categoría indicada mediante identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/categories/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
}
],
"AREA": {
"ID" : 123,
"PID" :"abc"
},
"AVAILABILITY": {
"ID" : 123,
"PID" :"abc"
},
"CATEGORYITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
],
"CUSTOMTAGS": {
"GENERAL": [
{
"ACTIVE" : true,
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
},
"VALUE" :"123"
}
],
"LANGUAGES": [
{
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
},
"LANGUAGES": [
{
"ACTIVE" : true,
"LANGUAGE" :"ES",
"VALUE" :"123"
}
]
}
],
"SELECTABLE": [
{
"ACTIVE" : true,
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
},
"VALUE": {
"ID" : 1,
"PID" :"abc"
}
}
]
},
"DATEADDED" :"2015-01-10",
"HIGHLIGHT" : false,
"ID" : 1,
"LANGUAGES": [
{
"DESTINATIONURL" :"",
"LANGUAGE" :"ES",
"LARGEIMAGE" :"",
"LARGETITLEIMAGE" :"",
"LONGDESCRIPTION" :"",
"NAME" :"",
"SHORTDESCRIPTION" :"",
"SMALLIMAGE" :"",
"SMALLTITLEIMAGE" :"",
"TARGET" :""
}
],
"PARENT": {
"ID" : 9,
"PID" :"abc"
},
"PID" :"sdfsdf",
"PRIORITY" : 34,
"PRODFIRST" : false,
"PRODUCTS": [
{
"ID" : 123,
"PID" :"abc"
}
],
"RELATEDITEMS": [
{
"ID" : 2,
"ITEMS": {
"BANNERS": [
],
"BLOGPOST": [
],
"CATEGORIES": [
],
"NEWS": [
],
"PAGES": [
],
"PRODUCTS": [
{
"ID" : 43567,
"ITEM": {
"ID" : 13,
"pId" :"abc"
}
}
]
},
"NAME" :"Related Definition 1",
"PID" :"abc"
}
],
"SALE" : false,
"SEO": {
"LANGUAGES": [
{
"KEYWORDKS" :"",
"METADESCRIPTION" :"",
"PARTICULARTITLE" :"",
"URL" :""
}
]
},
"SUBCATEGORIES": [
{
"ID" : 123,
"PID" :"abc"
}
]
}
PUT /categories/{id}
Descripción
Edición de una categoría indicada mediante identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/categories/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "categories": { "area": { "id":numeric, "pId":string }, "availability": { "id":numeric, "pId":string }, "includeSubCategories":boolean, "languages": [ { "languageCode":string, "target":numeric, "destinationURL": string "indexable": boolean "largeImage": string "largeTitleImage": string "linkFollowing": boolean "longDescription": string "name": string "shortDescription": string "smallImage": string "smallTitleImage": string } ], "pId":string, "parent": { "id":numeric, "pId":string }, "seo": { "languages": [ { "indexable":boolean, "keyWords":string, "languageCode":string, "linkFollowing":boolean, "metaDescription":string, "particularTitle":string, "urlSeo":string } ] }, "active": boolean "highLight": boolean "priority": numeric "prodFirst": boolean "sale": boolean } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| categories | Obligatorio | struct | |
| Bloque de información que contiene la definición de una categoría. | |||
| categories/active | Opcional | false | boolean |
| Define si la categoría es visible (si esta activa). | |||
| categories/area | Opcional | struct | |
| Bloque que define en que área de la tienda se ubicara esta categoría. Si este código de área queda en blanco y no tiene código de categoría padre, quedará colgando de la raíz de categorías. | |||
| categories/area/id | Opcional | 0 | numeric |
| Identificador interno del área. Opcional en caso que se use identificador público. | |||
| categories/area/pId | Opcional | string | |
| Identificador público del área. Opcional en caso que se use identificador interno. | |||
| categories/availability | Opcional | struct | |
| Bloque de información sobre disponibilidad de productos. La disponibilidad vinculada se heredará a todos los productos cuya categoría principal sea esta. La disponibilidad se puede redefinir a nivel de producto. | |||
| categories/availability/id | Opcional | 0 | numeric |
| Identificador interno de la disponibilidad de productos. Opcional en caso que se use identificador público. | |||
| categories/availability/pId | Opcional | string | |
| Identificador público de la disponibilidad de productos. Opcional en caso que se use identificador interno. | |||
| categories/highLight | Opcional | boolean | |
| Define si la categoría esta en novedad. Los valores admitidos son el 0 y el 1. Esta característica es informativa, el hecho de marcar la categoría como novedad no altera los productos que esta contiene. | |||
| categories/includeSubCategories | Opcional | true | boolean |
| Define si se deben visualizar también todos los productos de las subcategorías contenidas en esta categoría. Los valores admitidos son el 0 y el 1. Si se establece a 0 solo se mostrarán, si los tuviera, productos directamente contenidos en esta categoría. | |||
| categories/languages | Opcional | array [0:n] | |
| Bloque con información variable según el idioma. | |||
| categories/languages/destinationURL | Opcional | string | |
| En caso que se necesite que al pulsar sobre esta categoría 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. | |||
| categories/languages/indexable | Opcional | true | boolean |
| categories/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. | |||
| categories/languages/largeImage | Opcional | string | |
| Imagen grande de la categoría 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. | |||
| categories/languages/largeTitleImage | Opcional | string | |
| Imagen grande de título de la categoría 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. | |||
| categories/languages/linkFollowing | Opcional | true | boolean |
| categories/languages/longDescription | Opcional | string | |
| Descripción larga de la categoría para el idioma seleccionado. Solo debe especificarse si el diseño de la web lo contempla. | |||
| categories/languages/name | Opcional | string | |
| Nombre de la categoría para el idioma seleccionado. | |||
| categories/languages/shortDescription | Opcional | string | |
| Descripción corta de la categoría para el idioma seleccionado. Solo debe especificarse si el diseño de la web lo contempla. | |||
| categories/languages/smallImage | Opcional | string | |
| Imagen pequeña de la categoría 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. | |||
| categories/languages/smallTitleImage | Opcional | string | |
| Imagen pequeña de título de la categoría 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. | |||
| categories/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 | |||
| categories/pId | Opcional | string | |
| Identificador público de la categoría. | |||
| categories/parent | Opcional | struct | |
| Bloque que especifica el identificador del padre de la categoría. Para las categorías raíz se debe dejar vacío. Corresponde con alguno de los códigos de categoría definidos dentro del mismo post, o bien que ya existan previamente en la base de datos. Si en algún caso el archivo tuviera un código de categoría raíz, que apunte a alguna categoría no definida, dicha categoría quedaría colgando de la raíz del árbol de categorías. | |||
| categories/parent/id | Opcional | 0 | numeric |
| Identificador interno de la categoría padre. Opcional en caso que se use identificador público. | |||
| categories/parent/pId | Opcional | string | |
| Identificador público de la categoría padre. Opcional en caso que se use identificador interno. | |||
| categories/priority | Opcional | numeric | |
| Define el orden de presentación de esta categoría en relación al resto de categorías que se encuentran en su mismo nivel. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
| categories/prodFirst | Opcional | boolean | |
| Define, para la categoría, si al acceder a su página se quiere mostrar primero los productos. Los valores admitidos son el 0 y el 1. Si el valor es 1 se muestran primero los productos y después las sub-categorías, sino al revés. | |||
| categories/sale | Opcional | boolean | |
| Define si la categoría esta en oferta. Los valores admitidos son el 0 y el 1. Esta característica es informativa, el hecho de marcar la categoría como oferta no altera los productos que esta contiene. | |||
| categories/seo | Opcional | struct | |
| Bloque con información de posicionamiento SEO. | |||
| categories/seo/languages | Opcional | array [0:n] | |
| Bloque con los datos SEO que dependen del idioma. | |||
| categories/seo/languages/indexable | Opcional | false | boolean |
| categories/seo/languages/keyWords | Opcional | string | |
| Palabras clave de la categoría para el idioma seleccionado. Separadas por coma ','. | |||
| categories/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. | |||
| categories/seo/languages/linkFollowing | Opcional | false | boolean |
| categories/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). | |||
| categories/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). | |||
| categories/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_- | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACTIVE" : true,
"ACTIVITYLIMITS": [
{
"ACTIVATIONDATE" :"2015-11-02",
"EXPIRATIONDATE" :"2015-11-20",
"ID" : 23535
}
],
"AREA": {
"ID" : 123,
"PID" :"abc"
},
"AVAILABILITY": {
"ID" : 123,
"PID" :"abc"
},
"CATEGORYITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
],
"CUSTOMTAGS": {
"GENERAL": [
{
"ACTIVE" : true,
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
},
"VALUE" :"123"
}
],
"LANGUAGES": [
{
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
},
"LANGUAGES": [
{
"ACTIVE" : true,
"LANGUAGE" :"ES",
"VALUE" :"123"
}
]
}
],
"SELECTABLE": [
{
"ACTIVE" : true,
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
},
"VALUE": {
"ID" : 1,
"PID" :"abc"
}
}
]
},
"DATEADDED" :"2015-01-10",
"HIGHLIGHT" : false,
"ID" : 1,
"LANGUAGES": [
{
"DESTINATIONURL" :"",
"LANGUAGE" :"ES",
"LARGEIMAGE" :"",
"LARGETITLEIMAGE" :"",
"LONGDESCRIPTION" :"",
"NAME" :"",
"SHORTDESCRIPTION" :"",
"SMALLIMAGE" :"",
"SMALLTITLEIMAGE" :"",
"TARGET" :""
}
],
"PARENT": {
"ID" : 9,
"PID" :"abc"
},
"PID" :"sdfsdf",
"PRIORITY" : 34,
"PRODFIRST" : false,
"PRODUCTS": [
{
"ID" : 123,
"PID" :"abc"
}
],
"RELATEDITEMS": [
{
"ID" : 2,
"ITEMS": {
"BANNERS": [
],
"BLOGPOST": [
],
"CATEGORIES": [
],
"NEWS": [
],
"PAGES": [
],
"PRODUCTS": [
{
"ID" : 43567,
"ITEM": {
"ID" : 13,
"pId" :"abc"
}
}
]
},
"NAME" :"Related Definition 1",
"PID" :"abc"
}
],
"SALE" : false,
"SEO": {
"LANGUAGES": [
{
"KEYWORDKS" :"",
"METADESCRIPTION" :"",
"PARTICULARTITLE" :"",
"URL" :""
}
]
},
"SUBCATEGORIES": [
{
"ID" : 123,
"PID" :"abc"
}
]
}
DELETE /categories/{id}
Descripción
Elimina la categoría indicada mediante identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/categories/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
| confirm | Opcional | false | boolean |
| Parámetro de seguridad adicional que se debe pasar con valor true si mode=3. No es necesario en culaquier otro caso. | |||
| mode | Opcional | 1 | numeric |
| Indica el nivel de borrado. Valores permitidos: 1 - Solo eliminar categorías (se eliminarán solo las categorías. Su contenido se moverá a No asignados), 2 - Eliminar categorías y subcategorías (se eliminarán las categorías y sus subcategorías. Los productos se moverán a No asignados), 3 - Eliminar categorías, subcategorías y productos (se eliminarán las categorías, sus subcategorías y los productos cuya categoría principal esté incluida en esta lista. Los productos con una categoría principal diferente no serán eliminados, solo sus enlaces). | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 1
}
GET /categories/{id}/activityLimits
Descripción
Devuelve la información de los periodos de actividad de la categoría indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/categories/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 /categories/{id}/activityLimits
Descripción
Creación de un periodo de actividad para la categoría indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/categories/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 /categories/{id}/activityLimits
Descripción
Elimina todos los periodos de actividad de la categoría indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/categories/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 /categories/{id}/categoryItems
Descripción
Devuelve los filtros asignados a la categoría 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/categories/1/categoryItems
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"CATEGORYITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
]
}
POST /categories/{id}/categoryItems
Descripción
Creación de un filtro para la categoría indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/categories/1/categoryItems
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "categoryItems": { "id":numeric, "itemType":numeric, "pId":string } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| categoryItems | Obligatorio | struct | |
| Bloque de información sobre los filtros aplicados a este elemento. | |||
| categoryItems/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). | |||
| categoryItems/itemType | Obligatorio | numeric | |
| Tipo de filtro. Valores permitidos: 10 - Usuario, 11 - Grupo de usuario, 30 - Países, 9 - Zonas de países | |||
| categoryItems/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
{
"CATEGORYITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
]
}
DELETE /categories/{id}/categoryItems
Descripción
Elimina todos los filtros asignados de la categoría indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/categories/1/categoryItems
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"CATEGORYITEMS": [
]
}
GET /categories/{id}/customTags
Descripción
Devuelve las etiquetas de la categoría indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/categories/1/customTags
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. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"CUSTOMTAGS": [
{
"GENERAL": [
{
"ACTIVE" : true,
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
},
"VALUE" :"123"
}
],
"LANGUAGES": [
{
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
},
"LANGUAGES": [
{
"ACTIVE" : true,
"LANGUAGE" :"ES",
"VALUE" :"123"
}
]
}
],
"SELECTABLE": [
{
"ACTIVE" : true,
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
},
"VALUE": {
"ID" : 1,
"PID" :"abc"
}
}
]
}
]
}
POST /categories/{id}/customTags
Descripción
Vincula etiquetas a la categoría indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/categories/1/customTags
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "customTags": { "customTag": { "id":numeric, "pId":string }, "general": { "value":string, "active": boolean }, "group": { "id":numeric, "pId":string }, "languages": [ { "languageCode":string, "value":string, "active": boolean } ], "selectable": { "active":boolean, "value": { "id":numeric, "pId":string } } } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| customTags | Obligatorio | struct | |
| Bloque para vincular etiquetas de tipo categoría, para esta categoría en concreto. | |||
| customTags/customTag | Obligatorio | struct | |
| Bloque de información asociada a una etiqueta en concreto. Dependiendo del tipo de etiqueta, se debe añadir a continuación bloques del tipo general, languages o selectable. | |||
| customTags/customTag/id | Opcional | 0 | numeric |
| Indica el identificador interno de la etiqueta. Debe existir previamente. Opcional en caso que se use identificador público. | |||
| customTags/customTag/pId | Opcional | string | |
| Indica el identificador público de la etiqueta. Debe existir previamente. Opcional en caso que se use identificador interno. | |||
| customTags/general | Opcional | struct | |
| Bloque para etiquetas cuyos valores no dependen del idioma | |||
| customTags/general/active | Opcional | false | boolean |
| Define la visibilidad de la etiqueta. | |||
| customTags/general/value | Opcional | string | |
| Define el valor de la etiqueta. | |||
| customTags/group | Opcional | struct | |
| Bloque para informar del grupo de etiquetas en caso que la etiqueta pertenezca a más de uno. | |||
| customTags/group/id | Opcional | 0 | numeric |
| Identificador interno del grupo de etiquetas. Opcional en caso que se use identificador público. | |||
| customTags/group/pId | Opcional | string | |
| Identificador público del grupo de etiquetas. Opcional en caso que se use identificador interno. | |||
| customTags/languages | Opcional | array [0:n] | |
| Bloque para etiquetas cuyos valores dependen del idioma. | |||
| customTags/languages/active | Opcional | false | boolean |
| Define la visibilidad de la etiqueta. | |||
| customTags/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. | |||
| customTags/languages/value | Opcional | string | |
| Define el valor de la etiqueta. | |||
| customTags/selectable | Opcional | struct | |
| Bloque para etiquetas cuyos valores estan predefinidos a modo de selector desplegable. | |||
| customTags/selectable/active | Obligatorio | boolean | |
| Define la visibilidad de la etiqueta. | |||
| customTags/selectable/value | Opcional | struct | |
| Bloque para identificar la opción del desplegable. | |||
| customTags/selectable/value/id | Opcional | 0 | numeric |
| Identificador interno del valor que se quiere asignar. Opcional en caso que se use identificador público. | |||
| customTags/selectable/value/pId | Opcional | string | |
| Identificador público del valor que se quiere asignar. Opcional en caso que se use identificador interno. | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"CUSTOMTAGS": [
{
"GENERAL": [
{
"ACTIVE" : true,
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
},
"VALUE" :"123"
}
],
"LANGUAGES": [
{
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
},
"LANGUAGES": [
{
"ACTIVE" : true,
"LANGUAGE" :"ES",
"VALUE" :"123"
}
]
}
],
"SELECTABLE": [
{
"ACTIVE" : true,
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
},
"VALUE": {
"ID" : 1,
"PID" :"abc"
}
}
]
}
]
}
DELETE /categories/{id}/customTags
Descripción
Desvincula etiquetas de la categoría indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/categories/1/customTags
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"CUSTOMTAGS": [
]
}
GET /categories/{id}/customTags/{customTagId}
Descripción
Devuelve la información de una etiqueta determinada de la categoría indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/categories/1/customTags/{customTagId}
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
| customTagId | Obligatorio | numeric | |
| Identificador interno de la etiqueta. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GENERAL": {
"ACTIVE" : true,
"VALUE" :"12"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
}
}
PUT /categories/{id}/customTags/{customTagId}
Descripción
Edición de una etiqueta determinada de la categoría indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/categories/1/customTags/{customTagId}
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
| customTagId | Obligatorio | numeric | |
| Identificador interno de la etiqueta. | |||
Parámetros de entrada JSON
{ "customTags": { "general": { "active":boolean, "value":string }, "languages": [ { "active":boolean, "languageCode":string, "value":string } ], "selectable": { "active":boolean, "value": { "id":numeric, "pId":string } } } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| customTags | Obligatorio | struct | |
| Bloque para vincular etiquetas de tipo categoría, para esta categoría en concreto. | |||
| customTags/general | Opcional | struct | |
| Bloque para etiquetas cuyos valores no dependen del idioma | |||
| customTags/general/active | Opcional | false | boolean |
| Define la visibilidad de la etiqueta. | |||
| customTags/general/value | Opcional | string | |
| Define el valor de la etiqueta. | |||
| customTags/languages | Opcional | array [0:n] | |
| Bloque para etiquetas cuyos valores dependen del idioma. | |||
| customTags/languages/active | Opcional | false | boolean |
| Define la visibilidad de la etiqueta. | |||
| customTags/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. | |||
| customTags/languages/value | Opcional | string | |
| Define el valor de la etiqueta. | |||
| customTags/selectable | Opcional | struct | |
| Bloque para etiquetas cuyos valores estan predefinidos a modo de selector desplegable. | |||
| customTags/selectable/active | Opcional | boolean | |
| Define la visibilidad de la etiqueta. | |||
| customTags/selectable/value | Opcional | struct | |
| Bloque para identificar la opción del desplegable. | |||
| customTags/selectable/value/id | Opcional | 0 | numeric |
| Identificador interno del valor que se quiere asignar. Opcional en caso que se use identificador público. | |||
| customTags/selectable/value/pId | Opcional | string | |
| Identificador público del valor que se quiere asignar. Opcional en caso que se use identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GENERAL": {
"ACTIVE" : true,
"VALUE" :"12"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
}
}
DELETE /categories/{id}/customTags/{customTagId}
Descripción
Desvincula una etiqueta determinada de la categoría indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/categories/1/customTags/{customTagId}
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
| customTagId | Obligatorio | numeric | |
| Identificador interno de la etiqueta. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"CUSTOMTAGID" : 12445,
"ID" : 23535
}
GET /categories/{id}/prices
Descripción
Devuelve las definiciones de precios de la categoría indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/categories/1/prices
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"PRICES": [
{
"DEFINITION": {
"ID" : 0
},
"FARE": {
"ID" : 5
},
"ID" : 3,
"PERCENTPRICE" : 99,
"PERCENTPRICEOVERRIDECUSTOMPRICES" : true,
"SHOWBASEPRICE" : true,
"USERETAILPRICE" : false
}
]
}
POST /categories/{id}/prices
Descripción
Creación de definiciones de precios para la categoría indicada.
Importante: No se puede indicar en el mismo registro una tarifa y una personalización. Los precios se asignan a uno u otro, no observar esto puede provocar efectos no deseados.
Importante: No se puede indicar en el mismo registro una tarifa y una personalización. Los precios se asignan a uno u otro, no observar esto puede provocar efectos no deseados.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/categories/1/prices
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "prices": { "definition": { "id":numeric, "pId":string }, "fare": { "id":numeric, "pId":string }, "percentPrice":numeric, "percentPriceOverrideCustomPrices":boolean, "showBasePrice":boolean, "useRetailPrice":boolean } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| prices | Obligatorio | struct | |
| Bloque de información sobre los precios por categoría. | |||
| prices/definition | Opcional | struct | |
| Bloque con información sobre las personalizaciones. Las personalizaciones se basan en una vinculación a una definición, que son conjuntos de propiedades bajo un condicionante. La definición debe existir previamente. Si se espcifica indica que el descuento se aplica a una definición determinada. | |||
| prices/definition/id | Opcional | 0 | numeric |
| Identificador interno de la definición. Opcional en caso que se use identificador público. | |||
| prices/definition/pId | Opcional | string | |
| Identificador público de la definición. Opcional en caso que se use identificador interno. | |||
| prices/fare | Opcional | struct | |
| Bloque de definición de la tarifa. Debe existir previamente. Si se espcifica indica que el descuento se aplica a una tarifa determinada. | |||
| prices/fare/id | Opcional | 0 | numeric |
| Identificador interno de la tarifa. Opcional en caso que se use identificador público. | |||
| prices/fare/pId | Opcional | string | |
| Identificador público de la tarifa. Opcional en caso que se use identificador interno. | |||
| prices/percentPrice | Opcional | 0 | numeric |
| Indica el valor del porcentaje que se usará para calcular el precio final de un producto. Puede ser positivo (incremento) o negativo (descuento). | |||
| prices/percentPriceOverrideCustomPrices | Opcional | true | boolean |
| Indica sobre qué política de precios se debe aplicar el cálculo del porcentaje. Valores permitidos: true - Se ignoran personalizaciones o tarifas y el cáculo del porcentaje se realizará siempre sobre el precio base (tarifa base) del producto, false - El cálculo del porcentaje se realizará sobre el precio de la personalización o tarifa definida que corresponda. | |||
| prices/showBasePrice | Opcional | true | boolean |
| Indica que debe mostrarse el precio base con el valor existente antes de realizar el cálculo del precio a modo de precio anterior o 'tachado'. | |||
| prices/useRetailPrice | Opcional | true | boolean |
| Indica que el cálculo del porcentaje se realizará sobre el precio de oferta, si lo tuviera. Se debe tener en cuenta que si este parámetro es false, no se define o es true pero no existe oferta, el porcentaje se aplicará sobre el precio base. | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"PRICES": {
"DEFINITION": {
"ID" : 0
},
"FARE": {
"ID" : 5
},
"ID" : 3,
"PERCENTPRICE" : 99,
"PERCENTPRICEOVERRIDECUSTOMPRICES" : true,
"SHOWBASEPRICE" : true,
"USERETAILPRICE" : false
}
}
DELETE /categories/{id}/prices
Descripción
Elimina todas las definiciones de precios de la categoría indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/categories/1/prices
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"PRICES": [
]
}
GET /categories/{id}/products
Descripción
Devuelve la lista de productos de la categoría indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/categories/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,
"PID" :"abc",
"PRIORITY" : 1
}
]
}
POST /categories/{id}/products
Descripción
Vincula productos a la categoría indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/categories/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 categoría. | |||
| 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,
"PID" :"abc",
"PRIORITY" : 1
}
]
}
DELETE /categories/{id}/products
Descripción
Desvincula productos de la categoría indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/categories/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 /categories/{id}/products/{productId}
Descripción
Desvincula un producto determinado de la categoría indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/categories/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 /categories/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/categories/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
{
"ACTIVITYLIMITS": {
"ACTIVATIONDATE" :"2015-11-02",
"EXPIRATIONDATE" :"2015-11-20",
"ID" : 23535
}
}
PUT /categories/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/categories/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
{
"ACTIVITYLIMITS": {
"ACTIVATIONDATE" :"2015-11-02",
"EXPIRATIONDATE" :"2015-11-20",
"ID" : 23535
}
}
DELETE /categories/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/categories/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 /categories/categoryItems/{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/categories/categoryItems/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 /categories/categoryItems/{id}
Descripción
Elimina el filtro indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/categories/categoryItems/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 /categories/count
Descripción
Devuelve un valor que indica la cantidad de categorías.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/categories/count
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| areaId | Opcional | 0 | numeric |
| Devuelve las categorías contenidas en el área con el identificador interno indicado. | |||
| 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. | |||
| idList | Opcional | string | |
| Lista de los identificadores internos de categoría que han de ser devueltos. | |||
| parentId | Opcional | 0 | numeric |
| Devuelve las subcategorías contenidas en la categoría con el identificador interno indicado. | |||
| 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 /categories/getId/{pId}
Descripción
Devuelve el identificador interno de la categoría.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/categories/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
}
PUT /categories/prices/{id}
Descripción
Edición de la definición de precios indicada mediante identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/categories/prices/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "prices": { "percentPrice":numeric, "percentPriceOverrideCustomPrices":boolean, "showBasePrice":boolean, "useRetailPrice":boolean } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| prices | Obligatorio | struct | |
| Bloque de información sobre los precios por categoría. | |||
| prices/percentPrice | Opcional | 0 | numeric |
| Indica el valor del porcentaje que se usará para calcular el precio final de un producto. Puede ser positivo (incremento) o negativo (descuento). | |||
| prices/percentPriceOverrideCustomPrices | Opcional | false | boolean |
| Indica sobre qué política de precios se debe aplicar el cálculo del porcentaje. Valores permitidos: true - Se ignoran personalizaciones o tarifas y el cáculo del porcentaje se realizará siempre sobre el precio base (tarifa base) del producto, false - El cálculo del porcentaje se realizará sobre el precio de la personalización o tarifa definida que corresponda. | |||
| prices/showBasePrice | Opcional | true | boolean |
| Indica que debe mostrarse (o no) el precio base con el valor existente antes de realizar el cálculo del precio, a modo de precio anterior o 'tachado'. | |||
| prices/useRetailPrice | Opcional | true | boolean |
| Indica que el cálculo del porcentaje se realizará sobre el precio de oferta, si lo tuviera. Se debe tener en cuenta que si este parámetro es false, no se define o es true pero no existe oferta, el porcentaje se aplicará sobre el precio base. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"DEFINITION": {
"ID" : 0
},
"FARE": {
"ID" : 5
},
"ID" : 3,
"PERCENTPRICE" : 99,
"PERCENTPRICEOVERRIDECUSTOMPRICES" : true,
"SHOWBASEPRICE" : true,
"USERETAILPRICE" : false
}
DELETE /categories/prices/{id}
Descripción
Elimina la definición de precios indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/categories/prices/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" : 352144
}