General

Objects

Codes

Store - POST

Create or update stores

The endpoint you need to use for this is:

/store

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: To update just supply the object id.

Key Details Data Type
stores[{objectRef}].lat Store latitude. Mandatory field Float
stores[{objectRef}].lng Store longitude. Mandatory field Float
stores[{objectRef}].addressLine1 Store address line 1. Mandatory field String
stores[{objectRef}].addressLine2 Store address line 2 String
stores[{objectRef}].addressLine3 Store address line 3 String
stores[{objectRef}].phoneNumber Store phone number. Mandatory field String
stores[{objectRef}].city City name where the store is located. Mandatory field String
stores[{objectRef}].postcode Zipcode or postcode where the store is located. Mandatory field String
stores[{objectRef}].countryId 2 Character ISO country code String
stores[{storeId}].email An email address which a customer can use to contact the store. Also enables customer receipts String
stores[{storeId}].sandbox Is the store flagged as sandbox. Boolean
stores[{objectRef}].timezoneId Please check our Timezone Id list to choose one String 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
    "stores": {
        "0": {
            "lat": 51.4769,
            "lng": -0.168871,
            "addressLine1": "Tower Bridge",
            "addressLine2": "Shad Thames",
            "addressLine3": "London",
            "phoneNumber": "0207 132 9412",
            "city": "Greater London",
            "postcode": "SE1",
            "countryId": "GB",
            "timezoneId": 371,
            "email": "store@email.com",
            "sandbox": false
        }
    }
}
X

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
stores[{objectRef}].id unique store Id int
stores[{objectRef}].lat Store latitude Float
stores[{objectRef}].lng Store longitude Float
stores[{objectRef}].addressLine1 Store address line 1 String
stores[{objectRef}].addressLine2 Store address line 2 String
stores[{objectRef}].addressLine3 Store address line 3 String
stores[{objectRef}].phoneNumber Store phone number String
stores[{objectRef}].city City name where the store is located String
stores[{objectRef}].postcode Zipcode or postcode where the store is located String
stores[{objectRef}].countryId 2 Character ISO country code String
stores[{storeId}].email An email address which a customer can use to contact the store. Also enables customer receipts String
stores[{storeId}].sandbox Is the store flagged as sandbox. Boolean
stores[{objectRef}].timezoneId Please check our Timezone Id list to choose one String 
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
36
37
38
39
{
    "stores": {
        "0": {
            "id": 1,
            "lat": 51.4769,
            "lng": -0.168871,
            "addressLine1": "Tower Bridge",
            "addressLine2": "Shad Thames",
            "addressLine3": "London",
            "phoneNumber": "0207 132 9412",
            "city": "Greater London",
            "postcode": "SE1",
            "countryId": "GB",
            "timezoneId": 371,
            "email": "store@email.com",
            "sandbox": false
        }
    },
    "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
    }
}
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}
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
preloader