Vinculum Inbounds API

API to retrieve or manipulate Inbound related information.

OpenAPI Specification

vinculum-inbounds-api-openapi.yml Raw ↑
swagger: '2.0'
info:
  title: Vinculum Advance Shipping Notice Inbounds API
  description: API to retrieve or manipulate ASN related information.
host: erp.vineretail.com
tags:
- name: Inbounds
  description: API to retrieve or manipulate Inbound related information.
paths:
  /RestWS/api/eretail/v1/inbound/detail:
    post:
      tags:
      - Inbounds
      summary: Max no. of lines/Response:100 API For Inbound Details(Hit Quota 40/5 min)
      consumes:
      - application/x-www-form-urlencoded
      produces:
      - application/json
      parameters:
      - in: formData
        name: RequestBody
        type: string
        description: <table class="table-style-three"><tbody><tr><tr align="center"><td style="vertical-align:middle" width='100'><strong>Field Name </strong></td><td style="vertical-align:middle" width='100'><strong>Data Type </strong></td><td style="vertical-align:middle" width='100'><strong>Mandatory </strong></td><td style="vertical-align:middle" width='300'><strong>Description </strong></td></tr><tr align="center"><td style="vertical-align:middle">poCode</td><td style="vertical-align:middle">Varchar(12)</td><td style="vertical-align:middle">Conditional*</td><td style="vertical-align:middle">Either (poCode / asnCode/inboundCode/returnCode/stoNo) or Date filter mandatory</td></tr><tr align="center"><td style="vertical-align:middle">asnCode</td><td style="vertical-align:middle">Varchar(12)</td><td style="vertical-align:middle">Conditional*</td><td style="vertical-align:middle">Either (poCode / asnCode/inboundCode/returnCode/stoNo) or Date filter mandatory</td></tr><tr align="center"><td style="vertical-align:middle">stoNo</td><td style="vertical-align:middle">Varchar(12)</td><td style="vertical-align:middle">Conditional*</td><td style="vertical-align:middle">Either (poCode / asnCode/inboundCode/returnCode/stoNo) or Date filter mandatory</td></tr><tr align="center"><td style="vertical-align:middle">delloc</td><td style="vertical-align:middle">Varchar(3)</td><td style="vertical-align:middle">Conditional*</td><td style="vertical-align:middle">Mandatory when date range is passed</td></tr><tr align="center"><td style="vertical-align:middle">fromDate</td><td style="vertical-align:middle">Datetime</td><td style="vertical-align:middle">Conditional*</td><td style="vertical-align:middle">Either (poCode / asnCode/inboundCode/returnCode/stoNo) or Date filter mandatory</td></tr><tr align="center"><td style="vertical-align:middle">toDate</td><td style="vertical-align:middle">Datetime</td><td style="vertical-align:middle">Conditional*</td><td style="vertical-align:middle">Either (poCode / asnCode/inboundCode/returnCode/stoNo) or Date filter mandatory</td></tr><tr align="center"><td style="vertical-align:middle">pageNumber</td><td style="vertical-align:middle">Integer</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Default 1</td></tr><tr align="center"><td style="vertical-align:middle">inboundcode</td><td style="vertical-align:middle">Varchar(12)</td><td style="vertical-align:middle">Conditional*</td><td style="vertical-align:middle">Either (poCode / asnCode/inboundCode/returnCode/stoNo) or Date filter mandatory</td></tr><tr align="center"><td style="vertical-align:middle">returnCode</td><td style="vertical-align:middle">Varchar(12)</td><td style="vertical-align:middle">Conditional*</td><td style="vertical-align:middle">Either (poCode / asnCode/inboundCode/returnCode/stoNo) or Date filter mandatory</td></tr><tr align="center"><td style="vertical-align:middle">vendor_code</td><td style="vertical-align:middle">Varchar(20)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Vendor Code(If details by date filter)</td></tr><tr align="center"><td style="vertical-align:middle">filterBy</td><td style="vertical-align:middle">Varchar(1)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">get PO on the basis of updation or creation date Default:GRNdate, Possible values are 1 (update date),2(create date)</td></tr><tr align="center"><td style="vertical-align:middle">inbType</td><td style="vertical-align:middle">Varchar(200)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Inbound Type, Defined in Codelkup with lkupcode 'INBTYPE'.</td></tr><tr><td  colspan=5> <b>Case 1-Request by poCode</b><br/> <b>{<br/> &nbsp;&nbsp;&nbsp;&nbsp;"poCode":"DEL38206",</br>&nbsp;&nbsp;&nbsp;&nbsp;"asnCode":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"stoNo":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"delloc":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"fromDate":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"toDate":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"vendor_code":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"inbType":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"inboundcode":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"returnCode":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"pageNumber":"1",</br>&nbsp;&nbsp;&nbsp;&nbsp"filterBy":"1"</br>&nbsp;}</b><br/><br/><br/> <b>Case 2-Request by inboundCode</b><br/> <b>{<br/> &nbsp;&nbsp;&nbsp;&nbsp;"poCode":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"asnCode":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"stoNo":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"inboundcode":"BTD000000000",</br>&nbsp;&nbsp;&nbsp;&nbsp;"delloc":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"fromDate":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"toDate":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"returnCode":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"vendor_code":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"inbType":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"pageNumber":"1",</br>&nbsp;&nbsp;&nbsp;&nbsp;"filterBy":""<br/>&nbsp;}</b><br/><br/><br/> <b>Case 3-Request by date range filter</b><br/> <b>{<br/> &nbsp;&nbsp;&nbsp;&nbsp;"poCode":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"asnCode":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"stoNo":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"delloc":"CHE",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"fromDate":"10/12/2017 00:00:00",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"toDate":"17/12/2017 00:00:00",</br>&nbsp;&nbsp;&nbsp;&nbsp;"vendor_code":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"inboundcode":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"inbType":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"returnCode":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"pageNumber":"1",</br>&nbsp;&nbsp;&nbsp;&nbsp;"filterBy":""<br/>&nbsp;}</b> </b><br/><br/><br/> <b>Case 4-Request by asnCode</b><br/> <b>{<br/> &nbsp;&nbsp;&nbsp;&nbsp;"poCode":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"asnCode":"ASN001",</br>&nbsp;&nbsp;&nbsp;&nbsp;"stoNo":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"delloc":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"fromDate":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"toDate":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"inboundcode":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"vendor_code":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"returnCode":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"inbType":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"pageNumber":"1",</br>&nbsp;&nbsp;&nbsp;&nbsp;"filterBy":"&nbsp;<br/>}</b><br/><br/><br/> <b>Case 5-Request by returnCode</b><br/> <b>{<br/> &nbsp;&nbsp;&nbsp;&nbsp;"poCode":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"asnCode":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"stoNo":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"inboundcode":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"returnCode":"CHE1234",</br>&nbsp;&nbsp;&nbsp;&nbsp;"delloc":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"fromDate":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"toDate":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"pageNumber":"1",</br>&nbsp;&nbsp;&nbsp;&nbsp;"vendor_code":"1",</br>&nbsp;&nbsp;&nbsp;&nbsp;"inbType":"1",</br>&nbsp;&nbsp;&nbsp;&nbsp;"filterBy":""<br/>&nbsp;}</b><br/><br/><br/> <b>Case 6-Request by stoNo</b><br/> <b>{<br/> &nbsp;&nbsp;&nbsp;&nbsp;"poCode":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"asnCode":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"stoNo":"CHE168458",</br>&nbsp;&nbsp;&nbsp;&nbsp;"inboundcode":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"returnCode":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"delloc":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"fromDate":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"toDate":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"pageNumber":"1",</br>&nbsp;&nbsp;&nbsp;&nbsp;"vendor_code":"1",</br>&nbsp;&nbsp;&nbsp;&nbsp;"inbType":"1",</br>&nbsp;&nbsp;&nbsp;&nbsp;"filterBy":""<br/>&nbsp;}</b><br/><br/><br/> <br/></td></tr></tbody></table><p>&nbsp;</p><br/>
        required: true
      - in: formData
        name: ApiOwner
        type: string
        description: This Field Will Be Used To Send API Owner
        required: true
      - in: formData
        name: ApiKey
        type: string
        description: This is the API Key
        required: true
      responses:
        200:
          description: <table border='1'width='672'>  <h1  style="color:#FFFF00;">API Generic Error Codes</h1><tbody><tr align="center"><td style="vertical-align:middle" width='167'><p><strong>Response Code </strong></p></td><td style="vertical-align:middle" colspan='2' width='171'><p><strong> Response Message </strong></p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>804</p></td><td style="vertical-align:middle" width='167'><p>To Date Should be Greater Than From Date.</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>901</p></td><td style="vertical-align:middle" width='167'><p>From Date is Mandatory</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>923</p></td><td style="vertical-align:middle" width='167'><p>Invalid delivery_loc Location</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>2102</p></td><td style="vertical-align:middle" width='167'><p>Location is mandatory</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>2021</p></td><td style="vertical-align:middle" width='167'><p>Invalid PO Code.</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>13003</p></td><td style="vertical-align:middle" width='167'><p>Please Enter valid ASN Code</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>13004</p></td><td style="vertical-align:middle" width='167'><p>Please Enter valid PO Code</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>13005</p></td><td style="vertical-align:middle" width='167'><p>Invalid Delivery Location</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>13006</p></td><td style="vertical-align:middle" width='167'><p>Please enter valid Inbound Code</p></td></tr></tbody></table>
          schema:
            $ref: '#/definitions/inbounddetail'
  /RestWS/api/eretail/v3/inbound/detail:
    post:
      tags:
      - Inbounds
      summary: Max no. of lines/Response:100 API For Inbound Details(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: InboundDetailJSON
        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">poCode</td><td style="vertical-align:middle">Varchar(12)</td><td style="vertical-align:middle">Conditional*</td><td style="vertical-align:middle">Either (poCode / asnCode/inboundCode/stoNo) or Date filter mandatory</td></tr><tr align="center"><td style="vertical-align:middle">asnCode</td><td style="vertical-align:middle">Varchar(12)</td><td style="vertical-align:middle">Conditional*</td><td style="vertical-align:middle">Either (poCode / asnCode/inboundCode/stoNo) or Date filter mandatory</td></tr><tr align="center"><td style="vertical-align:middle">stoNo</td><td style="vertical-align:middle">Varchar(12)</td><td style="vertical-align:middle">Conditional*</td><td style="vertical-align:middle">Either (poCode / asnCode/inboundCode/returnCode/stoNo) or Date filter mandatory</td></tr><tr align="center"><td style="vertical-align:middle">delloc</td><td style="vertical-align:middle">Varchar(3)</td><td style="vertical-align:middle">Conditional*</td><td style="vertical-align:middle">Mandatory when date range is passed</td></tr><tr align="center"><td style="vertical-align:middle">fromDate</td><td style="vertical-align:middle">Datetime</td><td style="vertical-align:middle">Conditional*</td><td style="vertical-align:middle">Either (poCode / asnCode / stoNo) or Date filter mandatory</td></tr><tr align="center"><td style="vertical-align:middle">toDate</td><td style="vertical-align:middle">Datetime</td><td style="vertical-align:middle">Conditional*</td><td style="vertical-align:middle">Either (poCode / asnCode / stoNo) or Date filter mandatory</td></tr><tr align="center"><td style="vertical-align:middle">pageNumber</td><td style="vertical-align:middle">Integer</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Default 1</td></tr><tr align="center"><td style="vertical-align:middle">inbType</td><td style="vertical-align:middle">varchar(200)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Inbound Type, Defined in Codelkup with lkupcode 'INBTYPE'.</td></tr><tr align="center"><td style="vertical-align:middle">inboundcode</td><td style="vertical-align:middle">Varchar(12)</td><td style="vertical-align:middle">Conditional*</td><td style="vertical-align:middle">Either (poCode / asnCode/inboundCode /stoNo) or Date filter mandatory</td></tr><tr align="center"><td style="vertical-align:middle">vendor_code</td><td style="vertical-align:middle">Varchar(20)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Vendor Code(If details by date filter)</td></tr><tr align="center"><td style="vertical-align:middle">filterBy</td><td style="vertical-align:middle">Varchar(1)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">get PO on the basis of updation or creation date Default:GRNdate, Possible values are 1 (update date),2(create date)</td></tr><tr><td  colspan=5> <b>Case 1-Request by poCode</b><br/> <b>{<br/> &nbsp;&nbsp;&nbsp;&nbsp;"poCode":"DEL38206",</br>&nbsp;&nbsp;&nbsp;&nbsp;"asnCode":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"stoNo":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"delloc":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"fromDate":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"toDate":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"inbType":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"inboundcode":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"vendor_code":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"pageNumber":"1",</br>&nbsp;&nbsp;&nbsp;&nbsp"filterBy":""</br>&nbsp;}</b><br/><br/><br/> <b>Case 2-Request by inboundCode</b><br/> <b>{<br/> &nbsp;&nbsp;&nbsp;&nbsp;"poCode":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"asnCode":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"stoNo":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"inboundcode":"BTD000000000",</br>&nbsp;&nbsp;&nbsp;&nbsp;"delloc":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"fromDate":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"toDate":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"inbType":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"vendor_code":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"pageNumber":"1",</br>&nbsp;&nbsp;&nbsp;&nbsp;"filterBy":""<br/>&nbsp;}</b><br/><br/><br/> <b>Case 3-Request by date range filter</b><br/> <b>{<br/> &nbsp;&nbsp;&nbsp;&nbsp;"poCode":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"asnCode":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"stoNo":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"delloc":"CHE",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"fromDate":"10/12/2017 00:00:00",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"toDate":"17/12/2017 00:00:00",</br>&nbsp;&nbsp;&nbsp;&nbsp;"vendor_code":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"inbType":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"inboundcode":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"pageNumber":"1",</br>&nbsp;&nbsp;&nbsp;&nbsp;"filterBy":""<br/>&nbsp;}</b> </b><br/><br/><br/> <b>Case 4-Request by asnCode</b><br/> <b>{<br/> &nbsp;&nbsp;&nbsp;&nbsp;"poCode":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"asnCode":"ASN001",</br>&nbsp;&nbsp;&nbsp;&nbsp;"stoNo":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"delloc":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"fromDate":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"toDate":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"inboundcode":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"inbType":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"vendor_code":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"pageNumber":"1",</br>&nbsp;&nbsp;&nbsp;&nbsp;"filterBy":""&nbsp;<br/>}</b> <br/> <b>Case 5-Request by stoNo</b><br/> <b>{<br/> &nbsp;&nbsp;&nbsp;&nbsp;"poCode":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"asnCode":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"stoNo":"CHE168458",</br>&nbsp;&nbsp;&nbsp;&nbsp;"delloc":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"fromDate":"",<br/>&nbsp;&nbsp;&nbsp;&nbsp;"toDate":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"inboundcode":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"inbType":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"vendor_code":"",</br>&nbsp;&nbsp;&nbsp;&nbsp;"pageNumber":"1",</br>&nbsp;&nbsp;&nbsp;&nbsp;"filterBy":""&nbsp;<br/>}</b> <br/></td></tr></tbody></table><p>&nbsp;</p><br/>
        schema:
          type: object
          required:
          - poCode
          properties:
            poCode:
              type: string
              items:
                type: string
              example: ''
            asnCode:
              type: string
              example: ''
            stoNo:
              type: string
              example: ''
            inboundcode:
              type: string
              example: BWD000000320
            delloc:
              type: string
              example: ''
            fromDate:
              type: string
              example: ''
            toDate:
              type: string
              example: ''
            vendor_code:
              type: string
              example: ''
            inbType:
              type: string
              example: ''
            pageNumber:
              type: string
              example: '1'
            filterBy:
              type: string
              example: 1
      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>804</p></td><td style="vertical-align:middle" width='167'><p>To Date Should be Greater Than From Date.</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>901</p></td><td style="vertical-align:middle" width='167'><p>From Date is Mandatory</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>923</p></td><td style="vertical-align:middle" width='167'><p>Invalid delivery_loc Location</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>2102</p></td><td style="vertical-align:middle" width='167'><p>Location is mandatory</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>2021</p></td><td style="vertical-align:middle" width='167'><p>Invalid PO Code.</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>13003</p></td><td style="vertical-align:middle" width='167'><p>Please Enter valid ASN Code</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>13004</p></td><td style="vertical-align:middle" width='167'><p>Please Enter valid PO Code</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>13005</p></td><td style="vertical-align:middle" width='167'><p>Invalid Delivery Location</p></td></tr><tr align="center"><td style="vertical-align:middle" width='167'><p>13006</p></td><td style="vertical-align:middle" width='167'><p>Please enter valid Inbound Code</p></td></tr></tbody></table>
          schema:
            $ref: '#/definitions/inbounddetail'
  /RestWS/api/eretail/v4/inbound/create:
    post:
      tags:
      - Inbounds
      summary: API For Inbound create(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: InboundCreateJSONV4
        description: '<table class="table-style-three"><tbody><tr align="center"><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">receiveType</td><td style="vertical-align:middle">Varchar(20)</td><td style="vertical-align:middle">Mandatory*</td><td style="vertical-align:middle">  receiveType can be PO/STO/ASN/RET/DI</td></tr><tr align="center"><td style="vertical-align:middle">pocode</td><td style="vertical-align:middle">Varchar(12)</td><td style="vertical-align:middle">Conditional*</td><td style="vertical-align:middle">Could be either PO code or externPO Code If PO code not given then create direct inbound else PO inbound</td></tr><tr align="center"><td style="vertical-align:middle">vendor_code</td><td style="vertical-align:middle">Varchar(20)</td><td style="vertical-align:middle">Conditional*</td><td style="vertical-align:middle">Mandatory if receive type is DI</td></tr><tr align="center"><td style="vertical-align:middle">asnNo</td><td style="vertical-align:middle">Varchar(20)</td><td style="vertical-align:middle">Conditional*</td><td style="vertical-align:middle">Mandatory if receive type is ASN</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">Valid status- Pending, Confirmed, GRN in process, Cancelled  (Only grn in process can be cancelled)</td></tr><tr align="center"><td style="vertical-align:middle">stoNo</td><td style="vertical-align:middle">Varchar(20)</td><td style="vertical-align:middle">Conditional*</td><td style="vertical-align:middle">Mandatory if receive type is STO</td></tr><tr align="center"><td style="vertical-align:middle">returnNo</td><td style="vertical-align:middle">Varchar(12)</td><td style="vertical-align:middle">Conditional*</td><td style="vertical-align:middle">Mandatory if receive type is RET</td></tr><tr align="center"><td style="vertical-align:middle">delivery_loc</td><td style="vertical-align:middle">Varchar(5)</td><td style="vertical-align:middle">Mandatory*</td><td style="vertical-align:middle">eRetail valid loccode or loccode of external system</td></tr><tr align="center"><td style="vertical-align:middle">extInboundNo</td><td style="vertical-align:middle">Varchar (50)</td><td style="vertical-align:middle">Mandatory*</td><td style="vertical-align:middle">Inbound code from External system</td></tr><tr align="center"><td style="vertical-align:middle">invoiceno</td><td style="vertical-align:middle">Varchar(20)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Invoice Number, must be unique in system</td></tr><tr align="center"><td style="vertical-align:middle">invoicedate</td><td style="vertical-align:middle">Datetime</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Invoice date, Date format should be like DD/MM/YYYY HH:MM:SS</td></tr><tr align="center"><td style="vertical-align:middle">invoice_amt</td><td style="vertical-align:middle">Decimal(20,5)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Total Invoice Amount</td></tr><tr align="center"><td style="vertical-align:middle">invoicetax</td><td style="vertical-align:middle">Decimal(10,3)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Tax amount associated with the invoice.</td></tr><tr align="center"><td style="vertical-align:middle">no_ofboxes</td><td style="vertical-align:middle">Int(11)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">NumberOFBoxes</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">Optional</td><td style="vertical-align:middle">Vehicle identifier for the shipment.</td></tr><tr align="center"><td style="vertical-align:middle">challan_no</td><td style="vertical-align:middle">Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Unique challan number for the shipment</td></tr><tr align="center"><td style="vertical-align:middle">challan_date</td><td style="vertical-align:middle">DateTime</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Date and time of challan issuance.</td></tr><tr align="center"><td style="vertical-align:middle">remarks</td><td style="vertical-align:middle">Varchar(5000)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Remarks against Inbound</td></tr><tr align="center"><td style="vertical-align:middle">weight</td><td style="vertical-align:middle">Decimal(10,3)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Weight of the shipment.</td></tr><tr align="center"><td style="vertical-align:middle">material_rcvddate</td><td style="vertical-align:middle">DateTime</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Timestamp of material receipt.</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><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">validateShelfLife</td><td style="vertical-align:middle">Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Indicates whether shelf life validation is required, accept values  yes or no</td></tr><tr align="center"><td style="vertical-align:middle">transporterCode</td><td style="vertical-align:middle">Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Transportercode as per masters</td></tr><tr align="center"><td style="vertical-align:middle">ewayBill</td><td style="vertical-align:middle">Varchar(100)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Tracking no</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">smallint(6)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">GRN Lineno </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 of the sku to be inbound</td></tr><tr align="center"><td style="vertical-align:middle">receivedqty</td><td style="vertical-align:middle">Integer(7)</td><td style="vertical-align:middle">Mandatory</td><td style="vertical-align:middle">SKU Qty to be received</td></tr><tr align="center"><td style="vertical-align:middle">bin</td><td style="vertical-align:middle">Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Bin code configured in eRetail</td></tr><tr align="center"><td style="vertical-align:middle">cost</td><td style="vertical-align:middle">Varchar(20)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Unit cost of SKU</td></tr><tr align="center"><td style="vertical-align:middle">imeino</td><td style="vertical-align:middle">Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">IMEI number for electronic items, if applicable</td></tr><tr align="center"><td style="vertical-align:middle">lottable01</td><td style="vertical-align:middle">Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Lot attribute fields</td></tr><tr align="center"><td style="vertical-align:middle">lottable02</td><td style="vertical-align:middle">DateTime</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Lot attribute fields (DD/MM/YYYY)</td></tr><tr align="center"><td style="vertical-align:middle">lottable03</td><td style="vertical-align:middle">DateTime</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Lot attribute fields (DD/MM/YYYY)</td></tr><tr align="center"><td style="vertical-align:middle">lottable04</td><td style="vertical-align:middle">DateTime</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Lot attribute fields (DD/MM/YYYY)</td></tr><tr align="center"><td style="vertical-align:middle">lottable05</td><td style="vertical-align:middle">Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Lot attribute fields</td></tr><tr align="center"><td style="vertical-align:middle">lottable06</td><td style="vertical-align:middle">Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Lot attribute fields</td></tr><tr align="center"><td style="vertical-align:middle">lottable07</td><td style="vertical-align:middle">Varchar(50)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">Lot attribute fields</td></tr><tr align="center"><td style="vertical-align:middle">usns</td><td style="vertical-align:middle">Array</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">1.Array of unique sequence number (eg. ["a080","a079"])</td></tr><tr align="center"><td style="vertical-align:middle">lpn</td><td style="vertical-align:middle">Varchar(20)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">LPN</td></tr><tr align="center"><td style="vertical-align:middle">uom</td><td style="vertical-align:middle">Varchar(10)</td><td style="vertical-align:middle">Optional</td><td style="vertical-align:middle">UOM Name</td></

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