Choose a version:

ShopPolicy

object

Requires read_legal_policies access scope.

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

Anchor to FieldsFields

Anchor to bodybody • HTML!non-null: The text of the policy. The maximum size is 512kb.
Anchor to createdAtcreatedAt • Date!non-null: The date and time (ISO 8601 format) when the policy was created.
Anchor to idid • ID!non-null: A globally-unique ID.
Anchor to titletitle • String!non-null: The translated title of the policy. For example, Refund Policy or Politique de remboursement.
Anchor to translationstranslations • [Translation!]!non-null: The published translations associated with the resource.
Anchor to typetype • ShopPolicyType!non-null: The shop policy type.
Anchor to updatedAtupdatedAt • Date!non-null: The date and time (ISO 8601 format) when the policy was last modified.
Anchor to urlurl • URL!non-null: The public URL of the policy.

Was this section helpful?

•

mutation

Updates a shop policy.

Anchor to shopPolicyshopPolicy • ShopPolicyInput!required: The properties to use when updating the shop policy.

Anchor to shopPolicyshopPolicy • ShopPolicy: The shop policy that has been updated.
Anchor to userErrorsuserErrors • [ShopPolicyUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Was this section helpful?