Listas de precios
Las listas de precios permiten establecer unos precios de producto alternativos a los que se han definido por defecto. Este endpoint permite la gestión de los distintos tipos de listas de precios que se aplican sobre productos.
</> GET / priceListsDevuelve la lista de listas de precios.
</> POST / priceListsCreación de una nueva lista de precios.
</> GET / priceLists/{id}Devuelve la información de la lista de precios indicada mediante identificador interno.
</> PUT / priceLists/{id}Edición de la lista de precios indicada mediante identificador interno.
</> DELETE / priceLists/{id}Elimina la lista de precios indicada mediante identificador interno.
</> GET / priceLists/{id}/priceListItemsDevuelve los filtros asignados a la lista de precios indicada.
</> POST / priceLists/{id}/priceListItemsCreación de un filtro para la lista de precios indicada.
</> DELETE / priceLists/{id}/priceListItemsElimina todos los filtros asignados de la lista de precios indicada.
</> GET / priceLists/getId/{pId}Devuelve el identificador interno de la lista de precios.
</> GET / priceLists/priceListItems/{id}Devuelve el filtro de la lista de precios con el identificador indicado.
</> DELETE / priceLists/priceListItems/{id}Elimina el filtro de la lista de precios con el identificador indicado.
GET /priceLists
Descripción
Devuelve la lista de listas de precios.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/priceLists
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ITEMS" : 1000,
"PRICELISTS": [
{
"BASEPRICEPOLICY" :"false",
"DESCRIPTION" :"Description abc",
"ID" : 43,
"INCREMENT" : -10,
"NAME" :"Definition 1",
"PARENT": {
"ID" : 123,
"PID" :"xyz"
},
"PID" :"abc",
"PRICELISTITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
],
"SHOWBASEPRICE" : false,
"TYPE" : 2,
"USERETAILPRICE" : false
}
]
}
POST /priceLists
Descripción
Creación de una nueva lista de precios.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/priceLists
Parámetros de entrada JSON
{ "priceLists": { "basePricePolicy":boolean, "description":string, "increment":numeric, "name":string, "pId":string, "parent": { "id":numeric, "pId":string }, "priceListItems": [ { "id":numeric, "itemType":numeric, "pId":string } ], "showBasePrice":boolean, "useRetailPrice":boolean } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| priceLists | Obligatorio | struct | |
| Bloque con información sobre la lista de precios. | |||
| priceLists/basePricePolicy | Opcional | false | boolean |
| Parámetro que define si el porcentaje de descuento se aplica sobre los precios de la lista de precios original directamente (false) o se aplica sobre el precio resultante en función de los parámetros showBasePrice y useRetailPrice (true). | |||
| priceLists/description | Opcional | string | |
| Texto breve a modo de comentario interno. | |||
| priceLists/increment | Opcional | 0 | numeric |
| Indica el valor del porcentaje que se usará para calcular el precio final de un producto. Puede ser positivo (incremento) o negativo (descuento). | |||
| priceLists/name | Obligatorio | string | |
| Indica el nombre del elemento a nivel interno. | |||
| priceLists/pId | Obligatorio | string | |
| Identificador público de la lista de precios. | |||
| priceLists/parent | Opcional | struct | |
| Bloque para informar de que lista de precios realiza el cálculo de precio. Solo disponible con el 'type' = 3. | |||
| priceLists/parent/id | Opcional | 0 | numeric |
| Identificador interno de la lista de precios. | |||
| priceLists/parent/pId | Opcional | string | |
| Identificador público de la lista de precios. | |||
| priceLists/priceListItems | Opcional | array [0:n] | |
| Bloque de información sobre los filtros aplicados a la lista de precios. | |||
| priceLists/priceListItems/id | Opcional | 0 | numeric |
| Identificador interno del elemento que filtra. En caso que itemType sea 30, es el identificador del país en formato ISO 3166-1 numeric. Opcional en caso que se use identificador público (si lo tiene, en caso contrario es obligatorio). | |||
| priceLists/priceListItems/itemType | Obligatorio | numeric | |
| Tipo de filtro. Valores permitidos: 10 - Usuario, 11 - Grupo de usuario, 30 - Países, 9 - Zonas de países | |||
| priceLists/priceListItems/pId | Opcional | string | |
| Identificador público del elemento que filtra (si lo tiene). En caso que itemType sea 30, es el identificador del país en formato ISO 3166-1 alpha-2. Opcional en caso que se use identificador interno. | |||
| priceLists/showBasePrice | Opcional | false | boolean |
| Indica que debe mostrarse (o no) el precio base con el valor existente antes de realizar el cálculo del precio, a modo de precio anterior o 'tachado'. | |||
| priceLists/useRetailPrice | Opcional | false | 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
{
"BASEPRICEPOLICY" :"false",
"DESCRIPTION" :"Description abc",
"ID" : 43,
"INCREMENT" : -10,
"NAME" :"Definition 1",
"PARENT": {
"ID" : 123,
"PID" :"xyz"
},
"PID" :"abc",
"PRICELISTITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
],
"SHOWBASEPRICE" : false,
"TYPE" : 2,
"USERETAILPRICE" : false
}
GET /priceLists/{id}
Descripción
Devuelve la información de la lista de precios indicada mediante identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/priceLists/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
{
"BASEPRICEPOLICY" :"false",
"DESCRIPTION" :"Description abc",
"ID" : 43,
"INCREMENT" : -10,
"NAME" :"Definition 1",
"PARENT": {
"ID" : 123,
"PID" :"xyz"
},
"PID" :"abc",
"PRICELISTITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
],
"SHOWBASEPRICE" : false,
"TYPE" : 2,
"USERETAILPRICE" : false
}
PUT /priceLists/{id}
Descripción
Edición de la lista de precios indicada mediante identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/priceLists/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "priceLists": { "basePricePolicy":boolean, "description":string, "increment":numeric, "name":string, "pId":string, "parent": { "id":numeric, "pId":string }, "showBasePrice":boolean, "useRetailPrice":boolean } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| priceLists | Obligatorio | struct | |
| Bloque con información sobre la lista de precios. | |||
| priceLists/basePricePolicy | Opcional | false | boolean |
| priceLists/description | Opcional | string | |
| Texto breve a modo de comentario interno. | |||
| priceLists/increment | Opcional | 0 | numeric |
| Indica el valor del porcentaje que se usará para calcular el precio final de un producto. Puede ser positivo (incremento) o negativo (descuento). | |||
| priceLists/name | Opcional | string | |
| Indica el nombre del elemento a nivel interno. | |||
| priceLists/pId | Opcional | string | |
| Identificador público de la lista de precios. | |||
| priceLists/parent | Opcional | struct | |
| Bloque para informar de que lista de precios realiza el cálculo de precio. Solo disponible con el 'type' = 3. | |||
| priceLists/parent/id | Opcional | 0 | numeric |
| Identificador interno de la lista de precios. | |||
| priceLists/parent/pId | Opcional | string | |
| Identificador público de la lista de precios. | |||
| priceLists/showBasePrice | Opcional | false | boolean |
| priceLists/useRetailPrice | Opcional | false | boolean |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"BASEPRICEPOLICY" :"false",
"DESCRIPTION" :"Description abc",
"ID" : 43,
"INCREMENT" : -10,
"NAME" :"Definition 1",
"PARENT": {
"ID" : 123,
"PID" :"xyz"
},
"PID" :"abc",
"PRICELISTITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
],
"SHOWBASEPRICE" : false,
"TYPE" : 2,
"USERETAILPRICE" : false
}
DELETE /priceLists/{id}
Descripción
Elimina la lista de precios indicada mediante identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/priceLists/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 /priceLists/{id}/priceListItems
Descripción
Devuelve los filtros asignados a la lista de precios indicada.
Los tipos de filtro devueltos (itemType) son: 10 - Usuario, 11 - Grupo de usuario, 30 - Países, 9 - Zonas de países.
Los tipos de filtro devueltos (itemType) son: 10 - Usuario, 11 - Grupo de usuario, 30 - Países, 9 - Zonas de países.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/priceLists/1/priceListItems
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"PRICELISTITEMS": [
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
]
}
POST /priceLists/{id}/priceListItems
Descripción
Creación de un filtro para la lista de precios indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/priceLists/1/priceListItems
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "priceListItems": { "id":numeric, "itemType":numeric, "pId":string } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| priceListItems | Obligatorio | struct | |
| Bloque de información sobre los filtros aplicados a la lista de precios. | |||
| priceListItems/id | Opcional | 0 | numeric |
| Identificador interno del elemento que filtra. En caso que itemType sea 30, es el identificador del país en formato ISO 3166-1 numeric. Opcional en caso que se use identificador público (si lo tiene, en caso contrario es obligatorio). | |||
| priceListItems/itemType | Obligatorio | numeric | |
| Tipo de filtro. Valores permitidos: 10 - Usuario, 11 - Grupo de usuario, 30 - Países, 9 - Zonas de países | |||
| priceListItems/pId | Opcional | string | |
| Identificador público del elemento que filtra (si lo tiene). En caso que itemType sea 30, es el identificador del país en formato ISO 3166-1 alpha-2. Opcional en caso que se use identificador interno. | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
DELETE /priceLists/{id}/priceListItems
Descripción
Elimina todos los filtros asignados de la lista de precios indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/priceLists/1/priceListItems
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"PRICELISTITEMS": [
]
}
GET /priceLists/getId/{pId}
Descripción
Devuelve el identificador interno de la lista de precios.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/priceLists/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 /priceLists/priceListItems/{id}
Descripción
Devuelve el filtro de la lista de precios con el identificador indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/priceLists/priceListItems/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 134564,
"ITEM": {
"ID" : 10,
"PID" :"df4"
},
"ITEMTYPE" : 2
}
DELETE /priceLists/priceListItems/{id}
Descripción
Elimina el filtro de la lista de precios con el identificador indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/priceLists/priceListItems/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" : 123
}