¿Cómo validar y actualizar un atributo desde la integración en la venta?

Lo primero es validar el o los sets de atributos personalizados para ventas que el merchant tenga creados esto se puede realizar mediante el endpoint Get Checkout Custom Attribute Sets.

ℹ️ Información:

En caso de no poseer atributos creados puedes seguir el paso a paso explicado en el siguiente artículo: Cómo crear y configurar atributos personalizados para ventas en Multivende

Request:

  {
    "entries":
  [
      {
        "_id":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "name":"Set_API_Multivende",
        "position":0
      }
    ],
    "pagination":
  {
      "offset":0,
      "limit":50,
      "total_pages":1,
      "current_page":1,
      "next_page":0,
      "previous_page":0,
      "total_items":1
    }  }

Una vez obtenido el set de atributos, podrás consultar los atributos que contiene utilizando el endpoint Get Checkouts Custom Attributes, el cual te mostrará todos los atributos personalizados de venta asociados a dicho set.

  {
    "entries":
  [
      {
        "_id":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "name":"Atributo_API",
        "code":"atributo_api",
        "description":null,
        "position":0,
        "tags":null,
        "status":"created",
        "createdAt":"2025-11-10T15:37:25.000Z",
        "updatedAt":"2025-11-10T15:37:25.000Z",
        "MerchantId":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "CustomAttributeSetId":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "CustomAttributeScopeId":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "CustomAttributeTypeId":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "CustomAttributeSpecificityId":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "CreatedById":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "UpdatedById":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "CustomAttributeOptions":[]
      }
    ],
    "pagination":{
      "offset":0,
      "limit":50,
      "total_pages":1,
      "current_page":1,
      "next_page":0,
      "previous_page":0,
      "total_items":1
    }

  }

Si deseas editar o asignar un valor a un atributo dentro de una venta, puedes hacerlo a través del endpoint Update Checkout Custom Attribute Values.

En este caso, deberás enviar en el body el CustomAttributeId del atributo que quieres modificar y el CustomAttributeOptionId correspondiente a la opción que deseas asignar.

Request:

  curl--location--requestPUT
  \'https://app.multivende.com/api/checkouts/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/custom-attributes-values/upsert'\
  --header'Content-Type: application/json'\
  --header'Authorization: Bearer (TOKEN)'\
  --data'{
    "CustomAttributeValues":
  {
    "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX":"Texto Simple"
    }}'

Response:

  [
    {
      "_id":
  "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
      "position":0,
      "status":"created",
      "CustomAttributeId":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
      "MerchantId":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
      "CreatedById":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
      "UpdatedById":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
      "CheckoutId":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
      "text":"Texto Simple",
      "updatedAt":"2025-11-10T15:41:00.000Z",
      "createdAt":"2025-11-10T15:41:00.000Z"
    }

  ]

¿Cómo se visualiza el detalle del atributo personalizado en la API?

Para consultar el detalle de los atributos custom asociados a una venta, es importante revisar el detalle de la venta mediante el Get Checkout y consultar el campo:

"CustomAttributeValues"

Este campo corresponde a un arreglo (array) que contiene la información de los atributos personalizados asociados a la transacción.

Dentro de este arreglo se puede encontrar:

El tipo de atributo configurado.
La opción seleccionada específicamente para esa venta.
Información adicional relacionada con el atributo.

Cada objeto dentro de CustomAttributeValues representa un atributo personalizado aplicado al checkout.

  {
    "CustomAttributeValues":
  [
      {
        "_id":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX",
        "name":null,
        "text":"Y",
        "number":null,
        "code":null,
        "createdAt":"2026-02-13T15:06:22.000Z",
        "updatedAt":"2026-02-13T15:06:22.000Z",
        "CustomAttributeId":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX",
        "CustomAttributeOptionId":null,
        "CustomAttributeSetId":null,
        "CheckoutId":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX",
        "CreatedById":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX",
        "UpdatedById":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX",
        "CustomAttribute":
  {
          "_id":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX",
          "name":"Estado",
          "code":"estado",
          "description":null,
          "createdAt":"2021-04-27T16:22:14.000Z",
          "updatedAt":"2021-04-27T16:22:14.000Z",
          "CustomAttributeSet":
  {
            "_id":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX",
            "name":"EstadoIntegracion",
            "description":"Estado Integración"
          },
          "CustomAttributeType":
  {
            "_id":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "name":"CUSTOM_ATTRIBUTE_TYPES.Single_line_text.Name",
            "code":"single_line_text",
            "description":"CUSTOM_ATTRIBUTE_TYPES.Single_line_text.Description"
          }
        },
        "CustomAttributeOption":null
      }
    ]
  }

Equipo Integraciones API Multivende

¿Cómo se visualiza el detalle del atributo personalizado en la API?

0 comentarios

¿No encontraste lo que buscabas?