Skip to main content

How to use the Merchant API

Updated over 2 weeks ago

  • Use of this API requires a partner API Key. To obtain such a key, contact your Booxi representative.

    • *Note: the Partner API key should be used exclusively in server-side (backend) code to ensure it remains confidential.

  • 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:

POST /merchant

Create a new merchant (i.e. store).

Permissions & Security

  • A Partner API key is required.

  • The Partner API key provided must be valid.

Requirements & Specifications

  • A Head-Office is required to create a merchant. For info, contact your Booxi representative.

  • Each merchant is created under a merchant group (group_id) and inherits its configuration from a template_merchant_ID (i.e. your Head Office template store ID).

  • You cannot use a template_merchant (i.e. template store) from another merchant group to create a new merchant in the current group. For example, a merchant cannot be created in Group B using a template_merchant from Group A.

  • The number of merchants you can create is fixed; for info, contact your Booxi representative.

  • The created merchant inherits the following from the template_merchant_id :

    • Cover picture, profile picture

    • Owner login email

    • Services (if pushAllServices is set to ‘true’)

    • Business Open hours

    • Business Booking rules

    • Clientele (if shared)

Parameters

Parameter

Format

Description

pushAllServices

boolean

Determines whether the newly created merchant will inherit the template’s store services.

Mandatory fields to include in the request body

Field

Description

name

Store name

groupId

The merchant group to which the store is associated; can be retrieved by using the GET /merchant/{merchantId} endpoint for an existing store that is in the target group.

template_merchant_ID

The template store ID (to find, go to My Stores > {select your template store} > copy the ID listed in Business details)

address

Store address

contact first name

Store contact first name

contact first name

Store contact last name

phoneNumber

Store phone number

email

Store contact email address

timezone

Store timezone

Optional fields to include in the request body

Field

Description

Default

isAvailableOnline

Whether the store is online or offline

“true” if empty

storeNumber

Store number

null if empty

groupCategoryId

The store category you want the merchant to be created in (to find existing categories, see “My Stores” tab in the Head Office)

Placed in “Other Stores” if empty

tags

Store filter tags

null if empty

websiteUrl

Store website URL

null if empty

bookingUrl

Store booking page URL

null if empty

description

Store description

null if empty

tax1Name

Store tax 1

null if empty

tax1Rate

Store tax 1 rate

null if empty

tax2Name

Store tax 2

null if empty

tax2Rate

Store tax 2 rate

null if empty

defaultLanguage

Store primary language

Template store primary language if empty

Read-only fields

Field

How it is set

groupName

Read-only

groupCategoryName

Read-only

apiKey

Read-only

coverImageUrl

Inherited from the template store.

profileImageUrl

Inherited from the template store.

latitude

Defined automatically based on the store address

longitude

Defined automatically based on the store address

booking rules

Inherited from the template store.

currency

Defined automatically based on the store address

open hours

Inherited from the template store.

services

Inherited from the template store if pushAllServices is set to true

clientele

Inherited from the template store.

owner email user

Inherited from the template store.

Example of a request body

{
  "name": "Infinity Store",
  "templateMerchantId": 11329,
  "groupId": 1999,
  "address": {
    "street": "123 Fake St",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001",
    "country": "US"
  },
  "contactFirstName": "John",
  "contactLastName": "Smith",
  "phoneNumber": "+12125552368",
  "email": "john@gmail.com",
  "timeZone": "America/New_York"
}

Request URL for North America

https://api.booxi.com/booking/v1/merchant?pushAllServices=true

Request URL for Europe

https://api.booxi.eu/booking/v1/merchant?pushAllServices=true

cURL

curl -X 'POST' \
  'https://api.booxi.com/booking/v1/merchant?pushAllServices=true' \
  -H 'accept: application/json' \
  -H 'Booxi-PartnerKey: YOUR_PARTNER_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Infinity Store",
  "templateMerchantId": 11329,
  "groupId": 1999,
  "address": {
    "street": "123 Fake St",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001",
    "country": "US"
  },
  "contactFirstName": "John",
  "contactLastName": "Smith",
  "phoneNumber": "+12125552368",
  "email": "john@gmail.com",
  "timeZone": "America/New_York"
}'

Successful Response

Here’s an example of a successful response.

