Post Sale Order Return
This REST API is used to update the shipment status of sale orders returned in POS.
Tip
It is recommended to check out Notes for the reader. You might find this helpful as it contains Guidelines for using API references and Terminologies used here.
Basic Information
| NAME | DETAILS |
|---|---|
| URL: | https://< posbaseurl>/v1 |
| Endpoint: | /returns/{shippingPackage.code} |
| Request Type: | POST |
| Level: | Facility |
| Scheme: | HTTPS |
| Header (Content-Type): | application/json |
| Header (Authorization): | access-token, Eg.: bearer b30f3aea-7978-49bb-9ea7-33eddfc80afa |
Request Payload
{
"saleOrderID": "string",
"shipmentCode":"string",
"orderStatus": "RETURNED",
"trackingNumber": "string",
"shippingProviderName": "string",
"shippingCourierName" : "string",
"returnTime": "string",
"facilityCode":"Store1",
"type":"RTO"
"returnInvoiceDetails":
{
"invoiceNumber":"string",
"invoiceDate":"2017-01-02T08:12:53",
"invoiceItems":
[
"product":"string",
"description":"string",
"skuCode":"string",
"hsnCode":"string",
"quantity":"number",
"bundleSku":"string",
"orderItems": [
"orderItemId": "string",
"serialNumber","string",
"orderItemPrice": {
"cashOnDeliveryCharges": 0,
"sellingPrice": 0,
"shippingCharges": 0,
"discount": 0,
"totalPrice": 0,
"transferPrice": 0
},
"giftWrap": {
"giftWrapMessage": "string",
"giftWrapCharges": 0
},
"bundleIdentifier" :"string"
]
"taxBreakUp":[
"costHead" :"string",
"integratedGst":"number",
"unionTerritoryGst":"number",
"stateGst":"number",
"centralGst":"number",
"centralGstPercentage":"number",
"stateGstPercentage":"number",
"unionTerritoryGstPercentage:"number",
"integratedGstPercentage":"number"
]
]
}
}Response Payload Details
| LEVEL | PARAMETER | TYPE | DESCRIPTION | NOTES |
|---|---|---|---|---|
| 1 | saleOrderID | string | Sale order code | Eg: SO00937 |
| 2 | shipmentCode | string | Shipping package code | Eg: VARAAA07998 |
| 3 | orderStatus | enum | Sale order status | Eg: RETURNED |
| 4 | trackingNumber | string | Return tracking number | - |
| 5 | shippingProviderName | string | Shipping provider Name | - |
| 6 | shippingCourierName | string | Shipping courier Name | - |
| 7 | returnTime | date | Order’s shipment return date/time | Eg: 2021-08-17T14:02:42 |
| 8 | facilityCode | string | Facility ID | Eg: Delhi6 |
| 9 | type | string | RTO/CIR | - |
| 10 | returnInvoiceDetails | object | Return invoice details | - |
| 10.1 | invoiceNumber | string | Invoice code | - |
| 10.2 | invoiceDate | date | Invoice date/time | Eg: 2021-08-17T14:02:42 |
| 10.3 | invoiceItems | object | Invoice Items details | - |
| 10.3.1 | product | string | Product name | - |
| 10.3.2 | description | string | Product description | - |
| 10.3.3 | skuCode | string | Item SKU | - |
| 10.3.4 | hsnCode | string | 6 digit uniform code that classifies products worldwide | Eg: 12311625 |
| 10.3.5 | quantity | integer | quantity | - |
| 10.3.6 | bundleSku | null | - | - |
| 10.3.7 | orderItems | array | - | - |
| 10.3.7.1 | orderItemId | string | Order item id | - |
| 10.3.7.2 | serialNumber | string | Serial number | - |
| 10.3.7.3 | orderItemPrice | array | - | - |
| 10.3.7.3.1 | cashOnDeliveryCharges | number | - | - |
| 10.3.7.3.2 | sellingPrice | number | Selling Price | - |
| 10.3.7.3.3 | shippingCharges | number | Shipping charges | - |
| 10.3.7.3.4 | discount | number | discount | - |
| 10.3.7.3.5 | totalPrice | number | Total Price | - |
| 10.3.7.3.6 | transferPrice | number | Transfer Price | - |
| 10.3.7.4 | giftWrap | array | - | - |
| 10.3.7.4.1 | giftWrapMessage | null | giftWrap Message | - |
| 13.3.7.4.2 | giftWrapCharges | number | giftWrap Charges | - |
| 13.3.7.5 | bundleIdentifier | null | - | - |
| 13.3.8 | taxBreakUp | array | - | - |
| 13.3.8.1.1 | costHead | string | SELLING_PRICE | SELLINGPRICE,SHIPPINGCHARGES,GIFTWRAPCHARGES,SHIPPINGMETHODCHARGES,CASHONDELIVERY_CHARGES |
| 13.3.8.1.2 | integratedGst | number | IGST value | - |
| 13.3.8.1.3 | unionTerritoryGst | number | UT GST value | - |
| 13.3.8.1.4 | stateGst | number | State GST value | - |
| 13.3.8.1.5 | centralGst | number | Central GST value | - |
| 13.3.8.1.6 | centralGstPercentage | number | Central GST percentage | - |
| 13.3.8.1.7 | stateGstPercentage | number | State GST percentage | - |
| 13.3.8.1.8 | unionTerritoryGstPercentage | number | UT GST percentage | - |
| 13.3.8.1.9 | integratedGstPercentage | number | IGST GST percentage | - |
Response Payload
{
"successful": true,
"message": "string",
"errors": [
{
"code": 0,
"fieldName": "string",
"description": "string",
"message": "string",
"errorParams": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
}
}
],
"warnings": [
{
"code": 0,
"message": "string",
"description": "string"
}
]
}Response Payload Details
| LEVEL | PARAMETER | TYPE | DESCRIPTION | NOTES |
|---|---|---|---|---|
| 1 | successful | true | Request success status | - |
| 2 | message | string | Response message | - |
| 3 | errors | list | List of errors (if any) | - |
| 3.1 | code | number | Error code | - |
| 3.2 | fieldName | string | Field with error | - |
| 3.3 | description | string | Warning description | - |
| 3.4 | message | string | Error message | - |
| 3.5 | errorParams | object | Parameters with error | - |
| 3.5.1 | additionalProp1 | object | Parameter 1 with error | - |
| 3.5.2 | additionalProp2 | object | Parameter 2 with error | - |
| 3.5.3 | additionalProp3 | object | Parameter 3 with error | - |
| 4 | warnings | list | List of warnings (if any) | - |
| 4.1 | code | number | Warning code | - |
| 4.2 | message | string | Warning message | - |
| 4.3 | description | string | Warning description | - |
Error Codes
Refer Response Codes section to know about specific errors codes.