Skip to content
Navigation

Creates a draft custom page.

POST
https://api.sherpo.io/merchant/v1/stores/{store}/pages

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

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 required

  • title
    string
    required
    maxLength: 200 · minLength: 1
  • full
    optional
    boolean

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

  • slug
    optional
    string

    Made from the title when absent: its words, numbered past a twin.

    maxLength: 120 · minLength: 1 · pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
  • description
    optional

    One of the following:

    • string
    • null
  • menu_position
    optional

    One of the following:

    • integer
    • null
  • settings
    optional
    object
    • storefront
      optional
      object
      • no_index
        optional
        boolean
  • metadata
    optional
    map of
    any of

Returns

201

Creates a draft custom page.

JSON
  • status
    string
    required
  • id
    string
    required
  • slug
    string
    required
  • title
    string
    required
  • description
    required

    One of the following:

    • string
    • null
  • published_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
    • storefront
      optional
      object
      • no_index
        optional
        boolean
  • metadata
    map of
    any of
    required
  • menu_position
    required

    One of the following:

    • number
    • null
  • live
    boolean
    required

    Served: published and within the pages the plan applies.

  • 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
  • menu_live
    boolean
    required

    Shown in the menu: published or scheduled, in it, and within the menu items the plan applies.

  • access
    array of
    object
    required
    • resource
      object
      required
      • kind
        string
        required
      • id
        string
        required
    • channel
      string
      required
    • tier_id
      required

      One of the following:

      • string
      • null
    • closed
      boolean
      required
  • attachments
    optional
    array of
    object

    Every attachment on the page with its asset whole; answered only with full.

    • id
      string
      required
    • target
      object
      required
      • kind
        string
        required
      • id
        string
        required
    • role
      string
      required
    • delivery
      string
      required
    • preview_only
      boolean
      required
    • from_body
      boolean
      required
    • release_file
      boolean
      required

      A file a software release ships, which its release edits and the product's own list leaves out.

    • position
      number
      required
    • asset
      object
      required
      • id
        string
        required
      • locator
        required

        One of the following:

        • string
        • null
      • origin
        string
        required
      • custodian
        string
        required
      • enforcement
        string
        required
      • mime
        required

        One of the following:

        • string
        • null
      • bytes
        required

        The file's size in bytes; null when it is charged nothing.

        One of the following:

        • number
        • null
      • quota_bytes
        number
        required

        The file's size in bytes; zero when it is charged nothing.

      • name
        string
        required
      • title
        required

        One of the following:

        • string
        • null
      • ext
        required

        One of the following:

        • string
        • null
      • status
        string
        required
      • optimized
        boolean
        required
      • parent_id
        required

        One of the following:

        • string
        • null
      • redacted
        boolean
        required
      • security
        required

        One of the following:

        • string
        • null
      • description
        required

        One of the following:

        • string
        • null
      • processed_at
        required

        One of the following:

        • string
        • null
      • metadata
        object
        required
        • width
          optional
          integer
          minimum: 0
        • height
          optional
          integer
          minimum: 0
        • duration
          optional
          number

          Seconds, measured, so rarely whole.

        • pages
          optional
          integer
          minimum: 0
        • waveform
          optional

          An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.

          One of the following:

          • string
          • null
        • transcript
          optional
          object
          • language
            optional
            string
          • confidence
            optional
            number
        • arguments
          optional
          array of
          object

          What an MCP prompt asks for; only an authored prompt carries it.

          • name
            string
            required
          • description
            required

            One of the following:

            • string
            • null
          • required
            boolean
            required
          • default
            required

            One of the following:

            • string
            • null
          • match
            required

            Pattern the whole value must match, diacritic-insensitive.

            One of the following:

            • string
            • null
          • flags
            required

            Flags among i, s and u the pattern runs with; null for i alone.

            One of the following:

            • string
            • null
          • message
            required

            What a refused value is told instead of the default reason.

            One of the following:

            • string
            • null
          • lenient
            boolean
            required
      • created_at
        required

        One of the following:

        • string
        • null
  • files
    optional
    map of
    object

    The files its body 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