Get merchant details
The endpoint you need to use for this is:
/merchant| Key | Details | Example |
|---|---|---|
| Authorization* | {token_type} {access_token} | Bearer c3499c2729730a7f807efb8676a92dcb6f8a3f8f |
| Method* | GET | GET |
| x-accept-version | {recommended_latest_version_number} | 2 |
* Required header
| Key | Details | Data Type | Example |
|---|---|---|---|
| statusCode | Very important to check this for shopwave server uptime. 200 for success. | int | 200 |
NOTE: Currently a user can create only one merchant, thus the API restrict you to get only one.
| Key | Details | Data Type |
|---|---|---|
| merchant.id | unique merchant Id | int |
| merchant.name | Merchant name | String |
| merchant.description | Merchant description | String |
| merchant.companyNumber | Merchant name | String |
| merchant.vatNumber | Merchant name | String |
| merchant.imageIds | An object containing images relevant to the merchant including the logo. | Object |
| merchant.colours | An object containing colours relevant to the merchant. | Object |
| merchant.links | An object containing links relevant to the merchant. | Object |
| merchant.categoryId | Merchant business type. Please see the below table for category ids. | array |
| merchant.estAnnualRevenue | Estimated annual revenue of the merchant in pence. | decimal |
| merchant.note | Extra notes about the merchant | decimal |
| ID | Value |
|---|---|
| 0 | Other |
| 1 | Bar, Pub or Club |
| 2 | Caterer |
| 3 | Charity or Education |
| 4 | Coffee Shop, Bakery or Deli |
| 5 | Health, Fitness & Beauty |
| 6 | Quick Service Food and Drink |
| 7 | Retail |
| 8 | Sit Down Restaurant |
| 9 | Street Food or Market Stall |
Please check the live API calls for more details on the API messages.
| ID | Status Code | Title | Details |
|---|---|---|---|
| 908 | 401 | Expired Token | Token expired or invalid. Please renew your token |
| 911 | 401 | Authorization Header Invalid | The authorization header is invalid. The correct format is Authorization: {token_type} {accessToken} |
| 912 | 403 | Resource Not Allowed For Specified User | The user does not own this resource and its forbidden |
| 899 | 500 | Unknown Error | Something went wrong. Please contact the site administrator |
Please check the live API calls for more details on the API messages.
| ID | Status Code | Title | Details |
|---|---|---|---|
| 203 | 200 | Request Processed Successfully | The request has been successfully completed. |
| 204 | 204 | No content to return | End of the page or no content to return for your request |
| 202 | 200 | Token is valid | Token is validated and found valid. |
