INPUT_OBJECT

PurgeOrderDataMutationInput

Autogenerated input type of PurgeOrderDataMutation

link GraphQL Schema definition

  • input PurgeOrderDataMutationInput {
  • # A unique identifier for the client performing the mutation.
  • clientMutationId: String
  • # Orders to act upon. Note individual errors can fail and will cause them to be
  • # returned in the errors
  • orderIds: [ID!]!
  • # Purge (clear) PII data directly on the order: user, address,
  • # billing_address, email_address, first_name, surname, phone, company_name,
  • # billing_email_address billing_phone, billing_first_name, billing_surname,
  • # billing_company_name, ip_address identity_document_number and date_of_birth
  • purgeOrderDetails: Boolean
  • # Purge (clear) note data at several levels. "Note" on both the order
  • # directly and associated shipments. Set "content" on invoice annotations
  • # to "purged" (can't be blank). Remove receipt attachments on refund requests
  • # and attachments on return shipments and refund request notes (as well as
  • # "note").
  • # Remove "reason" and "denyRefundReason" on the refund request line items, as well
  • # as "note" and "attachments" on the associated RefundRequestNote.
  • purgeNotes: Boolean
  • # Purge (clear) all of the metadata on the order and associated invoice, lineItem,
  • # shipment objects (Note: not any other associated objects)
  • purgeMetadata: Boolean
  • # Purge (clear) all of the externalIds on the order and associated invoice,
  • # lineItem, shipment objects (Note: not any other associated objects)
  • purgeExternalIds: Boolean
  • }