Choose a version:

ConsentPolicy

object

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

Anchor to consentRequiredconsentRequired •Boolean: Whether consent is required for the region.
Anchor to countryCodecountryCode •PrivacyCountryCode: The ISO 3166 country code for which the policy applies.
Anchor to dataSaleOptOutRequireddataSaleOptOutRequired •Boolean: Whether data sale opt-out is required for the region.
Anchor to idid •ID!non-null: The global ID of the consent policy. IDs prefixed with SD- are system default policies.
Anchor to regionCoderegionCode •String: The ISO 3166 region code for which the policy applies.
Anchor to shopIdshopId •ID!non-null: The global ID of the shop that owns the policy.

Was this section helpful?

Anchor to consentPolicy consentPolicy •query: Returns the customer privacy consent policies of a shop.

Was this section helpful?

•mutation

Update or create consent policies in bulk.

Anchor to consentPoliciesconsentPolicies •[ConsentPolicyInput!]!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.

Anchor to updatedPoliciesupdatedPolicies •[ConsentPolicy!]: All updated and created consent policies. The consent policies that haven't been modified as part of the mutation aren't returned.
Anchor to userErrorsuserErrors •[ConsentPolicyError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Was this section helpful?