Modificar socio de negocios existente

El punto final PUT /pic/link/business-partners/update le permite actualizar los socios comerciales que interactuarán con la plataforma AppliQloud. 👔💼🤝

Authorización

Este endpoint requiere autenticación a través de Basic Auth con el nombre de usuario y contraseña del backend que lo consumirá. Para crear y configurar un backend, siga el tutorial de backends

Parámetros requeridos

👣 Path

Esta solicitud no contiene parámetros de tipo Path

🔍 Query

Esta solicitud no contiene parámetros de tipo Query

💪 Body

Cuerpo del JSON

{
   "inputs": [
      BusinessPartner
   ]
}

Nombre	Tipo	Por defecto	Descripción
inputs	Array[BusinessPartner]	Required	Lista de socios comerciales para crear

BusinessPartner

{
   "externalId": string,
   "name": string,
   "email": string,
   "identification": BusinessPartnerIdentification,
   "businessPartnerTypeIds": [
      string
   ],
   "contacts":[
      BusinessPartnerContact
   ]
}

Nombre	Tipo	Por defecto	Descripción
externalId	string	Required	Identificador en el sistema externo
name	string	Required	Nombre del socio de negocios
identification	BusinessPartnerIdentification	Required	Identificador del socio de negocios
businessPartnerTypeIds	Array[BusinessPartnerType]	Required	Tipo de socio de negocios
contacts	Array[BusinessPartnerContact ]	[]	Contactos del socio de negocios

---

BusinessPartnerIdentification

Valores posibles: [COMPANY, PERSON]

---

BusinessPartnerType

Valores posibles: [VENDOR]

---

BusinessPartnerContact

{
  "firstName": string,
  "lastName": string,
  "email": string
}

Nombre	Tipo	Por defecto	Descripción
firstName	string	Required	Nombre del nuevo usuario
lastName	string	Required	Apellido del nuevo usuario
email	string	Required	Email del nuevo usuario

info

Este objeto se utiliza para registrar un nuevo usuario como contacto de socio comercial. La solicitud devolverá un estado de 400 bad request si el correo electrónico ya está asociado con un usuario existente en la plataforma AppliQloud.

Ejemplos

🖥️ cURL

curl --location 'https://<identifier>.api.appliqloud.com/pic/link/business-partners/update' \
--request PUT \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <token>' \
--data '{
   "inputs": [
      {
         "externalId": "1245",
         "name": "AppliQloud",
         "email": "contact@appliqloud.com",
         "identification": "COMPANY",
         "businessPartnerTypeIds": [
            "VENDOR"
         ],
         "contacts":[
            {
               "firstName": "Juan",
               "lastName": "Pérez",
               "email": "juan.perez@mail.com"
            }
         ]
      }
   ]
}'

caution

Asegúrese de modificar los campos <identifier> y <token> con el identificador de su empresa y el token de autenticación respectivamente.

Respuestas

✅ 200

Los socios de negocios se actualizaron exitosamente.

{
   "success": [
      {
         "id": "32",
         "name": "AppliQloud",
         "email": "sales@appliqloud.com",
         "status": "PENDING_COMPLETION",
         "identification": "PERSON"
         "businessPartnerTypeIds": [
             "VENDOR"
         ],
         "contacts": [
             {
                "userId": "jimenezd24",
                "notificationChannels": [
                   "EMAIL"
                ]
             }
         ],
         "backendMappings": [
           {
             "backendId": "SAP",
             "externalId": "6247"
           }
         ]
      }
   ],
   "errors": []
}

⚠️ 201 (with errors)

Hay un error en la petición

{
   "success": [],
   "errors": [
      {
         "traceId": "3095a0a77f80436ba104eb2fc24ba343"
         "cause": "BusinessPartnerNotFoundException",
         "message": "Business partner with external identifier 6248 not found for backend SAP",
         "context": {
            "backendId": "6248",
            "externalId": "SAP"
         }
      }
   ]
}

🔒 401

Se requiere autorización o las credenciales no son correctas

{
    "traceId": "3095a0a77f80436ba104eb2fc24ba343"
    "request": "POST /pic/business-partners",
    "cause": "UnauthorizedException",
    "message": "Authorization required"
}

🚧 500

Error interno de la aplicación (comuníquese con support@appliqloud.com o abra un ticket de soporte)

{
   "success": [],
   "errors": [
      {
         "traceId": "3095a0a77f80436ba104eb2fc24ba343"
         "cause": "InternalServerError",
         "message": "Internal Server Error",
      }
   ]
}