General

Objects

Codes

Supplier GET

Get supplier details

The endpoint you need to use for this is:

/supplier

Request

Headers

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

* Required header

Response

Headers

Key Details Data Type Example
statusCode Very important to check this for shopwave server uptime. 200 for success. int 200

Body

Key Details Data Type
suppliers[id].id unique supplier Id int
suppliers[id].name Supplier name String
suppliers[id].description Supplier description String
suppliers[id].companyNumber Supplier name String
suppliers[id].vatNumber Supplier name String
suppliers[id].imageIds An Array of string containing supplier images url Array
suppliers[id].note Extra notes about the supplier decimal 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
{
    "suppliers": {
        "1": {
            "id": 1,
            "name": "Coffee Bean",
            "description": "A coffee shop",
            "companyNumber": "",
            "vatNumber": "12345",
            "imageIds": [
                "http://static.merchantstack.com/images/merchant/1/logo/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."
                },
                "203": {
                    "id": 203,
                    "code": "requestSuccessful",
                    "title": "Request Processed Successfully",
                    "details": "The request has been successfully completed."
                }
            }
        },
        "codeBaseVersion": 2,
        "executionTime_milliSeconds": 32
    }
}
X

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}
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

Success

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