Return Created

This REST API is used to notify the Partner when the return has been created in Uniware.

Tip

The access token received in response is required in Header (apikey) 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:	/createReturn
Request Type:	POST
Scheme:	HTTPS
Header (Content-Type):	application/json
Header (Authorization):	token value(got from Authentication

Request Payload

{
  "SaleOrderCode": "1100053069",
  "ShippingPackageCode": "String",
  "returnId": "String",
  "status": "CREATED",
  "returnReason": "String",
  "facilityCode": "string",
  "type": "CUSTOMER_RETURN",
  "createdOn": "Feb 13, 2023 4:01:45 PM",
  "customFields": [
        
      ],
  "orderItems": [
    {
      "orderItemId": "FN1100053069_9351746447330_0",
      "bundleIdentifier": null,
      "skuCode": "9351746447330"
    },
    "customFields": [
        
      ]
  ]
}

Request Payload Details

LEVEL	PARAMETER	TYPE	DESCRIPTION	MANDATORY	NOTES
1	saleOrderCode	string	Sale order code	Yes	-
2	shippingPackageCode	string	Shipment code	Yes	-
3	returnId	string	Return id	Yes	-
4	status	string	Return status	Yes	“CREATED” for CIR , “Return_awaited” for RTO
5	returnReason	string	Return reason	Yes	-
6	facilityCode	string	Uniwre warehouse code	Yes	-
7	type	string	Return type	Yes	“CUSTOMER_RETURN” for CIR or “COURIER_RETURN” for RTO
8	createdOn	Date	date-time Eg: Feb 13, 2023 4:01:45 PM	Yes	-
9	customFields	object	Custom fields details	Opt	-
10	orderItems	object	Order Items details	Yes	-
11	orderItemId	string	OrderItems Ids	Yes	-
12	bundleIdentifier	string	Bundle Identifier	Yes	-
13	skuCode	string	SKU code	Yes	-
14	customFields	object	Custom fields details	Opt	-

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.