POST api/V3/DispatchAgainstOrder/TransactionV2

Upload List of Dispatches for Various Sales Done by ESMs in Transaction database Maximum 2000 in One request

Request Information

URI Parameters

None.

Body Parameters

Collection of V3.DispatchAgainstOrder
NameDescriptionTypeAdditional information
Visitid

Visit/Attendance Guid

 integer

Required
OutletErpId

Outlet ERP Id/ClientSide ID

 string

Required
DistributorErpId

Distributor ERP Id/ClientSide ID

 string

Required
DispatchTime

Time stamp of the Dispatch Done for the Sale

 date

Required
DispatchRemark

Comments/Remarks

 string

String length: inclusive between 0 and 500
InvoiceAmount

Amount total for the Invoice in local Currency

 decimal number

None.
InvoiceNo

Invoice number generated from ERP System

 string

String length: inclusive between 0 and 100
Status

Status of the order Dispatch (Partial/Complete/Incomplete/on its way?)

 string

String length: inclusive between 0 and 50
DispatchDetailsList

List of Dispatch Items along with its Details

 Collection of V3.DispatchDetails

None.
DMSSyncTime

Time of the Syncing of the Order from FAApi to DMS

 date

None.
InvoiceAttributeText1

Invoice Attribute Text 1

 string

String length: inclusive between 0 and 1000
InvoiceAttributeText2

Invoice Attribute Text 2

 string

String length: inclusive between 0 and 1000

Request Formats

application/json, text/json