{
  "id": 123456,
  "name": "Infinity Store",
  "isAvailableOnline": true,
  "storeNumber": "",
  "templateMerchantId": 11329,
  "groupId": 1999,
  "groupName": "NA stores",
  "groupCategoryName": "",
  "address": {
    "street": "123 Fake St",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001",
    "country": "US"
  },
  "contactFirstName": "John",
  "contactLastName": "Smith",
  "phoneNumber": "+12125552368",
  "email": "john@gmail.com",
  "tags": "usa",
  "websiteUrl": "",
  "bookingUrl": "https://site.booxi.com/infinitystore-84",
  "apiKey": "GENERATED_MERCHANT_API_KEY_HERE",
  "description": "",
  "coverImageUrl": "https://www.booxi.com/images/1tg3XisyCv0J9fQB.png",
  "profileImageUrl": "https://www.booxi.com/images/1tg3XisyCv0J9fQB.png",
  "currency": "USD",
  "tax1Name": "",
  "tax1Rate": "0.000000",
  "tax2Name": "",
  "tax2Rate": "0.000000",
  "timeZone": "America/New_York",
  "latitude": "40.7054097",
  "longitude": "-73.8291849",
  "defaultLanguage": "eng"
}

You can test this endpoint at the following links.

For North America

For Europe

createMerchant

createMerchant

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

getMerchantList

getMerchantList

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

  • 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.

The response only includes the list of modules associated with the merchant (i.e. merchantLinks) if a match has been found for the provided moduleId.

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

findMerchants

findMerchants

GET merchant/{merchantId}

Retrieves the information of a specific merchant.

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 merchantId provided must belong to an active merchant that is associated with the Partner API key provided.

Parameters

Parameter

Format

Description

merchantId

integer

The id of the merchant. Mandatory.

Request URL for the North America

https://api.booxi.com/booking/v1/merchant/YOUR_MERCHANT_ID

Request URL for Europe

https://api.booxi.eu/booking/v1/merchant/YOUR_MERCHANT_ID

cURL 

curl -X 'GET' \
  'https://api.booxi.com/booking/v1/merchant/YOUR_MERCHANT_ID' \
  -H 'accept: application/json' \
  -H 'Booxi-PartnerKey: YOUR_PARTNER_API_KEY'

Successful Response

Here’s an example of a successful response.

