Get customers

GET

/merchants/{merchantCode}/customers

curl --request GET \
  --url 'https://customer.shopgate.io/v1/merchants/example/customers?limit=100&offset=0&sort=null'

Get customers

Parameters

Path Parameters

merchantCode

required

string

Query Parameters

fields

string

Add fields to response.
Available fields: contacts, settings, attributes.attributeName

filters

string

Filter for

• id
• name
• emailAddress
• status
• externalCustomerNumber
• internalCustomerNumber
• contactStatus
• isAnonymous
• contacts.postalCode
• contacts.region
• contacts.country
• contacts.isDefaultBilling
• contacts.isDefaultShipping
• metrics.lifetimeValue
• metrics.averageOrderValue
• metrics.averageItemsPerOrder
• metrics.averageOnlineOrderValue
• metrics.averagePickupInStoreOrderValue
• metrics.customerCreateAt
• metrics.lastOrderDate
• metrics.pushOpenRate
• metrics.pushConversionRate
• metrics.numberOfOrders
• metrics.numberOfBOPUISOrders
• metrics.numberOfROPUISOrders
• metrics.numberOfDirectShipOrders
• metrics.averageBOPUISItemsPerOrder
• metrics.averageROPUISItemsPerOrder
• metrics.averageDirectShipItemsPerOrder
• metrics.averageBOPUISOrderRevenue
• metrics.averageROPUISOrderRevenue
• metrics.averageDirectShipOrderRevenue
• attributes.<attributeCode>

translationPriority

string format: csv

Comma separated list of where to get the locale from that should be used for translation of multi-language fields. Valid values are query, customer and merchant. Type query means that the locale will be taken from parameter localeCode if set.

Default values:

• customer,merchant if no localeCode was passed
• query if localeCode was passed

localeCode

string

This will make translationPriority value query match if it is set.

limit

integer

default: 100 <= 1000

The limit of entries of one page

offset

integer

0

The offset where to start the page

sort

string

Comma-separated list of fields to sort by and sort directions, separated by a colon each (e.g. field1:asc,field2:desc).

Responses

200

Returns customers

Media typeapplication/json

object

meta

object

limit

number

offset

number

totalItemCount

number

customers

Array

object

id

string

internalCustomerNumber

Internal Customer number, set automatically upon creation

number

externalCustomerNumber

External Customer number

string

firstName

First name of the customer

string

middleName

Middle name of the customer

string | null

lastName

Last name of the customer

string

emailAddress

string format: email

status

string

default: active

Allowed values: active inactive deleted

isAnonymous

Indicates anonymous/guest customer.

boolean

externalUpdateDate

string format: date-time

taxExempt

boolean

taxClass

Tax class of the customer.

string

Example

{
  "meta": {
    "limit": 10,
    "offset": 0,
    "totalItemCount": 1
  },
  "customers": [
    {
      "id": "d162439c-e2f9-4050-8b94-6bff33e8163b",
      "internalCustomerNumber": 2,
      "externalCustomerNumber": "10001",
      "firstName": "Max",
      "middleName": "René",
      "lastName": "Muster",
      "emailAddress": "max.muster@shopgate.com",
      "status": "active",
      "isAnonymous": true,
      "externalUpdateDate": "2022-01-26T15:50:07.478Z",
      "taxExempt": false,
      "taxClass": "yourTaxCode"
    }
  ]
}

404

Merchant not found

Media typeapplication/json

default

Unexpected error

Media typeapplication/json

object

code

Machine readable error code

string

message

required

Human readable error code

string

Example^generated

{
  "code": "example",
  "message": "example"
}