POST Customers/Customers

Retrieves all existing Customers.

Request Information

URI Parameters

None.

Body Parameters

GetCustomersRequest
NameDescriptionTypeAdditional information
Filter

CustomersFilter

None.

Range

AdminFilterRange

None.

Lang

string

None.

StoreID

integer

None.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CustomersView
NameDescriptionTypeAdditional information
TotalCount

integer

None.

Customers

Collection of CustomerTiny

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalCount": 1,
  "Customers": [
    {
      "ID": "sample string 1",
      "Email": "sample string 2",
      "Phone": "sample string 3",
      "Created": "2025-12-06T09:17:22.3862161+01:00",
      "Modified": "2025-12-06T09:17:22.3862161+01:00",
      "Disabled": "2025-12-06T09:17:22.3862161+01:00",
      "ShippingContactID": 1,
      "BillingContactID": 1,
      "TypeID": 6,
      "TariffID": 7,
      "Name": "sample string 8",
      "Surnames": "sample string 9",
      "FullName": "sample string 10"
    },
    {
      "ID": "sample string 1",
      "Email": "sample string 2",
      "Phone": "sample string 3",
      "Created": "2025-12-06T09:17:22.3862161+01:00",
      "Modified": "2025-12-06T09:17:22.3862161+01:00",
      "Disabled": "2025-12-06T09:17:22.3862161+01:00",
      "ShippingContactID": 1,
      "BillingContactID": 1,
      "TypeID": 6,
      "TariffID": 7,
      "Name": "sample string 8",
      "Surnames": "sample string 9",
      "FullName": "sample string 10"
    }
  ]
}

application/xml, text/xml

Sample:
<CustomersView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Customer">
  <Customers>
    <CustomerTiny>
      <BillingContactID>1</BillingContactID>
      <Created>2025-12-06T09:17:22.3862161+01:00</Created>
      <Disabled>2025-12-06T09:17:22.3862161+01:00</Disabled>
      <Email>sample string 2</Email>
      <FullName>sample string 10</FullName>
      <ID>sample string 1</ID>
      <Modified>2025-12-06T09:17:22.3862161+01:00</Modified>
      <Name>sample string 8</Name>
      <Phone>sample string 3</Phone>
      <ShippingContactID>1</ShippingContactID>
      <Surnames>sample string 9</Surnames>
      <TariffID>7</TariffID>
      <TypeID>6</TypeID>
    </CustomerTiny>
    <CustomerTiny>
      <BillingContactID>1</BillingContactID>
      <Created>2025-12-06T09:17:22.3862161+01:00</Created>
      <Disabled>2025-12-06T09:17:22.3862161+01:00</Disabled>
      <Email>sample string 2</Email>
      <FullName>sample string 10</FullName>
      <ID>sample string 1</ID>
      <Modified>2025-12-06T09:17:22.3862161+01:00</Modified>
      <Name>sample string 8</Name>
      <Phone>sample string 3</Phone>
      <ShippingContactID>1</ShippingContactID>
      <Surnames>sample string 9</Surnames>
      <TariffID>7</TariffID>
      <TypeID>6</TypeID>
    </CustomerTiny>
  </Customers>
  <TotalCount>1</TotalCount>
</CustomersView>