Vinculum

Vinculum Order Returns API

API to retrieve or create return for an order.

GitHub OpenAPI

Documentation

📖
APIReference
https://erp.vineretail.com/swagger/
📖
APIReference
https://erp.vineretail.com/SellerPanelV3/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/vinculum/refs/heads/main/openapi/vinculum-order-returns-api-openapi.yml

OpenAPI Specification

vinculum-order-returns-api-openapi.yml Raw ↑ 
swagger: '2.0'
info:
  title: Vinculum Advance Shipping Notice Order Returns API
  description: API to retrieve or manipulate ASN related information.
host: erp.vineretail.com
tags:
- name: Order Returns
  description: API to retrieve or create return for an order.
paths:
  /RestWS/api/eretail/v1/order/return:
    post:
      tags:
      - Order Returns
      summary: Max no. of Lines/hit:100 API For Returning an Order(Hit Quota 40/5 min)
      consumes:
      - application/x-www-form-urlencoded
      produces:
      - application/json
      parameters:
      - in: formData
        name: RequestBody
        required: true
        type: string
        description: <table class="table-style-three"><tbody><tr align="center"><td style="vertical-align:middle" width='100'><strong>Field Name </strong></td><td style="vertical-align:middle" width='100'><strong>Data Type </strong></td><td style="vertical-align:middle" width='100'><strong>Mandatory </strong></td><td style="vertical-align:middle" width='300'><strong>Description </strong></td></tr><tr align="center"><td style="vertical-align:middle" >requestType</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >requestType should be like Request or Request & Inbound</td></tr><tr align="center"><td style="vertical-align:middle" >returnType</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >returnType should be like RTO or Delivered Return</td></tr><tr align="center"><td style="vertical-align:middle" >returnBin</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Return Bin</td></tr><tr align="center"><td style="vertical-align:middle" >order_location</td><td style="vertical-align:middle" >Varchar(3)</td><td style="vertical-align:middle" >Conditional</td><td style="vertical-align:middle" >eRetail Location Code or loccode of external system. API will pick Loc Code from Order API configuration, if single Location Code is configured. If API is mapped with multiple locations, it is mandatory to provide the field in request</td></tr><tr align="center"><td style="vertical-align:middle" >order_no</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >Orderno from external system</td></tr><tr align="center"><td style="vertical-align:middle" >invoice_no</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >Either the invoice_no or tracking_no needed</td></tr><tr align="center"><td style="vertical-align:middle" >tracking_no</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >Either the invoice_no or tracking_no needed</td></tr><tr align="center"><td style="vertical-align:middle" >status</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >&nbsp;e. g.<b> Pending, Confirmed.</b> Master Code:ODRSTS&nbsp;</td></tr><tr align="center"><td style="vertical-align:middle" >custRetCode</td><td style="vertical-align:middle" >Varchar(12)</td><td style="vertical-align:middle" >Optional*</td><td style="vertical-align:middle" >Mandatory In case of Cancellation.</td></tr><tr align="center"><td style="vertical-align:middle" >extCustRetCode</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Return Customer Code from External System</td></tr><tr align="center"><td style="vertical-align:middle" >return_date</td><td style="vertical-align:middle" >datetime</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >Format given in Generic Information section</td></tr><tr align="center"><td style="vertical-align:middle" >customer_name</td><td style="vertical-align:middle" >Varchar(100)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >If not passed will pick from order</td></tr><tr align="center"><td style="vertical-align:middle" >customer_address1</td><td style="vertical-align:middle" >Varchar(1000)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >If not passed will pick from order</td></tr><tr align="center"><td style="vertical-align:middle" >customer_address2</td><td style="vertical-align:middle" >Varchar(200)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >If not passed will pick from order</td></tr><tr align="center"><td style="vertical-align:middle" >customer_address3</td><td style="vertical-align:middle" >Varchar(200)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >If not passed will pick from order</td></tr><tr align="center"><td style="vertical-align:middle" >customer_address4</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >If not passed will pick from order</td></tr><tr align="center"><td style="vertical-align:middle" >customer_country</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >If not passed will pick from order</td></tr><tr align="center"><td style="vertical-align:middle" >customer_state</td><td style="vertical-align:middle" >int(11)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >If not passed will pick from order</td></tr><tr align="center"><td style="vertical-align:middle" >customer_city</td><td style="vertical-align:middle" >Varchar(200)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" ></td></tr><tr align="center"><td style="vertical-align:middle" >customer_pincode</td><td style="vertical-align:middle" >Varchar(20)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle" >If not passed will pick from order</td></tr><tr align="center"><td style="vertical-align:middle" >customer_email</td><td style="vertical-align:middle" >Varchar(255)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >If not passed will pick from order</td></tr><tr align="center"><td style="vertical-align:middle" >remarks</td><td style="vertical-align:middle" >Varchar(5000)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >If not passed then first item 'return_reason' will be set.</td></tr><tr align="center"><td style="vertical-align:middle" >transporter</td><td style="vertical-align:middle" >int(11)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Transportercode as per masters</td></tr><tr align="center"><td style="vertical-align:middle" >category</td><td style="vertical-align:middle" >Varchar(200)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Define in codelkup table with lkupcode DRTYPE</td></tr><tr align="center"><td style="vertical-align:middle" >coupon</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Valid Coupon No</td></tr><tr align="center"><td style="vertical-align:middle" >udf1</td><td style="vertical-align:middle" >Varchar(2000)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">UDF1 must NOT be greater than 2000 characters</td></tr><tr align="center"><td style="vertical-align:middle" >udf2</td><td style="vertical-align:middle" >Varchar(2000)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle"> UDF2 must NOT be greater than 2000 characters</td></tr><tr align="center"><td style="vertical-align:middle" >udf3</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">User defined field</td></tr><tr align="center"><td style="vertical-align:middle" >udf4</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">User defined field</td></tr><tr align="center"><td style="vertical-align:middle" >udf5</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">User defined field</td></tr><tr align="center"><td style="vertical-align:middle" >udf6</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">User defined field</td></tr><tr align="center"><td style="vertical-align:middle" >udf7</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">User defined field</td></tr><tr align="center"><td style="vertical-align:middle" >udf8</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">User defined field</td></tr><tr align="center"><td style="vertical-align:middle" >udf9</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">User defined field</td></tr><tr align="center"><td style="vertical-align:middle" >udf10</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">User defined field</td></tr><tr align="center"><td style="vertical-align:middle" >geoType</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Conditional</td><td style="vertical-align:middle" > Geocode system type (eg. What3Words).</td></tr><tr align="center"><td style="vertical-align:middle" >geoAddress</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Customer's ship to geocode address</td></tr><tr align="center"><td style="vertical-align:middle" >geoLatitude</td><td style="vertical-align:middle" >Text</td><td style="vertical-align:middle" >Conditional</td><td style="vertical-align:middle" >Geocode latitude, Geotype is mandatory for this field</td></tr><tr align="center"><td style="vertical-align:middle" >geoLongitude</td><td style="vertical-align:middle" >Text</td><td style="vertical-align:middle" >Conditional</td><td style="vertical-align:middle" >Geocode longitude, Geotype is mandatory for this field</td></tr><tr align="center"><td style="vertical-align:middle" >return_tracking_no</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" > Reverse AWB No</td></tr><tr align="center"><td style="vertical-align:middle" >transporterName</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" > If both Transcode and transporterName are present, Transcode takes priority, and the transporterName is retrieved accordingly. Otherwise, the provided value is used. </td></tr><tr align="center"><td style="vertical-align:middle" >updatedPrice</td><td style="vertical-align:middle" >decimal(10,3)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" > The default value will be set to the sum of the line-level updated prices, unless a specific value is provided in this field.</td></tr><tr align="center"><td style="vertical-align:middle" >delType</td><td style="vertical-align:middle" >Varchar(200)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Accepted Values are PickUp, Delivery or No PickUp, By default, the value will be set to PickUp if not provided.</td></tr><tr align="center"><td style="vertical-align:middle" >referenceNo</td><td style="vertical-align:middle" >Varchar(255)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Tracking Number (Must be unique)</td></tr><tr align="center"><td style="vertical-align:middle" >customer_altPhoneNo</td><td style="vertical-align:middle" >Varchar(20)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >If not passed will pick from order</td></tr><tr align="center"><td style="vertical-align:middle" >customer_phoneNo</td><td style="vertical-align:middle" >Varchar(20)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >If not passed will pick from order</td></tr><tr align="center"><td style="vertical-align:middle" >customer_altEmail</td><td style="vertical-align:middle" >Varchar(255)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >If not passed will pick from order</td></tr><tr align="center"><td style="vertical-align:middle" colspan=4 ><b>Items Fields</b></td></tr><tr align="center"><td style="vertical-align:middle" >lineno</td><td style="vertical-align:middle" >smallint(6)</td><td style="vertical-align:middle" >Conditional</td><td style="vertical-align:middle" >Mandatory If the order is having more than one Order Line for same SKU</td></tr><tr align="center"><td style="vertical-align:middle" >ext_lineno</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Line no of external system</td></tr><tr align="center"><td style="vertical-align:middle" >sku</td><td style="vertical-align:middle" >Varchar(20)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >Sku code as per masters</td></tr><tr align="center"><td style="vertical-align:middle" >bagId</td><td style="vertical-align:middle" >Varchar(250)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" ></td></tr><tr align="center"><td style="vertical-align:middle" >channelSkuCode</td><td style="vertical-align:middle" >Varchar(100)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >External System SKU code/Marketplace SKU code</td></tr><tr align="center"><td style="vertical-align:middle" >channelProductId</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >ProductId of the SKU created in external system/Marketplace</td></tr><tr align="center"><td style="vertical-align:middle" >return_qty</td><td style="vertical-align:middle" >decimal(10,3)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >Return qty</td></tr><tr align="center"><td style="vertical-align:middle" >return_reason</td><td style="vertical-align:middle" >Varchar(200)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">If passed and not exists then system will create this automatically</td></tr><tr align="center"><td style="vertical-align:middle" >udf1</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">User defined field</td></tr><tr align="center"><td style="vertical-align:middle" >udf2</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">User defined field</td></tr><tr align="center"><td style="vertical-align:middle" >udf3</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">User defined field</td></tr><tr align="center"><td style="vertical-align:middle" >udf4</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">User defined field</td></tr><tr align="center"><td style="vertical-align:middle" >udf5</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">User defined field</td></tr><tr align="center"><td style="vertical-align:middle" >udf6</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">User defined field</td></tr><tr align="center"><td style="vertical-align:middle" >udf7</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">User defined field</td></tr><tr align="center"><td style="vertical-align:middle" >udf8</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">User defined field</td></tr><tr align="center"><td style="vertical-align:middle" >udf9</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">User defined field</td></tr><tr align="center"><td style="vertical-align:middle" >udf10</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">User defined field</td></tr><tr align="center"><td style="vertical-align:middle" >updatedPrice</td><td style="vertical-align:middle" >decimal(10,3)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Updated price of SKU</td></tr><tr align="center"><td style="vertical-align:middle" colspan=4 ><b>Return Payment Details</b></td></tr><tr align="center"><td style="vertical-align:middle" >paymentMode</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:left">Cheque/Giftcard Redemption Amount/Loyalty Points/Wallet/IMPS/Multi Finance/NETB/DD/Credit Card/Debit Card/Cash/Coupon/Store Credit/Credit/Advance Payment</td></tr><tr align="center"><td style="vertical-align:middle" >docNo</td></td><td style="vertical-align:middle" >Varchar(50)</td></td><td style="vertical-align:middle" >Optional</td></td></td><td style="vertical-align:middle" >Transaction document number</td></tr><tr align="center"><td style="vertical-align:middle" >docdate</td></td><td style="vertical-align:middle" >Varchar(50)</td></td><td style="vertical-align:middle" >Optional</td></td></td><td style="vertical-align:middle" >Date of the payment document in a suitable format DD/MM/YYYY HH:MM:SS</td></tr><tr align="center"><td style="vertical-align:middle" >docBank</td></td><td style="vertical-align:middle" >Varchar(50)</td></td><td style="vertical-align:middle" >Optional</td></td></td><td style="vertical-align:middle" >Name of the bank associated with the payment document.</td></tr><tr align="center"><td style="vertical-align:middle" >ifscCode</td></td><td style="vertical-align:middle" >Varchar(50)</td></td><td style="vertical-align:middle" >Optional</td></td></td><td style="vertical-align:middle" >IFSC code of the bank branch associated with the transaction.</td></tr><tr align="center"><td style="vertical-align:middle" >docAmt</td></td><td style="vertical-align:middle" >Varchar(50)</td></td><td style="vertical-align:middle" >Optional</td></td></td><td style="vertical-align:middle" >Amount specified in the payment document.</td></tr><tr align="center"><td style="vertical-align:middle" >returnAmountReceived</td></td><td style="vertical-align:middle" >Decimal(10,3)</td></td><td style="vertical-align:middle" >Optional</td></td></td><td style="vertical-align:middle" >Total return amount received as part of the payment.</td></tr><tr align="center"><td style="vertical-align:middle" >branch</td></td><td style="vertical-align:middle" >Varchar(50)</td></td><td style="vertical-align:middle" >Optional</td></td></td><td style="vertical-align:middle" >Branch name associated with the payment or document, if applicable.</td></tr><tr align="center"><td style="vertical-align:middle" >authCode</td></td><td style="vertical-align:middle" >Varchar(50)</td></td><td style="vertical-align:middle" >Optional</td></td></td><td style="vertical-align:middle" >Authentication code </td></tr><tr align="center"><td style="vertical-align:middle" >edcNo</td></td><td style="vertical-align:middle" >Varchar(50)</td></td><td style="vertical-align:middle" >Optional</td></td></td><td style="vertical-align:middle" >edc Number</td></tr><tr align="center"><td style="vertical-align:middle" >udf1</td></td><td style="vertical-align:middle" >Varchar(2000)</td></td><td style="vertical-align:middle" >Optional</td></td></td><td style="vertical-align:middle" >Items UDF1 must NOT be greater than 2000 characters</td></tr><tr align="center"><td style="vertical-align:middle" >udf2</td></td><td style="vertical-align:middle" >Varchar(2000)</td></td><td style="vertical-align:middle" >Optional</td></td></td><td style="vertical-align:middle" >Items UDF2 must NOT be greater than 2000 characters</td></tr><tr align="center"><td style="vertical-align:middle" >udf3</td></td><td style="vertical-align:middle" >Varchar(50)</td></td><td style="vertical-align:middle" >Optional</td></td></td><td style="vertical-align:middle" >User Defined Field</td></tr><tr align="center"><td style="vertical-align:middle" >udf4</td></td><td style="vertical-align:middle" >Varchar(50)</td></td><td style="vertical-align:middle" >Optional</td></td></td><td style="vertical-align:middle" >User Defined Field</td></tr><tr align="center"><td style="vertical-align:middle" >udf5</td></td><td style="vertical-align:middle" >Varchar(50)</td></td><td style="vertical-align:middle" >Optional</td></td></td><td style="vertical-align:middle" >User Defined Field</td></tr><tr align="center"><td style="vertical-align:middle" >udf6</td></td><td style="vertical-align:middle" >Varchar(50)</td></td><td style="vertical-align:middle" >Optional</td></td></td><td style="vertical-align:middle" >User Defined Field</td></tr><tr align="center"><td style="vertical-align:middle" >udf7</td></td><td style="vertical-align:middle" >Varchar(50)</td></td><td style="vertical-align:middle" >Optional</td></td></td><td style="vertical-align:middle" >User Defined Field</td></tr><tr align="center"><td style="vertical-align:middle" >udf8</td></td><td style="vertical-align:middle" >Varchar(50)</td></td><td style="vertical-align:middle" >Optional</td></td></td><td style="vertical-align:middle" >User Defined Field</td></tr><tr align="center"><td style="vertical-align:middle" >udf9</td></td><td style="vertical-align:middle" >Varchar(50)</td></td><td style="vertical-align:middle" >Optional</td></td></td><td style="vertical-align:middle" >User Defined Field</td></tr><tr align="center"><td style="vertical-align:middle" >udf10</td></td><td style="vertical-align:middle" >Varchar(50)</td></td><td style="vertical-align:middle" >Optional</td></td></td><td style="vertical-align:middle" >User Defined Field</td></tr><tr><tr align="center"><td style="vertical-align:middle" colspan=4 ><b>Additional Information</b></td></tr><tr align="left"><td style="vertical-align:middle" colspan=4 >Max Allowance - 100 Orders.  </td></tr><tr align="center"><tr><td style="vertical-align:middle" colspan=4> <b>Input JSON Format-<br/> {<br/>&nbsp;&nbsp;"orderReturn":[<br/>&nbsp;&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;"requestType":"Request & Inbound",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"returnType":"Delivered Return",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"returnBin":"PACKBIN",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"order_location":"TWH",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"order_no":"101196954",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"invoice_no":"TWH000003699",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"tracking_no":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"status":"Confirmed",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"custRetCode":"AABB0001",&nbsp;&nbsp;&nbsp;&nbsp;<br/>&nbsp;&nbsp;&nbsp;&nbsp;"extCustRetCode":"AAAA009",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"return_date":"21/01/2017 22:40:30",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"customer_name":"Anuj Kaul",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"customer_address1":"House number 50, First Floor ",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"customer_address2":"ABC Road, Green Park ",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"customer_address3":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"customer_address4":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"customer_country":"India",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"customer_state":"Maharashtra",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"customer_city":"Mumbai",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"customer_pincode":"400001",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"customer_email":"anujkaul86@gmail.com",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"customer_altEmail":"anujkaul86@gmail.com",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"customer_phoneNo":"9889098998",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"customer_altPhoneNo":"9889098998",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"remarks":"DamagedGood",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"transporter":"12345",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"category":"Credit Coupon",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"coupon":"VIN2020",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"udf1":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"udf2":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"udf3":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"udf4":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"udf5":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"udf6":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"udf7":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"udf8":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"udf9":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"udf10":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"geoType" :"What3WorDS",</br>&nbsp;&nbsp;&nbsp;&nbsp;"geoAddress" :"101 add",</br>&nbsp;&nbsp;&nbsp;&nbsp;"geoLatitude":"101 latitude",</br>&nbsp;&nbsp;&nbsp;&nbsp;"geoLongitude":"101 longitude",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"return_tracking_no":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"transporterName":"Rana singth",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"delType":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"referenceNo":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"updatedPrice":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"items":[<br/>&nbsp;&nbsp;&nbsp;&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"lineno":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ext_lineno":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"sku":"SKU101",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"bagId":"00000005-667556246964-1",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"channelSkuCode":"8196511",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"channelProductId":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"return_qty":"1",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"return_reason":"Sizenotcorrect.",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"udf1":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"udf2":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"udf3":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"udf4":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"udf5":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"udf6":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"udf7":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"udf8":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"udf9":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"udf10":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"updatedPrice":""<br/>&nbsp;&nbsp;&nbsp;&nbsp;}<br/>&nbsp;&nbsp;&nbsp;&nbsp;],<br/>&nbsp;&nbsp;&nbsp;&nbsp;"refundPaymentItems":[<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"paymentMode":"Cash",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"docNo":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"docdate":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"docBank":"Axis",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ifscCode":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"docAmt":"100.00",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"returnAmountReceived":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"branch":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"authCode":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"edcNo":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"udf1":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"udf2":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"udf3":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"udf4":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"udf5":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"udf6":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"udf7":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"udf8":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"udf9":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"udf10":""<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;]<br/>&nbsp;&nbsp;}<br/>&nbsp;&nbsp;]<br/>}</b></tbody></table>
      - in: formData
        name: ApiOwner
        required: true
        type: string
        description: API Owner.
      - in: formData
        name: ApiKey
        required: true
        type: string
        description: API Key.
      responses:
        200:
          description: <table border='1'width='672'> <h1  style="color:#FFFF00;">API Generic Error Codes</h1><tbody><tr align="center"><td style="vertical-align:middle" width='167'><p><strong>Response Code </strong></p></td><td style="vertical-align:middle" colspan='2' width='171'><p><strong> Response Message </strong></p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>104</p></td><td style="vertical-align:middle" width='167'><p>Order Creation Error while processing</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>501</p></td><td style="vertical-align:middle" width='167'><p>No Access for given Order Location.</p></td><tr align="center"><td style="vertical-align:middle" width='167'><p>502</p></td><td style="vertical-align:middle" width='167'><p>Order Location is mandatory.</p></td><tr align="center"><td style="vertical-align:middle" width='167'><p>504</p></td><td style="vertical-align:middle" width='167'><p>Order_no is mandatory and must be unique within the request.</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>701</p></td><td style="vertical-align:middle" width='167'><p>Maximum Limit Exceeded(100 SKUs Max)</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>9007</p></td><td style="vertical-align:middle" width='167'><p>No Access for given Order Location</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>11001</p></td><td style="vertical-align:middle" width='167'><p>Validation related errors</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>11002</p></td><td style="vertical-align:middle" width='167'><p>Order Not Found in ERP</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>11003</p></td><td style="vertical-align:middle" width='167'><p>Invoice Number is not found in ERP</p></td></tr></tbody></table><table> <tbody> <td style="vertical-align:middle" colspan=4> <b>Case 1- For Single Return Submitted<br/>{<br/>&nbsp;&nbsp;"responseCode":0,<br/>&nbsp;&nbsp;"responseMessage":"Success",<br/>&nbsp;&nbsp;"requestStatus":{<br/>&nbsp;&nbsp;&nbsp;&nbsp;"uniqueKey":"TWH001234",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"requestKey":"TWH001234",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"outputKey":"TWH968",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"status":"Success",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"errorDesc":null,<br/>&nbsp;&nbsp;&nbsp;&nbsp;"errorCode":null<br/>&nbsp;&nbsp;}<br/>}<br/><br/>Case 2- For Multiple Return Submitted<br/>{<br/>&nbsp;&nbsp;"responseCode":0,<br/>&nbsp;&nbsp;"responseMessage":"Success",<br/>&nbsp;&nbsp;"requestId":"02cb470eaf40466c80bdba8faedd4be5"<br/>}</b></tbody></table>
  /RestWS/api/eretail/v1/order/orderreturn:
    post:
      tags:
      - Order Returns
      summary: Max no. of Lines/Response:100 API To Get Returned Order(Hit Quota 40/5 min)
      consumes:
      - application/x-www-form-urlencoded
      produces:
      - application/json
      parameters:
      - in: formData
        name: RequestBody
        required: true
        type: string
        description: <table class="table-style-three"><tbody><tr align="center"><td style="vertical-align:middle" width='100'><strong>Field Name </strong></td><td style="vertical-align:middle" width='100'><strong>Data Type </strong></td><td style="vertical-align:middle" width='100'><strong>Mandatory </strong></td><td style="vertical-align:middle" width='300'><strong>Description </strong></td></tr><tr align="center"><td style="vertical-align:middle">order_no</td><td style="vertical-align:middle">Array</td><td style="vertical-align:middle">Mandatory*</td><td style="vertical-align:middle">*Only if details by order number</td></tr><tr align="center"><td style="vertical-align:middle">status</td><td style="vertical-align:middle">Arra

# --- truncated at 32 KB (62 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vinculum/refs/heads/main/openapi/vinculum-order-returns-api-openapi.yml