Get Sale Order
This REST API is used to fetch sale order details from Uniware using sale order code and facility code (optional).
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 |
|---|---|
| Endpoint: | /services/rest/v1/oms/saleorder/get |
| Request Type: | POST |
| Level: | Tenant |
| Scheme: | HTTPS |
| Header (Content-Type): | application/json |
| Header (Authorization): | bearer {access-token}, Eg.: bearer b30f3aea-7978-49bb-9ea7-33eddfc80afa |
Request Payload
{
"code": "string",
"facilityCodes": [
"string"
],
"paymentDetailRequired": true
}Request Payload Details
| LEVEL | PARAMETER | TYPE | DESCRIPTION | MANDATORY | NOTES |
|---|---|---|---|---|---|
| 1 | code | string | Sale order code | Yes | - |
| 2 | facilityCodes | list | List of facility codes | No | - |
| 3 | paymentDetailRequired | boolean | true - if payment transaction detail required | No | - |
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"
}
],
"saleOrderDTO": {
"code": "SO1016233",
"displayOrderCode": "Sushant1",
"channel": "CUSTOM",
"source": "CUSTOM",
"displayOrderDateTime": 1598293800000,
"channelProcessingTime": 1688547060000,
"status": "PROCESSING",
"created": 1598335400000,
"updated": 1598335500000,
"fulfillmentTat": 1598335500000,
"notificationEmail": "abc@gmail.com",
"notificationMobile": "9999999999",
"customerGSTIN": null,
"cod": false,
"thirdPartyShipping": false,
"priority": 0,
"currencyCode": "INR",
"customerCode": "sushant",
"billingAddress": {
"id": "305034",
"name": "Sushant",
"addressLine1": "Second floor Laxmi Nagar",
"addressLine2": "",
"city": "New Delhi",
"state": "DL",
"country": "IN",
"pincode": "110092",
"phone": "12345678",
"email": abc@gmail.com,
"type": null
},
"addresses": [
{
"id": "305034",
"name": "Sushant",
"addressLine1": "Second floor Laxmi Nagar",
"addressLine2": "",
"city": "New Delhi",
"state": "DL",
"country": "IN",
"pincode": "110092",
"phone": "12345678",
"email": abc@gmail.com,
"type": null
},
{
"id": "305033",
"name": "Sushant",
"addressLine1": "Lajpat Nagar",
"addressLine2": "xyz",
"city": "New Delhi",
"state": "DL",
"country": "IN",
"pincode": "110024",
"phone": "123456789",
"email": abc@gmail.com,
"type": null
}
],
"shippingPackages": [
{
"code": "03P1008221",
"saleOrderCode": "SO1016233",
"channel": "CUSTOM",
"status": "CREATED",
"shippingPackageType": "124",
"shippingProvider": null,
"shippingMethod": "Standard-Prepaid",
"trackingNumber": null,
"trackingStatus": null,
"trackingLink": "abc",
"courierStatus": null,
"estimatedWeight": null,
"actualWeight": null,
"customer": "sushant",
"created": 1598335501000,
"updated": 1598335500000,
"dispatched": null,
"delivered": null,
"invoice": 0,
"invoiceCode": null,
"invoiceDisplayCode": null,
"noOfItems": 2,
"city": "tikh",
"collectableAmount": 200,
"collectedAmount": null,
"paymentReconciled": false,
"podCode": null,
"shippingManifestCode": null,
"items": {
"itemCode": {
"itemSku": "sushant183",
"itemName": "sushant183",
"itemTypeImageUrl": null,
"itemTypePageUrl": null,
"quantity": 2
}
},
"customFieldValues": [],
"shippingLabelLink": null
}
],
"saleOrderItems": [
{
"id": 488290,
"shippingPackageCode": "03P1008221",
"shippingPackageStatus": "CREATED",
"facilityCode": "03",
"facilityName": "mumbai",
"alternateFacilityCode": null,
"reversePickupCode": null,
"shippingAddressId": 305033,
"packetNumber": 0,
"combinationIdentifier": null,
"combinationDescription": null,
"type": "NORMAL",
"item": null,
"shippingMethodCode": "STD",
"itemName": "sushant183",
"itemSku": "sushant183",
"sellerSkuCode": "sushant183",
"channelProductId": "sushant183",
"imageUrl": null,
"statusCode": "FULFILLABLE",
"code": "sushant183-0",
"shelfCode": "SSS1",
"totalPrice": 100,
"sellingPrice": 100,
"shippingCharges": 0,
"shippingMethodCharges": 0,
"cashOnDeliveryCharges": 0,
"prepaidAmount": 0,
"voucherCode": null,
"voucherValue": 0,
"storeCredit": 0,
"discount": 0,
"giftWrap": null,
"giftWrapCharges": 0,
"taxPercentage": null,
"giftMessage": null,
"cancellable": true,
"editAddress": true,
"reversePickable": false,
"packetConfigurable": false,
"created": 1598335400000,
"updated": 1598335500000,
"onHold": false,
"saleOrderItemAlternateId": null,
"cancellationReason": null,
"pageUrl": null,
"color": null,
"brand": null,
"size": null,
"replacementSaleOrderCode": null,
"bundleSkuCode": null,
"customFieldValues": [],
"itemDetailFieldDTOList": [],
"hsnCode": "12311625",
"totalIntegratedGst": 0,
"integratedGstPercentage": 0,
"totalUnionTerritoryGst": 0,
"unionTerritoryGstPercentage": 0,
"totalStateGst": 0,
"stateGstPercentage": 0,
"totalCentralGst": 0,
"centralGstPercentage": 0,
"maxRetailPrice": 100,
"itemDetailFields": {
"itemSealId": "124"
}
},
{
"id": 488291,
"shippingPackageCode": "03P1008221",
"shippingPackageStatus": "CREATED",
"facilityCode": "03",
"facilityName": "mumbai",
"alternateFacilityCode": null,
"reversePickupCode": null,
"shippingAddressId": 305033,
"packetNumber": 0,
"combinationIdentifier": null,
"combinationDescription": null,
"type": "NORMAL",
"item": null,
"shippingMethodCode": "STD",
"itemName": "sushant183",
"itemSku": "sushant183",
"sellerSkuCode": "sushant183",
"channelProductId": "sushant183",
"imageUrl": null,
"statusCode": "FULFILLABLE",
"code": "sushant183-1",
"shelfCode": "SSS1",
"totalPrice": 100,
"sellingPrice": 100,
"shippingCharges": 0,
"shippingMethodCharges": 0,
"cashOnDeliveryCharges": 0,
"prepaidAmount": 0,
"voucherCode": null,
"voucherValue": 0,
"storeCredit": 0,
"discount": 0,
"giftWrap": null,
"giftWrapCharges": 0,
"taxPercentage": null,
"giftMessage": null,
"cancellable": true,
"editAddress": true,
"reversePickable": false,
"packetConfigurable": false,
"created": 1598335400000,
"updated": 1598335500000,
"onHold": false,
"saleOrderItemAlternateId": null,
"cancellationReason": null,
"pageUrl": null,
"color": null,
"brand": null,
"size": null,
"replacementSaleOrderCode": null,
"bundleSkuCode": null,
"customFieldValues": [],
"itemDetailFieldDTOList": [],
"hsnCode": "12311625",
"totalIntegratedGst": 0,
"integratedGstPercentage": 0,
"totalUnionTerritoryGst": 0,
"unionTerritoryGstPercentage": 0,
"totalStateGst": 0,
"stateGstPercentage": 0,
"totalCentralGst": 0,
"centralGstPercentage": 0,
"maxRetailPrice": 100,
"itemDetailFields": {
"itemSealId": "125",
"SerialNumber": "2dd2d2",
"Imei": "2dd2d2"
},
"itemDetailsKey": "itemSealId,SerialNumber,Imei",
},
],
"returns": [],
"customFieldValues": [],
"cancellable": true,
"reversePickable": false,
"packetConfigurable": false,
"cFormProvided": false,
"totalDiscount": null,
"totalShippingCharges": null,
"additionalInfo": null,
"paymentDetail":{
"paymentMode":null,
"transactionId":null,
"amountPaid":1000.00
}
},
"failedOrderFetch": true,
"refreshEnabled": true
}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 | Error 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 | - |
| 5 | saleOrderDTO | object | Sale order details | - |
| 5.1 | code | string | Sale order code | Eg: SO1016233 |
| 5.2 | displayOrderCode | string | Order code to be displayed | - |
| 5.3 | channel | string | Channel code | - |
| 5.4 | source | string | Source code | - |
| 5.5 | displayOrderDateTime | date | Order date to be displayed | - |
| 5.6 | status | enum | Sale order status | Allowable: PENDING_VERIFICATION, CANCELLED, CREATED, PROCESSING, COMPLETE |
| 5.7 | created | date | Creation date | Eg: 1593590417000 |
| 5.8 | updated | date | Updation Date | Eg: 1593590731000 |
| 5.9 | fulfillmentTat | date | fulfillmentTat Date | Eg: 1633772460000 |
| 5.10 | notificationEmail | string | Email for notifications | Eg: user@example.com |
| 5.11 | notificationMobile | string | Mobile for notifications | - |
| 5.12 | customerGSTIN | string | Customer GST No. | - |
| 5.13 | cod | boolean | true if COD | - |
| 5.14 | thirdPartyShipping | boolean | true if the shipping to end customer is taken care by the Marketplace. false for self shipping | - |
| 5.15 | priority | integer | Order fullfillment priority | - |
| 5.16 | currencyCode | string | Currency codes (3 digit) | Default: INR, Currency Codes |
| 5.17 | customerCode | string | Customer code | - |
| 5.18 | billingAddress | object | Billing address details | - |
| 5.18.1 | id | string | Address ID | - |
| 5.18.2 | name | string | Name | - |
| 5.18.3 | addressLine1 | string | Precise address | - |
| 5.18.4 | addressLine2 | string | Additional address information | - |
| 5.18.5 | city | string | City name | Eg: Surat |
| 5.18.6 | state | string | State code | State Codes |
| 5.18.7 | country | string | Country code not name | Country Codes |
| 5.18.8 | pincode | string | Area pincode (min. 6 digits) | Eg: 395006 |
| 5.18.9 | phone | string | Contact no. | - |
| 5.18.10 | string | Email ID | - | |
| 5.18.11 | type | string | - | - |
| 5.19 | addresses | list | List of customer addresses | - |
| 5.19.1 | id | string | Address ID | - |
| 5.19.2 | name | string | Name | - |
| 5.19.3 | addressLine1 | string | Precise address | - |
| 5.19.4 | addressLine2 | string | Additional address information | - |
| 5.19.5 | city | string | City name | Eg: Surat |
| 5.19.6 | state | string | State code | State Codes |
| 5.19.7 | country | string | Country code not name | Country Codes |
| 5.19.8 | pincode | string | Area pincode (min. 6 digits) | Eg: 395006 |
| 5.19.9 | phone | string | Contact no. | - |
| 5.19.10 | string | Email ID | - | |
| 5.19.11 | type | string | - | - |
| 5.20 | shippingPackages | list | List of shipping packages | - |
| 5.20.1 | code | string | Shipping package code | Eg: 03P1008221 |
| 5.20.2 | saleOrderCode | string | Sale order code | - |
| 5.20.3 | channel | string | Channel name | - |
| 5.20.4 | status | enum | Sale order status | Allowable: PENDING_VERIFICATION, CANCELLED, CREATED, PROCESSING, COMPLETE |
| 5.20.5 | shippingPackageType | string | Shipping package type | - |
| 5.20.6 | shippingProvider | string | Shipping provider | - |
| 5.20.7 | shippingMethod | string | Shipping method | - |
| 5.20.8 | trackingNumber | string | Tracking number | - |
| 5.20.9 | trackingStatus | string | Tracking status | - |
| 5.20.10 | trackingLink | string | Tracking Link | - |
| 5.20.11 | courierStatus | string | Courier status | - |
| 5.20.12 | estimatedWeight | number | Estimated weight (in gm) | - |
| 5.20.13 | actualWeight | number | Actual weight | - |
| 5.20.14 | customer | string | Customer name | - |
| 5.20.15 | created | date | Creation date | Eg: 1593590417000 |
| 5.20.16 | updated | date | Updation Date | Eg: 1593590731000 |
| 5.20.17 | dispatched | date | Dispatch date | - |
| 5.20.18 | delivered | date | Delivery date | - |
| 5.20.19 | invoice | object | Invoice resource details | - |
| 5.20.20 | invoiceCode | string | Invoice code | - |
| 5.20.21 | invoiceDisplayCode | string | Invoice display code | - |
| 5.20.22 | noOfItems | integer | No. of items | - |
| 5.20.23 | city | string | City name | Eg: Surat |
| 5.20.24 | collectableAmount | number | Amount to be collected at time of delivery | 0.00 for Prepaid mode |
| 5.12.25 | collectedAmount | number | Prepaid amount | Default: 0 |
| 5.20.26 | paymentReconciled | boolean | Payment reconciled | Default: false |
| 5.20.27 | podCode | string | - | - |
| 5.20.28 | shippingManifestCode | string | Shipping manifest code | - |
| 5.20.29 | items | array | Details of items | - |
| 5.20.29.1 | itemCode | array | Details of items in shipping package | sushant183 |
| 5.20.29.1.1 | itemSku | string | Item SKU | - |
| 5.20.29.1.2 | itemName | string | Item name | - |
| 5.20.29.1.3 | itemTypeImageUrl | string | Item type image URL | - |
| 5.20.29.1.4 | itemTypePageUrl | string | Item type page URL | - |
| 5.20.29.1.5 | quantity | integer | Quantity | - |
| 5.20.30 | customFieldValues | list | List of custom fields | - |
| 5.20.31 | shippingLabelLink | string | Shipping label link | - |
| 5.21 | saleOrderItems | list | Details of items in sale order | - |
| 5.21.1 | id | string | ID | - |
| 5.21.2 | shippingPackageCode | string | Shipping package code | - |
| 5.21.3 | shippingPackageStatus | string | Shipping package status | |
| 5.21.4 | facilityCode | string | Facility ID | Eg.: Delhi6 |
| 5.21.5 | facilityName | string | Facility name | - |
| 5.21.6 | alternateFacilityCode | string | Alternate facility code | - |
| 5.21.7 | reversePickupCode | string | Reverse pick-up code | - |
| 5.21.8 | shippingAddressId | string | Shipping address ID | Eg: 305033 |
| 5.21.9 | packetNumber | integer | No. of parcels in which the order has to be processed | - |
| 5.21.10 | combinationIdentifier | string | Combination identifier | - |
| 5.21.11 | combinationDescription | string | Combination description | Max. chars: 200 |
| 5.21.12 | type | string | - | Eg: NORMAL |
| 5.21.13 | item | null | - | - |
| 5.21.14 | shippingMethodCode | string | The shipping method of the order | Allowable: STD (Standard), EXP (Express), PKP (Pickup), CHQ (Standard Cheque) |
| 5.21.15 | itemName | string | Item name | - |
| 5.21.16 | itemSku | string | Item SKU | - |
| 5.21.17 | sellerSkuCode | string | Seller SKU code | - |
| 5.21.18 | channelProductId | string | Channel product ID | - |
| 5.21.19 | imageUrl | string | Image URL | - |
| 5.21.20 | statusCode | enum | Item status code | Allowable: CANCELLED, FULFILLABLE, CREATED, PROCESSING, PACKED, READY_TO_DISPATCH, DISPATCHED, DELIVERED, REPLACED, RETURN_REQUESTED, COURIER_RETURN, RETURNED |
| 5.21.21 | code | string | Code | - |
| 5.21.22 | shelfCode | string | Shelf code | Eg: S001 |
| 5.21.23 | totalPrice | number | Total price | - |
| 5.21.24 | sellingPrice | number | Selling price | - |
| 5.21.25 | shippingCharges | number | Shipping charges | - |
| 5.21.26 | shippingMethodCharges | number | Shipping charges | - |
| 5.21.27 | cashOnDeliveryCharges | number | COD charges | - |
| 5.21.28 | prepaidAmount | number | Amount paid while ordering | - |
| 5.21.29 | voucherCode | string | Voucher code | - |
| 5.21.30 | voucherValue | number | Voucher value | - |
| 5.21.31 | storeCredit | number | Store credit | - |
| 5.21.32 | discount | number | Discount amount | - |
| 5.21.33 | giftWrap | boolean | true for gift wrap | - |
| 5.21.34 | giftWrapCharges | number | Extra charges for the wrap | - |
| 5.21.35 | taxPercentage | number | Tax percentage | Default: 0 |
| 5.21.36 | giftMessage | string | Message on gift | - |
| 5.21.37 | cancellable | boolean | true if cancellable | Default: true |
| 5.21.38 | editAddress | boolean | - | Default: true |
| 5.21.39 | reversePickable | boolean | true if reverse pickable | - |
| 5.21.40 | packetConfigurable | boolean | TRUE is packet is configurable | - |
| 5.21.41 | created | date | Creation date | Eg: 1593590417000 |
| 5.21.42 | updated | date | Updation Date | Eg: 1593590731000 |
| 5.21.43 | onHold | boolean | true if onHold | - |
| 5.21.44 | saleOrderItemAlternateId | string | Alternate ID of a saleorder item | - |
| 5.21.45 | cancellationReason | string | Reason for cancellation | Max chars: 100 |
| 5.21.46 | pageUrl | null | Page URL | - |
| 5.21.47 | color | string | Color description | - |
| 5.21.48 | brand | string | Brand of the item | Eg: Bombay Dyeing |
| 5.21.49 | size | string | Size | Format: LxBxH, Unit: mm, Eg: 60.00X40.00X2.00 |
| 5.21.50 | replacementSaleOrderCode | string | Replacement Saleorder code | - |
| 5.21.51 | bundleSkuCode | string | SKU code for bundle | - |
| 5.21.52 | customFieldValues | list | List of custom fields | - |
| 5.21.53 | itemDetailFieldDTOList | list | - | imei or IMEI or serialNumber or Serial Number |
| 5.21.54 | hsnCode | string | 6 digit uniform code that classifies products worldwide | Eg: 12311625 |
| 5.21.55 | totalIntegratedGst | number | Total IGST | - |
| 5.21.56 | integratedGstPercentage | number | IGST percentage | - |
| 5.21.57 | totalUnionTerritoryGst | number | Total UT GST | - |
| 5.21.58 | unionTerritoryGstPercentage | number | UT GST percentage | - |
| 5.21.59 | totalStateGst | number | Total SGST | - |
| 5.21.60 | stateGstPercentage | number | State GST percentage | - |
| 5.21.61 | totalCentralGst | number | Total CGST | - |
| 5.21.62 | centralGstPercentage | number | Central GST percentage | - |
| 5.21.63 | maxRetailPrice | number | Max. retail price | - |
| 5.21.64 | itemDetailFields | List | Item specific detail like IMEI or Serial Number or item Seal Id | If present with orderitem |
| 5.21.64.1 | itemSealId | string | item Seal Id | - |
| 5.21.64.1 | SerialNumber | string | SerialNumber | - |
| 5.21.64.1 | Imei | string | Imei | - |
| 5.33 | itemDetailsKey | string | comma seperated nudge e.g. itemSealId,SerialNumber,Imei | - |
| 5.22 | returns | list | List of returned items | - |
| 5.23 | customFieldValues | list | List of custom fields | - |
| 5.24 | cancellable | boolean | true if cancellable | Default: true |
| 5.25 | reversePickable | boolean | true if reverse pickable | - |
| 5.26 | packetConfigurable | boolean | TRUE is packet is configurable | - |
| 5.27 | cFormProvided | boolean | Pre-GST configuration | Fixed: false |
| 5.28 | totalDiscount | number | Discount amount | - |
| 5.29 | totalShippingCharges | number | Shipping charges | - |
| 5.30 | additionalInfo | string | Any additional information | - |
| 5.31 | paymentDetail | list | Details of payment transaction | - |
| 5.31.1 | paymentMode | string | Payment mode information | e.g. COD, PREPAID |
| 5.31.2 | transactionId | string | Transaction Id information | - |
| 5.31.3 | amountPaid | number | AmountPaid information | - |
| 5.32 | channelProcessingTime | date | Order Processing time to be displayed | Defined order Processing at a fixed time interval |
| 6 | failedOrderFetch | boolean | true if failed order fetched | - |
| 7 | refreshEnabled | boolean | true if refresh enabled | - |
Error Codes
Refer Response Codes section to know about specific errors codes.