Vinculum Vendors API
API to retrieve or manipulate Vendor related information.
OpenAPI Specification
swagger: '2.0'
info:
title: Vinculum Advance Shipping Notice Vendors API
description: API to retrieve or manipulate ASN related information.
host: erp.vineretail.com
tags:
- name: Vendors
description: API to retrieve or manipulate Vendor related information.
paths:
/RestWS/api/eretail/v1/master/vendorCreate:
post:
tags:
- Vendors
summary: API For Creating Vendor(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">ext_vendor_code</td><td style="vertical-align:middle">Varchar(50)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">Ext Vendor Code must not exceed 50 characters</td></tr><tr align="center"><td style="vertical-align:middle">parent_vendor_code</td><td style="vertical-align:middle">Varchar(10)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Parent Vendor code in external system</td></tr><tr align="center"><td style="vertical-align:middle">vendor_name</td><td style="vertical-align:middle">Varchar(100)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">Name of the vendor</td></tr><tr align="center"><td style="vertical-align:middle">status</td><td style="vertical-align:middle">Varchar(200)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">Status of vendor. Possible values are - Pending Confirmation, Confirmed, Deactivated</td></tr><tr align="center"><td style="vertical-align:middle">vendor_shortname</td><td style="vertical-align:middle">Varchar(20)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Short name of vendor</td></tr><tr align="center"><td style="vertical-align:middle">ext_paymentterm</td><td style="vertical-align:middle">Varchar(200)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Payment Term</td></tr><tr align="center"><td style="vertical-align:middle">taxZone</td><td style="vertical-align:middle">Varchar(100)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">As per the Masters</td></tr><tr align="center"><td style="vertical-align:middle">vendorCurrency</td><td style="vertical-align:middle">Varchar(10)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">ISO currency code</td></tr><tr align="center"><td style="vertical-align:middle">vendorType</td><td style="vertical-align:middle">Varchar(200)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Possible values are Outright Purchase ,Marketplace,JIT(default Outright Purcahse if not passing)</td></tr><tr align="center"><td style="vertical-align:middle">defaultDeliveryMode</td><td style="vertical-align:middle">Varchar(200)</td><td style="vertical-align:middle">*Conditional</td><td style="vertical-align:middle">Possible Values Drop Ship, Ship via FC, Vendor Self Delivery, Defined in Codelkup with lkupcode 'DLVRMOD'.Mandatory when vendorType is of type Marketplace.</br>This is mandatory when vendorType is of type Marketplace.</td></tr><tr align="center"><td style="vertical-align:middle">returnDays</td><td style="vertical-align:middle">Integer</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Return acceptance days for the Vendor</td></tr><tr align="center"><td style="vertical-align:middle">costDerivative</td><td style="vertical-align:middle">Varchar(20)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Possible values are Gross, Net</td></tr><tr align="center"> <td style="vertical-align:middle" >shipAddress1</td> <td style="vertical-align:middle" >Varchar(250)</td> <td style="vertical-align:middle" >Mandatory</td> <td style="vertical-align:middle" >line 1 of vendor's shipping address</td></tr><tr align="center"><td style="vertical-align:middle" >shipAddress2</td><td style="vertical-align:middle" >Varchar(250)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >line 2 of vendor's shipping address</td></tr><tr align="center"><td style="vertical-align:middle" >shipAddress3</td><td style="vertical-align:middle" >Varchar(250)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >line 3 of vendor's shipping address</td></tr><tr align="center"><td style="vertical-align:middle" >shipContactPerson</td><td style="vertical-align:middle" >Varchar(200)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >Contact name of person at Shipping Address</td></tr><tr align="center"><td style="vertical-align:middle" >shipPhone</td><td style="vertical-align:middle" >Varchar(20)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >Contact No. of Vendor's Shipping address</td></tr><tr align="center"><td style="vertical-align:middle" >shipEmail</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">Email Id of Vendor's Shipping address</td></tr><tr align="center"><td style="vertical-align:middle" >shipCity</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >City Name of Vendor's Shipping adress</td></tr><tr align="center"><td style="vertical-align:middle" >shipState</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >State Name of Vendor's Shipping Address</td></tr><tr align="center"><td style="vertical-align:middle" >shipCountry</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >Country Name of vendor's Shipping Address</td></tr><tr align="center"><td style="vertical-align:middle" >shipPincode</td><td style="vertical-align:middle" >Varchar(10)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >Pincode of Vendor's Shipping Address</td></tr><tr align="center"><td style="vertical-align:middle" >latitude</td><td style="vertical-align:middle" >Varchar(100)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Latitudes range from -90 to 90, e. g. 17.572375290155</td></tr><tr align="center"><td style="vertical-align:middle" >longitude</td><td style="vertical-align:middle" >Varchar(100)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Longitudes range from -180 to 80, e. g. -179.572375290155</td></tr><tr align="center"><td style="vertical-align:middle" >billContactPerson</td><td style="vertical-align:middle" >Varchar(255)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >Contact name of person at billing Address</td></tr><tr align="center"><td style="vertical-align:middle" >billAddress1</td><td style="vertical-align:middle" >Varchar(250)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >line 1 of vendor's billing address</td></tr><tr align="center"><td style="vertical-align:middle" >billAddress2</td><td style="vertical-align:middle" >Varchar(250)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >line 2 of vendor's billing address</td></tr><tr align="center"><td style="vertical-align:middle" >billAddress3</td><td style="vertical-align:middle" >Varchar(250)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >line 3 of vendor's billing address</td></tr><tr align="center"><td style="vertical-align:middle" >billPhone</td><td style="vertical-align:middle" >Varchar(255)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >Contact No. of Vendor's billing address</td></tr><tr align="center"><td style="vertical-align:middle" >billEmail</td><td style="vertical-align:middle" >Varchar(255)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >Email Id of Vendor's billing address</td></tr><tr align="center"><td style="vertical-align:middle" >billCity</td><td style="vertical-align:middle" >Varchar(40)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >City Name of Vendor's billing adress</td></tr><tr align="center"><td style="vertical-align:middle" >billState</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >State Name of Vendor's billing Address</td></tr><tr align="center"><td style="vertical-align:middle" >billCountry</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >Country Name of vendor's billing Address</td></tr><tr align="center"><td style="vertical-align:middle" >billPincode</td><td style="vertical-align:middle" >Varchar(255)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">Pincode of Vendor's billing Address</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 fields</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 fields</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 fields</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 fields</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 fields</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 fields</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 fields</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 fields</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 fields</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 fields</td></tr> <tr align="center"><td style="vertical-align:middle" >cstno</td><td style="vertical-align:middle" >Varchar(20)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">CST of vendor</td></tr><tr align="center"><td style="vertical-align:middle" >vatno</td><td style="vertical-align:middle" >Varchar(20)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">vat of vendor</td></tr><tr align="center"><td style="vertical-align:middle" >tinno</td><td style="vertical-align:middle" >Varchar(20)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">tin of vendor</td></tr><tr align="center"><td style="vertical-align:middle" >digitalsignatureurl</td><td style="vertical-align:middle" >Varchar(300)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">digital signature Url of vendor</td></tr><tr align="center"><td style="vertical-align:middle" >digitalsignaturebytestream</td><td style="vertical-align:middle" >Byte Array</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle"></td></tr><tr align="center"><td style="vertical-align:middle" >linkToStore</td><td style="vertical-align:middle" >Varchar</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">1 or more than 1 store can be linked comma seprated</td></tr><tr align="center"><td style="vertical-align:middle" >locCode</td><td style="vertical-align:middle" >Varchar(5)</td><td style="vertical-align:middle">Conditional</td><td style="vertical-align:middle">Mandatory to be filled in case VendorType = "JIT" else non-mandatory.</td></tr><tr align="center"><td style="vertical-align:middle" >byPassSKUVendorLink</td><td style="vertical-align:middle" >Varchar(5)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Possible values are YES or NO</td></tr><tr align="center"><td style="vertical-align:middle" >invoiceNoBy</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Possible values are market place or self</td></tr><tr align="center"><td style="vertical-align:middle" >allowHopping</td><td style="vertical-align:middle" >Varchar(5)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Possible values are YES or NO</td></tr><tr align="center"><td style="vertical-align:middle" >sla</td><td style="vertical-align:middle" >smallint</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Possible values are in hours only</td></tr><tr align="center"><td style="vertical-align:middle" >panNo</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">PAN No. of Vendor</td></tr><tr align="center"><td style="vertical-align:middle" >bankName</td><td style="vertical-align:middle" >Varchar(100)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">bankName</td></tr><tr align="center"><td style="vertical-align:middle" >accountNo</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">accountNo</td></tr><tr align="center"><td style="vertical-align:middle" >branchName</td><td style="vertical-align:middle" >Varchar(100)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">branchName</td></tr><tr align="center"><td style="vertical-align:middle" >branchAddress</td><td style="vertical-align:middle" >Varchar(250)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">branchAddress</td></tr><tr align="center"><td style="vertical-align:middle" >ifscCode</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">IFSCCoder</td></tr><tr align="center"><td style="vertical-align:middle" >swiftCode</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">swiftCode</td></tr><tr align="center"><td style="vertical-align:middle" >micrCode</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">MICRCode</td></tr><tr align="center"><td style="vertical-align:middle" >minOrderValue</td><td style="vertical-align:middle" >Integer</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">minOrderValue</td></tr><tr align="center"><td style="vertical-align:middle" >isTaxExempted</td><td style="vertical-align:middle" >Varchar(12)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">isTaxExempted</td></tr><tr align="center"><td style="vertical-align:middle" >glCode</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">GLCode</td></tr><tr align="center"><td style="vertical-align:middle" >isCostBasedOnMargin</td><td style="vertical-align:middle" >Varchar(5)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">isCostBasedOnMargin</td></tr><tr align="center"><td style="vertical-align:middle" >gstinno</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">gstinno of Vendor</td></tr><tr align="center"><td style="vertical-align:middle" >endEffDate</td><td style="vertical-align:middle" >Varchar(12)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">PAN No. of Vendor</td></tr><tr align="center"><td style="vertical-align:middle" >returnFlag</td><td style="vertical-align:middle" >tinyint(1)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Possible values are 1 and 0</td></tr><tr align="center"><td style="vertical-align:middle" >isAutoPO</td><td style="vertical-align:middle" >Varchar(5)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Possible values are True or false</td></tr><tr align="center"><td style="vertical-align:middle" >licenseNo</td><td style="vertical-align:middle" >Varchar(20)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">license No. of Vendor</td></tr><tr align="center"><td style="vertical-align:middle" >otpValidation</td><td style="vertical-align:middle" >Varchar(5)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Possible value Yes or No </td></tr><tr align="center"><td style="vertical-align:middle" >vendorChannelType</td><td style="vertical-align:middle" >Varchar(200)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Channel associated with Vendor, Defined in Codelkup with lkupcode 'VENDCHNLTYP'</td></tr><tr align="center"><td style="vertical-align:middle" >skipPhoneEmailValidation</td><td style="vertical-align:middle" >Varchar(5)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Possible value Yes or No </td></tr><tr align="center"><td style="vertical-align:middle" >diRecValidation</td><td style="vertical-align:middle" >Varchar(20)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle"> Pass recvValidCode to be applied for Direct Inbound</td></tr><tr align="center"><td style="vertical-align:middle" >poRecValidation</td><td style="vertical-align:middle" >Varchar(20)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Pass recvValidCode to be applied for PO Inbound(Priority - PO level if provided)</td></tr><tr align="center"><td style="vertical-align:middle" >asnRecValidation</td><td style="vertical-align:middle" >Varchar(20)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Pass recvValidCode to be applied for ASN Inbound</td></tr><tr align="center"><td style="vertical-align:middle" >vendorToEmail</td><td style="vertical-align:middle" >Array</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Vendor:To Email</td></tr><tr align="center"><td style="vertical-align:middle" >vendorCcEmail</td><td style="vertical-align:middle" >Array</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Vendor:CC Email</td></tr><tr><td style="vertical-align:middle" colspan=4> <b>Input JSON Format-<br/> {<br/> "vendor":<br/> {<br/> "ext_vendor_code":"VEND001",<br/> "parent_vendor_code":"ABC123",<br/> "vendor_name":"RG Textiles",<br/> "status":" Pending Confirmation",<br/> "vendor_shortname":"Raghu Ram",<br/> "ext_paymentterm":"7 DAYS",<br/> "taxZone":"delhi",<br/> "vendorCurrency":"INR",<br/> "vendorType":"Outright Purchase",<br/> "defaultDeliveryMode":"",<br/> "returnDays":"10",<br/> "costDerivative":"Gross",<br/> "shipAddress1":"dslkjfgnsjkvn",<br/> "shipAddress2":"",<br/> "shipAddress3":"",<br/> "shipContactPerson":"Mr. Raghu",<br/> "shipPhone":"9876543210",<br/> "shipEmail":"rgtax@gmail.com",<br/> "shipState":"Haryana",<br/> "shipCountry":"INDIA",<br/> "shipCity":"Ambala",<br/> "shipPincode":"382039",<br/> "latitude":"54.23",<br/> "longitude":"120.22",<br/> "billAddress1":"dslkjfgnsjkvn",<br/> "billAddress2":"",<br/> "billAddress3":"",<br/> "billContactPerson":"Mr. Raghu",<br/> "billPhone":"9876543210",<br/> "billEmail":"rgtax@gmail.com",<br/> "billState":"Haryana",<br/> "billCountry":"INDIA",<br/> "billCity":"Ambala",<br/> "billPincode":"382039",<br/> "udf1":"",<br/> "udf2":"",<br/> "udf3":"",<br/> "udf4":"",<br/> "udf5":"",<br/> "udf6":"",<br/> "udf7":"",<br/> "udf8":"",<br/> "udf9":"",<br/> "udf10":"",<br/> "cstno":"",<br/> "vatno":"",<br/> "tinno":"",<br/> "digitalsignatureurl":" http://static.vineretail.com/eRetailWeb/ClientLogo.jpg ",<br/> "digitalsignaturebytestream":" /9j/4AAQSkZJRgABAQEAYABgAAD/4QBaRXhpZ",<br/> "linkToStore":"IWH,UWH,LWH",<br/> "locCode":"IWH",<br/> "byPassSKUVendorLink":"YES",<br/> "invoiceNoBy":"",<br/> "allowHopping":"",<br/> "sla":"",<br/> "panNo":"",<br/> "bankName":"",<br/> "accountNo":"",<br/> "branchName":"",<br/> "branchAddress":"",<br/> "ifscCode":"",<br/> "swiftCode":"",<br/> "micrCode":"",<br/> "minOrderValue":"",<br/> "isTaxExempted":"",<br/> "glCode":"",<br> "isCostBasedOnMargin":"",<br/> "gstinno":"",<br/> "endEffDate":"",<br/> "returnFlag":"",<br/> "isAutoPO":"",<br/> "licenseNo":"",<br/> "otpValidation":"",<br/> "vendorChannelType":"",<br/> "skipPhoneEmailValidation":"",<br/> "diRecValidation":"",<br/> "poRecValidation":"",<br/> "asnRecValidation":"",<br/> "vendorToEmail":["empire12@gmail.com","samsung10@gmail.com"],<br/> "vendorCcEmail":["empire1@gmail.com","samsung1@gmail.com"]<br/> }<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><tr align="center"><td style="vertical-align:middle" width='167'><p>1001</p></td><td style="vertical-align:middle" width='167'><p>Vendor Creation Error while processing</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>1002</p></td><td style="vertical-align:middle" width='167'><p>Ext Vendor Code is mandatory</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>1003</p></td><td style="vertical-align:middle" width='167'><p>Ship Phone length should not be greater than 20 characters</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>1004</p></td><td style="vertical-align:middle" width='167'><p>Ship Email length should not be greater than 50 characters</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>E10117</p></td><td style="vertical-align:middle" width='167'><p> Please Enter Valid TOMail {0}</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>E10118</p></td><td style="vertical-align:middle" width='167'><p>Please Enter Valid CCMail {0}</p></td></tr></tbody></table>
schema:
$ref: '#/definitions/VendorCreateResponse'
/RestWS/api/eretail/v1/vendor/vendordetail:
post:
tags:
- Vendors
summary: Max no. of Lines/Response:100 API For Vendor Details(Hit Quota 40/5 min)
consumes:
- application/x-www-form-urlencoded
produces:
- application/json
parameters:
- in: formData
name: RequestBody
type: string
description: <table class="table-style-three"><tbody><tr><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">vendorCodes</td><td style="vertical-align:middle">Array</td><td style="vertical-align:middle">Conditional</td><td style="vertical-align:middle">*Only if details by vendor, Max 100</td></tr><tr align="center"><td style="vertical-align:middle">date_from</td><td style="vertical-align:middle">Datetime</td><td style="vertical-align:middle">Conditional</td><td style="vertical-align:middle">*Only if details by filter (DD/MM/YYYY HH:mm:ss)</td></tr><tr align="center"><td style="vertical-align:middle">date_to</td><td style="vertical-align:middle">Datetime</td><td style="vertical-align:middle">Conditional</td><td style="vertical-align:middle">*Only if details by filter (DD/MM/YYYY HH:mm:ss)</td></tr><tr align="center"><td style="vertical-align:middle">pageNumber</td><td style="vertical-align:middle">Integer</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Default 1. (Page Size 100 Orders)</td></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 vendorCodes at time.</td></tr><tr><td colspan=5> <b>Case 1- When Vendor List is passed</b><br/> <b>{<br/> "vendorCodes":["VEND001"],</br> "date_from":"",<br/> "date_to":"",</br> "pageNumber":"1"   <br/> }</b><br/><br/><br/> <b>Case 2- With Date Range</b><br/> <b>{<br/> "vendorCodes":[],</br> "date_from":"01/08/2017 00:00:00",<br/> "date_to":"01/08/2017 00:00:00",</br> "pageNumber":"1"  <br/> }</b></td></tr></tbody></table><p> </p><br/>
required: true
- in: formData
name: ApiOwner
type: string
description: This Field Will Be Used To Send API Owner
required: true
- in: formData
name: ApiKey
type: string
description: This is the API Key
required: true
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>3005</p></td><td style="vertical-align:middle" width='167'><p>No. of Vendors cannot be more than 100</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>3006</p></td><td style="vertical-align:middle" width='167'><p>Either Vendor code OR date is mandatory</p></td></tr></tbody></table>
schema:
$ref: '#/definitions/vendordetail'
/RestWS/api/eretail/v1/vendor/vendlocskumapping/create:
post:
tags:
- Vendors
summary: Max no. of Lines/hit:50 API For Vendor Location SKU Mapping(Hit Quota 40/5 min)
consumes:
- application/json
produces:
- application/json
parameters:
- in: header
name: ApiOwner
required: true
type: string
description: API Owner.
- in: header
name: ApiKey
required: true
type: string
description: API Key.
- in: body
name: VendlocskumappingJSON
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">skuCode</td><td style="vertical-align:middle">Varchar(50)</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">vendorSkuCode</td><td style="vertical-align:middle">Varchar(255)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Seller SKU code if any</td></tr><tr align="center"><td style="vertical-align:middle">vendorCode</td><td style="vertical-align:middle">Varchar(255)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">Vendor code as per masters</td></tr><tr align="center"><td style="vertical-align:middle">skuCost</td><td style="vertical-align:middle">decimal(20,5)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">It should be numeric value</td></tr><tr align="center"><td style="vertical-align:middle">leadTime</td><td
# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vinculum/refs/heads/main/openapi/vinculum-vendors-api-openapi.yml