Skip to content
Navigation

Reads what the store's home, a page, a product or an entry renders, its body or the default layout without one, and a quiz's or certificate's body; staged reads the unpublished one, and default the default layout even over a body. `getBodySchema` answers the blocks and props each kind of body takes.

GET
https://api.sherpo.io/merchant/v1/stores/{store}/{kind}/{id}/body

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • kind
    string
    required

    The target's kind, in the plural.

    minLength: 1
  • id
    string
    required
    minLength: 1

Query parameters

  • staged
    optional
    boolean

    Reads the unpublished next body instead of the live one.

  • default
    optional
    boolean

    Answers the default layout the target's page shows without a body (the answer's default set), even while it has one, naming that body as asset; not with staged, and not for a quiz or certificate.

Returns

200

Reads what the store's home, a page, a product or an entry renders, its body or the default layout without one, and a quiz's or certificate's body; staged reads the unpublished one, and default the default layout even over a body. getBodySchema answers the blocks and props each kind of body takes.

JSON

One of the following:

  • object
  • 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