Sign in
Customer Privacy

Get customer privacy settings

Requires business:read. Returns the authenticated business's consent-required country lists, current revision, supported country codes and read-only compatibility metadata. Country lists independently control store statistics and marketing consent requirements. Countries absent from a list do not require consent for that category.

get/v3/customer-privacy

Response

Success

business_idinteger required
revisioninteger required

Current settings revision. Read it immediately before an update.

marketing_generationinteger required

Read-only revision for material marketing configuration changes.

notice_versionstring required

Current notice identifier.

analytics_enabledboolean required

Read-only legacy owner-acceptance metadata; not a writable analytics switch and not a prerequisite for event ingestion.

analytics_consent_countriesCustomerPrivacyCountryCode[] required

Use the supported codes returned by GET /v3/customer-privacy. Unsupported or lowercase codes are rejected. Duplicate valid codes are accepted and normalized to a sorted unique list.

marketing_consent_countriesCustomerPrivacyCountryCode[] required

Use the supported codes returned by GET /v3/customer-privacy. Unsupported or lowercase codes are rejected. Duplicate valid codes are accepted and normalized to a sorted unique list.

country_codesCustomerPrivacyCountryCode[] required

All supported country codes.

Changes

Changed in 1 of the 7 revisions of this API.1