General

Objects

Codes

Merchant - POST

Stability: 3 - Frozen

Create or update a merchant

The endpoint you need to use for this is:

/merchant

Request

Headers

Key	Details	Example
Authorization*	{token_type} {access_token}	Bearer c3499c2729730a7f807efb8676a92dcb6f8a3f8f
Method*	POST	POST
x-accept-version	{recommended_latest_version_number}	2

* Required header

Body

NOTE: Currently a user can create only one merchant, thus the API restrict you to create only one.

NOTE: To update just supply the object id.

Key	Details	Data Type
merchant.name	Merchant name	string
merchant.description	A short description about the merchant.	string
merchant.companyNumber	Registered company number.	alphaNumerical
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

{
    "merchant": {
        "name": "Coffee Bean",
        "description": "A coffee shop",
        "companyNumber": "34522113",
        "vatNumber": "12345234",
        "colours": {
            "primary": {
                "main": "00aefc",
                "highlight": "307bcc",
                "contrast": "ffffff"
            }
        },
        "links": {
            "website": {
                "home": "http://google.com"
            }
        },
        "imageIds": {
            "logo": {
                "receipt": "vygubinjkhbuiwjnekbnj.jpg",
                "square": "hwebcwenwjknwkfnewfkjnw.jpg"
            },
            "feature": [
                "uiwefwifnwlkefnwoeifnwf.jpg",
                "efoiwejfwojeifwoefjiowefnmweio.jpg"
            ]
        },
        "categoryId": 2,
        "estAnnualRevenue": 20000000,
        "note": "Google organic search conversion"
    }
}

Response

Headers

Key	Details	Data Type	Example
statusCode	Very important to check this for any error. 201 for success.	int	201

Body

Key	Details	Data Type
merchant.id	Newly created merchant id	int
merchant.name	Merchant name	string
merchant.description	A short description about the merchant.	string
merchant.companyNumber	Registered company number.	string
merchant.vatNumber	Local Value Added Tax registration number.	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 above table for category ids.	array
merchant.estAnnualRevenue	Estimated annual revenue of the merchant in pence.	decimal
merchant.note	Extra notes about the merchant	decimal

{
    "merchant": {
        "0": {
            "id": 1,
            "name": "Coffee Bean",
            "description": "A coffee shop",
            "companyNumber": "34522113",
            "vatNumber": "12345234",
            "categoryId": 2,
            "estAnnualRevenue": 20000000,
            "note": "Google organic search conversion"
        }
    },
    "api": {
        "message": {
            "success": {
                "202": {
                    "id": 202,
                    "code": "tokenValid",
                    "title": "Token is valid",
                    "details": "Token is validated and found valid."
                },
                "206": {
                    "id": 206,
                    "statusCode": 201,
                    "title": "Resource Created",
                    "details": "Your resource is created partially or fully. Please check further message or process log"
                }
            }
        },
        "codeBaseVersion": 2,
        "executionTime_milliSeconds": 32
    }
}

Attribute Options

Category Id

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

Status Codes

Error

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}
919	429	Cannot handle too many request	There is a limit for every object you can send to our server and you are exceding that.
913	400	Required parameter or object missing in request	One or more of the required parameters or object formation is missing in your request. Please refer the documentation
904	401	Access Denied	Access denied for the request
899	500	Unknown Error	Something went wrong. Please contact the site administrator

Success

Please check the live API calls for more details on the API messages.

ID	Status Code	Title	Details
202	200	Token is valid	Token is validated and found valid.
206	201	Resource Created	Your resource is created partially or fully. Please check further message or process log

Request
- Headers
- Body
Response
- Headers
- Body
Attribute Options
- Category Id
Status Codes
- Error
- Success
Top