Post Order Cancel

This REST API is used to notify the marketplace when the order has been cancelled by the seller on 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.

Flow

Order_Flow

Tip

Complete integration flow is available on Basic Overview page.

Basic Information

NAME DETAILS
Usage: Optional
Endpoint: /orders/cancel
Request Type: POST
Scheme: HTTPS
Header (Content-Type): application/json
Header (apiKey): accessToken (got from Get Authentication)

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.

{
  "orderId": "string",
  "orderItems": [
    {
      "orderItemId": "string",
      "productId": "string",
      "variantId": "string",
      "quantity": 2
    }
  ]
}

Request Payload Details

LEVEL PARAMETER TYPE DESCRIPTION MANDATORY NOTES
1 orderID string ID of orders to be marked as cancel Yes -
2 orderItems - - - -
2.1 orderItemId string ItemsId of orders to be marked as cancel Yes -
2.2 productId string ProductID of orders to be marked as cancel Yes -
2.3 variantId string VariantID of orders to be marked as cancel Yes -
2.4 quantity number Qty to be cancelled Yes -

Response Payload

{
  "status": "SUCCESS",
  "orderItems": [
    {
      "orderItemId": "string",
      "errorMessage": "order Item Id not available"
    }
  ]
}

Response Payload Details

LEVEL PARAMETER TYPE DESCRIPTION MANDATORY NOTES
1 Status string Send Success after cancellation is acknowledged Yes Allowable: SUCCESS, FAILED, PARTIAL_SUCCESS
2 orderItems list List of items in an order - -
2.1 orderItemId string Order ID of the orders failed to be marked cancel at your system No -
2.2 errorMessage string Reason of failure No -

Error Codes

Refer Response Codes section to know about specific errors codes.

FAQs/Notes

Q1. What would be that frequency of cancellation push to MP?
Ans. Once a seller cancels an order, at same time Uniware posts the cancellation information on marketplace.

Q2. Can UC do partial cancellation of order (item wise order cancellation)?
Ans. Yes, UC provides item-wise cancellation.

Q3. If the order is cancelled at the MP but the same is not cancelled in UC because of the 10 minutes sync time in order status sync, then how does UC deal with it?
Ans. In this case the MP can pass UC the error at the invoice/label generation in Get Invoice Details API and display the relevant error message to the seller so that it is conveyed that the order is cancelled. Then this order will mark cancelled on next status sync.

Unicommerce Website

Copyright © 2022 Unicommerce eSolutions Pvt. Ltd.