Skip to content
Navigation

Connects a domain the seller owns to the store, answering the DNS records to set; it becomes the store's main address once they check out, or at once when it already does. Needs a plan that includes a domain.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

Request body JSON required

  • hostname
    string
    required
    maxLength: 253 · minLength: 3

Returns

200

Connects a domain the seller owns to the store, answering the DNS records to set; it becomes the store's main address once they check out, or at once when it already does. Needs a plan that includes a domain.

JSON
  • included
    boolean
    required
  • available
    boolean
    required
  • target
    required

    One of the following:

    • string
    • null
  • domain
    required

    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