Sign in

v1

latestOpenAPI 3.0.12026-07-2412502.6 MB
Customers

Search customers

Return detailed information on specific customer criteria.

get/customers

Query parameters

customer_idstring

Search for specific Customer ID(s). Comma separate for multiple.

connection_idinteger

Search customers that belong to a specific connection.

first_namestring

Search for customers by first name.

last_namestring

Search for customers by last name.

emailstring

Search for customers by email.

phonestring

Search for customers by telephone number.

ip_addressstring

Search customers with orders using a specific IP Address.

date_created_fromstring date-time
Example:2023-04-01 00:00:00

Search customers that were created on or after this date. A date to and from field is required when not passing customer ID(s) or customer email.

date_created_tostring date-time
Example:2023-04-01 00:00:00

Search customers that were created on or before this date. Required when passing date_created_from. Maximum date range: 31 days.

date_modified_fromstring date-time
Example:2023-04-01 00:00:00

Search customers that were modified on or after this date. A date to and from field is required when not passing customer ID(s) or customer email.

date_modified_tostring date-time
Example:2023-04-01 00:00:00

Search customers that were modified on or before this date. Required when passing date_modified_from. Maximum date range: 31 days.

order_idinteger

Search for customers by a specific order ID.

campaign_idinteger

Search customers that have orders associated with a specific campaign ID.

transaction_idinteger

Search for customers using the transaction ID.

offer_idinteger

Search customers that have orders that contain specific offers.

order_offer_idinteger

Search for customers using the order offer ID.

status_type_idnull | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 nullable
  • 1 - Active
  • 2 - Cancelled
  • 3 - Complete
  • 4 - Partial
  • 5 - Declined
  • 6 - Archive
  • 7 - Rejected
  • 8 - Removed
  • 9 - Paused
  • 10 - Expired

Search customers that have offers in a specific status.

  • 1 - Active
  • 2 - Cancelled
  • 3 - Complete
  • 4 - Partial
  • 5 - Declined
  • 6 - Archive
  • 7 - Rejected
  • 8 - Removed
  • 9 - Paused
  • 10 - Expired
is_recurringboolean

Search customers that have recurring offers.

merchant_idinteger

Search customers that have transactions using a specific merchant ID.

card_bininteger

Search customers that have cards that have a specific BIN number.

card_last_4integer

Search customers that have cards that have specific last 4 digits.

is_blacklistboolean

Search for only blacklisted customers.

is_testboolean

Search customers that have test orders.

discount_codestring

Search customers that have used a specific discount code.

ship_addressstring

Search customers using the ship address.

ship_citystring

Search customers using the ship city.

ship_statestring

Search customers using the ship state.

ship_zipcodestring

Search customers using the ship zipcode.

ship_countrystring

Search customers using the ship country.

bill_addressstring

Search customers using the bill address.

bill_citystring

Search customers using the bill city.

bill_statestring

Search customers using the bill state.

bill_zipcodestring

Search customers using the bill zipcode.

bill_countrystring

Search customers using the bill country.

shipment_idinteger

Search for customers by a specific shipment ID.

shipment_tracking_idstring

Search for customers by using a tracking number from a shipment.

tracking1-20string

Custom Tracking Variable Options 1-20 that would be on a customer order.

with'customer_cards' | 'customer_addresses'

Expand on the information returned by including 'with' in the query parameters. For multiple attributes, separate with a comma (example : with=customer_cards,customer_addresses)

limitinteger

Limit the number of results. Default: 25, max: 200.

offsetinteger

Offset the results

sort_bystring

Field to sort result by

order'asc' | 'desc'

Order by asc or desc

Response

OK

totalinteger

Example response

{
  "customers": [
    {
      "date_created": "2023-04-01 00:00:00",
      "date_modified": "2023-04-01 00:00:00",
      "customer_cards": [
        {
          "date_created": "2023-04-01 00:00:00",
          "date_modified": "2023-04-01 00:00:00"
        }
      ],
      "customer_addresses": [
        {
          "date_created": "2023-04-01 00:00:00",
          "date_modified": "2023-04-01 00:00:00"
        }
      ]
    }
  ]
}