Post Omni Order Accept Reject

This REST API is used to update the marketplace that the seller has accepted or rejected the hope order at hoppable store. The seller on receiving the order, gives his acceptance for each order id, using the method defined here.

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.

This feature is useful for marketplaces who wish their sellers to acknowledge and accept their orders.

This order hopping is only available to Enterprise tenants in Uniware.

Basic Information

NAME	DETAILS
Usage:	Optional (Only for Omni channel)
Endpoint: order accept-reject	/orders/reject
Request Type:	POST
Scheme:	HTTPS
Header (Content-Type):	application/json
Header (apiKey):	accessToken (got from Get Authentication)

Request Payload (accept)

{
  "saleOrderCode": "string",
  "confirmedSaleOrderItemCodes": [
     {
         "orderItemId": "string",
         "quantity": "2"
     }
   ],
   "rejectedSaleOrderItemCodes": []
}

Request Payload (accept) Details

LEVEL	PARAMETER	TYPE	DESCRIPTION	MANDATORY	NOTES
1	saleOrderCode	string	ID of order to be marked as cancel	Yes	-
2	confirmedSaleOrderItemCodes	-	-	-	-
2.1	orderItemId	string	Order Item Id marked as accept	Yes	-
2.2	quantity	number	Qty to be accepted	Yes	-
3	rejectedSaleOrderItemCodes	-	-	-	-
3.1	orderItemId	string	Order Item Id marked as reject	No	-
3.2	quantity	number	Qty to be rejected	No	-

Response Payload (accept)

{
    "status": "success",
    "message": "Confirmed on channel",
     "data": {
          "ACCEPTED_SOI_RESPONSE": [
           {
                "orderItemId": "string"
           }
        ]
     }
}

Response Payload (accept) Details

LEVEL	PARAMETER	TYPE	DESCRIPTION	MANDATORY	NOTES
1	status	string	Send Success after acknowledged	Yes	Allowable: SUCCESS, FAILED
2	message	string	message after acknowledged	Yes	-
3	data	list	List of items in an order	-	-
3.1	ACCEPTED_SOI_RESPONSE	-	-	Yes	-
3.1.1	orderItemId	string	Order Item Id	Yes	-

Request Payload (reject)

{
    "saleOrderCode": "string",
    "confirmedSaleOrderItemCodes":[],
    "rejectedSaleOrderItemCodes": [
     {
         "orderItemId":"string",
         "quantity":"2",
         "reason":"Inventory does not exist"
     }
   ]
}

Request Payload (reject) Details

LEVEL	PARAMETER	TYPE	DESCRIPTION	MANDATORY	NOTES
1	saleOrderCode	string	ID of order to be marked as cancel	Yes	-
2	confirmedSaleOrderItemCodes	-	-	-	-
2.1	orderItemId	string	Order Item Id marked as accept	No	-
2.2	quantity	number	Qty to be accepted	No	-
3	rejectedSaleOrderItemCodes	-	-	-	-
3.1	orderItemId	string	Order Item Id marked as reject	Yes	-
3.2	quantity	number	Qty to be rejected	Yes	-
3.3	reason	string	reason for rejection	Yes	-

Response Payload (reject)

{
      "status": "success",
      "message": "Confirmed on channel",
      "data": {
             "SUGGESTED_REJECTED_SOI_TO_FACILITY_CODE": [
             {
                   "orderItemId":"NYK-11460840-4269542-1-1~1",
                   "facilityCode":"Location-01"
              }
        ]
    }
}

Response Payload (reject) Details

LEVEL	PARAMETER	TYPE	DESCRIPTION	MANDATORY	NOTES
1	status	string	Send Success after acknowledged	Yes	Allowable: SUCCESS, FAILED
2	message	string	message after acknowledged	Yes	-
3	data	list	List of items in an order	-	-
3.1	SUGGESTED_REJECTED_SOI_TO_FACILITY_CODE	-	-	Yes	it can be any one of CANCELLED_SOI_RESPONSE or SUGGESTED_REJECTED_SOI_TO_FACILITY_CODE
3.1.1	orderItemId	string	Order Item Id	Yes	-

Error Codes

Refer Response Codes section to know about specific errors codes.

FAQs/Notes

Q1. For which integrations is this API useful?
Ans. Some JIT MPs with Omni orders require the sellers to manually acknowledge the orders at store and then proecss them, which they can do by this API.

Q2. Is this API provided by MP and UC will consume it?
Ans. UC will consume this API. This notifies the MP that seller has accepted the store order and will process it at dedecated store.