Usuarios
Este endpoint permite la gestión de los usuarios de su ecommerce y realizar acciones como altas, cambios de grupo, edición de datos, bajas o consultas de diversa información relacionada con usuarios.
</> GET / usersDevuelve el listado de usuarios.
</> POST / usersCreación de un nuevo usuario.
</> GET / users/{id}Devuelve la información del usuario indicado mediante identificador interno.
</> PUT / users/{id}Edición del usuario indicado mediante identificador interno.
</> DELETE / users/{id}Elimina al usuario indicado mediante identificador interno.
</> GET / users/{id}/addressbookDevuelve la libreta de direcciones del usuario indicado.
</> POST / users/{id}/addressbookCrea una nueva dirección de facturación o envío al usuario indicado.
</> DELETE / users/{id}/addressbookBorrado de Todas las libretas de direcciones de un usuario.
</> GET / users/{id}/commentsDevuelve los comentarios del usuario indicado.
</> GET / users/{id}/customTagsDevuelve la información de las etiquetas del usuario indicado.
</> POST / users/{id}/customTagsVincula una etiqueta al usuario indicado.
</> DELETE / users/{id}/customTagsDesvincula todas las etiquetas al usuario indicado.
</> GET / users/{id}/customTags/{customTagId}Devuelve la información de la etiqueta facilitada del usuario indicado.
</> PUT / users/{id}/customTags/{customTagId}Edición de la etiqueta facilitada del usuario indicado.
</> DELETE / users/{id}/customTags/{customTagId}Desvincula la etiqueta facilitada del usuario indicado.
</> GET / users/{id}/rewardPointsDevuelve la información de los rewardPoints del usuario indicado.
</> POST / users/{id}/rewardPointsAsigna rewardPoints al usuario indicado.
</> GET / users/{id}/salesAgentDevuelve la información del agente de venta.
</> PUT / users/{id}/salesAgentEdición de los datos del agente de venta.
</> POST / users/{id}/salesAgent/{userId}Vincula un usuario al agente de venta
</> DELETE / users/{id}/salesAgent/{userId}Desvincula un usuario al agente de venta
</> GET / users/{id}/shoppingListsDevuelve la información de las listas de compra del usuario indicado.
</> GET / users/{id}/supplierDevuelve la información de proveedor correspondiente al usuario indicado.
</> PUT / users/{id}/supplierEdición de la información de proveedor correspondiente al usuario indicado.
</> POST / users/{id}/supplier/itemsVincular un producto o categoría al usuario proveedor indicado.
</> DELETE / users/{id}/supplier/itemsElimina todas las vinculaciones de producto o categoría de proveedor que se hayan establecido para el usuario indicado.
</> DELETE / users/{id}/supplier/items/{productId}Elimina la vinculación de un producto de proveedor determinado que se haya establecido para el usuario indicado.
</> GET / users/{id}/vouchersDevuelve la información de los cupones de regalo vinculados al usuario indicado.
</> POST / users/{id}/vouchersAsignar un nuevo cupón de regalo al usuario indicado.
</> DELETE / users/{id}/vouchersElimina todos los cupones de regalo del usuario indicado.
</> GET / users/{id}/wishlistDevuelve la información de los productos de la lista de favoritos del usuario indicado.
</> POST / users/{id}/wishlistVincula un producto a la lista de favoritos del usuario indicado.
</> DELETE / users/{id}/wishlistElimina toda la lista de productos favoritos del usuario indicado.
</> DELETE / users/{id}/wishlist/{productId}Elimina de la lista de favoritos el producto indicado.
</> GET / users/addressbook/{id}Devuelve la información de la libreta de direcciones indicada.
</> PUT / users/addressbook/{id}Edición del registro indicado de la libreta de direcciones.
</> DELETE / users/addressbook/{id}Elimina la dirección indicada.
</> GET / users/countDevuelve un valor que indica la cantidad de usuarios.
</> GET / users/getId/{pId}Devuelve el identificador interno del usuario.
</> GET / users/shoppingLists/{id}/rowsDevuelve la información de la lista de compra indicada.
</> DELETE / users/shoppingLists/rows/{id}Elimina la linea de compra indicada de su lista de compra.
</> GET / users/vouchers/{id}Devuelve la información del cupón de regalo con el identificador indicado.
</> PUT / users/vouchers/{id}Edición del cupón de regalo con el identificador indicado.
</> DELETE / users/vouchers/{id}Elimina el cupón de regalo con el identificador indicado.
</> GET / usersGroupsDevuelve el listado de grupos de usuarios.
</> POST / usersGroupsCreación de un nuevo grupo de usuarios.
</> GET / usersGroups/{id}Devuelve la información del grupo de usuarios indicado.
</> PUT / usersGroups/{id}Edición del grupo de usuarios indicado.
</> DELETE / usersGroups/{id}Elimina el grupo de usuarios indicado.
</> GET / usersGroups/getId/{pId}Devuelve el identificador interno del grupo de usuarios indicado mediante identificador público.
GET /users
Descripción
Devuelve el listado de usuarios. 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/users
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| dateAdded_max | Opcional | date | |
| Devuelve a los usuarios creados hasta la fecha indicada. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
| dateAdded_min | Opcional | date | |
| Devuelve a los usuarios creados a partir de la fecha indicada. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
| Opcional | |||
| Devuelve elementos asociados al usuario con el correo electrónico indicado. | |||
| fields | Opcional | string | |
| Lista de campos a devolver. | |||
| groupId | Opcional | 0 | numeric |
| Devuelve elementos asociados al grupo indicado mediante identificador interno. | |||
| lastUsed_max | Opcional | date | |
| Devuelve a los usuarios que han realizado alguna modificación de sus datos hasta la fecha indicada. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
| lastUsed_min | Opcional | date | |
| Devuelve a los usuarios que han realizado alguna modificación de sus datos a partir de la fecha indicada. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
| 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. | |||
| showOnlyActive | Opcional | false | boolean |
| Devuelve únicamente elementos activos. | |||
| since_id | Opcional | 0 | numeric |
| Devuelve a los usuarios a partir de la id facilitada. | |||
| sort | Opcional | id | string |
| Variable de ordenación. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"CURSORS": {
"NEXT" :"http://api.logicommerce.net/v1/users?page=2&perPage=100",
"PREVIOUS" :""
},
"ITEMS" : 1000,
"PAGERPARAMETERS": {
"PAGE" : 1,
"PERPAGE" : 100
},
"USERS": [
{
"ACTIVE" : true,
"ADDRESSBOOK": {
"BILLINGADDRESS": [
{
"ADDRESS" :"Milà i Fontanals, 3",
"ADDRESSADDITIONALINFORMATION" :"additional",
"ALIAS" :"Default Address",
"CITY" :"IGUALADA",
"COMPANY" :"",
"COUNTRY" :"ES",
"DEFAULT" : 1,
"FAX" :"",
"FIRSTNAME" :"Brian",
"ID" : 12,
"LASTNAME" :"Baidal",
"LOCATIONID" : 28706,
"MOBILE" :"931842974",
"NIF" :"",
"NUMBER" :"",
"PHONE" :"",
"PID" :"",
"POSTALCODE" :"08700",
"RE" : false,
"REVERSECHARGEVAT" : false,
"STATE" :"BARCELONA",
"TAX" : true,
"USERID" : 3599,
"USERTYPE" : 1,
"VAT" :""
}
],
"SHIPPINGADDRESS": [
{
"ADDRESS" :"Milà i Fontanals, 3",
"ADDRESSADDITIONALINFORMATION" :"additional",
"ALIAS" :"Default Address",
"CITY" :"IGUALADA",
"COMPANY" :"",
"COUNTRY" :"ES",
"DEFAULT" : 1,
"FAX" :"",
"FIRSTNAME" :"Brian",
"ID" : 12,
"LASTNAME" :"Baidal",
"LOCATIONID" : 28706,
"MOBILE" :"931842974",
"NIF" :"",
"NUMBER" :"",
"PHONE" :"",
"PID" :"",
"POSTALCODE" :"08700",
"STATE" :"BARCELONA",
"USERID" : 3599,
"USERTYPE" : 1,
"VAT" :""
}
]
},
"AGENT" : false,
"BIRTHDAY" :"1980-03-14",
"CHATSUPPORT" : false,
"CUSTOMTAGS": {
"GENERAL": [
{
"ACTIVE" : true,
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
},
"VALUE" :"123"
}
],
"LANGUAGES": [
{
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
},
"LANGUAGES": [
{
"ACTIVE" : true,
"LANGUAGE" :"ES",
"VALUE" :"123"
}
]
}
],
"SELECTABLE": [
{
"ACTIVE" : true,
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
},
"VALUE": {
"ID" : 1,
"PID" :"abc"
}
}
]
},
"DATEADDED" :"2015-10-20",
"DEFAULTLANGUAGE" :"ES",
"EMAIL" :"a@b.com",
"GENDER" : 1,
"GROUP": {
"ID" : 3,
"PID" :""
},
"IMAGE" :"carlos.jpg",
"LANGUAGE" :"ES",
"LASTUSED" :"2015-11-05",
"LATITUDE" : 213.345,
"LONGITUDE" : 126.789,
"NICK" :"Charly",
"PID" :"CarlosG",
"RE" :"(DEPRECATED)",
"REVERSECHARGEVAT" :"(DEPRECATED)",
"SUBSCRIBED" : true,
"SUPPLIER": {
"ACTIVE" : true,
"ITEMS": [
{
"ITEM": {
"ID" : 123,
"PID" :"abc"
},
"ITEMTYPE" : 1
}
],
"LOGO" :"",
"PID" :"abc"
},
"SYSTEMLEVEL" : 4,
"TAX" :"(DEPRECATED)",
"TICKETINGSUPPORT" : false,
"USERTYPE" :"(DEPRECATED)",
"USESHIPPINGADDRESS" : false,
"VERIFIED" : true,
"VOUCHERS": [
{
"VOUCHERS": [
{
"AVAILABLEBALANCE" : 23.24,
"CODE" :"",
"CURRENCY" :"EUR",
"EXPIRATIONDATE" :"2014-10-12",
"ID" : 2574778
}
]
}
],
"WISHLIST": [
{
"ID" : 13,
"PID" :"abc"
}
]
}
]
}
POST /users
Descripción
Creación de un nuevo usuario. Este recurso permite, además del alta de los datos típicos de registro, vincular al usuario con otras funcionalidades como afiliados, apadrinamiento, epoints o la gestión de favoritos.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users
Parámetros de entrada JSON
{ "users": { "active":boolean, "addressBook": [ { "countryCode":string, "default":boolean, "firstName":string, "pId":string, "postalCode":string, "re":boolean, "reverseChargeVat":boolean, "tax":boolean, "type":numeric, "userType":numeric, "alias": string "address": string "addressAdditionalInformation": string "city": string "company": string "fax": string "lastName": string "latitude": numeric "longitude": numeric "mobile": string "nif": string "number": string "phone": string "state": string "vat": string } ], "customTags": [ { "customTag": { "id":numeric, "pId":string }, "general": { "value":string, "active": boolean }, "group": { "id":numeric, "pId":string }, "languages": [ { "languageCode":string, "value":string, "active": boolean } ], "selectable": { "active":boolean, "value": { "id":numeric, "pId":string } } } ], "group": { "id":numeric, "pId":string }, "languageCode":string, "pId":string, "salesAgent":boolean, "supplier": { "active":boolean, "items": [ { "item": { "id":numeric, "pId":string }, "itemType":numeric } ], "logo": string }, "systemLevel":numeric, "userType":numeric, "verified":boolean, "vouchers": [ { "availableBalance":numeric, "currencyId": numeric "code": string "expirationDate": datetime "pId": string } ], "wishlist": [ { "id":numeric, "pId":string } ], "email": string "password": string "birthDay": datetime "blogVerified": boolean "blogger": boolean "currencyCode": string "gender": numeric "image": string "nick": string "reverseChargeVat": boolean "useShippingAddress": boolean "visits": numeric } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| users | Obligatorio | struct | |
| Bloque de información que contiene la definición de un usuario. | |||
| users/active | Opcional | true | boolean |
| Define si el usuario está activo. Si no está activo no podrá identificarse en la tienda. | |||
| users/addressBook | Obligatorio | array [1:n] | |
| Bloque de información que define la libreta de direcciones del usuario. Esta libreta está compuesta por las distintas direcciones de facturación y/o envío que tiene el usuario y los campos que aquí se definen se refieren a cada una de las direcciones que se establezcan. | |||
| users/addressBook/address | Opcional | string | |
| Indica la dirección. | |||
| users/addressBook/addressAdditionalInformation | Opcional | string | |
| users/addressBook/alias | Obligatorio | string | |
| Indica un alias o nombre que identificará la dirección dentro de una lista en los procesos de compra. Este nombre se usa para etiquetar de manera cómoda las diferentes direcciones de la libreta. | |||
| users/addressBook/city | Opcional | string | |
| Indica el nombre de la ciudad. | |||
| users/addressBook/company | Opcional | string | |
| Indica el nombre de la empresa (este campo es obligatorio cuando el usuario es de tipo empresa). | |||
| users/addressBook/countryCode | Obligatorio | string | |
| users/addressBook/default | Opcional | false | boolean |
| Indica si es dirección principal o por defecto. Es la que se usa de manera automática si no se dice lo contrario en los procesos de compra. | |||
| users/addressBook/fax | Opcional | string | |
| Indica el número de fax. | |||
| users/addressBook/firstName | Opcional | string | |
| Indica el nombre (este campo es obligatorio cuando el usuario es de tipo particular o autónomo). | |||
| users/addressBook/lastName | Opcional | string | |
| Indica los apellidos. | |||
| users/addressBook/latitude | Opcional | numeric | |
| users/addressBook/longitude | Opcional | numeric | |
| users/addressBook/mobile | Opcional | string | |
| Indica el número de teléfono móvil. | |||
| users/addressBook/nif | Opcional | string | |
| Indica el número de identidad. | |||
| users/addressBook/number | Opcional | string | |
| Indica la numeración de la dirección. | |||
| users/addressBook/pId | Obligatorio | string | |
| Identificador público de la dirección. | |||
| users/addressBook/phone | Opcional | string | |
| Indica el número de teléfono. | |||
| users/addressBook/postalCode | Opcional | string | |
| users/addressBook/re | Opcional | false | boolean |
| Indica si al usuario se le aplica recargo de equivalencia. | |||
| users/addressBook/reverseChargeVat | Opcional | false | boolean |
| Indica si el usuario está bajo la consideración fiscal de Invertir sujeto pasivo. | |||
| users/addressBook/state | Opcional | string | |
| Indica el nombre de la provincia. | |||
| users/addressBook/tax | Opcional | true | boolean |
| Indica si al usuario se le aplican impuestos. | |||
| users/addressBook/type | Obligatorio | numeric | |
| Indica el tipo de dirección. Valores permitidos: 1 - Dirección de facturación, 2 - Dirección de envío | |||
| users/addressBook/userType | Opcional | 1 | numeric |
| Define el tipo de usuario. Valores permitidos: 1 - Particular, 2 - Empresa, 3 - Autónomo | |||
| users/addressBook/vat | Opcional | string | |
| Indica la identificación fiscal. | |||
| users/birthDay | Opcional | datetime | |
| Define la fecha de nacimiento del cliente. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
| users/blogVerified | Opcional | false | boolean |
| users/blogger | Opcional | false | boolean |
| Bloque de información de usuario autor de blog (blogger). Solo es necesario si el usuario va a tener rol de blogger. | |||
| users/currencyCode | Opcional | string | |
| users/customTags | Opcional | array [0:n] | |
| Bloque para vincular etiquetas de tipo usuario, para esta usuario en concreto. | |||
| users/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. | |||
| users/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. | |||
| users/customTags/customTag/pId | Opcional | string | |
| Indica el identificador público de la etiqueta. Debe existir previamente. Opcional en caso que se use identificador interno. | |||
| users/customTags/general | Opcional | struct | |
| Bloque para etiquetas cuyos valores no dependen del idioma. | |||
| users/customTags/general/active | Opcional | false | boolean |
| Define la visibilidad de la etiqueta. | |||
| users/customTags/general/value | Obligatorio | string | |
| Define el valor de la etiqueta. | |||
| users/customTags/group | Opcional | struct | |
| Bloque para informar del grupo de etiquetas en caso que la etiqueta pertenezca a más de uno. | |||
| users/customTags/group/id | Opcional | 0 | numeric |
| Identificador interno del grupo de etiquetas. Opcional en caso que se use identificador público. | |||
| users/customTags/group/pId | Opcional | string | |
| Identificador público del grupo de etiquetas. Opcional en caso que se use identificador interno. | |||
| users/customTags/languages | Opcional | array [0:n] | |
| Bloque para etiquetas cuyos valores dependen del idioma. | |||
| users/customTags/languages/active | Opcional | false | boolean |
| Define la visibilidad de la etiqueta. | |||
| users/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. | |||
| users/customTags/languages/value | Obligatorio | string | |
| Define el valor de la etiqueta. | |||
| users/customTags/selectable | Opcional | struct | |
| Bloque para etiquetas cuyos valores estan predefinidos a modo de selector desplegable. | |||
| users/customTags/selectable/active | Obligatorio | boolean | |
| Define la visibilidad de la etiqueta. | |||
| users/customTags/selectable/value | Opcional | struct | |
| Bloque para identificar la opción del desplegable. | |||
| users/customTags/selectable/value/id | Opcional | 0 | numeric |
| Identificador interno del valor que se quiere asignar. Opcional en caso que se use identificador público. | |||
| users/customTags/selectable/value/pId | Opcional | string | |
| Identificador público del valor que se quiere asignar. Opcional en caso que se use identificador interno. | |||
| users/email | Obligatorio | string | |
| Indica el correo electrónico del usuario. | |||
| users/gender | Opcional | 1 | numeric |
| Define el género del usuario. Valores permitidos: 1 - Hombre, 2 - Mujer | |||
| users/group | Obligatorio | struct | |
| Bloque para definir el grupo al que pertenece el usuario. | |||
| users/group/id | Opcional | 0 | numeric |
| Identificador interno del grupo que se quiere asignar. Opcional en caso que se use identificador público. | |||
| users/group/pId | Opcional | string | |
| Identificador público del grupo que se quiere asignar. Opcional en caso que se use identificador interno. | |||
| users/image | Opcional | string | |
| Imagen de usuario. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
| users/languageCode | Obligatorio | string | |
| Define el idioma por defecto del usuario. | |||
| users/nick | Opcional | string | |
| Indica el nombre de usuario para poder entrar en el gestor del eCommerce. Solo para usuarios administradores de Backoffice. | |||
| users/pId | Obligatorio | string | |
| Identificador público del usuario. | |||
| users/password | Obligatorio | string | |
| Indica la contraseña de acceso del usuario. | |||
| users/reverseChargeVat | Opcional | false | boolean |
| users/salesAgent | Opcional | false | boolean |
| Define si el usuario tiene el rol de agente de ventas. | |||
| users/supplier | Opcional | 0 | struct |
| Bloque de información de proveedor. Necesario si el usuario tiene el rol de proveedor. | |||
| users/supplier/active | Opcional | true | boolean |
| Indica si está activo. | |||
| users/supplier/items | Opcional | array [0:n] | |
| Bloque de categorías y/o productos vinculados al proveedor. | |||
| users/supplier/items/item | Obligatorio | struct | |
| Bloque de información asociada a un elemento en concreto. | |||
| users/supplier/items/item/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). | |||
| users/supplier/items/item/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. | |||
| users/supplier/items/itemType | Obligatorio | numeric | |
| Tipo de elemento. Valores permitidos: 1 - Productos, 2 - Categorías | |||
| users/supplier/logo | Opcional | string | |
| Imagen del logotipo del proveedor. | |||
| users/systemLevel | Opcional | 4 | numeric |
| Nivel de administrador. Solo para usuarios administradores de Backoffice. Valores permitidos: 3 - Superadministrador, 4 - Administrador | |||
| users/useShippingAddress | Opcional | boolean | |
| Define si el usuario utiliza una dirección de envío adicional. | |||
| users/userType | Opcional | 1 | numeric |
| users/verified | Opcional | true | boolean |
| Define si el usuario está verificado. | |||
| users/visits | Opcional | 1 | numeric |
| users/vouchers | Opcional | array [0:n] | |
| Bloque de información de bonos. Vincula este tipo de promoción al usuario. | |||
| users/vouchers/availableBalance | Obligatorio | numeric | |
| Indica el saldo disponible del bono. | |||
| users/vouchers/code | Opcional | string | |
| Indica el código alfanumérico que identifica al bono. | |||
| users/vouchers/currencyId | Obligatorio | numeric | |
| users/vouchers/expirationDate | Opcional | datetime | |
| Fecha de caducidad del bono. | |||
| users/vouchers/pId | Opcional | string | |
| users/wishlist | Opcional | array [0:n] | |
| Bloque de información de los productos de laa lista de favoritos. | |||
| users/wishlist/id | Opcional | 0 | numeric |
| Identificador interno del producto que se quiere asignar a la lista. Opcional en caso que se use identificador público. | |||
| users/wishlist/pId | Opcional | string | |
| Identificador público del elemento que se quiere asignar a la lista. Opcional en caso que se use identificador interno. | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"ACTIVE" : true,
"ADDRESSBOOK": {
"BILLINGADDRESS": [
{
"ADDRESS" :"Milà i Fontanals, 3",
"ADDRESSADDITIONALINFORMATION" :"additional",
"ALIAS" :"Default Address",
"CITY" :"IGUALADA",
"COMPANY" :"",
"COUNTRY" :"ES",
"DEFAULT" : 1,
"FAX" :"",
"FIRSTNAME" :"Brian",
"ID" : 12,
"LASTNAME" :"Baidal",
"LOCATIONID" : 28706,
"MOBILE" :"931842974",
"NIF" :"",
"NUMBER" :"",
"PHONE" :"",
"PID" :"",
"POSTALCODE" :"08700",
"RE" : false,
"REVERSECHARGEVAT" : false,
"STATE" :"BARCELONA",
"TAX" : true,
"USERID" : 3599,
"USERTYPE" : 1,
"VAT" :""
}
],
"SHIPPINGADDRESS": [
{
"ADDRESS" :"Milà i Fontanals, 3",
"ADDRESSADDITIONALINFORMATION" :"additional",
"ALIAS" :"Default Address",
"CITY" :"IGUALADA",
"COMPANY" :"",
"COUNTRY" :"ES",
"DEFAULT" : 1,
"FAX" :"",
"FIRSTNAME" :"Brian",
"ID" : 12,
"LASTNAME" :"Baidal",
"LOCATIONID" : 28706,
"MOBILE" :"931842974",
"NIF" :"",
"NUMBER" :"",
"PHONE" :"",
"PID" :"",
"POSTALCODE" :"08700",
"STATE" :"BARCELONA",
"USERID" : 3599,
"USERTYPE" : 1,
"VAT" :""
}
]
},
"AGENT" : false,
"BIRTHDAY" :"1980-03-14",
"CHATSUPPORT" : false,
"CUSTOMTAGS": {
"GENERAL": [
{
"ACTIVE" : true,
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
},
"VALUE" :"123"
}
],
"LANGUAGES": [
{
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
},
"LANGUAGES": [
{
"ACTIVE" : true,
"LANGUAGE" :"ES",
"VALUE" :"123"
}
]
}
],
"SELECTABLE": [
{
"ACTIVE" : true,
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
},
"VALUE": {
"ID" : 1,
"PID" :"abc"
}
}
]
},
"DATEADDED" :"2015-10-20",
"DEFAULTLANGUAGE" :"ES",
"EMAIL" :"a@b.com",
"GENDER" : 1,
"GROUP": {
"ID" : 3,
"PID" :""
},
"IMAGE" :"carlos.jpg",
"LANGUAGE" :"ES",
"LASTUSED" :"2015-11-05",
"LATITUDE" : 213.345,
"LONGITUDE" : 126.789,
"NICK" :"Charly",
"PID" :"CarlosG",
"RE" :"(DEPRECATED)",
"REVERSECHARGEVAT" :"(DEPRECATED)",
"SUBSCRIBED" : true,
"SUPPLIER": {
"ACTIVE" : true,
"ITEMS": [
{
"ITEM": {
"ID" : 123,
"PID" :"abc"
},
"ITEMTYPE" : 1
}
],
"LOGO" :"",
"PID" :"abc"
},
"SYSTEMLEVEL" : 4,
"TAX" :"(DEPRECATED)",
"TICKETINGSUPPORT" : false,
"USERTYPE" :"(DEPRECATED)",
"USESHIPPINGADDRESS" : false,
"VERIFIED" : true,
"VOUCHERS": [
{
"VOUCHERS": [
{
"AVAILABLEBALANCE" : 23.24,
"CODE" :"",
"CURRENCY" :"EUR",
"EXPIRATIONDATE" :"2014-10-12",
"ID" : 2574778
}
]
}
],
"WISHLIST": [
{
"ID" : 13,
"PID" :"abc"
}
]
}
GET /users/{id}
Descripción
Devuelve la información del usuario indicado mediante identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/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. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACTIVE" : true,
"ADDRESSBOOK": {
"BILLINGADDRESS": [
],
"SHIPPINGADDRESS": [
]
},
"AGENT" : false,
"BIRTHDAY" :"1980-03-14",
"CHATSUPPORT" : false,
"CUSTOMTAGS": {
"GENERAL": [
{
"ACTIVE" : true,
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
},
"VALUE" :"123"
}
],
"LANGUAGES": [
{
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
},
"LANGUAGES": [
{
"ACTIVE" : true,
"LANGUAGE" :"ES",
"VALUE" :"123"
}
]
}
],
"SELECTABLE": [
{
"ACTIVE" : true,
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
},
"VALUE": {
"ID" : 1,
"PID" :"abc"
}
}
]
},
"DATEADDED" :"2015-10-20",
"DEFAULTLANGUAGE" :"ES",
"EMAIL" :"a@b.com",
"GENDER" : 1,
"GROUP": {
"ID" : 3,
"PID" :""
},
"IMAGE" :"carlos.jpg",
"LANGUAGE" :"ES",
"LASTUSED" :"2015-11-05",
"LATITUDE" : 213.345,
"LONGITUDE" : 126.789,
"NICK" :"Charly",
"PID" :"CarlosG",
"RE" :"(DEPRECATED)",
"REVERSECHARGEVAT" :"(DEPRECATED)",
"SUBSCRIBED" : true,
"SUPPLIER": {
"ACTIVE" : true,
"ITEMS": [
{
"ITEM": {
"ID" : 123,
"PID" :"abc"
},
"ITEMTYPE" : 1
}
],
"LOGO" :"",
"PID" :"abc"
},
"SYSTEMLEVEL" : 4,
"TAX" :"(DEPRECATED)",
"TICKETINGSUPPORT" : false,
"USERTYPE" :"(DEPRECATED)",
"USESHIPPINGADDRESS" : false,
"VERIFIED" : true,
"VOUCHERS": [
{
"VOUCHERS": [
{
"AVAILABLEBALANCE" : 23.24,
"CODE" :"",
"CURRENCY" :"EUR",
"EXPIRATIONDATE" :"2014-10-12",
"ID" : 2574778
}
]
}
],
"WISHLIST": [
{
"ID" : 13,
"PID" :"abc"
}
]
}
PUT /users/{id}
Descripción
Edición del usuario indicado mediante identificador interno. Permite modificar los datos básicos de usuario.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "users": { "active":boolean, "email":email, "gender":numeric, "group": { "id":numeric, "pId":string }, "languageCode":string, "pId":string, "password":string, "salesAgent":boolean, "systemLevel":numeric, "userType":numeric, "verified":boolean, "birthDay": datetime "blogVerified": boolean "currencyCode": string "image": string "nick": string "useShippingAddress": boolean "visits": numeric } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| users | Obligatorio | struct | |
| Bloque de información que contiene la definición de un usuario. | |||
| users/active | Opcional | true | boolean |
| Define si el usuario está activo. Si no está activo no podrá identificarse en la tienda. | |||
| users/birthDay | Opcional | datetime | |
| Define la fecha de nacimiento del cliente. Debe estar en formato ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm). | |||
| users/blogVerified | Opcional | false | boolean |
| users/currencyCode | Opcional | string | |
| users/email | Opcional | ||
| Indica el correo electrónico del usuario. | |||
| users/gender | Opcional | 1 | numeric |
| Define el género del usuario. Valores permitidos: 1 - Hombre, 2 - Mujer | |||
| users/group | Opcional | struct | |
| Bloque para definir el grupo al que pertenece el usuario. | |||
| users/group/id | Opcional | 0 | numeric |
| Identificador interno del grupo que se quiere asignar. Opcional en caso que se use identificador público. | |||
| users/group/pId | Opcional | string | |
| Identificador público del grupo que se quiere asignar. Opcional en caso que se use identificador interno. | |||
| users/image | Opcional | string | |
| Imagen de usuario. Se debe indicar la ruta (relativa si es propia) de la imagen. | |||
| users/languageCode | Opcional | string | |
| Define el idioma por defecto del usuario. | |||
| users/nick | Opcional | string | |
| Indica el nombre de usuario para poder entrar en el gestor del eCommerce. Solo para usuarios administradores de Backoffice. | |||
| users/pId | Opcional | string | |
| Identificador público del usuario. | |||
| users/password | Opcional | string | |
| Indica la contraseña de acceso del usuario. | |||
| users/salesAgent | Opcional | false | boolean |
| Define si el usuario tiene el rol de agente de ventas. | |||
| users/systemLevel | Opcional | 4 | numeric |
| Nivel de administrador. Solo para usuarios administradores de Backoffice. Valores permitidos: 3 - Superadministrador, 4 - Administrador | |||
| users/useShippingAddress | Opcional | boolean | |
| Define si el usuario utiliza una dirección de envío adicional. | |||
| users/userType | Opcional | numeric | |
| users/verified | Opcional | true | boolean |
| Define si el usuario está verificado. | |||
| users/visits | Opcional | 1 | numeric |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACTIVE" : true,
"ADDRESSBOOK": {
"BILLINGADDRESS": [
],
"SHIPPINGADDRESS": [
]
},
"AGENT" : false,
"BIRTHDAY" :"1980-03-14",
"CHATSUPPORT" : false,
"CUSTOMTAGS": {
"GENERAL": [
{
"ACTIVE" : true,
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
},
"VALUE" :"123"
}
],
"LANGUAGES": [
{
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
},
"LANGUAGES": [
{
"ACTIVE" : true,
"LANGUAGE" :"ES",
"VALUE" :"123"
}
]
}
],
"SELECTABLE": [
{
"ACTIVE" : true,
"CUSTOMTAG": {
"ID" : 1,
"PID" :"abc"
},
"GROUP": {
"ID" : 1,
"PID" :"abc"
},
"VALUE": {
"ID" : 1,
"PID" :"abc"
}
}
]
},
"DATEADDED" :"2015-10-20",
"DEFAULTLANGUAGE" :"ES",
"EMAIL" :"a@b.com",
"GENDER" : 1,
"GROUP": {
"ID" : 3,
"PID" :""
},
"IMAGE" :"carlos.jpg",
"LANGUAGE" :"ES",
"LASTUSED" :"2015-11-05",
"LATITUDE" : 213.345,
"LONGITUDE" : 126.789,
"NICK" :"Charly",
"PID" :"CarlosG",
"RE" :"(DEPRECATED)",
"REVERSECHARGEVAT" :"(DEPRECATED)",
"SUBSCRIBED" : true,
"SUPPLIER": {
"ACTIVE" : true,
"ITEMS": [
{
"ITEM": {
"ID" : 123,
"PID" :"abc"
},
"ITEMTYPE" : 1
}
],
"LOGO" :"",
"PID" :"abc"
},
"SYSTEMLEVEL" : 4,
"TAX" :"(DEPRECATED)",
"TICKETINGSUPPORT" : false,
"USERTYPE" :"(DEPRECATED)",
"USESHIPPINGADDRESS" : false,
"VERIFIED" : true,
"VOUCHERS": [
{
"VOUCHERS": [
{
"AVAILABLEBALANCE" : 23.24,
"CODE" :"",
"CURRENCY" :"EUR",
"EXPIRATIONDATE" :"2014-10-12",
"ID" : 2574778
}
]
}
],
"WISHLIST": [
{
"ID" : 13,
"PID" :"abc"
}
]
}
DELETE /users/{id}
Descripción
Elimina al usuario indicado mediante identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/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 /users/{id}/addressbook
Descripción
Devuelve la libreta de direcciones del usuario indicado. La libreta de direcciones está compuesta por el conjunto de todas las direcciones de facturación y todas las de envío.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/1/addressbook
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"BILLINGADDRESS": [
{
"ADDRESS" :"Milà i Fontanals, 3",
"ADDRESSADDITIONALINFORMATION" :"additional",
"ALIAS" :"Default Address",
"CITY" :"IGUALADA",
"COMPANY" :"",
"COUNTRY" :"ES",
"DEFAULT" : 1,
"FAX" :"",
"FIRSTNAME" :"Brian",
"ID" : 12,
"LASTNAME" :"Baidal",
"LOCATIONID" : 28706,
"MOBILE" :"931842974",
"NIF" :"",
"NUMBER" :"",
"PHONE" :"",
"PID" :"",
"POSTALCODE" :"08700",
"RE" : false,
"REVERSECHARGEVAT" : false,
"STATE" :"BARCELONA",
"TAX" : true,
"USERID" : 3599,
"USERTYPE" : 1,
"VAT" :""
}
],
"SHIPPINGADDRESS": [
{
"ADDRESS" :"Milà i Fontanals, 3",
"ADDRESSADDITIONALINFORMATION" :"additional",
"ALIAS" :"Default Address",
"CITY" :"IGUALADA",
"COMPANY" :"",
"COUNTRY" :"ES",
"DEFAULT" : 1,
"FAX" :"",
"FIRSTNAME" :"Brian",
"ID" : 12,
"LASTNAME" :"Baidal",
"LOCATIONID" : 28706,
"MOBILE" :"931842974",
"NIF" :"",
"NUMBER" :"",
"PHONE" :"",
"PID" :"",
"POSTALCODE" :"08700",
"STATE" :"BARCELONA",
"USERID" : 3599,
"USERTYPE" : 1,
"VAT" :""
}
]
}
POST /users/{id}/addressbook
Descripción
Crea una nueva dirección de facturación o envío al usuario indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/1/addressbook
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "addressbook": { "countryCode":string, "firstName":string, "pId":string, "postalCode":string, "re":boolean, "reverseChargeVat":boolean, "tax":boolean, "type":string, "userType":numeric, "alias": string "address": string "addressAdditionalInformation": string "city": string "company": string "default": boolean "fax": string "lastName": string "latitude": numeric "longitude": numeric "mobile": string "nif": string "number": string "phone": string "state": string "vat": string } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| addressbook | Obligatorio | struct | |
| Bloque de información que define la libreta de direcciones del usuario. Esta libreta está compuesta por las distintas direcciones de facturación y/o envío que tiene el usuario y los campos que aquí se definen se refieren a cada una de las direcciones que se establezcan. | |||
| addressbook/address | Opcional | string | |
| Indica la dirección. | |||
| addressbook/addressAdditionalInformation | Opcional | string | |
| addressbook/alias | Obligatorio | string | |
| Indica un alias o nombre que identificará la dirección dentro de una lista en los procesos de compra. Este nombre se usa para etiquetar de manera cómoda las diferentes direcciones de la libreta. | |||
| addressbook/city | Opcional | string | |
| Indica el nombre de la ciudad. | |||
| addressbook/company | Opcional | string | |
| Indica el nombre de la empresa (este campo es obligatorio cuando el usuario es de tipo empresa). | |||
| addressbook/countryCode | Obligatorio | string | |
| addressbook/default | Opcional | false | boolean |
| Indica si es dirección principal o por defecto. Es la que se usa de manera automática si no se dice lo contrario en los procesos de compra. | |||
| addressbook/fax | Opcional | string | |
| Indica el número de fax. | |||
| addressbook/firstName | Opcional | string | |
| Indica el nombre (este campo es obligatorio cuando el usuario es de tipo particular o autónomo). | |||
| addressbook/lastName | Opcional | string | |
| Indica los apellidos. | |||
| addressbook/latitude | Opcional | numeric | |
| addressbook/longitude | Opcional | numeric | |
| addressbook/mobile | Opcional | string | |
| Indica el número de teléfono móvil. | |||
| addressbook/nif | Opcional | string | |
| Indica el número de identidad. | |||
| addressbook/number | Opcional | string | |
| Indica la numeración de la dirección. | |||
| addressbook/pId | Obligatorio | string | |
| Identificador público de la dirección. | |||
| addressbook/phone | Opcional | string | |
| Indica el número de teléfono. | |||
| addressbook/postalCode | Opcional | string | |
| addressbook/re | Opcional | false | boolean |
| Indica si al usuario se le aplica recargo de equivalencia. | |||
| addressbook/reverseChargeVat | Opcional | false | boolean |
| Indica si el usuario está bajo la consideración fiscal de Invertir sujeto pasivo. | |||
| addressbook/state | Opcional | string | |
| Indica el nombre de la provincia. | |||
| addressbook/tax | Opcional | true | boolean |
| Indica si al usuario se le aplican impuestos. | |||
| addressbook/type | Obligatorio | string | |
| Indica el tipo de dirección. Valores permitidos: 1 - Dirección de facturación, 2 - Dirección de envío | |||
| addressbook/userType | Opcional | 1 | numeric |
| Define el tipo de usuario. Valores permitidos: 1 - Particular, 2 - Empresa, 3 - Autónomo | |||
| addressbook/vat | Opcional | string | |
| Indica la identificación fiscal. | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"BILLINGADDRESS": [
{
"ADDRESS" :"Milà i Fontanals, 3",
"ADDRESSADDITIONALINFORMATION" :"additional",
"ALIAS" :"Default Address",
"CITY" :"IGUALADA",
"COMPANY" :"",
"COUNTRY" :"ES",
"DEFAULT" : 1,
"FAX" :"",
"FIRSTNAME" :"Brian",
"ID" : 12,
"LASTNAME" :"Baidal",
"LOCATIONID" : 28706,
"MOBILE" :"931842974",
"NIF" :"",
"NUMBER" :"",
"PHONE" :"",
"PID" :"",
"POSTALCODE" :"08700",
"RE" : false,
"REVERSECHARGEVAT" : false,
"STATE" :"BARCELONA",
"TAX" : true,
"USERID" : 3599,
"USERTYPE" : 1,
"VAT" :""
}
],
"SHIPPINGADDRESS": [
{
"ADDRESS" :"Milà i Fontanals, 3",
"ADDRESSADDITIONALINFORMATION" :"additional",
"ALIAS" :"Default Address",
"CITY" :"IGUALADA",
"COMPANY" :"",
"COUNTRY" :"ES",
"DEFAULT" : 1,
"FAX" :"",
"FIRSTNAME" :"Brian",
"ID" : 12,
"LASTNAME" :"Baidal",
"LOCATIONID" : 28706,
"MOBILE" :"931842974",
"NIF" :"",
"NUMBER" :"",
"PHONE" :"",
"PID" :"",
"POSTALCODE" :"08700",
"STATE" :"BARCELONA",
"USERID" : 3599,
"USERTYPE" : 1,
"VAT" :""
}
]
}
DELETE /users/{id}/addressbook
Descripción
Borrado de Todas las libretas de direcciones de un usuario.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/1/addressbook
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"BILLINGADDRESS": [
],
"SHIPPINGADDRESS": [
]
}
GET /users/{id}/comments
Descripción
Devuelve los comentarios del usuario indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/1/comments
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. | |||
| fromDate | Opcional | datetime | |
| Devuelve los comentarios a partir de la fecha facilitada del usuario indicado. | |||
| onlyAccepted | Opcional | false | boolean |
| Devuelve los comentarios aceptados del usuario indicado. | |||
| onlyRevised | Opcional | false | boolean |
| Devuelve los comentarios revisados del usuario indicado. | |||
| page | Opcional | 1 | numeric |
| Nº de página solicitada. | |||
| perPage | Opcional | 100 | numeric |
| Cantidad de elementos por página. | |||
| productId | Opcional | 0 | numeric |
| Devuelve los comentarios del producto facilitado por identificador interno del usuario indicado. | |||
| q | Opcional | string | |
| Criterio de búsqueda. | |||
| sort | Opcional | name | string |
| Variable de ordenación. | |||
| toDate | Opcional | datetime | |
| Devuelve los comentarios hasta la fecha facilitada del usuario indicado. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"COMMENTS": [
{
"ACCEPTED" : true,
"ADVANCED": [
{
"COMMENTID" : 1,
"VOTE" : 4
}
],
"COMMENT" :"Comment",
"DATEADDED" :"2015-12-05",
"ID" : 1,
"LANGUAGE" :"ES",
"PRODUCT": {
"id" : 2,
"pId" :"abc"
},
"REVISED" : true
}
],
"CURSORS": {
"NEXT" :"http://api.logicommerce.net/v1/users/1/comments?page=2&perPage=100",
"PREVIOUS" :""
},
"ITEMS" : 100,
"PAGERPARAMETERS": {
"PAGE" : 1,
"PERPAGE" : 100
}
}
GET /users/{id}/customTags
Descripción
Devuelve la información de las etiquetas del usuario indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/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
{
"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 /users/{id}/customTags
Descripción
Vincula una etiqueta al usuario indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/1/customTags
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "customTags": { "customTag": { "id":numeric, "pId":string }, "general": { "value":string, "active": boolean }, "group": { "id":numeric, "pId":string }, "languages": [ { "languageCode":string, "value":string, "active": boolean } ], "selectable": { "active":boolean, "value": { "id":numeric, "pId":string } } } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| customTags | Obligatorio | struct | |
| Bloque para vincular etiquetas de tipo usuario, para esta usuario en concreto. | |||
| customTags/customTag | Obligatorio | struct | |
| Bloque de información asociada a una etiqueta en concreto. Dependiendo del tipo de etiqueta, se debe añadir a continuación bloques del tipo general, languages o selectable. | |||
| customTags/customTag/id | Opcional | 0 | numeric |
| Indica el identificador interno de la etiqueta. Debe existir previamente. Opcional en caso que se use identificador público. | |||
| customTags/customTag/pId | Opcional | string | |
| Indica el identificador público de la etiqueta. Debe existir previamente. Opcional en caso que se use identificador interno. | |||
| customTags/general | Opcional | struct | |
| Bloque para etiquetas cuyos valores no dependen del idioma. | |||
| customTags/general/active | Opcional | false | boolean |
| Define la visibilidad de la etiqueta. | |||
| customTags/general/value | Obligatorio | string | |
| Define el valor de la etiqueta. | |||
| customTags/group | Opcional | struct | |
| Bloque para informar del grupo de etiquetas en caso que la etiqueta pertenezca a más de uno. | |||
| customTags/group/id | Opcional | 0 | numeric |
| Identificador interno del grupo de etiquetas. Opcional en caso que se use identificador público. | |||
| customTags/group/pId | Opcional | string | |
| Identificador público del grupo de etiquetas. Opcional en caso que se use identificador interno. | |||
| customTags/languages | Opcional | array [0:n] | |
| Bloque para etiquetas cuyos valores dependen del idioma. | |||
| customTags/languages/active | Opcional | false | boolean |
| Define la visibilidad de la etiqueta. | |||
| customTags/languages/languageCode | Obligatorio | string | |
| Indica el código de idioma. Formato ISO 639-1 de dos dígitos. Más información en el recurso: util/languages. | |||
| customTags/languages/value | Obligatorio | string | |
| Define el valor de la etiqueta. | |||
| customTags/selectable | Opcional | struct | |
| Bloque para etiquetas cuyos valores estan predefinidos a modo de selector desplegable. | |||
| customTags/selectable/active | Obligatorio | boolean | |
| Define la visibilidad de la etiqueta. | |||
| customTags/selectable/value | Opcional | struct | |
| Bloque para identificar la opción del desplegable. | |||
| customTags/selectable/value/id | Opcional | 0 | numeric |
| Identificador interno del valor que se quiere asignar. Opcional en caso que se use identificador público. | |||
| customTags/selectable/value/pId | Opcional | string | |
| Identificador público del valor que se quiere asignar. Opcional en caso que se use identificador interno. | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"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 /users/{id}/customTags
Descripción
Desvincula todas las etiquetas al usuario indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/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
{
"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"
}
}
]
}
GET /users/{id}/customTags/{customTagId}
Descripción
Devuelve la información de la etiqueta facilitada del usuario indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/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
{
"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"
}
}
]
}
PUT /users/{id}/customTags/{customTagId}
Descripción
Edición de la etiqueta facilitada del usuario indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/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 }, "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 vincular etiquetas de tipo usuario, para esta usuario en concreto. | |||
| customTags/general | Opcional | struct | |
| Bloque para etiquetas cuyos valores no dependen del idioma. | |||
| customTags/general/active | Opcional | false | boolean |
| Define la visibilidad de la etiqueta. | |||
| customTags/general/value | Opcional | string | |
| Define el valor de la etiqueta. | |||
| customTags/group | Opcional | struct | |
| Bloque para informar del grupo de etiquetas en caso que la etiqueta pertenezca a más de uno. | |||
| customTags/group/id | Opcional | 0 | numeric |
| Identificador interno del grupo de etiquetas. Opcional en caso que se use identificador público. | |||
| customTags/group/pId | Opcional | string | |
| Identificador público del grupo de etiquetas. Opcional en caso que se use identificador interno. | |||
| customTags/languages | Opcional | array [0:n] | |
| Bloque para etiquetas cuyos valores dependen del idioma. | |||
| customTags/languages/active | Opcional | false | boolean |
| Define la visibilidad de la etiqueta. | |||
| customTags/languages/languageCode | Obligatorio | string | |
| Indica el código de idioma. Formato ISO 639-1 de dos dígitos. Más información en el recurso: util/languages. | |||
| customTags/languages/value | Opcional | string | |
| Define el valor de la etiqueta. | |||
| customTags/selectable | Opcional | struct | |
| Bloque para etiquetas cuyos valores estan predefinidos a modo de selector desplegable. | |||
| customTags/selectable/active | Opcional | boolean | |
| Define la visibilidad de la etiqueta. | |||
| customTags/selectable/value | Opcional | struct | |
| Bloque para identificar la opción del desplegable. | |||
| customTags/selectable/value/id | Opcional | 0 | numeric |
| Identificador interno del valor que se quiere asignar. Opcional en caso que se use identificador público. | |||
| customTags/selectable/value/pId | Opcional | string | |
| Identificador público del valor que se quiere asignar. Opcional en caso que se use identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"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 /users/{id}/customTags/{customTagId}
Descripción
Desvincula la etiqueta facilitada del usuario indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/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
{
"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"
}
}
]
}
GET /users/{id}/rewardPoints
Descripción
Devuelve la información de los rewardPoints del usuario indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/1/rewardPoints
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"rewardPoints": [
{
"balances": {
"availables" : 10,
"earned" : 20,
"pending" : 0,
"redeemed" : 10
},
"rewardPoints": {
"id" : 2,
"pId" :"ssss"
}
}
]
}
POST /users/{id}/rewardPoints
Descripción
Asigna rewardPoints al usuario indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/1/rewardPoints
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "rewardPoints": { "rewardPointsId":numeric, "value":numeric } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| rewardPoints | Obligatorio | struct | |
| Bloque de información de los rewardPoints. | |||
| rewardPoints/rewardPointsId | Obligatorio | numeric | |
| Identificador interno del rewardPoint. | |||
| rewardPoints/value | Obligatorio | numeric | |
| Valor de rewardPoints a asignar. Si desea realizar gasto de reward points, debe asignar un valor negativo. | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"result" :"ok"
}
GET /users/{id}/salesAgent
Descripción
Devuelve la información del agente de venta.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/1/salesAgent
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,
"COMISSION" : 10,
"PID" :"abc",
"USERS": [
{
"ID" : 1,
"PID" :"fgh"
}
]
}
PUT /users/{id}/salesAgent
Descripción
Edición de los datos del agente de venta.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/1/salesAgent
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "salesAgent": { "active":boolean, "pId":string, "percentCommission":numeric } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| salesAgent | Obligatorio | struct | |
| Bloque de información sobre el agente de venta. | |||
| salesAgent/active | Opcional | boolean | |
| Define si el agente de venta está activo. | |||
| salesAgent/pId | Opcional | string | |
| Identificador público del agente de venta. | |||
| salesAgent/percentCommission | Opcional | numeric | |
| Define el porcentaje de comissión. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACTIVE" : true,
"COMISSION" : 10,
"PID" :"abc",
"USERS": [
{
"ID" : 1,
"PID" :"fgh"
}
]
}
POST /users/{id}/salesAgent/{userId}
Descripción
Vincula un usuario al agente de venta
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/1/salesAgent/{userId}
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
| userId | Obligatorio | numeric | |
| Indentificador del usuario a vincular | |||
Parámetros de entrada JSON
{ } |
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"ID" : 1,
"USERID" : 34
}
DELETE /users/{id}/salesAgent/{userId}
Descripción
Desvincula un usuario al agente de venta
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/1/salesAgent/{userId}
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,
"USERID" : 34
}
GET /users/{id}/shoppingLists
Descripción
Devuelve la información de las listas de compra del usuario indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/1/shoppingLists
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
| defaultOne | Opcional | string | |
| idList | Opcional | string | |
| 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. | |||
| sort | Opcional | string | |
| Variable de ordenación. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
No implemented response
GET /users/{id}/supplier
Descripción
Devuelve la información de proveedor correspondiente al usuario indicado. Si el usuario no es un proveedor, el sistema devolverá un error.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/1/supplier
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,
"ITEMS": [
{
"ITEM": {
"ID" : 123,
"PID" :"abc"
},
"ITEMTYPE" : 1
}
],
"LOGO" :"",
"PID" :"abc"
}
PUT /users/{id}/supplier
Descripción
Edición de la información de proveedor correspondiente al usuario indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/1/supplier
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "supplier": { "active":boolean, "logo": string } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| supplier | Obligatorio | struct | |
| Bloque de información de proveedor. Necesario si el usuario tiene el rol de proveedor. | |||
| supplier/active | Opcional | true | boolean |
| Indica si está activo. | |||
| supplier/logo | Opcional | string | |
| Imagen del logotipo del proveedor. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACTIVE" : true,
"ITEMS": [
{
"ITEM": {
"ID" : 123,
"PID" :"abc"
},
"ITEMTYPE" : 1
}
],
"LOGO" :"",
"PID" :"abc"
}
POST /users/{id}/supplier/items
Descripción
Vincular un producto o categoría al usuario proveedor indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/1/supplier/items
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "supplierItems": { "item": { "id":numeric, "pId":string }, "itemType":numeric } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| supplierItems | Obligatorio | struct | |
| Bloque de categorías y/o productos vinculados al proveedor. | |||
| supplierItems/item | Obligatorio | struct | |
| Bloque de información asociada a un elemento en concreto. | |||
| supplierItems/item/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). | |||
| supplierItems/item/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. | |||
| supplierItems/itemType | Obligatorio | numeric | |
| Tipo de elemento. Valores permitidos: 1 - Productos, 2 - Categorías | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"ACTIVE" : true,
"ITEMS": [
{
"ITEM": {
"ID" : 123,
"PID" :"abc"
},
"ITEMTYPE" : 1
}
],
"LOGO" :"",
"PID" :"abc"
}
DELETE /users/{id}/supplier/items
Descripción
Elimina todas las vinculaciones de producto o categoría de proveedor que se hayan establecido para el usuario indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/1/supplier/items
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,
"ITEMS": [
{
"ITEM": {
"ID" : 123,
"PID" :"abc"
},
"ITEMTYPE" : 1
}
],
"LOGO" :"",
"PID" :"abc"
}
DELETE /users/{id}/supplier/items/{productId}
Descripción
Elimina la vinculación de un producto de proveedor determinado que se haya establecido para el usuario indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/1/supplier/items/{productId}
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
| productId | Obligatorio | numeric | |
| Identificador interno de producto. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 23535
}
GET /users/{id}/vouchers
Descripción
Devuelve la información de los cupones de regalo vinculados al usuario indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/1/vouchers
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"VOUCHERS": [
{
"AVAILABLEBALANCE" : 23.24,
"CODE" :"",
"CURRENCY" :"EUR",
"EXPIRATIONDATE" :"2014-10-12",
"ID" : 2574778
}
]
}
POST /users/{id}/vouchers
Descripción
Asignar un nuevo cupón de regalo al usuario indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/1/vouchers
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "vouchers": { "availableBalance":numeric, "currencyCode":string, "currencyId": numeric "code": string "expirationDate": datetime "pId": string } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| vouchers | Obligatorio | struct | |
| Bloque de información de bonos. Vincula este tipo de promoción al usuario. | |||
| vouchers/availableBalance | Obligatorio | numeric | |
| Indica el saldo disponible del bono. | |||
| vouchers/code | Opcional | string | |
| Indica el código alfanumérico que identifica al bono. | |||
| vouchers/currencyCode | Obligatorio | string | |
| Código de la moneda en formato ISO 4217. | |||
| vouchers/currencyId | Obligatorio | numeric | |
| vouchers/expirationDate | Opcional | datetime | |
| Fecha de caducidad del bono. | |||
| vouchers/pId | Opcional | string | |
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"VOUCHERS": [
{
"AVAILABLEBALANCE" : 23.24,
"CODE" :"",
"CURRENCY" :"EUR",
"EXPIRATIONDATE" :"2014-10-12",
"ID" : 2574778
}
]
}
DELETE /users/{id}/vouchers
Descripción
Elimina todos los cupones de regalo del usuario indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/1/vouchers
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"VOUCHERS": [
]
}
GET /users/{id}/wishlist
Descripción
Devuelve la información de los productos de la lista de favoritos del usuario indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/1/wishlist
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"WISHLIST": [
{
"ID" : 13,
"PID" :"abc"
},
{
"ID" : 123,
"PID" :"tyu"
}
]
}
POST /users/{id}/wishlist
Descripción
Vincula un producto a la lista de favoritos del usuario indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/1/wishlist
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "wishlist": { "id":numeric, "pId":string } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| wishlist | Obligatorio | struct | |
| Bloque de información de los productos de laa lista de favoritos. | |||
| wishlist/id | Opcional | 0 | numeric |
| Identificador interno del producto que se quiere asignar a la lista. Opcional en caso que se use identificador público. | |||
| wishlist/pId | Opcional | string | |
| Identificador público del elemento que se quiere asignar a la lista. Opcional en caso que se use identificador interno. | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"WISHLIST": [
{
"ID" : 13,
"PID" :"abc"
},
{
"ID" : 123,
"PID" :"tyu"
}
]
}
DELETE /users/{id}/wishlist
Descripción
Elimina toda la lista de productos favoritos del usuario indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/1/wishlist
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"WISHLIST": [
]
}
DELETE /users/{id}/wishlist/{productId}
Descripción
Elimina de la lista de favoritos el producto indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/1/wishlist/{productId}
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
| productId | Obligatorio | numeric | |
| Identificador interno de producto. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 13,
"PID" :"abc"
}
GET /users/addressbook/{id}
Descripción
Devuelve la información de la libreta de direcciones indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/addressbook/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
{
"address" :"Milà i Fontanals, 3",
"alias" :"Default Address",
"city" :"IGUALADA",
"company" :"",
"country" :"ES",
"default" : 1,
"fax" :"",
"firstname" :"Brian",
"id" : 12,
"lastname" :"Baidal",
"locationId" : 28706,
"mobile" :"931842974",
"nif" :"",
"number" :"",
"phone" :"",
"pid" :"",
"postalcode" :"08700",
"re" : false,
"reverseChargeVat" : false,
"state" :"BARCELONA",
"tax" : true,
"type" : 1,
"userType" : 1,
"vat" :""
}
PUT /users/addressbook/{id}
Descripción
Edición del registro indicado de la libreta de direcciones.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/addressbook/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "addressbook": { "alias":string, "countryCode":string, "firstName":string, "pId":string, "postalCode":string, "re":boolean, "reverseChargeVat":boolean, "tax":boolean, "userType":numeric, "address": string "addressAdditionalInformation": string "city": string "company": string "fax": string "lastName": string "latitude": numeric "longitude": numeric "mobile": string "nif": string "number": string "phone": string "state": string "vat": string } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| addressbook | Obligatorio | struct | |
| Bloque de información que define la libreta de direcciones del usuario. Esta libreta está compuesta por las distintas direcciones de facturación y/o envío que tiene el usuario y los campos que aquí se definen se refieren a cada una de las direcciones que se establezcan. | |||
| addressbook/address | Opcional | string | |
| Indica la dirección. | |||
| addressbook/addressAdditionalInformation | Opcional | string | |
| addressbook/alias | Opcional | string | |
| Indica un alias o nombre que identificará la dirección dentro de una lista en los procesos de compra. Este nombre se usa para etiquetar de manera cómoda las diferentes direcciones de la libreta. | |||
| addressbook/city | Opcional | string | |
| Indica el nombre de la ciudad. | |||
| addressbook/company | Opcional | string | |
| Indica el nombre de la empresa (este campo es obligatorio cuando el usuario es de tipo empresa). | |||
| addressbook/countryCode | Opcional | string | |
| addressbook/fax | Opcional | string | |
| Indica el número de fax. | |||
| addressbook/firstName | Opcional | string | |
| Indica el nombre (este campo es obligatorio cuando el usuario es de tipo particular o autónomo). | |||
| addressbook/lastName | Opcional | string | |
| Indica los apellidos. | |||
| addressbook/latitude | Opcional | numeric | |
| addressbook/longitude | Opcional | numeric | |
| addressbook/mobile | Opcional | string | |
| Indica el número de teléfono móvil. | |||
| addressbook/nif | Opcional | string | |
| Indica el número de identidad. | |||
| addressbook/number | Opcional | string | |
| Indica la numeración de la dirección. | |||
| addressbook/pId | Opcional | string | |
| Identificador público de la dirección. | |||
| addressbook/phone | Opcional | string | |
| Indica el número de teléfono. | |||
| addressbook/postalCode | Opcional | string | |
| addressbook/re | Opcional | false | boolean |
| Indica si al usuario se le aplica recargo de equivalencia. | |||
| addressbook/reverseChargeVat | Opcional | false | boolean |
| Indica si el usuario está bajo la consideración fiscal de Invertir sujeto pasivo. | |||
| addressbook/state | Opcional | string | |
| Indica el nombre de la provincia. | |||
| addressbook/tax | Opcional | true | boolean |
| Indica si al usuario se le aplican impuestos. | |||
| addressbook/userType | Opcional | 1 | numeric |
| Define el tipo de usuario. Valores permitidos: 1 - Particular, 2 - Empresa, 3 - Autónomo | |||
| addressbook/vat | Opcional | string | |
| Indica la identificación fiscal. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"address" :"Milà i Fontanals, 3",
"alias" :"Default Address",
"city" :"IGUALADA",
"company" :"",
"country" :"ES",
"default" : 1,
"fax" :"",
"firstname" :"Brian",
"id" : 12,
"lastname" :"Baidal",
"locationId" : 28706,
"mobile" :"931842974",
"nif" :"",
"number" :"",
"phone" :"",
"pid" :"",
"postalcode" :"08700",
"re" : false,
"reverseChargeVat" : false,
"state" :"BARCELONA",
"tax" : true,
"type" : 1,
"userType" : 1,
"vat" :""
}
DELETE /users/addressbook/{id}
Descripción
Elimina la dirección indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/addressbook/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 /users/count
Descripción
Devuelve un valor que indica la cantidad de usuarios. Los parámetros de entrada permiten filtrar a los usuarios contados.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/count
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| groupId | Opcional | 0 | numeric |
| Devuelve elementos asociados al grupo indicado mediante identificador interno. | |||
| q | Opcional | string | |
| Criterio de búsqueda. | |||
| showOnlyActive | Opcional | false | boolean |
| Devuelve únicamente usuarios activos. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ITEMS" : 100
}
GET /users/getId/{pId}
Descripción
Devuelve el identificador interno del usuario.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/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" : 5
}
GET /users/shoppingLists/{id}/rows
Descripción
Devuelve la información de la lista de compra indicada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/shoppingLists/1/rows
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Indentificador interno de la lista de compra | |||
| 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. | |||
| sort | Opcional | string | |
| Variable de ordenación. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
No implemented response
POST /users/shoppingLists/{id}/rows
Descripción
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/shoppingLists/1/rows
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "items": [ { "comment":string, "importance":string, "pId":string, "priority":numeric, "quantity":numeric, "reference": { "bundleOptions": [ { "id":numeric, "options": [ { "id":numeric, "values": [ { "value":numeric } ] } ] } ], "id":numeric, "productOptions": [ { "id":numeric, "values": [ { "value":numeric } ] } ], "type":string } } ] } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| items | Opcional | array [0:n] | |
| items/comment | Opcional | string | |
| items/importance | Opcional | string | |
| items/pId | Opcional | string | |
| items/priority | Opcional | numeric | |
| items/quantity | Opcional | numeric | |
| items/reference | Opcional | struct | |
| items/reference/bundleOptions | Opcional | array [0:n] | |
| items/reference/bundleOptions/id | Opcional | numeric | |
| items/reference/bundleOptions/options | Opcional | array [0:n] | |
| items/reference/bundleOptions/options/id | Opcional | numeric | |
| items/reference/bundleOptions/options/values | Opcional | array [0:n] | |
| items/reference/bundleOptions/options/values/value | Opcional | numeric | |
| items/reference/id | Opcional | numeric | |
| items/reference/productOptions | Opcional | array [0:n] | |
| items/reference/productOptions/id | Opcional | numeric | |
| items/reference/productOptions/values | Opcional | array [0:n] | |
| items/reference/productOptions/values/value | Opcional | numeric | |
| items/reference/type | Opcional | string |
HTTP statusCode
201 CREATED
Ejemplo de respuesta
No implemented response
DELETE /users/shoppingLists/rows/{id}
Descripción
Elimina la linea de compra indicada de su lista de compra.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/shoppingLists/rows/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Indentificador interno de la linea de la lista de compra | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
No implemented response
GET /users/vouchers/{id}
Descripción
Devuelve la información del cupón de regalo con el identificador indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/vouchers/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
{
"AVAILABLEBALANCE" : 23.24,
"CODE" :"",
"CURRENCY" :"EUR",
"EXPIRATIONDATE" :"2014-10-12",
"ID" : 2574778
}
PUT /users/vouchers/{id}
Descripción
Edición del cupón de regalo con el identificador indicado. Este recurso permite modificar solo cupones vinculados a usuario, para editar otros tipos de cupones de regalo se deben usar los recursos del endpoint Cupones de descueto para este propósito.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/vouchers/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "vouchers": { "availableBalance":numeric, "currencyCode":string, "currencyId": numeric "code": string "expirationDate": datetime "pId": string } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| vouchers | Obligatorio | struct | |
| Bloque de información de bonos. Vincula este tipo de promoción al usuario. | |||
| vouchers/availableBalance | Opcional | numeric | |
| Indica el saldo disponible del bono. | |||
| vouchers/code | Opcional | string | |
| Indica el código alfanumérico que identifica al bono. | |||
| vouchers/currencyCode | Obligatorio | string | |
| Código de la moneda en formato ISO 4217. | |||
| vouchers/currencyId | Obligatorio | numeric | |
| vouchers/expirationDate | Opcional | datetime | |
| Fecha de caducidad del bono. | |||
| vouchers/pId | Opcional | string | |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"AVAILABLEBALANCE" : 23.24,
"CODE" :"",
"CURRENCY" :"EUR",
"EXPIRATIONDATE" :"2014-10-12",
"ID" : 2574778
}
DELETE /users/vouchers/{id}
Descripción
Elimina el cupón de regalo con el identificador indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/users/vouchers/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 /usersGroups
Descripción
Devuelve el listado de grupos de usuarios.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/usersGroups
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"USERSGROUPS": [
{
"DATEADDED" :"2015-05-23",
"DEFAULTGROUP" : 1,
"DESCRIPTION" :"Description abc",
"ID" : 43,
"NAME" :"UserGroup 1",
"PID" :"abc",
"SYSTEMGROUP" : 0
}
]
}
POST /usersGroups
Descripción
Creación de un nuevo grupo de usuarios.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/usersGroups
Parámetros de entrada JSON
{ "usersGroups": { "defaultGroup":boolean, "pId":string, "systemGroup":boolean, "name": string "description": string } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| usersGroups | Obligatorio | struct | |
| Bloque de información del grupo de usuario. | |||
| usersGroups/defaultGroup | Opcional | false | boolean |
| Indica si es grupo por defecto. Se debe cumplir: - Solo puede haber un grupo por defecto, la activación de uno desactiva automáticamente al anterior. - Un grupo de usuarios no puede ser grupo de sistema y por defecto a la vez. | |||
| usersGroups/description | Opcional | string | |
| Descripción del grupo de usuarios. | |||
| usersGroups/name | Obligatorio | string | |
| Indica el nombre. | |||
| usersGroups/pId | Obligatorio | string | |
| Identificador público del grupo de usuarios. | |||
| usersGroups/systemGroup | Opcional | false | boolean |
| Indica si es grupo de sistema (grupo de administradores). Se debe cumplir: - Solo puede haber un grupo de sistema, la activación de uno desactiva automáticamente al anterior. - Un grupo de usuarios no puede ser grupo de sistema y por defecto a la vez. | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"DATEADDED" :"2015-05-23",
"DEFAULTGROUP" : 1,
"DESCRIPTION" :"Description abc",
"ID" : 43,
"NAME" :"UserGroup 1",
"PID" :"abc",
"SYSTEMGROUP" : 0
}
GET /usersGroups/{id}
Descripción
Devuelve la información del grupo de usuarios indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/usersGroups/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
{
"DATEADDED" :"2015-05-23",
"DEFAULTGROUP" : 1,
"DESCRIPTION" :"Description abc",
"ID" : 43,
"NAME" :"UserGroup 1",
"PID" :"abc",
"SYSTEMGROUP" : 0
}
PUT /usersGroups/{id}
Descripción
Edición del grupo de usuarios indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/usersGroups/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "usersGroups": { "defaultGroup":boolean, "description":string, "name":string, "pId":string, "systemGroup":boolean } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| usersGroups | Obligatorio | struct | |
| Bloque de información del grupo de usuario. | |||
| usersGroups/defaultGroup | Opcional | false | boolean |
| Indica si es grupo por defecto. Se debe cumplir: - Solo puede haber un grupo por defecto, la activación de uno desactiva automáticamente al anterior. - Un grupo de usuarios no puede ser grupo de sistema y por defecto a la vez. | |||
| usersGroups/description | Opcional | string | |
| Descripción del grupo de usuarios. | |||
| usersGroups/name | Opcional | string | |
| Indica el nombre. | |||
| usersGroups/pId | Opcional | string | |
| Identificador público del grupo de usuarios. | |||
| usersGroups/systemGroup | Opcional | false | boolean |
| Indica si es grupo de sistema (grupo de administradores). Se debe cumplir: - Solo puede haber un grupo de sistema, la activación de uno desactiva automáticamente al anterior. - Un grupo de usuarios no puede ser grupo de sistema y por defecto a la vez. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"DATEADDED" :"2015-05-23",
"DEFAULTGROUP" : 1,
"DESCRIPTION" :"Description abc",
"ID" : 43,
"NAME" :"UserGroup 1",
"PID" :"abc",
"SYSTEMGROUP" : 0
}
DELETE /usersGroups/{id}
Descripción
Elimina el grupo de usuarios indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/usersGroups/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 /usersGroups/getId/{pId}
Descripción
Devuelve el identificador interno del grupo de usuarios indicado mediante identificador público.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/usersGroups/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
}