POST
/
api
/
KarizClientApp
/
Unified
/
Customers
curl --request POST \
  --url https://api.trykariz.com/api/KarizClientApp/Unified/Customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "params": {
    "shopify": [
      {
        "key": "baseUrl",
        "value": "your-shop.myshopify.com"
      },
      {
        "key": "token",
        "value": "your-shopify-oauth-token"
      }
    ]
  },
  "created_at_max": "2024-01-31T23:59:59-05:00",
  "created_at_min": "2024-01-01T00:00:00-05:00",
  "fields": "id,email,first_name,last_name,phone",
  "ids": "1234567890,9876543210,5555555555",
  "limit": 100,
  "since_id": 1234567889,
  "updated_at_max": "2024-03-20T10:30:00Z",
  "updated_at_min": "2024-03-01T00:00:00Z"
}'
{
  "Errors": {},
  "Output": {
    "step": "transform",
    "isSuccess": true,
    "schemaValidationErrors": null,
    "restErrors": null,
    "operationErrors": null,
    "unexpectedErrors": null,
    "execution_id": "ed7ad663-4757-447c-b5cd-1e83c2380afc",
    "override_count": 1,
    "next_page_token_url": "https://api.trykariz.com/api/KarizClientApp/RunSync?configName=shopify_get_orders&tpUserId=1&data=%7B%22limit%22%3A1%2C%22next_page_token%22%3A%22eyJsYXN0X2lkIjo1OTU0NDYxMzM1ODI3LCJsYXN0X3ZhbHVlIjoiMjAyNC0wOS0xMyAxNDo0NzoxMy4xNDAwNTEiLCJkaXJlY3Rpb24iOiJuZXh0In0%22%7D",
    "next_page_token": "eyJsYXN0X2lkIjo1OTU0NDYxMzM1ODI3LCJsYXN0X3ZhbHVlIjoiMjAyNC0wOS0xMyAxNDo0NzoxMy4xNDAwNTEiLCJkaXJlY3Rpb24iOiJuZXh0In0",
    "result": {
      "customers": [
        {
          "id": 1073339462,
          "email": "steve.lastnameson@example.com",
          "created_at": "2025-01-02T11:27:00-05:00",
          "updated_at": "2025-01-02T11:27:00-05:00",
          "first_name": "Steve",
          "last_name": "Lastnameson",
          "orders_count": 0,
          "state": "disabled",
          "total_spent": "0.00",
          "last_order_id": null,
          "note": null,
          "verified_email": true,
          "multipass_identifier": null,
          "tax_exempt": false,
          "tags": "",
          "last_order_name": null,
          "currency": "USD",
          "phone": "+15142546011",
          "addresses": [
            {
              "id": 1053317292,
              "customer_id": 1073339462,
              "first_name": "Mother",
              "last_name": "Lastnameson",
              "company": null,
              "address1": "123 Oak St",
              "address2": null,
              "city": "Ottawa",
              "province": "Ontario",
              "country": "Canada",
              "zip": "123 ABC",
              "phone": "555-1212",
              "name": "Mother Lastnameson",
              "province_code": "ON",
              "country_code": "CA",
              "country_name": "Canada",
              "default": true
            }
          ],
          "tax_exemptions": [],
          "email_marketing_consent": {
            "state": "not_subscribed",
            "opt_in_level": "single_opt_in",
            "consent_updated_at": null
          },
          "sms_marketing_consent": {
            "state": "not_subscribed",
            "opt_in_level": "single_opt_in",
            "consent_updated_at": null,
            "consent_collected_from": "OTHER"
          },
          "admin_graphql_api_id": "gid://shopify/Customer/1073339462",
          "default_address": {
            "id": 1053317292,
            "customer_id": 1073339462,
            "first_name": "Mother",
            "last_name": "Lastnameson",
            "company": null,
            "address1": "123 Oak St",
            "address2": null,
            "city": "Ottawa",
            "province": "Ontario",
            "country": "Canada",
            "zip": "123 ABC",
            "phone": "555-1212",
            "name": "Mother Lastnameson",
            "province_code": "ON",
            "country_code": "CA",
            "country_name": "Canada",
            "default": true
          }
        },
        {
          "id": 207119551,
          "email": "bob.norman@mail.example.com",
          "created_at": "2025-01-02T11:26:48-05:00",
          "updated_at": "2025-01-02T11:26:48-05:00",
          "first_name": "Bob",
          "last_name": "Norman",
          "orders_count": 1,
          "state": "disabled",
          "total_spent": "199.65",
          "last_order_id": 450789469,
          "note": null,
          "verified_email": true,
          "multipass_identifier": null,
          "tax_exempt": false,
          "tags": "Léon, Noël",
          "last_order_name": "#1001",
          "currency": "USD",
          "phone": "+16136120707",
          "addresses": [
            {
              "id": 207119551,
              "customer_id": 207119551,
              "first_name": null,
              "last_name": null,
              "company": null,
              "address1": "Chestnut Street 92",
              "address2": "",
              "city": "Louisville",
              "province": "Kentucky",
              "country": "United States",
              "zip": "40202",
              "phone": "555-625-1199",
              "name": "",
              "province_code": "KY",
              "country_code": "US",
              "country_name": "United States",
              "default": true
            }
          ],
          "tax_exemptions": [],
          "email_marketing_consent": {
            "state": "not_subscribed",
            "opt_in_level": null,
            "consent_updated_at": "2004-06-13T11:57:11-04:00"
          },
          "sms_marketing_consent": {
            "state": "not_subscribed",
            "opt_in_level": "single_opt_in",
            "consent_updated_at": "2024-01-01T07:00:00-05:00",
            "consent_collected_from": "OTHER"
          },
          "admin_graphql_api_id": "gid://shopify/Customer/207119551",
          "default_address": {
            "id": 207119551,
            "customer_id": 207119551,
            "first_name": null,
            "last_name": null,
            "company": null,
            "address1": "Chestnut Street 92",
            "address2": "",
            "city": "Louisville",
            "province": "Kentucky",
            "country": "United States",
            "zip": "40202",
            "phone": "555-625-1199",
            "name": "",
            "province_code": "KY",
            "country_code": "US",
            "country_name": "United States",
            "default": true
          }
        }
      ]
    }
  },
  "Report": {
    "TraceId": "00-3c6a96b919427b0952ba274800a4b04f-7efc4603f4ee42e7-00",
    "TotalExtResourcesDuration": 356.8311,
    "TotalEventsTransitDuration": 554.5615,
    "TotalTransformationsDuration": 690.4757,
    "TotalRequestsDuration": 4296.1973,
    "ExtResources": [
      {
        "Uri": "https://quickstart.myshopify.com/admin/api/2025-01/customers.json",
        "Duration": 356.8311
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
channel
enum<string>
required

Specify the sales channel from which to fetch user data. Each request can only retrieve data from a single channel at a time. Since requests are processed in real-time, response times vary depending on the sales channel’s speed

Available options:
amazon,
bigcommerce,
bol,
lightspeed_c,
magento,
mirakl,
shopify,
woocommerce
​
tpUserId
string
required

The ID of your user(must be authenticated with target channels).

​
completionCallbackUrl
string

To receive the completion event. You can use a webhook to find out whether the task is finished.

Body

application/json

The supported parameters to query the data depend on the channels API. Supported channels shows which parameters can be used for which channels.

​
created_at_max
string | null

Show resources created before or on this specified date and time (ISO 8601 format). Example: 2014-04-25T16:15:47-04:00

​
created_at_min
string | null

Show resources created after or on this specified date and time (ISO 8601 format). Example: 2014-04-25T16:15:47-04:00

​
fields
string | null

Show only certain fields, specified by a comma-separated list of field names (e.g., 'id,email,first_name').

​
ids
string | null

Restrict results to resources specified by a comma-separated list of numeric IDs (e.g., '12345,67890').

​
limit
number | null
default:10

The maximum number of results to retrieve.

Required range: 1 <= x <= 250
​
since_id
string | null

Restrict results to those with an ID greater than the specified ID. Used for cursor-based pagination.

​
updated_at_max
string | null

Show resources last updated before or on this specified date and time (ISO 8601 format). Example: 2014-04-25T16:15:47-04:00

​
updated_at_min
string | null

Show resources last updated after or on this specified date and time (ISO 8601 format). Example: 2014-04-25T16:15:47-04:00

​
next_page_token
string | null

Used to paginate to the next batch of objects. Should be a copy of the next_page_token value from the previous response.

Supported channels: shopify, woocommerce, bigcommerce, lightspeed_c, bol, amazon, magento

​
params
object

Response

200 - application/json

POST /Unified/Customers Successful response

​
Errors
object
required
​
Output
object
required
​
Report
object
required