swagger: '2.0'
info:
title: Vinculum Advance Shipping Notice Manifest API
description: API to retrieve or manipulate ASN related information.
host: erp.vineretail.com
tags:
- name: Manifest
description: API to create Manifest
paths:
/RestWS/api/eretail/v1/manifest/create:
post:
tags:
- Manifest
summary: API For Create Manifest(Hit Quota 40/5 min)
consumes:
- application/json
produces:
- application/json
parameters:
- in: header
name: ApiOwner
required: true
type: string
description: API Owner.
- in: header
name: ApiKey
required: true
type: string
description: API Key.
- in: body
name: JSON Format
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" >businessType</td><td style="vertical-align:middle" >Varchar(20)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >Possible value B2C</td></tr><tr align="center"><td style="vertical-align:middle" >manifestType</td><td style="vertical-align:middle" >Varchar(3)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >Possible value Marketplace</td></tr><tr align="center"><td style="vertical-align:middle" >channelCode</td><td style="vertical-align:middle" >Varchar(5)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >ChannelCode must be MarketPlace Type</td></tr><tr align="center"><td style="vertical-align:middle" >status</td><td style="vertical-align:middle" >Varchar(10)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >Status should be Confirmed</td></tr><tr align="center"><td style="vertical-align:middle" >vehicleNo</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >optional</td><td style="vertical-align:middle" >VehicleNo</td></tr><tr align="center"><td style="vertical-align:middle" >manifestSubmission</td><td style="vertical-align:middle" >Varchar(3)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >manifestSubmission only yes/no</td></tr><tr align="center"><td style="vertical-align:middle" >remarks</td><td style="vertical-align:middle" >Varchar(200)</td><td style="vertical-align:middle" >Optional</td><td style="vertical-align:middle" >Remarks is mandatory</td></tr><tr align="center"><td style="vertical-align:middle" colspan=4 ><b>Line Level</b></td></tr><tr align="center"><td style="vertical-align:middle" >deliveryNo</td><td style="vertical-align:middle" >Varchar(20)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >Max 20 deliveryNo are allowed in deliveryNo List</td></tr><tr align="center"><td style="vertical-align:middle" >trackingNo</td><td style="vertical-align:middle" >Varchar(50)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >Tracking No is Mandotary</td></tr><tr align="center"><td style="vertical-align:middle" >packagingType</td><td style="vertical-align:middle" >Varchar()</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >packagingType is Mandotary</td></tr><tr align="center"><td style="vertical-align:middle" >length</td><td style="vertical-align:middle" >decimal(10,3)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >length is Mandotary</td></tr><tr align="center"><td style="vertical-align:middle" >breadth</td><td style="vertical-align:middle" >decimal(10,3)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >breadth is Mandotary</td></tr><tr align="center"><td style="vertical-align:middle" >height</td><td style="vertical-align:middle" >decimal(10,3)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >height is Mandotary</td></tr><tr align="center"><td style="vertical-align:middle" >weight</td><td style="vertical-align:middle" >decimal(20,5)</td><td style="vertical-align:middle" >Mandatory</td><td style="vertical-align:middle" >weight is Mandotary</td></tr><tr align="center"><tr><td style="vertical-align:middle" colspan=4> <b>JSON FORMAT<br/> <b>{<br/> "manifest":{<br/> "businessType":"B2C",<br/> "manifestType":"marketplace",<br/> "channelCode":"M12",<br/> "status":"Confirmed",<br/> "vehicleNo":"",<br/> "manifestSubmission":"yes",<br/> "remarks":"",<br/> "orderList":[<br/> {<br/> "deliveryNo":"CHEAB9D19223",<br/> "trackingNo":"",<br/> "packagingType":"FEDEX_TUBE",<br/> "length":"1",<br/> "breadth":"1",<br/> "height":"1",<br/> "weight":"1"<br/> }<br/> ]<br/> <br/> }<br/> <br/> } </b></tbody> </table>
schema:
properties:
manifest:
$ref: '#/definitions/createmanifest0'
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>E10082</p></td><td style="vertical-align:middle" width='167'><p>BusinessType is Mandatory</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>E10083</p></td><td style="vertical-align:middle" width='167'><p>BusinessType should be B2C</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>E10085</p></td><td style="vertical-align:middle" width='167'><p>ManifestType should be Marketplace</p></td></tr> <tr align="center"><td style="vertical-align:middle" width='167'><p>E10087</p></td><td style="vertical-align:middle" width='167'><p>Either Delivery No or Tracking No is Mandatory</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>E90456</p></td><td style="vertical-align:middle" width='167'><p>ChannelCode is mandatory.</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>E9193</p></td><td style="vertical-align:middle" width='167'><p>Status is mandatory</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>E10090</p></td><td style="vertical-align:middle" width='167'><p>Length/Breadth/Height/Weight should be Numeric</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>E5</p></td><td style="vertical-align:middle" width='167'><p>Empty Request</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>E10086</p></td><td style="vertical-align:middle" width='167'><p>Status should be Confirmed</p></td></tr><td style="vertical-align:middle" colspan=4> <b>Success Response</b><br/>{<br/> "responseCode":9000,<br/> "responseMessage":"Success",<br/> "requestStatus":[</br> {</br> "responseMessage":"ShippedCount :0,ErrorCount :1",</br> "response":{</br> "manifestId":"CHE000003581",</br> "status":"confirmed",</br> "manifestDate":"24/08/2023",</br> "manifestDocument":"",</br> "delivery":[</br> {</br> "orderNo":"M12112",</br> "extOrderNo":"sh112233",</br> "orderType":"Prepaid",</br> "outboundDelivery":"CHEC28C75553",</br> "trackingNo":"653633mndfjhdj2l",</br> "packDate":"21/04/2023 11:57:58",</br> "packUser":"sa",</br> "extManifestNo":null,</br> "extInvoiceNo":"",</br> "errorDescription":null,</br> "extTransporter":"",</br> "length":"11",</br> "breadth":"11",</br> "height":"11",</br> "weight":"11",</br> "status":"Shipped"</br> }</br> ]</br> }</br> }<br/>}</td></tr><br/></tbody></table><p> </p></tbody></table>
/RestWS/api/eretail/v1/manifest/createB2bManifest:
post:
tags:
- Manifest
summary: Max no. of Lines/Response:20 API For Order Invoice Pdf(Hit Quota 40/5 min)
consumes:
- application/json
produces:
- application/json
parameters:
- in: header
name: DbId
required: true
type: string
description: DB Identifier.
- in: header
name: ApiKey
required: true
type: string
description: API Key.
- in: body
name: OrderUnAllocateJson
description: <table class="table-style-three"><tbody><tr><tr align="center"><td style="vertical-align:middle" width='100'><strong>Field Name </strong></td><td style="vertical-align:middle" width='100'><strong>Data Type </strong></td><td style="vertical-align:middle" width='100'><strong>Mandatory </strong></td><td style="vertical-align:middle" width='300'><strong>Description </strong></td></tr><tr align="center"><td style="vertical-align:middle">extManifestNo</td><td style="vertical-align:middle">varchar(20)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">Manifest No. of external system</td></tr><tr align="center"><td style="vertical-align:middle">manifestType</td><td style="vertical-align:middle">varchar(20)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">Possible Values selfship </td></tr><tr align="center"><td style="vertical-align:middle">transporterCode</td><td style="vertical-align:middle">Integer</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">Transporter code</td></tr><tr align="center"><td style="vertical-align:middle>fulfillmentLocation</td><td style="vertical-align:middle">fulfillmentLocation</td><td style="vertical-align:middle">Varchar(3)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">Ext Loccode or Loccode of the location from where order is being fulfilled</td></tr><tr align="center"><td style="vertical-align:middle">lrNo</td><td style="vertical-align:middle">Varchar(100)</td><td style="vertical-align:middle">Conditional</td><td style="vertical-align:middle">Mandatory unless the transporter is API enabled</td></tr><tr align="center"><td style="vertical-align:middle">status</td><td style="vertical-align:middle">varchar(200)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">Possible values Pending, Confirmed, Invoiced.Confirmed status is accepted only if current status of manifest is Invoiced </td></tr><tr align="center"><td style="vertical-align:middle">vehicleNo</td><td style="vertical-align:middle">varchar(20)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">Possible Values selfship </td></tr><tr align="center"><td style="vertical-align:middle">driverName</td><td style="vertical-align:middle">Varchar(100)</td><td style="vertical-align:middle">Conditional</td><td style="vertical-align:middle">Driver Name, Mandatory based on configuration</td></tr><tr align="center"><td style="vertical-align:middle">remarks</td><td style="vertical-align:middle">Varchar(250)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Remarks if any</td></tr><tr align="center"><td style="vertical-align:middle">lpnList</td><td style="vertical-align:middle">Array</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">List of LPN to be added (Max 200 LPNs per request) </td></tr><tr align="center"><td style="vertical-align:middle">udf1</td><td style="vertical-align:middle">Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">User defined Field </td></tr><tr align="center"><td style="vertical-align:middle">udf2</td><td style="vertical-align:middle">Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">User defined Field </td></tr><tr align="center"><td style="vertical-align:middle">udf3</td><td style="vertical-align:middle">Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">User defined Field </td></tr><tr align="center"><td style="vertical-align:middle">udf4</td><td style="vertical-align:middle">Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">User defined Field </td></tr><tr align="center"><td style="vertical-align:middle">udf5</td><td style="vertical-align:middle">Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">User defined Field </td></tr><tr align="center"><td style="vertical-align:middle">udf6</td><td style="vertical-align:middle">Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">User defined Field </td></tr><tr align="center"><td style="vertical-align:middle">udf7</td><td style="vertical-align:middle">Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">User defined Field </td><tr 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><td colspan=5> <b>Case - </b><br/> { <b>"manifestData":{<br/> "extManifestNo":"",<br/> "manifestType":"",<br/> "transporterCode":"",<br/> "fulfillmentLocation":"",<br/> "lrNo":"",<br/> "status":"",<br/> "vehicleNo":"",<br/> "driverName":"",<br/> "remarks":"",<br/> "lpnList":[],<br/> "userDefinedFields":{<br/> "udf1":"",<br/> "udf2":"",<br/> "udf3":"",<br/> "udf4":"",<br/> "udf5":"",<br/> "udf6":"",<br/> "udf7":"",<br/> "udf8":"",<br/> "udf9":"",<br/> "udf10":""  }<br/>}</br> } </td></tr></tbody></table><p> </p><br/>
schema:
properties:
manifestData:
$ref: '#/definitions/createmanifest07'
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>9</p></td><td style="vertical-align:middle" width='167'><p>Please Enter Extern Manifest No</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>9</p></td><td style="vertical-align:middle" width='167'><p>ManifestType is Mandatory</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>9</p></td><td style="vertical-align:middle" width='167'><p>FulfillmentLocation is mandatory</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>9</p></td><td style="vertical-align:middle" width='167'><p>Status is mandatory</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>9</p></td><td style="vertical-align:middle" width='167'><p>Max 200 LPN can be selected at time</p></td></tr></tbody></table>
schema:
$ref: '#/definitions/createmanifestB2Bresponse'
definitions:
createmanifest0:
properties:
businessType:
type: string
example: B2C
manifestType:
type: string
example: marketplace
channelCode:
type: string
example: M12
status:
type: string
example: Confirmed
vehicleNo:
type: string
example: ''
manifestSubmission:
type: string
example: 'yes'
remarks:
type: string
example: ''
orderList:
type: array
items:
$ref: '#/definitions/createmanifest1'
userDefinedFieldCreaeB2b:
properties:
udf1:
type: string
example: ''
udf2:
type: string
example: ''
udf3:
type: string
example: ''
udf4:
type: string
example: ''
udf5:
type: string
example: ''
udf6:
type: string
example: ''
udf7:
type: string
example: ''
udf8:
type: string
example: ''
udf9:
type: string
example: ''
udf10:
type: string
example: ''
createmanifestB2Bresponse:
properties:
responseCode:
type: string
example: '0'
responseMessage:
type: string
example: SUCCESS
requestId:
type: string
example: ''
extManifestNo:
type: string
example: MAN233333
manifestNo:
type: string
example: TWH000003699
invoiceNo:
type: string
example: null
lrNo:
type: string
example: null
manifestStatus:
type: string
example: InvoiceInProcess
createmanifest07:
properties:
extManifestNo:
type: string
example: MAN233333
manifestType:
type: string
example: marketplace
transporterCode:
type: string
example: '232322'
fulfillmentLocation:
type: string
example: Confirmed
lrNo:
type: string
example: ''
status:
type: string
example: ''
vehicleNo:
type: string
example: ''
driverName:
type: string
example: ''
remarks:
type: string
example: ''
lpnList:
type: string
example: []
userDefinedFields:
$ref: '#/definitions/userDefinedFieldCreaeB2b'
createmanifest1:
properties:
deliveryNo:
type: string
example: CHEAB9D19223
trackingNo:
type: string
example: ''
packagingType:
type: string
example: FEDEX_TUBE
length:
type: string
example: 1
breadth:
type: string
example: 1
height:
type: string
example: 1
weight:
type: string
example: 1