consentPolicy - admin-graphql - QUERY

Version: unstable

Description:

Returns the customer privacy consent policies of a shop.

Access Scopes

Arguments

  • consentRequired: Boolean - Return policies where consent is required or not.
  • countryCode: PrivacyCountryCode - Return policies with the provided country code.
  • dataSaleOptOutRequired: Boolean - Return policies where data sale opt out is required or not.
  • id: ID - Return the policy with the provided ID.
  • regionCode: PrivacyRegionCode - Return policies with the provided region code.

Returns

  • consentRequired: Boolean Whether consent is required for the region.
  • countryCode: PrivacyCountryCode The `ISO 3166` country code for which the policy applies.
  • dataSaleOptOutRequired: Boolean Whether data sale opt-out is required for the region.
  • id: ID! The global ID of the consent policy. IDs prefixed with `SD-` are system default policies.
  • regionCode: PrivacyRegionCode The `ISO 3166` region code for which the policy applies.
  • shopId: ID! The global ID of the shop that owns the policy.

Examples