General

Objects

Codes

Supplier - POST

Stability: 3 - Frozen

Create or update a supplier

The endpoint you need to use for this is:

/supplier

Request

Headers

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

Body

NOTE: To update just supply the object id.

Key	Details	Data Type
suppliers[objectRef].name	supplier name	string
suppliers[objectRef].description	A short description about the supplier.	string
suppliers[objectRef].companyNumber	Registered company number.	string
suppliers[objectRef].vatNumber	Local Value Added Tax registration number.	string
suppliers[objectRef].imageIds	supplier logo and image urls.	array
suppliers[objectRef].note	Extra notes about the supplier	decimal

{
    "suppliers": {
        "0": {
            "name": "Coffee Bean",
            "description": "A coffee shop",
            "companyNumber": "34522113",
            "vatNumber": "12345234",
            "imageIds": [
                "38ec323266e4cbeb45636d5ff73b0c89d09f98b4.jpg"
            ],
            "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
suppliers[objectRef].id	Newly created supplier id	int
suppliers[objectRef].name	Supplier name	string
suppliers[objectRef].description	A short description about the supplier.	string
suppliers[objectRef].companyNumber	Registered company number.	alphaNumerical
suppliers[objectRef].vatNumber	Local Value Added Tax registration number.	alphaNumerical
suppliers[objectRef].imageIds	Supplier logo and image urls.	array
suppliers[objectRef].note	Extra notes about the supplier	decimal

{
    "suppliers": {
        "0": {
            "id": 1,
            "name": "Coffee Bean",
            "description": "A coffee shop",
            "companyNumber": "34522113",
            "vatNumber": "12345234",
            "imageIds": [
                "38ec323266e4cbeb45636d5ff73b0c89d09f98b4.jpg"
            ],
            "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
    }
}

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
Status Codes
- Error
- Success
Top