Post Sale Order Dispatch
This REST API is used to update sale orders dispatched details 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: | /shipment/{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": "SO00937",
"shipmentCode": "VARAAA07998",
"orderDate": "2021-08-17T14:02:42",
"orderStatus": "COMPLETE",
"channelCode": "CUSTOM",
"paymentType": "PREPAID",
"currencyCode": "INR",
"trackingNumber": "111232232323",
"shippingProviderName": "testga",
"shippingCourierName": "TESTGA",
"dispatchTime": "2021-08-17T14:03:54",
"facilityCode": "varad",
"invoiceDetails": {
"invoiceNumber": "IRS00482",
"invoiceDate": "2021-08-17T14:03:54",
"invoiceItems": [
{
"product": "dettol1",
"description": "Dettol",
"skuCode": "dettol1",
"hsnCode": "1234567",
"quantity": "1",
"bundleSku": null,
"orderItems": [
{
"orderItemId": "SOI111",
"serialNumber": "ACB3434",
"orderItemPrice": {
"cashOnDeliveryCharges": 0,
"sellingPrice": 549,
"shippingCharges": 32.37,
"discount": 0,
"totalPrice": 549,
"transferPrice": 0
},
"giftWrap": {
"giftWrapMessage": null,
"giftWrapCharges": 0
},
"bundleIdentifier": null
}
],
"taxBreakUp": [
{
"costHead": "SELLING_PRICE",
"integratedGst": 14.24,
"unionTerritoryGst": 0,
"stateGst": 0,
"centralGst": 0,
"centralGstPercentage": 0,
"stateGstPercentage": 0,
"unionTerritoryGstPercentage": 0,
"integratedGstPercentage": 5
},
{
"costHead": "SHIPPING_CHARGES",
"integratedGst": 0.84,
"unionTerritoryGst": 0,
"stateGst": 0,
"centralGst": 0,
"centralGstPercentage": 0,
"stateGstPercentage": 0,
"unionTerritoryGstPercentage": 0,
"integratedGstPercentage": 5
}
]
}
]
},
"shippingAddress": {
"addressLine1": "Test",
"addressLine2": "address lime 2",
"city": "Delhi",
"country": "India",
"email": "test@gmail.com",
"name": "Test name",
"phone": "9809833333",
"pincode": "110001",
"state": "DL"
},
"billingAddress": {
"addressLine1": "Test",
"addressLine2": "address lime 2",
"city": "Delhi",
"country": "India",
"email": "test@gmail.com",
"name": "Test name",
"phone": "9809833333",
"pincode": "110001",
"state": "DL"
}
}
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 | orderDate | date | Order creation date/time | Eg: 2021-08-17T14:02:42 |
4 | orderStatus | enum | Sale order status | Eg: COMPLETE |
5 | channelCode | string | Channel code | - |
6 | paymentType | string | COD/Prepaid | - |
7 | currencyCode | string | Currency codes (3 digit) | Default: INR, Currency Codes Default: INR, Currency Codes |
8 | trackingNumber | string | Tracking number | - |
9 | shippingProviderName | string | Shipping provider Name | - |
10 | shippingCourierName | string | Shipping courier Name | - |
11 | dispatchTime | date | Order’s shipment dispatch date/time | Eg: 2021-08-17T14:02:42 |
12 | facilityCode | string | Facility ID | Eg: Delhi6 |
13 | invoiceDetails | object | Invoice details | - |
13.1 | invoiceNumber | string | Invoice code | - |
13.2 | invoiceDate | date | Invoice date/time | Eg: 2021-08-17T14:02:42 |
13.3 | invoiceItems | object | Invoice Items details | - |
13.3.1 | product | string | Product name | - |
13.3.2 | description | string | Product description | - |
13.3.3 | skuCode | string | Item SKU | - |
13.3.4 | hsnCode | string | 6 digit uniform code that classifies products worldwide | Eg: 12311625 |
13.3.5 | quantity | integer | quantity | - |
13.3.6 | bundleSku | null | - | - |
13.3.7 | orderItems | array | - | - |
13.3.7.1 | orderItemId | string | Order item id | - |
13.3.7.2 | serialNumber | string | Serial number | - |
13.3.7.3 | orderItemPrice | array | - | - |
13.3.7.3.1 | cashOnDeliveryCharges | number | - | - |
13.3.7.3.2 | sellingPrice | number | Selling Price | - |
13.3.7.3.3 | shippingCharges | number | Shipping charges | - |
13.3.7.3.4 | discount | number | discount | - |
13.3.7.3.5 | totalPrice | number | Total Price | - |
13.3.7.3.6 | transferPrice | number | Transfer Price | - |
13.3.7.4 | giftWrap | array | - | - |
13.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 | - |
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 | - |
13.3.8.2.1 | costHead | string | SHIPPING_CHARGES | - |
13.3.8.2.2 | integratedGst | number | IGST value | - |
13.3.8.2.3 | unionTerritoryGst | number | UT GST value | - |
13.3.8.2.4 | stateGst | number | State GST value | - |
13.3.8.2.5 | centralGst | number | Central GST value | - |
13.3.8.2.6 | centralGstPercentage | number | Central GST percentage | - |
13.3.8.2.7 | stateGstPercentage | number | State GST percentage | - |
13.3.8.2.8 | unionTerritoryGstPercentage | number | UT GST percentage | - |
13.3.8.2.9 | integratedGstPercentage | number | IGST GST percentage | - |
14 | shippingAddress | object | customer shipping address | - |
14.1 | addressLine1 | string | Precise address | - |
14.2 | addressLine2 | string | Additional address information | - |
14.3 | city | string | City name | Eg: Surat |
14.4 | country | string | Country code not name | Link to be add |
14.5 | string | Email ID | - | |
14.6 | name | string | Name | - |
14.7 | phone | string | Contact no. | - |
14.8 | pincode | string | Area pincode (min. 6 digits) | Eg: 395006 |
14.9 | state | string | State code | Link to be add |
15 | billingAddress | object | customer billing address | - |
15.1 | addressLine1 | string | Precise address | - |
15.2 | addressLine2 | string | Additional address information | - |
15.3 | city | string | City name | Eg: Surat |
15.4 | country | string | Country code not name | Country Codes |
15.5 | string | Email ID | - | |
15.6 | name | string | Name | - |
15.7 | phone | string | Contact no. | - |
15.8 | pincode | string | Area pincode (min. 6 digits) | Eg: 395006 |
15.9 | state | string | State code | State Codes |
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.