Get a catalogue item
Returns one item of your page's What We Offer, removed ones included (status: removed).
Scope: reviews:read · Plan: Growth, Pro and Enterprise in live mode (Reviews Business or Reviews Enterprise for an Agoo Reviews key); every plan in test mode.
AuthorizationBearer <token>Send Authorization: Bearer <token> on every request. The token is one of:
| Prefix | What it is | Where it may be used |
|---|---|---|
agoo_sk_live_ | Secret key, live mode | Your servers only |
agoo_sk_test_ | Secret key, test mode | Your servers only |
agoo_pk_live_ | Publishable key, live mode | Browsers and apps: create pre-registrations and bookings, read public booking types (with their intake questions) and their free slots, read the visit types open for pre-registration with their public forms. Never lists people. |
agoo_pk_test_ | Publishable key, test mode | As above, in test mode |
agoo_rk_live_ | Agoo Reviews key, live mode: a business on Agoo Reviews on its own, on Reviews Business | Your servers only: the Reviews operations, for that business and the branches the key names |
agoo_rk_test_ | Agoo Reviews key, test mode | As above, on any level: it reads the business's reviews and checks every write without saving it |
Admins create keys in Console → Developers → API keys and choose each key's scopes; a business on Agoo Reviews on its own creates its keys in its business area on agoo.reviews, under Developers. A key is shown once. Never put a secret key in a URL, a browser or a mobile app.
Scope: reviews:read
item_id*stringThe item's ID.
^ritem_[0-7][0-9a-hjkmnp-tv-z]{25}$The item.
application/json- response
One item in your page's What We Offer on Agoo Reviews: a product, service or programme.
id*string^ritem_[0-7][0-9a-hjkmnp-tv-z]{25}$object*"catalogue_item""catalogue_item"business_id*string^rbiz_[0-7][0-9a-hjkmnp-tv-z]{25}$kind*string"product""service""programme"name*stringdescription*string|nullgroup*|Your own grouping ("Mains", "Antenatal care").
price*An item's price as the page shows it, in cedis.
buy_url*|uribook_url*|urienquiries*booleanReaders may send an enquiry about it.
listed*booleanShown under What We Offer (false: a review area only).
reviewable*booleanReviewers may say a review is about it.
status*string"live""hidden""removed"position*integerIts place in your page's order.
place_ids*array<>The branches that offer it; empty: every branch.
photos*integerPublished photos (added in the business area).
rating*|Its rating from the reviews that name it, when there are enough.
url*|uricreated_at*stringdate-timeupdated_at*stringdate-timetest?booleanA test key's write: checked, not saved.
curl -X GET 'https://api.agoohq.com/v1/catalogue-items/string'{ "id": "string", "object": "catalogue_item", "business_id": "string", "kind": "product", "name": "string", "description": "string", "group": "string", "price": { "kind": "fixed", "min": 0, "max": 0, "unit": "string", "currency": "GHS" }, "buy_url": "http://example.com", "book_url": "http://example.com", "enquiries": true, "listed": true, "reviewable": true, "status": "live", "position": 0, "place_ids": [ "rplace_01m6a2b3c4d5e6f7g8h9jkmnpq" ], "photos": 0, "rating": {}, "url": "http://example.com", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "test": true}Create a catalogue item POST
Adds an item to your page's What We Offer, with the same checks as the business area: your level's item limit, no phone numbers, emails or links in the words (links go in `buy_url` and `book_url`), and branches of your page. Photos are added in the business area. `item.created` fires. A test key checks the item and saves nothing (`test: true`). A key limited to some branches can't change the catalogue: it belongs to the whole page. **Scope:** `reviews:write` · **Plan:** Growth, Pro and Enterprise in live mode (Reviews Business or Reviews Enterprise for an Agoo Reviews key); every plan in test mode.
Update a catalogue item PATCH
Changes what you send of an item: its words, price, buttons, branches, order, or whether it shows (`live` or `hidden`). `item.updated` fires. A test key checks the change and saves nothing. **Scope:** `reviews:write` · **Plan:** Growth, Pro and Enterprise in live mode (Reviews Business or Reviews Enterprise for an Agoo Reviews key); every plan in test mode.