Campos personalizados

Es la entidad que almacena la información específica de los distintos campos personalizados de información adicional de usuarios.

Aparte de los campos de información estándar y nativos de GoShop, tienes la posibilidad de crear campos personalizados con toda la información adicional que quieras almacenar para los usuarios.

Estos pueden ser muy útiles si por ejemplo: Necesitas almacenar el código de usuario de tu sistema ERP en el ecommerce, puedes crear un campo personalizado para hacerlo.

• Si necesitas almacenar campos de teléfonos adicionales.

• Cualquier otra información específica por usuario que desees almacenar.

Tipos de campos personalizados actualmente disponibles:

1. Campo de texto (text_field)

2. Desplegable con opciones (select_field)

3. Checkbox (check_box)

4. Area de texto (text_area)

Listado de todos los campos personalizados de usuarios.

GET https://tiendagoshop.com/api/v1/user_fields

Headers

Name	Type	Description
X-Spree-Token	string	Token generado desde el CMS de GS

200

{
  "user_fields": [
    {
      "id": 5,
      "name": "Teléfono",
      "field_type": "text_field",
      "visible_in_frontend": null,
      "position": null,
      "created_at": "2020-11-06T13:43:26.260-04:00",
      "updated_at": "2020-11-06T13:43:26.260-04:00",
      "required": false,
      "editable": false,
      "options": []
    },
    {
      "id": 8,
      "name": "ID ERP interno",
      "field_type": "text_field",
      "visible_in_frontend": false,
      "position": null,
      "created_at": "2020-11-16T13:50:31.113-04:00",
      "updated_at": "2020-11-16T13:50:31.113-04:00",
      "required": false,
      "editable": false,
      "options": []
    },
    {
      "id": 11,
      "name": "Tipo de cliente",
      "field_type": "select_field",
      "visible_in_frontend": false,
      "position": null,
      "created_at": "2020-11-16T14:25:38.311-04:00",
      "updated_at": "2020-11-16T14:25:38.311-04:00",
      "required": false,
      "editable": false,
      "options": [
        {
          "id": 3,
          "name": "VIP",
          "position": null
        },
        {
          "id": 4,
          "name": "Clave",
          "position": null
        },
        {
          "id": 5,
          "name": "Retail",
          "position": null
        }
      ]
    },
    {
      "id": 12,
      "name": "Suscrito a newsletter",
      "field_type": "check_box",
      "visible_in_frontend": false,
      "position": null,
      "created_at": "2020-11-16T14:28:35.458-04:00",
      "updated_at": "2020-11-16T14:28:35.458-04:00",
      "required": false,
      "editable": false,
      "options": []
    }
  ],
  "count": 4,
  "current_page": 1,
  "pages": 1
}

Listado de tipos de campos personalizados.

GET https://tiendagoshop.com/api/v1/user_fields/types

Headers

Name	Type	Description
X-Spree-Token	string	Token generado desde el CMS de GS

200

[
  "text_field",
  "select_field",
  "check_box",
  "text_area"
]

Crear un nuevo campo personalizado.

POST https://tiendagoshop.com/api/v1/user_fields

Headers

Name	Type	Description
X-Spree-Token	string	Token generado desde el CMS de GS

Request Body

Name	Type	Description
name	string	Nombre del campo
field_type	string	Tipo de campo
visible_in_frontend	boolean	Visbilidad en el frontend
position	integer	Posición en el frontend
required	boolean	Opción de campo requerido
editable	boolean	Opción de campo editable
options_attributes	array	Opciones del campo, el campo es un array de con los siguientes datos: name:string y position:integer

200

{
  "id": 13,
  "name": "ID externo",
  "field_type": "text_field",
  "visible_in_frontend": false,
  "position": 1,
  "created_at": "2020-11-16T15:28:16.539-04:00",
  "updated_at": "2020-11-16T15:28:16.539-04:00",
  "required": false,
  "editable": false,
  "options": []
}

Eliminar un campo personalizado.

DELETE https://tiendagoshop.com/api/v1/user_fields/:id

Path Parameters

Name	Type	Description
id	integer	ID del campo personalizado.

Headers

Name	Type	Description
X-Spree-Token	string	Token generado desde el CMS de GS

204