Describe a merchant

Services with pricing_model and a typed inputs list (needs, frequencies, conditions), add-ons, the business time zone, service area (ZIPs, with town and state) and hours. Hours are wall-clock times in the business time zone.

post/api/v1/discover

Request

  • Base URL: https://commontape.com
  • URL: https://commontape.com/api/v1/discover
  • Auth: HTTP bearer

Request body

merchant_slugstring required

Response

Success

slugstring
display_namestring
verticalstring
bringsstring[] nullable
productsstring[] nullable
brings_not_saidstring[] nullable

Kit words added to the word list after this business answered: it has not said, which is not a no.

products_not_saidstring[] nullable

Product words added to the word list after this business answered: it has not said, which is not a no.

invoicestring[] nullable

M-32: what the customer gets after the job, sent by the business (CommonTape never issues one). invoice.receipt is a receipt only. null: the business has not said.

timezonestring

The business's IANA time zone, e.g. America/Los_Angeles. Its hours are in this zone.

areastring[]

ZIP codes the business serves.

Example response

{
  "services": [
    {
      "inputs": {
        "needs": [
          {
            "path": "property.size.square_feet"
          }
        ],
        "conditions": [
          {
            "key": "cond.pets"
          }
        ]
      },
      "booking_hours": 3
    }
  ],
  "timezone": "America/Los_Angeles",
  "area_details": [
    {
      "city": "San Francisco",
      "state": "CA"
    }
  ],
  "hours": [
    {
      "open_time": "08:00:00",
      "close_time": "17:00:00"
    }
  ]
}

Changes

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