Use of this API requires a partner API Key. To obtain such a key, contact your Booxi representative.
Prior to use, consult Booxi's API fair use policy.
Remember that the URL at which you access the API depends on your hosting region. This article presents examples from a North American hosting only.
API documentation links:
GET /merchant/list
Find merchants of a given merchant group.
*The merchant information can be accessed even if the merchant is not available online.
Permissions & Security
A Partner API key is required.
The Partner API key provided must be valid.
Requirements & Specifications
The groupId must be linked to merchants that are associated with the Partner API key.
The groupId provided must be valid.
Parameters
Parameter | Format | Description |
groupId | integer | The target merchant group ID. |
language | string | The language code that the content should be in. ISO 639-1, 639-2 and 639-3 are accepted. Only affects computed properties, localizable properties and certain errors. Defaults to the authenticated merchant's preferred language. The following languages are supported: eng, fre, spa, por, nld, deu, ita, ron, pol, yue, jpn, ell, dan, swe, bul, rus, kor, ces, tur, tha |
offset | integer | The number of matching items to skip. |
limit | integer | The maximum number of matching items to include in the response; the page size. |
Request URL for the North America
https://api.booxi.com/booking/v1/merchant/list?groupId=YOUR_MERCHANT_GROUP_ID&offset=YOUR_OFFSET&limit=YOUR_LIMIT
Request URL for Europe
https://api.booxi.eu/booking/v1/merchant/list?groupId=YOUR_MERCHANT_GROUP_ID&offset=YOUR_OFFSET&limit=YOUR_LIMIT
cURL
curl -X 'GET' \
'https://api.booxi.com/booking/v1/merchant/list?groupId=YOUR_MERCHANT_GROUP_ID&offset=YOUR_OFFSET&limit=YOUR_LIMIT' \
-H 'accept: application/json' \
-H 'Booxi-PartnerKey: YOUR_PARTNER_API_KEY'
Successful Response
Here’s an example of a successful response.
{
"offset": 0,
"limit": 10,
"total": 12,
"items": [
{
"id": 1,
"name": "The Work Shop",
"isAvailableOnline": true,
"storeNumber": "US1210",
"groupId": 201,
"groupName": "Printing Co",
"groupCategoryId": 30,
"groupCategoryName": "Manhattan",
"address": {
"street": "123 Fake St",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "US"
},
"contactFirstName": "Jane",
"contactLastName": "Poe",
"phoneNumber": "+12125552368",
"email": "jane@example.com",
"tags": "self-service,open-late",
"websiteUrl": "",
"bookingUrl": "https://site.booxi.com/theworkshop?lang=eng",
"apiKey": "7L9K7N2QrELXYJ8PJBsAtSA7HuL3BgRs",
"description": "The Work Shop is a great place to find and buy work supplies.",
"coverImageUrl": "https://www.booxi.com/images/1tg3XisyCv0J9fQY.png",
"profileImageUrl": "https://www.booxi.com/images/1tg3XisyCv0J9fQZ.png",
"currency": "USD",
"tax1Name": "CST",
"tax1Rate": "0.0450",
"tax2Name": "",
"tax2Rate": "0",
"timeZone": "America/New_York",
"latitude": "40.6892361",
"longitude": "-74.0445726",
"defaultLanguage": "eng",
"openHours": [
{
"dow": 1,
"start": "09:00:00",
"end": "10:00:00"
}
]
}
]
}You can test this endpoint at the following links.
For North America | For Europe |
GET /merchant/search
Find merchants based on the given parameters. The merchant information can be accessed even if the merchant is not available online.
Permissions & Security
A Partner API key is required.
The Partner API key provided must be valid.
Requirements & Specifications
The groupId must be linked to merchants that are associated with the Partner API key.
The groupId provided must be valid.
At least one search parameter is required.
Notes
The response only includes merchantLinks when providing a moduleId.
If there are too many results, only the first matching merchant will be returned.
Parameters
Parameter | Format | Description |
groupId | integer | The target merchant group ID. |
moduleId | string | The module of the merchant. Mandatory if externalId is provided. |
externalId | string | The externalId of the merchant. |
cursor | string | A token to get the next set of results of a request. When the cursor is set, all other query parameters must NOT be set. |
Request URL for the North America
https://api.booxi.com/booking/v1/merchant/search?groupId=YOUR_MERCHANT_GROUP_ID&
Request URL for Europe
https://api.booxi.eu/booking/v1/merchant/search?groupId=YOUR_MERCHANT_GROUP_ID&
cURL
curl -X 'GET' \
'https://api.booxi.com/booking/v1/merchant/search?groupId=YOUR_MERCHANT_GROUP_ID' \
-H 'accept: application/json' \
-H 'Booxi-PartnerKey: YOUR_PARTNER_API_KEY'
Successful Response
Here’s an example of a successful response.
{
"merchants": [
{
"id": 1,
"name": "The Work Shop",
"isAvailableOnline": true,
"storeNumber": "US1210",
"groupId": 201,
"groupName": "Printing Co",
"groupCategoryId": 30,
"groupCategoryName": "Manhattan",
"address": {
"street": "123 Fake St",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "US"
},
"contactFirstName": "Jane",
"contactLastName": "Poe",
"phoneNumber": "+12125552368",
"email": "jane@example.com",
"tags": "self-service,open-late",
"websiteUrl": "",
"bookingUrl": "https://site.booxi.com/theworkshop?lang=eng",
"apiKey": "7L9K7N2QrELXYJ8PJBsAtSA7HuL3BgRs",
"desription": "The Work Shop is a great place to find and buy work supplies.",
"coverImageUrl": "https://www.booxi.com/images/1tg3XisyCv0J9fQY.png",
"profileImageUrl": "https://www.booxi.com/images/1tg3XisyCv0J9fQZ.png",
"currency": "USD",
"tax1Name": "CST",
"tax1Rate": "0.0450",
"tax2Name": "",
"tax2Rate": "0",
"timeZone": "America/New_York",
"latitude": "40.6892361",
"longitude": "-74.0445726",
"defaultLanguage": "eng"
}
],
"merchantLinks": [
{
"merchantId": 956,
"moduleId": "salesforce",
"externalId": "merchant_51123",
"metadata": {
"classification": "supplemental"
},
"createdOn": "2022-05-20T07:15:00Z",
"modifiedOn": "2022-05-20T07:30:00Z"
}
],
"cursor": "eyJjcmVhdGlvbl9pZCI6IjEiLCJtZXJja"
}You can test this endpoint at the following links.
For North America | For Europe |
GET merchant/{merchantId}/moduleLink/{moduleId}
Retrieves the link configuration of a merchant for a given integration module.
Permissions & Security
A Partner API key is required.
The Partner API key provided must be valid.
Requirements & Specifications
The merchantId must not be associated with a deleted or disabled merchant.
The moduleId must be a valid module.
The moduleId must be associated with the merchantId.
The moduleId must be authorized for the Partner API Key.
The merchantId must be authorized for the Partner API Key.
The merchantId must be associated with the provided Partner API key.
Notes
If the link was never configured, a default merchant link will be returned with empty values.
Parameters
Parameter | Format | Description |
merchantId | integer | The id of the merchant the link is for. Mandatory.
|
moduleId | string | The id of the integration module the link is for. Mandatory. |
Request URL for the North America
https://api.booxi.com/booking/v1/merchant/YOUR_MERCHANT_ID/moduleLink/YOUR_MODULE_ID' \
Request URL for Europe
https://api.booxi.eu/booking/v1/merchant/YOUR_MERCHANT_ID/moduleLink/YOUR_MODULE_ID' \
cURL
curl -X 'GET' \
'https://api.booxi.com/booking/v1/merchant/YOUR_MERCHANT_ID/moduleLink/YOUR_MODULE_ID' \
-H 'accept: application/json' \
-H 'Booxi-PartnerKey: YOUR_PARTNER_API_KEY'
Successful Response
Here’s an example of a successful response.
{
"link": {
"merchantId": 956,
"moduleId": "salesforce",
"externalId": "merchant_51123",
"metadata": {
"classification": "supplemental"
},
"createdOn": "2022-05-20T07:15:00Z",
"modifiedOn": "2022-05-20T07:30:00Z"
},
"merchant": {
"id": 1,
"name": "The Work Shop",
"isAvailableOnline": true,
"storeNumber": "US1210",
"groupId": 201,
"groupName": "Printing Co",
"groupCategoryId": 30,
"groupCategoryName": "Manhattan",
"address": {
"street": "123 Fake St",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "US"
},
"contactFirstName": "Jane",
"contactLastName": "Poe",
"phoneNumber": "+12125552368",
"email": "jane@example.com",
"tags": "self-service,open-late",
"websiteUrl": "",
"bookingUrl": "https://site.booxi.com/theworkshop?lang=eng",
"apiKey": "7L9K7N2QrELXYJ8PJBsAtSA7HuL3BgRs",
"description": "The Work Shop is a great place to find and buy work supplies.",
"coverImageUrl": "https://www.booxi.com/images/1tg3XisyCv0J9fQY.png",
"profileImageUrl": "https://www.booxi.com/images/1tg3XisyCv0J9fQZ.png",
"currency": "USD",
"tax1Name": "CST",
"tax1Rate": "0.0450",
"tax2Name": "",
"tax2Rate": "0",
"timeZone": "America/New_York",
"latitude": "40.6892361",
"longitude": "-74.0445726",
"defaultLanguage": "eng"
}
}You can test this endpoint at the following links.
For North America | For Europe |
PUT merchant/{merchantId}/moduleLink/{moduleId}
Updates the link configuration of a merchant for a given integration module.
Permissions & Security
A Partner API key is required.
The Partner API key provided must be valid.
Requirements & Specifications
The merchantId must not be associated with a deleted or disabled merchant.
The moduleId must be a valid module.
The moduleId must be associated with the merchantId.
The moduleId must be authorized for the Partner API Key.
The merchantId must be authorized for the Partner API Key.
The merchantId must be associated with the provided Partner API key.
Notes
If given, the metadata will replace the existing metadata entirely. To avoid losing any data, it's recommended to read the merchant link before updating the metadata.
Parameters
Parameter | Format | Description |
merchantId | integer | The id of the merchant the link is for. Mandatory.
|
moduleId | string | The id of the integration module the link is for. Mandatory.
|
Request URL for the North America
https://api.booxi.com/booking/v1/merchant/YOUR_MERCHANT_ID/moduleLink/YOUR_MODULE_ID' \
Request URL for Europe
https://api.booxi.eu/booking/v1/merchant/YOUR_MERCHANT_ID/moduleLink/YOUR_MODULE_ID' \
cURL
curl -X 'PUT' \ 'https://api.booxi.com/booking/v1/merchant/YOUR_MERCHANT_ID/moduleLink/YOUR_MODULE_ID' \
-H 'accept: application/json' \
-H 'Booxi-PartnerKey: YOUR_PARTNER_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"externalId": "merchant_51123",
"metadata": {
"classification": "supplemental"
}
}'
Successful Response
Here’s an example of a successful response.
{
"link": {
"merchantId": 956,
"moduleId": "salesforce",
"externalId": "merchant_51123",
"metadata": {
"classification": "supplemental"
},
"createdOn": "2022-05-20T07:15:00Z",
"modifiedOn": "2022-05-20T07:30:00Z"
},
"merchant": {
"id": 1,
"name": "The Work Shop",
"isAvailableOnline": true,
"storeNumber": "US1210",
"groupId": 201,
"groupName": "Printing Co",
"groupCategoryId": 30,
"groupCategoryName": "Manhattan",
"address": {
"street": "123 Fake St",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "US"
},
"contactFirstName": "Jane",
"contactLastName": "Poe",
"phoneNumber": "+12125552368",
"email": "jane@example.com",
"tags": "self-service,open-late",
"websiteUrl": "",
"bookingUrl": "https://site.booxi.com/theworkshop?lang=eng",
"apiKey": "7L9K7N2QrELXYJ8PJBsAtSA7HuL3BgRs",
"description": "The Work Shop is a great place to find and buy work supplies.",
"coverImageUrl": "https://www.booxi.com/images/1tg3XisyCv0J9fQY.png",
"profileImageUrl": "https://www.booxi.com/images/1tg3XisyCv0J9fQZ.png",
"currency": "USD",
"tax1Name": "CST",
"tax1Rate": "0.0450",
"tax2Name": "",
"tax2Rate": "0",
"timeZone": "America/New_York",
"latitude": "40.6892361",
"longitude": "-74.0445726",
"defaultLanguage": "eng"
}
}You can test this endpoint at the following links.
For North America | For Europe |