Merchant API

A merchant is represented as an object with the following structure:

{
  currency: String,
  customerCount: Number,
  country: String,
  createdAt: String,
  creditsEnabled: Boolean,
  currency: String,
  email: String,
  firstName: String,
  landingPageEnabled: Boolean,
  lastName: String,
  merchantId: String,
  merchantName: String,
  myshopifyDomain: String,
  phone: String,
  savedSearchId: String,
  status: String,
  subscriptionProduct: String,
  updatedAt: String
}

Endpoints & Methods

Get merchant

GET https://public.inveterateapi.com/merchant

Gets merchant data.

Headers

Name	Type	Description
X-Inveterate-Api-Key*	String	Required to access all protected endpoints on this API. Obtained from merchant's Inveterate dashboard.

200: OK Get merchant success

{
  "data": {
    "merchant": {
      "currency": "USD",
      "customerCount": 2374,
      "country": "United States",
      "createdAt": "2022-01-01T12:00:00.000Z",
      "creditsEnabled": true,
      "currency": "USD",
      "email": "[email protected]",
      "firstName": "Inveterate",
      "landingPageEnabled": true,
      "lastName": "Example",
      "merchantId": "inveterate",
      "merchantName": "Inveterate",
      "myshopifyDomain": "inveterate.myshopify.com",
      "phone": "555-123-4567",
      "savedSearchId": "gid://shopify/Segment/1234567890",
      "status": "ACTIVE",
      "subscriptionProduct": "gid://shopify/Product/1234567890",
      "updatedAt": "2022-01-01T12:00:00.000Z"
    }
  }
  "success": true,
  "errors": []
}

400: Bad Request All errors

{
  "data": {}
  "success": false,
  "errors": [
    "Invalid API key"
  ]
}