Create Alternate Item

This REST API is used to create an alternate sale order item in lieu of some returned item in Uniware.

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/createSaleOrderItemAlternate
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

{
   "saleOrderItems": [
      {
         "code": "string",
         "status": "string",
         "shelfCode": "string",
         "reason": "string"
      }
   ],
   "saleOrderItemAlternates": [
      {
         "itemSku": "string",
         "amountDifference": 0
      }
   ]
}

Request Payload Details

LEVEL PARAMETER TYPE DESCRIPTION MANDATORY NOTES
1 saleOrderItems list Details of items in sale order Yes -
1.1 code string Sale order code Yes -
1.2 status string Sale order status No -
1.3 shelfCode string Shelf code of the item No -
1.4 reason string Reason for replacement No -
2 saleOrderItemAlternates list Alternate item details Yes -
2.1 itemSku string Item SKU Yes Eg.: Bharat4
2.2 amountDifference number Difference in amount Yes -

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"
      }
   ],
   "successfulSaleOrderItemCodes": [
      "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 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 successfulSaleOrderItemCodes list List of successful sale order items -

Error Codes

Refer Response Codes section to know about specific errors codes.

Unicommerce Website

Copyright © 2022 Unicommerce eSolutions Pvt. Ltd.