Sample: 
[
  {
    "Visitid": 1,
    "OutletErpId": "sample string 1",
    "DistributorErpId": "sample string 2",
    "DispatchTime": "2025-04-28T09:11:45.7178591+00:00",
    "DispatchRemark": "sample string 4",
    "InvoiceAmount": 5.0,
    "InvoiceNo": "sample string 6",
    "Status": "sample string 7",
    "DispatchDetailsList": [
      {
        "ProductErpId": "sample string 1",
        "OrderQty": 2,
        "DispatchedQty": 3,
        "CancelledQty": 1,
        "BatchNo": "sample string 4",
        "Remark": "sample string 5",
        "ReturnQuantity": 1,
        "BilledPTR": 1.1
      },
      {
        "ProductErpId": "sample string 1",
        "OrderQty": 2,
        "DispatchedQty": 3,
        "CancelledQty": 1,
        "BatchNo": "sample string 4",
        "Remark": "sample string 5",
        "ReturnQuantity": 1,
        "BilledPTR": 1.1
      }
    ],
    "DMSSyncTime": "2025-04-28T09:11:45.7178591+00:00",
    "InvoiceAttributeText1": "sample string 8",
    "InvoiceAttributeText2": "sample string 9"
  },
  {
    "Visitid": 1,
    "OutletErpId": "sample string 1",
    "DistributorErpId": "sample string 2",
    "DispatchTime": "2025-04-28T09:11:45.7178591+00:00",
    "DispatchRemark": "sample string 4",
    "InvoiceAmount": 5.0,
    "InvoiceNo": "sample string 6",
    "Status": "sample string 7",
    "DispatchDetailsList": [
      {
        "ProductErpId": "sample string 1",
        "OrderQty": 2,
        "DispatchedQty": 3,
        "CancelledQty": 1,
        "BatchNo": "sample string 4",
        "Remark": "sample string 5",
        "ReturnQuantity": 1,
        "BilledPTR": 1.1
      },
      {
        "ProductErpId": "sample string 1",
        "OrderQty": 2,
        "DispatchedQty": 3,
        "CancelledQty": 1,
        "BatchNo": "sample string 4",
        "Remark": "sample string 5",
        "ReturnQuantity": 1,
        "BilledPTR": 1.1
      }
    ],
    "DMSSyncTime": "2025-04-28T09:11:45.7178591+00:00",
    "InvoiceAttributeText1": "sample string 8",
    "InvoiceAttributeText2": "sample string 9"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfDispatchAgainstOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models">
  <DispatchAgainstOrder>
    <DMSSyncTime>2025-04-28T09:11:45.7178591+00:00</DMSSyncTime>
    <DispatchDetailsList>
      <DispatchDetails>
        <BatchNo>sample string 4</BatchNo>
        <BilledPTR>1.1</BilledPTR>
        <CancelledQty>1</CancelledQty>
        <DispatchedQty>3</DispatchedQty>
        <OrderQty>2</OrderQty>
        <ProductErpId>sample string 1</ProductErpId>
        <Remark>sample string 5</Remark>
        <ReturnQuantity>1</ReturnQuantity>
      </DispatchDetails>
      <DispatchDetails>
        <BatchNo>sample string 4</BatchNo>
        <BilledPTR>1.1</BilledPTR>
        <CancelledQty>1</CancelledQty>
        <DispatchedQty>3</DispatchedQty>
        <OrderQty>2</OrderQty>
        <ProductErpId>sample string 1</ProductErpId>
        <Remark>sample string 5</Remark>
        <ReturnQuantity>1</ReturnQuantity>
      </DispatchDetails>
    </DispatchDetailsList>
    <DispatchRemark>sample string 4</DispatchRemark>
    <DispatchTime>2025-04-28T09:11:45.7178591+00:00</DispatchTime>
    <DistributorErpId>sample string 2</DistributorErpId>
    <InvoiceAmount>5</InvoiceAmount>
    <InvoiceAttributeText1>sample string 8</InvoiceAttributeText1>
    <InvoiceAttributeText2>sample string 9</InvoiceAttributeText2>
    <InvoiceNo>sample string 6</InvoiceNo>
    <OutletErpId>sample string 1</OutletErpId>
    <Status>sample string 7</Status>
    <Visitid>1</Visitid>
  </DispatchAgainstOrder>
  <DispatchAgainstOrder>
    <DMSSyncTime>2025-04-28T09:11:45.7178591+00:00</DMSSyncTime>
    <DispatchDetailsList>
      <DispatchDetails>
        <BatchNo>sample string 4</BatchNo>
        <BilledPTR>1.1</BilledPTR>
        <CancelledQty>1</CancelledQty>
        <DispatchedQty>3</DispatchedQty>
        <OrderQty>2</OrderQty>
        <ProductErpId>sample string 1</ProductErpId>
        <Remark>sample string 5</Remark>
        <ReturnQuantity>1</ReturnQuantity>
      </DispatchDetails>
      <DispatchDetails>
        <BatchNo>sample string 4</BatchNo>
        <BilledPTR>1.1</BilledPTR>
        <CancelledQty>1</CancelledQty>
        <DispatchedQty>3</DispatchedQty>
        <OrderQty>2</OrderQty>
        <ProductErpId>sample string 1</ProductErpId>
        <Remark>sample string 5</Remark>
        <ReturnQuantity>1</ReturnQuantity>
      </DispatchDetails>
    </DispatchDetailsList>
    <DispatchRemark>sample string 4</DispatchRemark>
    <DispatchTime>2025-04-28T09:11:45.7178591+00:00</DispatchTime>
    <DistributorErpId>sample string 2</DistributorErpId>
    <InvoiceAmount>5</InvoiceAmount>
    <InvoiceAttributeText1>sample string 8</InvoiceAttributeText1>
    <InvoiceAttributeText2>sample string 9</InvoiceAttributeText2>
    <InvoiceNo>sample string 6</InvoiceNo>
    <OutletErpId>sample string 1</OutletErpId>
    <Status>sample string 7</Status>
    <Visitid>1</Visitid>
  </DispatchAgainstOrder>
</ArrayOfDispatchAgainstOrder>

Response Information

Resource Description

ApiResponse
NameDescriptionTypeAdditional information
Message

Message Indicating the Overall Response Summary of the Requested API

 string

None.
ResponseList

List of Errors

 Collection of ApiResponseMessage

None.
Response

Enum Indicating the Response status

 ResponseStatus

None.
ResponseStatusCount

Summary containing Number of SuccessFull And Failed Tasks

 ResponseStatusCount

None.

Response Formats

application/json, text/json

Sample: 
{
  "Message": "sample string 1",
  "ResponseList": [
    {
      "ERPId": "sample string 1",
      "Message": "sample string 2",
      "ResponseStatus": "Failure",
      "GUID": "sample string 3"
    },
    {
      "ERPId": "sample string 1",
      "Message": "sample string 2",
      "ResponseStatus": "Failure",
      "GUID": "sample string 3"
    }
  ],
  "Response": "Failure",
  "ResponseStatusCount": {
    "Updated": 1,
    "Failed": 2,
    "Ignored": 3,
    "Name": "sample string 1",
    "Total": 6,
    "StatusMessage": "sample string 1: Total-6, Updated-1, Failed-2, Ignored-3",
    "ResponseStatus": "PartialSuccess"
  }
}

application/xml, text/xml

Sample: 
<ApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.Models.Common">
  <Message>sample string 1</Message>
  <Response>Failure</Response>
  <ResponseList>
    <ApiResponseMessage>
      <ERPId>sample string 1</ERPId>
      <GUID>sample string 3</GUID>
      <Message>sample string 2</Message>
      <ResponseStatus>Failure</ResponseStatus>
    </ApiResponseMessage>
    <ApiResponseMessage>
      <ERPId>sample string 1</ERPId>
      <GUID>sample string 3</GUID>
      <Message>sample string 2</Message>
      <ResponseStatus>Failure</ResponseStatus>
    </ApiResponseMessage>
  </ResponseList>
  <ResponseStatusCount>
    <Failed>2</Failed>
    <Ignored>3</Ignored>
    <Name>sample string 1</Name>
    <Updated>1</Updated>
  </ResponseStatusCount>
</ApiResponse>