General

Objects

Codes

Order - POST

Stability: 2 - Stable

Once a basket has been completed an order can be attached to specify delivery of its contents.

The endpoint you need to use for this is:

/order

Request

Headers

Key	Details	Example
Authorization*	{token_type} {access_token}	Bearer c3499c2729730a7f807efb8676a92dcb6f8a3f8f
Method*	POST	N/A
x-accept-version	{recommended_latest_version_number}	2

* Required header

Body

Key	Details	Data Type
order[{orderId}].id*	unique order Id	Int
order[{orderId}].completed	Is Complete / Time since complete	Bool / Int

* Required attributes

{
    "orders": {
        "0": {
            "id": 140397,
            "completed": true
        },
        "1": {
            "id": 140404,
            "completed": true
        },
        "2": {
            "id": 199133,
            "completed": true
        },
        "3": {
            "id": 1404,
            "completed": true
        }
    }
}

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
order[{orderId}].id	unique order Id	Int
order[{orderId}].completeDate	Complete Date	Date

{
    "orders": {
        "2": {
            "id": 199133,
            "completeDate": "2018-01-12 23:00:16"
        }
    },
    "api": {
        "message": {
            "success": {
                "202": {
                    "id": 202,
                    "title": "Token is valid",
                    "details": "Token is validated and found valid."
                },
                "206": {
                    "id": 206,
                    "title": "Resource Created",
                    "details": "Your resource is created partially or fully. Please check further message or process log"
                }
            }
        },
        "codeBaseVersion": 2,
        "executionTime_milliSeconds": 51
    }
}

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

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