{
  "id": 1,
  "name": "The Work Shop",
  "isAvailableOnline": true,
  "storeNumber": "US1210",
  "groupId": 201,
  "groupName": "Printing Co",
  "groupCategoryId": 30,
  "groupCategoryName": "Manhattan",
  "address": {
    "street": "123 Example 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

getMerchantById

getMerchantById

PUT /merchant/{merchantId}

Update a merchant (i.e. store).

Permissions & Security

  • A Partner API key is required.

  • The Partner API key provided must be valid.

Requirements & Specifications

  • Merchants can only be updated if they are associated with a Head Office. For any questions, contact your Booxi representative.

  • Template stores cannot be updated.

  • Null values will be ignored.

  • Empty strings will be deleted.

  • Provided value(s) will override existing values.

Parameters

Parameter

Format

Description

merchantId

integer

The ID of the merchant to be updated.

Example of a request body

{
  "name": "Infinity Store 2",
  "isAvailableOnline": true,
  "storeNumber": "3",
  "groupCategoryId": 123,
  "address": {
    "street": "456 New St",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001",
    "country": "US"
  },
  "contactFirstName": "David",
  "contactLastName": "White",
  "phoneNumber": "+12125559999",
  "email": "david@gmail.com",
  "websiteUrl": "https://www.infinitystore2.com",
  "bookingUrl": "https://book.infinity-new.com",
  "description": "The new infinity store location.",
  "defaultLanguage": "en"
}

Request URL for North America

https://api.booxi.com/booking/v1/merchant/YOUR_MERCHANT_ID

Request URL for Europe

https://api.booxi.eu/booking/v1/merchant/YOUR_MERCHANT_ID

cURL

curl -X 'PUT' \
  'https://api.booxi.com/booking/v1/merchant/YOUR_MERCHANT_ID' \
  -H 'accept: application/json' \
  -H 'Booxi-PartnerKey: YOUR_PARTNER_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Infinity Store 2",
  "isAvailableOnline": true,
  "storeNumber": "3",
  "groupCategoryId": 123,
  "address": {
    "street": "456 New St",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001",
    "country": "US"
  },
  "contactFirstName": "David",
  "contactLastName": "White",
  "phoneNumber": "+12125559999",
  "email": "david@gmail.com",
  "websiteUrl": "https://www.infinitystore2.com",
  "bookingUrl": "https://book.infinity-new.com",
  "description": "The new infinity store location.",
  "defaultLanguage": "en"
}'

Successful Response

Here’s an example of a successful response.

{
  "id": 123456,
  "name": "Infinity Store 2",
  "isAvailableOnline": true,
  "storeNumber": "3",
  "templateMerchantId": 11329,
  "groupId": 1999,
  "groupName": "NA stores",
  "groupCategoryId": 123,
  "groupCategoryName": "Flagship",
  "address": {
    "street": "456 New St",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001",
    "country": "US"
  },
  "contactFirstName": "David",
  "contactLastName": "White",
  "phoneNumber": "+12125559999",
  "email": "david@gmail.com",
  "tags": "usa",
  "websiteUrl": "https://www.infiniystore2.com",
  "bookingUrl": "https://book.infinity-new.com",
  "apiKey": "MERCHANT_API_KEY_HERE",
  "description": "The new infinity store location.",
  "coverImageUrl": "https://www.booxi.com/images/1tg3XisyCv0J9fQB.png",
  "profileImageUrl": "https://www.booxi.com/images/1tg3XisyCv0J9fQB.png",
  "currency": "USD",
  "tax1Name": "",
  "tax1Rate": "0.000000",
  "tax2Name": "",
  "tax2Rate": "0.000000",
  "timeZone": "America/New_York",
  "latitude": "40.706215",
  "longitude": "-74.0120453",
  "defaultLanguage": "eng"
}

You can test this endpoint at the following links.

For North America

For Europe

updateMerchant

updateMerchant

DELETE /merchant/{merchantId}

Delete (i.e. deactivate) a merchant.

Permissions & Security

  • A Partner API key is required.

  • The Partner API key provided must be valid.

Requirements & Specifications

  • Successful use of this endpoint will deactivate a merchant. It will remain visible in the Head Office (”My Stores” tab), listed as “Deactivated”.

  • Template stores cannot be deactivated.

Parameters

Parameter

Format

Description

merchantId

integer

The ID of the merchant to be deactivated.

Request URL for the North America

https://api.booxi.com/booking/v1/merchant/YOUR_MERCHANT_ID

Request URL for Europe

https://api.booxi.eu/booking/v1/merchant/YOUR_MERCHANT_ID

cURL

curl -X 'DELETE' \
  'https://api.booxi.com/booking/v1/merchant/YOUR_MERCHANT_ID' \
  -H 'accept: application/json' \
  -H 'Booxi-PartnerKey: YOUR_PARTNER_API_KEY_HERE'

Successful Response

Here’s an example of a successful response.

{
  "id": 123456,
  "name": "Infinity Store 2",
  "isAvailableOnline": true,
  "storeNumber": "3",
  "templateMerchantId": 11329,
  "groupId": 1999,
  "groupName": "NA stores",
  "groupCategoryId": 123,
  "groupCategoryName": "Flagship",
  "address": {
    "street": "456 New St",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001",
    "country": "US"
  },
  "contactFirstName": "David",
  "contactLastName": "White",
  "phoneNumber": "+12125559999",
  "email": "david@gmail.com",
  "tags": "usa",
  "websiteUrl": "https://www.infinitystore2.com",
  "bookingUrl": "https://book.infinitystore-new.com",
  "apiKey": "MERCHANT_API_KEY_HERE",
  "description": "The new infinity store location.",
  "coverImageUrl": "https://www.booxi.com/images/1tg3XisyCv0J9fQB.png",
  "profileImageUrl": "https://www.booxi.com/images/1tg3XisyCv0J9fQB.png",
  "currency": "USD",
  "tax1Name": "",
  "tax1Rate": "0.000000",
  "tax2Name": "",
  "tax2Rate": "0.000000",
  "timeZone": "America/New_York",
  "latitude": "40.706215",
  "longitude": "-74.0120453",
  "defaultLanguage": "eng"
}

You can test this endpoint at the following links.

For North America

For Europe

deleteMerchantById

deleteMerchantById

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

getMerchantModuleLink

getMerchantModuleLink

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

updateMerchantModuleLink

updateMerchantModuleLink

Related Articles
How to retrieve client records using the Booxi API
How to build a “Nearby Store Availability” experience
How to Retrieve a Client's Booking History Using the Booxi API
How to use the Staff API
How to use the Service API
Did this answer your question?