Skip to content
Navigation

Says whether a path is free for a page or redirect.

GET
https://api.sherpo.io/merchant/v1/stores/{store}/paths/check

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

Query parameters

  • kind
    product
    or
    page
    or
    redirect
    required
  • value
    string
    required
    maxLength: 4096 · minLength: 0
  • except
    optional
    string
    maxLength: 200 · minLength: 1

Returns

200

Says whether a path is free for a page or redirect.

JSON
  • available
    boolean
    required
  • reason
    required

    One of the following:

    • string
    • null
  • current
    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