List Customers

GET 
/commerce/customers

List customers for a specified credential

Request

Query Parameters

credentialId stringrequired

The ID of the credential.

pageNumber int32

The page number of the results. Default is 1.

pageSize int32

The maximum number of results to show on a page. Default is 50. Maximum is 100.

firstName string

A string representing the first name of a customer.

firstNameContains string

A string that the first name of a customer should contain.

firstNameNotEquals string

A string that the first name of a customer should not match.

lastName string

A string representing the last name of a customer.

lastNameContains string

A string that the last name of a customer should contain.

lastNameNotEquals string

A string that the last name of a customer should not match.

remoteCreatedAtMin date

Filter objects created in the third-party application after a specified date.

remoteCreatedAtMax date

Filter objects created in the third-party application before a specified date.

remoteUpdatedAtMin date

Filter objects last updated in the third-party application after a specified date.

remoteUpdatedAtMax date

Filter objects last updated in the third-party application before a specified date.

createdAtMin date

Filter objects created after a specified date.

createdAtMax date

Filter objects created before a specified date.

updatedAtMin date

Filter objects last updated after a specified date.

updatedAtMax date

Filter objects last updated before a specified date.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

any

Result

{
  "customers": [
    {
      "remoteId": "1122334455667",
      "firstName": "Alex",
      "lastName": "Johnson",
      "email": "alex.johnson@example.com",
      "phone": null,
      "id": "00000000-0000-0000-0000-000000000000"
      "remoteCreatedAt": "2023-11-19T17:00:17.000Z",
      "remoteUpdatedAt": "2023-11-19T17:00:17.000Z",
      "remoteDeleted": false,
      "createdAt": "2024-02-22T11:17:53.264Z",
      "updatedAt": "2024-02-22T13:54:03.445Z"
    }
  ]
}

400

400

application/json

Schema

Schema

object

Example (from schema)

{}

Result

{}

Loading...