shopify: appmixer.shopify.customers.GetCustomer

Basic Information

Name

appmixer.shopify.customers.GetCustomer

Version

1.0.0

Visibility

Public

Description

Get a customer by ID, with contact details, marketing consent, addresses and order totals.

Input Ports

in

Field	Type	Description
Customer	text	Pick a customer, or enter its ID — the global ID (gid://shopify/Customer/…) or the numeric ID.

Output Ports

out

Field	Type	Description
Customer ID	string	-
Legacy Resource ID	string	-
Display Name	string	-
First Name	string	-
Last Name	string	-
Note	string	-
Tags	array	-
State	string	-
Locale	string	-
Verified Email	boolean	-
Tax Exempt	boolean	-
Tax Exemptions	array	-
Number of Orders	string	-
Created At	string	-
Updated At	string	-
Amount Spent	object	-
Default Email Address	object	-
Default Phone Number	object	-
Default Address	object	-
Addresses	array	-
Metafields	array	-
Last Order	object	-

Full Metadata

#metadata-viewer { display: none; }{ "name": "appmixer.shopify.customers.GetCustomer", "description": "Get a customer by ID, with contact details, marketing consent, addresses and order totals.", "author": "Jimoh Damilola <jimoh@client.io>", "private": false, "auth": { "service": "appmixer:shopify", "scope": [ "read_customers", "read_orders" ] }, "quota": { "manager": "appmixer:shopify", "resources": "requests", "scope": { "userId": "{{userId}}" } }, "inPorts": [ { "name": "in", "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] }, "inspector": { "inputs": { "id": { "type": "text", "label": "Customer", "index": 0, "tooltip": "Pick a customer, or enter its ID — the global ID (gid://shopify/Customer/…) or the numeric ID.", "source": { "url": "/component/appmixer/shopify/customers/FindCustomers?outPort=out", "data": { "properties": { "isSource": true }, "messages": { "in/outputType": "array" }, "transform": "./FindCustomers#customersToSelectArray" } } } } } } ], "outPorts": [ { "name": "out", "schema": { "type": "object", "required": [ "id", "legacyResourceId", "displayName", "tags", "state", "locale", "verifiedEmail", "taxExempt", "taxExemptions", "numberOfOrders", "createdAt", "updatedAt", "amountSpent", "addresses", "metafields" ], "properties": { "id": { "type": "string", "title": "Customer ID", "example": "gid://shopify/Customer/27606879338577" }, "legacyResourceId": { "type": "string", "title": "Legacy Resource ID", "example": "27606879338577" }, "displayName": { "type": "string", "title": "Display Name", "example": "Jane Doe" }, "firstName": { "type": "string", "title": "First Name", "example": "Jane" }, "lastName": { "type": "string", "title": "Last Name", "example": "Doe" }, "note": { "type": "string", "title": "Note", "example": "Prefers delivery after 5 pm" }, "tags": { "type": "array", "title": "Tags", "items": { "type": "string" }, "example": [ "VIP", "wholesale" ] }, "state": { "type": "string", "title": "State", "example": "DISABLED" }, "locale": { "type": "string", "title": "Locale", "example": "en" }, "verifiedEmail": { "type": "boolean", "title": "Verified Email", "example": true }, "taxExempt": { "type": "boolean", "title": "Tax Exempt", "example": false }, "taxExemptions": { "type": "array", "title": "Tax Exemptions", "items": { "type": "string" }, "example": [ "CA_STATUS_CARD_EXEMPTION" ] }, "numberOfOrders": { "type": "string", "title": "Number of Orders", "example": "3" }, "createdAt": { "type": "string", "title": "Created At", "example": "2026-10-05T08:22:51Z", "format": "date-time" }, "updatedAt": { "type": "string", "title": "Updated At", "example": "2026-10-05T08:22:52Z", "format": "date-time" }, "amountSpent": { "type": "object", "title": "Amount Spent", "required": [ "amount", "currencyCode" ], "properties": { "amount": { "type": "string", "title": "Amount Spent.Amount", "example": "199.9" }, "currencyCode": { "type": "string", "title": "Amount Spent.Currency Code", "example": "USD" } } }, "defaultEmailAddress": { "type": "object", "title": "Default Email Address", "required": [ "emailAddress", "marketingState" ], "properties": { "emailAddress": { "type": "string", "title": "Default Email Address.Email Address", "example": "jane.doe@example.com" }, "marketingState": { "type": "string", "title": "Default Email Address.Marketing State", "example": "SUBSCRIBED" }, "marketingOptInLevel": { "type": "string", "title": "Default Email Address.Marketing Opt-in Level", "example": "SINGLE_OPT_IN" }, "marketingUpdatedAt": { "type": "string", "title": "Default Email Address.Marketing Updated At", "example": "2026-10-05T08:22:50Z", "format": "date-time" } } }, "defaultPhoneNumber": { "type": "object", "title": "Default Phone Number", "required": [ "phoneNumber", "smsMarketingConsent" ], "properties": { "phoneNumber": { "type": "string", "title": "Default Phone Number.Phone Number", "example": "+420777123456" }, "smsMarketingConsent": { "type": "object", "title": "Default Phone Number.SMS Marketing Consent", "required": [ "state" ], "properties": { "state": { "type": "string", "title": "Default Phone Number.SMS Marketing Consent.State", "example": "NOT_SUBSCRIBED" }, "optInLevel": { "type": "string", "title": "Default Phone Number.SMS Marketing Consent.Opt-in Level", "example": "SINGLE_OPT_IN" }, "updatedAt": { "type": "string", "title": "Default Phone Number.SMS Marketing Consent.Updated At", "example": "2026-10-05T08:22:50Z", "format": "date-time" } } } } }, "defaultAddress": { "type": "object", "title": "Default Address", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "Default Address.ID", "example": "gid://shopify/MailingAddress/38344136425553?model_name=CustomerAddress" }, "firstName": { "type": "string", "title": "Default Address.First Name", "example": "Jane" }, "lastName": { "type": "string", "title": "Default Address.Last Name", "example": "Doe" }, "company": { "type": "string", "title": "Default Address.Company", "example": "Acme Inc." }, "address1": { "type": "string", "title": "Default Address.Address Line 1", "example": "Havanska 155" }, "address2": { "type": "string", "title": "Default Address.Address Line 2", "example": "Floor 2" }, "city": { "type": "string", "title": "Default Address.City", "example": "Prague" }, "province": { "type": "string", "title": "Default Address.Province", "example": "Ontario" }, "provinceCode": { "type": "string", "title": "Default Address.Province Code", "example": "ON" }, "country": { "type": "string", "title": "Default Address.Country", "example": "Czech Republic" }, "countryCodeV2": { "type": "string", "title": "Default Address.Country Code", "example": "CZ" }, "zip": { "type": "string", "title": "Default Address.ZIP", "example": "170 00" }, "phone": { "type": "string", "title": "Default Address.Phone", "example": "+420777123456" } } }, "addresses": { "type": "array", "title": "Addresses", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "ID", "example": "gid://shopify/MailingAddress/38344136425553?model_name=CustomerAddress" }, "firstName": { "type": "string", "title": "First Name", "example": "Jane" }, "lastName": { "type": "string", "title": "Last Name", "example": "Doe" }, "company": { "type": "string", "title": "Company", "example": "Acme Inc." }, "address1": { "type": "string", "title": "Address Line 1", "example": "Havanska 155" }, "address2": { "type": "string", "title": "Address Line 2", "example": "Floor 2" }, "city": { "type": "string", "title": "City", "example": "Prague" }, "province": { "type": "string", "title": "Province", "example": "Ontario" }, "provinceCode": { "type": "string", "title": "Province Code", "example": "ON" }, "country": { "type": "string", "title": "Country", "example": "Czech Republic" }, "countryCodeV2": { "type": "string", "title": "Country Code", "example": "CZ" }, "zip": { "type": "string", "title": "ZIP", "example": "170 00" }, "phone": { "type": "string", "title": "Phone", "example": "+420777123456" } } }, "example": [ { "id": "gid://shopify/MailingAddress/38344136425553?model_name=CustomerAddress", "firstName": "Jane", "lastName": "Doe", "company": "Acme Inc.", "address1": "Havanska 155", "address2": null, "city": "Prague", "province": null, "provinceCode": null, "country": "Czech Republic", "countryCodeV2": "CZ", "zip": "170 00", "phone": "+420777123456" } ] }, "metafields": { "type": "array", "title": "Metafields", "items": { "type": "object", "required": [ "namespace", "key", "type", "value" ], "properties": { "namespace": { "type": "string", "title": "Namespace", "example": "custom" }, "key": { "type": "string", "title": "Key", "example": "loyalty_level" }, "type": { "type": "string", "title": "Type", "example": "single_line_text_field" }, "value": { "type": "string", "title": "Value", "example": "gold" } } }, "example": [ { "namespace": "custom", "key": "loyalty_level", "type": "single_line_text_field", "value": "gold" } ] }, "lastOrder": { "type": "object", "title": "Last Order", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "title": "Last Order.ID", "example": "gid://shopify/Order/6012345678901" }, "name": { "type": "string", "title": "Last Order.Name", "example": "#1001" } } } } } } ], "icon": "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiA/PjwhRE9DVFlQRSBzdmcgIFBVQkxJQyAnLS8vVzNDLy9EVEQgU1ZHIDEuMS8vRU4nICAnaHR0cDovL3d3dy53My5vcmcvR3JhcGhpY3MvU1ZHLzEuMS9EVEQvc3ZnMTEuZHRkJz48c3ZnIGVuYWJsZS1iYWNrZ3JvdW5kPSJuZXcgMCAwIDEyOCAxMjgiIGlkPSJTb2NpYWxfSWNvbnMiIHZlcnNpb249IjEuMSIgdmlld0JveD0iMCAwIDEyOCAxMjgiIHhtbDpzcGFjZT0icHJlc2VydmUiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiPjxnIGlkPSJfeDM3X19zdHJva2UiPjxnIGlkPSJTaG9waWZ5Ij48cmVjdCBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGZpbGw9Im5vbmUiIGZpbGwtcnVsZT0iZXZlbm9kZCIgaGVpZ2h0PSIxMjgiIHdpZHRoPSIxMjgiLz48cGF0aCBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik03MC40NSwxOS41NjhjMC0wLjQzNiwwLjAwNC0wLjg2NCwwLjAwNC0xLjMzMiAgICBjMC00LjA4LTAuNTY1LTcuMzY4LTEuNDY5LTkuOTcyYzMuNjM0LDAuNDU2LDYuMDU0LDQuNjEyLDcuNjEsOS4zOTJDNzQuNzczLDE4LjIyNCw3Mi42OTksMTguODY4LDcwLjQ1LDE5LjU2OHogTTYyLjQyNiw2MC4yNDggICAgYzAsMC00LjI1MS0yLjI4LTkuNDYxLTIuMjhjLTcuNjQyLDAtOC4wMjgsNC44Mi04LjAyOCw2LjAzMmMwLDYuNjI4LDE3LjE4Nyw5LjE2OCwxNy4xODcsMjQuNjg4ICAgIGMwLDEyLjIwOC03LjcwNiwyMC4wNzItMTguMDk4LDIwLjA3MmMtMTIuNDcsMC0xOC44NDYtNy44LTE4Ljg0Ni03LjhsMy4zMzktMTEuMDg0YzAsMCw2LjU1NSw1LjY1NiwxMi4wODgsNS42NTYgICAgYzMuNjEsMCw1LjA4My0yLjg2LDUuMDgzLTQuOTQ4YzAtOC42NDQtMTQuMTAyLTkuMDMyLTE0LjEwMi0yMy4yMzZjMC0xMS45NTIsOC41MzgtMjMuNTIsMjUuNzcyLTIzLjUyICAgIGM2LjYzOSwwLDkuOTIzLDEuOTEyLDkuOTIzLDEuOTEyTDYyLjQyNiw2MC4yNDh6IE01OS41OTYsNC40MjhjMC43MTIsMCwxLjQyNSwwLjI0NCwyLjExLDAuNzE2ICAgIGMtNS4yNjYsMi40ODgtMTAuOTA2LDguNzYtMTMuMjksMjEuMjhjLTMuNDgzLDEuMDg0LTYuODg2LDIuMTQ0LTEwLjAzNCwzLjEyNEM0MS4xNzEsMTkuOTk2LDQ3Ljc5OCw0LjQyOCw1OS41OTYsNC40Mjh6ICAgICBNNjYuMTQ3LDIwLjE5MmMwLDAuMjUyLTAuMDA0LDAuNDg0LTAuMDA0LDAuNzE2Yy00LDEuMjQ0LTguMzQzLDIuNTk2LTEyLjY5NywzLjk1MkM1NS44OSwxNS4zOCw2MC40NzIsMTAuOCw2NC40OCw5LjA3MiAgICBDNjUuNDg3LDExLjYxNiw2Ni4xNDcsMTUuMjY4LDY2LjE0NywyMC4xOTJ6IE04NS4wNTgsMTUuMDk3Yy0wLjI2LDAuMDM0LTAuNDg1LDAuMDg1LTAuNjQyLDAuMTMxICAgIGMtMC4wODQsMC4wMjQtMS40ODUsMC40Ni0zLjgwNSwxLjE4Qzc4LjMzOSw5Ljg0LDc0LjMzMSwzLjgwNCw2Ny4yODIsMy44MDRjLTAuMTk1LDAtMC4zOTgsMC4wMDgtMC41OTcsMC4wMiAgICBDNjQuNjc5LDEuMTYsNjIuMTk1LDAsNjAuMDUsMEM0My42MjMsMCwzNS43NzQsMjAuNjQsMzMuMzE0LDMxLjEyNGMtNi4zODQsMS45ODgtMTAuOTE4LDMuNC0xMS40OTUsMy41ODQgICAgYy0zLjU2NiwxLjEyNC0zLjY3OCwxLjIzNi00LjE0Myw0LjYwOEMxNy4zMjIsNDEuODcyLDgsMTE0LjMyNCw4LDExNC4zMjRMODAuNjM5LDEyOGwwLjA3Ny0wLjAxN0w4NS4wNTgsMTUuMDk3eiBNOTAuMjU5LDE4LjY1MiAgICBjMi4wOTcsMi4wOTMsNC40NzUsNC40NjQsNC40NzUsNC40NjRzOS43ODcsMC43MjgsMTAuMjQ5LDAuNzY4YzAuNDY2LDAuMDQsMS4wMjcsMC4zOTYsMS4xMTQsMS4wNCAgICBjMC4wODgsMC42NDQsMTMuOTAzLDk0LjUyLDEzLjkwMyw5NC41MmwtMzMuOTAxLDcuMzY5TDkwLjI1OSwxOC42NTJ6IiBmaWxsPSIjODFCRjM3IiBmaWxsLXJ1bGU9ImV2ZW5vZGQiIGlkPSJTaG9waWZ5XzFfIi8+PC9nPjwvZz48L3N2Zz4=" }