Order Cancel

This REST API is used to notify the Partner when the order(Items) has been cancelled in Uniware.

Tip

The access token received in response is required in Header (Authorization) in all subsequent API requests.

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
BaseUrl:	https://{PartnerBaseUrl}
Endpoint:	/cancelSOItem
Request Type:	POST
Scheme:	HTTPS
Header (Content-Type):	application/json
Header (Authorization):	token value(got from Authentication

Request Payload

{
  "saleOrderCode": "5975515365683",
  "shippingPackageCode": "string",
  "displayOrderCode": "64391",
  "facilityCode": "wearcomet",
  "items": [
    {
      "itemCode": "15130286522675",
      "itemSku": "CLSB03018",
      "cancellationReason": "Cancellation by Seller :cancelled on panel"
    }
  ]
}

Request Payload Details

LEVEL	PARAMETER	TYPE	DESCRIPTION	MANDATORY	NOTES
1	saleOrderCode	string	Code of order	Yes	-
2	shippingPackageCode	string	List of cancelled items in an order	No	If available
1	displayOrderCode	string	Code of order	Yes	-
1	facilityCode	string	Code of order	Yes	-
1	items	List	Code of order	Yes	-
2.1	itemCode	string	Sale order item code	Yes	-
2.2	itemSku	string	Item SKU	Yes	-
2.3	cancellationReason	string	Reason for cancellation	No	-

Response Payload

{
    "status": "Success",
    "message": "Detail is updated successfully"    
}

Response Payload Details

LEVEL	PARAMETER	TYPE	DESCRIPTION	MANDATORY	NOTES
1	status	string	Success after notification is acknowledged	Yes	Success/Failed
2	message	string	Readable response message	Yes	-

Error Codes

Refer Response Codes section to know about specific errors codes.

FAQs/Notes

Q1. What would be that frequency of Notification push to partner?
Ans. Real-time or nearly real-time.