General

Objects

Codes

Stock Reconcile - GET

Stability: 2 - Stable

This API GET call allows you to get wastage and surplus stock reconciliations.

The endpoint you need to use for this is:

/stock/reconcile

Request

Headers

Key	Details	Example
Authorization*	{token_type} {access_token}	Bearer c3499c2729730a7f807efb8676a92dcb6f8a3f8f
Method*	GET	N/A
from*	{from_date}	2015-01-01 00:00:00
to*	{to_date}	2015-05-01 00:00:00
storeIds*	{storeIds}	53,54,55
x-accept-version	{recommended_latest_version_number}	2

* Required header

Response

Headers

Key	Details	Data Type	Example
statusCode	Very important to check this for any error. 200 for success.	int	201

Body

Key	Details	Data Type
stockReconcile.wastage[{basketProductInstanceId}].name	Name of the basket usually stored as WASTAGE in our system	String
stockReconcile.wastage[{basketProductInstanceId}].storeId	Store id of a wasted basket	int
stockReconcile.wastage[{basketProductInstanceId}].completedDate	completed Date of the wasted basket	String
stockReconcile.wastage[{basketProductInstanceId}].productId	Productid which is wasted	int
stockReconcile.wastage[{basketProductInstanceId}].vatPercentage	productsInstance Vat percentage at the time of wasted	String
stockReconcile.wastage[{basketProductInstanceId}].productInstancePrice	productsInstance price at the time of wasted	String
stockReconcile.wastage[{basketProductInstanceId}].productModifiedPrice	productsInstance modified if modified by the employee	String
stockReconcile.wastage[{basketProductInstanceId}].id	basketProductInstanceId	int
stockReconcile.wastage[{basketProductInstanceId}].qunatity	no. of quantities wasted	int
stockReconcile.surplus[{invoiceItemId}].invoiceItemId	invoiceItemId	int
stockReconcile.surplus[{invoiceItemId}].storeId	Store id	int
stockReconcile.surplus[{invoiceItemId}].completedDate	completed Date of the surplus invoice	String
stockReconcile.surplus[{invoiceItemId}].productId	Product id which is added as surplus	int
stockReconcile.surplus[{invoiceItemId}].vatPercentage	productsInstance Vat percentage at the time of surplus found	String
stockReconcile.surplus[{invoiceItemId}].price	price at the time of incremented	String
stockReconcile.surplus[{invoiceItemId}].qunatity	no. of quantities in surplus	int
stockReconcile.surplus[{invoiceItemId}].note	usually stored as RECONCILE INCREMENT in our system	string

{
    "stockReconcile": {
        "wastage": {
            "4210609": {
                "name": "WASTAGE",
                "storeId": 53,
                "completeDate": "2015-01-27T10:56:58.000Z",
                "productId": 7319,
                "vatPercentage": "0",
                "productInstancePrice": "300",
                "productModifiedPrice": null,
                "id": 4210609,
                "quantity": -15
            },
            "4830728": {
                "name": "WASTAGE",
                "storeId": 53,
                "completeDate": "2015-03-19T18:23:09.000Z",
                "productId": 7319,
                "vatPercentage": "0",
                "productInstancePrice": "300",
                "productModifiedPrice": null,
                "id": 4830728,
                "quantity": -6
            }
        },
        "surplus": {
            "4559": {
                "invoiceItemId": 4559,
                "productId": 1,
                "storeId": 53,
                "quantity": 100,
                "price": 100,
                "vatPercentage": 0,
                "note": "RECONCILE INCREMENT"
            },
            "4560": {
                "invoiceItemId": 4560,
                "productId": 7319,
                "storeId": 53,
                "quantity": 166,
                "price": 200,
                "vatPercentage": 0,
                "note": "RECONCILE INCREMENT"
            }
        }
    },
    "api": {
        "message": {
            "success": {
                "202": {
                    "id": 202,
                    "title": "Token is valid",
                    "details": "Token is validated and found valid."
                },
                "203": {
                    "id": 203,
                    "title": "Request Processed Successfully",
                    "details": "The request has been successfully completed."
                }
            }
        },
        "codeBaseVersion": 2,
        "executionTime_milliSeconds": 228
    }
}

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}
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.
203	200	Request Processed Successfully	The request has been successfully completed.

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