General

Objects

Codes

Application - GET

Stability: 2 - Stable

Helps to get all your application information.

/application

Request

Headers

Key	Details	Example
Authorization*	{token_type} {access_token}	Bearer c3499c2729730a7f807efb8676a92dcb6f8a3f8f
Method*	GET	GET
x-accept-version	{recommended_latest_version_number}	2
applicationIds	{comma_separated_applicationId}	1,2,4 //Returns all if not supplied

* 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
applications[{applicationId}].applicationId	Unique identifier for an application.	int
applications[{applicationId}].identifier	An encrypted 40 random characters key to uniquely identify your application.	string
applications[{applicationId}].secret	An encrypted 40 random characters secret key used only in token post call.	string
applications[{applicationId}].applicationName	Name of the application	string
applications[{applicationId}].applicationDesc	Description of the application	string
applications[{applicationId}].url	Valid redirect urls, Index 0 is Live URL, Index 1 is Staging URL and Index 2 is development URL.	array
applications[{applicationId}].approvedDate	Description of the application	datetime
applications[{applicationId}].trustedPartner	Set to 1 or 0 by shopwave server. Only Merchant application will be approved as trustedPartner. If set 1 the application will skip access grant check.	tinyint
applications[{applicationId}].sandbox	Set to 1 or 0. If set 1 the application will be in sandbox mode and display all developer based error messages in our secure area. If set 0 the application will be ready for live and once reviewed it can go live on our WaveStore	tinyint
applications[{applicationId}].logoIds	Array of application logo urls	array
applications[{applicationId}].imageIds	Array of application screen shots and image urls	array

{
    "applications": {
        "2": {
            "applicationId": 2,
            "identifier": "932ef614dbfb31ccfe129f29e9ce03732cfcc0ec",
            "secret": "1cede75aba205077387d33483c1aafe71b739fc7",
            "applicationName": "Application Name 1",
            "applicationDesc": "Test desc",
            "url": [
                "http://appLiveUrl.com",
                "http://appStagingUrl.com",
                "http://appDevUrl.com"
            ],
            "approvedDate": "2013-05-28T14:15:23.000Z",
            "trustedPartner": 0,
            "sandbox": 0,
            "logoIds": [
                "http://static.merchantstack.com/images/application/images/d1b1e48e8928f44f917a1f91ae2476094a9cfc6e.jpg"
            ],
            "imageIds": [
                "http://static.merchantstack.com/images/application/images/6cc06cf0be696d2342d974cda15ec108a92db911.jpg",
                "http://static.merchantstack.com/images/application/images/5973a4edf7d1d20945430f271d7a377a623d77bc.jpg"
            ]
        },
        "3": {
            "applicationId": 3,
            "identifier": "612be614c84ffc80b2c514f6ce8f562a3c98202f",
            "secret": "cea877e308225c11a0cfda747f1618e3b7f27353",
            "applicationName": "Application Name 2",
            "applicationDesc": "Test desc",
            "url": [
                "http://appLiveUrl.com",
                "http://appStagingUrl.com",
                "http://appDevUrl.com"
            ],
            "approvedDate": "2013-08-05T23:00:00.000Z",
            "trustedPartner": 1,
            "sandbox": 1
        }
    },
    "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": 182
    }
}

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}
899	500	Unknown Error	Something went wrong. Please contact the site administrator

Success

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

ID	Status Code	Title	Details
203	200	Request Processed Successfully	The request has been successfully completed.
202	200	Token is valid	Token is validated and found valid.
204	204	No content to return	End of the page or no content to return for your request

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