Vinculum

Vinculum Orders API

API to retrieve or manipulate Order related information.

Documentation GitHub OpenAPI

Operations 40

POST /RestWS/api/eretail/v1/order/create API For Creating Order(Hit Quota 80/5 min)

POST /RestWS/api/eretail/v4/order/create API For Creating Order(Hit Quota 80/5 min)

POST /RestWS/api/eretail/v1/order/createBulk Max no. of Lines/hit:100 API For Creating Bulk Order(Hit Quota 40/5 min).

POST /RestWS/api/eretail/v1/order/cancel API For Cancelling Order(Hit Quota 80/5 min)

POST /RestWS/api/eretail/v1/order/cancelLineLevel API For Cancel Line Level order(Hit Quota 80/5 min)

POST /RestWS/api/eretail/v2/order/orderUpdate Max no. of Lines/hit:1000 API for Updating order details(Hit Quota 80/5 min).

POST /RestWS/api/eretail/v1/order/orderPull Max no. Line/Response:100 API to fetch Order Details. (Hit Quota 40/5 min)

POST /RestWS/api/eretail/v2/order/orderPullV2 Max no. Line/Response:100 (Custom API) API to fetch Order Details. (Hit Quota 40/5 min)

POST /RestWS/api/eretail/v3/order/orderPull Max no. Line/Response:100 (Custom API) API to fetch Order Details. (Hit Quota 40/5 min)

