Vinculum

Vinculum Common API

API to facilitate Common Operations.

Documentation GitHub OpenAPI

Operations 12

POST /RestWS/api/eretail/v1/common/checkRequestStatus API For Checking Request Status(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v1/customer/custCreate Max no. of Lines/hit:50 API For Customer Create/Update(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v1/customer/detail Max no. of Lines/Response:100. Max Allowed Phone Numbers/EmailId- 100. API For Customer Details(Hit Quota 40/5 min)

POST /RestWS/api/tally/getDocumentAck Max Allowed Date Range- 7 Days.API For Tally Details(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v1/common/skuCategoryDetail Max no. of Lines/Response:100 API For Get Sku Category Detail(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v1/common/lpnUpdate Max no. of Lines/hit:50 API For lpnUpdate(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v1/master/locationFetch Max no. of Lines/Response:50 API For Get Locations Detail(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v1/channel/createEdit API For Channel Create Update(Hit Quota 40/5 min)

POST /RestWS/api//eretail/v1/common/channelInfo API For Get channelinfo(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v1/master/clientCreate API For Create Client(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v1/order/updatePackagingDimensions API For Updating Packaging Dimensions(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v1/common/NDR API For NDR ProposedPayload(Hit Quota 40/5 min)

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-common-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/vinculum-common-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Vinculum Common API
  description: API to facilitate Common Operations.
servers:
- url: https://erp.vineretail.com
tags:
- name: Common
  description: API to facilitate Common Operations.
paths:
  /RestWS/api/eretail/v1/common/checkRequestStatus:
    post:
      tags:
      - Common
      summary: API For Checking Request Status(Hit Quota 40/5 min)
      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 align="center"><td style="vertical-align:middle" width='167' colspan=2><p>Please Check Error messages and codes into common error section</p></td></tr></tbody></table><table> <tbody> <td style="vertical-align:middle" colspan=4> <b>Output- (When request is NOT processed)</br>&nbsp;{</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"responseCode":0,</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"responseMessage":"Success",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"requestStatusList":[</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"uniqueKey":"300301",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"requestKey":"300301",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"outputKey":null,</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"status":"WIP",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"errorDesc":null</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"uniqueKey":"300302",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;. . . . . .</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;]</br>&nbsp;}</br></br>&nbsp;Case1- Output (When request is processed):</br>&nbsp;{</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"responseCode":0,</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"responseMessage":"Success",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"requestStatusList":[</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"uniqueKey":"300301",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"requestKey ":"300301",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"outputKey ":"TWH955",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"status":"Success",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"errorDesc":null</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"uniqueKey":"300302",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;. . . . . .</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;]</br>&nbsp;}</br></br>&nbsp;Case2- Output (When request is failed):</br>&nbsp;{</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"responseCode":0,</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"responseMessage":"Success",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"requestStatusList":[</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"uniqueKey":"300301",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"requestKey":"300301",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"outputKey":"TWH955",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"status":" Error",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"errorDesc":""</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"uniqueKey":"300302",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;. . . . . .</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;]</br>&nbsp;}</b></tbody></table>
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                RequestBody:
                  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">requestId</td><td style="vertical-align:middle">Varchar(50)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">Provided requested ID</td></tr><tr><td style="vertical-align:middle" colspan=4> <b>Input JSON Format-<br/> {<br/> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"requestId":"ab98a12f538f4b78bc57ead6587b209c"<br/>&nbsp;}</b><br/><br/></td></tr></tbody></table>
                ApiOwner:
                  type: string
                  description: API Owner.
                ApiKey:
                  type: string
                  description: API Key.
              required:
              - RequestBody
              - ApiOwner
              - ApiKey
  /RestWS/api/eretail/v1/customer/custCreate:
    post:
      tags:
      - Common
      summary: Max no. of Lines/hit:50 API For Customer Create/Update(Hit Quota 40/5 min)
      parameters:
      - in: header
        name: ApiOwner
        required: true
        description: API Owner.
        schema:
          type: string
      - in: header
        name: ApiKey
        required: true
        description: API Key.
        schema:
          type: string
      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>2050</p></td><td style="vertical-align:middle" width='167'><p>Customer Name Is A Mandatory Field. It Cannt Be Left Null Or Blank.</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>2051</p></td><td style="vertical-align:middle" width='167'><p>Customer Type Is A Mandatory Field. It Cannt Be Left Null Or Blank. If You Have Sent You The Customer Type, It Does Not Exist With Us</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>2052</p></td><td style="vertical-align:middle" width='167'><p>Bill Address 1 Is A Mandatory Field. It Cannt Be Left Null Or Blank</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>2053</p></td><td style="vertical-align:middle" width='167'><p>Bill Phone Is A Mandatory Field. It Cannt Be Left Null Or Blank</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>2054</p></td><td style="vertical-align:middle" width='167'><p>Bill E-Mail Is A Mandatory Field. It Cannt Be Left Null Or Blank</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>2055</p></td><td style="vertical-align:middle" width='167'><p>Bill Country Is A Mandatory Field. It Cannt Be Left Null Or Blank. If You Have Sent The Bill Contry, This Bill Country Doesnot Exists With Us.</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>2056</p></td><td style="vertical-align:middle" width='167'><p>Address 1 Is A Mandatory Field. It Cannt Be Left Null Or Blank</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>2057</p></td><td style="vertical-align:middle" width='167'><p>Phone Is A Mandatory Field. It Cannt Be Left Null Or Blank</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>2058</p></td><td style="vertical-align:middle" width='167'><p>E-Mail Is A Mandatory Field. It Cannt Be Left Null Or Blank</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>2059</p></td><td style="vertical-align:middle" width='167'><p>Country Is A Mandatory Field. It Cannt Be Left Null Or Blank. If You Have Sent The Contry, This Country Doesnot Exist With Us.</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>2060</p></td><td style="vertical-align:middle" width='167'><p>State Is A Mandatory Field. It Cannt Be Left Null Or Blank. If You Have Sent The State, This State Does Not Exist Under The Given Country.</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>2061</p></td><td style="vertical-align:middle" width='167'><p>Other Address 1 Is A Mandatory Field. It Cannt Be Left Null Or Blank</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>2062</p></td><td style="vertical-align:middle" width='167'><p>Other Phone Is A Mandatory Field. It Cannt Be Left Null Or Blank</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>2063</p></td><td style="vertical-align:middle" width='167'><p>Other E-Mail Is A Mandatory Field. It Cannt Be Left Null Or Blank</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>2064</p></td><td style="vertical-align:middle" width='167'><p>Other Country Is A Mandatory Field. It Cannt Be Left Null Or Blank. If You Have Sent The Contry, This Country Does Not Exist With Us.</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>2065</p></td><td style="vertical-align:middle" width='167'><p>Other State Is A Mandatory Field. It Cannt Be Left Null Or Blank. If You Have Sent The State, This State Does Not Exist Under The Given Country.</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>2066</p></td><td style="vertical-align:middle" width='167'><p>Customer Code Supplied In The Request For Update Does Not Exists. You Can Leave This Field Blank For Creating New Customer.</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>2067</p></td><td style="vertical-align:middle" width='167'><p>Bill State Is A Mandatory Field. It Cannt Be Left Null Or Blank. If You Have Sent The Bill State, This Bill State Doesnot Exists Under The Given Country.</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>2068</p></td><td style="vertical-align:middle" width='167'><p>Customer Already Exists With Bill Phone Number Supplied In The Request. Please Do Change The Bill Phone Number.</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>2069</p></td><td style="vertical-align:middle" width='167'><p>Customer Already Exists With Bill E-Mail Supplied In The Request. Please Do Change The Bill E-Mail.</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>2070</p></td><td style="vertical-align:middle" width='167'><p>Customer Already Exists With Phone Number Supplied In The Request. Please Do Change The Phone Number.</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>2071</p></td><td style="vertical-align:middle" width='167'><p>Customer Already Exists With E-Mail Supplied In The Request. Please Do Change The E-Mail.</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>2073</p></td><td style="vertical-align:middle" width='167'><p>Phone cannot be more than 50 characters</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>2074</p></td><td style="vertical-align:middle" width='167'><p>Other Addresses Phone cannot be more than 20 characters</p></td></tr></tbody></table>
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custCreate2'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - order_no
              properties:
                customers:
                  type: array
                  items:
                    $ref: '#/components/schemas/custCreate0'
        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">customerCode</td><td style="vertical-align:middle">Integer</td><td style="vertical-align:middle">Conditional</td><td style="vertical-align:middle">Mandatory for Customer Update Request. On creation of a Customer, Customer Code is not to be passed.</td></tr><tr align="center"><td style="vertical-align:middle">extCustomerCode</td><td style="vertical-align:middle">Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Customer code in external system</td></tr><tr align="center"><td style="vertical-align:middle">customerName</td><td style="vertical-align:middle">Varchar(100)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">Name of the Customer</td></tr><tr align="center"><td style="vertical-align:middle">isActive</td><td style="vertical-align:middle">Varchar(5)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Default Yes, Possible values are Yes or No</td></tr><tr align="center"><td style="vertical-align:middle">customerType</td><td style="vertical-align:middle">Varchar(5)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">Customer type as defined in other Master's</td></tr><tr align="center"><td style="vertical-align:middle">address1</td><td style="vertical-align:middle">Varchar(1000)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">Address1 of Customer</td></tr><tr align="center"><td style="vertical-align:middle">address2</td><td style="vertical-align:middle">Varchar(200)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Address2 of Customer</td></tr><tr align="center"><td style="vertical-align:middle">address3</td><td style="vertical-align:middle">Varchar(200)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Address3 of Customer</td></tr><tr align="center"><td style="vertical-align:middle">address4</td><td style="vertical-align:middle">Varchar(255)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Address4 of Customer</td></tr><tr align="center"><td style="vertical-align:middle">phone</td><td style="vertical-align:middle">Varchar(50)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">Phone No. of Customer</td></tr><tr align="center"><td style="vertical-align:middle">altPhone</td><td style="vertical-align:middle">Varchar(20)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Alternate phone No. of Customerter</td></tr><tr align="center"><td style="vertical-align:middle">fax</td><td style="vertical-align:middle">Varchar(20)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Fax No. of Customer</td></tr><tr align="center"><td style="vertical-align:middle">email1</td><td style="vertical-align:middle">Varchar(255)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">Email id 1 of Customer</td></tr><tr align="center"><td style="vertical-align:middle">email2</td><td style="vertical-align:middle">Varchar(255)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Email id 2 of Customer</td></tr><tr align="center"><td style="vertical-align:middle">country</td><td style="vertical-align:middle">Varchar(5)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">It should exist in country table. If it is not present in country table, it doesnt allow to create the customer</td></tr><tr align="center"><td style="vertical-align:middle">state</td><td style="vertical-align:middle">Varchar(5)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">It should exist in state table. If it is not present in state table,  it doesnt allow to create the customer</td></tr><tr align="center"><td style="vertical-align:middle">city</td><td style="vertical-align:middle">Varchar(40)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">City of Customer</td></tr><tr align="center"><td style="vertical-align:middle">pinCode</td><td style="vertical-align:middle">Varchar(20)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Pincode of Customer</td></tr><tr align="center"><td style="vertical-align:middle">billAddress1</td><td style="vertical-align:middle">Varchar(1000)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">Billing Address 1 of Customer</td></tr><tr align="center"><td style="vertical-align:middle">billAddress2</td><td style="vertical-align:middle">Varchar(200)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Billing Address 2 of Customer</td></tr><tr align="center"><td style="vertical-align:middle">billAddress3</td><td style="vertical-align:middle">Varchar(200)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Billing Address 3 of Customer</td></tr><tr align="center"><td style="vertical-align:middle">billAddress4</td><td style="vertical-align:middle">Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Billing Address 4 of Customer</td></tr><tr align="center"><td style="vertical-align:middle">billPhone</td><td style="vertical-align:middle">Varchar(50)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">Billing phone No. of Customer</td></tr><tr align="center"><td style="vertical-align:middle">billAltPhone</td><td style="vertical-align:middle">Varchar(20)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">Alternate billing phone No. of Customer</td></tr><tr align="center"><td style="vertical-align:middle">billFax</td><td style="vertical-align:middle">Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Billing Fax No. of Customer</td></tr><tr align="center"><td style="vertical-align:middle">billEmail1</td><td style="vertical-align:middle">Varchar(255)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">Billing email id 1 of Customer</td></tr><tr align="center"><td style="vertical-align:middle">billEmail2</td><td style="vertical-align:middle">Varchar(255)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Billing email id 2 of Customer</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">It should exist in country table. If it is not present in country table,  it doesnt allow to create the customer</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">It should exist in state table. If it is not present in state table,  it doesnt allow to create the customer</td></tr><tr align="center"><td style="vertical-align:middle">billCity</td><td style="vertical-align:middle">Varchar(150)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Bill City of Customer</td></tr><tr align="center"><td style="vertical-align:middle">billPinCode</td><td style="vertical-align:middle">Varchar(20)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Bill Pincode of Customer</td></tr><tr align="center"><td style="vertical-align:middle">paymentTerms</td><td style="vertical-align:middle">Integer(6)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Should exist in CODELKUP  where lookup code is "PMTTERM"</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">Optional</td><td style="vertical-align:middle">It refers to the GSTIN/TIN no of the Customer</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">Optional</td><td style="vertical-align:middle">It should exist in taxzone table. If it is not present in the table,  it doesnt allow to create the customer</td></tr><tr align="center"><td style="vertical-align:middle">priceZone</td><td style="vertical-align:middle">Integer(5)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">It should exist in pricezonemaster table. If it is not present in the table,  it doesnt allow to create the customer. gives an error.</td></tr><tr align="center"><td style="vertical-align:middle">udf1</td><td style="vertical-align:middle">Varchar(200)</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(2000)</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(255)</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(100)</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(100)</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(100)</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(100)</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(100)</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(100)</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(100)</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">isformC</td><td style="vertical-align:middle">Varchar(1)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Possible values are Yes/No</td></tr><tr align="center"><td style="vertical-align:middle">panNo</td><td style="vertical-align:middle">Varchar(12)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Pan No. of Customer</td></tr><tr align="center"><td style="vertical-align:middle">gstNo</td><td style="vertical-align:middle">Varchar(25)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">It refers to the Tax Ref No of the Customer</td></tr><tr align="center"><td style="vertical-align:middle">shelflifeonPicking</td><td style="vertical-align:middle">Integer(6)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">No. of days of Shelf Life on Picking for SKU(s) as agreed by the user and the customer</td></tr><tr align="center"><td style="vertical-align:middle">totalShelfLife</td><td style="vertical-align:middle">Integer</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">No. of days of Total shelf like for SKU(s) as agreed by the user and the customer.</td></tr><tr align="center"><td style="vertical-align:middle">isTaxExempt</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/no</td></tr><tr align="center"><td style="vertical-align:middle">economiczone</td><td style="vertical-align:middle">varchar(5)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Possible value is SEZ</td></tr><tr align="center"><td style="vertical-align:middle">creditDays</td><td style="vertical-align:middle">Integer</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle"> Number of credit days applicable for customer</td></tr><tr align="center"><td style="vertical-align:middle">isTCSApplicable</td><td style="vertical-align:middle">Varchar(5)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">Possible values are yes/no</td></tr><tr align="center"><td style="vertical-align:middle">tcsPercentage</td><td style="vertical-align:middle">decimal(10,3)</td><td style="vertical-align:middle">Conditional**</td><td style="vertical-align:middle">Mandatory when isTCSApplicable is "yes", Possible values are 0.075/0.75/0.1/1</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" >geoType</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Optional</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" >Varchar(50)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Geocode latitude</td></tr><tr align="center"><td style="vertical-align:middle" >geoLongitude</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" > Geocode longitude</td></tr><tr align="center"><td style="vertical-align:middle" >identificationId </td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Identification Id of customer</td></tr><tr align="center"><td style="vertical-align:middle" >identificationCode</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Conditional</td><td style="vertical-align:middle" > if identificationId is not null then identificationCode is mandatory</td></tr><tr align="center"><td style="vertical-align:middle" >pickingInstructions</td><td style="vertical-align:middle" >Array</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" > Maximum allowded are 10</td></tr><tr align="center"><td style="vertical-align:middle" >shippingInstructions</td><td style="vertical-align:middle" >Array</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" > Maximum allowded are 10</td></tr><tr align="center"><td style="vertical-align:middle" >landmark</td><td style="vertical-align:middle" >Varchar(100)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Nearby reference location of shipping address</td></tr><tr align="center"><td style="vertical-align:middle" colspan=4 ><b>addresses Fields</b></td></tr><tr align="center"><td style="vertical-align:middle">address1</td><td style="vertical-align:middle">Varchar(1000)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">Address1 of Customer</td></tr><tr align="center"><td style="vertical-align:middle">address2</td><td style="vertical-align:middle">Varchar(200)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Address2 of Customer</td></tr><tr align="center"><td style="vertical-align:middle">address3</td><td style="vertical-align:middle">Varchar(200)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Address3 of Customer</td></tr><tr align="center"><td style="vertical-align:middle">phone</td><td style="vertical-align:middle">Varchar(20)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">Phone No. of Customer</td></tr><tr align="center"><td style="vertical-align:middle">altPhone</td><td style="vertical-align:middle">Varchar(20)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Alternate Phone No. of Customer</td></tr><tr align="center"><td style="vertical-align:middle">fax</td><td style="vertical-align:middle">Varchar(20)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Fax No. of Customer</td></tr><tr align="center"><td style="vertical-align:middle">email1</td><td style="vertical-align:middle">Varchar(255)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">Email Id 1 of Customer</td></tr><tr align="center"><td style="vertical-align:middle">email2</td><td style="vertical-align:middle">Varchar(255)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Email Id 2 of Customer</td></tr><tr align="center"><td style="vertical-align:middle">country</td><td style="vertical-align:middle">Varchar(10)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">It should exist in country table.If it is not present in country table,  it doesnt allow to create the customer</td></tr><tr align="center"><td style="vertical-align:middle">state</td><td style="vertical-align:middle">Varchar(10)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">It should exist in state table.If it is not present in state table,  it doesnt allow to create the customer</td></tr><tr align="center"><td style="vertical-align:middle">city</td><td style="vertical-align:middle">Varchar(40)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">City Name of Customer</td></tr><tr align="center"><td style="vertical-align:middle">pinCode</td><td style="vertical-align:middle">Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">pincode of Customer</td></tr><tr align="center"><td style="vertical-align:middle">remarks</td><td style="vertical-align:middle">Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Remarks</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">User defined field</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">User defined field</td></tr><tr align="center"><td style="vertical-align:middle">udf3</td><td style="vertical-align:middle">Varchar(255)</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(255)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">User defined field</td></tr

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