General

Objects

Codes

Application - POST

Stability: 2 - Stable

Helps to create or update an application.

The endpoint you need to use for this is:

/application

Request

Headers

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

* Required header

Body

NOTE: To update just supply the object id.

Key	Details	Data Type
applications[{objectRef}].name	Just a name of an application	string
applications[{objectRef}].description	A short description of what your app do.	string
applications[{objectRef}].url	redirect_url for your application. If it is a mobile application, you can provide url scheme. Your authorisation_code will be return as {redirect_url}?code={authorisation_code}. You can supply multiple address for different environment simply by comma separating. And your live url should be the first in the comma separated list.	string
applications[{objectRef}].sandbox	Set 1 for sandbox mode or 0 for live. If sandbox is set to 1 all the developer errors will get displayed in our secure area. We recommend you to set it to 0 when you go live so you stop your customers see any developer errors in our page.	tinyint

{
    "applications": {
        "0": {
            "name": "Ace Accounting",
            "description": "An accounting software which takes care of your HMRC returns.",
            "url": "http://aceaccounting.com/callback, http://staging.aceaccounting.com/callback, http://local.aceaccounting.com/callback",
            "sandbox": 1
        }
    }
}

//Applications is the object which should one or more application object
//Object reference for each application object. If there is an error check objectRef in API message.
//Name of the application
//Description of the application
//redirect_url
//Set sandbox mode

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
applications[{objectRef}].id	Unique ID for an application. Supply ID in the request post body to update.	int
applications[{objectRef}].identifier	Application identifier created by our system that you need to use when you connect with shopwave.	string
applications[{objectRef}].secret	Application Secret created by our system that you need to use when you connect with shopwave.	string
applications[{objectRef}].name	Just a name of an application	string
applications[{objectRef}].description	A short description of what your app do.	string
applications[{objectRef}].url	redirect_url for your application. If it is a mobile application, you can provide url scheme. Your authorisation_code will be return as {redirect_url}?code={authorisation_code}. You can supply multiple address for different environment simply by comma separating. And your live url should be the first in the comma separated list.	string
applications[{objectRef}].sandbox	Set 1 for sandbox mode or 0 for live. If sandbox is set to 1 all the developer errors will get displayed in our secure area. We recommend you to set it to 0 when you go live so you stop your customers see any developer errors in our page.	tinyint

{
    "applications": {
        "0": {
            "id": 2,
            "identifier": "bf4003228076bec022ab82cde8f5efe1d39a4a32",
            "secret": "474d5494f4bd8eb71c3b70aa3578a6629e7b5e94",
            "name": "Ace Accounting",
            "description": "An accounting software which takes care of your tax returns.",
            "url": "http://aceaccounting.com/callback, http://staging.aceaccounting.com/callback, http://local.aceaccounting.com/callback",
            "sandbox": 1
        }
    },
    "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": 29
    }
}

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}
910	404	Not Found	The resource you are looking for does not exist
899	500	Unknown Error	Something went wrong. Please contact the site administrator
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
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.

Success

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

ID	Status Code	Title	Details
206	201	Resource Created	Your resource is created partially or fully. Please check further message or process log
202	200	Token is valid	Token is validated and found valid.

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