POST /RestWS/api/eretail/v2/order/list Max no. of Lines/Response:100 API to fetch Order List.(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v2/order/status Max no. of Lines/Response:50 API For Order Status(Hit Quota 120/5 min)

POST /RestWS/api/eretail/v4/order/status Max no. of Lines/Response:50 API For Order Status(Hit Quota 120/5 min)

POST /RestWS/api/eretail/v1/order/customerOrder Max no. of Lines/Response:100 API For Customer Order(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v1/order/shipDetail API For Ship Details Order(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v2/order/orderInvoice Max no. of Lines/Response:50 API For Order Invoice(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v3/order/orderInvoice Max no. of Lines/Response:50 API For Order Invoice(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v1/order/orderinvoicepdf Max no. of Lines/Response:20 API For Order Invoice Pdf(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v4/order/orderinvoicepdf Max no. of Lines/Response:20 API For Order Invoice Pdf(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v1/order/getShippingLabelPdf Max no. of Lines/Response:20 API For Shipping Label PDF(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v2/order/getShippingLabelPdf Max no. of Lines/Response:20 API For Shipping Label PDF(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v2/order/customerOrder Max no. of Lines/Response:100 API For History of Customer Order(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v1/order/availableInventoryWH API to retrieve which warehouse can used to fulfill a product in the Cart(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v1/order/orderProcess API For order processing i.e. Pack and shipment create of orders having single delivery and allocated status(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v2/order/orderProcess API For order processing i.e. Pack and shipment create of orders having single delivery and allocated status(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v1/order/updateOrderDetails Max no. of Lines/hit:10 API For Update Order Details(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v1/order/orderPick Max no. of Lines/hit:1 API For Order Pick(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v1/order/orderPack Max no. of Lines/hit:1 For Order Pack/Single Delivery Process(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v1/order/orderShip Max no. of Lines/hit:1 API For Single Delivery Process(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v1/order/addToManifest API For Add To Manifest(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v1/order/downloadManifest API For Download Manifest Pdf(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v1/order/failedOrders Max no. Line/Response:50 API For Get Failed Orders Detail(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v1/order/updateChannelSkuDetails Max no. of Lines/hit:10 API For Update Channel Sku Details(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v1/order/statusUpdate Max no. of Lines/hit:50 API for Updating order details(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v1/order/kit Max no. of Lines/hit:10 API For Creating Kit Order(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v1/order/orderAllocate Max no. of Lines/Response:1 API For OrderAllocation(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v1/order/orderUnAllocate Max no. of Lines/hit:1 API For OrderUnAllocate(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v1/order/updateStatus Max no. Line/hit:1000 (Custom API) API For updateStatus(Hit Quota 40/5 min)

GET /RestWS/api/eretail/v1/order/kitDetails Max no. of Lines/Response:100 API For Get Kit Orders Detail(Hit Quota 40/5 min) #

POST /RestWS/api/eretail/v1/order/shipmentDetail API For Get Shipment Detail(Hit Quota 40/5 min)

POST /RestWS/api/eretail/v1/order/orderUnpack Max no. of Lines/Response:100 API For Order Unpack(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-orders-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-orders-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 Orders API
  description: API to retrieve or manipulate Order related information.
servers:
- url: https://erp.vineretail.com
tags:
- name: Orders
  description: API to retrieve or manipulate Order related information.
paths:
  /RestWS/api/eretail/v1/order/create:
    post:
      tags:
      - Orders
      summary: API For Creating Order(Hit Quota 80/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'><p>463</p></td><td style="vertical-align:middle" width='167'><p>Generic Error.</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><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>808</p></td><td style="vertical-align:middle" width='167'><p>Order Status mandatory for filter, Please check.</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>810</p></td><td style="vertical-align:middle" width='167'><p>Multiple Location Found in ERP for given location.</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>9006</p></td><td style="vertical-align:middle" width='167'><p>Invalid location.</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>9005</p></td><td style="vertical-align:middle" width='167'><p>Order Location is mandatory.</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><td style="vertical-align:middle" colspan=4> <b>Case 1- When order created with mode="wms" or mode ="" or no tag passed</br>&nbsp;{</br>&nbsp;&nbsp;&nbsp;&nbsp;"responseCode":0,</br>&nbsp;&nbsp;&nbsp;&nbsp;"responseMessage":"Success",</br>&nbsp;&nbsp;&nbsp;&nbsp;"requestStatus":{</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"uniqueKey":"300301",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"requestKey":"300301",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"outputKey":"TWH968",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"status":"Success",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"errorDesc":null,</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"errorCode":null</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}</br>&nbsp;}</br></br>&nbsp;Case 2- When order created with mode="dropship"</br>&nbsp;{</br>&nbsp;&nbsp;&nbsp;&nbsp;"responseCode":0,</br>&nbsp;&nbsp;&nbsp;&nbsp;"responseMessage":"Success",</br>&nbsp;&nbsp;&nbsp;&nbsp;"requestStatus":{</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"uniqueKey":"300301",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"requestKey":"300301",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"outputKey":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"status":"Success",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"errorDesc":null ,</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"errorCode":null,</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"dsOrderNo":" 300301"</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}</br>&nbsp;}</br></br>&nbsp;Case 3- When order created with mode="dropship" & "wms" both</br>&nbsp;{</br>&nbsp;&nbsp;&nbsp;&nbsp;"responseCode":0,</br>&nbsp;&nbsp;&nbsp;&nbsp;"responseMessage":"Success",</br>&nbsp;&nbsp;&nbsp;&nbsp;"requestStatus":{</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"uniqueKey":"300301",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"requestKey":"300301",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"outputKey":"TWH968",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"status":"Success",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"errorDesc":null,</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"errorCode":null,</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"dsOrderNo":"300301"</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}</br>&nbsp;}</br></br>&nbsp;Case 4- When order created with mode="dropship" with different vendor code</br>&nbsp;{</br>&nbsp;&nbsp;&nbsp;&nbsp;"responseCode":0,</br>&nbsp;&nbsp;&nbsp;&nbsp;"responseMessage":"Success",</br>&nbsp;&nbsp;&nbsp;&nbsp;"requestStatus":{</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"uniqueKey":"300301",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"requestKey":"300301",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"outputKey":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"status":"Success",</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"errorDesc":null,</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"errorCode":null,</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"dsOrderNo":"300301-1, 300301-2"</br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}</br>&nbsp;}</b></td></tr><br/></tbody></table><p>&nbsp;</p></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" >order_location</td><td style="vertical-align:middle" >Varchar(3)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >The Channel code that is used to identify the Channel/Source from where the order was received.</td></tr><tr align="center"><td style="vertical-align:middle" >master_order_no</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >The unique identifier for the master order, used to group or track related orders.</td></tr><tr align="center"><td style="vertical-align:middle" >awbNo</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Tracking Number</td></tr><tr align="center"><td style="vertical-align:middle" >uniqueKey</td><td style="vertical-align:middle" >Varchar(15)</td><td style="vertical-align:middle">Optional</td><td style="veritcal-align:middle">Field uniqueKey is a unique identifier to identify the API Call.</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" >order_type</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >e.g. COD, Prepaid. Master Code:ODRTYPE</td></tr><tr align="center"><td style="vertical-align:middle" >payment_type</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >e.g. Credit Card, Cash</td></tr><tr align="center"><td style="vertical-align:middle" >order_amount</td><td style="vertical-align:middle" >Varchar(20)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >Total amount for the order, including item costs, shipping charges, and applicable taxes..</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. Pending, Confirmed. (Master Code:ODRSTS)&nbsp;</td></tr><tr align="center"><td style="vertical-align:middle" >hold_status</td><td style="vertical-align:middle" >Varchar(3)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >e.g. yes ,no</td></tr><tr align="center"><td style="vertical-align:middle" >address_verified</td><td style="vertical-align:middle" >Varchar(3)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >e.g. yes ,no</td></tr><tr align="center"><td style="vertical-align:middle" >payment_verified</td><td style="vertical-align:middle" >Varchar(3)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >e.g. yes ,no</td></tr><tr align="center"><td style="vertical-align:middle" >address_type</td><td style="vertical-align:middle" >Varchar(20)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Possible values are Home , Office, Work and Other</td></tr><tr align="center"><td style="vertical-align:middle" >order_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" >shipby_date</td><td style="vertical-align:middle" >Datetime</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Format given in Generic Information section</td></tr><tr align="center"><td style="vertical-align:middle" >expDelDate</td><td style="vertical-align:middle" >Datetime</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Format given in Generic Information section</td></tr><tr align="center"><td style="vertical-align:middle" >order_currency</td><td style="vertical-align:middle" >Varchar(10)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >e.g. INR, USD</td></tr><tr align="center"><td style="vertical-align:middle" >conversion_rate</td><td style="vertical-align:middle" >Decimal(10,3)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Exchange rate used for currency conversion to organisation base currency&nbsp;&nbsp;</td></tr><tr align="center"><td style="vertical-align:middle" >is_replacement</td><td style="vertical-align:middle" >Varchar(3)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Yes/No , For Creating replacement order pass value as "Yes"</td></tr><tr align="center"><td style="vertical-align:middle" >original_orderno</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Conditional</td><td style="vertical-align:middle" >If is_replacement='Yes' then this field is mandatory</td></tr><tr align="center"><td style="vertical-align:middle" >customer_code</td><td style="vertical-align:middle" >Varchar(20)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" ><p>If customer code will be provided then order will be created with provided customer code, If not then system will consider order for Default Customer code. i.e. 999999</p></td></tr><tr align="center"><td style="vertical-align:middle" >extCustomerCode</td><td style="vertical-align:middle" >Varchar(20)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" ><p>If extcustomer code will be provided then order will be created with provided extcustomer code</p></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" >Mandatory</td><td style="vertical-align:middle" >Name of the customer placing the order.</td></tr><tr align="center"><td style="vertical-align:middle" >ship_address1</td><td style="vertical-align:middle" >Varchar(1000)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle" >Primary shipping address line for the order.</td></tr><tr align="center"><td style="vertical-align:middle" >ship_address2</td><td style="vertical-align:middle" >Varchar(200)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Secondary shipping address line (if applicable).</td></tr><tr align="center"><td style="vertical-align:middle" >ship_address3</td><td style="vertical-align:middle" >Varchar(200)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle" >Additional shipping address line (if applicable).</td></tr><tr align="center"><td style="vertical-align:middle" >ship_address4</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Extra field for additional address details.</td></tr><tr align="center"><td style="vertical-align:middle" >ship_city</td><td style="vertical-align:middle" >Varchar(40)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >City name for the shipping address.</td></tr><tr align="center"><td style="vertical-align:middle" >ship_state</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >State name for the shipping address.</td></tr><tr align="center"><td style="vertical-align:middle" >ship_country</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >Country name for the shipping address.</td></tr><tr align="center"><td style="vertical-align:middle" >ship_pincode</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >Pincode for the shipping address.</td></tr><tr align="center"><td style="vertical-align:middle" >ship_phone1</td><td style="vertical-align:middle" >Varchar(20)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >Primary contact phone number for shipping.</td></tr><tr align="center"><td style="vertical-align:middle" >ship_phone2</td><td style="vertical-align:middle" >Varchar(20)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Secondary contact phone number for shipping (if available).</td></tr><tr align="center"><td style="vertical-align:middle" >ship_email1</td><td style="vertical-align:middle" >Varchar(255)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">Primary email address for shipping communication.</td></tr><tr align="center"><td style="vertical-align:middle" >ship_email2</td><td style="vertical-align:middle" >Varchar(255)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Secondary email address for shipping communication (if available).</td></tr><tr align="center"><td style="vertical-align:middle" >bill_name</td><td style="vertical-align:middle" >Varchar(200)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >Name of the person or entity for billing purposes.</td></tr><tr align="center"><td style="vertical-align:middle" >bill_address1</td><td style="vertical-align:middle" >Varchar(1000)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >Primary billing address line.</td></tr><tr align="center"><td style="vertical-align:middle" >bill_address2</td><td style="vertical-align:middle" >Varchar(200)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Secondary billing address line (if applicable).</td></tr><tr align="center"><td style="vertical-align:middle" >bill_address3</td><td style="vertical-align:middle" >Varchar(200)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle" >Additional billing address line (if applicable).</td></tr><tr align="center"><td style="vertical-align:middle" >bill_address4</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Extra field for additional billing address details.</td></tr><tr align="center"><td style="vertical-align:middle" >bill_city</td><td style="vertical-align:middle" >Varchar(40)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >City name for the billing address.</td></tr><tr align="center"><td style="vertical-align:middle" >bill_state</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >State name for the billing address.</td></tr><tr align="center"><td style="vertical-align:middle" >bill_phone2</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >An alternate phone number for billing-related communication.</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" >Landmark or nearby reference for the billing address, if applicable.</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" >url</td><td style="vertical-align:middle" >Varchar(300)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >URL associated with the order, such as website landing page link, Order status= confirmed then the URL must get embedded.</td></tr><tr align="center"><td style="vertical-align:middle" >bill_country</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >Country name for the billing address.</td></tr><tr align="center"><td style="vertical-align:middle" >bill_pincode</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">Postal code for the billing address.</td></tr><tr align="center"><td style="vertical-align:middle" >bill_phone1</td><td style="vertical-align:middle" >Varchar(20)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >Primary contact phone number for billing.</td></tr><tr align="center"><td style="vertical-align:middle" >bill_email1</td><td style="vertical-align:middle" >Varchar(255)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >Primary email address for billing communication.</td></tr><tr align="center"><td style="vertical-align:middle" >bill_email2</td><td style="vertical-align:middle" >Varchar(255)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Secondary email address for billing communication (if available).</td></tr><tr align="center"><td style="vertical-align:middle" >order_remarks</td><td style="vertical-align:middle" >Varchar(5000)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Remarks against order</td></tr><tr align="center"><td style="vertical-align:middle" >shipping_charges</td><td style="vertical-align:middle" >Decimal(10,3)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Charges for shipping the order, in the specified currency.</td></tr><tr align="center"><td style="vertical-align:middle" >other_charge1</td><td style="vertical-align:middle" >Decimal(10,3)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Additional charges for the order (e.g., handling fees).</td></tr><tr align="center"><td style="vertical-align:middle" >other_charge2</td><td style="vertical-align:middle" >Decimal(10,3)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Any other applicable charges for the order.</td></tr><tr align="center"><td style="vertical-align:middle" >store_credit</td><td style="vertical-align:middle" >Decimal(10,3)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Store credit applied to the order, if any.</td></tr><tr align="center"><td style="vertical-align:middle" >discount_code</td><td style="vertical-align:middle" >Varchar(30)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Discount code applied to the order</td></tr><tr align="center"><td style="vertical-align:middle" >rewardPointsAmount</td><td style="vertical-align:middle" >Decimal(20,5)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Amount redeemed using customer reward points for this order.</td></tr><tr align="center"><td style="vertical-align:middle" >cancel_remark</td><td style="vertical-align:middle" >Varchar(255)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Remarks or reasons for canceling the order, if applicable.</td></tr><tr align="center"><td style="vertical-align:middle" >is_giftwrap</td><td style="vertical-align:middle" >Varchar(3)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Possible Values Yes/No</td></tr><tr align="center"><td style="vertical-align:middle" >giftwrap_msg</td><td style="vertical-align:middle" >Varchar(500)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Giftwrap Message</td></tr><tr align="center"><td style="vertical-align:middle" >giftwrapCharge</td><td style="vertical-align:middle" >Decimal(10,3)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Additional charge applied for gift-wrapping services, if opted.</td></tr><tr align="center"><td style="vertical-align:middle" >giftWrapType</td><td style="vertical-align:middle" >Varchar(20)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Free text field specifying the type of gift wrapping.</td></tr><tr align="center"><td style="vertical-align:middle" >delivery_slot</td><td style="vertical-align:middle" >Varchar(11)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >e.g. 14:00-17:00</td></tr><tr align="center"><td style="vertical-align:middle" >tags</td><td style="vertical-align:middle" >Array</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Allowed max 10 ordertags, comma seprated.</td></tr><tr align="center"><td style="vertical-align:middle" >viewDetails</td><td style="vertical-align:middle" >Varchar(5)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle"> Possible Values are  1(to view SKU details with status),0</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">Items 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">Items 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" >udf11</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" >udf12</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" >udf13</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" >udf14</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" >udf15</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" >custtinno</td><td style="vertical-align:middle" >Varchar(20)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Customer Tax Identification Number (TIN)</td></tr><tr align="center"><td style="vertical-align:middle" >pickAfterDate</td><td style="vertical-align:middle" >Datetime</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Pick After date, Date format should be like DD/MM/YYYY HH:MM:SS</td></tr><tr align="center"><td style="vertical-align:middle" >cust_type</td><td style="vertical-align:middle" >Varchar(100)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Possible values are B2B, B2C etc, Default B2C</td></tr><tr align="center"><td style="vertical-align:middle" >req_type</td><td style="vertical-align:middle" >Varchar(20)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle" >create/update , For "create" value it check is order already exist or not </td></tr><tr align="center"><td style="vertical-align:middle" >pickupLocation</td><td style="vertical-align:middle" >Varchar(5)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle" >Orders should be routed to the location that is being passed in this field</td></tr><tr align="center"><td style="vertical-align:middle" >handoverValCode</td><td style="vertical-align:middle" >Varchar(100)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Handover validation code for the handover process</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(100)</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" >orderProcessing</td><td style="vertical-align:middle" >Varchar(5)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" > Possible values are B2B, B2C etc, Default B2C</td></tr><tr align="center"><td style="vertical-align:middle" >userConsent</td><td style="vertical-align:middle" >Varchar(5)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" > Possible values are Y/N, Default Y</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" >Define in codelkup table with lkupcode "IDNTFYBUYRCODE"</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" >Varchar(50)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Instructions for the warehouse or picker regarding order picking for the order.</td></tr><tr align="center"><td style="vertical-align:middle" >shippingInstructions</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" > Instructions for the warehouse or picker regarding order shipping for the order.</td></tr><tr align="center"><td style="vertical-align:middle" >distributionType</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Distribution Type</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" >Varchar(255)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >Lineno of external system</td></tr><tr align="center"><td style="vertical-align:middle" >sku</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >SKU code from masters </td></tr><tr align="center"><td style="vertical-align:middle" >channelSkuCode</td><td style="vertical-align:middle" >Varchar(50)</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 exte

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