Skip to content
Navigation

Takes a product back to draft.

POST
https://api.sherpo.io/merchant/v1/stores/{store}/products/{product}/unpublish

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • product
    string
    required

    An id, or slug:<slug>.

    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

  • full
    optional
    boolean

    Answers the texts, attachments and file lists the short answer leaves out.

Returns

200

Takes a product back to draft.

JSON
  • status
    string
    required
  • category
    string
    required
  • listing
    string
    required
  • id
    string
    required
  • slug
    string
    required
  • title
    string
    required
  • subtitle
    required

    The short line shown under the title.

    One of the following:

    • string
    • null
  • priority
    number
    required
  • published_at
    required

    One of the following:

    • string
    • null
  • discontinued_at
    required

    One of the following:

    • string
    • null
  • unlisted_at
    required

    One of the following:

    • string
    • null
  • created_at
    required

    One of the following:

    • string
    • null
  • updated_at
    required

    One of the following:

    • string
    • null
  • settings
    object
    required
    • refund_policy
      optional
      string
    • progress_tracking
      optional
      string
    • reviews_enabled
      optional
      boolean
    • review_summary_visible
      optional
      boolean

      Whether customers see the generated review summary; it is written either way.

    • purchase_note
      optional
      string

      Shown beside the buy button.

      maxLength: 2000 · minLength: 1
    • calendar
      optional
      object

      A bookable product: the seller's Cal.com event and the host card beside the widget; writes check it, reads answer it as stored.

      • calcom
        optional
        object
        • username
          optional
          string
        • event_slug
          optional
          string
      • host
        optional
        object
        • title
          optional
          string
        • subtitle
          optional
          string
        • description
          optional
          string
        • tags
          optional
          array of
          string
        • icon
          optional
          string
    • coffee
      optional
      object

      A tip button: what it is called and what it shows.

      • emoji
        optional
        string
      • descriptor
        optional
        string
        maxLength: 15 · minLength: 3 · pattern: ^\S(.*\S)?$
    • fundraising
      optional
      object

      A fundraiser: the goal, in minor units of its currency.

      • goal
        integer
        required
        minimum: 1
      • currency
        string
        required
        maxLength: 3 · minLength: 3
    • feeds
      optional
      object

      A blog's or a podcast's feeds: the public one always stays; private false turns every customer's private feed off.

      • private
        optional
        boolean
      • category
        optional
        string

        A podcast's directory category, one of Apple's, its subcategory after > (Arts > Books).

        maxLength: 64
      • explicit
        optional
        boolean

        Whether a podcast's episodes are explicit; not where unset.

      • owner_email
        optional
        string

        The address directories mail to verify a podcast's owner; never in a private feed.

        maxLength: 254
    • storefront
      optional
      object
      • sales_counter
        optional
        boolean

        A public count of orders on the product page.

      • background_poster
        optional
        boolean

        The poster doubles as the page background.

      • require_dark
        optional
        boolean

        The page renders dark whatever the visitor chose.

  • metadata
    map of
    any of
    required
  • unlisted
    boolean
    required
  • in_use
    array of
    object
    required
    • kind
      string
      required
    • count
      number
      required
  • path
    string
    required

    The storefront path.

  • url
    required

    The absolute URL on the store's verified hostname, or null before it has one.

    One of the following:

    • string
    • null
  • tiers
    array of
    object
    required
    • in_use
      object
      required
      • prices
        number
        required
      • grants
        number
        required
      • orders
        number
        required
      • discounts
        number
        required
      • gates
        number
        required
    • id
      string
      required
    • product_id
      string
      required
    • rank
      number
      required
    • name
      string
      required
  • prices
    array of
    object
    required
    • in_use
      object
      required
      • orders
        number
        required
      • subscriptions
        number
        required
      • checkouts
        number
        required
      • automations
        number
        required
      • discounts
        number
        required
    • id
      string
      required
    • product_id
      string
      required
    • tier_id
      string
      required
    • currency
      string
      required
    • exponent
      required

      One of the following:

      • number
      • null
    • amount
      number
      required
    • kind
      string
      required
    • period
      required

      One of the following:

      • object
      • null
    • highlighted
      boolean
      required
    • title
      required

      One of the following:

      • string
      • null
    • description
      required

      One of the following:

      • string
      • null
    • settings
      object
      required
      • autorenew
        optional
        boolean

        Recurring only; false stops the renewal, absent renews.

      • renewal_discount
        optional
        integer

        Recurring only, a percent off every renewal.

        maximum: 100 · minimum: 0
      • upgrade_multiplier
        optional
        number

        One-time only, a factor on the difference paid to move up a tier.

        maximum: 10 · minimum: 1
      • refund_policy
        optional
        string

        Overrides the product's.

    • archived_at
      required

      One of the following:

      • string
      • null
    • created_at
      required

      One of the following:

      • string
      • null
  • delete_blocked_by
    array of
    object
    required
    • kind
      string
      required
    • count
      number
      required
  • stats
    array of
    object
    required
    • gross
      required

      One of the following:

      • number
      • null
    • refunded
      required

      One of the following:

      • number
      • null
    • platform_fee
      required

      One of the following:

      • number
      • null
    • processor_fee
      required

      One of the following:

      • number
      • null
    • affiliate_fee
      required

      One of the following:

      • number
      • null
    • exponent
      required

      One of the following:

      • number
      • null
    • currency
      string
      required
    • settlement
      string
      required
    • transactions
      number
      required
    • refunds
      number
      required
    • buyers
      number
      required
  • ratings
    object
    required
    • published
      object
      required
      • count
        number
        required
      • average
        required

        One of the following:

        • number
        • null
      • histogram
        object
        required
        • 1
          number
          required
        • 2
          number
          required
        • 3
          number
          required
        • 4
          number
          required
        • 5
          number
          required
    • live
      object
      required
      • hidden
        number
        required
      • count
        number
        required
      • average
        required

        One of the following:

        • number
        • null
      • histogram
        object
        required
        • 1
          number
          required
        • 2
          number
          required
        • 3
          number
          required
        • 4
          number
          required
        • 5
          number
          required
  • feed_url
    required

    The public feed's absolute URL, for a blog or a podcast that is published, listed and on a verified hostname; else null.

    One of the following:

    • string
    • null
  • created
    array of
    object
    required

    The attachments the write bound: the files its new prose names.

    • id
      string
      required
    • role
      string
      required
    • asset
      object
      required
      • id
        string
        required
  • poster
    optional

    One of the following:

    • object
    • null
  • description
    optional

    The page's long description, in the rich text format as stored; answered only with full.

    One of the following:

    • string
    • null
  • what_you_get
    optional

    What a buyer gets, in the rich text format as stored; answered only with full.

    One of the following:

    • string
    • null
  • files
    optional
    map of
    object

    The files its prose names; answered only with full.

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