Scribd
Upload
107 views6 pages

Uniware API Sale Order Management

The document describes 4 Uniware APIs: 1. The Sale Order Search API allows searching for sale orders by various parameters like order code, date range, and returning lists of orders. 2. The Get Sale Order API retrieves a specific sale order by its code, returning all details of the order. 3. The Cancel Sale Order API cancels a sale order by code, optionally specifying items to cancel and a cancellation reason. 4. The Inventory Adjustment API adjusts inventory quantities by SKU, shelf, and type, specifying if it is adding or subtracting quantity.

Uploaded by

Rupesh Solanki
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
107 views6 pages

Uniware API Sale Order Management

The document describes 4 Uniware APIs: 1. The Sale Order Search API allows searching for sale orders by various parameters like order code, date range, and returning lists of orders. 2. The Get Sale Order API retrieves a specific sale order by its code, returning all details of the order. 3. The Cancel Sale Order API cancels a sale order by code, optionally specifying items to cancel and a cancellation reason. 4. The Inventory Adjustment API adjusts inventory quantities by SKU, shelf, and type, specifying if it is adding or subtracting quantity.

Uploaded by

Rupesh Solanki
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd

Uniware API

1. Search Sale Order

URL- [Link]

Body-
{
"displayOrderCode": "TEXT(optional)",
"status": "TEXT(optional)",
"channel": "TEXT(optional)",
"customerEmailOrMobile": "TEXT(optional)",
"customerName": "TEXT(optional)",
"fromDate": "DATE(optional)",
"toDate": "DATE(optional)",
"facilityCodes": "ARRAY(optional)",
"updatedSinceInMinutes": "INTEGER(optional)"
}

Sample Request :
{
"fromDate": "2018-05-21T00:00:00Z"
}
Sample Response:
{
"successful": true,
"message": null,
"errors": [],
"warnings": null,
"totalRecords": null,
"elements": [
{
"code": "204213",
"displayOrderCode": "204213",
"channel": "CUSTOM",
"displayOrderDateTime": 1526991825000,
"status": "PROCESSING",
"created": 1526991825000,
"updated": 1526972121000,
"notificationEmail": "",
"notificationMobile": ""
},
{
"code": "204214",
"displayOrderCode": "204214",
"channel": "CUSTOM",
"displayOrderDateTime": 1526991825000,
"status": "PROCESSING",
"created": 1526991825000,
"updated": 1526972121000,
"notificationEmail": "",
"notificationMobile": ""
},

2. Get Sale Order

URL- [Link]

Body-
{
"code":"TEXT(madatory)"
}

Sample Request :
{
"code":"204214"
}
Sample Response :
{
"successful": true,
"message": null,
"errors": [],
"warnings": null,
"saleOrderDTO": {
"code": "204214",
"displayOrderCode": "204214",
"channel": "CUSTOM",
"displayOrderDateTime": 1526991825000,
"status": "PROCESSING",
"created": 1526991825000,
"updated": 1526972121000,
"notificationEmail": "",
"notificationMobile": "",
"cod": true,
"priority": 0,
"currencyCode": "INR",
"customerCode": null,
"billingAddress": {
"id": "1512",
"name": "Sunny",
"addressLine1": "AHMEDABAD",
"addressLine2": "",
"city": "AHMEDABAD",
"state": "GJ",
"country": "IN",
"pincode": "380001",
"phone": "9898989898",
"email": null
},
"addresses": [
{
"id": "1512",
"name": "Sunny",
"addressLine1": "AHMEDABAD",
"addressLine2": "",
"city": "AHMEDABAD",
"state": "GJ",
"country": "IN",
"pincode": "380001",
"phone": "9898989898",
"email": null
}
],
"shippingPackages": [
{
"code": "HLPL567",
"saleOrderCode": "204214",
"channel": "CUSTOM",
"status": "CREATED",
"shippingPackageType": "DEFAULT",
"shippingProvider": null,
"shippingMethod": "Standard-COD",
"trackingNumber": null,
"trackingStatus": null,
"courierStatus": null,
"estimatedWeight": null,
"actualWeight": null,
"customer": "Sunny",
"created": 1526991921000,
"updated": 1526972121000,
"dispatched": null,
"delivered": null,
"invoice": 0,
"invoiceCode": null,
"invoiceDisplayCode": null,
"returnInvoiceCode": null,
"returnInvoiceDisplayCode": null,
"noOfItems": 1,
"city": "AHMEDABAD",
"collectableAmount": 25,
"collectedAmount": null,
"paymentReconciled": false,
"podCode": null,
"items": {
"dhar007": {
"itemSku": "dhar007",
"itemName": "shirt",
"itemTypeImageUrl": null,
"itemTypePageUrl": null,
"quantity": 1
}
},
"customFieldValues": []
}
],
"saleOrderItems": [
{
"id": 9458,
"shippingPackageCode": "HLPL567",
"shippingPackageStatus": "CREATED",
"facilityCode": "Warehouse",
"facilityName": "Demo Warehouse",
"alternateFacilityCode": null,
"reversePickupCode": null,
"shippingAddressId": 1512,
"packetNumber": 0,
"combinationIdentifier": null,
"combinationDescription": null,
"item": null,
"shippingMethodCode": "STD",
"itemName": "shirt",
"itemSku": "dhar007",
"channelProductId": "dhar007",
"imageUrl": null,
"statusCode": "FULFILLABLE",
"code": "204214-1",
"shelfCode": "Default",
"totalPrice": 25,
"sellingPrice": 25,
"shippingCharges": 0,
"shippingMethodCharges": 0,
"cashOnDeliveryCharges": 0,
"prepaidAmount": 0,
"voucherCode": null,
"voucherValue": 0,
"storeCredit": 0,
"discount": 0,
"giftWrap": null,
"giftWrapCharges": 0,
"taxPercentage": null,
"giftMessage": "",
"cancellable": true,
"editAddress": true,
"reversePickable": false,
"packetConfigurable": false,
"created": 1526991825000,
"updated": 1526972121000,
"onHold": false,
"saleOrderItemAlternateId": null,
"cancellationReason": null,
"pageUrl": null,
"color": null,
"brand": null,
"size": null,
"replacementSaleOrderCode": null,
"customFieldValues": [
{
"fieldName": "Tax",
"fieldValue": null,
"valueType": "text",
"displayName": "Tax",
"required": false,
"possibleValues": [
""
]
},
{
"fieldName": "Tax1",
"fieldValue": null,
"valueType": "text",
"displayName": "Tax1",
"required": false,
"possibleValues": [
""
]
}
],
"itemDetailFieldDTOList": []
}
],
"customFieldValues": [],
"cancellable": true,
"reversePickable": false,
"packetConfigurable": false,
"cFormProvided": false,
"totalDiscount": null,
"totalShippingCharges": null,
"additionalInfo": null
},
"refreshEnabled": false,
"failedOrderFetch": false
}

3. Cancel Sale Order

URL- [Link]
Body-
{
"saleOrderCode": "TEXT(mandatory)",
"saleOrderItemCodes": "ARRAY(optional)",
"cancellationReason": "TEXT(optional)"
}

4. Inventory Adjustment API

URL: [Link]

Body :
{"inventoryAdjustment":
{ "itemSKU": "sam123",
"quantity": 10,
"shelfCode": "DEFAULT",
"inventoryType": "GOOD_INVENTORY",
"adjustmentType": "ADD" } }

Response :
{"successful":true,"message":null,"errors":[],"warnings":null}

You might also like