POST api/edi/GetXsData
Request Information
URI Parameters
None.
Body Parameters
EdiCriteria| Name | Description | Type | Additional information |
|---|---|---|---|
| VendorId | string |
None. |
|
| ExportType | string |
None. |
|
| TransactionType | string |
None. |
|
| FromDate | date |
None. |
|
| ToDate | date |
None. |
|
| ItemNumber | string |
None. |
|
| FileName | string |
None. |
|
| IncludeRawProducts | boolean |
None. |
|
| IncludeFinishedProducts | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"VendorId": "sample string 1",
"ExportType": "sample string 2",
"TransactionType": "sample string 3",
"FromDate": "2026-11-21T05:35:05.6459064+00:00",
"ToDate": "2026-11-21T05:35:05.6459064+00:00",
"ItemNumber": "sample string 4",
"FileName": "sample string 5",
"IncludeRawProducts": true,
"IncludeFinishedProducts": true
}
application/xml, text/xml
Sample:
<EdiModels.EdiCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HarAccountingAPI.Models"> <ExportType>sample string 2</ExportType> <FileName>sample string 5</FileName> <FromDate>2026-11-21T05:35:05.6459064+00:00</FromDate> <IncludeFinishedProducts>true</IncludeFinishedProducts> <IncludeRawProducts>true</IncludeRawProducts> <ItemNumber>sample string 4</ItemNumber> <ToDate>2026-11-21T05:35:05.6459064+00:00</ToDate> <TransactionType>sample string 3</TransactionType> <VendorId>sample string 1</VendorId> </EdiModels.EdiCriteria>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of XsRecord| Name | Description | Type | Additional information |
|---|---|---|---|
| RetailICCode | string |
None. |
|
| TransactionDate | date |
None. |
|
| ShipFromLocationICCode | string |
None. |
|
| ShipToZipCode | string |
None. |
|
| InvoiceNumber | string |
None. |
|
| InvoiceLine | integer |
None. |
|
| ItemNumber | string |
None. |
|
| ItemDescription | string |
None. |
|
| PackageSize | string |
None. |
|
| Quantity | decimal number |
None. |
|
| UnitOfMeasure | string |
None. |
|
| DollarValue | decimal number |
None. |
|
| ExtRetail | decimal number |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"RetailICCode": "sample string 1",
"TransactionDate": "2026-11-21T05:35:05.6459064+00:00",
"ShipFromLocationICCode": "sample string 3",
"ShipToZipCode": "sample string 4",
"InvoiceNumber": "sample string 5",
"InvoiceLine": 6,
"ItemNumber": "sample string 7",
"ItemDescription": "sample string 8",
"PackageSize": "sample string 9",
"Quantity": 10.0,
"UnitOfMeasure": "sample string 11",
"DollarValue": 12.0,
"ExtRetail": 13.0
},
{
"RetailICCode": "sample string 1",
"TransactionDate": "2026-11-21T05:35:05.6459064+00:00",
"ShipFromLocationICCode": "sample string 3",
"ShipToZipCode": "sample string 4",
"InvoiceNumber": "sample string 5",
"InvoiceLine": 6,
"ItemNumber": "sample string 7",
"ItemDescription": "sample string 8",
"PackageSize": "sample string 9",
"Quantity": 10.0,
"UnitOfMeasure": "sample string 11",
"DollarValue": 12.0,
"ExtRetail": 13.0
}
]
application/xml, text/xml
Sample:
<ArrayOfEdiModels.XsRecord xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HarAccountingAPI.Models">
<EdiModels.XsRecord>
<DollarValue>12</DollarValue>
<ExtRetail>13</ExtRetail>
<InvoiceLine>6</InvoiceLine>
<InvoiceNumber>sample string 5</InvoiceNumber>
<ItemDescription>sample string 8</ItemDescription>
<ItemNumber>sample string 7</ItemNumber>
<PackageSize>sample string 9</PackageSize>
<Quantity>10</Quantity>
<RetailICCode>sample string 1</RetailICCode>
<ShipFromLocationICCode>sample string 3</ShipFromLocationICCode>
<ShipToZipCode>sample string 4</ShipToZipCode>
<TransactionDate>2026-11-21T05:35:05.6459064+00:00</TransactionDate>
<UnitOfMeasure>sample string 11</UnitOfMeasure>
</EdiModels.XsRecord>
<EdiModels.XsRecord>
<DollarValue>12</DollarValue>
<ExtRetail>13</ExtRetail>
<InvoiceLine>6</InvoiceLine>
<InvoiceNumber>sample string 5</InvoiceNumber>
<ItemDescription>sample string 8</ItemDescription>
<ItemNumber>sample string 7</ItemNumber>
<PackageSize>sample string 9</PackageSize>
<Quantity>10</Quantity>
<RetailICCode>sample string 1</RetailICCode>
<ShipFromLocationICCode>sample string 3</ShipFromLocationICCode>
<ShipToZipCode>sample string 4</ShipToZipCode>
<TransactionDate>2026-11-21T05:35:05.6459064+00:00</TransactionDate>
<UnitOfMeasure>sample string 11</UnitOfMeasure>
</EdiModels.XsRecord>
</ArrayOfEdiModels.XsRecord>