Productos
Este endpoint permite gestionar la creación, modificación o borrado de productos de su eCommerce. Mediante los recursos de este módulo es posible integrar y crear productos de manera fácil y directa, además de dar de alta y gestionar opciones, etiquetas, elementos relacionados o imágenes de producto. También se dispone de recursos específicos para la gestión de precios y stock.
</> GET / productsDevuelve el listado de productos.
</> POST / productsCreación de un nuevo producto.
</> GET / products/{id}Devuelve la información del producto indicado mediante identificador interno.
</> PUT / products/{id}Edición del producto indicado mediante identificador interno.
</> DELETE / products/{id}Elimina el producto indicado mediante identificador interno.
</> GET / products/{id}/activityLimitsDevuelve la información de los periodos de actividad del producto indicado.
</> POST / products/{id}/activityLimitsCreación de un periodo de actividad para el producto indicado.
</> DELETE / products/{id}/activityLimitsElimina todos los periodos de actividad del producto indicado.
</> GET / products/{id}/additionalImagesDevuelve las imágenes adicionales del producto indicado.
</> POST / products/{id}/additionalImagesAsignación de una imagen adicional al producto indicado.
</> DELETE / products/{id}/additionalImagesDesasigna todas las imágenes adicionales del producto indicado.
</> GET / products/{id}/categoriesDevuelve las categorías vinculadas al producto indicado.
</> POST / products/{id}/categoriesVincula una categoría al producto indicado.
</> DELETE / products/{id}/categoriesDesvincula todas las categorías del producto indicado.
</> PUT / products/{id}/categories/{categoryId}Editar una vinculación a categoría determinada del producto indicado.
</> DELETE / products/{id}/categories/{categoryId}Desvincula una vinculación a categoría determinada del producto indicado.
</> GET / products/{id}/combinationsDevuelve información sobre las combinaciones de valores de opción del producto indicado.
</> POST / products/{id}/combinationsCreación de una combinación de valores de opción del producto indicado.
</> DELETE / products/{id}/combinationsElimina todas las combinaciones de valores de opción del producto indicado.
</> GET / products/{id}/customTagsDevuelve las etiquetas del producto indicado.
</> POST / products/{id}/customTagsVincula etiquetas al producto indicado.
</> DELETE / products/{id}/customTagsDesvincula etiquetas del producto indicado.
</> GET / products/{id}/customTags/{customTagId}Devuelve la información de una etiqueta determinada del producto indicado.
</> PUT / products/{id}/customTags/{customTagId}Edición de una etiqueta determinada del producto indicado.
</> DELETE / products/{id}/customTags/{customTagId}Desvincula una etiqueta determinada del producto indicado.
</> GET / products/{id}/definitionsDevuelve las personalizaciones del producto indicado.
</> POST / products/{id}/definitionsVincula una personalización al producto indicado.
</> DELETE / products/{id}/definitionsElimina todas las personalizaciones del producto indicado.
</> GET / products/{id}/definitions/{definitionId}Devuelve la información de una personalización determinada del producto indicado.
</> DELETE / products/{id}/definitions/{definitionId}Elimina una personalización determinada del producto indicado.
</> GET / products/{id}/definitions/{definitionId}/pricesDevuelve el precio de una personalización determinada del producto indicado.
</> POST / products/{id}/definitions/{definitionId}/pricesAsignación de precios a una personalización determinada del producto indicado.
</> DELETE / products/{id}/definitions/{definitionId}/pricesElimina el precio de una personalización determinada del producto indicado.
</> GET / products/{id}/definitions/{definitionId}/propertiesDevuelve las propiedades de una personalización determinada del producto indicado.
</> POST / products/{id}/definitions/{definitionId}/propertiesAsignación de propiedades a una personalización determinada del producto indicado.
</> PUT / products/{id}/definitions/{definitionId}/propertiesEdición de las propiedades de una personalización determinada del producto indicado.
</> DELETE / products/{id}/definitions/{definitionId}/propertiesElimina las propiedades de una personalización determinada del producto indicado.
</> PUT / products/{id}/hideDesactiva (oculta) el producto indicado.
</> GET / products/{id}/optionsDevuelve las opciones del producto indicado.
</> POST / products/{id}/optionsCreación de una opción para el producto indicado.
</> DELETE / products/{id}/optionsElimina todas las opciones del producto indicado.
</> GET / products/{id}/priceListsDevuelve todos los precios de tarifa del producto indicado.
</> DELETE / products/{id}/priceListsElimina todos los precios de tarifa del producto indicado.
</> GET / products/{id}/priceLists/{priceListId}/pricesDevuelve los precios de una tarifa determinada del producto indicado.
</> POST / products/{id}/priceLists/{priceListId}/pricesAsignación de precios a una tarifa determinada del producto indicado.
</> DELETE / products/{id}/priceLists/{priceListId}/pricesElimina los precios de una tarifa determinada del producto indicado.
</> GET / products/{id}/pricesDevuelve los precios del producto indicado.
</> POST / products/{id}/pricesAsignación de precios al producto indicado.
</> DELETE / products/{id}/pricesElimina los precios del producto indicado.
</> GET / products/{id}/relatedItemsDevuelve la información de los elementos relacionados del producto indicado.
</> POST / products/{id}/relatedItemsVincula elementos relacionados al producto indicado.
</> DELETE / products/{id}/relatedItemsElimina todos los elementos relacionados del producto indicado.
</> GET / products/{id}/shippingTypesObtiene las asignaciones de tipos de transporte para el producto indicado.
</> POST / products/{id}/shippingTypesAsignación de tipo de transporte para el producto indicado.
</> DELETE / products/{id}/shippingTypesElimina todas las asignaciones de tipos de transporte para el producto indicado.
</> DELETE / products/{id}/shippingTypes/{shippingTypeId}Elimina la asignación del tipos de transporte con el identificador indicado.
</> PUT / products/{id}/showActiva (hace visible) el producto indicado.
</> GET / products/{id}/stocksDevuelve el stock del producto indicado.
</> POST / products/{id}/stocksAsignación de stock al producto indicado.
</> DELETE / products/{id}/stocksElimina todo el stock del producto indicado.
</> GET / products/activityLimits/{id}Devuelve la información sobre el periodo de activitad indicado.
</> PUT / products/activityLimits/{id}Edición del periodo de actividad indicado.
</> DELETE / products/activityLimits/{id}Elimina el periodo de actividad indicado.
</> GET / products/additionalImages/{id}Devuelve la imagen adicional indicada.
</> PUT / products/additionalImages/{id}Edición de la imagen adicional indicada.
</> DELETE / products/additionalImages/{id}Desasigna la imagen adicional indicada.
</> GET / products/combinations/{id}Devuelve información sobre las combinaciones de valores de opción.
</> PUT / products/combinations/{id}Edición de la combinación de valores de opción indicada.
</> DELETE / products/combinations/{id}Elimina la combinación de valores de opción indicada.
</> GET / products/combinations/getId/{pId}Devuelve el identificador interno de la combinación de valores de opción.
</> GET / products/definitions/prices/{id}Devuelve la información del precio personalizado indicado.
</> PUT / products/definitions/prices/{id}Edición del precio personalizado indicado.
</> DELETE / products/definitions/prices/{id}Elimina el precio personalizado indicado.
</> GET / products/definitions/prices/{id}/currenciesDevuelve la lista de precios por moneda del precio (personalizado) indicado.
</> POST / products/definitions/prices/{id}/currenciesAsignación de precios por moneda al precio (personalizado) indicado.
</> DELETE / products/definitions/prices/{id}/currenciesElimina los precios por moneda del precio (personalizado) indicado.
</> GET / products/definitions/prices/currencies/{id}Devuelve el precio por moneda indicado.
</> PUT / products/definitions/prices/currencies/{id}Edita el precio por moneda indicado.
</> DELETE / products/definitions/prices/currencies/{id}Elimina el precio por moneda indicado.
</> GET / products/getId/{pId}Devuelve el identificador interno del producto.
</> GET / products/options/{id}Devuelve la opción (de producto) indicada.
</> PUT / products/options/{id}Edición de la opción (de producto) indicada.
</> DELETE / products/options/{id}Elimina la opción (de producto) indicada.
</> GET / products/options/{id}/valuesDevuelve los valores de la opción indicada.
</> POST / products/options/{id}/valuesCreación de un valor para la opción indicada.
</> DELETE / products/options/{id}/valuesElimina todos los valores de la opción indicada.
</> GET / products/options/getId/{pId}Devuelve el identificador interno de la opción de producto.
</> GET / products/options/values/{id}Devuelve el valor (de opción) indicado.
</> PUT / products/options/values/{id}Edición del valor (de opción) indicado.
</> DELETE / products/options/values/{id}Elimina el valor (de opción) indicado.
</> GET / products/options/values/{id}/pricesDevuelve los precios para el valor de opción indicado.
</> POST / products/options/values/{id}/pricesAsignación de precios al valor de opción indicado.
</> DELETE / products/options/values/{id}/pricesElimina todos los precios para el valor de opción indicado.
</> GET / products/options/values/getId/{pId}Devuelve el identificador interno del valor de opción de producto.
</> GET / products/options/values/prices/{id}Devuelve la información del precio (del valor de opción) indicado.
</> PUT / products/options/values/prices/{id}Edición del precio (del valor de opción) indicado.
</> DELETE / products/options/values/prices/{id}Elimina el precio (del valor de opción) indicado.
</> GET / products/options/values/prices/{id}/currenciesDevuelve la lista de precios por moneda del precio (del valor de opción) indicado.
</> POST / products/options/values/prices/{id}/currenciesAsignación de precios por moneda al precio (del valor de opción) indicado.
</> DELETE / products/options/values/prices/{id}/currenciesElimina los precios por moneda del precio (del valor de opción) indicado.
</> GET / products/options/values/prices/currencies/{id}Devuelve el precio por moneda indicado.
</> PUT / products/options/values/prices/currencies/{id}Edita el precio por moneda indicado.
</> DELETE / products/options/values/prices/currencies/{id}Elimina el precio por moneda indicado.
</> GET / products/priceLists/prices/{id}Devuelve el precio (de tarifa) indicado.
</> PUT / products/priceLists/prices/{id}Edición del precio (de tarifa) indicado.
</> DELETE / products/priceLists/prices/{id}Elimina el precio (de tarifa) indicado.
</> GET / products/priceLists/prices/{id}/currenciesDevuelve la lista de precios por moneda del precio (de tarifa) indicado.
</> POST / products/priceLists/prices/{id}/currenciesAsignación de precios por moneda al precio (de tarifa) indicado.
</> DELETE / products/priceLists/prices/{id}/currenciesElimina los precios por moneda del precio (de tarifa) indicado.
</> GET / products/priceLists/prices/currencies/{id}Devuelve el precio por moneda indicado.
</> PUT / products/priceLists/prices/currencies/{id}Edita el precio por moneda indicado.
</> DELETE / products/priceLists/prices/currencies/{id}Elimina el precio por moneda indicado.
</> PUT / products/pricesEdición masiva de precios
</> GET / products/prices/{id}Devuelve la información del precio (de producto) indicado.
</> PUT / products/prices/{id}Edición del precio (de producto) indicado.
</> DELETE / products/prices/{id}Elimina el precio (de producto) indicado.
</> GET / products/prices/{id}/currenciesDevuelve la lista de precios por moneda del precio (del valor de opción) indicado.
</> POST / products/prices/{id}/currenciesAsignación de precios por moneda al precio (del valor de opción) indicado.
</> DELETE / products/prices/{id}/currenciesElimina los precios por moneda del precio (del valor de opción) indicado.
</> GET / products/prices/currencies/{id}Devuelve el precio por moneda indicado.
</> PUT / products/prices/currencies/{id}Edita el precio por moneda indicado.
</> DELETE / products/prices/currencies/{id}Elimina el precio por moneda indicado.
</> GET / products/relatedItems/{id}Devuelve la información del elemento relacionado indicado.
</> DELETE / products/relatedItems/{id}Elimina el elemento relacionado indicado.
</> GET / products/stock/getId/{pId}/{warehousePId}Devuelve el identificador interno de la línea de stock por almacén.
</> PUT / products/stocksEdición masiva de stocks
</> GET / products/stocks/{id}Devuelve la línea de stock indicada.
</> PUT / products/stocks/{id}Edición de la línea de stock indicada.
</> DELETE / products/stocks/{id}Elimina la línea de stock indicada.
</> GET / products/stocks/{id}/previsionDevuelve el stock por provisión de la línea de stock indicada.
</> POST / products/stocks/{id}/previsionAsignación de stock por provisión a la línea de stock indicada.
</> DELETE / products/stocks/{id}/previsionElimina el stock por provisión de la línea de stock indicada.
</> GET / products/stocks/prevision/{id}Devuelve la línea de stock por provisión indicada.
</> PUT / products/stocks/prevision/{id}Edición de la línea de stock por provisión indicada.
</> DELETE / products/stocks/prevision/{id}Elimina la línea de stock por provisión indicada.
GET /products
Descripción
Devuelve el listado de productos. 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/products
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
brandId | Opcional | 0 | numeric |
Devuelve los productos de la marca indicada. | |||
brandsList | Opcional | string | |
Lista de identificadores internos de marca. Devuelve los productos que contenidos en las marcas indicadas. | |||
categoriesList | Opcional | string | |
Lista de identificadores internos de categoría. Devuelve los productos que contenidos en las categorías indicadas. | |||
categoryId | Opcional | 0 | numeric |
Devuelve los productos de la categoría indicada con identificador interno. El valor 0 muestra productos no asignados a ninguna categoría. | |||
fields | Opcional | string | |
Lista de campos a devolver. | |||
idList | Opcional | string | |
Lista de los identificadores internos de productos 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
{
"CURSORS": {
"NEXT" :"http://api.logicommerce.net/v1/products?page=2&perPage=100",
"PREVIOUS" :""
},
"ITEMS" : 1000,
"PAGERPARAMETERS": {
"PAGE" : 1,
"PERPAGE" : 100
},
"PRODUCTS": [
{
"ACTIVITYLIMITS": [
{
"ACTIVATIONDATE" :"2015-11-02",
"EXPIRATIONDATE" :"2015-11-20",
"ID" : 23535
}
],
"ADDITIONALIMAGES": [
{
"ID" : 375356,
"LANGUAGES": [
{
"ALT" :"Image 1",
"LANGUAGE" :"ES"
}
],
"LARGEIMAGE" :"large.jpg",
"PRIORITY" : 1,
"SMALLIMAGE" :"small.jpg"
}
],
"BRAND": {
"ID" : 1,
"PID" :"abc"
},
"CATEGORIES": [
{
"ID" : 464,
"MAINCATEGORY" : true,
"PID" :"abc",
"PRICECATEGORY" : false,
"PRIORITY" : 1
}
],
"COMBINATIONS": [
{
"EAN" :"ssss",
"ID" : 16534,
"ISBN" :"sdgddfkjs",
"JAN" :"stets",
"OPTIONSVALUES": [
{
"ID" : 1,
"PID" :"abc"
},
{
"ID" : 2,
"PID" :"cdf"
}
],
"PID" :"aas",
"SKU" :"sssddd",
"UPC" :"sasdasss"
}
],
"CUSTOMTAGS": {
"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"
}
}
]
}
]
},
"DEFINITIONS": [
{
"DEFINITION": {
"id" : 1,
"pId" :"abvc"
},
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 426,
"ID" : 843,
"OPTIONVALUE": {
"ID" : 1657,
"PID" :""
},
"RETAILPRICE" : 12
}
],
"PROPERTIES": {
"AVAILABILITY": {
"ID" : 0,
"PID" :""
},
"AVAILABLEDATE" :"2014-04-08T02:00:00+02:00",
"BACKORDER" : 1,
"COSTPRICE" : 0,
"DISPLAY" : true,
"ENDHIGHLIGHTDATE" :"2014-04-08T02:00:00+02:00",
"ENDOFFERDATE" :"",
"GROUPQUANTITYBYOPTIONS" : false,
"HIGHLIGHT" : false,
"MAXORDERQUANTITY" : 0,
"MINORDERQUANTITY" : 0,
"MULTIPLEACTSOVER" : 0,
"MULTIPLEORDERQUANTITY" : 0,
"NORETURN" : false,
"ONREQUEST" : true,
"ONREQUESTDAYS" : 3,
"PRIORITY" : 0,
"SALE" : true,
"SHOWDISCOUNTS" : true,
"SHOWORDERBOX" : true,
"SHOWPRICE" : true,
"STARTOFFERDATE" :"",
"STOCKMANAGEMENT" : true
}
}
],
"EAN" :"Code EAN",
"ID" :"1",
"ISBN" :"CODE ISBN",
"JAN" :"CODE JAN",
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"LARGETITLEIMAGE" :"",
"LONGDESCRIPTION" :"",
"NAME" :"",
"SHORTDESCRIPTION" :"",
"SMALLTITLEIMAGE" :""
}
],
"MAINCATEGORY": {
"ID" : 123,
"PID" :"abc"
},
"MAINIMAGE": {
"LARGEIMAGE" :"",
"MEDIUMIMAGE" :"",
"SMALLIMAGE" :""
},
"MANUFACTURERSKU" :"4E6HTRF",
"OPTIONS": [
{
"ACTIVE" : true,
"COMBINABLE" : false,
"FILTERABLE" : true,
"ID" : 14789,
"IMAGE" :"",
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"NAME" :"",
"PROMPT" :""
}
],
"MAXVALUES" :null,
"MINVALUES" :null,
"PID" :"color",
"PRIORITY" : 3,
"REQUIRED" : true,
"SHOWASGRID" : false,
"TYPOLOGY" : 1,
"UNIQUEPRICE" : true,
"VALUES": [
{
"ACTIVE" : true,
"ID" : 1,
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"LONGDESCRIPTION" :"Size XL long description",
"SEARCHVALUE" :"XL",
"SHORTDESCRIPTION" :"Size XL short description",
"VALUE" :"XL"
}
],
"LARGEIMAGE" :"b.jpg",
"PID" :"abc",
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 2,
"ID" : 843,
"RETAILPRICE" : 12
}
],
"PRIORITY" : 1,
"SKU" :"sku",
"SMALLIMAGE" :"a.jpg",
"WEIGHT" : 6
}
],
"VALUETYPE" : 1
}
],
"PID" :"abc",
"PRICECATEGORY": {
"ID" : 123,
"PID" :"abc"
},
"PRICELISTS": [
{
"PRICELIST": {
"ID" : 123,
"PID" :"abc"
},
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 426,
"ID" : 843,
"OPTIONVALUE": {
"ID" : 1657,
"PID" :""
},
"RETAILPRICE" : 12
}
]
}
],
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 426,
"ID" : 843,
"OPTIONVALUE": {
"ID" : 1657,
"PID" :""
},
"RETAILPRICE" : 12
}
],
"PROPERTIES": {
"ACTIVE" : true,
"AVAILABILITY": {
"ID" : 1,
"PID" :"abc"
},
"AVAILABLEDATE" :"",
"BACKORDER" : 0,
"COSTPRICE" : 0,
"ENDHIGHLIGHTDATE" :"2021-10-21T20:25:51+02:00",
"ENDOFFERDATE" :"",
"GROUPQUANTITYBYOPTIONS" : false,
"HIGHLIGHT" : false,
"MAXORDERQUANTITY" : 0,
"MINORDERQUANTITY" : 0,
"MULTIPLEACTSOVER" : 0,
"MULTIPLEORDERQUANTITY" : 0,
"NORETURN" : false,
"ONREQUEST" : false,
"ONREQUESTDAYS" : 0,
"PERCENTPRICE" :null,
"PERCENTPRICEOVERRIDECUSTOMPRICES" : false,
"PRIORITY" : 0,
"SALE" : false,
"SHOWBASEPRICE" : false,
"SHOWDISCOUNTS" : true,
"SHOWORDERBOX" : true,
"SHOWPRICE" : true,
"STARTOFFERDATE" :"",
"STOCKMANAGEMENT" : true,
"USERRETAILPRICE" : false
},
"RELATEDITEMS": [
{
"ID" : 2,
"ITEMS": {
"BANNERS": [
],
"BLOGPOST": [
],
"CATEGORIES": [
],
"NEWS": [
],
"PAGES": [
],
"PRODUCTS": [
{
"ID" : 43567,
"ITEM": {
"ID" : 13,
"pId" :"abc"
}
}
]
},
"NAME" :"Related Definition 1",
"PID" :"abc"
}
],
"REVERSECHARGEVAT" : true,
"SALEUNIT" : 1,
"SEO": {
"LANGUAGES": [
{
"ALTIMAGEKEYWORDS" :"",
"COREKEYWORD" :"",
"KEYWORDS" :"",
"LANGUAGE" :"ES",
"METADESCRIPTION" :"",
"PARTICULARTITLE" :"",
"URLSEO" :""
}
]
},
"SHIPPING" : true,
"SHIPPINGTYPES": [
{
"ID" : 123,
"PID" :"ShippingType1"
}
],
"SKU" :"124TG67",
"STOCKS": [
{
"BACKORDERPREVISION": [
{
"ID" : 134646,
"INCOMINGDATE" :"2015-04-03",
"PID" :"sdfsdf",
"STOCK" : 230
}
],
"COMBINATION": {
"PID" :"combination M"
},
"ID" : 16534,
"PREVISION": [
{
"ID" : 134646,
"INCOMINGDATE" :"2015-04-03",
"PID" :"sdfsdf",
"STOCK" : 230
}
],
"STOCK" : 555,
"WAREHOUSE": {
"ID" : 1,
"PID" :"abc"
}
}
],
"SUPPLIER": {
"ID" : 1,
"PID" :"abc"
},
"TAXDEFINITION": {
"ID" : 1,
"PID" :"abc"
},
"TEMPLATEID" : 1,
"UPC" :"CODE UPC",
"WEIGHT" : 36
}
]
}
POST /products
Descripción
Creación de un nuevo producto. Permite definir todas sus características, propiedades y precios (más información de los distintos bloques de precios en los recursos POST / products/{id}/priceLists/{priceListId}/prices, POST / products/{id}/definitions/{definitionId}/prices y POST / products/{id}/prices).
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products
Parámetros de entrada JSON
{ "products": { "activityLimits": [ { "activationDate": datetime "expirationDate": datetime } ], "additionalImages": [ { "languages": [ { "languageCode":string, "alt": string } ], "largeImage":string, "smallImage":string, "priority": numeric } ], "brand": { "id":numeric, "pId":string }, "categories": [ { "id":numeric, "mainCategory":boolean, "pId":string, "priceCategory":boolean, "priority": numeric } ], "combinations": [ { "ean":string, "isbn":string, "jan":string, "optionsValues": [ { "id":numeric, "pId":string } ], "pId":string, "sku":string, "upc":string } ], "customTags": [ { "customTag": { "id":numeric, "pId":string }, "general": { "active":boolean, "value":string }, "group": { "id":numeric, "pId":string }, "languages": [ { "active":boolean, "languageCode":string, "value":string } ], "selectable": { "active":boolean, "value": { "id":numeric, "pId":string } } } ], "definitions": [ { "definition": { "id":numeric, "pId":string }, "prices": [ { "currencies": [ { "currencyCode":currency, "retailPrice":numeric, "basePrice": numeric } ], "fromQuantity":numeric, "optionValue": { "id":numeric, "pId":string }, "basePrice": numeric "retailPrice": numeric } ], "properties": { "availability": { "id":numeric, "pId":string }, "backOrder":any, "active": boolean "availableDate": datetime "costPrice": numeric "endHighlightDate": datetime "endOfferDate": datetime "exclusiveLinked": boolean "groupQuantityByOptions": boolean "highlight": boolean "maxOrderQuantity": numeric "minOrderQuantity": numeric "multipleActsOver": numeric "multipleOrderQuantity": numeric "noReturn": boolean "onRequest": boolean "onRequestDays": numeric "percentPrice": numeric "percentPriceOverrideCustomPrices": boolean "priority": numeric "publicationDate": datetime "sale": boolean "showBasePrice": boolean "showDiscounts": boolean "showOrderBox": boolean "showPrice": boolean "startOfferDate": datetime "stockManagement": boolean "useRetailPrice": boolean } } ], "languages": [ { "languageCode":string, "name":string, "indexable": boolean "largeTitleImage": string "linkFollowing": boolean "longDescription": string "shortDescription": string "smallTitleImage": string } ], "mainImages": { "largeImage":string, "mediumImage":string, "smallImage":string }, "options": [ { "combinable":boolean, "languages": [ { "languageCode":string, "name":string, "prompt": string } ], "maxValues":numeric, "minValues":numeric, "pId":string, "showAsGrid":boolean, "showPrice":, "typology":numeric, "valueType":numeric, "values": [ { "languages": [ { "languageCode":string, "value":string, "longDescription": string "searchValue": string "shortDescription": string } ], "noReturn":boolean, "pId":string, "prices": [ { "basePrice":numeric, "currencies": [ { "currencyCode":currency, "retailPrice":numeric, "basePrice": numeric } ], "fromQuantity":numeric, "retailPrice": numeric } ], "weight":numeric, "active": boolean "largeImage": string "priority": numeric "smallImage": string } ], "active": boolean "filterable": boolean "image": string "priority": numeric "required": boolean "uniquePrice": boolean } ], "pId":string, "priceLists": [ { "priceList": { "id":numeric, "pId":string }, "prices": [ { "basePrice":numeric, "currencies": [ { "currencyCode":currency, "retailPrice":numeric, "basePrice": numeric } ], "fromQuantity":numeric, "optionValue": { "id":numeric, "pId":string }, "retailPrice": numeric } ] } ], "prices": [ { "currencies": [ { "currencyCode":currency, "retailPrice":numeric, "basePrice": numeric } ], "fromQuantity":numeric, "basePrice": numeric "retailPrice": numeric } ], "properties": { "active":boolean, "availability": { "id":numeric, "pId":string }, "backOrder":any, "availableDate": datetime "costPrice": numeric "endHighlightDate": datetime "endOfferDate": datetime "exclusiveLinked": boolean "groupQuantityByOptions": boolean "highlight": boolean "maxOrderQuantity": numeric "minOrderQuantity": numeric "multipleActsOver": numeric "multipleOrderQuantity": numeric "noReturn": boolean "onRequest": boolean "onRequestDays": numeric "percentPrice": numeric "percentPriceOverrideCustomPrices": boolean "priority": numeric "publicationDate": datetime "sale": boolean "showBasePrice": boolean "showDiscounts": boolean "showOrderBox": boolean "showPrice": boolean "startOfferDate": datetime "stockManagement": boolean "useRetailPrice": boolean }, "relatedItems": [ { "item": { "id":numeric, "pId":string }, "priority":numeric, "relatedDefinition": { "id":numeric, "pId":string }, "type":numeric } ], "seo": { "languages": [ { "altImagekeywords":string, "coreKeyword":string, "keywords":string, "languageCode":string, "metaDescription":string, "particularTitle":string, "urlSeo":string } ] }, "shippingTypes": [ { "id":, "pId":string } ], "stocks": [ { "combination": { "pId":string }, "pId":string, "prevision": [ { "incomingDate":date, "pId":string, "previsionType":numeric, "stock": numeric } ], "stock":numeric, "warehouse": { "id":, "pId":string } } ], "supplier": { "id":numeric, "pId":string }, "tax": { "id":numeric, "pId":string }, "ean": string "includeInShippingRangePrice": boolean "isbn": string "jan": string "manufacturerSku": string "minOrderQuantity": numeric "reverseChargeVat": boolean "saleUnit": numeric "shipping": boolean "sku": string "templateId": string "typeShippingCalculation": numeric "upc": string "weight": numeric } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
products | Obligatorio | struct | |
Contiene la definición de un producto. | |||
products/activityLimits | Opcional | array [0:n] | |
Bloque con información sobre los periodos de actividad. | |||
products/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). | |||
products/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). | |||
products/additionalImages | Opcional | array [0:n] | |
Bloque con información de las imágenes adicionales del producto. | |||
products/additionalImages/languages | Opcional | array [0:n] | |
Bloque con información variable según el idioma. | |||
products/additionalImages/languages/alt | Opcional | string | |
Palabras clave de las imágenes adicionales del producto para el idioma seleccionado. Separadas por coma ','. | |||
products/additionalImages/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. | |||
products/additionalImages/largeImage | Obligatorio | string | |
Información de la imagen adicional del producto en su versión grande. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
products/additionalImages/priority | Opcional | numeric | |
Define el orden de presentación de esta imagen adicional en relación al resto de adicionales que se encuentran en su mismo nivel. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
products/additionalImages/smallImage | Obligatorio | string | |
Información de la imagen adicional del producto en su versión pequeña. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
products/brand | Opcional | struct | |
Bloque de información sobre la marca del producto. | |||
products/brand/id | Opcional | 0 | numeric |
Identificador interno de la marca. Opcional en caso que se use identificador público. | |||
products/brand/pId | Opcional | string | |
Identificador público de la marca. Opcional en caso que se use identificador interno. | |||
products/categories | Opcional | array [0:n] | |
Bloque con las categorías a las que pertenece el producto. | |||
products/categories/id | Opcional | 0 | numeric |
Identificador interno de la categoría. Opcional en caso que se use identificador público. | |||
products/categories/mainCategory | Obligatorio | boolean | |
Define si es la categoría principal del producto. Sólo puede haber una categoría principal para un producto. | |||
products/categories/pId | Opcional | string | |
Identificador público de la categoría. Opcional en caso que se use identificador interno. | |||
products/categories/priceCategory | Opcional | false | boolean |
Define si es la categoría de la que debe tomar el porcentaje a aplicar sobre los precios del producto. Sólo puede haber una categoría de precios para un producto. No es necesario si el eCommerce no tiene activado Precios por categoría. | |||
products/categories/priority | Opcional | 0 | numeric |
Define el orden de presentación del producto cuando se visualiza dentro de esta categoría en relación al resto de productos que se encuentran en su mismo nivel. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
products/combinations | Opcional | array [0:n] | |
Bloque de información sobre las combinaciones de valores de opción que puede tener un producto. Solo estas combinaciones podrán asociarse a stock. | |||
products/combinations/ean | Opcional | string | |
Número de artículo europeo (EAN), también llamado GTIN-13. | |||
products/combinations/isbn | Opcional | string | |
Número internacional normalizado del libro (ISBN). | |||
products/combinations/jan | Opcional | string | |
Número de artículo japonés (JAN), también llamado GTIN-13. | |||
products/combinations/optionsValues | Opcional | array [0:n] | |
Bloque de información sobre la combinación de los valores de opción. Define las opciones que intervienen en la combinación. Solo es necesario para los valores de opción que tengan combinable=true. | |||
products/combinations/optionsValues/id | Opcional | 0 | numeric |
Identificador interno del valor de opción. Opcional en caso que se use identificador público. | |||
products/combinations/optionsValues/pId | Opcional | string | |
Identificador público del valor de opción. Opcional en caso que se use identificador interno. | |||
products/combinations/pId | Obligatorio | string | |
Identificador público de la combinación. Este ID se usa también como identificador público de la línea de stock que contiene el número de unidades disponibles (stock) para esa combinación. | |||
products/combinations/sku | Opcional | string | |
Define una referencia para la combinación de valores de opción. | |||
products/combinations/upc | Opcional | string | |
Código de producto universal (UPC), también llamado GTIN-12 y UPC-A. | |||
products/customTags | Opcional | array [0:n] | |
Bloque para manipular los valores de las etiquetas de tipo producto, para este producto en concreto. | |||
products/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. | |||
products/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. | |||
products/customTags/customTag/pId | Opcional | string | |
Indica el identificador público de la etiqueta. Debe existir previamente. Opcional en caso que se use identificador interno. | |||
products/customTags/general | Opcional | struct | |
Bloque para etiquetas cuyos valores no dependen del idioma | |||
products/customTags/general/active | Opcional | true | boolean |
Define la visibilidad de la etiqueta. | |||
products/customTags/general/value | Opcional | string | |
Define el valor de la etiqueta. | |||
products/customTags/group | Opcional | struct | |
Bloque para informar del grupo de etiquetas en caso que la etiqueta pertenezca a más de uno. | |||
products/customTags/group/id | Opcional | 0 | numeric |
Identificador interno del grupo de etiquetas. Opcional en caso que se use identificador público. | |||
products/customTags/group/pId | Opcional | string | |
Identificador público del grupo de etiquetas. Opcional en caso que se use identificador interno. | |||
products/customTags/languages | Opcional | array [0:n] | |
Bloque para etiquetas cuyos valores dependen del idioma. | |||
products/customTags/languages/active | Opcional | true | boolean |
Define la visibilidad de la etiqueta. | |||
products/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. | |||
products/customTags/languages/value | Opcional | string | |
Define el valor de la etiqueta. | |||
products/customTags/selectable | Opcional | struct | |
Bloque para etiquetas cuyos valores estan predefinidos a modo de selector desplegable. | |||
products/customTags/selectable/active | Opcional | true | boolean |
Define la visibilidad de la etiqueta. | |||
products/customTags/selectable/value | Opcional | struct | |
Bloque para identificar la opción del desplegable. | |||
products/customTags/selectable/value/id | Opcional | 0 | numeric |
Identificador interno del valor que se quiere asignar. Opcional en caso que se use identificador público. | |||
products/customTags/selectable/value/pId | Opcional | string | |
Identificador público del valor que se quiere asignar. Opcional en caso que se use identificador interno. | |||
products/definitions | Opcional | array [0:n] | |
Bloque con información sobre las personalizaciones del producto. 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. | |||
products/definitions/definition | Obligatorio | struct | |
Bloque para especificar una determinada definición. | |||
products/definitions/definition/id | Opcional | 0 | numeric |
Identificador interno de la definición. Opcional en caso que se use identificador público. | |||
products/definitions/definition/pId | Opcional | string | |
Identificador público de la definición. Opcional en caso que se use identificador interno. | |||
products/definitions/prices | Opcional | array [0:n] | |
Bloque con información de los precios del producto para la personalización. | |||
products/definitions/prices/basePrice | Obligatorio | numeric | |
Precio del producto. El precio se especifica sin impuestos añadidos. | |||
products/definitions/prices/currencies | Opcional | array [0:n] | |
Bloque con información de los precios del producto en monedas adicionales vinculadas al eCommerce. | |||
products/definitions/prices/currencies/basePrice | Obligatorio | numeric | |
Precio del producto. El precio se especifica sin impuestos añadidos. | |||
products/definitions/prices/currencies/currencyCode | Obligatorio | currency | |
Código de la moneda en formato ISO 4217. | |||
products/definitions/prices/currencies/retailPrice | Opcional | numeric | |
Precio del producto cuando está en oferta. El precio se especifica sin impuestos añadidos. | |||
products/definitions/prices/fromQuantity | Opcional | 1 | numeric |
Cuando se define, indica que el bloque de precios es por cantidad (de unidades compradas). Indica la cantidad del intervalo a partir de la cual se aplican los nuevos precios. Debe ser superior a 1 y a la cantidad del intervalo anterior. No es necesario si el eCommerce no tiene activado Precios por cantidad. | |||
products/definitions/prices/optionValue | Opcional | struct | |
Bloque de información del valor de una opción. Define si el bloque de precios es para un valor de opción. | |||
products/definitions/prices/optionValue/id | Opcional | 0 | numeric |
Identificador interno del valor de opción. Opcional en caso que se use identificador público. | |||
products/definitions/prices/optionValue/pId | Opcional | string | |
Identificador público del valor de opción. Opcional en caso que se use identificador interno. | |||
products/definitions/prices/retailPrice | Opcional | numeric | |
Precio del producto cuando está en oferta. El precio se especifica sin impuestos añadidos. | |||
products/definitions/properties | Opcional | struct | |
Bloque con las propiedades de la personalización del producto. | |||
products/definitions/properties/active | Opcional | true | boolean |
Define si el producto es visible. | |||
products/definitions/properties/availability | Opcional | struct | |
Bloque de información sobre disponibilidad de productos. | |||
products/definitions/properties/availability/id | Opcional | 0 | numeric |
Identificador interno de la disponibilidad de productos. Opcional en caso que se use identificador público. | |||
products/definitions/properties/availability/pId | Opcional | string | |
Identificador público de la disponibilidad de productos. Opcional en caso que se use identificador interno. | |||
products/definitions/properties/availableDate | Opcional | CURRENT_TIMESTAMP | datetime |
Fecha a partir de la cual está disponible el producto. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
products/definitions/properties/backOrder | Opcional | any | |
Indica si se permite realizar reservas del producto, o sea, comprar cuando no se tiene stock y el control de stock está activo. Valores permitidos: 0 - Reservas deshabilitadas, 1 - Reservas permitidas siempre, 2* - Reservas permitidas con previsión, 3* - Reservas permitidas sin previsión (* Estos valores necesitan tener contratadas las previsiones de reserva para poder utilizarse) | |||
products/definitions/properties/costPrice | Opcional | 0 | numeric |
Indica el precio de coste del producto. Su uso es solo a nivel informativo. | |||
products/definitions/properties/endHighlightDate | Opcional | datetime | |
Fecha de fin de novedad. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
products/definitions/properties/endOfferDate | Opcional | datetime | |
Fecha de fin de oferta. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
products/definitions/properties/exclusiveLinked | Opcional | false | boolean |
products/definitions/properties/groupQuantityByOptions | Opcional | false | boolean |
Define si para el control de cantidades de compra del producto se suman las cantidades de todas las opciones compradas o si se cuentan por separado. | |||
products/definitions/properties/highlight | Opcional | false | boolean |
Indica si el producto es una novedad. | |||
products/definitions/properties/maxOrderQuantity | Opcional | 0 | numeric |
Define la cantidad máxima que se puede comprar del producto en un mismo pedido. 0 para ignorar. | |||
products/definitions/properties/minOrderQuantity | Opcional | 0 | numeric |
Define la cantidad mínima que se debe comprar del producto en un mismo pedido. 0 para ignorar. | |||
products/definitions/properties/multipleActsOver | Opcional | 0 | numeric |
Define el número de unidades a partir del cual los múltiples de compra actuarán. 0 para ignorar. | |||
products/definitions/properties/multipleOrderQuantity | Opcional | 0 | numeric |
Define el múltiplo de unidades del producto al comprar. 0 para ignorar. | |||
products/definitions/properties/noReturn | Opcional | false | boolean |
Indica si se prohibe la devolución. Valores permitidos: false - No prohibir, true - Prohibir | |||
products/definitions/properties/onRequest | Opcional | false | boolean |
Indica si el producto es de tipo 'bajo demanda'. Un producto de este tipo puede ser comprado aunque se tenga la gestión de stock activa y de él no quede stock suficiente. En tal caso se considerará que el producto ha sido comprado 'bajo demanda' para aquellas unidades para las que no haya stock suficiente. Una condición adicional para que un producto de este tipo pueda ser comprado 'bajo demana' es que tenga al menos una línea de stock configurada. Si esta característica se activa, será desactivará automáticamente la característica de 'reserva' del producto. | |||
products/definitions/properties/onRequestDays | Opcional | 0 | numeric |
Indica cuantos días se necesitan para preparar el producto en el caso que éste sea comprado 'bajo demanda'. Esta información se utiliza para mostrar una fecha estimada de salida en este caso. | |||
products/definitions/properties/percentPrice | Opcional | numeric | |
Indica el valor del porcentaje que se usará para calcular el precio final de un producto. Puede ser positivo (incremento) o negativo (descuento). | |||
products/definitions/properties/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. | |||
products/definitions/properties/priority | Obligatorio | numeric | |
Define el orden de presentación del producto en relación al resto de productos que se encuentran en su mismo nivel. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
products/definitions/properties/publicationDate | Opcional | CURRENT_TIMESTAMP | datetime |
Fecha de publicación del producto. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
products/definitions/properties/sale | Opcional | false | boolean |
Indica si el producto está en oferta. | |||
products/definitions/properties/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'. | |||
products/definitions/properties/showDiscounts | Opcional | true | boolean |
Indica si se muestran los posibles descuentos que pueden afectar al producto. | |||
products/definitions/properties/showOrderBox | Opcional | true | boolean |
Indica si se muestra el input para introducir la cantidad de unidades a comprar. | |||
products/definitions/properties/showPrice | Opcional | true | boolean |
Indica si se muestra el precio del producto. | |||
products/definitions/properties/startOfferDate | Opcional | datetime | |
Fecha de inicio de oferta. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
products/definitions/properties/stockManagement | Opcional | true | boolean |
Define si el producto mantiene y controla la cantidad de stock. Aunque se active el control de stock mediante esta propiedad, si la configuración general no lo tiene activado, el control no se tendrá en cuenta. | |||
products/definitions/properties/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. | |||
products/ean | Opcional | string | |
Número de artículo europeo (EAN), también llamado GTIN-13. | |||
products/includeInShippingRangePrice | Opcional | true | boolean |
Indica el producto se tiene en cuenta (contribuye) en el cálculo del transporte por rango de precio. | |||
products/isbn | Opcional | string | |
Número internacional normalizado del libro (ISBN). | |||
products/jan | Opcional | string | |
Número de artículo japonés (JAN), también llamado GTIN-13. | |||
products/languages | Obligatorio | array [1:n] | |
Bloque con información variable según el idioma. | |||
products/languages/indexable | Opcional | true | boolean |
Booleano que indica si se debe o no indexar el producto. | |||
products/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. | |||
products/languages/largeTitleImage | Opcional | string | |
Define la imagen de titulo grande del producto para el idioma seleccionado. Se debe indicar la ruta (relativa si es propia) de la imagen. No incluya esta etiqueta a no ser que se lo pidan desde Trilogi. | |||
products/languages/linkFollowing | Opcional | true | boolean |
Booleano que indica si se debe seguir o no los enlaces de esta página. | |||
products/languages/longDescription | Opcional | string | |
Define la descripción larga del producto para el idioma seleccionado. | |||
products/languages/name | Obligatorio | string | |
Define el nombre del producto para el idioma seleccionado. | |||
products/languages/shortDescription | Opcional | string | |
Define la descripción corta del producto para el idioma seleccionado. | |||
products/languages/smallTitleImage | Opcional | string | |
Define la imagen de titulo pequeña del producto para el idioma seleccionado. Se debe indicar la ruta (relativa si es propia) de la imagen. No incluya esta etiqueta a no ser que se lo pidan desde Trilogi. | |||
products/mainImages | Opcional | struct | |
Bloque con información de la imagen principal del producto. | |||
products/mainImages/largeImage | Opcional | string | |
Información de la imagen principal del producto en su versión grande. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
products/mainImages/mediumImage | Opcional | string | |
Información de la imagen principal del producto en su versión mediana. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
products/mainImages/smallImage | Opcional | string | |
Información de la imagen principal del producto en su versión pequeña. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
products/manufacturerSku | Opcional | string | |
Referencia del producto según el fabricante. | |||
products/minOrderQuantity | Opcional | numeric | |
Define la cantidad mínima que se debe comprar del producto en un mismo pedido. 0 para ignorar. | |||
products/options | Opcional | array [0:n] | |
En este bloque podemos definir las opciones del producto. Las opciones son variaciones del producto, como talla o color. | |||
products/options/active | Opcional | true | boolean |
Define si la opción esta activada. | |||
products/options/combinable | Opcional | true | boolean |
Indica si los valores de esta opción se usarán para generar combinaciones de opciones. Importante: es necesario pasar este parámetro con valor true si se necesita añadir stock por combinaciones de valores de opción. | |||
products/options/filterable | Opcional | false | boolean |
Indica si la opción permite que sus valores sean filtrables en la tienda. | |||
products/options/image | Opcional | string | |
Define una imagen específica para la opción. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
products/options/languages | Obligatorio | array [1:n] | |
Bloque con información variable según el idioma. | |||
products/options/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. | |||
products/options/languages/name | Obligatorio | string | |
Define el nombre de la opción para el idioma seleccionado. | |||
products/options/languages/prompt | Opcional | string | |
Define el título de la opción para el idioma seleccionado. Texto que aparece junto al selector de valores. | |||
products/options/maxValues | Opcional | 0 | numeric |
Número de ficheros adjuntos que como máximo se admitirán (en blanco implica que no habrá límite mínimo). Solo si valueType=10. | |||
products/options/minValues | Opcional | 0 | numeric |
Número de ficheros adjuntos que como mínimo se admitirán (en blanco implica que no habrá límite mínimo). Solo si valueType=10. | |||
products/options/pId | Obligatorio | string | |
Identificador público de la opción. | |||
products/options/priority | Opcional | 0 | numeric |
Define el orden de presentación de esta opción en relación al resto de opciones de este mismo producto. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
products/options/required | Opcional | true | boolean |
Define si la opción es obligatoria. | |||
products/options/showAsGrid | Opcional | false | boolean |
Indica si la opción se debe mostrar como cuadro de compra múltiple en forma de rejilla. Solo es posible si hay dos opciones en el producto. No incluya esta etiqueta a no ser que se lo pidan desde Trilogi. | |||
products/options/showPrice | Opcional | false | |
Define si se muestra el precio o no. | |||
products/options/typology | Opcional | 0 | numeric |
Define el tipo de opción (tipología). Valores permitidos: 1 - Talla, 2 - Color, 3 - Material, 9999 - Otros. Si no se pasa este parámetro, la opción queda sin tipología. | |||
products/options/uniquePrice | Opcional | false | boolean |
Indica si independientemente de las unidades que se compre del producto, el precio de la opción se aplicará solamente una vez. No incluya esta etiqueta a no ser que se lo pidan desde Trilogi. | |||
products/options/valueType | Opcional | 7 | numeric |
Define el tipo de opción. Valores permitidos: 1 - Sí/No, 2 - Texto corto, 3 - Marca única, 4 - Marca Múltiple, 5 - Marca única con imagen, 6 - Marca múltiple con imagen, 7 - Desplegable, 8 - Fecha/Hora, 9 - Texto largo, 10 - Adjunto. | |||
products/options/values | Opcional | array [0:n] | |
Bloque con los distintos valores que tiene la opción. Contiene la definición de todos los valores. | |||
products/options/values/active | Opcional | true | boolean |
Define si el valor de opción esta activo. | |||
products/options/values/languages | Obligatorio | array [1:n] | |
Bloque con información variable según el idioma. | |||
products/options/values/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. | |||
products/options/values/languages/longDescription | Opcional | string | |
Define la descripción corta del valor de opción para el idioma seleccionado. | |||
products/options/values/languages/searchValue | Opcional | string | |
Define el valor de búsqueda del valor de opción para el idioma seleccionado. Si no se especifica se usa el propio valor. | |||
products/options/values/languages/shortDescription | Opcional | string | |
Define la descripción corta del valor de opción para el idioma seleccionado. | |||
products/options/values/languages/value | Obligatorio | string | |
Define el valor de opción para el idioma seleccionado. | |||
products/options/values/largeImage | Opcional | string | |
Información de la imagen del valor en su versión grande. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
products/options/values/noReturn | Opcional | false | boolean |
Indica si se prohibe la devolución. Valores permitidos: false - No prohibir, true - Prohibir | |||
products/options/values/pId | Obligatorio | string | |
Identificador público del valor de la opción. | |||
products/options/values/prices | Obligatorio | array [1:n] | |
Bloque con información de los precios del producto para el valor de opción. | |||
products/options/values/prices/basePrice | Obligatorio | numeric | |
Define un incremento de importe sobre el precio del producto. | |||
products/options/values/prices/currencies | Opcional | array [0:n] | |
Bloque con información de los precios del producto para el valor de opción en monedas adicionales vinculadas al eCommerce. | |||
products/options/values/prices/currencies/basePrice | Obligatorio | numeric | |
Precio del producto. El precio se especifica sin impuestos añadidos. | |||
products/options/values/prices/currencies/currencyCode | Obligatorio | currency | |
Código de la moneda en formato ISO 4217. | |||
products/options/values/prices/currencies/retailPrice | Opcional | numeric | |
Precio del producto cuando está en oferta. El precio se especifica sin impuestos añadidos. | |||
products/options/values/prices/fromQuantity | Opcional | 1 | numeric |
Cuando se define, indica que el bloque de precios es por cantidad (de unidades compradas). Indica la cantidad del intervalo a partir de la cual se aplican los nuevos precios. Debe ser superior a 1 y a la cantidad del intervalo anterior. No es necesario si el eCommerce no tiene activado Precios por cantidad. | |||
products/options/values/prices/retailPrice | Opcional | numeric | |
Define un incremento de importe sobre el precio de oferta del producto. | |||
products/options/values/priority | Opcional | 0 | numeric |
Define el orden de presentación de este valor de opción en relación al resto de valores de esta misma opción en este mismo producto. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
products/options/values/smallImage | Opcional | string | |
Información de la imagen del valor en su versión pequeña. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
products/options/values/weight | Opcional | 0 | numeric |
Define un incremento de peso sobre el peso base del producto. | |||
products/pId | Obligatorio | string | |
Identificador público del producto. | |||
products/priceLists | Opcional | array [0:n] | |
Bloque de información de tarifa. Define los precios del producto para las tarifas disponibles. | |||
products/priceLists/priceList | Obligatorio | struct | |
Bloque de definición de la tarifa. | |||
products/priceLists/priceList/id | Opcional | 0 | numeric |
Identificador interno de la tarifa. Opcional en caso que se use identificador público. | |||
products/priceLists/priceList/pId | Opcional | string | |
Identificador público de la tarifa. Opcional en caso que se use identificador interno. | |||
products/priceLists/prices | Obligatorio | array [1:n] | |
Bloque con información de los precios del producto para la tarifa. | |||
products/priceLists/prices/basePrice | Obligatorio | numeric | |
Precio del producto. El precio se especifica sin impuestos añadidos. | |||
products/priceLists/prices/currencies | Opcional | array [0:n] | |
Bloque con información de los precios del producto en monedas adicionales vinculadas al eCommerce. | |||
products/priceLists/prices/currencies/basePrice | Obligatorio | numeric | |
Precio del producto. El precio se especifica sin impuestos añadidos. | |||
products/priceLists/prices/currencies/currencyCode | Obligatorio | currency | |
Código de la moneda en formato ISO 4217. | |||
products/priceLists/prices/currencies/retailPrice | Opcional | numeric | |
Precio del producto cuando está en oferta. El precio se especifica sin impuestos añadidos. | |||
products/priceLists/prices/fromQuantity | Opcional | 1 | numeric |
Cuando se define, indica que el bloque de precios es por cantidad (de unidades compradas). Indica la cantidad del intervalo a partir de la cual se aplican los nuevos precios. Debe ser superior a 1 y a la cantidad del intervalo anterior. No es necesario si el eCommerce no tiene activado Precios por cantidad. | |||
products/priceLists/prices/optionValue | Opcional | struct | |
Bloque de información del valor de una opción. Indica que el bloque de precios es para un valor de opción. Si se define, la información de precios del bloque se asignará al valor de opción indicado. | |||
products/priceLists/prices/optionValue/id | Opcional | 0 | numeric |
Identificador interno del valor de opción. Opcional en caso que se use identificador público. | |||
products/priceLists/prices/optionValue/pId | Opcional | string | |
Identificador público del valor de opción. Opcional en caso que se use identificador interno. | |||
products/priceLists/prices/retailPrice | Opcional | numeric | |
Precio del producto cuando está en oferta. El precio se especifica sin impuestos añadidos. | |||
products/prices | Obligatorio | array [1:n] | |
Bloque con información de los precios del producto. | |||
products/prices/basePrice | Obligatorio | numeric | |
Precio del producto. El precio se especifica sin impuestos añadidos. | |||
products/prices/currencies | Opcional | array [0:n] | |
Bloque con información de los precios del producto en monedas adicionales vinculadas al eCommerce. | |||
products/prices/currencies/basePrice | Obligatorio | numeric | |
Precio del producto. El precio se especifica sin impuestos añadidos. | |||
products/prices/currencies/currencyCode | Obligatorio | currency | |
Código de la moneda en formato ISO 4217. | |||
products/prices/currencies/retailPrice | Opcional | numeric | |
Precio del producto cuando está en oferta. El precio se especifica sin impuestos añadidos. | |||
products/prices/fromQuantity | Opcional | 1 | numeric |
Cuando se define, indica que el bloque de precios es por cantidad (de unidades compradas). Indica la cantidad del intervalo a partir de la cual se aplican los nuevos precios. Debe ser superior a 1 y a la cantidad del intervalo anterior. No es necesario si el eCommerce no tiene activado Precios por cantidad. | |||
products/prices/retailPrice | Opcional | numeric | |
Precio del producto cuando está en oferta. El precio se especifica sin impuestos añadidos. | |||
products/properties | Obligatorio | struct | |
Bloque de información de las propiedades del producto. | |||
products/properties/active | Opcional | true | boolean |
Define si el producto es visible. | |||
products/properties/availability | Opcional | struct | |
Bloque de información sobre disponibilidad de productos. | |||
products/properties/availability/id | Opcional | 0 | numeric |
Identificador interno de la disponibilidad de productos. Opcional en caso que se use identificador público. | |||
products/properties/availability/pId | Opcional | string | |
Identificador público de la disponibilidad de productos. Opcional en caso que se use identificador interno. | |||
products/properties/availableDate | Opcional | CURRENT_TIMESTAMP | datetime |
Fecha a partir de la cual está disponible el producto. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
products/properties/backOrder | Opcional | any | |
Indica si se permite realizar reservas del producto, o sea, comprar cuando no se tiene stock y el control de stock está activo. Valores permitidos: 0 - Reservas deshabilitadas, 1 - Reservas permitidas siempre, 2* - Reservas permitidas con previsión, 3* - Reservas permitidas sin previsión (* Estos valores necesitan tener contratadas las previsiones de reserva para poder utilizarse) | |||
products/properties/costPrice | Opcional | 0 | numeric |
Indica el precio de coste del producto. Su uso es solo a nivel informativo. | |||
products/properties/endHighlightDate | Opcional | datetime | |
Fecha de fin de novedad. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
products/properties/endOfferDate | Opcional | datetime | |
Fecha de fin de oferta. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
products/properties/exclusiveLinked | Opcional | false | boolean |
products/properties/groupQuantityByOptions | Opcional | false | boolean |
Define si para el control de cantidades de compra del producto se suman las cantidades de todas las opciones compradas o si se cuentan por separado. | |||
products/properties/highlight | Opcional | false | boolean |
Indica si el producto es una novedad. | |||
products/properties/maxOrderQuantity | Opcional | 0 | numeric |
Define la cantidad máxima que se puede comprar del producto en un mismo pedido. 0 para ignorar. | |||
products/properties/minOrderQuantity | Opcional | 0 | numeric |
Define la cantidad mínima que se debe comprar del producto en un mismo pedido. 0 para ignorar. | |||
products/properties/multipleActsOver | Opcional | 0 | numeric |
Define el número de unidades a partir del cual los múltiples de compra actuarán. 0 para ignorar. | |||
products/properties/multipleOrderQuantity | Opcional | 0 | numeric |
Define el múltiplo de unidades del producto al comprar. 0 para ignorar. | |||
products/properties/noReturn | Opcional | false | boolean |
Indica si se prohibe la devolución. Valores permitidos: false - No prohibir, true - Prohibir | |||
products/properties/onRequest | Opcional | false | boolean |
Indica si el producto es de tipo 'bajo demanda'. Un producto de este tipo puede ser comprado aunque se tenga la gestión de stock activa y de él no quede stock suficiente. En tal caso se considerará que el producto ha sido comprado 'bajo demanda' para aquellas unidades para las que no haya stock suficiente. Una condición adicional para que un producto de este tipo pueda ser comprado 'bajo demana' es que tenga al menos una línea de stock configurada. Si esta característica se activa, será desactivará automáticamente la característica de 'reserva' del producto. | |||
products/properties/onRequestDays | Opcional | 0 | numeric |
Indica cuantos días se necesitan para preparar el producto en el caso que éste sea comprado 'bajo demanda'. Esta información se utiliza para mostrar una fecha estimada de salida en este caso. | |||
products/properties/percentPrice | Opcional | numeric | |
Indica el valor del porcentaje que se usará para calcular el precio final de un producto. Puede ser positivo (incremento) o negativo (descuento). | |||
products/properties/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. | |||
products/properties/priority | Obligatorio | numeric | |
Define el orden de presentación del producto en relación al resto de productos que se encuentran en su mismo nivel. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
products/properties/publicationDate | Opcional | CURRENT_TIMESTAMP | datetime |
Fecha de publicación del producto. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
products/properties/sale | Opcional | false | boolean |
Indica si el producto está en oferta. | |||
products/properties/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'. | |||
products/properties/showDiscounts | Opcional | true | boolean |
Indica si se muestran los posibles descuentos que pueden afectar al producto. | |||
products/properties/showOrderBox | Opcional | true | boolean |
Indica si se muestra el input para introducir la cantidad de unidades a comprar. | |||
products/properties/showPrice | Opcional | true | boolean |
Indica si se muestra el precio del producto. | |||
products/properties/startOfferDate | Opcional | datetime | |
Fecha de inicio de oferta. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
products/properties/stockManagement | Opcional | true | boolean |
Define si el producto mantiene y controla la cantidad de stock. Aunque se active el control de stock mediante esta propiedad, si la configuración general no lo tiene activado, el control no se tendrá en cuenta. | |||
products/properties/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. | |||
products/relatedItems | Opcional | array [0:n] | |
Bloque de información sobre elementos relacionados en este producto. | |||
products/relatedItems/item | Obligatorio | struct | |
Bloque para informar sobre el elemento que se relaciona. | |||
products/relatedItems/item/id | Opcional | 0 | numeric |
Identificador interno del elemento a relacionar. Opcional en caso que se use identificador público. | |||
products/relatedItems/item/pId | Opcional | string | |
Identificador público del elemento a relacionar. Opcional en caso que se use identificador interno. | |||
products/relatedItems/priority | Opcional | 0 | numeric |
products/relatedItems/relatedDefinition | Obligatorio | struct | |
Bloque para informar sobre la sección en la que se incluirá el elemento que se quiere relacionar. | |||
products/relatedItems/relatedDefinition/id | Opcional | 0 | numeric |
Identificador interno de la sección. Opcional en caso que se use identificador público. | |||
products/relatedItems/relatedDefinition/pId | Opcional | string | |
Identificador público de la sección. Opcional en caso que se use identificador interno. | |||
products/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. | |||
products/reverseChargeVat | Opcional | false | boolean |
Indica si el producto está bajo la consideración fiscal de Invertir sujeto pasivo. | |||
products/saleUnit | Opcional | numeric | |
Indica como es la unidad de venta. Su uso es solo a nivel informativo. | |||
products/seo | Opcional | struct | |
Bloque con información de posicionamiento SEO. | |||
products/seo/languages | Opcional | array [0:n] | |
Bloque con los datos SEO que dependen del idioma. | |||
products/seo/languages/altImagekeywords | Opcional | string | |
Palabras clave de las imágenes del producto para el idioma seleccionado. Separadas por coma ','. | |||
products/seo/languages/coreKeyword | Opcional | string | |
Palabras clave principal del producto para el idioma seleccionado. | |||
products/seo/languages/keywords | Opcional | string | |
Palabras clave de la categoría para el idioma seleccionado. Separadas por coma ','. | |||
products/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. | |||
products/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). | |||
products/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). | |||
products/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_- | |||
products/shipping | Opcional | boolean | |
Define si se debe calcular los portes para este producto. | |||
products/shippingTypes | Opcional | array [0:n] | |
Bloque para especificar tipos de transporte. | |||
products/shippingTypes/id | Opcional | 0 | |
Identificador interno del tipo de transporte.br>Opcional en caso que se use identificador público. | |||
products/shippingTypes/pId | Opcional | string | |
Identificador público del tipo de transporte. Opcional en caso que se use identificador interno. | |||
products/sku | Opcional | string | |
Referencia del producto. | |||
products/stocks | Opcional | array [0:n] | |
Bloque con información del stock del producto. Este bloque solo tiene sentido si el producto tiene stockManagement=true. | |||
products/stocks/combination | Obligatorio | struct | |
Bloque con información del pId de la combinación. | |||
products/stocks/combination/pId | Obligatorio | string | |
Identificador público de la combinación a la que se le quiere asignar el stock. | |||
products/stocks/pId | Opcional | string | |
Identificador público del stock. | |||
products/stocks/prevision | Opcional | array [0:n] | |
Bloque de información sobre la provisión de stock. | |||
products/stocks/prevision/incomingDate | Obligatorio | date | |
Define la fecha de la provisión de stock. Debe estar en formato ISO 8601 (YYYY-MM-DD). | |||
products/stocks/prevision/pId | Obligatorio | string | |
Identificador público de la provisión de stock. | |||
products/stocks/prevision/previsionType | Opcional | 1 | numeric |
Indica el tipo de la previsión. Valores permitidos: 1 - Previsión de stock, 2 - Previsión de reserva | |||
products/stocks/prevision/stock | Obligatorio | numeric | |
Cantidad entera de unidades en stock. | |||
products/stocks/stock | Opcional | 0 | numeric |
Cantidad entera de unidades en stock. | |||
products/stocks/warehouse | Obligatorio | struct | |
Bloque de información del almacén al que se modifica el stock. | |||
products/stocks/warehouse/id | Opcional | 0 | |
Identificador interno del almacén. Opcional en caso que se use identificador público. | |||
products/stocks/warehouse/pId | Opcional | string | |
Identificador público del almacén. Opcional en caso que se use identificador interno. | |||
products/supplier | Opcional | struct | |
Bloque de información de proveedor. | |||
products/supplier/id | Opcional | 0 | numeric |
Identificador interno del proveedor. Opcional en caso que se use identificador público. | |||
products/supplier/pId | Opcional | string | |
Identificador público del proveedor. Opcional en caso que se use identificador interno. | |||
products/tax | Opcional | struct | |
Bloque de información de los impuestos asociados al producto. | |||
products/tax/id | Opcional | 0 | numeric |
Identificador interno del impuesto. Opcional en caso que se use identificador público. | |||
products/tax/pId | Opcional | string | |
Identificador público del impuesto. Opcional en caso que se use identificador interno. | |||
products/templateId | Opcional | string | |
Indica que plantilla se utilizara para poder mostrar los diferentes productos. Los códigos aquí utilizados deben ser pactados con anterioridad a la integración. No incluya esta etiqueta a no ser que se lo pidan desde Trilogi. | |||
products/typeShippingCalculation | Opcional | 0 | numeric |
Indica el tipo de cálculo de envío. Valores permitidos: false - Peso, true - Unidad | |||
products/upc | Opcional | string | |
Código de producto universal (UPC), también llamado GTIN-12 y UPC-A. | |||
products/weight | Opcional | numeric | |
Indica el peso del producto. Por defecto en kilos, pero depende de la configuración general establecida en el gestor del eCommerce. Puede usarse para configurar los transportes. |
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"ACTIVITYLIMITS": [
{
"ACTIVATIONDATE" :"2015-11-02",
"EXPIRATIONDATE" :"2015-11-20",
"ID" : 23535
}
],
"ADDITIONALIMAGES": [
{
"ID" : 375356,
"LANGUAGES": [
{
"ALT" :"Image 1",
"LANGUAGE" :"ES"
}
],
"LARGEIMAGE" :"large.jpg",
"PRIORITY" : 1,
"SMALLIMAGE" :"small.jpg"
}
],
"BRAND": {
"ID" : 1,
"PID" :"abc"
},
"CATEGORIES": [
{
"ID" : 464,
"MAINCATEGORY" : true,
"PID" :"abc",
"PRICECATEGORY" : false,
"PRIORITY" : 1
}
],
"COMBINATIONS": [
{
"EAN" :"ssss",
"ID" : 16534,
"ISBN" :"sdgddfkjs",
"JAN" :"stets",
"OPTIONSVALUES": [
{
"ID" : 1,
"PID" :"abc"
},
{
"ID" : 2,
"PID" :"cdf"
}
],
"PID" :"aas",
"SKU" :"sssddd",
"UPC" :"sasdasss"
}
],
"CUSTOMTAGS": {
"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"
}
}
]
}
},
"DEFINITIONS": [
{
"DEFINITION": {
"id" : 1,
"pId" :"abvc"
},
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 426,
"ID" : 843,
"OPTIONVALUE": {
"ID" : 1657,
"PID" :""
},
"RETAILPRICE" : 12
}
],
"PROPERTIES": {
"AVAILABILITY": {
"ID" : 0,
"PID" :""
},
"AVAILABLEDATE" :"2014-04-08T02:00:00+02:00",
"BACKORDER" : 1,
"COSTPRICE" : 0,
"DISPLAY" : true,
"ENDHIGHLIGHTDATE" :"2014-04-08T02:00:00+02:00",
"ENDOFFERDATE" :"",
"GROUPQUANTITYBYOPTIONS" : false,
"HIGHLIGHT" : false,
"MAXORDERQUANTITY" : 0,
"MINORDERQUANTITY" : 0,
"MULTIPLEACTSOVER" : 0,
"MULTIPLEORDERQUANTITY" : 0,
"NORETURN" : false,
"ONREQUEST" : true,
"ONREQUESTDAYS" : 3,
"PRIORITY" : 0,
"SALE" : true,
"SHOWDISCOUNTS" : true,
"SHOWORDERBOX" : true,
"SHOWPRICE" : true,
"STARTOFFERDATE" :"",
"STOCKMANAGEMENT" : true
}
}
],
"EAN" :"Code EAN",
"ID" :"1",
"ISBN" :"CODE ISBN",
"JAN" :"CODE JAN",
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"LARGETITLEIMAGE" :"",
"LONGDESCRIPTION" :"",
"NAME" :"",
"SHORTDESCRIPTION" :"",
"SMALLTITLEIMAGE" :""
}
],
"MAINCATEGORY": {
"ID" : 123,
"PID" :"abc"
},
"MAINIMAGE": {
"LARGEIMAGE" :"",
"MEDIUMIMAGE" :"",
"SMALLIMAGE" :""
},
"MANUFACTURERSKU" :"4E6HTRF",
"OPTIONS": [
{
"ACTIVE" : true,
"COMBINABLE" : false,
"FILTERABLE" : true,
"ID" : 14789,
"IMAGE" :"",
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"NAME" :"",
"PROMPT" :""
}
],
"MAXVALUES" :null,
"MINVALUES" :null,
"PID" :"color",
"PRIORITY" : 3,
"REQUIRED" : true,
"SHOWASGRID" : false,
"TYPOLOGY" : 1,
"UNIQUEPRICE" : true,
"VALUES": [
{
"ACTIVE" : true,
"ID" : 1,
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"LONGDESCRIPTION" :"Size XL long description",
"SEARCHVALUE" :"XL",
"SHORTDESCRIPTION" :"Size XL short description",
"VALUE" :"XL"
}
],
"LARGEIMAGE" :"b.jpg",
"PID" :"abc",
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 2,
"ID" : 843,
"RETAILPRICE" : 12
}
],
"PRIORITY" : 1,
"SKU" :"sku",
"SMALLIMAGE" :"a.jpg",
"WEIGHT" : 6
}
],
"VALUETYPE" : 1
}
],
"PID" :"abc",
"PRICECATEGORY": {
"ID" : 123,
"PID" :"abc"
},
"PRICELISTS": [
{
"PRICELIST": {
"ID" : 123,
"PID" :"abc"
},
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 426,
"ID" : 843,
"OPTIONVALUE": {
"ID" : 1657,
"PID" :""
},
"RETAILPRICE" : 12
}
]
}
],
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 426,
"ID" : 843,
"OPTIONVALUE": {
"ID" : 1657,
"PID" :""
},
"RETAILPRICE" : 12
}
],
"PROPERTIES": {
"ACTIVE" : true,
"AVAILABILITY": {
"ID" : 1,
"PID" :"abc"
},
"AVAILABLEDATE" :"",
"BACKORDER" : 0,
"COSTPRICE" : 0,
"ENDHIGHLIGHTDATE" :"2021-10-21T20:25:51+02:00",
"ENDOFFERDATE" :"",
"GROUPQUANTITYBYOPTIONS" : false,
"HIGHLIGHT" : false,
"MAXORDERQUANTITY" : 0,
"MINORDERQUANTITY" : 0,
"MULTIPLEACTSOVER" : 0,
"MULTIPLEORDERQUANTITY" : 0,
"NORETURN" : false,
"ONREQUEST" : false,
"ONREQUESTDAYS" : 0,
"PERCENTPRICE" :null,
"PERCENTPRICEOVERRIDECUSTOMPRICES" : false,
"PRIORITY" : 0,
"SALE" : false,
"SHOWBASEPRICE" : false,
"SHOWDISCOUNTS" : true,
"SHOWORDERBOX" : true,
"SHOWPRICE" : true,
"STARTOFFERDATE" :"",
"STOCKMANAGEMENT" : true,
"USERRETAILPRICE" : false
},
"RELATEDITEMS": [
{
"ID" : 2,
"ITEMS": {
"BANNERS": [
],
"BLOGPOST": [
],
"CATEGORIES": [
],
"NEWS": [
],
"PAGES": [
],
"PRODUCTS": [
{
"ID" : 43567,
"ITEM": {
"ID" : 13,
"pId" :"abc"
}
}
]
},
"NAME" :"Related Definition 1",
"PID" :"abc"
}
],
"REVERSECHARGEVAT" : true,
"SALEUNIT" : 1,
"SEO": {
"LANGUAGES": [
{
"ALTIMAGEKEYWORDS" :"",
"COREKEYWORD" :"",
"KEYWORDS" :"",
"LANGUAGE" :"ES",
"METADESCRIPTION" :"",
"PARTICULARTITLE" :"",
"URLSEO" :""
}
]
},
"SHIPPING" : true,
"SHIPPINGTYPES": [
{
"ID" : 123,
"PID" :"ShippingType1"
}
],
"SKU" :"124TG67",
"STOCKS": [
{
"BACKORDERPREVISION": [
{
"ID" : 134646,
"INCOMINGDATE" :"2015-04-03",
"PID" :"sdfsdf",
"STOCK" : 230
}
],
"COMBINATION": {
"PID" :"combination M"
},
"ID" : 16534,
"PREVISION": [
{
"ID" : 134646,
"INCOMINGDATE" :"2015-04-03",
"PID" :"sdfsdf",
"STOCK" : 230
}
],
"STOCK" : 555,
"WAREHOUSE": {
"ID" : 1,
"PID" :"abc"
}
}
],
"SUPPLIER": {
"ID" : 1,
"PID" :"abc"
},
"TAXDEFINITION": {
"ID" : 1,
"PID" :"abc"
},
"TEMPLATEID" : 1,
"UPC" :"CODE UPC",
"WEIGHT" : 36
}
GET /products/{id}
Descripción
Devuelve la información del producto indicado mediante identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. | |||
fields | Opcional | string | |
Lista de campos a devolver. | |||
languageCode | Opcional | string | |
Devuelve elementos asociados al idioma. Formato ISO 639-1 de dos dígitos. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACTIVITYLIMITS": [
{
"ACTIVATIONDATE" :"2015-11-02",
"EXPIRATIONDATE" :"2015-11-20",
"ID" : 23535
}
],
"ADDITIONALIMAGES": [
{
"ID" : 375356,
"LANGUAGES": [
{
"ALT" :"Image 1",
"LANGUAGE" :"ES"
}
],
"LARGEIMAGE" :"large.jpg",
"PRIORITY" : 1,
"SMALLIMAGE" :"small.jpg"
}
],
"BRAND": {
"ID" : 1,
"PID" :"abc"
},
"CATEGORIES": [
{
"ID" : 464,
"MAINCATEGORY" : true,
"PID" :"abc",
"PRICECATEGORY" : false,
"PRIORITY" : 1
}
],
"COMBINATIONS": [
{
"EAN" :"ssss",
"ID" : 16534,
"ISBN" :"sdgddfkjs",
"JAN" :"stets",
"OPTIONSVALUES": [
{
"ID" : 1,
"PID" :"abc"
},
{
"ID" : 2,
"PID" :"cdf"
}
],
"PID" :"aas",
"SKU" :"sssddd",
"UPC" :"sasdasss"
}
],
"CUSTOMTAGS": {
"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"
}
}
]
}
]
},
"DEFINITIONS": [
{
"DEFINITION": {
"id" : 1,
"pId" :"abvc"
},
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 426,
"ID" : 843,
"OPTIONVALUE": {
"ID" : 1657,
"PID" :""
},
"RETAILPRICE" : 12
}
],
"PROPERTIES": {
"AVAILABILITY": {
"ID" : 0,
"PID" :""
},
"AVAILABLEDATE" :"2014-04-08T02:00:00+02:00",
"BACKORDER" : 1,
"COSTPRICE" : 0,
"DISPLAY" : true,
"ENDHIGHLIGHTDATE" :"2014-04-08T02:00:00+02:00",
"ENDOFFERDATE" :"",
"GROUPQUANTITYBYOPTIONS" : false,
"HIGHLIGHT" : false,
"MAXORDERQUANTITY" : 0,
"MINORDERQUANTITY" : 0,
"MULTIPLEACTSOVER" : 0,
"MULTIPLEORDERQUANTITY" : 0,
"NORETURN" : false,
"ONREQUEST" : true,
"ONREQUESTDAYS" : 3,
"PRIORITY" : 0,
"SALE" : true,
"SHOWDISCOUNTS" : true,
"SHOWORDERBOX" : true,
"SHOWPRICE" : true,
"STARTOFFERDATE" :"",
"STOCKMANAGEMENT" : true
}
}
],
"EAN" :"Code EAN",
"ID" :"1",
"ISBN" :"CODE ISBN",
"JAN" :"CODE JAN",
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"LARGETITLEIMAGE" :"",
"LONGDESCRIPTION" :"",
"NAME" :"",
"SHORTDESCRIPTION" :"",
"SMALLTITLEIMAGE" :""
}
],
"MAINCATEGORY": {
"ID" : 123,
"PID" :"abc"
},
"MAINIMAGE": {
"LARGEIMAGE" :"",
"MEDIUMIMAGE" :"",
"SMALLIMAGE" :""
},
"MANUFACTURERSKU" :"4E6HTRF",
"OPTIONS": [
{
"ACTIVE" : true,
"COMBINABLE" : false,
"FILTERABLE" : true,
"ID" : 14789,
"IMAGE" :"",
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"NAME" :"",
"PROMPT" :""
}
],
"MAXVALUES" :null,
"MINVALUES" :null,
"PID" :"color",
"PRIORITY" : 3,
"REQUIRED" : true,
"SHOWASGRID" : false,
"TYPOLOGY" : 1,
"UNIQUEPRICE" : true,
"VALUES": [
{
"ACTIVE" : true,
"ID" : 1,
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"LONGDESCRIPTION" :"Size XL long description",
"SEARCHVALUE" :"XL",
"SHORTDESCRIPTION" :"Size XL short description",
"VALUE" :"XL"
}
],
"LARGEIMAGE" :"b.jpg",
"PID" :"abc",
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 2,
"ID" : 843,
"RETAILPRICE" : 12
}
],
"PRIORITY" : 1,
"SKU" :"sku",
"SMALLIMAGE" :"a.jpg",
"WEIGHT" : 6
}
],
"VALUETYPE" : 1
}
],
"PID" :"abc",
"PRICECATEGORY": {
"ID" : 123,
"PID" :"abc"
},
"PRICELISTS": [
{
"PRICELIST": {
"ID" : 123,
"PID" :"abc"
},
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 426,
"ID" : 843,
"OPTIONVALUE": {
"ID" : 1657,
"PID" :""
},
"RETAILPRICE" : 12
}
]
}
],
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 426,
"ID" : 843,
"OPTIONVALUE": {
"ID" : 1657,
"PID" :""
},
"RETAILPRICE" : 12
}
],
"PROPERTIES": {
"ACTIVE" : true,
"AVAILABILITY": {
"ID" : 1,
"PID" :"abc"
},
"AVAILABLEDATE" :"",
"BACKORDER" : 0,
"COSTPRICE" : 0,
"ENDHIGHLIGHTDATE" :"2021-10-21T20:25:51+02:00",
"ENDOFFERDATE" :"",
"GROUPQUANTITYBYOPTIONS" : false,
"HIGHLIGHT" : false,
"MAXORDERQUANTITY" : 0,
"MINORDERQUANTITY" : 0,
"MULTIPLEACTSOVER" : 0,
"MULTIPLEORDERQUANTITY" : 0,
"NORETURN" : false,
"ONREQUEST" : false,
"ONREQUESTDAYS" : 0,
"PERCENTPRICE" :null,
"PERCENTPRICEOVERRIDECUSTOMPRICES" : false,
"PRIORITY" : 0,
"SALE" : false,
"SHOWBASEPRICE" : false,
"SHOWDISCOUNTS" : true,
"SHOWORDERBOX" : true,
"SHOWPRICE" : true,
"STARTOFFERDATE" :"",
"STOCKMANAGEMENT" : true,
"USERRETAILPRICE" : false
},
"RELATEDITEMS": [
{
"ID" : 2,
"ITEMS": {
"BANNERS": [
],
"BLOGPOST": [
],
"CATEGORIES": [
],
"NEWS": [
],
"PAGES": [
],
"PRODUCTS": [
{
"ID" : 43567,
"ITEM": {
"ID" : 13,
"pId" :"abc"
}
}
]
},
"NAME" :"Related Definition 1",
"PID" :"abc"
}
],
"REVERSECHARGEVAT" : true,
"SALEUNIT" : 1,
"SEO": {
"LANGUAGES": [
{
"ALTIMAGEKEYWORDS" :"",
"COREKEYWORD" :"",
"KEYWORDS" :"",
"LANGUAGE" :"ES",
"METADESCRIPTION" :"",
"PARTICULARTITLE" :"",
"URLSEO" :""
}
]
},
"SHIPPING" : true,
"SHIPPINGTYPES": [
{
"ID" : 123,
"PID" :"ShippingType1"
}
],
"SKU" :"124TG67",
"STOCKS": [
{
"BACKORDERPREVISION": [
{
"ID" : 134646,
"INCOMINGDATE" :"2015-04-03",
"PID" :"sdfsdf",
"STOCK" : 230
}
],
"COMBINATION": {
"PID" :"combination M"
},
"ID" : 16534,
"PREVISION": [
{
"ID" : 134646,
"INCOMINGDATE" :"2015-04-03",
"PID" :"sdfsdf",
"STOCK" : 230
}
],
"STOCK" : 555,
"WAREHOUSE": {
"ID" : 1,
"PID" :"abc"
}
}
],
"SUPPLIER": {
"ID" : 1,
"PID" :"abc"
},
"TAXDEFINITION": {
"ID" : 1,
"PID" :"abc"
},
"TEMPLATEID" : 1,
"UPC" :"CODE UPC",
"WEIGHT" : 36
}
PUT /products/{id}
Descripción
Edición del producto indicado mediante identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
Parámetros de entrada JSON
{ "products": { "brand": { "id":numeric, "pId":string }, "languages": [ { "languageCode":string, "name":string, "indexable": boolean "largeTitleImage": string "linkFollowing": boolean "longDescription": string "shortDescription": string "smallTitleImage": string } ], "mainImages": { "largeImage":string, "mediumImage":string, "smallImage":string }, "pId":string, "properties": { "active":boolean, "availability": { "id":numeric, "pId":string }, "backOrder":any, "priority":numeric, "availableDate": datetime "costPrice": numeric "endHighlightDate": datetime "endOfferDate": datetime "exclusiveLinked": boolean "groupQuantityByOptions": boolean "highlight": boolean "maxOrderQuantity": numeric "minOrderQuantity": numeric "multipleActsOver": numeric "multipleOrderQuantity": numeric "noReturn": boolean "onRequest": boolean "onRequestDays": numeric "percentPrice": numeric "percentPriceOverrideCustomPrices": boolean "publicationDate": datetime "sale": boolean "showBasePrice": boolean "showDiscounts": boolean "showOrderBox": boolean "showPrice": boolean "startOfferDate": datetime "stockManagement": boolean "useRetailPrice": boolean }, "reverseChargeVat":boolean, "saleUnit":numeric, "seo": { "languages": [ { "altImagekeywords":string, "coreKeyword":string, "keywords":string, "languageCode":string, "metaDescription":string, "particularTitle":string, "urlSeo":string } ] }, "supplier": { "id":numeric, "pId":string }, "tax": { "id":numeric, "pId":string }, "ean": string "includeInShippingRangePrice": boolean "isbn": string "jan": string "manufacturerSku": string "minOrderQuantity": numeric "shipping": boolean "sku": string "templateId": string "typeShippingCalculation": numeric "upc": string "weight": numeric } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
products | Obligatorio | struct | |
Contiene la definición de un producto. | |||
products/brand | Opcional | struct | |
Bloque de información sobre la marca del producto. | |||
products/brand/id | Opcional | 0 | numeric |
Identificador interno de la marca. Opcional en caso que se use identificador público. | |||
products/brand/pId | Opcional | string | |
Identificador público de la marca. Opcional en caso que se use identificador interno. | |||
products/ean | Opcional | string | |
Número de artículo europeo (EAN), también llamado GTIN-13. | |||
products/includeInShippingRangePrice | Opcional | true | boolean |
Indica el producto se tiene en cuenta (contribuye) en el cálculo del transporte por rango de precio. | |||
products/isbn | Opcional | string | |
Número internacional normalizado del libro (ISBN). | |||
products/jan | Opcional | string | |
Número de artículo japonés (JAN), también llamado GTIN-13. | |||
products/languages | Opcional | array [0:n] | |
Bloque con información variable según el idioma. | |||
products/languages/indexable | Opcional | true | boolean |
products/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. | |||
products/languages/largeTitleImage | Opcional | string | |
Define la imagen de titulo grande del producto para el idioma seleccionado. Se debe indicar la ruta (relativa si es propia) de la imagen. No incluya esta etiqueta a no ser que se lo pidan desde Trilogi. | |||
products/languages/linkFollowing | Opcional | true | boolean |
products/languages/longDescription | Opcional | string | |
Define la descripción larga del producto para el idioma seleccionado. | |||
products/languages/name | Opcional | string | |
Define el nombre del producto para el idioma seleccionado. | |||
products/languages/shortDescription | Opcional | string | |
Define la descripción corta del producto para el idioma seleccionado. | |||
products/languages/smallTitleImage | Opcional | string | |
Define la imagen de titulo pequeña del producto para el idioma seleccionado. Se debe indicar la ruta (relativa si es propia) de la imagen. No incluya esta etiqueta a no ser que se lo pidan desde Trilogi. | |||
products/mainImages | Opcional | struct | |
Bloque con información de la imagen principal del producto. | |||
products/mainImages/largeImage | Opcional | string | |
Información de la imagen principal del producto en su versión grande. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
products/mainImages/mediumImage | Opcional | string | |
Información de la imagen principal del producto en su versión mediana. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
products/mainImages/smallImage | Opcional | string | |
Información de la imagen principal del producto en su versión pequeña. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
products/manufacturerSku | Opcional | string | |
Referencia del producto según el fabricante. | |||
products/minOrderQuantity | Opcional | numeric | |
Define la cantidad mínima que se debe comprar del producto en un mismo pedido. 0 para ignorar. | |||
products/pId | Opcional | string | |
Identificador público del producto. | |||
products/properties | Opcional | struct | |
Bloque de información de las propiedades del producto. | |||
products/properties/active | Opcional | true | boolean |
Define si el producto es visible. | |||
products/properties/availability | Opcional | struct | |
Bloque de información sobre disponibilidad de productos. | |||
products/properties/availability/id | Opcional | 0 | numeric |
Identificador interno de la disponibilidad de productos. Opcional en caso que se use identificador público. | |||
products/properties/availability/pId | Opcional | string | |
Identificador público de la disponibilidad de productos. Opcional en caso que se use identificador interno. | |||
products/properties/availableDate | Opcional | CURRENT_TIMESTAMP | datetime |
Fecha a partir de la cual está disponible el producto. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
products/properties/backOrder | Opcional | any | |
Indica si se permite realizar reservas del producto, o sea, comprar cuando no se tiene stock y el control de stock está activo. Valores permitidos: 0 - Reservas deshabilitadas, 1 - Reservas permitidas siempre, 2* - Reservas permitidas con previsión, 3* - Reservas permitidas sin previsión (* Estos valores necesitan tener contratadas las previsiones de reserva para poder utilizarse) | |||
products/properties/costPrice | Opcional | 0 | numeric |
Indica el precio de coste del producto. Su uso es solo a nivel informativo. | |||
products/properties/endHighlightDate | Opcional | datetime | |
Fecha de fin de novedad. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
products/properties/endOfferDate | Opcional | datetime | |
Fecha de fin de oferta. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
products/properties/exclusiveLinked | Opcional | false | boolean |
products/properties/groupQuantityByOptions | Opcional | false | boolean |
Define si para el control de cantidades de compra del producto se suman las cantidades de todas las opciones compradas o si se cuentan por separado. | |||
products/properties/highlight | Opcional | false | boolean |
Indica si el producto es una novedad. | |||
products/properties/maxOrderQuantity | Opcional | 0 | numeric |
Define la cantidad máxima que se puede comprar del producto en un mismo pedido. 0 para ignorar. | |||
products/properties/minOrderQuantity | Opcional | 0 | numeric |
Define la cantidad mínima que se debe comprar del producto en un mismo pedido. 0 para ignorar. | |||
products/properties/multipleActsOver | Opcional | 0 | numeric |
Define el número de unidades a partir del cual los múltiples de compra actuarán. 0 para ignorar. | |||
products/properties/multipleOrderQuantity | Opcional | 0 | numeric |
Define el múltiplo de unidades del producto al comprar. 0 para ignorar. | |||
products/properties/noReturn | Opcional | false | boolean |
Indica si se prohibe la devolución. Valores permitidos: false - No prohibir, true - Prohibir | |||
products/properties/onRequest | Opcional | false | boolean |
Indica si el producto es de tipo 'bajo demanda'. Un producto de este tipo puede ser comprado aunque se tenga la gestión de stock activa y de él no quede stock suficiente. En tal caso se considerará que el producto ha sido comprado 'bajo demanda' para aquellas unidades para las que no haya stock suficiente. Una condición adicional para que un producto de este tipo pueda ser comprado 'bajo demana' es que tenga al menos una línea de stock configurada. Si esta característica se activa, será desactivará automáticamente la característica de 'reserva' del producto. | |||
products/properties/onRequestDays | Opcional | 0 | numeric |
Indica cuantos días se necesitan para preparar el producto en el caso que éste sea comprado 'bajo demanda'. Esta información se utiliza para mostrar una fecha estimada de salida en este caso. | |||
products/properties/percentPrice | Opcional | numeric | |
Indica el valor del porcentaje que se usará para calcular el precio final de un producto. Puede ser positivo (incremento) o negativo (descuento). | |||
products/properties/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. | |||
products/properties/priority | Opcional | numeric | |
Define el orden de presentación del producto en relación al resto de productos que se encuentran en su mismo nivel. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
products/properties/publicationDate | Opcional | CURRENT_TIMESTAMP | datetime |
Fecha de publicación del producto. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
products/properties/sale | Opcional | false | boolean |
Indica si el producto está en oferta. | |||
products/properties/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'. | |||
products/properties/showDiscounts | Opcional | true | boolean |
Indica si se muestran los posibles descuentos que pueden afectar al producto. | |||
products/properties/showOrderBox | Opcional | true | boolean |
Indica si se muestra el input para introducir la cantidad de unidades a comprar. | |||
products/properties/showPrice | Opcional | true | boolean |
Indica si se muestra el precio del producto. | |||
products/properties/startOfferDate | Opcional | datetime | |
Fecha de inicio de oferta. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
products/properties/stockManagement | Opcional | true | boolean |
Define si el producto mantiene y controla la cantidad de stock. Aunque se active el control de stock mediante esta propiedad, si la configuración general no lo tiene activado, el control no se tendrá en cuenta. | |||
products/properties/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. | |||
products/reverseChargeVat | Opcional | false | boolean |
Indica si el producto está bajo la consideración fiscal de Invertir sujeto pasivo. | |||
products/saleUnit | Opcional | 0 | numeric |
Indica como es la unidad de venta. Su uso es solo a nivel informativo. | |||
products/seo | Opcional | struct | |
Bloque con información de posicionamiento SEO. | |||
products/seo/languages | Opcional | array [0:n] | |
Bloque con los datos SEO que dependen del idioma. | |||
products/seo/languages/altImagekeywords | Opcional | string | |
Palabras clave de las imágenes del producto para el idioma seleccionado. Separadas por coma ','. | |||
products/seo/languages/coreKeyword | Opcional | string | |
Palabras clave principal del producto para el idioma seleccionado. | |||
products/seo/languages/keywords | Opcional | string | |
Palabras clave de la categoría para el idioma seleccionado. Separadas por coma ','. | |||
products/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. | |||
products/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). | |||
products/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). | |||
products/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_- | |||
products/shipping | Opcional | boolean | |
Define si se debe calcular los portes para este producto. | |||
products/sku | Opcional | string | |
Referencia del producto. | |||
products/supplier | Opcional | struct | |
Bloque de información de proveedor. | |||
products/supplier/id | Opcional | 0 | numeric |
Identificador interno del proveedor. Opcional en caso que se use identificador público. | |||
products/supplier/pId | Opcional | string | |
Identificador público del proveedor. Opcional en caso que se use identificador interno. | |||
products/tax | Opcional | struct | |
Bloque de información de los impuestos asociados al producto. | |||
products/tax/id | Opcional | 0 | numeric |
Identificador interno del impuesto. Opcional en caso que se use identificador público. | |||
products/tax/pId | Opcional | string | |
Identificador público del impuesto. Opcional en caso que se use identificador interno. | |||
products/templateId | Opcional | string | |
Indica que plantilla se utilizara para poder mostrar los diferentes productos. Los códigos aquí utilizados deben ser pactados con anterioridad a la integración. No incluya esta etiqueta a no ser que se lo pidan desde Trilogi. | |||
products/typeShippingCalculation | Opcional | 0 | numeric |
Indica el tipo de cálculo de envío. Valores permitidos: false - Peso, true - Unidad | |||
products/upc | Opcional | string | |
Código de producto universal (UPC), también llamado GTIN-12 y UPC-A. | |||
products/weight | Opcional | numeric | |
Indica el peso del producto. Por defecto en kilos, pero depende de la configuración general establecida en el gestor del eCommerce. Puede usarse para configurar los transportes. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACTIVITYLIMITS": [
{
"ACTIVATIONDATE" :"2015-11-02",
"EXPIRATIONDATE" :"2015-11-20",
"ID" : 23535
}
],
"ADDITIONALIMAGES": [
{
"ID" : 375356,
"LANGUAGES": [
{
"ALT" :"Image 1",
"LANGUAGE" :"ES"
}
],
"LARGEIMAGE" :"large.jpg",
"PRIORITY" : 1,
"SMALLIMAGE" :"small.jpg"
}
],
"BRAND": {
"ID" : 1,
"PID" :"abc"
},
"CATEGORIES": [
{
"ID" : 464,
"MAINCATEGORY" : true,
"PID" :"abc",
"PRICECATEGORY" : false,
"PRIORITY" : 1
}
],
"COMBINATIONS": [
{
"EAN" :"ssss",
"ID" : 16534,
"ISBN" :"sdgddfkjs",
"JAN" :"stets",
"OPTIONSVALUES": [
{
"ID" : 1,
"PID" :"abc"
},
{
"ID" : 2,
"PID" :"cdf"
}
],
"PID" :"aas",
"SKU" :"sssddd",
"UPC" :"sasdasss"
}
],
"CUSTOMTAGS": {
"CUSTOMTAGS": [
]
},
"DEFINITIONS": [
{
"DEFINITION": {
"id" : 1,
"pId" :"abvc"
},
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 426,
"ID" : 843,
"OPTIONVALUE": {
"ID" : 1657,
"PID" :""
},
"RETAILPRICE" : 12
}
],
"PROPERTIES": {
"AVAILABILITY": {
"ID" : 0,
"PID" :""
},
"AVAILABLEDATE" :"2014-04-08T02:00:00+02:00",
"BACKORDER" : 1,
"COSTPRICE" : 0,
"DISPLAY" : true,
"ENDHIGHLIGHTDATE" :"2014-04-08T02:00:00+02:00",
"ENDOFFERDATE" :"",
"GROUPQUANTITYBYOPTIONS" : false,
"HIGHLIGHT" : false,
"MAXORDERQUANTITY" : 0,
"MINORDERQUANTITY" : 0,
"MULTIPLEACTSOVER" : 0,
"MULTIPLEORDERQUANTITY" : 0,
"NORETURN" : false,
"ONREQUEST" : true,
"ONREQUESTDAYS" : 3,
"PRIORITY" : 0,
"SALE" : true,
"SHOWDISCOUNTS" : true,
"SHOWORDERBOX" : true,
"SHOWPRICE" : true,
"STARTOFFERDATE" :"",
"STOCKMANAGEMENT" : true
}
}
],
"EAN" :"Code EAN",
"ID" :"1",
"ISBN" :"CODE ISBN",
"JAN" :"CODE JAN",
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"LARGETITLEIMAGE" :"",
"LONGDESCRIPTION" :"",
"NAME" :"",
"SHORTDESCRIPTION" :"",
"SMALLTITLEIMAGE" :""
}
],
"MAINCATEGORY": {
"ID" : 123,
"PID" :"abc"
},
"MAINIMAGE": {
"LARGEIMAGE" :"",
"MEDIUMIMAGE" :"",
"SMALLIMAGE" :""
},
"MANUFACTURERSKU" :"4E6HTRF",
"OPTIONS": [
{
"ACTIVE" : true,
"COMBINABLE" : false,
"FILTERABLE" : true,
"ID" : 14789,
"IMAGE" :"",
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"NAME" :"",
"PROMPT" :""
}
],
"MAXVALUES" :null,
"MINVALUES" :null,
"PID" :"color",
"PRIORITY" : 3,
"REQUIRED" : true,
"SHOWASGRID" : false,
"TYPOLOGY" : 1,
"UNIQUEPRICE" : true,
"VALUES": [
{
"ACTIVE" : true,
"ID" : 1,
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"LONGDESCRIPTION" :"Size XL long description",
"SEARCHVALUE" :"XL",
"SHORTDESCRIPTION" :"Size XL short description",
"VALUE" :"XL"
}
],
"LARGEIMAGE" :"b.jpg",
"PID" :"abc",
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 2,
"ID" : 843,
"RETAILPRICE" : 12
}
],
"PRIORITY" : 1,
"SKU" :"sku",
"SMALLIMAGE" :"a.jpg",
"WEIGHT" : 6
}
],
"VALUETYPE" : 1
}
],
"PID" :"abc",
"PRICECATEGORY": {
"ID" : 123,
"PID" :"abc"
},
"PRICELISTS": [
{
"PRICELIST": {
"ID" : 123,
"PID" :"abc"
},
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 426,
"ID" : 843,
"OPTIONVALUE": {
"ID" : 1657,
"PID" :""
},
"RETAILPRICE" : 12
}
]
}
],
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 426,
"ID" : 843,
"OPTIONVALUE": {
"ID" : 1657,
"PID" :""
},
"RETAILPRICE" : 12
}
],
"PROPERTIES": {
"ACTIVE" : true,
"AVAILABILITY": {
"ID" : 1,
"PID" :"abc"
},
"AVAILABLEDATE" :"",
"BACKORDER" : 0,
"COSTPRICE" : 0,
"ENDHIGHLIGHTDATE" :"2021-10-21T20:25:51+02:00",
"ENDOFFERDATE" :"",
"GROUPQUANTITYBYOPTIONS" : false,
"HIGHLIGHT" : false,
"MAXORDERQUANTITY" : 0,
"MINORDERQUANTITY" : 0,
"MULTIPLEACTSOVER" : 0,
"MULTIPLEORDERQUANTITY" : 0,
"NORETURN" : false,
"ONREQUEST" : false,
"ONREQUESTDAYS" : 0,
"PERCENTPRICE" :null,
"PERCENTPRICEOVERRIDECUSTOMPRICES" : false,
"PRIORITY" : 0,
"SALE" : false,
"SHOWBASEPRICE" : false,
"SHOWDISCOUNTS" : true,
"SHOWORDERBOX" : true,
"SHOWPRICE" : true,
"STARTOFFERDATE" :"",
"STOCKMANAGEMENT" : true,
"USERRETAILPRICE" : false
},
"RELATEDITEMS": [
{
"ID" : 2,
"ITEMS": {
"BANNERS": [
],
"BLOGPOST": [
],
"CATEGORIES": [
],
"NEWS": [
],
"PAGES": [
],
"PRODUCTS": [
{
"ID" : 43567,
"ITEM": {
"ID" : 13,
"pId" :"abc"
}
}
]
},
"NAME" :"Related Definition 1",
"PID" :"abc"
}
],
"REVERSECHARGEVAT" : true,
"SALEUNIT" : 1,
"SEO": {
"LANGUAGES": [
{
"ALTIMAGEKEYWORDS" :"",
"COREKEYWORD" :"",
"KEYWORDS" :"",
"LANGUAGE" :"ES",
"METADESCRIPTION" :"",
"PARTICULARTITLE" :"",
"URLSEO" :""
}
]
},
"SHIPPING" : true,
"SHIPPINGTYPES": [
{
"ID" : 123,
"PID" :"ShippingType1"
}
],
"SKU" :"124TG67",
"STOCKS": [
{
"BACKORDERPREVISION": [
{
"ID" : 134646,
"INCOMINGDATE" :"2015-04-03",
"PID" :"sdfsdf",
"STOCK" : 230
}
],
"COMBINATION": {
"PID" :"combination M"
},
"ID" : 16534,
"PREVISION": [
{
"ID" : 134646,
"INCOMINGDATE" :"2015-04-03",
"PID" :"sdfsdf",
"STOCK" : 230
}
],
"STOCK" : 555,
"WAREHOUSE": {
"ID" : 1,
"PID" :"abc"
}
}
],
"SUPPLIER": {
"ID" : 1,
"PID" :"abc"
},
"TAXDEFINITION": {
"ID" : 1,
"PID" :"abc"
},
"TEMPLATEID" : 1,
"UPC" :"CODE UPC",
"WEIGHT" : 36
}
DELETE /products/{id}
Descripción
Elimina el producto indicado mediante identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/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 /products/{id}/activityLimits
Descripción
Devuelve la información de los periodos de actividad del producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/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 /products/{id}/activityLimits
Descripción
Creación de un periodo de actividad para el producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/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 /products/{id}/activityLimits
Descripción
Elimina todos los periodos de actividad del producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/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 /products/{id}/additionalImages
Descripción
Devuelve las imágenes adicionales del producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/additionalImages
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ADDITIONALIMAGES": [
{
"ID" : 375356,
"LANGUAGES": [
{
"ALT" :"Image 1",
"LANGUAGE" :"ES"
}
],
"LARGEIMAGE" :"large.jpg",
"PRIORITY" : 1,
"SMALLIMAGE" :"small.jpg"
}
]
}
POST /products/{id}/additionalImages
Descripción
Asignación de una imagen adicional al producto indicado. Este recurso asigna al producto una ruta a un fichero de imagen, no sube el archivo al CDN de recursos estáticos. Para este cometido, puede consultar el recurso: util/countries.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/additionalImages
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
Parámetros de entrada JSON
{ "additionalImages": { "languages": [ { "languageCode":string, "alt": string } ], "largeImage":string, "smallImage":string, "priority": numeric } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
additionalImages | Obligatorio | struct | |
Bloque con información de las imágenes adicionales del producto. | |||
additionalImages/languages | Opcional | array [0:n] | |
Bloque con información variable según el idioma. | |||
additionalImages/languages/alt | Opcional | string | |
Palabras clave de las imágenes adicionales del producto para el idioma seleccionado. Separadas por coma ','. | |||
additionalImages/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. | |||
additionalImages/largeImage | Obligatorio | string | |
Información de la imagen adicional del producto en su versión grande. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
additionalImages/priority | Opcional | numeric | |
Define el orden de presentación de esta imagen adicional en relación al resto de adicionales que se encuentran en su mismo nivel. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
additionalImages/smallImage | Obligatorio | string | |
Información de la imagen adicional del producto en su versión pequeña. Se debe indicar la ruta (relativa si es propia) de la imagen. |
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"ID" : 375356,
"LANGUAGES": [
{
"ALT" :"Image 1",
"LANGUAGE" :"ES"
}
],
"LARGEIMAGE" :"large.jpg",
"PRIORITY" : 1,
"SMALLIMAGE" :"small.jpg"
}
DELETE /products/{id}/additionalImages
Descripción
Desasigna todas las imágenes adicionales del producto indicado. Este recurso no borra los archivos, solo desvincula las imágenes.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/additionalImages
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ADDITIONALIMAGES": [
]
}
GET /products/{id}/categories
Descripción
Devuelve las categorías vinculadas al producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/categories
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"CATEGORIES": [
{
"ID" : 464,
"MAINCATEGORY" : true,
"PID" :"abc",
"PRICECATEGORY" : false,
"PRIORITY" : 1
}
]
}
POST /products/{id}/categories
Descripción
Vincula una categoría al producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/categories
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
Parámetros de entrada JSON
{ "categories": { "id":numeric, "mainCategory":boolean, "pId":string, "priceCategory":boolean, "priority":numeric } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
categories | Obligatorio | struct | |
Bloque con las categorías a las que pertenece el producto. | |||
categories/id | Opcional | 0 | numeric |
Identificador interno de la categoría. Opcional en caso que se use identificador público. | |||
categories/mainCategory | Opcional | false | boolean |
Define si es la categoría principal del producto. Sólo puede haber una categoría principal para un producto. | |||
categories/pId | Opcional | string | |
Identificador público de la categoría. Opcional en caso que se use identificador interno. | |||
categories/priceCategory | Opcional | false | boolean |
Define si es la categoría de la que debe tomar el porcentaje a aplicar sobre los precios del producto. Sólo puede haber una categoría de precios para un producto. No es necesario si el eCommerce no tiene activado Precios por categoría. | |||
categories/priority | Opcional | 0 | numeric |
Define el orden de presentación del producto cuando se visualiza dentro de esta categoría en relación al resto de productos que se encuentran en su mismo nivel. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. |
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"ID" : 464,
"MAINCATEGORY" : true,
"PID" :"abc",
"PRICECATEGORY" : false,
"PRIORITY" : 1
}
DELETE /products/{id}/categories
Descripción
Desvincula todas las categorías del producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/categories
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"CATEGORIES": [
]
}
PUT /products/{id}/categories/{categoryId}
Descripción
Editar una vinculación a categoría determinada del producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/categories/{categoryId}
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. | |||
categoryId | Obligatorio | numeric | |
Identificador interno de categoría. |
Parámetros de entrada JSON
{ "categories": { "mainCategory":boolean, "pId":string, "priceCategory":boolean, "priority":numeric } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
categories | Obligatorio | struct | |
Bloque con las categorías a las que pertenece el producto. | |||
categories/mainCategory | Opcional | boolean | |
Define si es la categoría principal del producto. Sólo puede haber una categoría principal para un producto. | |||
categories/pId | Opcional | string | |
categories/priceCategory | Opcional | boolean | |
categories/priority | Opcional | numeric | |
Define el orden de presentación del producto cuando se visualiza dentro de esta categoría en relación al resto de productos que se encuentran en su mismo nivel. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 464,
"MAINCATEGORY" : true,
"PID" :"abc",
"PRICECATEGORY" : false,
"PRIORITY" : 1
}
DELETE /products/{id}/categories/{categoryId}
Descripción
Desvincula una vinculación a categoría determinada del producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/categories/{categoryId}
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. | |||
categoryId | Obligatorio | numeric | |
Identificador interno de categoría. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 1
}
GET /products/{id}/combinations
Descripción
Devuelve información sobre las combinaciones de valores de opción del producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/combinations
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"COMBINATIONS": [
{
"EAN" :"ssss",
"ID" : 16534,
"ISBN" :"sdgddfkjs",
"JAN" :"stets",
"OPTIONSVALUES": [
{
"ID" : 1,
"PID" :"abc"
},
{
"ID" : 2,
"PID" :"cdf"
}
],
"PID" :"aas",
"SKU" :"sssddd",
"UPC" :"sasdasss"
}
]
}
POST /products/{id}/combinations
Descripción
Creación de una combinación de valores de opción del producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/combinations
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
Parámetros de entrada JSON
{ "combinations": { "ean":string, "isbn":string, "jan":string, "optionsValues": [ { "id":, "pId":string } ], "pId":string, "sku":string, "upc":string } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
combinations | Obligatorio | struct | |
Bloque de información sobre las combinaciones de valores de opción que puede tener un producto. Solo estas combinaciones podrán asociarse a stock. | |||
combinations/ean | Opcional | string | |
Número de artículo europeo (EAN), también llamado GTIN-13. | |||
combinations/isbn | Opcional | string | |
Número internacional normalizado del libro (ISBN). | |||
combinations/jan | Opcional | string | |
Número de artículo japonés (JAN), también llamado GTIN-13. | |||
combinations/optionsValues | Opcional | array [0:n] | |
Bloque de información sobre la combinación de los valores de opción. Define las opciones que intervienen en la combinación. Solo es necesario para los valores de opción que tengan combinable=true. | |||
combinations/optionsValues/id | Opcional | 0 | |
Identificador interno del valor de opción. Opcional en caso que se use identificador público. | |||
combinations/optionsValues/pId | Opcional | string | |
Identificador público del valor de opción. Opcional en caso que se use identificador interno. | |||
combinations/pId | Opcional | string | |
Identificador público de la combinación. Este ID se usa también como identificador público de la línea de stock que contiene el número de unidades disponibles (stock) para esa combinación. | |||
combinations/sku | Opcional | string | |
Define una referencia para la combinación de valores de opción. | |||
combinations/upc | Opcional | string | |
Código de producto universal (UPC), también llamado GTIN-12 y UPC-A. |
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"EAN" :"ssss",
"ID" : 16534,
"ISBN" :"sdgddfkjs",
"JAN" :"stets",
"OPTIONSVALUES": [
{
"ID" : 1,
"PID" :"abc"
},
{
"ID" : 2,
"PID" :"cdf"
}
],
"PID" :"aas",
"SKU" :"sssddd",
"UPC" :"sasdasss"
}
DELETE /products/{id}/combinations
Descripción
Elimina todas las combinaciones de valores de opción del producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/combinations
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"COMBINATIONS": [
]
}
GET /products/{id}/customTags
Descripción
Devuelve las etiquetas del producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/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 /products/{id}/customTags
Descripción
Vincula etiquetas al producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/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": { "active":boolean, "value":string }, "group": { "id":numeric, "pId":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 manipular los valores de las etiquetas de tipo producto, para este producto 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 | true | 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 | true | 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 | true | 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 /products/{id}/customTags
Descripción
Desvincula etiquetas del producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/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 /products/{id}/customTags/{customTagId}
Descripción
Devuelve la información de una etiqueta determinada del producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/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
{
"CUSTOMTAGS": {
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GENERAL": {
"ACTIVE" : true,
"VALUE" :"12"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
}
}
}
PUT /products/{id}/customTags/{customTagId}
Descripción
Edición de una etiqueta determinada del producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/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 manipular los valores de las etiquetas de tipo producto, para este producto en concreto. | |||
customTags/general | Opcional | struct | |
Bloque para etiquetas cuyos valores no dependen del idioma | |||
customTags/general/active | Opcional | true | 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 | true | 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 | true | 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
{
"CUSTOMTAGS": {
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GENERAL": {
"ACTIVE" : true,
"VALUE" :"12"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
}
}
}
DELETE /products/{id}/customTags/{customTagId}
Descripción
Desvincula una etiqueta determinada del producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/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" :"abc",
"ID" : 123
}
GET /products/{id}/definitions
Descripción
Devuelve las personalizaciones del producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/definitions
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"DEFINITIONS": [
{
"DEFINITION": {
"id" : 1,
"pId" :"abvc"
},
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 426,
"ID" : 843,
"OPTIONVALUE": {
"ID" : 1657,
"PID" :""
},
"RETAILPRICE" : 12
}
],
"PROPERTIES": {
"AVAILABILITY": {
"ID" : 0,
"PID" :""
},
"AVAILABLEDATE" :"2014-04-08T02:00:00+02:00",
"BACKORDER" : 1,
"COSTPRICE" : 0,
"DISPLAY" : true,
"ENDHIGHLIGHTDATE" :"2014-04-08T02:00:00+02:00",
"ENDOFFERDATE" :"",
"GROUPQUANTITYBYOPTIONS" : false,
"HIGHLIGHT" : false,
"MAXORDERQUANTITY" : 0,
"MINORDERQUANTITY" : 0,
"MULTIPLEACTSOVER" : 0,
"MULTIPLEORDERQUANTITY" : 0,
"NORETURN" : false,
"ONREQUEST" : true,
"ONREQUESTDAYS" : 3,
"PRIORITY" : 0,
"SALE" : true,
"SHOWDISCOUNTS" : true,
"SHOWORDERBOX" : true,
"SHOWPRICE" : true,
"STARTOFFERDATE" :"",
"STOCKMANAGEMENT" : true
}
}
]
}
POST /products/{id}/definitions
Descripción
Vincula una personalización al producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/definitions
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
Parámetros de entrada JSON
{ "definitions": { "definition": { "id":numeric, "pId":string }, "prices": [ { "currencies": [ { "currencyCode":currency, "basePrice": numeric "retailPrice": numeric } ], "fromQuantity":numeric, "optionValue": { "id":numeric, "pId":string }, "basePrice": numeric "retailPrice": numeric } ], "properties": { "availability": { "id":numeric, "pId":string }, "backOrder":any, "active": boolean "availableDate": datetime "costPrice": numeric "endHighlightDate": datetime "endOfferDate": datetime "exclusiveLinked": boolean "groupQuantityByOptions": boolean "highlight": boolean "maxOrderQuantity": numeric "minOrderQuantity": numeric "multipleActsOver": numeric "multipleOrderQuantity": numeric "noReturn": boolean "onRequest": boolean "onRequestDays": numeric "percentPrice": numeric "percentPriceOverrideCustomPrices": boolean "priority": numeric "publicationDate": datetime "sale": boolean "showBasePrice": boolean "showDiscounts": boolean "showOrderBox": boolean "showPrice": boolean "startOfferDate": datetime "stockManagement": boolean "useRetailPrice": boolean } } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
definitions | Obligatorio | struct | |
Bloque con información sobre las personalizaciones del producto. 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. | |||
definitions/definition | Obligatorio | struct | |
Bloque para especificar una determinada definición. | |||
definitions/definition/id | Opcional | 0 | numeric |
Identificador interno de la definición. Opcional en caso que se use identificador público. | |||
definitions/definition/pId | Opcional | string | |
Identificador público de la definición. Opcional en caso que se use identificador interno. | |||
definitions/prices | Opcional | array [0:n] | |
Bloque con información de los precios del producto para la personalización. | |||
definitions/prices/basePrice | Obligatorio | numeric | |
Precio del producto. El precio se especifica sin impuestos añadidos. | |||
definitions/prices/currencies | Opcional | array [0:n] | |
Bloque con información de los precios del producto en monedas adicionales vinculadas al eCommerce. | |||
definitions/prices/currencies/basePrice | Obligatorio | numeric | |
Precio del producto. El precio se especifica sin impuestos añadidos. | |||
definitions/prices/currencies/currencyCode | Obligatorio | currency | |
Código de la moneda en formato ISO 4217. | |||
definitions/prices/currencies/retailPrice | Opcional | numeric | |
Precio del producto cuando está en oferta. El precio se especifica sin impuestos añadidos. | |||
definitions/prices/fromQuantity | Opcional | 1 | numeric |
Cuando se define, indica que el bloque de precios es por cantidad (de unidades compradas). Indica la cantidad del intervalo a partir de la cual se aplican los nuevos precios. Debe ser superior a 1 y a la cantidad del intervalo anterior. No es necesario si el eCommerce no tiene activado Precios por cantidad. | |||
definitions/prices/optionValue | Opcional | struct | |
Bloque de información del valor de una opción. Define si el bloque de precios es para un valor de opción. | |||
definitions/prices/optionValue/id | Opcional | 0 | numeric |
Identificador interno del valor de opción. Opcional en caso que se use identificador público. | |||
definitions/prices/optionValue/pId | Opcional | string | |
Identificador público del valor de opción. Opcional en caso que se use identificador interno. | |||
definitions/prices/retailPrice | Opcional | numeric | |
Precio del producto cuando está en oferta. El precio se especifica sin impuestos añadidos. | |||
definitions/properties | Opcional | struct | |
Bloque con las propiedades de la personalización del producto. | |||
definitions/properties/active | Opcional | true | boolean |
Define si el producto es visible. | |||
definitions/properties/availability | Opcional | struct | |
Bloque de información sobre disponibilidad de productos. | |||
definitions/properties/availability/id | Opcional | 0 | numeric |
Identificador interno de la disponibilidad de productos. Opcional en caso que se use identificador público. | |||
definitions/properties/availability/pId | Opcional | string | |
Identificador público de la disponibilidad de productos. Opcional en caso que se use identificador interno. | |||
definitions/properties/availableDate | Opcional | CURRENT_TIMESTAMP | datetime |
Fecha a partir de la cual está disponible el producto. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
definitions/properties/backOrder | Opcional | any | |
Indica si se permite realizar reservas del producto, o sea, comprar cuando no se tiene stock y el control de stock está activo. Valores permitidos: 0 - Reservas deshabilitadas, 1 - Reservas permitidas siempre, 2* - Reservas permitidas con previsión, 3* - Reservas permitidas sin previsión (* Estos valores necesitan tener contratadas las previsiones de reserva para poder utilizarse) | |||
definitions/properties/costPrice | Opcional | 0 | numeric |
Indica el precio de coste del producto. Su uso es solo a nivel informativo. | |||
definitions/properties/endHighlightDate | Opcional | datetime | |
Fecha de fin de novedad. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
definitions/properties/endOfferDate | Opcional | datetime | |
Fecha de fin de oferta. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
definitions/properties/exclusiveLinked | Opcional | false | boolean |
definitions/properties/groupQuantityByOptions | Opcional | false | boolean |
Define si para el control de cantidades de compra del producto se suman las cantidades de todas las opciones compradas o si se cuentan por separado. | |||
definitions/properties/highlight | Opcional | false | boolean |
Indica si el producto es una novedad. | |||
definitions/properties/maxOrderQuantity | Opcional | 0 | numeric |
Define la cantidad máxima que se puede comprar del producto en un mismo pedido. 0 para ignorar. | |||
definitions/properties/minOrderQuantity | Opcional | 0 | numeric |
Define la cantidad mínima que se debe comprar del producto en un mismo pedido. 0 para ignorar. | |||
definitions/properties/multipleActsOver | Opcional | 0 | numeric |
Define el número de unidades a partir del cual los múltiples de compra actuarán. 0 para ignorar. | |||
definitions/properties/multipleOrderQuantity | Opcional | 0 | numeric |
Define el múltiplo de unidades del producto al comprar. 0 para ignorar. | |||
definitions/properties/noReturn | Opcional | false | boolean |
Indica si se prohibe la devolución. Valores permitidos: false - No prohibir, true - Prohibir | |||
definitions/properties/onRequest | Opcional | false | boolean |
Indica si el producto es de tipo 'bajo demanda'. Un producto de este tipo puede ser comprado aunque se tenga la gestión de stock activa y de él no quede stock suficiente. En tal caso se considerará que el producto ha sido comprado 'bajo demanda' para aquellas unidades para las que no haya stock suficiente. Una condición adicional para que un producto de este tipo pueda ser comprado 'bajo demana' es que tenga al menos una línea de stock configurada. Si esta característica se activa, será desactivará automáticamente la característica de 'reserva' del producto. | |||
definitions/properties/onRequestDays | Opcional | 0 | numeric |
Indica cuantos días se necesitan para preparar el producto en el caso que éste sea comprado 'bajo demanda'. Esta información se utiliza para mostrar una fecha estimada de salida en este caso. | |||
definitions/properties/percentPrice | Opcional | numeric | |
Indica el valor del porcentaje que se usará para calcular el precio final de un producto. Puede ser positivo (incremento) o negativo (descuento). | |||
definitions/properties/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. | |||
definitions/properties/priority | Obligatorio | numeric | |
Define el orden de presentación del producto en relación al resto de productos que se encuentran en su mismo nivel. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
definitions/properties/publicationDate | Opcional | CURRENT_TIMESTAMP | datetime |
Fecha de publicación del producto. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
definitions/properties/sale | Opcional | false | boolean |
Indica si el producto está en oferta. | |||
definitions/properties/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'. | |||
definitions/properties/showDiscounts | Opcional | true | boolean |
Indica si se muestran los posibles descuentos que pueden afectar al producto. | |||
definitions/properties/showOrderBox | Opcional | true | boolean |
Indica si se muestra el input para introducir la cantidad de unidades a comprar. | |||
definitions/properties/showPrice | Opcional | true | boolean |
Indica si se muestra el precio del producto. | |||
definitions/properties/startOfferDate | Opcional | datetime | |
Fecha de inicio de oferta. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
definitions/properties/stockManagement | Opcional | true | boolean |
Define si el producto mantiene y controla la cantidad de stock. Aunque se active el control de stock mediante esta propiedad, si la configuración general no lo tiene activado, el control no se tendrá en cuenta. | |||
definitions/properties/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
{
"DEFINITIONS": [
{
"DEFINITION": {
"id" : 1,
"pId" :"abvc"
},
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 426,
"ID" : 843,
"OPTIONVALUE": {
"ID" : 1657,
"PID" :""
},
"RETAILPRICE" : 12
}
],
"PROPERTIES": {
"AVAILABILITY": {
"ID" : 0,
"PID" :""
},
"AVAILABLEDATE" :"2014-04-08T02:00:00+02:00",
"BACKORDER" : 1,
"COSTPRICE" : 0,
"DISPLAY" : true,
"ENDHIGHLIGHTDATE" :"2014-04-08T02:00:00+02:00",
"ENDOFFERDATE" :"",
"GROUPQUANTITYBYOPTIONS" : false,
"HIGHLIGHT" : false,
"MAXORDERQUANTITY" : 0,
"MINORDERQUANTITY" : 0,
"MULTIPLEACTSOVER" : 0,
"MULTIPLEORDERQUANTITY" : 0,
"NORETURN" : false,
"ONREQUEST" : true,
"ONREQUESTDAYS" : 3,
"PRIORITY" : 0,
"SALE" : true,
"SHOWDISCOUNTS" : true,
"SHOWORDERBOX" : true,
"SHOWPRICE" : true,
"STARTOFFERDATE" :"",
"STOCKMANAGEMENT" : true
}
}
]
}
DELETE /products/{id}/definitions
Descripción
Elimina todas las personalizaciones del producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/definitions
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"DEFINITIONS": [
]
}
GET /products/{id}/definitions/{definitionId}
Descripción
Devuelve la información de una personalización determinada del producto indicado. La combinación de campos devuelta en el bloque prices depende del tipo de registro de precios, por lo que hay que tener en cuenta esta particularidad a la hora de analizar y tratar la respuesta. Más información en el recurso POST / products/{id}/definitions/{definitionId}/prices.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/definitions/{definitionId}
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. | |||
definitionId | Obligatorio | numeric | |
Indentificador interno de la personalización. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"DEFINITION": {
"id" : 1,
"pId" :"abvc"
},
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 426,
"ID" : 843,
"OPTIONVALUE": {
"ID" : 1657,
"PID" :""
},
"RETAILPRICE" : 12
}
],
"PROPERTIES": {
"AVAILABILITY": {
"ID" : 0,
"PID" :""
},
"AVAILABLEDATE" :"2014-04-08T02:00:00+02:00",
"BACKORDER" : 1,
"COSTPRICE" : 0,
"DISPLAY" : true,
"ENDHIGHLIGHTDATE" :"2014-04-08T02:00:00+02:00",
"ENDOFFERDATE" :"",
"GROUPQUANTITYBYOPTIONS" : false,
"HIGHLIGHT" : false,
"MAXORDERQUANTITY" : 0,
"MINORDERQUANTITY" : 0,
"MULTIPLEACTSOVER" : 0,
"MULTIPLEORDERQUANTITY" : 0,
"NORETURN" : false,
"ONREQUEST" : true,
"ONREQUESTDAYS" : 3,
"PRIORITY" : 0,
"SALE" : true,
"SHOWDISCOUNTS" : true,
"SHOWORDERBOX" : true,
"SHOWPRICE" : true,
"STARTOFFERDATE" :"",
"STOCKMANAGEMENT" : true
}
}
DELETE /products/{id}/definitions/{definitionId}
Descripción
Elimina una personalización determinada del producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/definitions/{definitionId}
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. | |||
definitionId | Obligatorio | numeric | |
Indentificador interno de la personalización. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"DEFINITIONID" : 1234,
"ID" : 352144
}
GET /products/{id}/definitions/{definitionId}/prices
Descripción
Devuelve el precio de una personalización determinada del producto indicado. La combinación de campos devueltos dependen del tipo de registro de precios, por lo que hay que tener en cuenta esta particularidad a la hora de analizar y tratar la respuesta. Más información en el recurso POST / products/{id}/definitions/{definitionId}/prices.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/definitions/{definitionId}/prices
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. | |||
definitionId | Obligatorio | numeric | |
Indentificador interno de la personalización. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 426,
"ID" : 843,
"OPTIONVALUE": {
"ID" : 1657,
"PID" :""
},
"RETAILPRICE" : 12
}
]
}
POST /products/{id}/definitions/{definitionId}/prices
Descripción
Asignación de precios a una personalización determinada del producto indicado. Permite especificar, para esa personalización, tanto los precios base como los de valor de opción. Si además se define fromQuantity, se indica que el precio es por cantidad (de unidades compradas).
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/definitions/{definitionId}/prices
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. | |||
definitionId | Obligatorio | numeric | |
Indentificador interno de la personalización. |
Parámetros de entrada JSON
{ "prices": { "basePrice":numeric, "currencies": [ { "currencyCode":currency, "basePrice": numeric "retailPrice": numeric } ], "fromQuantity":numeric, "optionValue": { "id":numeric, "pId":string }, "retailPrice":numeric } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
prices | Obligatorio | struct | |
Bloque con información de los precios del producto para la personalización. | |||
prices/basePrice | Obligatorio | numeric | |
Precio del producto. El precio se especifica sin impuestos añadidos. | |||
prices/currencies | Opcional | array [0:n] | |
Bloque con información de los precios del producto en monedas adicionales vinculadas al eCommerce. | |||
prices/currencies/basePrice | Obligatorio | numeric | |
Precio del producto. El precio se especifica sin impuestos añadidos. | |||
prices/currencies/currencyCode | Obligatorio | currency | |
Código de la moneda en formato ISO 4217. | |||
prices/currencies/retailPrice | Opcional | numeric | |
Precio del producto cuando está en oferta. El precio se especifica sin impuestos añadidos. | |||
prices/fromQuantity | Opcional | 1 | numeric |
Cuando se define, indica que el bloque de precios es por cantidad (de unidades compradas). Indica la cantidad del intervalo a partir de la cual se aplican los nuevos precios. Debe ser superior a 1 y a la cantidad del intervalo anterior. No es necesario si el eCommerce no tiene activado Precios por cantidad. | |||
prices/optionValue | Opcional | struct | |
Bloque de información del valor de una opción. Define si el bloque de precios es para un valor de opción. | |||
prices/optionValue/id | Opcional | 0 | numeric |
Identificador interno del valor de opción. Opcional en caso que se use identificador público. | |||
prices/optionValue/pId | Opcional | string | |
Identificador público del valor de opción. Opcional en caso que se use identificador interno. | |||
prices/retailPrice | Opcional | numeric | |
Precio del producto cuando está en oferta. El precio se especifica sin impuestos añadidos. |
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 426,
"ID" : 843,
"OPTIONVALUE": {
"ID" : 1657,
"PID" :""
},
"RETAILPRICE" : 12
}
DELETE /products/{id}/definitions/{definitionId}/prices
Descripción
Elimina el precio de una personalización determinada del producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/definitions/{definitionId}/prices
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. | |||
definitionId | Obligatorio | numeric | |
Indentificador interno de la personalización. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"PRICES": [
]
}
GET /products/{id}/definitions/{definitionId}/properties
Descripción
Devuelve las propiedades de una personalización determinada del producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/definitions/{definitionId}/properties
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. | |||
definitionId | Obligatorio | numeric | |
Indentificador interno de la personalización. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"AVAILABILITY": {
"ID" : 0,
"PID" :""
},
"AVAILABLEDATE" :"2014-04-08T02:00:00+02:00",
"BACKORDER" : 1,
"COSTPRICE" : 0,
"DISPLAY" : true,
"ENDHIGHLIGHTDATE" :"2014-04-08T02:00:00+02:00",
"ENDOFFERDATE" :"",
"GROUPQUANTITYBYOPTIONS" : false,
"HIGHLIGHT" : false,
"MAXORDERQUANTITY" : 0,
"MINORDERQUANTITY" : 0,
"MULTIPLEACTSOVER" : 0,
"MULTIPLEORDERQUANTITY" : 0,
"NORETURN" : false,
"ONREQUEST" : true,
"ONREQUESTDAYS" : 3,
"PRIORITY" : 0,
"SALE" : true,
"SHOWDISCOUNTS" : true,
"SHOWORDERBOX" : true,
"SHOWPRICE" : true,
"STARTOFFERDATE" :"",
"STOCKMANAGEMENT" : true
}
POST /products/{id}/definitions/{definitionId}/properties
Descripción
Asignación de propiedades a una personalización determinada del producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/definitions/{definitionId}/properties
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. | |||
definitionId | Obligatorio | numeric | |
Indentificador interno de la personalización. |
Parámetros de entrada JSON
{ "properties": { "availability": { "id":numeric, "pId":string }, "backOrder":any, "active": boolean "availableDate": datetime "costPrice": numeric "endHighlightDate": datetime "endOfferDate": datetime "exclusiveLinked": boolean "groupQuantityByOptions": boolean "highlight": boolean "maxOrderQuantity": numeric "minOrderQuantity": numeric "multipleActsOver": numeric "multipleOrderQuantity": numeric "noReturn": boolean "onRequest": boolean "onRequestDays": numeric "percentPrice": numeric "percentPriceOverrideCustomPrices": boolean "priority": numeric "publicationDate": datetime "sale": boolean "showBasePrice": boolean "showDiscounts": boolean "showOrderBox": boolean "showPrice": boolean "startOfferDate": datetime "stockManagement": boolean "useRetailPrice": boolean } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
properties | Obligatorio | struct | |
Bloque con las propiedades de la personalización del producto. | |||
properties/active | Opcional | true | boolean |
Define si el producto es visible. | |||
properties/availability | Opcional | struct | |
Bloque de información sobre disponibilidad de productos. | |||
properties/availability/id | Opcional | 0 | numeric |
Identificador interno de la disponibilidad de productos. Opcional en caso que se use identificador público. | |||
properties/availability/pId | Opcional | string | |
Identificador público de la disponibilidad de productos. Opcional en caso que se use identificador interno. | |||
properties/availableDate | Opcional | CURRENT_TIMESTAMP | datetime |
Fecha a partir de la cual está disponible el producto. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
properties/backOrder | Opcional | any | |
Indica si se permite realizar reservas del producto, o sea, comprar cuando no se tiene stock y el control de stock está activo. Valores permitidos: 0 - Reservas deshabilitadas, 1 - Reservas permitidas siempre, 2* - Reservas permitidas con previsión, 3* - Reservas permitidas sin previsión (* Estos valores necesitan tener contratadas las previsiones de reserva para poder utilizarse) | |||
properties/costPrice | Opcional | 0 | numeric |
Indica el precio de coste del producto. Su uso es solo a nivel informativo. | |||
properties/endHighlightDate | Opcional | datetime | |
Fecha de fin de novedad. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
properties/endOfferDate | Opcional | datetime | |
Fecha de fin de oferta. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
properties/exclusiveLinked | Opcional | false | boolean |
properties/groupQuantityByOptions | Opcional | false | boolean |
Define si para el control de cantidades de compra del producto se suman las cantidades de todas las opciones compradas o si se cuentan por separado. | |||
properties/highlight | Opcional | false | boolean |
Indica si el producto es una novedad. | |||
properties/maxOrderQuantity | Opcional | 0 | numeric |
Define la cantidad máxima que se puede comprar del producto en un mismo pedido. 0 para ignorar. | |||
properties/minOrderQuantity | Opcional | 0 | numeric |
Define la cantidad mínima que se debe comprar del producto en un mismo pedido. 0 para ignorar. | |||
properties/multipleActsOver | Opcional | 0 | numeric |
Define el número de unidades a partir del cual los múltiples de compra actuarán. 0 para ignorar. | |||
properties/multipleOrderQuantity | Opcional | 0 | numeric |
Define el múltiplo de unidades del producto al comprar. 0 para ignorar. | |||
properties/noReturn | Opcional | false | boolean |
Indica si se prohibe la devolución. Valores permitidos: false - No prohibir, true - Prohibir | |||
properties/onRequest | Opcional | false | boolean |
Indica si el producto es de tipo 'bajo demanda'. Un producto de este tipo puede ser comprado aunque se tenga la gestión de stock activa y de él no quede stock suficiente. En tal caso se considerará que el producto ha sido comprado 'bajo demanda' para aquellas unidades para las que no haya stock suficiente. Una condición adicional para que un producto de este tipo pueda ser comprado 'bajo demana' es que tenga al menos una línea de stock configurada. Si esta característica se activa, será desactivará automáticamente la característica de 'reserva' del producto. | |||
properties/onRequestDays | Opcional | 0 | numeric |
Indica cuantos días se necesitan para preparar el producto en el caso que éste sea comprado 'bajo demanda'. Esta información se utiliza para mostrar una fecha estimada de salida en este caso. | |||
properties/percentPrice | Opcional | numeric | |
Indica el valor del porcentaje que se usará para calcular el precio final de un producto. Puede ser positivo (incremento) o negativo (descuento). | |||
properties/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. | |||
properties/priority | Obligatorio | numeric | |
Define el orden de presentación del producto en relación al resto de productos que se encuentran en su mismo nivel. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
properties/publicationDate | Opcional | CURRENT_TIMESTAMP | datetime |
Fecha de publicación del producto. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
properties/sale | Opcional | false | boolean |
Indica si el producto está en oferta. | |||
properties/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'. | |||
properties/showDiscounts | Opcional | true | boolean |
Indica si se muestran los posibles descuentos que pueden afectar al producto. | |||
properties/showOrderBox | Opcional | true | boolean |
Indica si se muestra el input para introducir la cantidad de unidades a comprar. | |||
properties/showPrice | Opcional | true | boolean |
Indica si se muestra el precio del producto. | |||
properties/startOfferDate | Opcional | datetime | |
Fecha de inicio de oferta. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
properties/stockManagement | Opcional | true | boolean |
Define si el producto mantiene y controla la cantidad de stock. Aunque se active el control de stock mediante esta propiedad, si la configuración general no lo tiene activado, el control no se tendrá en cuenta. | |||
properties/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
{
"AVAILABILITY": {
"ID" : 0,
"PID" :""
},
"AVAILABLEDATE" :"2014-04-08T02:00:00+02:00",
"BACKORDER" : 1,
"COSTPRICE" : 0,
"DISPLAY" : true,
"ENDHIGHLIGHTDATE" :"2014-04-08T02:00:00+02:00",
"ENDOFFERDATE" :"",
"GROUPQUANTITYBYOPTIONS" : false,
"HIGHLIGHT" : false,
"MAXORDERQUANTITY" : 0,
"MINORDERQUANTITY" : 0,
"MULTIPLEACTSOVER" : 0,
"MULTIPLEORDERQUANTITY" : 0,
"NORETURN" : false,
"ONREQUEST" : true,
"ONREQUESTDAYS" : 3,
"PRIORITY" : 0,
"SALE" : true,
"SHOWDISCOUNTS" : true,
"SHOWORDERBOX" : true,
"SHOWPRICE" : true,
"STARTOFFERDATE" :"",
"STOCKMANAGEMENT" : true
}
PUT /products/{id}/definitions/{definitionId}/properties
Descripción
Edición de las propiedades de una personalización determinada del producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/definitions/{definitionId}/properties
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. | |||
definitionId | Obligatorio | numeric | |
Indentificador interno de la personalización. |
Parámetros de entrada JSON
{ "properties": { "availability": { "id":numeric, "pId":string }, "availableDate":datetime, "backOrder":any, "costPrice":numeric, "endHighlightDate":datetime, "groupQuantityByOptions":boolean, "maxOrderQuantity":numeric, "minOrderQuantity":numeric, "multipleActsOver":numeric, "multipleOrderQuantity":numeric, "priority":numeric, "active": boolean "endOfferDate": datetime "exclusiveLinked": boolean "highlight": boolean "noReturn": boolean "onRequest": boolean "onRequestDays": numeric "percentPrice": numeric "percentPriceOverrideCustomPrices": boolean "publicationDate": datetime "sale": boolean "showBasePrice": boolean "showDiscounts": boolean "showOrderBox": boolean "showPrice": boolean "startOfferDate": datetime "stockManagement": boolean "useRetailPrice": boolean } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
properties | Obligatorio | struct | |
Bloque con las propiedades de la personalización del producto. | |||
properties/active | Opcional | true | boolean |
Define si el producto es visible. | |||
properties/availability | Opcional | struct | |
Bloque de información sobre disponibilidad de productos. | |||
properties/availability/id | Opcional | 0 | numeric |
Identificador interno de la disponibilidad de productos. Opcional en caso que se use identificador público. | |||
properties/availability/pId | Opcional | string | |
Identificador público de la disponibilidad de productos. Opcional en caso que se use identificador interno. | |||
properties/availableDate | Opcional | CURRENT_TIMESTAMP | datetime |
Fecha a partir de la cual está disponible el producto. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
properties/backOrder | Opcional | any | |
Indica si se permite realizar reservas del producto, o sea, comprar cuando no se tiene stock y el control de stock está activo. Valores permitidos: 0 - Reservas deshabilitadas, 1 - Reservas permitidas siempre, 2* - Reservas permitidas con previsión, 3* - Reservas permitidas sin previsión (* Estos valores necesitan tener contratadas las previsiones de reserva para poder utilizarse) | |||
properties/costPrice | Opcional | 0 | numeric |
Indica el precio de coste del producto. Su uso es solo a nivel informativo. | |||
properties/endHighlightDate | Opcional | datetime | |
Fecha de fin de novedad. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
properties/endOfferDate | Opcional | datetime | |
Fecha de fin de oferta. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
properties/exclusiveLinked | Opcional | false | boolean |
properties/groupQuantityByOptions | Opcional | false | boolean |
Define si para el control de cantidades de compra del producto se suman las cantidades de todas las opciones compradas o si se cuentan por separado. | |||
properties/highlight | Opcional | false | boolean |
Indica si el producto es una novedad. | |||
properties/maxOrderQuantity | Opcional | 0 | numeric |
Define la cantidad máxima que se puede comprar del producto en un mismo pedido. 0 para ignorar. | |||
properties/minOrderQuantity | Opcional | 0 | numeric |
Define la cantidad mínima que se debe comprar del producto en un mismo pedido. 0 para ignorar. | |||
properties/multipleActsOver | Opcional | 0 | numeric |
Define el número de unidades a partir del cual los múltiples de compra actuarán. 0 para ignorar. | |||
properties/multipleOrderQuantity | Opcional | 0 | numeric |
Define el múltiplo de unidades del producto al comprar. 0 para ignorar. | |||
properties/noReturn | Opcional | false | boolean |
Indica si se prohibe la devolución. Valores permitidos: false - No prohibir, true - Prohibir | |||
properties/onRequest | Opcional | false | boolean |
Indica si el producto es de tipo 'bajo demanda'. Un producto de este tipo puede ser comprado aunque se tenga la gestión de stock activa y de él no quede stock suficiente. En tal caso se considerará que el producto ha sido comprado 'bajo demanda' para aquellas unidades para las que no haya stock suficiente. Una condición adicional para que un producto de este tipo pueda ser comprado 'bajo demana' es que tenga al menos una línea de stock configurada. Si esta característica se activa, será desactivará automáticamente la característica de 'reserva' del producto. | |||
properties/onRequestDays | Opcional | 0 | numeric |
Indica cuantos días se necesitan para preparar el producto en el caso que éste sea comprado 'bajo demanda'. Esta información se utiliza para mostrar una fecha estimada de salida en este caso. | |||
properties/percentPrice | Opcional | numeric | |
Indica el valor del porcentaje que se usará para calcular el precio final de un producto. Puede ser positivo (incremento) o negativo (descuento). | |||
properties/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. | |||
properties/priority | Opcional | numeric | |
Define el orden de presentación del producto en relación al resto de productos que se encuentran en su mismo nivel. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
properties/publicationDate | Opcional | CURRENT_TIMESTAMP | datetime |
Fecha de publicación del producto. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
properties/sale | Opcional | false | boolean |
Indica si el producto está en oferta. | |||
properties/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'. | |||
properties/showDiscounts | Opcional | true | boolean |
Indica si se muestran los posibles descuentos que pueden afectar al producto. | |||
properties/showOrderBox | Opcional | true | boolean |
Indica si se muestra el input para introducir la cantidad de unidades a comprar. | |||
properties/showPrice | Opcional | true | boolean |
Indica si se muestra el precio del producto. | |||
properties/startOfferDate | Opcional | datetime | |
Fecha de inicio de oferta. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
properties/stockManagement | Opcional | true | boolean |
Define si el producto mantiene y controla la cantidad de stock. Aunque se active el control de stock mediante esta propiedad, si la configuración general no lo tiene activado, el control no se tendrá en cuenta. | |||
properties/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
{
"AVAILABILITY": {
"ID" : 0,
"PID" :""
},
"AVAILABLEDATE" :"2014-04-08T02:00:00+02:00",
"BACKORDER" : 1,
"COSTPRICE" : 0,
"DISPLAY" : true,
"ENDHIGHLIGHTDATE" :"2014-04-08T02:00:00+02:00",
"ENDOFFERDATE" :"",
"GROUPQUANTITYBYOPTIONS" : false,
"HIGHLIGHT" : false,
"MAXORDERQUANTITY" : 0,
"MINORDERQUANTITY" : 0,
"MULTIPLEACTSOVER" : 0,
"MULTIPLEORDERQUANTITY" : 0,
"NORETURN" : false,
"ONREQUEST" : true,
"ONREQUESTDAYS" : 3,
"PRIORITY" : 0,
"SALE" : true,
"SHOWDISCOUNTS" : true,
"SHOWORDERBOX" : true,
"SHOWPRICE" : true,
"STARTOFFERDATE" :"",
"STOCKMANAGEMENT" : true
}
DELETE /products/{id}/definitions/{definitionId}/properties
Descripción
Elimina las propiedades de una personalización determinada del producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/definitions/{definitionId}/properties
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. | |||
definitionId | Obligatorio | numeric | |
Indentificador interno de la personalización. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
}
PUT /products/{id}/hide
Descripción
Desactiva (oculta) el producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/hide
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACTIVE" : true,
"ID" : 1,
"PID" :"abc"
}
GET /products/{id}/options
Descripción
Devuelve las opciones del producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/options
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"OPTIONS": [
{
"ACTIVE" : true,
"COMBINABLE" : false,
"FILTERABLE" : true,
"ID" : 14789,
"IMAGE" :"",
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"NAME" :"",
"PROMPT" :""
}
],
"MAXVALUES" :null,
"MINVALUES" :null,
"PID" :"color",
"PRIORITY" : 3,
"REQUIRED" : true,
"SHOWASGRID" : false,
"TYPOLOGY" : 1,
"UNIQUEPRICE" : true,
"VALUES": [
{
"ACTIVE" : true,
"ID" : 1,
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"LONGDESCRIPTION" :"Size XL long description",
"SEARCHVALUE" :"XL",
"SHORTDESCRIPTION" :"Size XL short description",
"VALUE" :"XL"
}
],
"LARGEIMAGE" :"b.jpg",
"PID" :"abc",
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 2,
"ID" : 843,
"RETAILPRICE" : 12
}
],
"PRIORITY" : 1,
"SKU" :"sku",
"SMALLIMAGE" :"a.jpg",
"WEIGHT" : 6
}
],
"VALUETYPE" : 1
}
]
}
POST /products/{id}/options
Descripción
Creación de una opción para el producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/options
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
Parámetros de entrada JSON
{ "options": { "affectsStock":boolean, "combinable":boolean, "languages": [ { "languageCode":string, "name":string, "prompt": string } ], "maxValues":numeric, "minValues":numeric, "pId":string, "showAsGrid":boolean, "showPrice":, "typology":numeric, "valueType":numeric, "values": [ { "languages": [ { "languageCode":string, "value":string, "longDescription": string "searchValue": string "shortDescription": string } ], "noReturn":boolean, "pId":string, "prices": [ { "basePrice":numeric, "currencies": [ { "currencyCode":currency, "basePrice": numeric "retailPrice": numeric } ], "fromQuantity":numeric, "retailPrice": numeric } ], "weight":numeric, "active": boolean "largeImage": string "priority": numeric "smallImage": string } ], "active": boolean "filterable": boolean "image": string "priority": numeric "required": boolean "uniquePrice": boolean } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
options | Obligatorio | struct | |
En este bloque podemos definir las opciones del producto. Las opciones son variaciones del producto, como talla o color. | |||
options/active | Opcional | true | boolean |
Define si la opción esta activada. | |||
options/affectsStock | Opcional | true | boolean |
DEPRECATED: debe usarse combinable en su lugar. Indica si la opción interviene en el stock por combinaciones de valores de opción. | |||
options/combinable | Opcional | true | boolean |
Indica si los valores de esta opción se usarán para generar combinaciones de opciones. Importante: es necesario pasar este parámetro con valor true si se necesita añadir stock por combinaciones de valores de opción. | |||
options/filterable | Opcional | false | boolean |
Indica si la opción permite que sus valores sean filtrables en la tienda. | |||
options/image | Opcional | string | |
Define una imagen específica para la opción. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
options/languages | Opcional | array [0:n] | |
Bloque con información variable según el idioma. | |||
options/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. | |||
options/languages/name | Obligatorio | string | |
Define el nombre de la opción para el idioma seleccionado. | |||
options/languages/prompt | Opcional | string | |
Define el título de la opción para el idioma seleccionado. Texto que aparece junto al selector de valores. | |||
options/maxValues | Opcional | 0 | numeric |
Número de ficheros adjuntos que como máximo se admitirán (en blanco implica que no habrá límite mínimo). Solo si valueType=10. | |||
options/minValues | Opcional | 0 | numeric |
Número de ficheros adjuntos que como mínimo se admitirán (en blanco implica que no habrá límite mínimo). Solo si valueType=10. | |||
options/pId | Obligatorio | string | |
Identificador público de la opción. | |||
options/priority | Opcional | 0 | numeric |
Define el orden de presentación de esta opción en relación al resto de opciones de este mismo producto. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
options/required | Opcional | true | boolean |
Define si la opción es obligatoria. | |||
options/showAsGrid | Opcional | false | boolean |
Indica si la opción se debe mostrar como cuadro de compra múltiple en forma de rejilla. Solo es posible si hay dos opciones en el producto. No incluya esta etiqueta a no ser que se lo pidan desde Trilogi. | |||
options/showPrice | Opcional | false | |
Define si se muestra el precio o no. | |||
options/typology | Opcional | 0 | numeric |
Define el tipo de opción (tipología). Valores permitidos: 1 - Talla, 2 - Color, 3 - Material, 9999 - Otros. Si no se pasa este parámetro, la opción queda sin tipología. | |||
options/uniquePrice | Opcional | false | boolean |
Indica si independientemente de las unidades que se compre del producto, el precio de la opción se aplicará solamente una vez. No incluya esta etiqueta a no ser que se lo pidan desde Trilogi. | |||
options/valueType | Opcional | 7 | numeric |
Define el tipo de opción. Valores permitidos: 1 - Sí/No, 2 - Texto corto, 3 - Marca única, 4 - Marca Múltiple, 5 - Marca única con imagen, 6 - Marca múltiple con imagen, 7 - Desplegable, 8 - Fecha/Hora, 9 - Texto largo, 10 - Adjunto. | |||
options/values | Opcional | array [0:n] | |
Bloque con los distintos valores que tiene la opción. Contiene la definición de todos los valores. | |||
options/values/active | Opcional | true | boolean |
Define si el valor de opción esta activo. | |||
options/values/languages | Opcional | array [0:n] | |
Bloque con información variable según el idioma. | |||
options/values/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. | |||
options/values/languages/longDescription | Opcional | string | |
Define la descripción corta del valor de opción para el idioma seleccionado. | |||
options/values/languages/searchValue | Opcional | string | |
Define el valor de búsqueda del valor de opción para el idioma seleccionado. Si no se especifica se usa el propio valor. | |||
options/values/languages/shortDescription | Opcional | string | |
Define la descripción corta del valor de opción para el idioma seleccionado. | |||
options/values/languages/value | Obligatorio | string | |
Define el valor de opción para el idioma seleccionado. | |||
options/values/largeImage | Opcional | string | |
Información de la imagen del valor en su versión grande. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
options/values/noReturn | Opcional | false | boolean |
Indica si se prohibe la devolución. Valores permitidos: false - No prohibir, true - Prohibir | |||
options/values/pId | Opcional | string | |
Identificador público del valor de la opción. | |||
options/values/prices | Opcional | array [0:n] | |
Bloque con información de los precios del producto para el valor de opción. | |||
options/values/prices/basePrice | Obligatorio | numeric | |
Define un incremento de importe sobre el precio del producto. | |||
options/values/prices/currencies | Opcional | array [0:n] | |
Bloque con información de los precios del producto para el valor de opción en monedas adicionales vinculadas al eCommerce. | |||
options/values/prices/currencies/basePrice | Obligatorio | numeric | |
Define un incremento de importe sobre el precio del producto. | |||
options/values/prices/currencies/currencyCode | Obligatorio | currency | |
Código de la moneda en formato ISO 4217. | |||
options/values/prices/currencies/retailPrice | Opcional | numeric | |
Define un incremento de importe sobre el precio de oferta del producto. | |||
options/values/prices/fromQuantity | Opcional | 1 | numeric |
Cuando se define, indica que el bloque de precios es por cantidad (de unidades compradas). Indica la cantidad del intervalo a partir de la cual se aplican los nuevos precios. Debe ser superior a 1 y a la cantidad del intervalo anterior. No es necesario si el eCommerce no tiene activado Precios por cantidad. | |||
options/values/prices/retailPrice | Opcional | numeric | |
Define un incremento de importe sobre el precio de oferta del producto. | |||
options/values/priority | Opcional | 0 | numeric |
Define el orden de presentación de este valor de opción en relación al resto de valores de esta misma opción en este mismo producto. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
options/values/smallImage | Opcional | string | |
Información de la imagen del valor en su versión pequeña. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
options/values/weight | Opcional | 0 | numeric |
Define un incremento de peso sobre el peso base del producto. |
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"ACTIVE" : true,
"COMBINABLE" : false,
"FILTERABLE" : true,
"ID" : 14789,
"IMAGE" :"",
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"NAME" :"",
"PROMPT" :""
}
],
"MAXVALUES" :null,
"MINVALUES" :null,
"PID" :"color",
"PRIORITY" : 3,
"REQUIRED" : true,
"SHOWASGRID" : false,
"TYPOLOGY" : 1,
"UNIQUEPRICE" : true,
"VALUES": [
{
"ACTIVE" : true,
"ID" : 1,
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"LONGDESCRIPTION" :"Size XL long description",
"SEARCHVALUE" :"XL",
"SHORTDESCRIPTION" :"Size XL short description",
"VALUE" :"XL"
}
],
"LARGEIMAGE" :"b.jpg",
"PID" :"abc",
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 2,
"ID" : 843,
"RETAILPRICE" : 12
}
],
"PRIORITY" : 1,
"SKU" :"sku",
"SMALLIMAGE" :"a.jpg",
"WEIGHT" : 6
}
],
"VALUETYPE" : 1
}
DELETE /products/{id}/options
Descripción
Elimina todas las opciones del producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/options
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"OPTIONS": [
]
}
GET /products/{id}/priceLists
Descripción
Devuelve todos los precios de tarifa del producto indicado. La combinación de campos devueltos dependen del tipo de registro de precios, por lo que hay que tener en cuenta esta particularidad a la hora de analizar y tratar la respuesta. Más información en el recurso POST / products/{id}/priceLists/{priceListId}/prices.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/priceLists
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"PRICELISTS": [
{
"PRICELIST": {
"ID" : 123,
"PID" :"abc"
},
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 426,
"ID" : 843,
"OPTIONVALUE": {
"ID" : 1657,
"PID" :""
},
"RETAILPRICE" : 12
}
]
}
]
}
DELETE /products/{id}/priceLists
Descripción
Elimina todos los precios de tarifa del producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/priceLists
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"PRICELISTS": [
]
}
GET /products/{id}/priceLists/{priceListId}/prices
Descripción
Devuelve los precios de una tarifa determinada del producto indicado. Los campos devueltos dependen del tipo de registro de precios, por lo que hay que tener en cuenta esta particularidad a la hora de analizar y tratar la respuesta. Más información en el recurso POST / products/{id}/priceLists/{priceListId}/prices.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/priceLists/{priceListId}/prices
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. | |||
priceListId | Obligatorio | numeric | |
Identificador interno de la tarifa. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 426,
"ID" : 843,
"OPTIONVALUE": {
"ID" : 1657,
"PID" :""
},
"RETAILPRICE" : 12
}
]
}
POST /products/{id}/priceLists/{priceListId}/prices
Descripción
Asignación de precios a una tarifa determinada del producto indicado. Permite especificar, para esa tarifa, tanto los precios base como los de valor de opción. Si además se define fromQuantity, se indica que el precio es por cantidad (de unidades compradas).
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/priceLists/{priceListId}/prices
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. | |||
priceListId | Obligatorio | numeric | |
Identificador interno de la tarifa. |
Parámetros de entrada JSON
{ "prices": { "basePrice":numeric, "currencies": [ { "currencyCode":currency, "basePrice": numeric "retailPrice": numeric } ], "fromQuantity":numeric, "optionValue": { "id":numeric, "pId":string }, "retailPrice":numeric } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
prices | Obligatorio | struct | |
Bloque con información de los precios del producto para la tarifa. | |||
prices/basePrice | Obligatorio | numeric | |
Precio del producto. El precio se especifica sin impuestos añadidos. | |||
prices/currencies | Opcional | array [0:n] | |
Bloque con información de los precios del producto en monedas adicionales vinculadas al eCommerce. | |||
prices/currencies/basePrice | Obligatorio | numeric | |
Precio del producto. El precio se especifica sin impuestos añadidos. | |||
prices/currencies/currencyCode | Obligatorio | currency | |
Código de la moneda en formato ISO 4217. | |||
prices/currencies/retailPrice | Opcional | numeric | |
Precio del producto cuando está en oferta. El precio se especifica sin impuestos añadidos. | |||
prices/fromQuantity | Opcional | 1 | numeric |
Cuando se define, indica que el bloque de precios es por cantidad (de unidades compradas). Indica la cantidad del intervalo a partir de la cual se aplican los nuevos precios. Debe ser superior a 1 y a la cantidad del intervalo anterior. No es necesario si el eCommerce no tiene activado Precios por cantidad. | |||
prices/optionValue | Opcional | struct | |
Bloque de información del valor de una opción. Indica que el bloque de precios es para un valor de opción. Si se define, la información de precios del bloque se asignará al valor de opción indicado. | |||
prices/optionValue/id | Opcional | 0 | numeric |
Identificador interno del valor de opción. Opcional en caso que se use identificador público. | |||
prices/optionValue/pId | Opcional | string | |
Identificador público del valor de opción. Opcional en caso que se use identificador interno. | |||
prices/retailPrice | Opcional | numeric | |
Precio del producto cuando está en oferta. El precio se especifica sin impuestos añadidos. |
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 426,
"ID" : 843,
"OPTIONVALUE": {
"ID" : 1657,
"PID" :""
},
"RETAILPRICE" : 12
}
DELETE /products/{id}/priceLists/{priceListId}/prices
Descripción
Elimina los precios de una tarifa determinada del producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/priceLists/{priceListId}/prices
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. | |||
priceListId | Obligatorio | numeric | |
Identificador interno de la tarifa. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"PRICES": [
]
}
GET /products/{id}/prices
Descripción
Devuelve los precios del producto indicado. La combinación de campos devueltos dependen del tipo de registro de precios, por lo que hay que tener en cuenta esta particularidad a la hora de analizar y tratar la respuesta. Más información en el recurso POST / products/{id}/prices.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/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": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 426,
"ID" : 843,
"OPTIONVALUE": {
"ID" : 1657,
"PID" :""
},
"RETAILPRICE" : 12
}
]
}
POST /products/{id}/prices
Descripción
Asignación de precios al producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/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": { "basePrice":numeric, "currencies": [ { "currencyCode":currency, "retailPrice":numeric, "basePrice": numeric } ], "fromQuantity":numeric, "retailPrice":numeric } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
prices | Obligatorio | struct | |
Bloque con información de los precios del producto. | |||
prices/basePrice | Obligatorio | numeric | |
Precio del producto. El precio se especifica sin impuestos añadidos. | |||
prices/currencies | Opcional | array [0:n] | |
Bloque con información de los precios del producto en monedas adicionales vinculadas al eCommerce. | |||
prices/currencies/basePrice | Obligatorio | numeric | |
Precio del producto. El precio se especifica sin impuestos añadidos. | |||
prices/currencies/currencyCode | Obligatorio | currency | |
Código de la moneda en formato ISO 4217. | |||
prices/currencies/retailPrice | Opcional | numeric | |
Precio del producto cuando está en oferta. El precio se especifica sin impuestos añadidos. | |||
prices/fromQuantity | Opcional | 1 | numeric |
Cuando se define, indica que el bloque de precios es por cantidad (de unidades compradas). Indica la cantidad del intervalo a partir de la cual se aplican los nuevos precios. Debe ser superior a 1 y a la cantidad del intervalo anterior. No es necesario si el eCommerce no tiene activado Precios por cantidad. | |||
prices/retailPrice | Opcional | numeric | |
Precio del producto cuando está en oferta. El precio se especifica sin impuestos añadidos. |
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 426,
"ID" : 843,
"OPTIONVALUE": {
"ID" : 1657,
"PID" :""
},
"RETAILPRICE" : 12
}
]
}
DELETE /products/{id}/prices
Descripción
Elimina los precios del producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/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 /products/{id}/shippingTypes
Descripción
Obtiene las asignaciones de tipos de transporte para el producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/shippingTypes
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"SHIPPINGTYPES": [
{
"ID" : 123,
"PID" :"ShippingType1"
}
]
}
POST /products/{id}/shippingTypes
Descripción
Asignación de tipo de transporte para el producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/shippingTypes
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
Parámetros de entrada JSON
{ "shippingTypes": { "id":, "pId":string } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
shippingTypes | Obligatorio | struct | |
Bloque para especificar tipos de transporte. | |||
shippingTypes/id | Opcional | 0 | |
Identificador interno del tipo de transporte.br>Opcional en caso que se use identificador público. | |||
shippingTypes/pId | Opcional | string | |
Identificador público del tipo de transporte. Opcional en caso que se use identificador interno. |
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"ID" : 123,
"PID" :"ShippingType1"
}
DELETE /products/{id}/shippingTypes
Descripción
Elimina todas las asignaciones de tipos de transporte para el producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/shippingTypes
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"SHIPPINGTYPES": [
]
}
DELETE /products/{id}/shippingTypes/{shippingTypeId}
Descripción
Elimina la asignación del tipos de transporte con el identificador indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/shippingTypes/{shippingTypeId}
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. | |||
shippingTypeId | Obligatorio | numeric | |
Identificador interno del tipo de transporte. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 123
}
PUT /products/{id}/show
Descripción
Activa (hace visible) el producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/show
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACTIVE" : true,
"ID" : 1,
"PID" :"abc"
}
GET /products/{id}/stocks
Descripción
Devuelve el stock del producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/stocks
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"STOCKS": [
{
"BACKORDERPREVISION": [
{
"ID" : 134646,
"INCOMINGDATE" :"2015-04-03",
"PID" :"sdfsdf",
"STOCK" : 230
}
],
"COMBINATION": {
"PID" :"combination M"
},
"ID" : 16534,
"PREVISION": [
{
"ID" : 134646,
"INCOMINGDATE" :"2015-04-03",
"PID" :"sdfsdf",
"STOCK" : 230
}
],
"STOCK" : 555,
"WAREHOUSE": {
"ID" : 1,
"PID" :"abc"
}
}
]
}
POST /products/{id}/stocks
Descripción
Asignación de stock al producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/stocks
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
Parámetros de entrada JSON
{ "stock": { "combination": { "pId":string }, "pId":string, "prevision": [ { "incomingDate":date, "pId":string, "previsionType":numeric, "stock": numeric } ], "warehouse": { "id":, "pId":string }, "stock": numeric } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
stock | Obligatorio | struct | |
Bloque con información del stock del producto. Este bloque solo tiene sentido si el producto tiene stockManagement=true. | |||
stock/combination | Obligatorio | struct | |
Bloque con información del pId de la combinación. | |||
stock/combination/pId | Obligatorio | string | |
Identificador público de la combinación a la que se le quiere asignar el stock. | |||
stock/pId | Opcional | string | |
Identificador público del stock. | |||
stock/prevision | Opcional | array [0:n] | |
Bloque de información sobre la provisión de stock. | |||
stock/prevision/incomingDate | Obligatorio | date | |
Define la fecha de la provisión de stock. Debe estar en formato ISO 8601 (YYYY-MM-DD). | |||
stock/prevision/pId | Obligatorio | string | |
Identificador público de la provisión de stock. | |||
stock/prevision/previsionType | Opcional | 1 | numeric |
Indica el tipo de la previsión. Valores permitidos: 1 - Previsión de stock, 2 - Previsión de reserva | |||
stock/prevision/stock | Obligatorio | numeric | |
Cantidad entera de unidades en stock. | |||
stock/stock | Opcional | 0 | numeric |
Cantidad entera de unidades en stock. | |||
stock/warehouse | Obligatorio | struct | |
Bloque de información del almacén al que se modifica el stock. | |||
stock/warehouse/id | Opcional | 0 | |
Identificador interno del almacén. Opcional en caso que se use identificador público. | |||
stock/warehouse/pId | Opcional | string | |
Identificador público del almacén. Opcional en caso que se use identificador interno. |
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"BACKORDERPREVISION": [
{
"ID" : 134646,
"INCOMINGDATE" :"2015-04-03",
"PID" :"sdfsdf",
"STOCK" : 230
}
],
"COMBINATION": {
"PID" :"combination M"
},
"ID" : 16534,
"PREVISION": [
{
"ID" : 134646,
"INCOMINGDATE" :"2015-04-03",
"PID" :"sdfsdf",
"STOCK" : 230
}
],
"STOCK" : 555,
"WAREHOUSE": {
"ID" : 1,
"PID" :"abc"
}
}
DELETE /products/{id}/stocks
Descripción
Elimina todo el stock del producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/1/stocks
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"STOCKS": [
]
}
GET /products/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/products/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 /products/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/products/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 /products/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/products/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" : 23535
}
GET /products/additionalImages/{id}
Descripción
Devuelve la imagen adicional indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/additionalImages/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" : 375356,
"LANGUAGES": [
{
"ALT" :"Image 1",
"LANGUAGE" :"ES"
}
],
"LARGEIMAGE" :"large.jpg",
"PRIORITY" : 1,
"SMALLIMAGE" :"small.jpg"
}
PUT /products/additionalImages/{id}
Descripción
Edición de la imagen adicional indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/additionalImages/1
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
Parámetros de entrada JSON
{ "additionalImages": { "languages": [ { "languageCode":string, "alt": string } ], "largeImage":string, "smallImage":string, "priority": numeric } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
additionalImages | Obligatorio | struct | |
Bloque con información de las imágenes adicionales del producto. | |||
additionalImages/languages | Opcional | array [0:n] | |
Bloque con información variable según el idioma. | |||
additionalImages/languages/alt | Opcional | string | |
Palabras clave de las imágenes adicionales del producto para el idioma seleccionado. Separadas por coma ','. | |||
additionalImages/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. | |||
additionalImages/largeImage | Opcional | string | |
Información de la imagen adicional del producto en su versión grande. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
additionalImages/priority | Opcional | numeric | |
Define el orden de presentación de esta imagen adicional en relación al resto de adicionales que se encuentran en su mismo nivel. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
additionalImages/smallImage | Opcional | string | |
Información de la imagen adicional del producto en su versión pequeña. Se debe indicar la ruta (relativa si es propia) de la imagen. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 375356,
"LANGUAGES": [
{
"ALT" :"Image 1",
"LANGUAGE" :"ES"
}
],
"LARGEIMAGE" :"large.jpg",
"PRIORITY" : 1,
"SMALLIMAGE" :"small.jpg"
}
DELETE /products/additionalImages/{id}
Descripción
Desasigna la imagen adicional indicada. Este recurso no borra el archivo, solo desvincula la imagen.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/additionalImages/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
}
GET /products/combinations/{id}
Descripción
Devuelve información sobre las combinaciones de valores de opción.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/combinations/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
{
"EAN" :"ssss",
"ID" : 16534,
"ISBN" :"sdgddfkjs",
"JAN" :"stets",
"OPTIONSVALUES": [
{
"ID" : 1,
"PID" :"abc"
},
{
"ID" : 2,
"PID" :"cdf"
}
],
"PID" :"aas",
"SKU" :"sssddd",
"UPC" :"sasdasss"
}
PUT /products/combinations/{id}
Descripción
Edición de la combinación de valores de opción indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/combinations/1
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
Parámetros de entrada JSON
{ "combinations": { "ean":string, "isbn":string, "jan":string, "pId":string, "sku":string, "upc":string } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
combinations | Obligatorio | struct | |
Bloque de información sobre las combinaciones de valores de opción que puede tener un producto. Solo estas combinaciones podrán asociarse a stock. | |||
combinations/ean | Opcional | string | |
Número de artículo europeo (EAN), también llamado GTIN-13. | |||
combinations/isbn | Opcional | string | |
Número internacional normalizado del libro (ISBN). | |||
combinations/jan | Opcional | string | |
Número de artículo japonés (JAN), también llamado GTIN-13. | |||
combinations/pId | Opcional | string | |
Identificador público de la combinación. Este ID se usa también como identificador público de la línea de stock que contiene el número de unidades disponibles (stock) para esa combinación. | |||
combinations/sku | Opcional | string | |
Define una referencia para la combinación de valores de opción. | |||
combinations/upc | Opcional | string | |
Código de producto universal (UPC), también llamado GTIN-12 y UPC-A. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"EAN" :"ssss",
"ID" : 16534,
"ISBN" :"sdgddfkjs",
"JAN" :"stets",
"OPTIONSVALUES": [
{
"ID" : 1,
"PID" :"abc"
},
{
"ID" : 2,
"PID" :"cdf"
}
],
"PID" :"aas",
"SKU" :"sssddd",
"UPC" :"sasdasss"
}
DELETE /products/combinations/{id}
Descripción
Elimina la combinación de valores de opción indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/combinations/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
}
GET /products/combinations/getId/{pId}
Descripción
Devuelve el identificador interno de la combinación de valores de opción.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/combinations/getId/abc
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
pId | Obligatorio | string | |
Identificador público. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 143
}
GET /products/definitions/prices/{id}
Descripción
Devuelve la información del precio personalizado indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/definitions/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
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 426,
"ID" : 843,
"OPTIONVALUE": {
"ID" : 1657,
"PID" :""
},
"RETAILPRICE" : 12
}
PUT /products/definitions/prices/{id}
Descripción
Edición del precio personalizado indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/definitions/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": { "basePrice":numeric, "retailPrice":numeric } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
prices | Obligatorio | struct | |
Bloque con información de los precios del producto para la personalización. | |||
prices/basePrice | Opcional | numeric | |
Precio del producto. El precio se especifica sin impuestos añadidos. | |||
prices/retailPrice | Opcional | numeric | |
Precio del producto cuando está en oferta. El precio se especifica sin impuestos añadidos. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 426,
"ID" : 843,
"OPTIONVALUE": {
"ID" : 1657,
"PID" :""
},
"RETAILPRICE" : 12
}
DELETE /products/definitions/prices/{id}
Descripción
Elimina el precio personalizado indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/definitions/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
}
GET /products/definitions/prices/{id}/currencies
Descripción
Devuelve la lista de precios por moneda del precio (personalizado) indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/definitions/prices/1/currencies
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
]
}
POST /products/definitions/prices/{id}/currencies
Descripción
Asignación de precios por moneda al precio (personalizado) indicado. Las monedas adicionales a las que se vincule un precio deben estar configuradas previamente al eCommerce.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/definitions/prices/1/currencies
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
Parámetros de entrada JSON
{ "currencies": { "basePrice":, "currencyCode":currency, "retailPrice": } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
currencies | Obligatorio | struct | |
Bloque con información de los precios del producto en monedas adicionales vinculadas al eCommerce. | |||
currencies/basePrice | Obligatorio | ||
Precio del producto. El precio se especifica sin impuestos añadidos. | |||
currencies/currencyCode | Obligatorio | currency | |
Código de la moneda en formato ISO 4217. | |||
currencies/retailPrice | Opcional | ||
Precio del producto cuando está en oferta. El precio se especifica sin impuestos añadidos. |
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
DELETE /products/definitions/prices/{id}/currencies
Descripción
Elimina los precios por moneda del precio (personalizado) indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/definitions/prices/1/currencies
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"CURRENCIES": [
]
}
GET /products/definitions/prices/currencies/{id}
Descripción
Devuelve el precio por moneda indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/definitions/prices/currencies/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
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
PUT /products/definitions/prices/currencies/{id}
Descripción
Edita el precio por moneda indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/definitions/prices/currencies/1
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
Parámetros de entrada JSON
{ "currencies": { "basePrice":, "retailPrice": } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
currencies | Obligatorio | struct | |
Bloque con información de los precios del producto en monedas adicionales vinculadas al eCommerce. | |||
currencies/basePrice | Opcional | ||
Precio del producto. El precio se especifica sin impuestos añadidos. | |||
currencies/retailPrice | Opcional | ||
Precio del producto cuando está en oferta. El precio se especifica sin impuestos añadidos. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
DELETE /products/definitions/prices/currencies/{id}
Descripción
Elimina el precio por moneda indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/definitions/prices/currencies/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
}
GET /products/getId/{pId}
Descripción
Devuelve el identificador interno del producto.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/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
}
POST /products/getIds/data
Descripción
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/getIds/data
Parámetros de entrada JSON
{ "items": [ { "ean":string, "pId":string } ] } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
items | Obligatorio | array [1:n] | |
items/ean | Opcional | string | |
items/pId | Opcional | string |
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"ACTIVE" : true,
"ID" : 1,
"PID" :"abc"
}
GET /products/options/{id}
Descripción
Devuelve la opción (de producto) indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/options/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
{
"ACTIVE" : true,
"COMBINABLE" : false,
"FILTERABLE" : true,
"ID" : 14789,
"IMAGE" :"",
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"NAME" :"",
"PROMPT" :""
}
],
"MAXVALUES" :null,
"MINVALUES" :null,
"PID" :"color",
"PRIORITY" : 3,
"REQUIRED" : true,
"SHOWASGRID" : false,
"TYPOLOGY" : 1,
"UNIQUEPRICE" : true,
"VALUES": [
{
"ACTIVE" : true,
"ID" : 1,
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"LONGDESCRIPTION" :"Size XL long description",
"SEARCHVALUE" :"XL",
"SHORTDESCRIPTION" :"Size XL short description",
"VALUE" :"XL"
}
],
"LARGEIMAGE" :"b.jpg",
"PID" :"abc",
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 2,
"ID" : 843,
"RETAILPRICE" : 12
}
],
"PRIORITY" : 1,
"SKU" :"sku",
"SMALLIMAGE" :"a.jpg",
"WEIGHT" : 6
}
],
"VALUETYPE" : 1
}
PUT /products/options/{id}
Descripción
Edición de la opción (de producto) indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/options/1
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
Parámetros de entrada JSON
{ "options": { "active":boolean, "affectsStock":boolean, "combinable":boolean, "filterable":boolean, "languages": [ { "languageCode":string, "productOptionId": numeric "name": string "prompt": string } ], "maxValues":numeric, "minValues":numeric, "pId":string, "priority":numeric, "required":boolean, "showAsGrid":boolean, "showPrice":, "typology":numeric, "uniquePrice":boolean, "image": string } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
options | Obligatorio | struct | |
En este bloque podemos definir las opciones del producto. Las opciones son variaciones del producto, como talla o color. | |||
options/active | Opcional | true | boolean |
Define si la opción esta activada. | |||
options/affectsStock | Opcional | true | boolean |
DEPRECATED: debe usarse combinable en su lugar. Indica si la opción interviene en el stock por combinaciones de valores de opción. | |||
options/combinable | Opcional | true | boolean |
Indica si los valores de esta opción se usarán para generar combinaciones de opciones. Importante: es necesario pasar este parámetro con valor true si se necesita añadir stock por combinaciones de valores de opción. | |||
options/filterable | Opcional | false | boolean |
Indica si la opción permite que sus valores sean filtrables en la tienda. | |||
options/image | Opcional | string | |
Define una imagen específica para la opción. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
options/languages | Opcional | array [0:n] | |
Bloque con información variable según el idioma. | |||
options/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. | |||
options/languages/name | Opcional | string | |
Define el nombre de la opción para el idioma seleccionado. | |||
options/languages/productOptionId | Obligatorio | numeric | |
options/languages/prompt | Opcional | string | |
Define el título de la opción para el idioma seleccionado. Texto que aparece junto al selector de valores. | |||
options/maxValues | Opcional | 0 | numeric |
Número de ficheros adjuntos que como máximo se admitirán (en blanco implica que no habrá límite mínimo). Solo si valueType=10. | |||
options/minValues | Opcional | 0 | numeric |
Número de ficheros adjuntos que como mínimo se admitirán (en blanco implica que no habrá límite mínimo). Solo si valueType=10. | |||
options/pId | Opcional | string | |
Identificador público de la opción. | |||
options/priority | Opcional | 0 | numeric |
Define el orden de presentación de esta opción en relación al resto de opciones de este mismo producto. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
options/required | Opcional | true | boolean |
Define si la opción es obligatoria. | |||
options/showAsGrid | Opcional | false | boolean |
Indica si la opción se debe mostrar como cuadro de compra múltiple en forma de rejilla. Solo es posible si hay dos opciones en el producto. No incluya esta etiqueta a no ser que se lo pidan desde Trilogi. | |||
options/showPrice | Opcional | false | |
Define si se muestra el precio o no. | |||
options/typology | Opcional | numeric | |
Define el tipo de opción (tipología). Valores permitidos: 1 - Talla, 2 - Color, 3 - Material, 9999 - Otros. Si no se pasa este parámetro, la opción queda sin tipología. | |||
options/uniquePrice | Opcional | false | boolean |
Indica si independientemente de las unidades que se compre del producto, el precio de la opción se aplicará solamente una vez. No incluya esta etiqueta a no ser que se lo pidan desde Trilogi. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACTIVE" : true,
"COMBINABLE" : false,
"FILTERABLE" : true,
"ID" : 14789,
"IMAGE" :"",
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"NAME" :"",
"PROMPT" :""
}
],
"MAXVALUES" :null,
"MINVALUES" :null,
"PID" :"color",
"PRIORITY" : 3,
"REQUIRED" : true,
"SHOWASGRID" : false,
"TYPOLOGY" : 1,
"UNIQUEPRICE" : true,
"VALUES": [
{
"ACTIVE" : true,
"ID" : 1,
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"LONGDESCRIPTION" :"Size XL long description",
"SEARCHVALUE" :"XL",
"SHORTDESCRIPTION" :"Size XL short description",
"VALUE" :"XL"
}
],
"LARGEIMAGE" :"b.jpg",
"PID" :"abc",
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 2,
"ID" : 843,
"RETAILPRICE" : 12
}
],
"PRIORITY" : 1,
"SKU" :"sku",
"SMALLIMAGE" :"a.jpg",
"WEIGHT" : 6
}
],
"VALUETYPE" : 1
}
DELETE /products/options/{id}
Descripción
Elimina la opción (de producto) indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/options/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
}
GET /products/options/{id}/values
Descripción
Devuelve los valores de la opción indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/options/1/values
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"VALUES": [
{
"ACTIVE" : true,
"ID" : 1,
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"LONGDESCRIPTION" :"Size XL long description",
"SEARCHVALUE" :"XL",
"SHORTDESCRIPTION" :"Size XL short description",
"VALUE" :"XL"
}
],
"LARGEIMAGE" :"b.jpg",
"PID" :"abc",
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 2,
"ID" : 843,
"RETAILPRICE" : 12
}
],
"PRIORITY" : 1,
"SKU" :"sku",
"SMALLIMAGE" :"a.jpg",
"WEIGHT" : 6
}
]
}
POST /products/options/{id}/values
Descripción
Creación de un valor para la opción indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/options/1/values
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
Parámetros de entrada JSON
{ "values": { "languages": [ { "languageCode":string, "value":string, "longDescription": string "searchValue": string "shortDescription": string } ], "noReturn":boolean, "pId":string, "prices": [ { "basePrice":numeric, "currencies": [ { "currencyCode":currency, "basePrice": numeric "id": numeric "retailPrice": numeric } ], "fromQuantity":numeric, "retailPrice": numeric } ], "weight":numeric, "active": boolean "largeImage": string "priority": numeric "smallImage": string } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
values | Obligatorio | struct | |
Bloque con los distintos valores que tiene la opción. Contiene la definición de todos los valores. | |||
values/active | Opcional | true | boolean |
Define si el valor de opción esta activo. | |||
values/languages | Opcional | array [0:n] | |
Bloque con información variable según el idioma. | |||
values/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. | |||
values/languages/longDescription | Opcional | string | |
Define la descripción corta del valor de opción para el idioma seleccionado. | |||
values/languages/searchValue | Opcional | string | |
Define el valor de búsqueda del valor de opción para el idioma seleccionado. Si no se especifica se usa el propio valor. | |||
values/languages/shortDescription | Opcional | string | |
Define la descripción corta del valor de opción para el idioma seleccionado. | |||
values/languages/value | Obligatorio | string | |
Define el valor de opción para el idioma seleccionado. | |||
values/largeImage | Opcional | string | |
Información de la imagen del valor en su versión grande. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
values/noReturn | Opcional | false | boolean |
Indica si se prohibe la devolución. Valores permitidos: false - No prohibir, true - Prohibir | |||
values/pId | Opcional | string | |
Identificador público del valor de la opción. | |||
values/prices | Opcional | array [0:n] | |
Bloque con información de los precios del producto para el valor de opción. | |||
values/prices/basePrice | Obligatorio | numeric | |
Define un incremento de importe sobre el precio del producto. | |||
values/prices/currencies | Opcional | array [0:n] | |
Bloque con información de los precios del producto para el valor de opción en monedas adicionales vinculadas al eCommerce. | |||
values/prices/currencies/basePrice | Obligatorio | numeric | |
Define un incremento de importe sobre el precio del producto. | |||
values/prices/currencies/currencyCode | Obligatorio | currency | |
Código de la moneda en formato ISO 4217. | |||
values/prices/currencies/id | Obligatorio | numeric | |
values/prices/currencies/retailPrice | Opcional | numeric | |
Define un incremento de importe sobre el precio de oferta del producto. | |||
values/prices/fromQuantity | Opcional | 1 | numeric |
Cuando se define, indica que el bloque de precios es por cantidad (de unidades compradas). Indica la cantidad del intervalo a partir de la cual se aplican los nuevos precios. Debe ser superior a 1 y a la cantidad del intervalo anterior. No es necesario si el eCommerce no tiene activado Precios por cantidad. | |||
values/prices/retailPrice | Opcional | numeric | |
Define un incremento de importe sobre el precio de oferta del producto. | |||
values/priority | Opcional | 0 | numeric |
Define el orden de presentación de este valor de opción en relación al resto de valores de esta misma opción en este mismo producto. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
values/smallImage | Opcional | string | |
Información de la imagen del valor en su versión pequeña. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
values/weight | Opcional | 0 | numeric |
Define un incremento de peso sobre el peso base del producto. |
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"ACTIVE" : true,
"ID" : 1,
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"LONGDESCRIPTION" :"Size XL long description",
"SEARCHVALUE" :"XL",
"SHORTDESCRIPTION" :"Size XL short description",
"VALUE" :"XL"
}
],
"LARGEIMAGE" :"b.jpg",
"PID" :"abc",
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 2,
"ID" : 843,
"RETAILPRICE" : 12
}
],
"PRIORITY" : 1,
"SKU" :"sku",
"SMALLIMAGE" :"a.jpg",
"WEIGHT" : 6
}
DELETE /products/options/{id}/values
Descripción
Elimina todos los valores de la opción indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/options/1/values
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"VALUES": [
]
}
GET /products/options/getId/{pId}
Descripción
Devuelve el identificador interno de la opción de producto.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/options/getId/abc
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
pId | Obligatorio | string | |
Identificador público. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 143
}
GET /products/options/values/{id}
Descripción
Devuelve el valor (de opción) indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/options/values/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
{
"ACTIVE" : true,
"ID" : 1,
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"LONGDESCRIPTION" :"Size XL long description",
"SEARCHVALUE" :"XL",
"SHORTDESCRIPTION" :"Size XL short description",
"VALUE" :"XL"
}
],
"LARGEIMAGE" :"b.jpg",
"PID" :"abc",
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 2,
"ID" : 843,
"RETAILPRICE" : 12
}
],
"PRIORITY" : 1,
"SKU" :"sku",
"SMALLIMAGE" :"a.jpg",
"WEIGHT" : 6
}
PUT /products/options/values/{id}
Descripción
Edición del valor (de opción) indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/options/values/1
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
Parámetros de entrada JSON
{ "values": { "active":boolean, "languages": [ { "languageCode":string, "longDescription": string "searchValue": string "shortDescription": string "value": string } ], "noReturn":boolean, "pId":string, "weight":numeric, "largeImage": string "priority": numeric "smallImage": string } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
values | Obligatorio | struct | |
Bloque con los distintos valores que tiene la opción. Contiene la definición de todos los valores. | |||
values/active | Opcional | true | boolean |
Define si el valor de opción esta activo. | |||
values/languages | Opcional | array [0:n] | |
Bloque con información variable según el idioma. | |||
values/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. | |||
values/languages/longDescription | Opcional | string | |
Define la descripción corta del valor de opción para el idioma seleccionado. | |||
values/languages/searchValue | Opcional | string | |
Define el valor de búsqueda del valor de opción para el idioma seleccionado. Si no se especifica se usa el propio valor. | |||
values/languages/shortDescription | Opcional | string | |
Define la descripción corta del valor de opción para el idioma seleccionado. | |||
values/languages/value | Opcional | string | |
Define el valor de opción para el idioma seleccionado. | |||
values/largeImage | Opcional | string | |
Información de la imagen del valor en su versión grande. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
values/noReturn | Opcional | false | boolean |
Indica si se prohibe la devolución. Valores permitidos: false - No prohibir, true - Prohibir | |||
values/pId | Opcional | string | |
Identificador público del valor de la opción. | |||
values/priority | Opcional | 0 | numeric |
Define el orden de presentación de este valor de opción en relación al resto de valores de esta misma opción en este mismo producto. Cuanto menor es el valor mayor es la prioridad (más relavancia tiene). Puede ser negativa. | |||
values/smallImage | Opcional | string | |
Información de la imagen del valor en su versión pequeña. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
values/weight | Opcional | 0 | numeric |
Define un incremento de peso sobre el peso base del producto. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACTIVE" : true,
"ID" : 1,
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"LONGDESCRIPTION" :"Size XL long description",
"SEARCHVALUE" :"XL",
"SHORTDESCRIPTION" :"Size XL short description",
"VALUE" :"XL"
}
],
"LARGEIMAGE" :"b.jpg",
"PID" :"abc",
"PRICES": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 2,
"ID" : 843,
"RETAILPRICE" : 12
}
],
"PRIORITY" : 1,
"SKU" :"sku",
"SMALLIMAGE" :"a.jpg",
"WEIGHT" : 6
}
DELETE /products/options/values/{id}
Descripción
Elimina el valor (de opción) indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/options/values/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
}
GET /products/options/values/{id}/prices
Descripción
Devuelve los precios para el valor de opción indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/options/values/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": [
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 2,
"ID" : 843,
"RETAILPRICE" : 12
}
]
}
POST /products/options/values/{id}/prices
Descripción
Asignación de precios al valor de opción indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/options/values/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": { "basePrice":numeric, "currencies": [ { "currencyCode":currency, "basePrice": numeric "retailPrice": numeric } ], "fromQuantity":numeric, "retailPrice": numeric } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
prices | Obligatorio | struct | |
Bloque con información de los precios del producto para el valor de opción. | |||
prices/basePrice | Obligatorio | numeric | |
Define un incremento de importe sobre el precio del producto. | |||
prices/currencies | Opcional | array [0:n] | |
Bloque con información de los precios del producto en monedas adicionales vinculadas al eCommerce. | |||
prices/currencies/basePrice | Obligatorio | numeric | |
Precio del producto. El precio se especifica sin impuestos añadidos. | |||
prices/currencies/currencyCode | Obligatorio | currency | |
Código de la moneda en formato ISO 4217. | |||
prices/currencies/retailPrice | Opcional | numeric | |
Precio del producto cuando está en oferta. El precio se especifica sin impuestos añadidos. | |||
prices/fromQuantity | Opcional | 1 | numeric |
Cuando se define, indica que el bloque de precios es por cantidad (de unidades compradas). Indica la cantidad del intervalo a partir de la cual se aplican los nuevos precios. Debe ser superior a 1 y a la cantidad del intervalo anterior. No es necesario si el eCommerce no tiene activado Precios por cantidad. | |||
prices/retailPrice | Opcional | numeric | |
Define un incremento de importe sobre el precio de oferta del producto. |
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 2,
"ID" : 843,
"RETAILPRICE" : 12
}
DELETE /products/options/values/{id}/prices
Descripción
Elimina todos los precios para el valor de opción indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/options/values/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 /products/options/values/getId/{pId}
Descripción
Devuelve el identificador interno del valor de opción de producto.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/options/values/getId/abc
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
pId | Obligatorio | string | |
Identificador público. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 143
}
GET /products/options/values/prices/{id}
Descripción
Devuelve la información del precio (del valor de opción) indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/options/values/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
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 2,
"ID" : 843,
"RETAILPRICE" : 12
}
PUT /products/options/values/prices/{id}
Descripción
Edición del precio (del valor de opción) indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/options/values/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": { "basePrice":numeric, "retailPrice":numeric } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
prices | Obligatorio | struct | |
Bloque con información de los precios del producto para el valor de opción. | |||
prices/basePrice | Opcional | numeric | |
Define un incremento de importe sobre el precio del producto. | |||
prices/retailPrice | Opcional | numeric | |
Define un incremento de importe sobre el precio de oferta del producto. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 2,
"ID" : 843,
"RETAILPRICE" : 12
}
DELETE /products/options/values/prices/{id}
Descripción
Elimina el precio (del valor de opción) indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/options/values/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
}
GET /products/options/values/prices/{id}/currencies
Descripción
Devuelve la lista de precios por moneda del precio (del valor de opción) indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/options/values/prices/1/currencies
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
]
}
POST /products/options/values/prices/{id}/currencies
Descripción
Asignación de precios por moneda al precio (del valor de opción) indicado. Las monedas adicionales a las que se vincule un precio deben estar configuradas previamente al eCommerce.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/options/values/prices/1/currencies
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
Parámetros de entrada JSON
{ "currencies": { "basePrice":, "currencyCode":currency, "retailPrice": } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
currencies | Obligatorio | struct | |
Bloque con información de los precios del producto en monedas adicionales vinculadas al eCommerce. | |||
currencies/basePrice | Obligatorio | ||
Precio del producto. El precio se especifica sin impuestos añadidos. | |||
currencies/currencyCode | Obligatorio | currency | |
Código de la moneda en formato ISO 4217. | |||
currencies/retailPrice | Opcional | ||
Precio del producto cuando está en oferta. El precio se especifica sin impuestos añadidos. |
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
DELETE /products/options/values/prices/{id}/currencies
Descripción
Elimina los precios por moneda del precio (del valor de opción) indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/options/values/prices/1/currencies
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"CURRENCIES": [
]
}
GET /products/options/values/prices/currencies/{id}
Descripción
Devuelve el precio por moneda indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/options/values/prices/currencies/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
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
PUT /products/options/values/prices/currencies/{id}
Descripción
Edita el precio por moneda indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/options/values/prices/currencies/1
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
Parámetros de entrada JSON
{ "currencies": { "basePrice":, "retailPrice": } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
currencies | Obligatorio | struct | |
Bloque con información de los precios del producto en monedas adicionales vinculadas al eCommerce. | |||
currencies/basePrice | Opcional | ||
Precio del producto. El precio se especifica sin impuestos añadidos. | |||
currencies/retailPrice | Opcional | ||
Precio del producto cuando está en oferta. El precio se especifica sin impuestos añadidos. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
DELETE /products/options/values/prices/currencies/{id}
Descripción
Elimina el precio por moneda indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/options/values/prices/currencies/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
}
GET /products/priceLists/prices/{id}
Descripción
Devuelve el precio (de tarifa) indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/priceLists/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
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 426,
"ID" : 843,
"OPTIONVALUE": {
"ID" : 1657,
"PID" :""
},
"RETAILPRICE" : 12
}
PUT /products/priceLists/prices/{id}
Descripción
Edición del precio (de tarifa) indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/priceLists/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": { "basePrice":numeric, "retailPrice":numeric } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
prices | Obligatorio | struct | |
Bloque con información de los precios del producto para la tarifa. | |||
prices/basePrice | Opcional | numeric | |
Precio del producto. El precio se especifica sin impuestos añadidos. | |||
prices/retailPrice | Opcional | numeric | |
Precio del producto cuando está en oferta. El precio se especifica sin impuestos añadidos. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"FROMQUANTITY" : 426,
"ID" : 843,
"OPTIONVALUE": {
"ID" : 1657,
"PID" :""
},
"RETAILPRICE" : 12
}
DELETE /products/priceLists/prices/{id}
Descripción
Elimina el precio (de tarifa) indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/priceLists/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
}
GET /products/priceLists/prices/{id}/currencies
Descripción
Devuelve la lista de precios por moneda del precio (de tarifa) indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/priceLists/prices/1/currencies
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
]
}
POST /products/priceLists/prices/{id}/currencies
Descripción
Asignación de precios por moneda al precio (de tarifa) indicado. Las monedas adicionales a las que se vincule un precio deben estar configuradas previamente al eCommerce.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/priceLists/prices/1/currencies
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
Parámetros de entrada JSON
{ "currencies": { "basePrice":, "currencyCode":currency, "retailPrice": } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
currencies | Obligatorio | struct | |
Bloque con información de los precios del producto en monedas adicionales vinculadas al eCommerce. | |||
currencies/basePrice | Obligatorio | ||
Precio del producto. El precio se especifica sin impuestos añadidos. | |||
currencies/currencyCode | Obligatorio | currency | |
Código de la moneda en formato ISO 4217. | |||
currencies/retailPrice | Opcional | ||
Precio del producto cuando está en oferta. El precio se especifica sin impuestos añadidos. |
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
DELETE /products/priceLists/prices/{id}/currencies
Descripción
Elimina los precios por moneda del precio (de tarifa) indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/priceLists/prices/1/currencies
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"CURRENCIES": [
]
}
GET /products/priceLists/prices/currencies/{id}
Descripción
Devuelve el precio por moneda indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/priceLists/prices/currencies/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
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
PUT /products/priceLists/prices/currencies/{id}
Descripción
Edita el precio por moneda indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/priceLists/prices/currencies/1
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
Parámetros de entrada JSON
{ "currencies": { "basePrice":, "retailPrice": } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
currencies | Obligatorio | struct | |
Bloque con información de los precios del producto en monedas adicionales vinculadas al eCommerce. | |||
currencies/basePrice | Opcional | ||
Precio del producto. El precio se especifica sin impuestos añadidos. | |||
currencies/retailPrice | Opcional | ||
Precio del producto cuando está en oferta. El precio se especifica sin impuestos añadidos. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
DELETE /products/priceLists/prices/currencies/{id}
Descripción
Elimina el precio por moneda indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/priceLists/prices/currencies/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
}
PUT /products/prices
Descripción
Edición masiva de precios
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/prices
Parámetros de entrada JSON
{ "prices": [ { "basePrice":numeric, "currencies": [ { "currencyCode":currency, "retailPrice":numeric, "basePrice": numeric } ], "definition": { "id":, "pId":string }, "fromQuantity":numeric, "optionValue": { "id":, "pId":string }, "priceList": { "id":, "pId":string }, "product": { "id":, "pId":string }, "retailPrice":numeric } ] } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
prices | Obligatorio | array [1:n] | |
Bloque con información de los precios del producto. | |||
prices/basePrice | Obligatorio | numeric | |
Precio del producto. El precio se especifica sin impuestos añadidos. | |||
prices/currencies | Opcional | array [0:n] | |
Bloque con información de los precios del producto en monedas adicionales vinculadas al eCommerce. | |||
prices/currencies/basePrice | Obligatorio | numeric | |
Precio por moneda del producto. El precio se especifica sin impuestos añadidos. | |||
prices/currencies/currencyCode | Obligatorio | currency | |
Código de la moneda en formato ISO 4217. | |||
prices/currencies/retailPrice | Opcional | numeric | |
Precio por moneda del producto cuando está en oferta. El precio se especifica sin impuestos añadidos. | |||
prices/definition | Opcional | struct | |
Bloque con información de la definición | |||
prices/definition/id | Opcional | 0 | |
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/fromQuantity | Opcional | 1 | numeric |
Cuando se define, indica que el bloque de precios es por cantidad (de unidades compradas). Indica la cantidad del intervalo a partir de la cual se aplican los nuevos precios. Debe ser superior a 1 y a la cantidad del intervalo anterior. No es necesario si el eCommerce no tiene activado Precios por cantidad. | |||
prices/optionValue | Opcional | struct | |
Bloque de información del valor de una opción. Define si el bloque de precios es para un valor de opción. | |||
prices/optionValue/id | Opcional | 0 | |
Identificador interno del valor de opción. Opcional en caso que se use identificador público. | |||
prices/optionValue/pId | Opcional | string | |
Identificador público del valor de opción. Opcional en caso que se use identificador interno. | |||
prices/priceList | Opcional | struct | |
Bloque con información de la tarifa | |||
prices/priceList/id | Opcional | 0 | |
Identificador interno de la tarifa. Opcional en caso que se use identificador público. | |||
prices/priceList/pId | Opcional | string | |
Identificador público de la tarifa. Opcional en caso que se use identificador interno. | |||
prices/product | Opcional | struct | |
Bloque de información del producto | |||
prices/product/id | Opcional | 0 | |
Identificador interno del producto. Opcional en caso que se use identificador público. | |||
prices/product/pId | Opcional | string | |
Identificador público del producto. Opcional en caso que se use identificador interno. | |||
prices/retailPrice | Opcional | numeric | |
Precio del producto cuando está en oferta. El precio se especifica sin impuestos añadidos. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"response" :"ok"
}
GET /products/prices/{id}
Descripción
Devuelve la información del precio (de producto) indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/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
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"ID" : 843,
"RETAILPRICE" : 12
}
PUT /products/prices/{id}
Descripción
Edición del precio (de producto) indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/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": { "basePrice":numeric, "retailPrice":numeric } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
prices | Obligatorio | struct | |
Bloque con información de los precios del producto. | |||
prices/basePrice | Opcional | numeric | |
Precio del producto. El precio se especifica sin impuestos añadidos. | |||
prices/retailPrice | Opcional | numeric | |
Precio del producto cuando está en oferta. El precio se especifica sin impuestos añadidos. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"BASEPRICE" : 14,
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
],
"ID" : 843,
"RETAILPRICE" : 12
}
DELETE /products/prices/{id}
Descripción
Elimina el precio (de producto) indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/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
}
GET /products/prices/{id}/currencies
Descripción
Devuelve la lista de precios por moneda del precio (del valor de opción) indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/prices/1/currencies
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"CURRENCIES": [
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
]
}
POST /products/prices/{id}/currencies
Descripción
Asignación de precios por moneda al precio (del valor de opción) indicado. Las monedas adicionales a las que se vincule un precio deben estar configuradas previamente al eCommerce.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/prices/1/currencies
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
Parámetros de entrada JSON
{ "currencies": { "basePrice":, "currencyCode":currency, "retailPrice": } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
currencies | Obligatorio | struct | |
Bloque con información de los precios del producto en monedas adicionales vinculadas al eCommerce. | |||
currencies/basePrice | Obligatorio | ||
Precio del producto. El precio se especifica sin impuestos añadidos. | |||
currencies/currencyCode | Obligatorio | currency | |
Código de la moneda en formato ISO 4217. | |||
currencies/retailPrice | Opcional | ||
Precio del producto cuando está en oferta. El precio se especifica sin impuestos añadidos. |
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
DELETE /products/prices/{id}/currencies
Descripción
Elimina los precios por moneda del precio (del valor de opción) indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/prices/1/currencies
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"CURRENCIES": [
]
}
GET /products/prices/currencies/{id}
Descripción
Devuelve el precio por moneda indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/prices/currencies/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
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
PUT /products/prices/currencies/{id}
Descripción
Edita el precio por moneda indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/prices/currencies/1
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
Parámetros de entrada JSON
{ "currencies": { "basePrice":, "retailPrice": } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
currencies | Obligatorio | struct | |
Bloque con información de los precios del producto en monedas adicionales vinculadas al eCommerce. | |||
currencies/basePrice | Opcional | ||
Precio del producto. El precio se especifica sin impuestos añadidos. | |||
currencies/retailPrice | Opcional | ||
Precio del producto cuando está en oferta. El precio se especifica sin impuestos añadidos. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"BASEPRICE" : 30,
"CURRENCY" :"EUR",
"ID" : 1,
"RETAILPRICE" : 10
}
DELETE /products/prices/currencies/{id}
Descripción
Elimina el precio por moneda indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/prices/currencies/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
}
GET /products/stock/getId/{pId}/{warehousePId}
Descripción
Devuelve el identificador interno de la línea de stock por almacén. Este recurso solo se debe llamar cuando se tiene múltiples almacenes. El primer parámetro de entrada es el identificador público de la combinación de valores de opción que conforma la línea de stock. El segundo parámetro de entrada es el identificador público del almacén.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/stock/getId/abc/{warehousePId}
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
pId | Obligatorio | string | |
Identificador público. | |||
warehousePId | Obligatorio | string | |
Identificador público del almacén |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 143
}
PUT /products/stocks
Descripción
Edición masiva de stocks
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/stocks
Parámetros de entrada JSON
{ "stocks": [ { "combination": { "pId":string }, "pId":string, "stock":numeric, "warehouse": { "id":, "pId":string } } ] } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
stocks | Obligatorio | array [1:n] | |
Bloque con información del stock del producto. Este bloque solo tiene sentido si el producto tiene stockManagement=true. | |||
stocks/combination | Obligatorio | struct | |
Bloque con información de la combinación. Opcional en caso que se use identificador público. | |||
stocks/combination/pId | Obligatorio | string | |
Identificador público de la combinación. Opcional en caso que se use identificador interno. | |||
stocks/pId | Opcional | string | |
Identificador público de la línia de stock. | |||
stocks/stock | Obligatorio | numeric | |
Cantidad entera de unidades en stock. | |||
stocks/warehouse | Obligatorio | struct | |
Bloque con información del almacén | |||
stocks/warehouse/id | Opcional | 0 | |
Identificador interno de la combinación. Opcional en caso que se use identificador público. | |||
stocks/warehouse/pId | Opcional | string | |
Identificador público de la combinación. Opcional en caso que se use identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"response" :"ok"
}
GET /products/stocks/{id}
Descripción
Devuelve la línea de stock indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/stocks/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
{
"BACKORDERPREVISION": [
{
"ID" : 134646,
"INCOMINGDATE" :"2015-04-03",
"PID" :"sdfsdf",
"STOCK" : 230
}
],
"COMBINATION": {
"PID" :"combination M"
},
"ID" : 16534,
"PREVISION": [
{
"ID" : 134646,
"INCOMINGDATE" :"2015-04-03",
"PID" :"sdfsdf",
"STOCK" : 230
}
],
"STOCK" : 555,
"WAREHOUSE": {
"ID" : 1,
"PID" :"abc"
}
}
PUT /products/stocks/{id}
Descripción
Edición de la línea de stock indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/stocks/1
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
Parámetros de entrada JSON
{ "stock": { "stock":numeric } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
stock | Obligatorio | struct | |
Bloque con información del stock del producto. Este bloque solo tiene sentido si el producto tiene stockManagement=true. | |||
stock/stock | Opcional | 0 | numeric |
Cantidad entera de unidades en stock. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"BACKORDERPREVISION": [
{
"ID" : 134646,
"INCOMINGDATE" :"2015-04-03",
"PID" :"sdfsdf",
"STOCK" : 230
}
],
"COMBINATION": {
"PID" :"combination M"
},
"ID" : 16534,
"PREVISION": [
{
"ID" : 134646,
"INCOMINGDATE" :"2015-04-03",
"PID" :"sdfsdf",
"STOCK" : 230
}
],
"STOCK" : 555,
"WAREHOUSE": {
"ID" : 1,
"PID" :"abc"
}
}
DELETE /products/stocks/{id}
Descripción
Elimina la línea de stock indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/stocks/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
}
GET /products/stocks/{id}/prevision
Descripción
Devuelve el stock por provisión de la línea de stock indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/stocks/1/prevision
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"BACKORDERPREVISION": [
{
"ID" : 134646,
"INCOMINGDATE" :"2015-04-03",
"PID" :"sdfsdf",
"STOCK" : 230
}
],
"PREVISION": [
{
"ID" : 134646,
"INCOMINGDATE" :"2015-04-03",
"PID" :"sdfsdf",
"STOCK" : 230
}
]
}
POST /products/stocks/{id}/prevision
Descripción
Asignación de stock por provisión a la línea de stock indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/stocks/1/prevision
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
Parámetros de entrada JSON
{ "prevision": { "incomingDate":date, "pId":string, "previsionType":numeric, "stock": numeric } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
prevision | Obligatorio | struct | |
Bloque de información sobre la provisión de stock. | |||
prevision/incomingDate | Obligatorio | date | |
Define la fecha de la provisión de stock. Debe estar en formato ISO 8601 (YYYY-MM-DD). | |||
prevision/pId | Obligatorio | string | |
Identificador público de la provisión de stock. | |||
prevision/previsionType | Opcional | 1 | numeric |
Indica el tipo de la previsión. Valores permitidos: 1 - Previsión de stock, 2 - Previsión de reserva | |||
prevision/stock | Obligatorio | numeric | |
Cantidad entera de unidades en stock. |
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"PREVISION": {
"ID" : 134646,
"INCOMINGDATE" :"2015-04-03",
"PID" :"sdfsdf",
"STOCK" : 230
}
}
DELETE /products/stocks/{id}/prevision
Descripción
Elimina el stock por provisión de la línea de stock indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/stocks/1/prevision
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"BACKORDERPREVISION": [
],
"PREVISION": [
]
}
GET /products/stocks/prevision/{id}
Descripción
Devuelve la línea de stock por provisión indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/stocks/prevision/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" : 134646,
"INCOMINGDATE" :"2015-04-03",
"PID" :"sdfsdf",
"STOCK" : 230
}
PUT /products/stocks/prevision/{id}
Descripción
Edición de la línea de stock por provisión indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/stocks/prevision/1
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
Parámetros de entrada JSON
{ "prevision": { "incomingDate":date, "pId":string, "stock":numeric } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
prevision | Obligatorio | struct | |
Bloque de información sobre la provisión de stock. | |||
prevision/incomingDate | Opcional | date | |
Define la fecha de la provisión de stock. Debe estar en formato ISO 8601 (YYYY-MM-DD). | |||
prevision/pId | Opcional | string | |
Identificador público de la provisión de stock. | |||
prevision/stock | Opcional | numeric | |
Cantidad entera de unidades en stock. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 134646,
"INCOMINGDATE" :"2015-04-03",
"PID" :"sdfsdf",
"STOCK" : 230
}
DELETE /products/stocks/prevision/{id}
Descripción
Elimina la línea de stock por provisión indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/products/stocks/prevision/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
}