General

Objects

Codes

Store GET

Stability: 3 - Frozen

Get store details

The endpoint you need to use for this is:

/store

Request

Headers

Key	Details	Example
Authorization*	{token_type} {access_token}	Bearer c3499c2729730a7f807efb8676a92dcb6f8a3f8f
Method*	GET	GET
x-accept-version	{recommended_latest_version_number}	2
storeIds	{optional_comma_separated_storeIds }	1,2,3

* 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
stores[{storeId}].id	unique store Id	int
stores[{storeId}].lat	Store latitude	Float
stores[{storeId}].lng	Store longitude	Float
stores[{storeId}].addressLine1	Store address line 1	String
stores[{storeId}].addressLine2	Store address line 2	String
stores[{storeId}].addressLine3	Store address line 3	String
stores[{storeId}].phoneNumber	Store phone number	String
stores[{storeId}].city	City name where the store is located	String
stores[{storeId}].postcode	Zipcode or postcode where the store is located	String
stores[{storeId}].countryId	2 Character ISO country code	String
stores[{storeId}].timezoneId	Please check our Timezone Id list to choose one	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[{storeId}].storeDeleteDate	If it is null then the store is not deleted. If you find a date then the store is deleted.	DateTime

{
    "stores": {
        "1": {
            "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,
            "storeDeleteDate": null,
            "email": "store@email.com",
            "sandbox": false
        },
        "2": {
            "id": 2,
            "lat": 51.5145,
            "lng": -0.151856,
            "addressLine1": "14 Field Close",
            "addressLine2": "The Pantry",
            "addressLine3": "",
            "phoneNumber": "0207 214 9231",
            "city": "London",
            "postcode": "",
            "countryId": "GB",
            "timezoneId": 371,
            "storeDeleteDate": null,
            "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."
                },
                "203": {
                    "id": 203,
                    "code": "requestSuccessful",
                    "title": "Request Processed Successfully",
                    "details": "The request has been successfully completed."
                }
            }
        },
        "codeBaseVersion": 2,
        "executionTime_milliSeconds": 190
    }
}

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.

Request
- Headers
Response
- Headers
- Body
Status Codes
- Error
- Success
Top