GET customers

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of NopCustomerEx

Name	Type	Additional information
customer_guid	string	None.
username	string	None.
email	string	None.
first_name	string	None.
last_name	string	None.
language_id	string	None.
date_of_birth	string	None.
gender	string	None.
admin_comment	string	None.
is_tax_exempt	boolean	None.
has_shopping_cart_items	boolean	None.
active	boolean	None.
deleted	boolean	None.
is_system_account	boolean	None.
system_name	string	None.
last_ip_address	string	None.
created_on_utc	string	None.
last_login_date_utc	string	None.
last_activity_date_utc	string	None.
registered_in_store_id	integer	None.
subscribed_to_newsletter	boolean	None.
id	integer	None.
role_ids	Collection of integer	None.
addresses	Collection of NopAddressDto	None.
shipping_address	NopCustomerShippingAddressEx	None.
billing_address	NopCustomerBillingAddressEx	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "customer_guid": "sample string 1",
    "username": "sample string 2",
    "email": "sample string 3",
    "first_name": "sample string 4",
    "last_name": "sample string 5",
    "language_id": "sample string 6",
    "date_of_birth": "sample string 7",
    "gender": "sample string 8",
    "admin_comment": "sample string 9",
    "is_tax_exempt": true,
    "has_shopping_cart_items": true,
    "active": true,
    "deleted": true,
    "is_system_account": true,
    "system_name": "sample string 10",
    "last_ip_address": "sample string 11",
    "created_on_utc": "sample string 12",
    "last_login_date_utc": "sample string 13",
    "last_activity_date_utc": "sample string 14",
    "registered_in_store_id": 1,
    "subscribed_to_newsletter": true,
    "id": 16,
    "role_ids": [
      1,
      2
    ],
    "addresses": [
      {
        "id": 1,
        "first_name": "sample string 2",
        "last_name": "sample string 3"
      },
      {
        "id": 1,
        "first_name": "sample string 2",
        "last_name": "sample string 3"
      }
    ],
    "shipping_address": {
      "id": 1,
      "first_name": "sample string 2",
      "last_name": "sample string 3",
      "email": "sample string 4",
      "company": "sample string 5",
      "country_id": 1,
      "country": "sample string 6",
      "city": "sample string 7",
      "address1": "sample string 8",
      "address2": "sample string 9",
      "zip_postal_code": "sample string 10",
      "phone_number": "sample string 11",
      "fax_number": "sample string 12",
      "customer_attributes": "sample string 13",
      "created_on_utc": "2025-12-11T01:35:26.9649303+01:00",
      "province": "sample string 14"
    },
    "billing_address": {
      "id": 1,
      "first_name": "sample string 2",
      "last_name": "sample string 3",
      "email": "sample string 4",
      "company": "sample string 5",
      "country_id": 1,
      "country": "sample string 6",
      "city": "sample string 7",
      "address1": "sample string 8",
      "address2": "sample string 9",
      "zip_postal_code": "sample string 10",
      "phone_number": "sample string 11",
      "fax_number": "sample string 12",
      "customer_attributes": "sample string 13",
      "created_on_utc": "2025-12-11T01:35:26.9649303+01:00",
      "province": "sample string 14"
    }
  },
  {
    "customer_guid": "sample string 1",
    "username": "sample string 2",
    "email": "sample string 3",
    "first_name": "sample string 4",
    "last_name": "sample string 5",
    "language_id": "sample string 6",
    "date_of_birth": "sample string 7",
    "gender": "sample string 8",
    "admin_comment": "sample string 9",
    "is_tax_exempt": true,
    "has_shopping_cart_items": true,
    "active": true,
    "deleted": true,
    "is_system_account": true,
    "system_name": "sample string 10",
    "last_ip_address": "sample string 11",
    "created_on_utc": "sample string 12",
    "last_login_date_utc": "sample string 13",
    "last_activity_date_utc": "sample string 14",
    "registered_in_store_id": 1,
    "subscribed_to_newsletter": true,
    "id": 16,
    "role_ids": [
      1,
      2
    ],
    "addresses": [
      {
        "id": 1,
        "first_name": "sample string 2",
        "last_name": "sample string 3"
      },
      {
        "id": 1,
        "first_name": "sample string 2",
        "last_name": "sample string 3"
      }
    ],
    "shipping_address": {
      "id": 1,
      "first_name": "sample string 2",
      "last_name": "sample string 3",
      "email": "sample string 4",
      "company": "sample string 5",
      "country_id": 1,
      "country": "sample string 6",
      "city": "sample string 7",
      "address1": "sample string 8",
      "address2": "sample string 9",
      "zip_postal_code": "sample string 10",
      "phone_number": "sample string 11",
      "fax_number": "sample string 12",
      "customer_attributes": "sample string 13",
      "created_on_utc": "2025-12-11T01:35:26.9649303+01:00",
      "province": "sample string 14"
    },
    "billing_address": {
      "id": 1,
      "first_name": "sample string 2",
      "last_name": "sample string 3",
      "email": "sample string 4",
      "company": "sample string 5",
      "country_id": 1,
      "country": "sample string 6",
      "city": "sample string 7",
      "address1": "sample string 8",
      "address2": "sample string 9",
      "zip_postal_code": "sample string 10",
      "phone_number": "sample string 11",
      "fax_number": "sample string 12",
      "customer_attributes": "sample string 13",
      "created_on_utc": "2025-12-11T01:35:26.9649303+01:00",
      "province": "sample string 14"
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfNopCustomerEx xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EliteWeb.NopCommerce.Common">
  <NopCustomerEx>
    <active>true</active>
    <addresses>
      <NopAddressDto>
        <first_name>sample string 2</first_name>
        <id>1</id>
        <last_name>sample string 3</last_name>
      </NopAddressDto>
      <NopAddressDto>
        <first_name>sample string 2</first_name>
        <id>1</id>
        <last_name>sample string 3</last_name>
      </NopAddressDto>
    </addresses>
    <admin_comment>sample string 9</admin_comment>
    <billing_address>
      <address1>sample string 8</address1>
      <address2>sample string 9</address2>
      <city>sample string 7</city>
      <company>sample string 5</company>
      <country>sample string 6</country>
      <country_id>1</country_id>
      <created_on_utc>2025-12-11T01:35:26.9649303+01:00</created_on_utc>
      <customer_attributes>sample string 13</customer_attributes>
      <email>sample string 4</email>
      <fax_number>sample string 12</fax_number>
      <first_name>sample string 2</first_name>
      <id>1</id>
      <last_name>sample string 3</last_name>
      <phone_number>sample string 11</phone_number>
      <province>sample string 14</province>
      <zip_postal_code>sample string 10</zip_postal_code>
    </billing_address>
    <created_on_utc>sample string 12</created_on_utc>
    <customer_guid>sample string 1</customer_guid>
    <date_of_birth>sample string 7</date_of_birth>
    <deleted>true</deleted>
    <email>sample string 3</email>
    <first_name>sample string 4</first_name>
    <gender>sample string 8</gender>
    <has_shopping_cart_items>true</has_shopping_cart_items>
    <id>16</id>
    <is_system_account>true</is_system_account>
    <is_tax_exempt>true</is_tax_exempt>
    <language_id>sample string 6</language_id>
    <last_activity_date_utc>sample string 14</last_activity_date_utc>
    <last_ip_address>sample string 11</last_ip_address>
    <last_login_date_utc>sample string 13</last_login_date_utc>
    <last_name>sample string 5</last_name>
    <registered_in_store_id>1</registered_in_store_id>
    <role_ids xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </role_ids>
    <shipping_address>
      <address1>sample string 8</address1>
      <address2>sample string 9</address2>
      <city>sample string 7</city>
      <company>sample string 5</company>
      <country>sample string 6</country>
      <country_id>1</country_id>
      <created_on_utc>2025-12-11T01:35:26.9649303+01:00</created_on_utc>
      <customer_attributes>sample string 13</customer_attributes>
      <email>sample string 4</email>
      <fax_number>sample string 12</fax_number>
      <first_name>sample string 2</first_name>
      <id>1</id>
      <last_name>sample string 3</last_name>
      <phone_number>sample string 11</phone_number>
      <province>sample string 14</province>
      <zip_postal_code>sample string 10</zip_postal_code>
    </shipping_address>
    <subscribed_to_newsletter>true</subscribed_to_newsletter>
    <system_name>sample string 10</system_name>
    <username>sample string 2</username>
  </NopCustomerEx>
  <NopCustomerEx>
    <active>true</active>
    <addresses>
      <NopAddressDto>
        <first_name>sample string 2</first_name>
        <id>1</id>
        <last_name>sample string 3</last_name>
      </NopAddressDto>
      <NopAddressDto>
        <first_name>sample string 2</first_name>
        <id>1</id>
        <last_name>sample string 3</last_name>
      </NopAddressDto>
    </addresses>
    <admin_comment>sample string 9</admin_comment>
    <billing_address>
      <address1>sample string 8</address1>
      <address2>sample string 9</address2>
      <city>sample string 7</city>
      <company>sample string 5</company>
      <country>sample string 6</country>
      <country_id>1</country_id>
      <created_on_utc>2025-12-11T01:35:26.9649303+01:00</created_on_utc>
      <customer_attributes>sample string 13</customer_attributes>
      <email>sample string 4</email>
      <fax_number>sample string 12</fax_number>
      <first_name>sample string 2</first_name>
      <id>1</id>
      <last_name>sample string 3</last_name>
      <phone_number>sample string 11</phone_number>
      <province>sample string 14</province>
      <zip_postal_code>sample string 10</zip_postal_code>
    </billing_address>
    <created_on_utc>sample string 12</created_on_utc>
    <customer_guid>sample string 1</customer_guid>
    <date_of_birth>sample string 7</date_of_birth>
    <deleted>true</deleted>
    <email>sample string 3</email>
    <first_name>sample string 4</first_name>
    <gender>sample string 8</gender>
    <has_shopping_cart_items>true</has_shopping_cart_items>
    <id>16</id>
    <is_system_account>true</is_system_account>
    <is_tax_exempt>true</is_tax_exempt>
    <language_id>sample string 6</language_id>
    <last_activity_date_utc>sample string 14</last_activity_date_utc>
    <last_ip_address>sample string 11</last_ip_address>
    <last_login_date_utc>sample string 13</last_login_date_utc>
    <last_name>sample string 5</last_name>
    <registered_in_store_id>1</registered_in_store_id>
    <role_ids xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </role_ids>
    <shipping_address>
      <address1>sample string 8</address1>
      <address2>sample string 9</address2>
      <city>sample string 7</city>
      <company>sample string 5</company>
      <country>sample string 6</country>
      <country_id>1</country_id>
      <created_on_utc>2025-12-11T01:35:26.9649303+01:00</created_on_utc>
      <customer_attributes>sample string 13</customer_attributes>
      <email>sample string 4</email>
      <fax_number>sample string 12</fax_number>
      <first_name>sample string 2</first_name>
      <id>1</id>
      <last_name>sample string 3</last_name>
      <phone_number>sample string 11</phone_number>
      <province>sample string 14</province>
      <zip_postal_code>sample string 10</zip_postal_code>
    </shipping_address>
    <subscribed_to_newsletter>true</subscribed_to_newsletter>
    <system_name>sample string 10</system_name>
    <username>sample string 2</username>
  </NopCustomerEx>
</ArrayOfNopCustomerEx>