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
VariableR/OValor por defectoTipo
addedFrom
Opcionaldatetime
Los elementos devueltos deben haber sido creados en la fecha especificada o después. Formato ISO-8601 ('YYYY-MM-DDThh:mm:ssZ')
addedTo
Opcionaldatetime
Los elementos devueltos deben haber sido creados en la fecha especificada o antes. Formato ISO-8601 ('YYYY-MM-DDThh:mm:ssZ')
commerceIdList
Opcionalstring
Lista de identificadores internos de comercios. Los elementos devueltos deben pertenecer al menos a uno de ellos.
customTagId
Opcionalstring
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
Opcionalstring
Lista de identificadores internos de grupos de cuentas. Las cuentas devueltas deben pertenecer al menos a uno de ellos. Lista separada por comas.
idFrom
Opcionalnumeric
Las cuentas devueltas deben tener un identificar interno igual o superior al indicado.
invoicingAddressAddress
Opcionalstring
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
Opcionalstring
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
Opcionalstring
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
Opcionalstring
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
Opcionalstring
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
Opcionalstring
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
Opcionalstring
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
Opcionalstring
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
Opcionaldatetime
Los elementos devueltos deben haber sido modificados en la fecha indicada o posteriormente. Formato ISO-8601 ('YYYY-MM-DDThh:mm:ssZ')
lastUsedTo
Opcionaldatetime
Los elementos devueltos deben estar modificados en la fecha indicada o previamente. Formato ISO-8601 ('YYYY-MM-DDThh:mm:ssZ')
name
Opcionalstring
page
Opcionalnumeric
Número de página.
perPage
Opcionalnumeric
Número de elementos a obtener por página.
q
Opcionalstring
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
Opcionalstring
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
Opcionalstring
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
Opcionalstring
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
Opcionalboolean
Las cuentas devueltas deben ser aquellas cuyo maestro cumple todos los filtros de usuario registrado especificados.
registeredUserPId
Opcionalstring
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
Opcionalstring
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
Opcionalnumeric
Las cuentas devueltas deben tener el agente de ventas especificado relacionado.
sort
Opcionalstring
Variable de ordenación.
statusList
Opcionalstring
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
Opcionalstring
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:
VariableR/OValor por defectoTipo
accounts
Obligatoriostruct
Bloque de parámetros con la información de la cuenta a crear.
accounts/customTags
Obligatorioarray
Bloque de parámetros para etiquetas personalizadas. Si no se proporciona valor para alguna de las etiquetas personalizadas, no se asigna.
accounts/customTags/customTag
Obligatoriostruct
Bloque de parámetros para la etiqueta personalizada.
accounts/customTags/customTag/id
Opcionalnumeric
Identificador interno de la etiqueta personalizada del tipo de elemento correspondiente.
accounts/customTags/customTag/pId
Opcionalstring
Identificador público de la etiqueta personalizada.
accounts/customTags/general
Obligatoriostruct
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
Opcionalboolean
Visibilidad de la etiqueta personalizada para el elemento.
accounts/customTags/general/extension
Opcionalstring
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
Opcionalstring
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
Obligatoriostruct
Bloque de parámetros para el valor seleccionable.
accounts/customTags/general/selectableValue/id
Opcionalnumeric
Identificador interno de la opción seleccionada. Debe ser una opción de la etiqueta personalizada.
accounts/customTags/general/selectableValue/pId
Opcionalstring
Identificador público de la opción seleccionada.
accounts/customTags/general/value
Opcionalstring
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
Obligatoriostruct
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
Opcionalnumeric
Identificador interno del grupo de etiquetas personalizadas. Debe ser un grupo al que pertenezca la etiqueta personalizada.
accounts/customTags/group/pId
Opcionalstring
Identificador público del grupo de etiquetas personalizadas.
accounts/customTags/languages
Obligatorioarray
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
Opcionalboolean
Visibilidad de la etiqueta personalizada para el elemento.
accounts/customTags/languages/extension
Opcionalstring
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
Opcionalstring
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
Opcionalstring
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
Opcionalstring
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
Opcionalstring
Descripción de la estructura de la empresa. Solo para los tipos de cuenta: COMPANY, COMPANY_DIVISION.
accounts/email
Opcionalstring
Dirección de correo electrónico de la estructura de la empresa. Solo aplica a cuentas COMPANY.
accounts/group
Obligatoriostruct
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
Opcionalnumeric
Identificador interno del grupo de cuentas.
accounts/group/pId
Opcionalstring
Identificador público del grupo de cuentas.
accounts/image
Opcionalstring
Ruta del archivo de imagen de la cuenta.
accounts/invoicingAddresses
Obligatorioarray
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
Opcionalstring
Dirección.
accounts/invoicingAddresses/addressAdditionalInformation
Opcionalstring
Campo adicional de dirección.
accounts/invoicingAddresses/alias
Opcionalstring
Alias para la dirección.
accounts/invoicingAddresses/city
Opcionalstring
Ciudad.
accounts/invoicingAddresses/company
Opcionalstring
Nombre de la empresa.
accounts/invoicingAddresses/customerType
Opcionalstring
Tipo de usuario.
Valores permitidos: EMPTY, PARTICULAR, BUSINESS, FREELANCE
accounts/invoicingAddresses/default
Opcionalboolean
Establecer la dirección como predeterminada.
accounts/invoicingAddresses/fax
Opcionalstring
Fax.
accounts/invoicingAddresses/firstName
Opcionalstring
Nombre.
accounts/invoicingAddresses/lastName
Opcionalstring
Apellidos.
accounts/invoicingAddresses/location
Obligatoriostruct
Bloque de parámetros para la ubicación.
accounts/invoicingAddresses/location/coordinate
Obligatoriostruct
Bloque de parámetros para las coordenadas.
accounts/invoicingAddresses/location/coordinate/latitude
Opcionalnumeric
Coordenada de latitud.
accounts/invoicingAddresses/location/coordinate/longitude
Opcionalnumeric
Coordenada de longitud.
accounts/invoicingAddresses/location/countryCode
Opcionalstring
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
Opcionalnumeric
Identificador interno de una subdivisión de un país.
accounts/invoicingAddresses/mobile
Opcionalstring
Teléfono móvil.
accounts/invoicingAddresses/nif
Opcionalstring
Número o código de identidad del usuario.
accounts/invoicingAddresses/number
Opcionalstring
Número de casa o edificio.
accounts/invoicingAddresses/pId
Opcionalstring
Identificador público.
accounts/invoicingAddresses/phone
Opcionalstring
Teléfono.
accounts/invoicingAddresses/postalCode
Opcionalstring
Código postal. Requerido si no se proporciona locationId.
accounts/invoicingAddresses/re
Opcionalboolean
Especifica si el usuario está sujeto al impuesto de igualación de ventas.
accounts/invoicingAddresses/reverseChargeVat
Opcionalboolean
Especifica si el cliente se considera un contribuyente que realiza una inversión con fines fiscales.
accounts/invoicingAddresses/state
Opcionalstring
Provincia o estado.
accounts/invoicingAddresses/tax
Opcionalboolean
Especifica si el usuario está sujeto a impuestos.
accounts/invoicingAddresses/vat
Opcionalstring
Código de identificación fiscal de la empresa.
accounts/master
Obligatoriostruct
Bloque de parámetros para el usuario registrado maestro de la cuenta.
accounts/master/defaultCurrency
Opcionalstring
Especifica la moneda predeterminada en formato ISO 4217.
accounts/master/defaultLanguage
Opcionalstring
Especifica el idioma predeterminado en formato ISO 639-1.
accounts/master/job
Opcionalstring
Solo aplica a cuentas COMPANY o COMPANY_DIVISION. Describe la ocupación del maestro de la cuenta.
accounts/master/registeredUser
Obligatoriostruct
Bloque de parámetros para el usuario registrado. Es obligatorio si no se proporciona registeredUserId.
accounts/master/registeredUser/backOfficeUser
Obligatoriostruct
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
Opcionalstring
Nivel del usuario de back office.
Valores permitidos: SUPER_ADMINISTRATOR, ADMINISTRATOR
accounts/master/registeredUser/birthday
Opcionalstring
Fecha de nacimiento. Formato ISO-8601 ('YYYY-MM-DD').
accounts/master/registeredUser/email
Opcionalstring
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
Opcionalstring
Nombre.
accounts/master/registeredUser/gender
Opcionalstring
Género del usuario registrado.
Valores permitidos: UNDEFINED, MALE, FEMALE
accounts/master/registeredUser/id
Opcionalnumeric
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
Opcionalstring
Ruta del archivo de imagen.
accounts/master/registeredUser/lastName
Opcionalstring
Apellido.
accounts/master/registeredUser/pId
Opcionalstring
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
Opcionalstring
Contraseña.
accounts/master/registeredUser/profiles
Obligatorioarray
Perfiles del usuario registrado.
Valores permitidos: SALES_AGENT, BLOGGER, SUPPLIER, BACK_OFFICE_USER
accounts/master/registeredUser/username
Opcionalstring
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
Opcionalboolean
Indica usar una dirección de envío diferente de la dirección de facturación.
accounts/pId
Opcionalstring
Identificador público.
accounts/shippingAddresses
Obligatorioarray
Bloque de parámetros para las direcciones de envío.
accounts/shippingAddresses/address
Opcionalstring
Dirección.
accounts/shippingAddresses/addressAdditionalInformation
Opcionalstring
Campo adicional de dirección.
accounts/shippingAddresses/alias
Opcionalstring
Alias para la dirección.
accounts/shippingAddresses/city
Opcionalstring
Ciudad.
accounts/shippingAddresses/company
Opcionalstring
Nombre de la empresa.
accounts/shippingAddresses/default
Opcionalboolean
Establecer la dirección como predeterminada.
accounts/shippingAddresses/fax
Opcionalstring
Fax.
accounts/shippingAddresses/firstName
Opcionalstring
Nombre.
accounts/shippingAddresses/lastName
Opcionalstring
Apellidos.
accounts/shippingAddresses/location
Obligatoriostruct
Bloque de parámetros para la ubicación.
accounts/shippingAddresses/location/coordinate
Obligatoriostruct
Bloque de parámetros para las coordenadas.
accounts/shippingAddresses/location/coordinate/latitude
Opcionalnumeric
Coordenada de latitud.
accounts/shippingAddresses/location/coordinate/longitude
Opcionalnumeric
Coordenada de longitud.
accounts/shippingAddresses/location/countryCode
Opcionalstring
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
Opcionalnumeric
Identificador interno de una subdivisión de un país.
accounts/shippingAddresses/mobile
Opcionalstring
Teléfono móvil.
accounts/shippingAddresses/nif
Opcionalstring
Número o código de identidad del usuario.
accounts/shippingAddresses/number
Opcionalstring
Número de casa o edificio.
accounts/shippingAddresses/pId
Opcionalstring
Identificador público.
accounts/shippingAddresses/phone
Opcionalstring
Teléfono.
accounts/shippingAddresses/postalCode
Opcionalstring
Código postal. Requerido si no se proporciona locationId.
accounts/shippingAddresses/state
Opcionalstring
Provincia o estado.
accounts/shippingAddresses/vat
Opcionalstring
Código de identificación fiscal de la empresa.
accounts/status
Opcionalstring
Estado de la cuenta.
Valores permitidos: ENABLED, DISABLED, PENDING_VERIFICATION, PENDING_MERCHANT_ACTIVATION, DENIED
accounts/type
Opcionalstring
Tipo de cuenta a crear.
Valores permitidos: GENERAL, INDIVIDUAL, FREELANCE, COMPANY, COMPANY_DIVISION
accounts/visits
Opcionalnumeric
Número de visitas.
accounts/vouchers
Obligatorioarray
Cupones de regalo vinculados a la cuenta.
accounts/vouchers/availableBalance
Opcionalnumeric
Indica el saldo disponible del cupón de regalo.
accounts/vouchers/code
Opcionalstring
Indica el código alfanumérico que identifica el cupón de regalo. Debe ser único entre todos los cupones.
accounts/vouchers/currencyCode
Opcionalstring
Código de moneda en formato ISO 4217.
accounts/vouchers/expirationDate
Opcionaldatetime
Fecha de expiración del cupón de regalo. Formato ISO-8601 ('YYYY-MM-DDThh:mm:ssZ')
accounts/vouchers/pId
Opcionalstring
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
VariableR/OValor por defectoTipo
id
Obligatorionumeric
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
VariableR/OValor por defectoTipo
id
Obligatorionumeric
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:
VariableR/OValor por defectoTipo
accounts
Obligatoriostruct
Bloque de parámetros con la información de la cuenta a actualizar.
accounts/description
Opcionalstring
Descripción de la estructura de la empresa. Solo para los tipos de cuenta: COMPANY, COMPANY_DIVISION.
accounts/email
Opcionalstring
Dirección de correo electrónico de la estructura de la empresa. Solo aplica a cuentas COMPANY.
accounts/group
Opcionalstruct
Bloque de parámetros para el grupo de cuentas.
accounts/group/id
Opcionalnumeric
Identificador interno del grupo de cuentas de la cuenta.
accounts/group/pId
Opcionalstring
Identificador público del grupo de cuentas de la cuenta.
accounts/image
Opcionalstring
Ruta del archivo de imagen de la cuenta.
accounts/master
Opcionalstruct
Bloque de parámetros para el usuario registrado maestro de la cuenta.
accounts/master/defaultCurrency
Opcionalstring
Especifica la moneda predeterminada en formato ISO 4217.
accounts/master/defaultLanguage
Opcionalstring
Especifica el idioma predeterminado en formato ISO 639-1.
accounts/master/job
Opcionalstring
Solo aplica a cuentas COMPANY o COMPANY_DIVISION. Describe la ocupación del maestro de la cuenta.
accounts/master/registeredUser
Opcionalstruct
Bloque de parámetros para el usuario registrado.
accounts/master/registeredUser/birthday
Opcionalstring
Fecha de nacimiento. Formato ISO-8601 ('YYYY-MM-DD').
accounts/master/registeredUser/email
Opcionalstring
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
Opcionalstring
Nombre.
accounts/master/registeredUser/gender
Opcionalstring
Género del usuario registrado.
Valores permitidos: UNDEFINED, MALE, FEMALE
accounts/master/registeredUser/image
Opcionalstring
Ruta del archivo de imagen.
accounts/master/registeredUser/lastName
Opcionalstring
Apellido.
accounts/master/registeredUser/pId
Opcionalstring
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
Opcionalstring
Contraseña.
accounts/master/registeredUser/profiles
Opcionalarray [0:n]
Perfiles del usuario registrado.
Valores permitidos: SALES_AGENT, BLOGGER, SUPPLIER, BACK_OFFICE_USER
accounts/master/registeredUser/username
Opcionalstring
Nombre de usuario. Debe ser único entre usuarios registrados. Si se establece como keyCriteria, no puede estar en blanco.
accounts/master/role
Opcionalstruct
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
Opcionalnumeric
Identificador interno del rol. Si no se proporciona, se asignará el rol predeterminado para maestros definido en la cuenta Company.
accounts/master/role/pId
Opcionalstring
Identificador público del rol.
accounts/master/useShippingAddress
Opcionalboolean
Indica usar una dirección de envío diferente de la dirección de facturación.
accounts/pId
Opcionalstring
Identificador público.
accounts/parentAccount
Opcionalstruct
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
Opcionalnumeric
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
Opcionalstring
Identificador público de la cuenta padre.
accounts/salesAgents
Opcionalarray [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
Opcionalnumeric
Identificador interno del agente de ventas. Proporcionar 0 para indicar que no está asociado con ningún agente de ventas.
accounts/salesAgents/pId
Opcionalstring
Identificador público del agente de ventas.
accounts/segmentationInheritanceAccount
Opcionalstruct
Bloque de parámetros para la cuenta de herencia de segmentación. Solo aplica a cuentas de tipo COMPANY_DIVISION.
accounts/segmentationInheritanceAccount/id
Opcionalnumeric
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
Opcionalstring
Identificador público de la cuenta de herencia de segmentación.
accounts/status
Opcionalstring
Estado de la cuenta.
Valores permitidos: ENABLED, DISABLED, PENDING_MERCHANT_ACTIVATION, DENIED
accounts/visits
Opcionalnumeric
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
VariableR/OValor por defectoTipo
id
Obligatorionumeric
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
VariableR/OValor por defectoTipo
id
Obligatorionumeric
Identificador interno del elemento.
commerceIdList
Opcionalstring
Lista de identificadores internos de comercios. Los elementos devueltos deben pertenecer al menos a uno de ellos.
name
Opcionalstring
Los roles personalizados de empresa devueltos deben tener este nombre. El filtro consiste en aplicar un LIKE '%inputData%'.
page
Opcionalnumeric
Número de página.
perPage
Opcionalnumeric
Número de elementos a obtener por página.
target
Opcionalstring
Devuelve los roles personalizados de empresa cuyo objetivo es el indicado.
Valores permitidos: COMPANY_DIVISION_MASTER, COMPANY_STRUCTURE_NON_MASTER
targetDefault
Opcionalboolean
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
VariableR/OValor por defectoTipo
id
Obligatorionumeric
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:
VariableR/OValor por defectoTipo
companyDivisions
Obligatoriostruct
Bloque de parámetros para crear la división de empresa.
companyDivisions/customTags
Obligatorioarray
Bloque de parámetros para etiquetas personalizadas. Si no se proporciona valor para alguna de las etiquetas personalizadas, no se asigna.
companyDivisions/customTags/customTag
Obligatoriostruct
Bloque de parámetros para la etiqueta personalizada.
companyDivisions/customTags/customTag/id
Opcionalnumeric
Identificador interno de la etiqueta personalizada del tipo de elemento correspondiente.
companyDivisions/customTags/customTag/pId
Opcionalstring
Identificador público de la etiqueta personalizada.
companyDivisions/customTags/general
Obligatoriostruct
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
Opcionalboolean
Visibilidad de la etiqueta personalizada para el elemento.
companyDivisions/customTags/general/extension
Opcionalstring
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
Opcionalstring
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
Opcionalstring
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
Obligatoriostruct
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
Opcionalnumeric
Identificador interno del grupo de etiquetas personalizadas. Debe ser un grupo al que pertenezca la etiqueta personalizada.
companyDivisions/customTags/group/pId
Opcionalstring
Identificador público del grupo de etiquetas personalizadas.
companyDivisions/customTags/languages
Obligatorioarray
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
Opcionalboolean
Visibilidad de la etiqueta personalizada para el elemento.
companyDivisions/customTags/languages/extension
Opcionalstring
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
Opcionalstring
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
Opcionalstring
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
Opcionalstring
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
Opcionalstring
Descripción de la estructura de la empresa. Solo para los tipos de cuenta: COMPANY, COMPANY_DIVISION.
companyDivisions/email
Opcionalstring
Dirección de correo electrónico de la estructura de la empresa. Solo aplica a cuentas COMPANY.
companyDivisions/group
Obligatoriostruct
Bloque de parámetros para el grupo de cuentas.
companyDivisions/group/id
Opcionalnumeric
Identificador interno del grupo de cuentas.
companyDivisions/group/pId
Opcionalstring
Identificador público del grupo de cuentas.
companyDivisions/image
Opcionalstring
Ruta del archivo de imagen de la cuenta.
companyDivisions/master
Obligatoriostruct
Bloque de parámetros para el usuario registrado maestro de la cuenta.
companyDivisions/master/defaultCurrency
Opcionalstring
Especifica la moneda predeterminada en formato ISO 4217.
companyDivisions/master/defaultLanguage
Opcionalstring
Especifica el idioma predeterminado en formato ISO 639-1.
companyDivisions/master/job
Opcionalstring
Solo aplica a cuentas COMPANY o COMPANY_DIVISION. Describe la ocupación del maestro de la cuenta.
companyDivisions/master/registeredUser
Obligatoriostruct
Bloque de parámetros para el usuario registrado. Es obligatorio si no se proporciona registeredUserId.
companyDivisions/master/registeredUser/backOfficeUser
Obligatoriostruct
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
Opcionalstring
Nivel del usuario de back office.
Valores permitidos: SUPER_ADMINISTRATOR, ADMINISTRATOR
companyDivisions/master/registeredUser/birthday
Opcionalstring
Fecha de nacimiento. Formato ISO-8601 ('YYYY-MM-DD').
companyDivisions/master/registeredUser/email
Opcionalstring
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
Opcionalstring
Nombre.
companyDivisions/master/registeredUser/gender
Opcionalstring
Género del usuario registrado.
Valores permitidos: UNDEFINED, MALE, FEMALE
companyDivisions/master/registeredUser/id
Opcionalnumeric
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
Opcionalstring
Ruta del archivo de imagen.
companyDivisions/master/registeredUser/lastName
Opcionalstring
Apellido.
companyDivisions/master/registeredUser/pId
Opcionalstring
Identificador público.
companyDivisions/master/registeredUser/password
Opcionalstring
Contraseña.
companyDivisions/master/registeredUser/profiles
Obligatorioarray
Perfiles del usuario registrado.
Valores permitidos: SALES_AGENT, BLOGGER, SUPPLIER, BACK_OFFICE_USER
companyDivisions/master/registeredUser/role
Obligatoriostruct
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
Opcionalnumeric
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
Opcionalstring
Identificador público del rol.
companyDivisions/master/registeredUser/status
Opcionalstring
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
Opcionalstring
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
Opcionalboolean
Indica usar una dirección de envío diferente de la dirección de facturación.
companyDivisions/pId
Opcionalstring
Identificador público.
companyDivisions/segmentationInheritanceAccount
Obligatoriostruct
Bloque de parámetros para la cuenta de herencia de segmentación.
companyDivisions/segmentationInheritanceAccount/id
Opcionalnumeric
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
Opcionalstring
Identificador público de la cuenta de herencia de segmentación.
companyDivisions/shippingAddresses
Obligatorioarray
Bloque de parámetros para las direcciones de envío.
companyDivisions/shippingAddresses/address
Opcionalstring
Dirección.
companyDivisions/shippingAddresses/addressAdditionalInformation
Opcionalstring
Campo adicional de dirección.
companyDivisions/shippingAddresses/alias
Opcionalstring
Alias para la dirección.
companyDivisions/shippingAddresses/city
Opcionalstring
Ciudad.
companyDivisions/shippingAddresses/company
Opcionalstring
Nombre de la empresa.
companyDivisions/shippingAddresses/default
Opcionalboolean
Establecer la dirección como predeterminada.
companyDivisions/shippingAddresses/fax
Opcionalstring
Fax.
companyDivisions/shippingAddresses/firstName
Opcionalstring
Nombre.
companyDivisions/shippingAddresses/lastName
Opcionalstring
Apellidos.
companyDivisions/shippingAddresses/location
Obligatoriostruct
Bloque de parámetros para la ubicación.
companyDivisions/shippingAddresses/location/coordinate
Obligatoriostruct
Bloque de parámetros para las coordenadas.
companyDivisions/shippingAddresses/location/coordinate/latitude
Opcionalnumeric
Coordenada de latitud.
companyDivisions/shippingAddresses/location/coordinate/longitude
Opcionalnumeric
Coordenada de longitud.
companyDivisions/shippingAddresses/location/countryCode
Opcionalstring
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
Opcionalnumeric
Identificador interno de una subdivisión de un país.
companyDivisions/shippingAddresses/mobile
Opcionalstring
Teléfono móvil.
companyDivisions/shippingAddresses/nif
Opcionalstring
Número o código de identidad del usuario.
companyDivisions/shippingAddresses/number
Opcionalstring
Número de casa o edificio.
companyDivisions/shippingAddresses/pId
Opcionalstring
Identificador público.
companyDivisions/shippingAddresses/phone
Opcionalstring
Teléfono.
companyDivisions/shippingAddresses/postalCode
Opcionalstring
Código postal. Requerido si no se proporciona locationId.
companyDivisions/shippingAddresses/state
Opcionalstring
Provincia o estado.
companyDivisions/shippingAddresses/vat
Opcionalstring
Código de identificación fiscal de la empresa.
companyDivisions/status
Opcionalstring
Estado de la cuenta.
Valores permitidos: ENABLED, DISABLED, PENDING_VERIFICATION, PENDING_MERCHANT_ACTIVATION, DENIED
companyDivisions/vouchers
Obligatorioarray
Cupones de regalo vinculados a la cuenta.
companyDivisions/vouchers/availableBalance
Opcionalnumeric
Indica el saldo disponible del cupón de regalo.
companyDivisions/vouchers/code
Opcionalstring
Indica el código alfanumérico que identifica el cupón de regalo. Debe ser único entre todos los cupones.
companyDivisions/vouchers/currencyCode
Opcionalstring
Código de moneda en formato ISO 4217.
companyDivisions/vouchers/expirationDate
Opcionaldatetime
Fecha de expiración del cupón de regalo. Formato ISO-8601 ('YYYY-MM-DDThh:mm:ssZ')
companyDivisions/vouchers/pId
Opcionalstring
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
VariableR/OValor por defectoTipo
id
Obligatorionumeric
Identificador interno de la cuenta.
addedFrom
Opcionaldatetime
Los elementos devueltos deben estar creados en la fecha indicada o posteriormente. Formato ISO-8601 ('YYYY-MM-DDThh:mm:ssZ').
addedTo
Opcionaldatetime
Los elementos devueltos deben estar creados en la fecha indicada o previamente. Formato ISO-8601 ('YYYY-MM-DDThh:mm:ssZ').
commerceIdList
Opcionalstring
Lista de identificadores internos de comercios. Los elementos devueltos deben pertenecer a alguno de ellos. Lista separada por comas.
email
Opcionalstring
Los usuarios registrados devueltos deben tener el email indicado. El filtro consiste en un LIKE '%inputData%'.
firstName
Opcionalstring
Los usuarios registrados devueltos deben tener el nombre indicado. El filtro consiste en un LIKE '%inputData%'.
lastName
Opcionalstring
Los usuarios registrados devueltos deben tener los apellidos indicados. El filtro consiste en un LIKE '%inputData%'.
page
Opcionalnumeric
Número de página.
perPage
Opcionalnumeric
Número de elementos que se quieren obtener por página.
roleId
Opcionalnumeric
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
Opcionalstring
Variable de ordenación.
statusList
Opcionalstring
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
Opcionalstring
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
VariableR/OValor por defectoTipo
id
Obligatorionumeric
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:
VariableR/OValor por defectoTipo
accountRegisteredUsers
Obligatoriostruct
Bloque de parámetros que contiene todos los datos para asociar un usuario registrado con la cuenta.
accountRegisteredUsers/job
Opcionalstring
Descripción del trabajo.
accountRegisteredUsers/registeredUser
Obligatoriostruct
Bloque de parámetros con la información del usuario registrado.
accountRegisteredUsers/registeredUser/backOfficeUser
Opcionalstruct
Información del usuario de back office.
accountRegisteredUsers/registeredUser/backOfficeUser/level
Opcionalstring
Nivel del usuario de back office. Valores permitidos: SUPER_ADMINISTRATOR, ADMINISTRATOR
accountRegisteredUsers/registeredUser/birthday
Opcionalstring
Fecha de nacimiento. Formato ISO-8601 ('YYYY-MM-DD').
accountRegisteredUsers/registeredUser/email
Opcionalstring
Dirección de correo electrónico.
accountRegisteredUsers/registeredUser/firstName
Opcionalstring
Nombre.
accountRegisteredUsers/registeredUser/gender
Opcionalstring
Género del usuario registrado. Valores permitidos: UNDEFINED, MALE, FEMALE
accountRegisteredUsers/registeredUser/id
Opcionalnumeric
Identificador interno de un usuario registrado existente.
accountRegisteredUsers/registeredUser/image
Opcionalstring
Ruta del archivo de imagen.
accountRegisteredUsers/registeredUser/lastName
Opcionalstring
Apellidos.
accountRegisteredUsers/registeredUser/pId
Opcionalstring
Identificador público del usuario registrado.
accountRegisteredUsers/registeredUser/password
Opcionalstring
Contraseña.
accountRegisteredUsers/registeredUser/profiles
Opcionalarray [0:n]
Perfiles del usuario registrado.
accountRegisteredUsers/registeredUser/username
Opcionalstring
Nombre de usuario.
accountRegisteredUsers/role
Opcionalstruct
Bloque de parámetros para el rol personalizado de empresa.
accountRegisteredUsers/role/id
Opcionalnumeric
Identificador interno del rol personalizado de empresa.
accountRegisteredUsers/role/pId
Opcionalstring
Identificador público del rol personalizado de empresa.
accountRegisteredUsers/status
Opcionalstring
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
VariableR/OValor por defectoTipo
id
Obligatorionumeric
Identificador interno de la cuenta.
registeredUserId
Opcionalnumeric
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
VariableR/OValor por defectoTipo
id
Obligatorionumeric
Identificador interno de la cuenta.
registeredUserId
Obligatorionumeric
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:
VariableR/OValor por defectoTipo
accountRegisteredUsers
Obligatoriostruct
Bloque de parámetros que contiene la información de relación del usuario registrado a actualizar.
accountRegisteredUsers/account
Opcionalstruct
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
Opcionalnumeric
Identificador interno de la cuenta.
accountRegisteredUsers/account/pId
Opcionalstring
Identificador público de la cuenta.
accountRegisteredUsers/accountAlias
Opcionalstring
Alias dado a esta cuenta por el usuario registrado.
accountRegisteredUsers/defaultCurrency
Opcionalstring
Indica la moneda predeterminada en formato ISO 4217.
accountRegisteredUsers/defaultLanguage
Opcionalstring
Indica el idioma predeterminado en formato ISO 639-1.
accountRegisteredUsers/job
Opcionalstring
Solo aplica a cuentas de tipo `COMPANY` o `COMPANY_DIVISION`. Describe la ocupación del empleado.
accountRegisteredUsers/master
Opcionalboolean
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
Opcionalstruct
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
Opcionalnumeric
Identificador interno del rol personalizado de empresa.
accountRegisteredUsers/role/pId
Opcionalstring
Identificador público del rol personalizado de empresa.
accountRegisteredUsers/status
Opcionalstring
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
VariableR/OValor por defectoTipo
id
Obligatorionumeric
Identificador interno de la cuenta.
registeredUserId
Obligatorionumeric
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
VariableR/OValor por defectoTipo
pId
Obligatoriostring
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
VariableR/OValor por defectoTipo
pId
Obligatoriostring
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
VariableR/OValor por defectoTipo
pId
Obligatoriostring
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
VariableR/OValor por defectoTipo
accountIdList
Opcionalstring
Lista de identificadores internos de cuentas. Los usuarios registrados devueltos deben estar asociados a alguna de ellas. Lista separada por comas.
addedFrom
Opcionaldatetime
Los elementos devueltos deben estar creados en la fecha indicada o posteriormente. Formato ISO-8601 ('YYYY-MM-DDThh:mm:ssZ')
addedTo
Opcionaldatetime
Los elementos devueltos deben estar creados en la fecha indicada o previamente. Formato ISO-8601 ('YYYY-MM-DDThh:mm:ssZ')
commerceIdList
Opcionalstring
Lista de identificadores internos de comercios. Los elementos devueltos deben pertenecer a alguno de ellos. Lista separada por comas.
customTagId
Opcionalstring
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).
email
Opcionalstring
Los usuarios registrados devueltos deben tener el email indicado. El filtro consiste en un LIKE '%inputData%'.
firstName
Opcionalstring
Los usuarios registrados devueltos deben tener el nombre indicado. El filtro consiste en un LIKE '%inputData%'.
lastName
Opcionalstring
Los usuarios registrados devueltos deben tener los apellidos indicados. El filtro consiste en un LIKE '%inputData%'.
master
Opcionalboolean
Los usuarios registrados devueltos deben ser master de alguna cuenta.
pId
Opcionalstring
Los usuarios registrados devueltos deben tener el identificador indicado.
page
Opcionalnumeric
Número de página.
perPage
Opcionalnumeric
Número de elementos que se quieren obtener por página.
profileList
Opcionalstring
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
Opcionalstring
Criterio de búsqueda sobre los campos nombre, apellidos y el campo clave (email, pId o username). LIKE '%q%'.
sort
Opcionalstring
Variable de ordenación. Lista separada por comas como: id.asc, firstName.desc, etc.
username
Opcionalstring
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
VariableR/OValor por defectoTipo
id
Obligatorionumeric
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
VariableR/OValor por defectoTipo
id
Obligatorionumeric
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:
VariableR/OValor por defectoTipo
registeredUsers
Obligatoriostruct
Bloque de parámetros con la información del usuario registrado a actualizar.
registeredUsers/birthday
Opcionalstring
Fecha de nacimiento. Formato ISO-8601 ('YYYY-MM-DD').
registeredUsers/email
Opcionalstring
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
Opcionalstring
Nombre.
registeredUsers/gender
Opcionalstring
Género del usuario registrado. Valores permitidos: UNDEFINED, MALE, FEMALE
registeredUsers/image
Opcionalstring
Ruta del archivo de imagen.
registeredUsers/lastName
Opcionalstring
Apellidos.
registeredUsers/pId
Opcionalstring
Identificador público del elemento. Si está configurado como clave debe ser único entre usuarios registrados y no tener valor vacío.
registeredUsers/password
Opcionalstring
Password. No puede ser una cadena vacía.
registeredUsers/profiles
Opcionalarray [0:n]
Perfiles del usuario registrado. Valores permitidos: SALES_AGENT, BLOGGER, SUPPLIER, BACK_OFFICE_USER
registeredUsers/username
Opcionalstring
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
VariableR/OValor por defectoTipo
id
Obligatorionumeric
Identificador interno.
fields
Opcionalstring
Lista de campos a devolver.
fromDate
Opcionaldatetime
Devuelve los comentarios a partir de la fecha facilitada del usuario indicado.
onlyAccepted
Opcionalboolean
Devuelve los comentarios aceptados del usuario indicado.
onlyRevised
Opcionalboolean
Devuelve los comentarios revisados del usuario indicado.
page
Opcionalnumeric
Nº de página solicitada.
perPage
Opcionalnumeric
Cantidad de elementos por página.
productId
Opcionalnumeric
Devuelve los comentarios del producto facilitado por identificador interno del usuario indicado.
q
Opcionalstring
Criterio de búsqueda.
toDate
Opcionaldatetime
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
VariableR/OValor por defectoTipo
id
Obligatorionumeric
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
VariableR/OValor por defectoTipo
id
Obligatorionumeric
Identificador interno.
Parámetros de entrada JSON
{
"backOfficeUsers": {
"level":string
}
}
Variables JSON:
VariableR/OValor por defectoTipo
backOfficeUsers
Obligatoriostruct
Bloque de información sobre el usuario de back office.
backOfficeUsers/level
Opcionalstring
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
VariableR/OValor por defectoTipo
id
Obligatorionumeric
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
VariableR/OValor por defectoTipo
id
Obligatorionumeric
Identificador interno.
Parámetros de entrada JSON
{
"salesAgents": {
"active":boolean,
"pId":string,
"percentCommission":numeric
}
}
Variables JSON:
VariableR/OValor por defectoTipo
salesAgents
Obligatoriostruct
Bloque de información sobre el agente de venta.
salesAgents/active
Opcionalboolean
Define si el agente de venta está activo.
salesAgents/pId
Opcionalstring
Identificador público del agente de venta.
salesAgents/percentCommission
Opcionalnumeric
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
VariableR/OValor por defectoTipo
id
Obligatorionumeric
Identificador interno.
accountId
Obligatorionumeric
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
VariableR/OValor por defectoTipo
id
Obligatorionumeric
Identificador interno.
accountId
Obligatorionumeric
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
VariableR/OValor por defectoTipo
pId
Obligatoriostring
Identificador público.
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 123
}