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

200

{
  "users": [
    {
      "id": 1,
      "first_name": "Pedro",
      "last_name": "Guzman",
      "email": "[e-mail]",
      "shipping_addresses": [
        {
          "id": 2,
          "firstname": "Pedro",
          "lastname": "Guzman",
          "address1": "Ave. 27 de Febrero 294",
          "address2": null,
          "city": "Santo Domingo",
          "zipcode": "",
          "phone": "8091112222",
          "state_name": null,
          "alternative_phone": null,
          "company": null,
          "state_id": 1,
          "country_id": 1,
          "geo_address": null,
          "geo_lat": null,
          "geo_lng": null,
          "fiscal_type": null,
          "rnc": null,
          "user_id": 1,
          "address_type": "shipping",
          "deleted_at": null,
          "last_used": "2020-09-30T15:44:30.312Z",
          "created_at": "2020-09-30T13:14:16.530Z",
          "updated_at": "2020-09-30T15:44:30.312Z"
        }
      ],
      "billing_addresses": [
        {
          "id": 1,
          "firstname": "Pedro",
          "lastname": "Guzman",
          "address1": "Ave. 27 de Febrero 294",
          "address2": null,
          "city": "Santo Domingo",
          "zipcode": "",
          "phone": "8091112222",
          "state_name": null,
          "alternative_phone": null,
          "company": null,
          "state_id": 1,
          "country_id": 1,
          "geo_address": null,
          "geo_lat": null,
          "geo_lng": null,
          "fiscal_type": "consumidor",
          "rnc": "",
          "user_id": 1,
          "address_type": "billing",
          "deleted_at": null,
          "last_used": "2020-09-30T15:44:30.310Z",
          "created_at": "2020-09-30T13:14:14.574Z",
          "updated_at": "2020-09-30T15:44:30.310Z"
        }
      ],
      "created_at": "2020-09-25T10:55:51.466Z",
      "updated_at": "2020-09-25T10:56:15.921Z",
      "confirmed_at": null,
      "ext_id": null,
      "has_payment_credit": false,
      "referral_credits": null,
      "referrer_benefit_enabled": true,
      "spree_roles": [
        {
          "id": 3,
          "name": "user",
          "ext_id": null,
          "label": "Cliente",
          "editable": true,
          "is_default": true,
          "admin_accessible": false
        },
        {
          "id": 2,
          "name": "admin",
          "ext_id": null,
          "label": "Admin",
          "editable": true,
          "is_default": false,
          "admin_accessible": true
        }
      ]
    },
    {
      "id": 2,
      "first_name": "Pablo",
      "last_name": "Gimenez",
      "email": "[e-mail]",
      "shipping_addresses": [],
      "billing_addresses": [],
      "created_at": "2020-10-05T11:37:16.786Z",
      "updated_at": "2020-10-05T11:37:16.786Z",
      "confirmed_at": null,
      "ext_id": null,
      "has_payment_credit": false,
      "referral_credits": null,
      "referrer_benefit_enabled": true,
      "spree_roles": [
        {
          "id": 3,
          "name": "user",
          "ext_id": null,
          "label": "Cliente",
          "editable": true,
          "is_default": true,
          "admin_accessible": false
        }
      ]
    }
  ],
  "count": 2,
  "current_page": 1,
  "pages": 1
}

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.
email	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

200

{
  "id": 23,
  "first_name": "Pablo",
  "last_name": "Gimenez",
  "email": "[e-mail]",
  "shipping_addresses": [],
  "billing_addresses": [],
  "created_at": "2020-11-16T15:31:14.671-04:00",
  "updated_at": "2020-11-16T15:31:14.671-04:00",
  "confirmed_at": null,
  "ext_id": null,
  "has_payment_credit": false,
  "referral_credits": null,
  "referrer_benefit_enabled": true,
  "spree_roles": [
    {
      "id": 3,
      "name": "user",
      "ext_id": null,
      "label": "Cliente",
      "editable": true,
      "is_default": true,
      "admin_accessible": false
    },
    {
      "id": 4,
      "name": "affiliate",
      "ext_id": null,
      "label": "Afiliado",
      "editable": true,
      "is_default": false,
      "admin_accessible": false
    }
  ],
  "user_field_values": [
    {
      "id": 132,
      "user_field_id": 8,
      "value": "Valor personalizado"
    },
    {
      "id": 133,
      "user_field_id": 11,
      "value": "4"
    },
    {
      "id": 134,
      "user_field_id": 12,
      "value": "0"
    }
  ]
}

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.
email	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

200

{
  "id": 24,
  "first_name": "Pablo",
  "last_name": "Gimenez",
  "email": "[e-mail]",
  "shipping_addresses": [],
  "billing_addresses": [],
  "created_at": "2020-11-16T15:33:46.232-04:00",
  "updated_at": "2020-11-16T15:33:46.232-04:00",
  "confirmed_at": null,
  "ext_id": null,
  "has_payment_credit": false,
  "referral_credits": null,
  "referrer_benefit_enabled": true,
  "spree_roles": [
    {
      "id": 3,
      "name": "user",
      "ext_id": null,
      "label": "Cliente",
      "editable": true,
      "is_default": true,
      "admin_accessible": false
    },
    {
      "id": 4,
      "name": "affiliate",
      "ext_id": null,
      "label": "Afiliado",
      "editable": true,
      "is_default": false,
      "admin_accessible": false
    }
  ],
  "user_field_values": [
    {
      "id": 135,
      "user_field_id": 8,
      "value": "Valor personalizado mod"
    },
    {
      "id": 136,
      "user_field_id": 11,
      "value": "4"
    },
    {
      "id": 137,
      "user_field_id": 12,
      "value": "0"
    }
  ]
}

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

204