Skip to content
Navigation

Erases a customer's personal data, keeping the records of what they bought.

POST
https://api.sherpo.io/merchant/v1/stores/{store}/customers/{customer}/erase

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • customer
    string
    required
    minLength: 1

Header parameters

  • Idempotency-Key
    optional
    string

    Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.

    maxLength: 255 · minLength: 1 · pattern: ^[\x21-\x7E]+$

Request body JSON optional

Returns

200

Erases a customer's personal data, keeping the records of what they bought.

JSON
  • orders
    object
    required
    • items
      array of
      object
      required
      • id
        string
        required
      • number
        number
        required
      • customer_id
        required

        One of the following:

        • string
        • null
      • currency
        string
        required
      • exponent
        required

        One of the following:

        • number
        • null
      • amount
        required

        One of the following:

        • number
        • null
      • discount
        required

        One of the following:

        • number
        • null
      • total
        required

        One of the following:

        • number
        • null
      • free
        boolean
        required
      • fees
        required

        One of the following:

        • number
        • null
      • source
        string
        required
      • source_key
        required

        One of the following:

        • string
        • null
      • statements
        object
        required
        • coupon
          optional
          string
        • customer_status
          optional
          string

          How well the buyer was known; fake is a seeded order.

        • method
          optional
          string

          The payment method the processor reported.

        • method_details
          optional
          object

          What the method shows, as a saved instrument's display: its brand and last 4 digits.

          • brand
            required

            One of the following:

            • string
            • null
          • last4
            required

            One of the following:

            • string
            • null
        • refund_waiver
          optional
          object

          Carried from the checkout.

          • policy
            string
            required

            The strictest policy among the lines, the one consented to.

          • accepted_at
            string
            required
        • under_minimum
          optional
          object
          • processor
            string
            required
          • minimum
            required

            Null when the processor refused the payment as too small rather than core reading its minimum.

            One of the following:

            • number
            • null
          • amount
            required

            One of the following:

            • number
            • null
      • note
        required

        One of the following:

        • string
        • null
      • occurred_at
        required

        One of the following:

        • string
        • null
      • recorded_at
        required

        One of the following:

        • string
        • null
    • total
      number
      required
  • subscriptions
    object
    required
    • items
      array of
      object
      required
      • display_status
        string
        required

        Its status as people read it: cancelling while it bills and is set to stop.

      • product
        required

        One of the following:

        • object
        • null
      • id
        string
        required
      • customer_id
        string
        required
      • product_id
        string
        required
      • plan_id
        string
        required
      • processor
        required

        One of the following:

        • string
        • null
      • external_ref
        required

        One of the following:

        • string
        • null
      • account_ref
        required

        One of the following:

        • string
        • null
      • status
        string
        required
      • cancel_at_period_end
        boolean
        required
      • instrument_ref
        required

        One of the following:

        • string
        • null
      • cancel_reason
        required

        One of the following:

        • string
        • null
      • created_at
        required

        One of the following:

        • string
        • null
      • ended_at
        required

        One of the following:

        • string
        • null
    • total
      number
      required
  • grants
    object
    required
    • items
      array of
      object
      required
      • token_id
        required

        One of the following:

        • string
        • null
      • product
        required

        One of the following:

        • object
        • null
      • id
        string
        required
      • customer_id
        string
        required
      • product_id
        string
        required
      • tier_id
        required

        One of the following:

        • string
        • null
      • source_kind
        string
        required
      • source_ref
        required

        One of the following:

        • string
        • null
      • grant_reason
        required

        One of the following:

        • string
        • null
      • settlement_id
        required

        One of the following:

        • string
        • null
      • valid_from
        required

        One of the following:

        • string
        • null
      • ends_at
        required

        One of the following:

        • string
        • null
      • end_reason
        required

        One of the following:

        • string
        • null
      • status
        string
        required

        Where it stands now: not begun, standing, or how it ended.

      • revocable
        boolean
        required

        Whether revokeGrant may still end it.

      • granted_by
        required

        One of the following:

        • string
        • null
      • occurred_at
        required

        One of the following:

        • string
        • null
      • recorded_at
        required

        One of the following:

        • string
        • null
    • total
      number
      required
  • entitlements
    object
    required
    • items
      array of
      object
      required
      • customer_id
        string
        required
      • product_id
        string
        required
      • tier_rank
        number
        required
      • expires_at
        required

        One of the following:

        • string
        • null
      • tier_expires_at
        required

        One of the following:

        • string
        • null
      • next_change_at
        required

        One of the following:

        • string
        • null
      • rebuilt_at
        required

        One of the following:

        • string
        • null
    • total
      number
      required
  • reviews
    object
    required
    • items
      array of
      object
      required
      • product
        required

        One of the following:

        • object
        • null
      • id
        string
        required
      • product_id
        string
        required
      • customer_id
        string
        required
      • order_item_id
        required

        One of the following:

        • string
        • null
      • rating
        number
        required
      • username
        required

        One of the following:

        • string
        • null
      • notes
        required

        One of the following:

        • string
        • null
      • reply
        required

        One of the following:

        • string
        • null
      • replied_at
        required

        One of the following:

        • string
        • null
      • hidden_at
        required

        One of the following:

        • string
        • null
      • created_at
        required

        One of the following:

        • string
        • null
      • updated_at
        required

        When the customer last edited it; null until they do.

        One of the following:

        • string
        • null
    • total
      number
      required
  • attempts
    object
    required
    • items
      array of
      object
      required
      • id
        string
        required
      • product_id
        string
        required
      • quiz_id
        string
        required
      • customer_id
        string
        required
      • attempt
        number
        required
      • status
        string
        required
      • answers
        map of
        object
        required
      • score
        required

        One of the following:

        • number
        • null
      • correct
        required

        One of the following:

        • number
        • null
      • started_at
        required

        One of the following:

        • string
        • null
      • finished_at
        required

        One of the following:

        • string
        • null
    • total
      number
      required
  • certificates
    object
    required
    • items
      array of
      object
      required
      • id
        string
        required
      • product_id
        string
        required
      • certificate_id
        string
        required
      • customer_id
        string
        required
      • score
        required

        One of the following:

        • number
        • null
      • attempt
        required

        One of the following:

        • number
        • null
      • issued_at
        required

        One of the following:

        • string
        • null
      • revoked_at
        required

        One of the following:

        • string
        • null
    • total
      number
      required
  • feeds
    object
    required

    Their private feeds, live and stopped, newest first; listFeeds pages the rest.

    • items
      array of
      object
      required
      • id
        string
        required
      • customer_id
        string
        required
      • product_id
        string
        required
      • product
        required

        One of the following:

        • object
        • null
      • readers
        number
        required

        Readers it served in the last 30 days, each shared fetcher for the people it reports.

      • reader_limit
        number
        required

        Readers it serves in 30 days before it moves to a new URL.

      • reader_limit_set
        boolean
        required

        Whether the limit is the merchant's own rather than the default.

      • created_at
        required

        One of the following:

        • string
        • null
      • revoked_at
        required

        One of the following:

        • string
        • null
      • revoked_reason
        required

        Why it stopped: a new URL replaced it, too many readers shared it, its customer or the merchant revoked it, or the product turned private feeds off.

        One of the following:

        • string
        • null
    • total
      number
      required
    • blocked
      array of
      object
      required

      The blogs, podcasts and events whose private feed sharing turned off for them, until the merchant turns it on again.

      • product_id
        string
        required
      • product
        required

        One of the following:

        • object
        • null
      • blocked_at
        required

        One of the following:

        • string
        • null
  • contacts
    array of
    object
    required
    • kind
      string
      required
    • value
      string
      required
    • verified_at
      required

      One of the following:

      • string
      • null
  • totals
    object
    required
    • orders
      number
      required
    • spent
      array of
      object
      required
      • currency
        string
        required
      • exponent
        required

        One of the following:

        • number
        • null
      • amount
        required

        One of the following:

        • number
        • null
      • gross
        required

        One of the following:

        • number
        • null
      • refunded
        required

        One of the following:

        • number
        • null
    • active_subscriptions
      number
      required
  • id
    string
    required
  • display_name
    required

    One of the following:

    • string
    • null
  • locale
    required

    One of the following:

    • string
    • null
  • country
    required

    One of the following:

    • string
    • null
  • erased_at
    required

    One of the following:

    • string
    • null
  • invited_at
    required

    One of the following:

    • string
    • null
  • created_at
    required

    One of the following:

    • string
    • null
JSON
  • type
    string
    required
    format: uri
  • title
    string
    required
  • status
    integer
    required
  • detail
    string
    required
  • code
    optional
    string
  • context
    optional
    object
  • reached_core
    optional
    boolean
  • core_answer
    optional
    string

Type to search…

↑↓ navigate↵ selectEsc close