Seller

List the shops this key may act for

An integration is handed a key, not a shop id. This is where it learns them. An account may run more than one shop and name the same key on each; when it has, every other vendor call needs ?vendor= to say which, and this endpoint is how a script finds the id rather than having it read out of the website. A shop that is not approved accepts writes but shows nothing publicly.

An empty array means the key is not named by any shop yet, not that anything is wrong with it. Holding an Enterprise plan is what buys access to this API; a shop naming the key in Profile > Seller is what gives it a shop to act for, and the two are deliberately separate (there is no scope on an API key). Call this first: every other vendor route refuses a key no shop names, because each of them needs a shop to act on.

Requires Enterprise tier or higher.

get/v1/vendor/shops

Request

  • Base URL: https://api.gunspec.io
  • URL: https://api.gunspec.io/v1/vendor/shops
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Response

List the shops this key may act for

successboolean required

Always true on a successful response. Every error carries false and an error object instead.

Example response

{
  "success": true,
  "data": [
    {
      "id": "ridgeline-optics",
      "name": "Ridgeline Optics",
      "website": "https://ridgeline.example",
      "currency": "AUD",
      "approved": true
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.