General

Objects

Codes

Stock Reconcile - POST

Stability: 2 - Stable

Send instructions to reconcile expected stock levels with actual stock levels.

This API POST call allows you to update stock reconciliation.

The endpoint you need to use for this is:

/stock/reconcile

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

NOTE: To update just supply the object id.

Key	Details	Data Type
stockReconcile.products[{productId}].productId*	Product Id	Int
stockReconcile.products[{productId}].productName*	Product Name	String
stockReconcile.products[{productId}].quantity*	Quantity In Stock	Int
stockReconcile.products[{productId}].note	Adjustment Note	String
stockReconcile.products[{productId}].price*	Adjustment Cost Price (Positive Only)	String
stockReconcile.products[{productId}].vatPercentage*	Adjustment Vat % (Positive Only)	String
stockReconcile.storeId*	Stock Store Id	Int
stockReconcile.completed	Is Complete / Time since complete	Bool / Int

* Required header

{
    "stockReconcile": {
        "products": {
            "7": {
                "productId": 7,
                "quantity": -10,
                "note": "Wastage - Items Broken"
            },
            "41": {
                "productId": 7320,
                "productName": "Coke",
                "quantity": 50,
                "note": "Surplus - Lost Invoice",
                "price": "10",
                "vatPercentage": "0.20"
            }
        },
        "storeId": "53",
        "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
baskets[{basketId}].id	unique basket Id	Int
baskets[{basketId}].storeId	Store Id	Int
baskets[{basketId}].completeDate	Complete Date	Date
baskets[{basketId}].name	Name	String
baskets[{basketId}].basketProducts[{basketProductId}].productId	Basket Product Id	Int
baskets[{basketId}].basketProducts[{basketProductId}].quantity	Basket Product Qty	Int
baskets[{basketId}].basketProducts[{basketProductId}].note	Basket Product Note	String
baskets[{basketId}].basketProducts[{basketProductId}].addedDate	Basket Product Added Date	Date
baskets[{basketId}].basketProductInstances [{basketProductInstancesId}].basketProductInstanceId	Product Instance Id	Int
baskets[{basketId}].basketProductInstances [{basketProductInstancesId}].productId	Product Id	Int
baskets[{basketId}].basketProductInstances [{basketProductInstancesId}].price	Instance Price	String
baskets[{basketId}].basketProductInstances [{basketProductInstancesId}].quantity	Instance Quantity	Int
baskets[{basketId}].basketProductInstances [{basketProductInstancesId}].note	Instance Note	String
invoices[{invoiceId}].invoiceItems[{invoiceItemId}].id	Item Id	Int
invoices[{invoiceId}].invoiceItems[{invoiceItemId}].invoiceId	InvoiceId	Int
invoices[{invoiceId}].invoiceItems[{invoiceItemId}].name	Item Name	String
invoices[{invoiceId}].invoiceItems[{invoiceItemId}].price	Item Price	String
invoices[{invoiceId}].invoiceItems[{invoiceItemId}].vatPercentage	Item Vat %	String
invoices[{invoiceId}].invoiceItems[{invoiceItemId}].quantity	Item Quantity	Int
invoices[{invoiceId}].invoiceItems[{invoiceItemId}].accountId	Item Account id	Int
invoices[{invoiceId}].invoiceItems[{invoiceItemId}].barcode	Item Barcode	String
invoices[{invoiceId}].invoiceItems[{invoiceItemId}].note	Item Note	String
invoices[{invoiceId}].invoiceItems[{invoiceItemId}].productId	Item Product Id	Int
invoices[{invoiceId}].id	Invoice Id	Int
invoices[{invoiceId}].storeId	Merchant Store Id	Int
invoices[{invoiceId}].supplierStoreId	Supplier Store Id	Int
invoices[{invoiceId}].invoiceItems[{invoiceItemId}].reference	Invoice Reference	String
invoices[{invoiceId}].invoiceItems[{invoiceItemId}].completeDate	Invoice Complete Date	Date
invoices[{invoiceId}].invoiceItems[{invoiceItemId}].note	Invoice Note	String

{
    "baskets": {
        "0": {
            "storeId": 53,
            "consumerId": null,
            "completeDate": "2015-05-01 16:32:11",
            "name": "WASTAGE",
            "id": 2236057,
            "basketProducts": {
                "7319": {
                    "productId": 7319,
                    "quantity": 10,
                    "note": "Wastage - Items Broken",
                    "addedDate": "2015-05-01 16:32:11"
                }
            },
            "basketProductInstances": {
                "7319": {
                    "basketProductInstanceId": 5394383,
                    "productId": "7319",
                    "price": null,
                    "quantity": 10,
                    "note": "Wastage - Items Broken"
                }
            }
        }
    },
    "invoices": {
        "0": {
            "invoiceItems": {
                "0": {
                    "invoiceId": 796,
                    "name": "Coke",
                    "price": "10",
                    "vatPercentage": "0.20",
                    "quantity": 50,
                    "accountId": 80,
                    "barcode": null,
                    "note": "Surplus - Lost Invoice",
                    "id": 4680,
                    "productId": 7320
                }
            },
            "id": 796,
            "storeId": "53",
            "supplierStoreId": "53",
            "reference": null,
            "completeDate": "2015-05-01 16:37:45",
            "note": "RECONCILE INCREMENT"
        }
    },
    "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": 1776
    }
}

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