Route Return
For saving the products returned from customers
URL
sales/route_return
Method
POST
Request Media type
application/json
Response Media type
application/json
Request Parameters
| Parameter | Data Type | Min | Max | M/O | Sample Value | Comments |
|---|---|---|---|---|---|---|
| key | String | 32 | 32 | M | BX5far3A3lfkjmXqYn9biQTxnySCjPGP | Key obtained from authentiaction. |
| gp_fyear | String | 4 | 15 | M | 4_19 | The response from Route Details |
| custcode | Integer | 1 | 99999 | M | 359 | Customer code from Route Customers |
| items | Array | M | details of the items returned from customers | |||
| itemcode | Integer | 1 | 9999 | M | 1 | Itemcode from Route Products |
| qty | Decimal | 1 | 9999 | M | 2 | Quantity enterde by user |
| expdate | String | 10 | 10 | M | 2020-11-03 | Expiry date of returned item in YYYY-MM-DD format |
| datetime | String | M | 2020-11-03 13:08:05 | Date time in Y-m-d H:i:s (PHP) format. | ||
| uid | String | 1 | 32 | M | d2974959e7bd40fd94269de2794ea70d | Unique ID |
Response Values
| Name | Data Type | Min Length | Max Length | M/O | Sample Value | Comments |
|---|---|---|---|---|---|---|
| status | String | 1 | 100 | M | Saved | |
| slno | Integer | M | 1 | |||
| uid | String | 1 | 32 | M | d2974959e7bd40fd94269de2794ea70d | The unique ID sent. |
Sample Request
{
"key": "QH7LlQ3wQMK9oYEKjeG5QOIVJQT4emeq",
"gp_fyear": "4_19",
"custcode": "359",
"items": [
{
"itemcode": "1",
"qty": "2",
"expdate": "2020-11-03"
}
],
"datetime": "2020-11-03 13:08:05",
"uid": "d2974959e7bd40fd94269de2794ea70d"
}Sample Success Response
{
"status": "Saved",
"slno": "1",
"uid": "d2974959e7bd40fd94269de2794ea70d",
"e": 200,
"msg": "Success"
}Sample Failure Responses
{
"e": 400,
"msg": "Bad Request."
}
{
"e": 401,
"msg": "Invalid authentication credentials."
}