API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

ShopPolicy object

Version unstable

Policy that a merchant has configured for their store, such as their refund or privacy policy.

Required access

read_legal_policies access scope.

Fields

body (HTML!)

The text of the policy. The maximum size is 512kb.

id (ID!)

Globally unique identifier.

translations ([PublishedTranslation!]!)

The translations associated with the resource.

locale ( String! ) required

Filters translations locale.

type (ShopPolicyType!)

The shop policy type.

url (URL!)

The public URL of the policy.

Types that return ShopPolicy

Mutations for ShopPolicy

shopPolicyUpdate

Updates a shop policy.

Implements

Version 2021-01 (Release candidate)

Policy that a merchant has configured for their store, such as their refund or privacy policy.

Required access

read_legal_policies access scope.

Fields

body (HTML!)

The text of the policy. The maximum size is 512kb.

id (ID!)

Globally unique identifier.

translations ([PublishedTranslation!]!)

The translations associated with the resource.

locale ( String! ) required

Filters translations locale.

type (ShopPolicyType!)

The shop policy type.

url (URL!)

The public URL of the policy.

Types that return ShopPolicy

Mutations for ShopPolicy

shopPolicyUpdate

Updates a shop policy.

Implements

Version 2020-10 (Latest)

Policy that a merchant has configured for their store, such as their refund or privacy policy.

Required access

read_legal_policies access scope.

Fields

body (HTML!)

The text of the policy. The maximum size is 512kb.

id (ID!)

Globally unique identifier.

translations ([PublishedTranslation!]!)

The translations associated with the resource.

locale ( String! ) required

Filters translations locale.

type (ShopPolicyType!)

The shop policy type.

url (URL!)

The public URL of the policy.

Types that return ShopPolicy

Mutations for ShopPolicy

shopPolicyUpdate

Updates a shop policy.

Implements