Post Return to UC

This REST API is used to notify the Uniware when the order need to mark return from MarketPlace.

Tip

  • This is an optional API used only when the marketplaces wish to post return update in Uniware.
  • This API request is initiated by the marketplace to post information(CUSTOMERRETURN/COURIERRETURN) 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/returns
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

{
    "saleOrderCode": "M029",
    "reason": "The product doesnu0027t fit me correctly",
    "trackingNumber": "",
    "returnID": "String",
    "returnWarehouseCode": null,
    "shippingProviderCode": "",
    "type": "CUSTOMER_RETURN/COURIER_RETURN",
    "status": "CREATED",
    "orderItems": [
        {
            "channelProductId": "UCW363-UC2W363-V-Black",
            "quantity": 16
        }
    ],
    "createdOn": "2022-08-19 04:41:51"
}

Request Payload Details

LEVEL PARAMETER TYPE DESCRIPTION MANDATORY NOTES
1 saleOrderCode string Sale Order Code Yes -
2 reason string Return Reason Yes -
3 trackingNumber string Shipment tracking number Yes -
4 returnID string Return id Yes -
5 shippingProviderCode string Shipping provider code Yes -
6 type string Return type Yes CUSTOMER_RETURN or COURIER_RETURN
7 returnWarehouseCode string Seller return facility(warehouse)code Yes -
8 status string Return status Yes CREATED
9 orderItems object Order Items details Yes -
9.1 channelProductId string ChannelProductId Yes -
9.2 quantity Integer Return item quantity Yes -
10 createdOn date Return creation date Yes e.g. 2022-08-19 04:41:51

Response Payload

{
    "status": "success",
    "message": "Customer Return successfully created",
    "data": null
}

Response Payload Details

LEVEL PARAMETER TYPE DESCRIPTION MANDATORY NOTES
1 Status string Success after Delievred is acknowledged Yes Success/Failed
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 Return push to UC?
Ans. On MarketPlace action for return, at same time MP needs to post the Return information to UC.

Unicommerce Website

Copyright © 2024 Unicommerce eSolutions Pvt. Ltd.