List Merchants

Provider Enablement / Endpoints

List Merchants

Return a list of all merchants (and their unique identifiers) available to us. The provider_id returned here will be passed to subsequent calls to the locations index endpoint detailed below.

Request Endpoints

GET /merchants

Example Response Body

{
  "updated_at": "2016-08-17T12:45:03",
  "merchants": [
    {
      "merchant": {
        "name": "LevelUp Cafe",
        "provider_id": "abc123",
        "integration_id": "revel",
        "allows_order_scheduling": "true"
      }
    },
    {
      "merchant": {
        "name": "Joe's Sandwich Shack",
        "provider_id": "xyz456",
        "integration_id": "monkeymedia",
        "allows_order_scheduling": "false"
      }
    }
  ]
}

Example Response Schema

{
  "type": "object",
  "properties": {
    "updated_at": {
      "description": "An iso8601 datestamp in UTC of when the merchant list was last refreshed",
      "type": "string"
    },
    "merchants:": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "merchant": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "description": "Name of the merchant"
              },
              "provider_id": {
                "type": "string",
                "description": "Unique identifier for the merchant"
              },
               "integration_id": {
                "type": "string",
                "description": "Unique identifier for the integration"
              },
              "allows_order_scheduling": {
                "type": "string",
                "description": "Whether or not native order scheduling is supported by this order provider for the merchant"
              }
            },
            "required": [
              "name",
              "provider_id",
              "integration_id",
              "allows_order_scheduling"
            ]
          }
        },
        "required": [
          "merchant"
        ]
      }
    }
  },
  "required": [
    "merchants"
  ]
}