Skip to content
Navigation

Reads the home's, a product's, entry's or page's body, or the default layout its page shows in its place, where the customer may; one still uploading fails `conflict` on `status` (`pending`), so retry it shortly.

GET
https://api.sherpo.io/customer/v1/stores/{store}/body

Authorization

  • bearer
    optional
    HTTP
  • publishableKey
    optional
    API key in header

Path parameters

  • store
    string
    required

    A hostname of the store.

Query parameters

  • target
    required

    One of the following:

    • object
    • object
  • preview
    optional
    string

    A token a seller made for the target's page, which opens it unpublished with its staged body; a product's opens its published entries' bodies, gated as ever, and an entry's its product's live body, gated as ever.

    maxLength: 128 · minLength: 1
  • fallback
    optional
    boolean

    Answers the target's default layout whatever its body, for a page that can show none of its own blocks.

Returns

200

Reads the home's, a product's, entry's or page's body, or the default layout its page shows in its place, where the customer may; one still uploading fails conflict on status (pending), so retry it shortly.

JSON

One of the following:

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