Cuentas
Endpoint para gestionar la sección de cuentas. Está compuesta por una colección de recursos que permiten llevar a cabo todas las acciones de administración relacionadas con esta sección, como la creación, edición y eliminación de cuentas.
</> GET / accountsObtiene una colección de cuentas aplicando los filtros y parámetros proporcionados.
</> POST / accountsCrea una nueva cuenta con la información proporcionada.
</> GET / accounts/{id}Obtiene los detalles de una cuenta específica por su identificador interno.
</> PUT / accounts/{id}Actualiza la información de una cuenta específica por su identificador interno.
</> DELETE / accounts/{id}Elimina la cuenta indicada, así como sus usuarios registrados que queden sin relación con ninguna otra cuenta. En caso de tratarse de una cuenta de una estructura empresarial, elimina adicionalmente todas sus sub-divisiones y los empleados de éstas.
</> GET / accounts/{id}/company/rolesObtiene los roles personalizados de empresa para la cuenta especificada.
</> POST / accounts/{id}/companyDivisionsCrea una nueva división de empresa para la cuenta especificada.
</> GET / accounts/{id}/registeredUsersObtiene los usuarios registrados asociados con una cuenta específica por su identificador interno.
</> POST / accounts/{id}/registeredUsersCrea la relación entre la cuenta indicada y el usuario registrado indicado. La relación creada es no-master
</> GET / accounts/{id}/registeredUsers/{registeredUserId}Obtiene los detalles de un usuario registrado específico asociado con una cuenta.
</> PUT / accounts/{id}/registeredUsers/{registeredUserId}Actualiza la relación entre un usuario registrado y una cuenta.
</> DELETE / accounts/{id}/registeredUsers/{registeredUserId}Elimina la asociación entre un usuario registrado y una cuenta.
</> GET / accounts/company/roles/getId/{pId}Devuelve el identificador interno del rol de empresa.
</> GET / accounts/getId/{pId}Devuelve el identificador interno de la cuenta.
</> GET / accounts/groups/getId/{pId}Devuelve el identificador interno del grupo de cuentas.
</> GET / registeredUsersObtiene una colección de usuarios registrados aplicando los filtros y parámetros proporcionados.
</> GET / registeredUsers/{id}Obtiene los detalles de un usuario registrado específico por su identificador interno.
</> PUT / registeredUsers/{id}Actualiza la información de un usuario registrado específico por su identificador interno.
</> GET / registeredUsers/{id}/commentsDevuelve los comentarios del usuario registrado indicado
</> GET / registeredUsers/{id}/profiles/backOfficeUserObtiene la información del perfil de usuario de back office.
</> PUT / registeredUsers/{id}/profiles/backOfficeUserEdita los datos del perfil de usuario de back office.
</> GET / registeredUsers/{id}/salesAgentDevuelve la información del agente de venta.
</> PUT / registeredUsers/{id}/salesAgentEdición de los datos del agente de venta.
</> POST / registeredUsers/{id}/salesAgent/accounts/{accountId}Vincula una cuenta al agente de venta indicado.
</> DELETE / registeredUsers/{id}/salesAgent/accounts/{accountId}Desvincula una cuenta al agente de venta indicado.
</> GET / registeredUsers/getId/{pId}Devuelve el identificador interno del usuario registrado.
GET/accounts
Descripción
Obtiene una colección de cuentas aplicando los filtros y parámetros proporcionados.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/accounts
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
addedFrom | Opcional | datetime | |
Los elementos devueltos deben haber sido creados en la fecha especificada o después. Formato ISO-8601 ('YYYY-MM-DDThh:mm:ssZ') | |||
addedTo | Opcional | datetime | |
Los elementos devueltos deben haber sido creados en la fecha especificada o antes. Formato ISO-8601 ('YYYY-MM-DDThh:mm:ssZ') | |||
commerceIdList | Opcional | string | |
Lista de identificadores internos de comercios. Los elementos devueltos deben pertenecer al menos a uno de ellos. | |||
customTagId | Opcional | string | |
Parámetro para filtrar por una etiqueta personalizada específica con un valor específico. Se pueden usar múltiples etiquetas simultáneamente. Uso: customTag[identificador de etiqueta] = valor de etiqueta. Debe ser un valor según el tipo de etiqueta personalizada: Boolean: 'true','false', Number: 'valor numérico', Date: ISO-8601 ('YYYY-MM-DD'), Selector: 'identificador interno de la opción seleccionada', Otro tipo: 'texto' | |||
groupIdList | Opcional | string | |
Lista de identificadores internos de grupos de cuentas. Las cuentas devueltas deben pertenecer al menos a uno de ellos. Lista separada por comas. | |||
idFrom | Opcional | numeric | |
Las cuentas devueltas deben tener un identificar interno igual o superior al indicado. | |||
invoicingAddressAddress | Opcional | string | |
Las cuentas devueltas deben tener la dirección especificada en la dirección de facturación, además de cumplir con los otros filtros proporcionados para esa dirección de facturación. El filtro consiste en aplicar un LIKE '%inputData%'. | |||
invoicingAddressCity | Opcional | string | |
Las cuentas devueltas deben tener la ciudad especificada en la dirección de facturación, además de cumplir con los otros filtros proporcionados para esa dirección de facturación. El filtro consiste en aplicar un LIKE '%inputData%'. | |||
invoicingAddressCountryCode | Opcional | string | |
Las cuentas devueltas deben tener el código de país especificado en la dirección de facturación, además de cumplir con los otros filtros proporcionados para esa dirección de facturación. El código de país debe proporcionarse en formato ISO 3166-2. | |||
invoicingAddressMobile | Opcional | string | |
Las cuentas devueltas deben tener el número de móvil especificado en la dirección de facturación, además de cumplir con los otros filtros proporcionados para esa dirección de facturación. El filtro consiste en aplicar un LIKE '%inputData%'. | |||
invoicingAddressPhone | Opcional | string | |
Las cuentas devueltas deben tener el teléfono especificado en la dirección de facturación, además de cumplir con los otros filtros proporcionados para esa dirección de facturación. El filtro consiste en aplicar un LIKE '%inputData%'. | |||
invoicingAddressPostalCode | Opcional | string | |
Las cuentas devueltas deben tener el código postal especificado en la dirección de facturación, además de cumplir con los otros filtros proporcionados para esa dirección de facturación. El filtro consiste en aplicar un LIKE '%inputData%'. | |||
invoicingAddressState | Opcional | string | |
Las cuentas devueltas deben tener el estado especificado en la dirección de facturación, además de cumplir con los otros filtros proporcionados para esa dirección de facturación. El filtro consiste en aplicar un LIKE '%inputData%'. | |||
invoicingAddressTaxId | Opcional | string | |
Las cuentas devueltas deben tener el identificador fiscal especificado en la dirección de facturación, además de cumplir con los otros filtros proporcionados para esa dirección de facturación. El filtro consiste en aplicar un LIKE '%inputData%'. | |||
lastUsedFrom | Opcional | datetime | |
Los elementos devueltos deben haber sido modificados en la fecha indicada o posteriormente. Formato ISO-8601 ('YYYY-MM-DDThh:mm:ssZ') | |||
lastUsedTo | Opcional | datetime | |
Los elementos devueltos deben estar modificados en la fecha indicada o previamente. Formato ISO-8601 ('YYYY-MM-DDThh:mm:ssZ') | |||
name | Opcional | string | |
page | Opcional | numeric | |
Número de página. | |||
perPage | Opcional | numeric | |
Número de elementos a obtener por página. | |||
q | Opcional | string | |
Criterios de búsqueda en los campos FirstName, LastName y Company de la invoicingAddress predeterminada de la Cuenta. La búsqueda sobre un campo consiste en aplicar LIKE '%q%'. | |||
registeredUserEmail | Opcional | string | |
Las cuentas devueltas deben estar asociadas con un usuario registrado que tenga este email, además de cumplir con los otros filtros proporcionados para eso. El filtro consiste en aplicar un LIKE '%inputData%'. | |||
registeredUserFirstName | Opcional | string | |
Las cuentas devueltas deben estar asociadas con un usuario registrado que tenga este nombre, además de cumplir con los otros filtros proporcionados para eso. El filtro consiste en aplicar un LIKE '%inputData%'. | |||
registeredUserLastName | Opcional | string | |
Las cuentas devueltas deben estar asociadas con un usuario registrado que tenga este apellido, además de cumplir con los otros filtros proporcionados para eso. El filtro consiste en aplicar un LIKE '%inputData%'. | |||
registeredUserMaster | Opcional | boolean | |
Las cuentas devueltas deben ser aquellas cuyo maestro cumple todos los filtros de usuario registrado especificados. | |||
registeredUserPId | Opcional | string | |
Las cuentas devueltas deben estar asociadas con un usuario registrado que tenga este identificador, además de cumplir con los otros filtros proporcionados para eso. | |||
registeredUsername | Opcional | string | |
Las cuentas devueltas deben estar asociadas con un usuario registrado que tenga este nombre de usuario, además de cumplir con los otros filtros proporcionados para eso. El filtro consiste en aplicar un LIKE '%inputData%'. | |||
salesAgentId | Opcional | numeric | |
Las cuentas devueltas deben tener el agente de ventas especificado relacionado. | |||
sort | Opcional | string | |
Variable de ordenación. | |||
statusList | Opcional | string | |
Las cuentas devueltas deben estar en uno de los estados especificados. Lista separada por comas. Valores permitidos: ENABLED, DISABLED, PENDING_VERIFICATION, PENDING_MERCHANT_ACTIVATION, DENIED | |||
typeList | Opcional | string | |
Las cuentas devueltas deben ser de uno de los tipos especificados. Lista separada por comas. Valores permitidos: GENERAL, INDIVIDUAL, FREELANCE, COMPANY, COMPANY_DIVISION |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ITEMS": [
{
"ALIAS" :"string",
"DATEADDED" :"2019-08-24T14:15:22Z",
"GROUP": {
"DEFAULTONE" : true,
"DESCRIPTION" :"string",
"ID" : 123,
"NAME" :"string",
"PID" :"string",
"SYSTEMGROUP" : true
},
"ID" : 123,
"IMAGE" :"string",
"INVOICINGADDRESS": {
"ADDRESS" :"string",
"CITY" :"string",
"COMPANY" :"string",
"CUSTOMERTYPE" :"EMPTY",
"FIRSTNAME" :"string",
"ID" : 123,
"LASTNAME" :"string",
"MOBILE" :"string",
"PHONE" :"string"
},
"MASTER": {
"EMAIL" :"string",
"FIRSTNAME" :"string",
"GENDER" :"UNDEFINED",
"ID" : 123,
"LASTNAME" :"string",
"PID" :"string",
"USERNAME" :"string"
},
"NAME" :"string",
"PID" :"string",
"STATUS" :"ENABLED",
"TYPE" :"GENERAL"
}
],
"PAGINATION": {
"PAGE" : 0,
"PERPAGE" : 0,
"TOTALITEMS" : 0,
"TOTALPAGES" : 0
}
}
POST/accounts
Descripción
Crea una nueva cuenta con la información proporcionada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/accounts
Parámetros de entrada JSON
{ "accounts": { "customTags": [ { "customTag": { "id":numeric, "pId":string }, "general": { "active":boolean, "extension":string, "fileName":string, "selectableValue": { "id":numeric, "pId":string }, "value":string }, "group": { "id":numeric, "pId":string }, "languages": [ { "active":boolean, "extension":string, "fileName":string, "languageCode":string, "value":string } ] } ], "description":string, "email":string, "group": { "id":numeric, "pId":string }, "image":string, "invoicingAddresses": [ { "address":string, "addressAdditionalInformation":string, "alias":string, "city":string, "company":string, "customerType":string, "default":boolean, "fax":string, "firstName":string, "lastName":string, "location": { "coordinate": { "latitude":numeric, "longitude":numeric }, "countryCode":string, "locationId":numeric }, "mobile":string, "nif":string, "number":string, "pId":string, "phone":string, "postalCode":string, "re":boolean, "reverseChargeVat":boolean, "state":string, "tax":boolean, "vat":string } ], "master": { "defaultCurrency":string, "defaultLanguage":string, "job":string, "registeredUser": { "backOfficeUser": { "level":string }, "birthday":string, "email":string, "firstName":string, "gender":string, "id":numeric, "image":string, "lastName":string, "pId":string, "password":string, "profiles": [ { } ], "username":string }, "useShippingAddress":boolean }, "pId":string, "shippingAddresses": [ { "address":string, "addressAdditionalInformation":string, "alias":string, "city":string, "company":string, "default":boolean, "fax":string, "firstName":string, "lastName":string, "location": { "coordinate": { "latitude":numeric, "longitude":numeric }, "countryCode":string, "locationId":numeric }, "mobile":string, "nif":string, "number":string, "pId":string, "phone":string, "postalCode":string, "state":string, "vat":string } ], "status":string, "type":string, "visits":numeric, "vouchers": [ { "availableBalance":numeric, "code":string, "currencyCode":string, "expirationDate":datetime, "pId":string } ] } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
accounts | Obligatorio | struct | |
Bloque de parámetros con la información de la cuenta a crear. | |||
accounts/customTags | Obligatorio | array | |
Bloque de parámetros para etiquetas personalizadas. Si no se proporciona valor para alguna de las etiquetas personalizadas, no se asigna. | |||
accounts/customTags/customTag | Obligatorio | struct | |
Bloque de parámetros para la etiqueta personalizada. | |||
accounts/customTags/customTag/id | Opcional | numeric | |
Identificador interno de la etiqueta personalizada del tipo de elemento correspondiente. | |||
accounts/customTags/customTag/pId | Opcional | string | |
Identificador público de la etiqueta personalizada. | |||
accounts/customTags/general | Obligatorio | struct | |
Bloque de parámetros para el valor. Solo aplica y es requerido si el valor de la etiqueta personalizada no depende del idioma. | |||
accounts/customTags/general/active | Opcional | boolean | |
Visibilidad de la etiqueta personalizada para el elemento. | |||
accounts/customTags/general/extension | Opcional | string | |
Especifica la extensión del archivo adjunto. Solo aplicable para etiquetas personalizadas de tipo 'Attachment' si el valor se proporciona en Base64. | |||
accounts/customTags/general/fileName | Opcional | string | |
Especifica un nombre para el archivo adjunto. Solo aplicable para etiquetas personalizadas de tipo 'Attachment' si el valor se proporciona en Base64. | |||
accounts/customTags/general/selectableValue | Obligatorio | struct | |
Bloque de parámetros para el valor seleccionable. | |||
accounts/customTags/general/selectableValue/id | Opcional | numeric | |
Identificador interno de la opción seleccionada. Debe ser una opción de la etiqueta personalizada. | |||
accounts/customTags/general/selectableValue/pId | Opcional | string | |
Identificador público de la opción seleccionada. | |||
accounts/customTags/general/value | Opcional | string | |
Valor a establecer para la etiqueta personalizada. Requerido si la etiqueta personalizada está marcada como requerida. Formato del valor según el tipo de etiqueta personalizada. | |||
accounts/customTags/group | Obligatorio | struct | |
Bloque de parámetros para el grupo de etiquetas personalizadas. Solo aplica si la etiqueta personalizada pertenece a un grupo de etiquetas personalizadas. | |||
accounts/customTags/group/id | Opcional | numeric | |
Identificador interno del grupo de etiquetas personalizadas. Debe ser un grupo al que pertenezca la etiqueta personalizada. | |||
accounts/customTags/group/pId | Opcional | string | |
Identificador público del grupo de etiquetas personalizadas. | |||
accounts/customTags/languages | Obligatorio | array | |
Bloque de parámetros para el valor por idioma. Solo aplica y es requerido si el valor de la etiqueta personalizada depende del idioma. Nunca aplica a cuentas, usuarios registrados o documentos de pedido. Si se proporciona el mismo valor-idioma más de una vez, solo se considera el último. | |||
accounts/customTags/languages/active | Opcional | boolean | |
Visibilidad de la etiqueta personalizada para el elemento. | |||
accounts/customTags/languages/extension | Opcional | string | |
Especifica la extensión del archivo adjunto. Solo aplicable para etiquetas personalizadas de tipo 'Attachment' si el valor se proporciona en Base64. | |||
accounts/customTags/languages/fileName | Opcional | string | |
Especifica un nombre para el archivo adjunto. Solo aplicable para etiquetas personalizadas de tipo 'Attachment' si el valor se proporciona en Base64. | |||
accounts/customTags/languages/languageCode | Opcional | string | |
Código alfabético estándar internacional ISO 639-1 del idioma. Debe ser uno de los idiomas activos del front office. | |||
accounts/customTags/languages/value | Opcional | string | |
Valor a establecer para la etiqueta personalizada. Requerido si la etiqueta personalizada está marcada como requerida. Formato del valor según el tipo de etiqueta personalizada. | |||
accounts/description | Opcional | string | |
Descripción de la estructura de la empresa. Solo para los tipos de cuenta: COMPANY, COMPANY_DIVISION. | |||
accounts/email | Opcional | string | |
Dirección de correo electrónico de la estructura de la empresa. Solo aplica a cuentas COMPANY. | |||
accounts/group | Obligatorio | struct | |
Bloque de parámetros para el grupo de cuentas. Si no se proporciona, se asigna al grupo de cuentas predeterminado. Solo para los tipos de cuenta: INDIVIDUAL, FREELANCE, COMPANY, GENERAL. | |||
accounts/group/id | Opcional | numeric | |
Identificador interno del grupo de cuentas. | |||
accounts/group/pId | Opcional | string | |
Identificador público del grupo de cuentas. | |||
accounts/image | Opcional | string | |
Ruta del archivo de imagen de la cuenta. | |||
accounts/invoicingAddresses | Obligatorio | array | |
Bloque de parámetros para la dirección de facturación. Debe proporcionar al menos una dirección de facturación. Solo las cuentas de tipo GENERAL pueden tener más de una dirección de facturación. | |||
accounts/invoicingAddresses/address | Opcional | string | |
Dirección. | |||
accounts/invoicingAddresses/addressAdditionalInformation | Opcional | string | |
Campo adicional de dirección. | |||
accounts/invoicingAddresses/alias | Opcional | string | |
Alias para la dirección. | |||
accounts/invoicingAddresses/city | Opcional | string | |
Ciudad. | |||
accounts/invoicingAddresses/company | Opcional | string | |
Nombre de la empresa. | |||
accounts/invoicingAddresses/customerType | Opcional | string | |
Tipo de usuario. Valores permitidos: EMPTY, PARTICULAR, BUSINESS, FREELANCE | |||
accounts/invoicingAddresses/default | Opcional | boolean | |
Establecer la dirección como predeterminada. | |||
accounts/invoicingAddresses/fax | Opcional | string | |
Fax. | |||
accounts/invoicingAddresses/firstName | Opcional | string | |
Nombre. | |||
accounts/invoicingAddresses/lastName | Opcional | string | |
Apellidos. | |||
accounts/invoicingAddresses/location | Obligatorio | struct | |
Bloque de parámetros para la ubicación. | |||
accounts/invoicingAddresses/location/coordinate | Obligatorio | struct | |
Bloque de parámetros para las coordenadas. | |||
accounts/invoicingAddresses/location/coordinate/latitude | Opcional | numeric | |
Coordenada de latitud. | |||
accounts/invoicingAddresses/location/coordinate/longitude | Opcional | numeric | |
Coordenada de longitud. | |||
accounts/invoicingAddresses/location/countryCode | Opcional | string | |
Código de país del usuario en formato ISO 3166-2. Se puede usar para determinar el canal de ventas. | |||
accounts/invoicingAddresses/location/locationId | Opcional | numeric | |
Identificador interno de una subdivisión de un país. | |||
accounts/invoicingAddresses/mobile | Opcional | string | |
Teléfono móvil. | |||
accounts/invoicingAddresses/nif | Opcional | string | |
Número o código de identidad del usuario. | |||
accounts/invoicingAddresses/number | Opcional | string | |
Número de casa o edificio. | |||
accounts/invoicingAddresses/pId | Opcional | string | |
Identificador público. | |||
accounts/invoicingAddresses/phone | Opcional | string | |
Teléfono. | |||
accounts/invoicingAddresses/postalCode | Opcional | string | |
Código postal. Requerido si no se proporciona locationId. | |||
accounts/invoicingAddresses/re | Opcional | boolean | |
Especifica si el usuario está sujeto al impuesto de igualación de ventas. | |||
accounts/invoicingAddresses/reverseChargeVat | Opcional | boolean | |
Especifica si el cliente se considera un contribuyente que realiza una inversión con fines fiscales. | |||
accounts/invoicingAddresses/state | Opcional | string | |
Provincia o estado. | |||
accounts/invoicingAddresses/tax | Opcional | boolean | |
Especifica si el usuario está sujeto a impuestos. | |||
accounts/invoicingAddresses/vat | Opcional | string | |
Código de identificación fiscal de la empresa. | |||
accounts/master | Obligatorio | struct | |
Bloque de parámetros para el usuario registrado maestro de la cuenta. | |||
accounts/master/defaultCurrency | Opcional | string | |
Especifica la moneda predeterminada en formato ISO 4217. | |||
accounts/master/defaultLanguage | Opcional | string | |
Especifica el idioma predeterminado en formato ISO 639-1. | |||
accounts/master/job | Opcional | string | |
Solo aplica a cuentas COMPANY o COMPANY_DIVISION. Describe la ocupación del maestro de la cuenta. | |||
accounts/master/registeredUser | Obligatorio | struct | |
Bloque de parámetros para el usuario registrado. Es obligatorio si no se proporciona registeredUserId. | |||
accounts/master/registeredUser/backOfficeUser | Obligatorio | struct | |
Información del usuario de back office. Solo aplicable si el usuario registrado tiene el perfil 'back office user'; de lo contrario se omite. | |||
accounts/master/registeredUser/backOfficeUser/level | Opcional | string | |
Nivel del usuario de back office. Valores permitidos: SUPER_ADMINISTRATOR, ADMINISTRATOR | |||
accounts/master/registeredUser/birthday | Opcional | string | |
Fecha de nacimiento. Formato ISO-8601 ('YYYY-MM-DD'). | |||
accounts/master/registeredUser/email | Opcional | string | |
Dirección de correo electrónico. Si se establece como keyCriteria, debe ser único entre usuarios registrados. Debe satisfacer la expresión regular especificada. | |||
accounts/master/registeredUser/firstName | Opcional | string | |
Nombre. | |||
accounts/master/registeredUser/gender | Opcional | string | |
Género del usuario registrado. Valores permitidos: UNDEFINED, MALE, FEMALE | |||
accounts/master/registeredUser/id | Opcional | numeric | |
Si se proporciona, el usuario registrado con ese identificador interno es el considerado (debe proporcionarse para establecer el usuario registrado maestro de la cuenta). | |||
accounts/master/registeredUser/image | Opcional | string | |
Ruta del archivo de imagen. | |||
accounts/master/registeredUser/lastName | Opcional | string | |
Apellido. | |||
accounts/master/registeredUser/pId | Opcional | string | |
Identificador público del elemento. Si se establece como keyCriteria, es requerido, no puede estar en blanco y debe ser único entre usuarios registrados. | |||
accounts/master/registeredUser/password | Opcional | string | |
Contraseña. | |||
accounts/master/registeredUser/profiles | Obligatorio | array | |
Perfiles del usuario registrado. Valores permitidos: SALES_AGENT, BLOGGER, SUPPLIER, BACK_OFFICE_USER | |||
accounts/master/registeredUser/username | Opcional | string | |
Nombre de usuario. Debe ser único entre usuarios registrados. Si se establece como keyCriteria, es requerido y no puede estar en blanco. | |||
accounts/master/useShippingAddress | Opcional | boolean | |
Indica usar una dirección de envío diferente de la dirección de facturación. | |||
accounts/pId | Opcional | string | |
Identificador público. | |||
accounts/shippingAddresses | Obligatorio | array | |
Bloque de parámetros para las direcciones de envío. | |||
accounts/shippingAddresses/address | Opcional | string | |
Dirección. | |||
accounts/shippingAddresses/addressAdditionalInformation | Opcional | string | |
Campo adicional de dirección. | |||
accounts/shippingAddresses/alias | Opcional | string | |
Alias para la dirección. | |||
accounts/shippingAddresses/city | Opcional | string | |
Ciudad. | |||
accounts/shippingAddresses/company | Opcional | string | |
Nombre de la empresa. | |||
accounts/shippingAddresses/default | Opcional | boolean | |
Establecer la dirección como predeterminada. | |||
accounts/shippingAddresses/fax | Opcional | string | |
Fax. | |||
accounts/shippingAddresses/firstName | Opcional | string | |
Nombre. | |||
accounts/shippingAddresses/lastName | Opcional | string | |
Apellidos. | |||
accounts/shippingAddresses/location | Obligatorio | struct | |
Bloque de parámetros para la ubicación. | |||
accounts/shippingAddresses/location/coordinate | Obligatorio | struct | |
Bloque de parámetros para las coordenadas. | |||
accounts/shippingAddresses/location/coordinate/latitude | Opcional | numeric | |
Coordenada de latitud. | |||
accounts/shippingAddresses/location/coordinate/longitude | Opcional | numeric | |
Coordenada de longitud. | |||
accounts/shippingAddresses/location/countryCode | Opcional | string | |
Código de país del usuario en formato ISO 3166-2. Se puede usar para determinar el canal de ventas. | |||
accounts/shippingAddresses/location/locationId | Opcional | numeric | |
Identificador interno de una subdivisión de un país. | |||
accounts/shippingAddresses/mobile | Opcional | string | |
Teléfono móvil. | |||
accounts/shippingAddresses/nif | Opcional | string | |
Número o código de identidad del usuario. | |||
accounts/shippingAddresses/number | Opcional | string | |
Número de casa o edificio. | |||
accounts/shippingAddresses/pId | Opcional | string | |
Identificador público. | |||
accounts/shippingAddresses/phone | Opcional | string | |
Teléfono. | |||
accounts/shippingAddresses/postalCode | Opcional | string | |
Código postal. Requerido si no se proporciona locationId. | |||
accounts/shippingAddresses/state | Opcional | string | |
Provincia o estado. | |||
accounts/shippingAddresses/vat | Opcional | string | |
Código de identificación fiscal de la empresa. | |||
accounts/status | Opcional | string | |
Estado de la cuenta. Valores permitidos: ENABLED, DISABLED, PENDING_VERIFICATION, PENDING_MERCHANT_ACTIVATION, DENIED | |||
accounts/type | Opcional | string | |
Tipo de cuenta a crear. Valores permitidos: GENERAL, INDIVIDUAL, FREELANCE, COMPANY, COMPANY_DIVISION | |||
accounts/visits | Opcional | numeric | |
Número de visitas. | |||
accounts/vouchers | Obligatorio | array | |
Cupones de regalo vinculados a la cuenta. | |||
accounts/vouchers/availableBalance | Opcional | numeric | |
Indica el saldo disponible del cupón de regalo. | |||
accounts/vouchers/code | Opcional | string | |
Indica el código alfanumérico que identifica el cupón de regalo. Debe ser único entre todos los cupones. | |||
accounts/vouchers/currencyCode | Opcional | string | |
Código de moneda en formato ISO 4217. | |||
accounts/vouchers/expirationDate | Opcional | datetime | |
Fecha de expiración del cupón de regalo. Formato ISO-8601 ('YYYY-MM-DDThh:mm:ssZ') | |||
accounts/vouchers/pId | Opcional | string | |
Identificador público. |
HTTP statusCode
201 CREATED
Ejemplo de respuesta
No Content
GET/accounts/{id}
Descripción
Obtiene los detalles de una cuenta específica por su identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/accounts/1
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno del elemento. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ALIAS" :"string",
"DATEADDED" :"2019-08-24T14:15:22Z",
"GROUP": {
"DEFAULTONE" : true,
"DESCRIPTION" :"string",
"ID" : 123,
"NAME" :"string",
"PID" :"string",
"SYSTEMGROUP" : true
},
"ID" : 123,
"IMAGE" :"string",
"INVOICINGADDRESS": {
"ADDRESS" :"string",
"CITY" :"string",
"COMPANY" :"string",
"CUSTOMERTYPE" :"EMPTY",
"FIRSTNAME" :"string",
"ID" : 123,
"LASTNAME" :"string",
"MOBILE" :"string",
"PHONE" :"string"
},
"MASTER": {
"EMAIL" :"string",
"FIRSTNAME" :"string",
"GENDER" :"UNDEFINED",
"ID" : 123,
"LASTNAME" :"string",
"PID" :"string",
"USERNAME" :"string"
},
"NAME" :"string",
"PID" :"string",
"STATUS" :"ENABLED",
"TYPE" :"GENERAL"
}
PUT/accounts/{id}
Descripción
Actualiza la información de una cuenta específica por su identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/accounts/1
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno del elemento. |
Parámetros de entrada JSON
{ "accounts": { "description":string, "email":string, "group": { "id":numeric, "pId":string }, "image":string, "master": { "defaultCurrency":string, "defaultLanguage":string, "job":string, "registeredUser": { "birthday":string, "email":string, "firstName":string, "gender":string, "image":string, "lastName":string, "pId":string, "password":string, "profiles": [ ], "username":string }, "role": { "id":numeric, "pId":string }, "useShippingAddress":boolean }, "pId":string, "parentAccount": { "id":numeric, "pId":string }, "salesAgents": [ { "id":numeric, "pId":string } ], "segmentationInheritanceAccount": { "id":numeric, "pId":string }, "status":string, "visits":numeric } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
accounts | Obligatorio | struct | |
Bloque de parámetros con la información de la cuenta a actualizar. | |||
accounts/description | Opcional | string | |
Descripción de la estructura de la empresa. Solo para los tipos de cuenta: COMPANY, COMPANY_DIVISION. | |||
accounts/email | Opcional | string | |
Dirección de correo electrónico de la estructura de la empresa. Solo aplica a cuentas COMPANY. | |||
accounts/group | Opcional | struct | |
Bloque de parámetros para el grupo de cuentas. | |||
accounts/group/id | Opcional | numeric | |
Identificador interno del grupo de cuentas de la cuenta. | |||
accounts/group/pId | Opcional | string | |
Identificador público del grupo de cuentas de la cuenta. | |||
accounts/image | Opcional | string | |
Ruta del archivo de imagen de la cuenta. | |||
accounts/master | Opcional | struct | |
Bloque de parámetros para el usuario registrado maestro de la cuenta. | |||
accounts/master/defaultCurrency | Opcional | string | |
Especifica la moneda predeterminada en formato ISO 4217. | |||
accounts/master/defaultLanguage | Opcional | string | |
Especifica el idioma predeterminado en formato ISO 639-1. | |||
accounts/master/job | Opcional | string | |
Solo aplica a cuentas COMPANY o COMPANY_DIVISION. Describe la ocupación del maestro de la cuenta. | |||
accounts/master/registeredUser | Opcional | struct | |
Bloque de parámetros para el usuario registrado. | |||
accounts/master/registeredUser/birthday | Opcional | string | |
Fecha de nacimiento. Formato ISO-8601 ('YYYY-MM-DD'). | |||
accounts/master/registeredUser/email | Opcional | string | |
Dirección de correo electrónico. Si se establece como keyCriteria, debe ser único entre usuarios registrados. Debe satisfacer la expresión regular especificada. | |||
accounts/master/registeredUser/firstName | Opcional | string | |
Nombre. | |||
accounts/master/registeredUser/gender | Opcional | string | |
Género del usuario registrado. Valores permitidos: UNDEFINED, MALE, FEMALE | |||
accounts/master/registeredUser/image | Opcional | string | |
Ruta del archivo de imagen. | |||
accounts/master/registeredUser/lastName | Opcional | string | |
Apellido. | |||
accounts/master/registeredUser/pId | Opcional | string | |
Identificador público del elemento. Si se establece como keyCriteria, debe ser único entre usuarios registrados y no estar en blanco. | |||
accounts/master/registeredUser/password | Opcional | string | |
Contraseña. | |||
accounts/master/registeredUser/profiles | Opcional | array [0:n] | |
Perfiles del usuario registrado. Valores permitidos: SALES_AGENT, BLOGGER, SUPPLIER, BACK_OFFICE_USER | |||
accounts/master/registeredUser/username | Opcional | string | |
Nombre de usuario. Debe ser único entre usuarios registrados. Si se establece como keyCriteria, no puede estar en blanco. | |||
accounts/master/role | Opcional | struct | |
Solo aplica a cuentas de tipo COMPANY_DIVISION. Debe ser el identificador de un rol de la cuenta Company de la estructura empresarial de la que cuelga la cuenta, y del target 'COMPANY_DIVISION_MASTER'. Si no se indica o se indica 0, se asignará el rol por defecto correspondiente. | |||
accounts/master/role/id | Opcional | numeric | |
Identificador interno del rol. Si no se proporciona, se asignará el rol predeterminado para maestros definido en la cuenta Company. | |||
accounts/master/role/pId | Opcional | string | |
Identificador público del rol. | |||
accounts/master/useShippingAddress | Opcional | boolean | |
Indica usar una dirección de envío diferente de la dirección de facturación. | |||
accounts/pId | Opcional | string | |
Identificador público. | |||
accounts/parentAccount | Opcional | struct | |
Solo aplica para cuentas de tipo COMPANY_DIVISION. Debe ser el identificador de una de las cuentas de la estructura empresarial a la que pertenece la cuenta actualmente. No se permite mover como cuenta principal ni bajo ninguna de sus sub-cuentas ni tampoco bajo otra estructura empresarial distinta. | |||
accounts/parentAccount/id | Opcional | numeric | |
Identificador interno de una de las cuentas dentro de la estructura de la empresa a la que pertenece actualmente la cuenta. No está permitido moverla como cuenta raíz (Company), bajo ninguna de sus propias subcuentas (creando un ciclo), o bajo una estructura empresarial diferente. | |||
accounts/parentAccount/pId | Opcional | string | |
Identificador público de la cuenta padre. | |||
accounts/salesAgents | Opcional | array [0:n] | |
Identificadores de los agentes de ventas de los que esta cuenta es cliente. Proporcione valor [] para indicar que no está asociado a ningún agente de ventas. Se requiere licencia para el módulo SAMNG 'SalesAgents Management'. | |||
accounts/salesAgents/id | Opcional | numeric | |
Identificador interno del agente de ventas. Proporcionar 0 para indicar que no está asociado con ningún agente de ventas. | |||
accounts/salesAgents/pId | Opcional | string | |
Identificador público del agente de ventas. | |||
accounts/segmentationInheritanceAccount | Opcional | struct | |
Bloque de parámetros para la cuenta de herencia de segmentación. Solo aplica a cuentas de tipo COMPANY_DIVISION. | |||
accounts/segmentationInheritanceAccount/id | Opcional | numeric | |
Identificador interno de la cuenta de la cual hereda segmentación. Un valor de 0 indica que no hereda segmentación. Solo se permite heredar de una de las cuentas en el camino entre su padre y la raíz (ambos incluidos), siempre que dicha cuenta no herede a su vez de otra cuenta. | |||
accounts/segmentationInheritanceAccount/pId | Opcional | string | |
Identificador público de la cuenta de herencia de segmentación. | |||
accounts/status | Opcional | string | |
Estado de la cuenta. Valores permitidos: ENABLED, DISABLED, PENDING_MERCHANT_ACTIVATION, DENIED | |||
accounts/visits | Opcional | numeric | |
Número de visitas. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"COMPANY": {
"ID" : 6188,
"PID" :"pIdTestingFOBPOSTaccounts81ddd"
},
"CUSTOMTAGVALUES": [
{
"ACTIVE" : true,
"CUSTOMTAG": {
"ID" : 23,
"PID" :"num1"
},
"GROUP": {
"ID" : 37,
"PID" :"asdfas"
},
"ID" : 28337,
"VALUE" :"2",
"VALUEFORALLLANGUAGES" : true,
"VALUETYPE" :"NUMBER"
},
{
"ACTIVE" : true,
"CUSTOMTAG": {
"ID" : 24,
"PID" :"shortText1"
},
"GROUP": {
"ID" : 37,
"PID" :"asdfas"
},
"ID" : 28338,
"VALUE" :"aabbcc",
"VALUEFORALLLANGUAGES" : true,
"VALUETYPE" :"SHORT_TEXT"
},
{
"ACTIVE" : true,
"CUSTOMTAG": {
"ID" : 26,
"PID" :"select1_tste"
},
"GROUP": {
"ID" : 3,
"PID" :"ct_test1"
},
"ID" : 28339,
"VALUE": {
"ID" : 6,
"PID" :"valor2"
},
"VALUEFORALLLANGUAGES" : true,
"VALUETYPE" :"SELECTOR"
}
],
"DATEADDED" :"2025-09-17T13:29:52Z",
"DESCRIPTION" :"Description of the company",
"EMAIL" :"email@test.com",
"GROUP": {
"DEFAULTONE" : false,
"DESCRIPTION" :"",
"ID" : 3,
"NAME" :"Tienda contado",
"PID" :"tienda-contado",
"SYSTEMGROUP" : false
},
"ID" : 6357,
"IMAGE" :"http://images-nightly-beyond-igd.logicommerce.systems/path/test.jpg",
"INVOICINGADDRESSES": [
{
"ADDRESS" :"",
"ADDRESSADDITIONALINFORMATION" :"",
"ALIAS" :"Main address",
"CITY" :"Igualada",
"COMPANY" :"División test",
"CUSTOMERTYPE" :"COMPANY",
"DEFAULTONE" : true,
"FAX" :"",
"FIRSTNAME" :"Yanimz",
"ID" : 12548,
"LASTNAME" :"",
"LOCATION": {
"COORDINATE": {
"LATITUDE" : 41.578951,
"LONGITUDE" : 1.618284
},
"GEOGRAPHICALZONE": {
"COUNTRYCODE" :"ES",
"LOCATIONID" : 15916328
}
},
"MOBILE" :"",
"NIF" :"",
"NUMBER" :"",
"PHONE" :"",
"PID" :"",
"POSTALCODE" :"08700",
"RE" : false,
"REVERSECHARGEVAT" : false,
"STATE" :"Barcelona",
"TAX" : true,
"TYPE" :"INVOICING",
"VAT" :""
}
],
"LASTUSED" :"2025-09-17T13:30:29Z",
"MASTER": {
"ACCOUNTALIAS" :"",
"ACCOUNTID" : 6357,
"DATEADDED" :"2025-09-17T13:29:52Z",
"DEFAULTCURRENCYCODE" :"EUR",
"DEFAULTLANGUAGECODE" :"es",
"ID" : 26445,
"JOB" :"",
"LASTUSED" :"2025-09-17T13:29:51Z",
"LASTVISIT" :"",
"MASTER" : true,
"REGISTEREDUSER": {
"BACKOFFICEUSER" :"",
"BIRTHDAY" :"",
"DATEADDED" :"2016-11-10T11:09:15Z",
"EMAIL" :"yanimz@hotmail.com",
"FIRSTNAME" :"Yanimz",
"GENDER" :"MALE",
"ID" : 11796,
"IMAGE" :"http://images-nightly-beyond-igd.logicommerce.systems/path/test.jpg",
"LASTNAME" :"",
"LASTUSED" :"2025-09-17T13:53:39Z",
"PID" :"1179600000346_11796_11796",
"PROFILES": [
"BLOGGER"
],
"USERNAME" :"userNameYanimz_11796"
},
"ROLE": {
"TARGET" :"COMPANY_DIVISION_MASTER",
"TYPE" :"BASIC_FIXED"
},
"STATUS" :"ENABLED",
"TYPE" :"EMPLOYEE",
"USESHIPPINGADDRESS" : false
},
"NAME" :"División test",
"PARENTACCOUNT": {
"ID" : 6188,
"PID" :"pIdTestingFOBPOSTaccounts81ddd"
},
"PID" :"",
"SALESAGENTS": [
{
"ACTIVE" : true,
"ID" : 38,
"PERCENTCOMMISSION" : 17.5,
"PID" :"blabla2",
"REGISTEREDUSER": {
"EMAIL" :"testing59@testing59.com",
"FIRSTNAME" :"John",
"GENDER" :"MALE",
"ID" : 16037,
"LASTNAME" :"Doe Hill",
"PID" :"16037_16037_16037",
"USERNAME" :"usernameTestingFOBPOSTaccounts59_16037"
}
}
],
"SEGMENTATIONINHERITANCEACCOUNT" :"",
"SHIPPINGADDRESSES": [
{
"ADDRESS" :"dddd",
"ADDRESSADDITIONALINFORMATION" :"fffff",
"ALIAS" :"test",
"CITY" :"Igualada",
"COMPANY" :"",
"DEFAULTONE" : true,
"FAX" :"",
"FIRSTNAME" :"test name",
"ID" : 12549,
"LASTNAME" :"test apel",
"LOCATION": {
"COORDINATE": {
"LATITUDE" : 0,
"LONGITUDE" : 0
},
"GEOGRAPHICALZONE": {
"COUNTRYCODE" :"ES",
"LOCATIONID" : 15916328
}
},
"MOBILE" :"696133320",
"NIF" :"",
"NUMBER" :"111",
"PHONE" :"606132613",
"PID" :"test",
"POSTALCODE" :"08700",
"STATE" :"Barcelona",
"TYPE" :"SHIPPING",
"VAT" :""
}
],
"STATUS" :"ENABLED",
"TYPE" :"COMPANY_DIVISION",
"VISITS" : 1,
"VOUCHERS": [
{
"AVAILABLEBALANCE" : 11,
"CODE" :"aaabbbccceeeee",
"CURRENCYCODE" :"EUR",
"EXPIRATIONDATE" :"2025-09-26T21:59:59Z",
"ID" : 233,
"PID" :""
}
]
}
DELETE/accounts/{id}
Descripción
Elimina la cuenta indicada, así como sus usuarios registrados que queden sin relación con ninguna otra cuenta. En caso de tratarse de una cuenta de una estructura empresarial, elimina adicionalmente todas sus sub-divisiones y los empleados de éstas.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/accounts/1
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno de la cuenta a eliminar. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 123
}
GET/accounts/{id}/company/roles
Descripción
Obtiene los roles personalizados de empresa para la cuenta especificada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/accounts/1/company/roles
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno del elemento. | |||
commerceIdList | Opcional | string | |
Lista de identificadores internos de comercios. Los elementos devueltos deben pertenecer al menos a uno de ellos. | |||
name | Opcional | string | |
Los roles personalizados de empresa devueltos deben tener este nombre. El filtro consiste en aplicar un LIKE '%inputData%'. | |||
page | Opcional | numeric | |
Número de página. | |||
perPage | Opcional | numeric | |
Número de elementos a obtener por página. | |||
target | Opcional | string | |
Devuelve los roles personalizados de empresa cuyo objetivo es el indicado. Valores permitidos: COMPANY_DIVISION_MASTER, COMPANY_STRUCTURE_NON_MASTER | |||
targetDefault | Opcional | boolean | |
Devuelve el rol personalizado de empresa predeterminado para los empleados del objetivo indicado. Es necesario especificar también el parámetro 'target'. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"COMPANYROLES": [
{
"DESCRIPTION" :"string",
"EMPLOYEESQUANTITY" : 0,
"ID" : 123,
"NAME" :"string",
"TARGET" :"COMPANY_DIVISION_MASTER",
"TARGETDEFAULT" : true,
"TYPE" :"BASIC_FIXED"
}
],
"CURSORS": {
"NEXT" :"http://api.logicommerce.net/v1/accounts/123/company-roles?page=1&perPage=100"
},
"ITEMS" : 0,
"PAGERPARAMETERS": {
"PAGE" : 0,
"PERPAGE" : 0
}
}
POST/accounts/{id}/companyDivisions
Descripción
Crea una nueva división de empresa para la cuenta especificada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/accounts/1/companyDivisions
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno de la cuenta COMPANY o COMPANY_DIVISION que será el padre de la nueva división. |
Parámetros de entrada JSON
{ "companyDivisions": { "customTags": [ { "customTag": { "id":numeric, "pId":string }, "general": { "active":boolean, "extension":string, "fileName":string, "value":string }, "group": { "id":numeric, "pId":string }, "languages": [ { "active":boolean, "extension":string, "fileName":string, "languageCode":string, "value":string } ] } ], "description":string, "email":string, "group": { "id":numeric, "pId":string }, "image":string, "master": { "defaultCurrency":string, "defaultLanguage":string, "job":string, "registeredUser": { "backOfficeUser": { "level":string }, "birthday":string, "email":string, "firstName":string, "gender":string, "id":numeric, "image":string, "lastName":string, "pId":string, "password":string, "profiles": [ { } ], "role": { "id":numeric, "pId":string }, "status":string, "username":string }, "useShippingAddress":boolean }, "pId":string, "segmentationInheritanceAccount": { "id":numeric, "pId":string }, "shippingAddresses": [ { "address":string, "addressAdditionalInformation":string, "alias":string, "city":string, "company":string, "default":boolean, "fax":string, "firstName":string, "lastName":string, "location": { "coordinate": { "latitude":numeric, "longitude":numeric }, "countryCode":string, "locationId":numeric }, "mobile":string, "nif":string, "number":string, "pId":string, "phone":string, "postalCode":string, "state":string, "vat":string } ], "status":string, "vouchers": [ { "availableBalance":numeric, "code":string, "currencyCode":string, "expirationDate":datetime, "pId":string } ] } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
companyDivisions | Obligatorio | struct | |
Bloque de parámetros para crear la división de empresa. | |||
companyDivisions/customTags | Obligatorio | array | |
Bloque de parámetros para etiquetas personalizadas. Si no se proporciona valor para alguna de las etiquetas personalizadas, no se asigna. | |||
companyDivisions/customTags/customTag | Obligatorio | struct | |
Bloque de parámetros para la etiqueta personalizada. | |||
companyDivisions/customTags/customTag/id | Opcional | numeric | |
Identificador interno de la etiqueta personalizada del tipo de elemento correspondiente. | |||
companyDivisions/customTags/customTag/pId | Opcional | string | |
Identificador público de la etiqueta personalizada. | |||
companyDivisions/customTags/general | Obligatorio | struct | |
Bloque de parámetros para el valor. Solo aplica y es requerido si el valor de la etiqueta personalizada no depende del idioma. | |||
companyDivisions/customTags/general/active | Opcional | boolean | |
Visibilidad de la etiqueta personalizada para el elemento. | |||
companyDivisions/customTags/general/extension | Opcional | string | |
Especifica la extensión del archivo adjunto. Solo aplicable para etiquetas personalizadas de tipo 'Attachment' si el valor se proporciona en Base64. | |||
companyDivisions/customTags/general/fileName | Opcional | string | |
Especifica un nombre para el archivo adjunto. Solo aplicable para etiquetas personalizadas de tipo 'Attachment' si el valor se proporciona en Base64. | |||
companyDivisions/customTags/general/value | Opcional | string | |
Valor a establecer para la etiqueta personalizada. Requerido si la etiqueta personalizada está marcada como requerida. Formato del valor según el tipo de etiqueta personalizada. | |||
companyDivisions/customTags/group | Obligatorio | struct | |
Bloque de parámetros para el grupo de etiquetas personalizadas. Solo aplica si la etiqueta personalizada pertenece a un grupo de etiquetas personalizadas. | |||
companyDivisions/customTags/group/id | Opcional | numeric | |
Identificador interno del grupo de etiquetas personalizadas. Debe ser un grupo al que pertenezca la etiqueta personalizada. | |||
companyDivisions/customTags/group/pId | Opcional | string | |
Identificador público del grupo de etiquetas personalizadas. | |||
companyDivisions/customTags/languages | Obligatorio | array | |
Bloque de parámetros para el valor por idioma. Solo aplica y es requerido si el valor de la etiqueta personalizada depende del idioma. Nunca aplica a cuentas, usuarios registrados o documentos de pedido. Si se proporciona el mismo valor-idioma más de una vez, solo se considera el último. | |||
companyDivisions/customTags/languages/active | Opcional | boolean | |
Visibilidad de la etiqueta personalizada para el elemento. | |||
companyDivisions/customTags/languages/extension | Opcional | string | |
Especifica la extensión del archivo adjunto. Solo aplicable para etiquetas personalizadas de tipo 'Attachment' si el valor se proporciona en Base64. | |||
companyDivisions/customTags/languages/fileName | Opcional | string | |
Especifica un nombre para el archivo adjunto. Solo aplicable para etiquetas personalizadas de tipo 'Attachment' si el valor se proporciona en Base64. | |||
companyDivisions/customTags/languages/languageCode | Opcional | string | |
Código alfabético estándar internacional ISO 639-1 del idioma. Debe ser uno de los idiomas activos del front office. | |||
companyDivisions/customTags/languages/value | Opcional | string | |
Valor a establecer para la etiqueta personalizada. Requerido si la etiqueta personalizada está marcada como requerida. Formato del valor según el tipo de etiqueta personalizada. | |||
companyDivisions/description | Opcional | string | |
Descripción de la estructura de la empresa. Solo para los tipos de cuenta: COMPANY, COMPANY_DIVISION. | |||
companyDivisions/email | Opcional | string | |
Dirección de correo electrónico de la estructura de la empresa. Solo aplica a cuentas COMPANY. | |||
companyDivisions/group | Obligatorio | struct | |
Bloque de parámetros para el grupo de cuentas. | |||
companyDivisions/group/id | Opcional | numeric | |
Identificador interno del grupo de cuentas. | |||
companyDivisions/group/pId | Opcional | string | |
Identificador público del grupo de cuentas. | |||
companyDivisions/image | Opcional | string | |
Ruta del archivo de imagen de la cuenta. | |||
companyDivisions/master | Obligatorio | struct | |
Bloque de parámetros para el usuario registrado maestro de la cuenta. | |||
companyDivisions/master/defaultCurrency | Opcional | string | |
Especifica la moneda predeterminada en formato ISO 4217. | |||
companyDivisions/master/defaultLanguage | Opcional | string | |
Especifica el idioma predeterminado en formato ISO 639-1. | |||
companyDivisions/master/job | Opcional | string | |
Solo aplica a cuentas COMPANY o COMPANY_DIVISION. Describe la ocupación del maestro de la cuenta. | |||
companyDivisions/master/registeredUser | Obligatorio | struct | |
Bloque de parámetros para el usuario registrado. Es obligatorio si no se proporciona registeredUserId. | |||
companyDivisions/master/registeredUser/backOfficeUser | Obligatorio | struct | |
Información del usuario de back office. Solo aplicable si el usuario registrado tiene el perfil 'back office user'; de lo contrario se omite. | |||
companyDivisions/master/registeredUser/backOfficeUser/level | Opcional | string | |
Nivel del usuario de back office. Valores permitidos: SUPER_ADMINISTRATOR, ADMINISTRATOR | |||
companyDivisions/master/registeredUser/birthday | Opcional | string | |
Fecha de nacimiento. Formato ISO-8601 ('YYYY-MM-DD'). | |||
companyDivisions/master/registeredUser/email | Opcional | string | |
Dirección de correo electrónico. Si se establece como keyCriteria, debe ser único entre usuarios registrados. Debe satisfacer la expresión regular especificada. | |||
companyDivisions/master/registeredUser/firstName | Opcional | string | |
Nombre. | |||
companyDivisions/master/registeredUser/gender | Opcional | string | |
Género del usuario registrado. Valores permitidos: UNDEFINED, MALE, FEMALE | |||
companyDivisions/master/registeredUser/id | Opcional | numeric | |
Si se proporciona, el usuario registrado con ese identificador interno es el considerado (debe proporcionarse para establecer el usuario registrado maestro de la cuenta). | |||
companyDivisions/master/registeredUser/image | Opcional | string | |
Ruta del archivo de imagen. | |||
companyDivisions/master/registeredUser/lastName | Opcional | string | |
Apellido. | |||
companyDivisions/master/registeredUser/pId | Opcional | string | |
Identificador público. | |||
companyDivisions/master/registeredUser/password | Opcional | string | |
Contraseña. | |||
companyDivisions/master/registeredUser/profiles | Obligatorio | array | |
Perfiles del usuario registrado. Valores permitidos: SALES_AGENT, BLOGGER, SUPPLIER, BACK_OFFICE_USER | |||
companyDivisions/master/registeredUser/role | Obligatorio | struct | |
Bloque de parámetros para el rol. Debe ser un rol de la cuenta Company dentro de la estructura de la empresa a la que pertenece la cuenta, y con el objetivo 'COMPANY_DIVISION_MASTER'. | |||
companyDivisions/master/registeredUser/role/id | Opcional | numeric | |
Identificador interno del rol. Si no se proporciona, se asignará el rol predeterminado para maestros definido en la cuenta Company. | |||
companyDivisions/master/registeredUser/role/pId | Opcional | string | |
Identificador público del rol. | |||
companyDivisions/master/registeredUser/status | Opcional | string | |
Estado de la relación. ENABLED,DISABLED solo se puede establecer cuando la contraseña del registeredUser indicado también está establecida y no está en blanco, de lo contrario solo se puede establecer el estado PENDING_APPROVAL. Valores permitidos: ENABLED, DISABLED, PENDING_VERIFICATION, PENDING_MERCHANT_ACTIVATION, DENIED | |||
companyDivisions/master/registeredUser/username | Opcional | string | |
Nombre de usuario. Debe ser único entre usuarios registrados. Si se establece como keyCriteria, es requerido y no puede estar en blanco. | |||
companyDivisions/master/useShippingAddress | Opcional | boolean | |
Indica usar una dirección de envío diferente de la dirección de facturación. | |||
companyDivisions/pId | Opcional | string | |
Identificador público. | |||
companyDivisions/segmentationInheritanceAccount | Obligatorio | struct | |
Bloque de parámetros para la cuenta de herencia de segmentación. | |||
companyDivisions/segmentationInheritanceAccount/id | Opcional | numeric | |
Identificador interno de la cuenta de la cual hereda segmentación. Un valor de 0 indica que no hereda segmentación. Solo se permite heredar de una de las cuentas en el camino entre su padre y la raíz (ambos incluidos), siempre que dicha cuenta no herede a su vez de otra cuenta. | |||
companyDivisions/segmentationInheritanceAccount/pId | Opcional | string | |
Identificador público de la cuenta de herencia de segmentación. | |||
companyDivisions/shippingAddresses | Obligatorio | array | |
Bloque de parámetros para las direcciones de envío. | |||
companyDivisions/shippingAddresses/address | Opcional | string | |
Dirección. | |||
companyDivisions/shippingAddresses/addressAdditionalInformation | Opcional | string | |
Campo adicional de dirección. | |||
companyDivisions/shippingAddresses/alias | Opcional | string | |
Alias para la dirección. | |||
companyDivisions/shippingAddresses/city | Opcional | string | |
Ciudad. | |||
companyDivisions/shippingAddresses/company | Opcional | string | |
Nombre de la empresa. | |||
companyDivisions/shippingAddresses/default | Opcional | boolean | |
Establecer la dirección como predeterminada. | |||
companyDivisions/shippingAddresses/fax | Opcional | string | |
Fax. | |||
companyDivisions/shippingAddresses/firstName | Opcional | string | |
Nombre. | |||
companyDivisions/shippingAddresses/lastName | Opcional | string | |
Apellidos. | |||
companyDivisions/shippingAddresses/location | Obligatorio | struct | |
Bloque de parámetros para la ubicación. | |||
companyDivisions/shippingAddresses/location/coordinate | Obligatorio | struct | |
Bloque de parámetros para las coordenadas. | |||
companyDivisions/shippingAddresses/location/coordinate/latitude | Opcional | numeric | |
Coordenada de latitud. | |||
companyDivisions/shippingAddresses/location/coordinate/longitude | Opcional | numeric | |
Coordenada de longitud. | |||
companyDivisions/shippingAddresses/location/countryCode | Opcional | string | |
Código de país del usuario en formato ISO 3166-2. Se puede usar para determinar el canal de ventas. | |||
companyDivisions/shippingAddresses/location/locationId | Opcional | numeric | |
Identificador interno de una subdivisión de un país. | |||
companyDivisions/shippingAddresses/mobile | Opcional | string | |
Teléfono móvil. | |||
companyDivisions/shippingAddresses/nif | Opcional | string | |
Número o código de identidad del usuario. | |||
companyDivisions/shippingAddresses/number | Opcional | string | |
Número de casa o edificio. | |||
companyDivisions/shippingAddresses/pId | Opcional | string | |
Identificador público. | |||
companyDivisions/shippingAddresses/phone | Opcional | string | |
Teléfono. | |||
companyDivisions/shippingAddresses/postalCode | Opcional | string | |
Código postal. Requerido si no se proporciona locationId. | |||
companyDivisions/shippingAddresses/state | Opcional | string | |
Provincia o estado. | |||
companyDivisions/shippingAddresses/vat | Opcional | string | |
Código de identificación fiscal de la empresa. | |||
companyDivisions/status | Opcional | string | |
Estado de la cuenta. Valores permitidos: ENABLED, DISABLED, PENDING_VERIFICATION, PENDING_MERCHANT_ACTIVATION, DENIED | |||
companyDivisions/vouchers | Obligatorio | array | |
Cupones de regalo vinculados a la cuenta. | |||
companyDivisions/vouchers/availableBalance | Opcional | numeric | |
Indica el saldo disponible del cupón de regalo. | |||
companyDivisions/vouchers/code | Opcional | string | |
Indica el código alfanumérico que identifica el cupón de regalo. Debe ser único entre todos los cupones. | |||
companyDivisions/vouchers/currencyCode | Opcional | string | |
Código de moneda en formato ISO 4217. | |||
companyDivisions/vouchers/expirationDate | Opcional | datetime | |
Fecha de expiración del cupón de regalo. Formato ISO-8601 ('YYYY-MM-DDThh:mm:ssZ') | |||
companyDivisions/vouchers/pId | Opcional | string | |
Identificador público. |
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"ALIAS" :"string",
"DATEADDED" :"2019-08-24T14:15:22Z",
"GROUP": {
"DEFAULTONE" : true,
"DESCRIPTION" :"string",
"ID" : 123,
"NAME" :"string",
"PID" :"string",
"SYSTEMGROUP" : true
},
"ID" : 456,
"IMAGE" :"string",
"INVOICINGADDRESS": {
"ADDRESS" :"string",
"CITY" :"string",
"COMPANY" :"string",
"CUSTOMERTYPE" :"EMPTY",
"FIRSTNAME" :"string",
"ID" : 123,
"LASTNAME" :"string",
"MOBILE" :"string",
"PHONE" :"string"
},
"MASTER": {
"EMAIL" :"string",
"FIRSTNAME" :"string",
"GENDER" :"UNDEFINED",
"ID" : 123,
"LASTNAME" :"string",
"PID" :"string",
"USERNAME" :"string"
},
"NAME" :"Division Name",
"PID" :"DIV001",
"STATUS" :"ENABLED",
"TYPE" :"COMPANY_DIVISION"
}
GET/accounts/{id}/registeredUsers
Descripción
Obtiene los usuarios registrados asociados con una cuenta específica por su identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/accounts/1/registeredUsers
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno de la cuenta. | |||
addedFrom | Opcional | datetime | |
Los elementos devueltos deben estar creados en la fecha indicada o posteriormente. Formato ISO-8601 ('YYYY-MM-DDThh:mm:ssZ'). | |||
addedTo | Opcional | datetime | |
Los elementos devueltos deben estar creados en la fecha indicada o previamente. Formato ISO-8601 ('YYYY-MM-DDThh:mm:ssZ'). | |||
commerceIdList | Opcional | string | |
Lista de identificadores internos de comercios. Los elementos devueltos deben pertenecer a alguno de ellos. Lista separada por comas. | |||
Opcional | string | ||
Los usuarios registrados devueltos deben tener el email indicado. El filtro consiste en un LIKE '%inputData%'. | |||
firstName | Opcional | string | |
Los usuarios registrados devueltos deben tener el nombre indicado. El filtro consiste en un LIKE '%inputData%'. | |||
lastName | Opcional | string | |
Los usuarios registrados devueltos deben tener los apellidos indicados. El filtro consiste en un LIKE '%inputData%'. | |||
page | Opcional | numeric | |
Número de página. | |||
perPage | Opcional | numeric | |
Número de elementos que se quieren obtener por página. | |||
roleId | Opcional | numeric | |
Los usuarios registrados devueltos deben tener el rol personalizado de empresa indicado para la cuenta indicada. Si desea obtener los que no tienen rol personalizado asignado debe indicar 0. Solo aplicable para cuentas de tipo empresa o división empresarial. | |||
sort | Opcional | string | |
Variable de ordenación. | |||
statusList | Opcional | string | |
Los usuarios registrados devueltos deben tener alguno de los estados indicados para la relación con la cuenta indicada. Lista separada por comas. Valores permitidos: ENABLED, DISABLED, PENDING_VERIFICATION | |||
username | Opcional | string | |
Los usuarios registrados devueltos deben tener el username indicado. El filtro consiste en un LIKE '%inputData%'. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACCOUNTALIAS" :"",
"ACCOUNTID" : 5957,
"DATEADDED" :"2025-09-16T09:02:08Z",
"DEFAULTCURRENCYCODE" :"EUR",
"DEFAULTLANGUAGECODE" :"es",
"ID" : 26434,
"JOB" :"",
"LASTUSED" :"2025-09-16T09:02:08Z",
"LASTVISIT" :"",
"MASTER" : false,
"REGISTEREDUSER": {
"BACKOFFICEUSER" :"",
"BIRTHDAY" :"",
"DATEADDED" :"2025-09-16T09:02:08Z",
"EMAIL" :"testingAll@testingAllpId111111111110000.com",
"FIRSTNAME" :"John testingAll",
"GENDER" :"UNDEFINED",
"ID" : 16394,
"IMAGE" :"",
"LASTNAME" :"",
"LASTUSED" :"2025-09-16T09:02:08Z",
"PID" :"",
"PROFILES": [
],
"USERNAME" :""
},
"ROLE": {
"DESCRIPTION" :"Description2",
"ID" : 2,
"NAME" :"Test2",
"PID" :"pId2",
"TARGET" :"COMPANY_STRUCTURE_NON_MASTER",
"TARGETDEFAULT" : true,
"TYPE" :"CUSTOM"
},
"STATUS" :"PENDING_APPROVAL",
"TYPE" :"EMPLOYEE",
"USESHIPPINGADDRESS" : false
}
POST/accounts/{id}/registeredUsers
Descripción
Crea la relación entre la cuenta indicada y el usuario registrado indicado. La relación creada es no-master
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/accounts/1/registeredUsers
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno de la cuenta. |
Parámetros de entrada JSON
{ "accountRegisteredUsers": { "job":string, "registeredUser": { "backOfficeUser": { "level":string }, "birthday":string, "email":string, "firstName":string, "gender":string, "id":numeric, "image":string, "lastName":string, "pId":string, "password":string, "profiles": [ ], "username":string }, "role": { "id":numeric, "pId":string }, "status":string } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
accountRegisteredUsers | Obligatorio | struct | |
Bloque de parámetros que contiene todos los datos para asociar un usuario registrado con la cuenta. | |||
accountRegisteredUsers/job | Opcional | string | |
Descripción del trabajo. | |||
accountRegisteredUsers/registeredUser | Obligatorio | struct | |
Bloque de parámetros con la información del usuario registrado. | |||
accountRegisteredUsers/registeredUser/backOfficeUser | Opcional | struct | |
Información del usuario de back office. | |||
accountRegisteredUsers/registeredUser/backOfficeUser/level | Opcional | string | |
Nivel del usuario de back office. Valores permitidos: SUPER_ADMINISTRATOR, ADMINISTRATOR | |||
accountRegisteredUsers/registeredUser/birthday | Opcional | string | |
Fecha de nacimiento. Formato ISO-8601 ('YYYY-MM-DD'). | |||
accountRegisteredUsers/registeredUser/email | Opcional | string | |
Dirección de correo electrónico. | |||
accountRegisteredUsers/registeredUser/firstName | Opcional | string | |
Nombre. | |||
accountRegisteredUsers/registeredUser/gender | Opcional | string | |
Género del usuario registrado. Valores permitidos: UNDEFINED, MALE, FEMALE | |||
accountRegisteredUsers/registeredUser/id | Opcional | numeric | |
Identificador interno de un usuario registrado existente. | |||
accountRegisteredUsers/registeredUser/image | Opcional | string | |
Ruta del archivo de imagen. | |||
accountRegisteredUsers/registeredUser/lastName | Opcional | string | |
Apellidos. | |||
accountRegisteredUsers/registeredUser/pId | Opcional | string | |
Identificador público del usuario registrado. | |||
accountRegisteredUsers/registeredUser/password | Opcional | string | |
Contraseña. | |||
accountRegisteredUsers/registeredUser/profiles | Opcional | array [0:n] | |
Perfiles del usuario registrado. | |||
accountRegisteredUsers/registeredUser/username | Opcional | string | |
Nombre de usuario. | |||
accountRegisteredUsers/role | Opcional | struct | |
Bloque de parámetros para el rol personalizado de empresa. | |||
accountRegisteredUsers/role/id | Opcional | numeric | |
Identificador interno del rol personalizado de empresa. | |||
accountRegisteredUsers/role/pId | Opcional | string | |
Identificador público del rol personalizado de empresa. | |||
accountRegisteredUsers/status | Opcional | string | |
Estado de la relación. Valores permitidos: ENABLED, DISABLED, PENDING_VERIFICATION |
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"ACCOUNTALIAS" :"",
"ACCOUNTID" : 5957,
"DATEADDED" :"2025-09-16T09:02:08Z",
"DEFAULTCURRENCYCODE" :"EUR",
"DEFAULTLANGUAGECODE" :"es",
"ID" : 26434,
"JOB" :"",
"LASTUSED" :"2025-09-16T09:02:08Z",
"LASTVISIT" :"",
"MASTER" : false,
"REGISTEREDUSER": {
"BACKOFFICEUSER" :"",
"BIRTHDAY" :"",
"DATEADDED" :"2025-09-16T09:02:08Z",
"EMAIL" :"testingAll@testingAllpId111111111110000.com",
"FIRSTNAME" :"John testingAll",
"GENDER" :"UNDEFINED",
"ID" : 16394,
"IMAGE" :"",
"LASTNAME" :"",
"LASTUSED" :"2025-09-16T09:02:08Z",
"PID" :"",
"PROFILES": [
],
"USERNAME" :""
},
"ROLE": {
"DESCRIPTION" :"Description2",
"ID" : 2,
"NAME" :"Test2",
"PID" :"pId2",
"TARGET" :"COMPANY_STRUCTURE_NON_MASTER",
"TARGETDEFAULT" : true,
"TYPE" :"CUSTOM"
},
"STATUS" :"PENDING_APPROVAL",
"TYPE" :"EMPLOYEE",
"USESHIPPINGADDRESS" : false
}
GET/accounts/{id}/registeredUsers/{registeredUserId}
Descripción
Obtiene los detalles de un usuario registrado específico asociado con una cuenta.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/accounts/1/registeredUsers/{registeredUserId}
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno de la cuenta. | |||
registeredUserId | Opcional | numeric | |
Identificador interno del usuario registrado. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACCOUNTALIAS" :"My Main Account",
"DATEADDED" :"2019-08-24T14:15:22Z",
"DEFAULTCURRENCY" :"EUR",
"DEFAULTLANGUAGE" :"en",
"EMAIL" :"user@example.com",
"FIRSTNAME" :"John",
"ID" : 123,
"JOB" :"Account Manager",
"LASTNAME" :"Doe",
"MASTER" : true,
"ROLE": {
"DESCRIPTION" :"Account Manager",
"ID" : 456,
"NAME" :"Manager"
},
"STATUS" :"ENABLED",
"USERNAME" :"username"
}
PUT/accounts/{id}/registeredUsers/{registeredUserId}
Descripción
Actualiza la relación entre un usuario registrado y una cuenta.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/accounts/1/registeredUsers/{registeredUserId}
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno de la cuenta. | |||
registeredUserId | Obligatorio | numeric | |
Identificador interno del usuario registrado. |
Parámetros de entrada JSON
{ "accountRegisteredUsers": { "account": { "id":numeric, "pId":string }, "accountAlias":string, "defaultCurrency":string, "defaultLanguage":string, "job":string, "master":boolean, "role": { "id":numeric, "pId":string }, "status":string } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
accountRegisteredUsers | Obligatorio | struct | |
Bloque de parámetros que contiene la información de relación del usuario registrado a actualizar. | |||
accountRegisteredUsers/account | Opcional | struct | |
Establece la cuenta de la relación, moviéndola a la cuenta indicada. Solo aplica para relaciones no-master de tipo empleado (cuentas de tipo 'COMPANY' o 'COMPANY_DIVISION') si además se dispone del módulo 'ADVCA' (Advanced Company Accounts). El valor indicado debe ser el identificador de una cuenta de tipo 'COMPANY' o 'COMPANY_DIVISION'. | |||
accountRegisteredUsers/account/id | Opcional | numeric | |
Identificador interno de la cuenta. | |||
accountRegisteredUsers/account/pId | Opcional | string | |
Identificador público de la cuenta. | |||
accountRegisteredUsers/accountAlias | Opcional | string | |
Alias dado a esta cuenta por el usuario registrado. | |||
accountRegisteredUsers/defaultCurrency | Opcional | string | |
Indica la moneda predeterminada en formato ISO 4217. | |||
accountRegisteredUsers/defaultLanguage | Opcional | string | |
Indica el idioma predeterminado en formato ISO 639-1. | |||
accountRegisteredUsers/job | Opcional | string | |
Solo aplica a cuentas de tipo `COMPANY` o `COMPANY_DIVISION`. Describe la ocupación del empleado. | |||
accountRegisteredUsers/master | Opcional | boolean | |
Establece el usuario registrado indicado como master de la cuenta indicada, dejando el master que hubiera previamente como usuario no-master. Una cuenta siempre debe tener un master y solo uno. | |||
accountRegisteredUsers/role | Opcional | struct | |
Establece el rol del usuario registrado en la relación con la cuenta indicada. Solo aplica para las cuentas de tipo 'COMPANY' o 'COMPANY_DIVISION' si se dispone del módulo 'ADVCA' (Advanced Company Accounts). Debe ser el identificador de un rol de la cuenta Company de la estructura empresarial de la que cuelga la cuenta indicada y para el target correspondiente. Si se indica 0 se considerará el rol básico para masters o no masters (según sea el caso). No aplica a masters de cuentas Company pues éstos ya tienen control total implícito. | |||
accountRegisteredUsers/role/id | Opcional | numeric | |
Identificador interno del rol personalizado de empresa. | |||
accountRegisteredUsers/role/pId | Opcional | string | |
Identificador público del rol personalizado de empresa. | |||
accountRegisteredUsers/status | Opcional | string | |
Estado de la relación. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"accountAlias" :"Alias que le he querido dar a esta cuenta",
"accountId" : 3456,
"dateAdded" :"2024-10-07T10:10:55Z",
"defaultCurrencyCode" :"EUR",
"defaultLanguageCode" :"es",
"job" :"Administrativo de ventas",
"lastUsed" :"2023-05-10T10:24:44Z",
"lastVisit" :"2023-05-10T10:24:44Z",
"master" : true,
"registeredUserId" : 5694,
"role": {
"description" :"Custom Company Role name",
"id" : 11,
"name" :"Custom Company Role name",
"pId" :"pIdX",
"target" :"COMPANY_DIVISION_MASTER",
"targetDefault" : false,
"type" :"BASIC_FIXED|CUSTOM"
},
"status" :"PENDING_APPROVAL",
"type" :"EMPLOYEE",
"useShippingAddress" : false
}
DELETE/accounts/{id}/registeredUsers/{registeredUserId}
Descripción
Elimina la asociación entre un usuario registrado y una cuenta.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/accounts/1/registeredUsers/{registeredUserId}
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno de la cuenta. | |||
registeredUserId | Obligatorio | numeric | |
Identificador interno del usuario registrado. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 5957,
"REGISTEREDUSERID" : 16397
}
GET/accounts/company/roles/getId/{pId}
Descripción
Devuelve el identificador interno del rol de empresa.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/accounts/company/roles/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" : 123
}
GET/accounts/getId/{pId}
Descripción
Devuelve el identificador interno de la cuenta.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/accounts/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" : 123
}
GET/accounts/groups/getId/{pId}
Descripción
Devuelve el identificador interno del grupo de cuentas.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/accounts/groups/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" : 123
}
GET/registeredUsers
Descripción
Obtiene una colección de usuarios registrados aplicando los filtros y parámetros proporcionados.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/registeredUsers
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
accountIdList | Opcional | string | |
Lista de identificadores internos de cuentas. Los usuarios registrados devueltos deben estar asociados a alguna de ellas. Lista separada por comas. | |||
addedFrom | Opcional | datetime | |
Los elementos devueltos deben estar creados en la fecha indicada o posteriormente. Formato ISO-8601 ('YYYY-MM-DDThh:mm:ssZ') | |||
addedTo | Opcional | datetime | |
Los elementos devueltos deben estar creados en la fecha indicada o previamente. Formato ISO-8601 ('YYYY-MM-DDThh:mm:ssZ') | |||
commerceIdList | Opcional | string | |
Lista de identificadores internos de comercios. Los elementos devueltos deben pertenecer a alguno de ellos. Lista separada por comas. | |||
customTagId | Opcional | string | |
Parámetro para filtrar según una etiqueta personalizada concreta con un valor concreto. Debe ser un valor acorde al tipo de etiqueta (booleano, numérico, fecha, selector o texto). | |||
Opcional | string | ||
Los usuarios registrados devueltos deben tener el email indicado. El filtro consiste en un LIKE '%inputData%'. | |||
firstName | Opcional | string | |
Los usuarios registrados devueltos deben tener el nombre indicado. El filtro consiste en un LIKE '%inputData%'. | |||
lastName | Opcional | string | |
Los usuarios registrados devueltos deben tener los apellidos indicados. El filtro consiste en un LIKE '%inputData%'. | |||
master | Opcional | boolean | |
Los usuarios registrados devueltos deben ser master de alguna cuenta. | |||
pId | Opcional | string | |
Los usuarios registrados devueltos deben tener el identificador indicado. | |||
page | Opcional | numeric | |
Número de página. | |||
perPage | Opcional | numeric | |
Número de elementos que se quieren obtener por página. | |||
profileList | Opcional | string | |
Los usuarios registrados devueltos deben tener activo alguno de los perfiles indicados. Lista separada por comas. Valores permitidos: SALES_AGENT, BLOGGER, SUPPLIER, BACK_OFFICE_USER | |||
q | Opcional | string | |
Criterio de búsqueda sobre los campos nombre, apellidos y el campo clave (email, pId o username). LIKE '%q%'. | |||
sort | Opcional | string | |
Variable de ordenación. Lista separada por comas como: id.asc, firstName.desc, etc. | |||
username | Opcional | string | |
Los usuarios registrados devueltos deben tener el username indicado. El filtro consiste en un LIKE '%inputData%'. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"CURSORS": {
"NEXT" :"http://api.logicommerce.net/v1/registeredUsers?page=2&perPage=10"
},
"ITEMS" : 2,
"PAGERPARAMETERS": {
"PAGE" : 1,
"PERPAGE" : 10
},
"REGISTEREDUSERS": [
{
"BIRTHDAY" :"1990-01-01",
"DATEADDED" :"2019-08-24T14:15:22Z",
"EMAIL" :"user@example.com",
"FIRSTNAME" :"John",
"GENDER" :"MALE",
"ID" : 123,
"LASTNAME" :"Doe",
"MASTER" : true,
"PID" :"user123",
"PROFILES": [
"SALES_AGENT"
],
"USERNAME" :"username"
},
{
"BIRTHDAY" :"1985-05-15",
"DATEADDED" :"2019-08-25T10:30:45Z",
"EMAIL" :"user2@example.com",
"FIRSTNAME" :"Jane",
"GENDER" :"FEMALE",
"ID" : 124,
"LASTNAME" :"Smith",
"MASTER" : false,
"PID" :"user124",
"PROFILES": [
"BLOGGER", "SUPPLIER"
],
"USERNAME" :"username2"
}
]
}
GET/registeredUsers/{id}
Descripción
Obtiene los detalles de un usuario registrado específico por su identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/registeredUsers/1
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno del usuario registrado. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"BIRTHDAY" :"1990-01-01",
"DATEADDED" :"2019-08-24T14:15:22Z",
"EMAIL" :"user@example.com",
"FIRSTNAME" :"John",
"GENDER" :"MALE",
"ID" : 123,
"IMAGE" :"/path/user.jpg",
"LASTNAME" :"Doe",
"MASTER" : true,
"PID" :"user123",
"PROFILES": [
"SALES_AGENT", "BLOGGER"
],
"USERNAME" :"username"
}
PUT/registeredUsers/{id}
Descripción
Actualiza la información de un usuario registrado específico por su identificador interno.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/registeredUsers/1
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno del usuario registrado. |
Parámetros de entrada JSON
{ "registeredUsers": { "birthday":string, "email":string, "firstName":string, "gender":string, "image":string, "lastName":string, "pId":string, "password":string, "profiles": [ ], "username":string } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
registeredUsers | Obligatorio | struct | |
Bloque de parámetros con la información del usuario registrado a actualizar. | |||
registeredUsers/birthday | Opcional | string | |
Fecha de nacimiento. Formato ISO-8601 ('YYYY-MM-DD'). | |||
registeredUsers/email | Opcional | string | |
Dirección de correo electrónico. Si está configurado como clave debe ser único entre usuarios registrados. Debe satisfacer la expresión regular: ^[\w-\+]+(\.[\w]+)*@[\w-]+(\.[\w]+)*(\.[a-z]{2,})$ | |||
registeredUsers/firstName | Opcional | string | |
Nombre. | |||
registeredUsers/gender | Opcional | string | |
Género del usuario registrado. Valores permitidos: UNDEFINED, MALE, FEMALE | |||
registeredUsers/image | Opcional | string | |
Ruta del archivo de imagen. | |||
registeredUsers/lastName | Opcional | string | |
Apellidos. | |||
registeredUsers/pId | Opcional | string | |
Identificador público del elemento. Si está configurado como clave debe ser único entre usuarios registrados y no tener valor vacío. | |||
registeredUsers/password | Opcional | string | |
Password. No puede ser una cadena vacía. | |||
registeredUsers/profiles | Opcional | array [0:n] | |
Perfiles del usuario registrado. Valores permitidos: SALES_AGENT, BLOGGER, SUPPLIER, BACK_OFFICE_USER | |||
registeredUsers/username | Opcional | string | |
Nombre de usuario. Debe ser único entre usuarios registrados. Si está configurado como clave no puede ser vacío. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"BIRTHDAY" :"1983-12-25",
"DATEADDED" :"2025-08-04T13:38:52Z",
"EMAIL" :"bobTestChasrsaissa@bobTest001.com",
"FIRSTNAME" :"John",
"GENDER" :"MALE",
"ID" : 16249,
"IMAGE" :"/path/test.jpg",
"LASTNAME" :"Doe",
"LASTUSED" :"2025-09-15T08:35:14Z",
"PID" :"pIdTest",
"PROFILES": [
"BLOGGER", "SALES_AGENT", "SUPPLIER", "BACK_OFFICE_USER"
],
"USERNAME" :"usernameTest"
}
GET/registeredUsers/{id}/comments
Descripción
Devuelve los comentarios del usuario registrado indicado
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/registeredUsers/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 | boolean | |
Devuelve los comentarios aceptados del usuario indicado. | |||
onlyRevised | Opcional | boolean | |
Devuelve los comentarios revisados del usuario indicado. | |||
page | Opcional | numeric | |
Nº de página solicitada. | |||
perPage | Opcional | numeric | |
Cantidad de elementos por página. | |||
productId | Opcional | numeric | |
Devuelve los comentarios del producto facilitado por identificador interno del usuario indicado. | |||
q | Opcional | string | |
Criterio de búsqueda. | |||
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" :"May, 14 2016 22:00:00 +0000",
"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"
},
"ITEMS" : 100,
"PAGERPARAMETERS": {
"PAGE" : 1,
"PERPAGE" : 100
}
}
GET/registeredUsers/{id}/profiles/backOfficeUser
Descripción
Obtiene la información del perfil de usuario de back office.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/registeredUsers/1/profiles/backOfficeUser
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"LEVEL" :"ADMINISTRATOR"
}
PUT/registeredUsers/{id}/profiles/backOfficeUser
Descripción
Edita los datos del perfil de usuario de back office.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/registeredUsers/1/profiles/backOfficeUser
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
Parámetros de entrada JSON
{ "backOfficeUsers": { "level":string } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
backOfficeUsers | Obligatorio | struct | |
Bloque de información sobre el usuario de back office. | |||
backOfficeUsers/level | Opcional | string | |
Nivel del usuario de back office. Valores permitidos: ADMINISTRATOR, SUPER_ADMINISTRATOR |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"LEVEL" :"SUPER_ADMINISTRATOR"
}
GET/registeredUsers/{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/registeredUsers/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
{
"SALESAGENT": {
"ACCOUNTS": [
{
"ID" : 1,
"PID" :"fgh"
}
],
"ACTIVE" : true,
"ID" : 123,
"PERCENTCOMMISSION" : 10,
"PID" :"abc"
}
}
PUT/registeredUsers/{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/registeredUsers/1/salesAgent
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. |
Parámetros de entrada JSON
{ "salesAgents": { "active":boolean, "pId":string, "percentCommission":numeric } } |
Variables JSON:
Variable | R/O | Valor por defecto | Tipo |
salesAgents | Obligatorio | struct | |
Bloque de información sobre el agente de venta. | |||
salesAgents/active | Opcional | boolean | |
Define si el agente de venta está activo. | |||
salesAgents/pId | Opcional | string | |
Identificador público del agente de venta. | |||
salesAgents/percentCommission | Opcional | numeric | |
Define el porcentaje de comissión. |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"SALESAGENT": {
"ACCOUNTS": [
{
"ID" : 1,
"PID" :"fgh"
}
],
"ACTIVE" : true,
"ID" : 123,
"PERCENTCOMMISSION" : 10,
"PID" :"abc"
}
}
POST/registeredUsers/{id}/salesAgent/accounts/{accountId}
Descripción
Vincula una cuenta al agente de venta indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/registeredUsers/1/salesAgent/accounts/{accountId}
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. | |||
accountId | Obligatorio | numeric | |
Indentificador de la cuenta a vincular |
Parámetros de entrada JSON
{ } |
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"ACCOUNTID" : 34,
"ID" : 1
}
DELETE/registeredUsers/{id}/salesAgent/accounts/{accountId}
Descripción
Desvincula una cuenta al agente de venta indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/registeredUsers/1/salesAgent/accounts/{accountId}
Parámetros de entrada URL
Variable | R/O | Valor por defecto | Tipo |
id | Obligatorio | numeric | |
Identificador interno. | |||
accountId | Obligatorio | numeric | |
Identificador de la cuenta a desvincular |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACCOUNTID" : 34,
"ID" : 1
}
GET/registeredUsers/getId/{pId}
Descripción
Devuelve el identificador interno del usuario registrado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/registeredUsers/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" : 123
}