Consent
A consent policy describes the level of consent that the merchant requires from the user before actually collecting and processing the data.
Anchor to FieldsFields
- consentRequired (Boolean)
- countryCode (PrivacyCountryCode)
- dataSaleOptOutRequired (Boolean)
- id (ID!)
- regionCode (String)
- shopId (ID!)
- Anchor to consentRequiredconsent•Boolean
Required Whether consent is required for the region.
- Anchor to countryCodecountry•Privacy
Code Country Code The
country code for which the policy applies.- Anchor to dataSaleOptOutRequireddata•Boolean
Sale Opt Out Required Whether data sale opt-out is required for the region.
- •ID!non-null
The global ID of the consent policy. IDs prefixed with
are system default policies.- Anchor to regionCoderegion•String
Code The
region code for which the policy applies.- Anchor to shopIdshop•ID!
Id non-null The global ID of the shop that owns the policy.
Anchor to QueriesQueries
- consentPolicy ([ConsentPolicy!]!)
- •query
Returns the customer privacy consent policies of a shop.
- •ID
Return the policy with the provided ID.
- Anchor to countryCodecountry•Privacy
Code Country Code Return policies with the provided country code.
- Anchor to regionCoderegion•String
Code Return policies with the provided region code.
- Anchor to consentRequiredconsent•Boolean
Required Return policies where consent is required or not.
- Anchor to dataSaleOptOutRequireddata•Boolean
Sale Opt Out Required Return policies where data sale opt out is required or not.
Arguments
Anchor to MutationsMutations
- consentPolicyUpdate (ConsentPolicyUpdatePayload)
- •mutation
Update or create consent policies in bulk.
- Anchor to consentPoliciesconsent•[Consent
Policies Policy Input!]! required The consent policies to update or create. If the country and region matches an existing consent policy, then the consent policy is updated. Otherwise, a new consent policy is created.
Arguments