POST api/Dispatch

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
DispatchFromLocationID	integer	Required
DispatchToLocationID	integer	None.
ConsignmentOrderID	integer	None.
RFIDs	string	Required
Title	string	None.
Description	string	None.
AddedBy	integer	Required
AddedDate	date	None.
OperationName	string	None.
OperatedBy	string	None.
OperatedOn	date	None.
OperationFrom	string	None.
DispatchID	integer	None.
StatusID	integer	None.
ConsignmentDeliveryID	integer	None.
IsSalesTransfer	boolean	None.
ShopifyCMMSOrderID	integer	None.
IsDispatchOrder	boolean	None.
IsInventoryDispatch	boolean	None.
NeedForcedMove	boolean	None.
ForceMoveReason	string	None.
SiesaSalesOrderNo	string	None.
MisMatchComment	string	None.
ScanCode	string	None.
ProductRFIDSalesOrderID	integer	None.

Request Formats

application/json, text/json, text/plain, text/html

Sample:

{
  "dispatchFromLocationID": 1,
  "dispatchToLocationID": 1,
  "consignmentOrderID": 1,
  "rfiDs": "sample string 2",
  "title": "sample string 3",
  "description": "sample string 4",
  "addedBy": 5,
  "addedDate": "2025-07-17T04:37:24.0857347+00:00",
  "operationName": "sample string 7",
  "operatedBy": "sample string 8",
  "operatedOn": "2025-07-17T04:37:24.0857347+00:00",
  "operationFrom": "sample string 10",
  "dispatchID": 1,
  "statusID": 1,
  "consignmentDeliveryID": 1,
  "isSalesTransfer": true,
  "shopifyCMMSOrderID": 1,
  "isDispatchOrder": true,
  "isInventoryDispatch": true,
  "needForcedMove": true,
  "forceMoveReason": "sample string 11",
  "siesaSalesOrderNo": "sample string 12",
  "misMatchComment": "sample string 13",
  "scanCode": "sample string 14",
  "productRFIDSalesOrderID": 1
}

application/xml, text/xml

Sample:

<DispatchRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel">
  <AddedBy>5</AddedBy>
  <AddedDate>2025-07-17T04:37:24.0857347+00:00</AddedDate>
  <ConsignmentDeliveryID>1</ConsignmentDeliveryID>
  <ConsignmentOrderID>1</ConsignmentOrderID>
  <Description>sample string 4</Description>
  <DispatchFromLocationID>1</DispatchFromLocationID>
  <DispatchID>1</DispatchID>
  <DispatchToLocationID>1</DispatchToLocationID>
  <ForceMoveReason>sample string 11</ForceMoveReason>
  <IsDispatchOrder>true</IsDispatchOrder>
  <IsInventoryDispatch>true</IsInventoryDispatch>
  <IsSalesTransfer>true</IsSalesTransfer>
  <MisMatchComment>sample string 13</MisMatchComment>
  <NeedForcedMove>true</NeedForcedMove>
  <OperatedBy>sample string 8</OperatedBy>
  <OperatedOn>2025-07-17T04:37:24.0857347+00:00</OperatedOn>
  <OperationFrom>sample string 10</OperationFrom>
  <OperationName>sample string 7</OperationName>
  <ProductRFIDSalesOrderID>1</ProductRFIDSalesOrderID>
  <RFIDs>sample string 2</RFIDs>
  <ScanCode>sample string 14</ScanCode>
  <ShopifyCMMSOrderID>1</ShopifyCMMSOrderID>
  <SiesaSalesOrderNo>sample string 12</SiesaSalesOrderNo>
  <StatusID>1</StatusID>
  <Title>sample string 3</Title>
</DispatchRequestModel>

multipart/form-data

Sample:

<DispatchRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel"><AddedBy>5</AddedBy><AddedDate>2025-07-17T04:37:24.0857347+00:00</AddedDate><ConsignmentDeliveryID>1</ConsignmentDeliveryID><ConsignmentOrderID>1</ConsignmentOrderID><Description>sample string 4</Description><DispatchFromLocationID>1</DispatchFromLocationID><DispatchID>1</DispatchID><DispatchToLocationID>1</DispatchToLocationID><ForceMoveReason>sample string 11</ForceMoveReason><IsDispatchOrder>true</IsDispatchOrder><IsInventoryDispatch>true</IsInventoryDispatch><IsSalesTransfer>true</IsSalesTransfer><MisMatchComment>sample string 13</MisMatchComment><NeedForcedMove>true</NeedForcedMove><OperatedBy>sample string 8</OperatedBy><OperatedOn>2025-07-17T04:37:24.0857347+00:00</OperatedOn><OperationFrom>sample string 10</OperationFrom><OperationName>sample string 7</OperationName><ProductRFIDSalesOrderID>1</ProductRFIDSalesOrderID><RFIDs>sample string 2</RFIDs><ScanCode>sample string 14</ScanCode><ShopifyCMMSOrderID>1</ShopifyCMMSOrderID><SiesaSalesOrderNo>sample string 12</SiesaSalesOrderNo><StatusID>1</StatusID><Title>sample string 3</Title></DispatchRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of DispatchDataModel

Name	Type	Additional information
ScanCode	string	None.
ScannedId	integer	None.
ScannedCount	integer	None.
MissingCount	integer	None.
ReturnID	integer	Required
Message	string	Required
Successful	boolean	Required
Code	integer	None.
TotalRecord	integer	None.

Response Formats

application/json, text/json, text/plain, text/html

Sample:

[
  {
    "scanCode": "sample string 1",
    "scannedId": 2,
    "scannedCount": 3,
    "missingCount": 4,
    "returnID": 5,
    "message": "sample string 6",
    "successful": true,
    "code": 8,
    "totalRecord": 9
  },
  {
    "scanCode": "sample string 1",
    "scannedId": 2,
    "scannedCount": 3,
    "missingCount": 4,
    "returnID": 5,
    "message": "sample string 6",
    "successful": true,
    "code": 8,
    "totalRecord": 9
  }
]

application/xml, text/xml

Sample:

<ArrayOfDispatchDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.DataModel">
  <DispatchDataModel>
    <Code xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">8</Code>
    <Message xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">sample string 6</Message>
    <ReturnID xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">5</ReturnID>
    <Successful xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">true</Successful>
    <TotalRecord xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">9</TotalRecord>
    <MissingCount>4</MissingCount>
    <ScanCode>sample string 1</ScanCode>
    <ScannedCount>3</ScannedCount>
    <ScannedId>2</ScannedId>
  </DispatchDataModel>
  <DispatchDataModel>
    <Code xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">8</Code>
    <Message xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">sample string 6</Message>
    <ReturnID xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">5</ReturnID>
    <Successful xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">true</Successful>
    <TotalRecord xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">9</TotalRecord>
    <MissingCount>4</MissingCount>
    <ScanCode>sample string 1</ScanCode>
    <ScannedCount>3</ScannedCount>
    <ScannedId>2</ScannedId>
  </DispatchDataModel>
</ArrayOfDispatchDataModel>

multipart/form-data

Sample:

<ArrayOfDispatchDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.DataModel"><DispatchDataModel><Code xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">8</Code><Message xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">sample string 6</Message><ReturnID xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">5</ReturnID><Successful xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">true</Successful><TotalRecord xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">9</TotalRecord><MissingCount>4</MissingCount><ScanCode>sample string 1</ScanCode><ScannedCount>3</ScannedCount><ScannedId>2</ScannedId></DispatchDataModel><DispatchDataModel><Code xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">8</Code><Message xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">sample string 6</Message><ReturnID xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">5</ReturnID><Successful xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">true</Successful><TotalRecord xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">9</TotalRecord><MissingCount>4</MissingCount><ScanCode>sample string 1</ScanCode><ScannedCount>3</ScannedCount><ScannedId>2</ScannedId></DispatchDataModel></ArrayOfDispatchDataModel>