Vinculum Orders API
API to retrieve or manipulate Order related information.
OpenAPI Specification
swagger: '2.0'
info:
title: Vinculum Advance Shipping Notice Orders API
description: API to retrieve or manipulate ASN related information.
host: 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)
consumes:
- application/x-www-form-urlencoded
produces:
- application/json
parameters:
- in: formData
name: RequestBody
required: true
type: string
description: <table class="table-style-three"><tbody><tr align="center"><td style="vertical-align:middle" width='100'><strong>Field Name </strong></td><td style="vertical-align:middle" width='100'><strong>Data Type </strong></td><td style="vertical-align:middle" width='100'><strong>Mandatory </strong></td><td style="vertical-align:middle" width='300'><strong>Description </strong></td></tr><tr align="center"><td style="vertical-align:middle" >order_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" > e. g. Pending, Confirmed. (Master Code:ODRSTS) </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 </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 external system/Marketplace</td></tr><tr align="center"><td style="vertical-align:middle" >order_qty</td><td style="vertical-align:middle" >Decimal(10,3)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >The quantity of the item ordered.</td></tr><tr align="center"><td style="vertical-align:middle" >cancelled_qty</td><td style="vertical-align:middle" >Decimal(10,3)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >The quantity of the item that has been canceled from the order, if applicable.</td></tr><tr align="center"><td style="vertical-align:middle" >unit_price</td><td style="vertical-align:middle" >Decimal(10,3)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">The price per unit of the item ordered.</td></tr><tr align="center"><td style="vertical-align:middle" >bundle_sku</td><td style="vertical-align:middle" >Varchar(100)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >The price per unit of the item ordered.</td></tr><tr align="center"><td style="vertical-align:middle" >bundle_price</td><td style="vertical-align:middle" >Decimal(10,3)</td><td style="vertical-align:middle" >Conditional</td><td style="vertical-align:middle" >Mandatory when bundle_sku is passed</td></tr><tr align="center"><td style="vertical-align:middle" >bundle_qty</td><td style="vertical-align:middle" >Decimal(10,3)</td><td style="vertical-align:middle" >Conditional</td><td style="vertical-align:middle" >Mandatory when bundle_sku is passed</td></td></tr><tr align="center"><td style="vertical-align:middle" >bagId</td><td style="vertical-align:middle" >Varchar(250)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >If BagId is entered, the quantity of the SKU must not exceed 1, Multiple BagId can be given using comma separated values</td></tr><tr align="center"><td style="vertical-align:middle" >mrp</td><td style="vertical-align:middle" >Decimal(10,3)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >MRP of the item being ordered.</td></tr><tr align="center"><td style="vertical-align:middle" >discount_amt</td><td style="vertical-align:middle" >Decimal(10,3)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Total discount amount applied to the order line.</td></tr><tr align="center"><td style="vertical-align:middle" >gift_voucher_amt</td><td style="vertical-align:middle" >Decimal(10,3)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Amount redeemed from a gift voucher or coupon for the order line.</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" >Cost of shipping the order line, if applicable.</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">Any additional charge associated with the order, such as handling fees or service charges.</td></tr><tr align="center"><td style="vertical-align:middle" >transporter</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Transporter code as per masters, Multiple transporters can be given using comma separated values</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 line, if any.</td></tr><tr align="center"><td style="vertical-align:middle" >is_giftcard</td><td style="vertical-align:middle" >Varchar(3)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Yes/No</td></tr><tr align="center"><td style="vertical-align:middle" >vendor</td><td style="vertical-align:middle" >Varchar(10)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Vendor code as per masters</td></tr><tr align="center"><td style="vertical-align:middle" >mode</td><td style="vertical-align:middle" >Varchar(8)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >e.g. wms , dropship</td></tr><tr align="center"><td style="vertical-align:middle" >tax_inclusive</td><td style="vertical-align:middle" >Varchar(5)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Acceptable values are Yes/No</td></tr><tr align="center"><td style="vertical-align:middle" >tax_percentage</td><td style="vertical-align:middle" >Decimal(20,3)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Tax percentage applied to an order</td></tr><tr align="center"><td style=
# --- truncated at 32 KB (521 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vinculum/refs/heads/main/openapi/vinculum-orders-api-openapi.yml