Marketplace

🔹 Obtener el marketplace

Consulta: GET /v1/{marketplace_code}

Respuesta:

Código HTTP: 200

{
  "code": "acme",
  "name": "ACME Marketplace",
  "logo": "https://cdn.freebiesupply.com/logos/large/2x/acme-logo-png-transparent.png",
  "emails": [
    "integraciones@acme.com"
  ],
  "settings": [],
  "publication_options": [
    {
      "code": "installments",
      "name": "Cuotas sin interés",
      "type": "select",
      "options": [
        {
          "name": "No ofrecer cuotas sin interés",
          "code": "no_installments"
        },
        {
          "name": "3 Cuotas sin interés",
          "code": "3_installments"
        },
        {
          "name": "6 Cuotas sin interés",
          "code": "6_installments"
        }
      ]
    }
  ]
}

🔹 Actualizar el marketplace

Consulta: PATCH /v1/{marketplace_code}

Campos actualizables:

Nombre	Descripción	Tipo de dato	Obligatorio
emails	Emails de contacto	Array<String>
* settings	Configuraciones que deberá completar el vendedor	Array<Object>
* publication_options	Opciones de publicación a elegir por el vendedor	Array<Object>

Aclaraciones:

• El campo settings funciona como atajo al endpoint para actualizar configuraciones del marketplace. Se le imponen las mismas reglas que en dicho endpoint.
• El campo publication_options funciona como atajo al endpoint para actualizar opciones de publicación. Se le imponen las mismas reglas que en dicho endpoint.

Ejemplo de payload para la consulta:

{
  "emails": [
    "integraciones@acme.com",
    "soporte@acme.com",
  ],
  "settings": [
    // Configuraciones
  ],
  "publication_options": [
    // Opciones de publicación
  ]
}

Respuesta:

Código HTTP: 200

Devuelve la entidad actualizada.

🔹 Actualizar configuraciones del marketplace

Actualiza el atributo settings del marketplace.

Campos de cada configuración:

Nombre	Descripción	Tipo de dato	Obligatorio	Valores permitidos
code	Identificador interno	String	X
name	Título que verá el vendedor	String	X
type	Tipo de componente	String	X	Ver abajo
placeholder	Placeholder que verá el vendedor	String
options	Opciones a elegir por el vendedor	Array<Object>	Ver abajo
options[].code	Código de la opción	String	X
options[].name	Título que verá el vendedor	String	X

Aclaraciones:

• Tipos de componente (type):
  • text: Marco con texto informativo.
  • textbox: Texto ingresado por el vendedor.
  • select: Lista desplegable. El vendedor sólo podrá seleccionar una opción.
  • checkbox_group: Casillas seleccionables. El vendedor podrá seleccionar múltiples opciones a la vez.
• El campo options:
  • Debe tener al menos una opción si type es select o checkbox_group.
  • Debe ser un Array vacío si type es textbox o text.
• El campo placeholer sólo tendrá efecto si type es textbox.

Consulta: PUT /v1/{marketplace_code}/settings

Ejemplo de payload para la consulta:

[
  {
    "code": "user",
    "name": "Usuario",
    "type": "textbox",
    "placeholder": "miusuario@acme.com, MiUsuario"
  },
  {
    "code": "warehouses_to_read_stock_from_message",
    "name": "Obtención de stock: Seleccione algún/os depósitos desde los cuales obtener el stock. En caso de no seleccionar ninguno se obtendrá desde todos.",
    "type": "text"
  },
  {
    "code": "warehouses_to_read_stock_from",
    "name": "Depósitos desde los que se obtendrá el stock",
    "type": "checkbox_group",
    "options": [
      {
        "name": "Depósito 1",
        "code": "warehouse_01"
      },
      {
        "name": "Depósito 2",
        "code": "warehouse_02"
      },
      {
        "name": "Depósito 3",
        "code": "warehouse_03"
      }
    ]
  }
]

Respuesta:

Código HTTP: 200

Devuelve la entidad marketplace actualizada.

🔹 Actualizar opciones de publicación

Actualiza el atributo publications_options del marketplace.

Consulta: PUT /v1/{marketplace_code}/publication_options

Campos de cada opción de publicación:

Nombre	Descripción	Tipo de dato	Obligatorio	Valores permitidos
code	Identificador interno	String	X
name	Título que verá el vendedor	String	X
type	Tipo de componente	String	X	Ver abajo
placeholder	Placeholder que verá el vendedor	String
options	Opciones a elegir por el vendedor	Array<Object>	Ver abajo
options[].code	Código de la opción	String	X
options[].name	Título que verá el vendedor	String	X

Aclaraciones:

• Tipos de componente (type):
  • text: Marco con texto informativo.
  • textbox: Texto ingresado por el vendedor.
  • select: Lista desplegable. El vendedor sólo podrá seleccionar una opción.
  • checkbox_group: Casillas seleccionables. El vendedor podrá seleccionar múltiples opciones a la vez.
• El campo options:
  • Debe tener al menos una opción si type es select o checkbox_group.
  • Debe ser un Array vacío si type es textbox o text.
• El campo placeholer sólo tendrá efecto si type es textbox.

Ejemplo de payload para la consulta:

[
  {
    "code": "installments",
    "name": "Cuotas sin interés",
    "type": "select",
    "options": [
      {
        "name": "No ofrecer cuotas sin interés",
        "code": "no_installments"
      },
      {
        "name": "3 Cuotas sin interés",
        "code": "3_installments"
      },
      {
        "name": "6 Cuotas sin interés",
        "code": "6_installments"
      }
    ]
  }
]

Respuesta:

Código HTTP: 200

Devuelve la entidad marketplace actualizada.

🔹 Actualizar opciones de publicación para una conexión específica

Se aplican las mismas condiciones que en el endpoint anterior.

Consulta: PUT /v1/{marketplace_code}/publication_options/{connection_id}

Las opciones de publicación configuradas para la conexión se sumarán a las opciones de publicación generales.

En caso de repetir algún código (code) la opción de la conexión pisará a la general. Esto es útil para sobreescribir opciones si se desea.

Respuesta:

Código HTTP: 200

Devuelve las opciones de publicación de la conexión.

🔹 Obtener opciones de publicación para una conexión específica

Devuelve las opciones de publicación Específicas de la conexión.

Consulta: GET /v1/{marketplace_code}/publication_options/{connection_id}

Respuesta:

Código HTTP: 200

[
  {
    "code": "installments",
    "name": "Cuotas sin interés",
    "type": "select",
    "options": [
      {
        "name": "No ofrecer cuotas sin interés",
        "code": "no_installments"
      },
      {
        "name": "3 Cuotas sin interés",
        "code": "3_installments"
      }
    ]
  }
]