Post Cancel to UC

This REST API is used to notify the Uniware when the order has been cancelled by the seller/Customer on MarketPlace.

Tip

This is an optional API used only when the marketplaces wish to post cancellation update in Uniware.

This API request is initiated by the marketplace to post information(cancellation) in Uniware. For such APIs a unique static securitykey is provided by the Unicommerce to the marketplaces for authentication. This securitykey should be passed in header as mentioned below.

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.

Tip

Complete integration flow is available on Basic Overview page.

Basic Information

NAME	DETAILS
Usage:	Optional
URL:	https://genericproxy.unicommerce.com/
Endpoint:	/uc/v1/order/cancel
Request Type:	POST
Scheme:	HTTPS
Header (Content-Type):	application/json
Header (clientid):	ID (provided by Unicommerce)
Header (merchantid):	username
Header (securitykey):	key (provided by Unicommerce), Eg.: F212b212-232323-232323

Request Payload

NOTE:

The orderItems is a list of cancelled order items. So the marketplace can send the details of multiple cancelled order items in this field.

{
    "saleOrderCode": "string",
    "cancelledSkuCodes": [
        {
            "quantity": 2,
            "productId": "string",
            "variantId": "string"
        }
    ],
    "cancellationReason": "string"
}

Request Payload Details

LEVEL	PARAMETER	TYPE	DESCRIPTION	MANDATORY	NOTES
1	saleOrderCode	string	Code of order	Yes	-
2	cancelledSkuCodes	List	List of cancelled items in an order	-	-
2.1	quantity	number	Qty of item to be cancelled	Yes	-
2.2	productId	string	ProductID of items to be cancelled	Yes	-
2.3	variantId	string	VariantID of items to be cancelled	Yes	-
3	cancellationReason	string	Reason for cancellation	Yes	-

Response Payload

{
    "status": "success",
    "message": "Successfully updated Order detail",
    "data": null
}

Response Payload Details

LEVEL	PARAMETER	TYPE	DESCRIPTION	MANDATORY	NOTES
1	Status	string	Success after cancellation is acknowledged	Yes	success/failure
2	message	string	Response message	-	-
3	data	string	Null	-	-

Error Codes

Refer Response Codes section to know about specific errors codes.

FAQs/Notes

Q1. What would be that frequency of cancellation push to UC?
Ans. On seller/MarketPlace action for cancellation, at same time MP needs to post the cancellation information to UC.

Q2. Can UC handle partial cancellation of order (item wise order cancellation)?
Ans. Yes, UC handle item-wise cancellation. Check the API schema.