Usuarios
Es la entidad que almacena la información general de todos los usuarios de la tienda (sean clientes o staff) como: número de pedido, fecha y hora, importe total, cliente que lo ha realizado, productos comprados, estados, etc.
Listado de usuarios
GET
https://tiendagoshop.com/api/v1/users
Obtener listado de todos los usuarios del ecommerce. Filtros: Al igual que con la mayoría de entidades, es posible utilizar algunos parámetros en la URL para filtrar los resultados. Ver "Query Parameters" debajo para más información.
Query Parameters
Name | Type | Description |
---|---|---|
q[user_field_values_user_field_id_eq] | string | Especificar un Campo personalizado a utilizar (no todos). |
q[user_field_values_value_cont] | string | Filtrar por valor en Campos personalizados (todos). |
q[first_name_cont] | string | Filtrar por Nombre del usuario. |
q[last_name_cont] | string | Filtrar por Apellido del usuario. |
q[email_cont] | string | Filtrar por Correo electrónico del usuario. |
q[external_id_eq] | String | Id externo |
Headers
Name | Type | Description |
---|---|---|
X-Spree-Token | string | Token generado desde el CMS de GS |
Crear un usuario
POST
https://tiendagoshop.com/api/v1/users
Crear un nuevo usuario en el ecommerce.
Headers
Name | Type | Description |
---|---|---|
X-Spree-Token | string | Token generado desde el CMS de GS |
Request Body
Name | Type | Description |
---|---|---|
first_name | string | Nombre del usuario. |
last_name | string | Apellido del usuario. |
string | Dirección de correo del usuario. | |
password | string | Contraseña de acceso del usuario. |
spree_role_ids | array | Rol / roles asignados al usuario. Array de integers: [3, 4] |
user_field_values_attributes | array | Campos personalizados de información adicional del usuario. Tipos de valores aceptados (campo “value”) dependiendo del tipo de campo personalizado: text_field: string select_field: ID de la opción (integer) check_box: 0 / 1 (boolean) text_area: string Array de objetos JSON con la siguiente estructura: [ { "user_field_id": 8, "value": "Valor personalizado" }, { "user_field_id": 11, "value": 4 } ] |
external_id | String | Id externo |
Modificar un usuario
PUT
https://tiendagoshop.com/api/v1/users/:id
Modificar un usuario existente.
Path Parameters
Name | Type | Description |
---|---|---|
id | integer | ID del usuario. |
Headers
Name | Type | Description |
---|---|---|
X-Spree-Token | string | Token generado desde el CMS de GS |
Request Body
Name | Type | Description |
---|---|---|
first_name | string | Nombre del usuario. |
last_name | string | Apellido del usuario. |
string | Dirección de correo del usuario. | |
password | string | Contraseña de acceso del usuario. |
spree_role_ids | array | Rol / roles asignados al usuario. Array de integers: [3, 4] |
user_field_values_attributes | array | Campos personalizados de información adicional del usuario. Tipos de valores aceptados (campo “value”) dependiendo del tipo de campo personalizado: text_field: string select_field: ID de la opción (integer) check_box: 0 / 1 (boolean) text_area: string Array de objetos JSON con la siguiente estructura: [ { "user_field_id": 8, "value": "Valor personalizado" }, { "user_field_id": 11, "value": 4 } ] |
external_id | String | Id externo |
Eliminar un usuario
DELETE
https://tiendagoshop.com/api/v1/users/:id
Eliminar un usuario
Path Parameters
Name | Type | Description |
---|---|---|
id | integer | ID de usuario. |
Headers
Name | Type | Description |
---|---|---|
X-Spree-Token | string | Token generado desde el CMS de GS |
Última actualización