POST api/Batch/GetBatches

Request Information

URI Parameters

None.

Body Parameters

BatchProcessingCriteria
NameDescriptionTypeAdditional information
EmpId

integer

None.

LOCNCODE

string

None.

Shift

string

None.

IncludeBatchStatus

boolean

None.

IncludeCompletedStatus

boolean

None.

IncludeNotPrinted

boolean

None.

RunDate

string

None.

SearchString

string

None.

PagingStart

integer

None.

NumRecs

integer

None.

SortFieldName

string

None.

SortDirection

string

None.

BegDate

date

None.

EndDate

date

None.

DateType

string

None.

Request Formats

application/json, text/json

Sample:
{
  "EmpId": 1,
  "LOCNCODE": "sample string 2",
  "Shift": "sample string 3",
  "IncludeBatchStatus": true,
  "IncludeCompletedStatus": true,
  "IncludeNotPrinted": true,
  "RunDate": "sample string 7",
  "SearchString": "sample string 8",
  "PagingStart": 1,
  "NumRecs": 1,
  "SortFieldName": "sample string 9",
  "SortDirection": "sample string 10",
  "BegDate": "2026-11-21T06:08:33.3109877+00:00",
  "EndDate": "2026-11-21T06:08:33.3109877+00:00",
  "DateType": "sample string 13"
}

application/xml, text/xml

Sample:
<BatchProcessingCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OperationsManagerAPI.Models">
  <BegDate>2026-11-21T06:08:33.3109877+00:00</BegDate>
  <DateType>sample string 13</DateType>
  <EmpId>1</EmpId>
  <EndDate>2026-11-21T06:08:33.3109877+00:00</EndDate>
  <IncludeBatchStatus>true</IncludeBatchStatus>
  <IncludeCompletedStatus>true</IncludeCompletedStatus>
  <IncludeNotPrinted>true</IncludeNotPrinted>
  <LOCNCODE>sample string 2</LOCNCODE>
  <NumRecs>1</NumRecs>
  <PagingStart>1</PagingStart>
  <RunDate>sample string 7</RunDate>
  <SearchString>sample string 8</SearchString>
  <Shift>sample string 3</Shift>
  <SortDirection>sample string 10</SortDirection>
  <SortFieldName>sample string 9</SortFieldName>
</BatchProcessingCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of BatchInformation
NameDescriptionTypeAdditional information
Trans_Num

integer

None.

RunDate

date

None.

BatchNum

string

None.

BagType

string

None.

BagTypeColor

string

None.

SOPNUMBE

string

None.

CUSTINFO

string

None.

QtyTons

decimal number

None.

Density

integer

None.

NPK

string

None.

BatchStatus

string

None.

SpargeType

string

None.

Printed

boolean

None.

NmbrLabels

integer

None.

NmbrFlySheets

integer

None.

BatchComments

string

None.

CreditIssue

boolean

None.

MixType

string

None.

ProdType

string

None.

ProdTypeDesc

string

None.

TagType

string

None.

Shift

string

None.

RequestedShipDate

date

None.

ShipDate

date

None.

ContainsPolyon

boolean

None.

HasControlledRelease

boolean

None.

LabelDescription

string

None.

TagWeight

string

None.

ItemNumber

string

None.

ItemDesc

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Trans_Num": 1,
    "RunDate": "2026-11-21T06:08:33.3109877+00:00",
    "BatchNum": "sample string 3",
    "BagType": "sample string 4",
    "BagTypeColor": "sample string 5",
    "SOPNUMBE": "sample string 6",
    "CUSTINFO": "sample string 7",
    "QtyTons": 8.1,
    "Density": 9,
    "NPK": "sample string 10",
    "BatchStatus": "sample string 11",
    "SpargeType": "sample string 12",
    "Printed": true,
    "NmbrLabels": 14,
    "NmbrFlySheets": 15,
    "BatchComments": "sample string 16",
    "CreditIssue": true,
    "MixType": "sample string 18",
    "ProdType": "sample string 19",
    "ProdTypeDesc": "sample string 20",
    "TagType": "sample string 21",
    "Shift": "sample string 22",
    "RequestedShipDate": "2026-11-21T06:08:33.3109877+00:00",
    "ShipDate": "2026-11-21T06:08:33.3109877+00:00",
    "ContainsPolyon": true,
    "HasControlledRelease": true,
    "LabelDescription": "sample string 27",
    "TagWeight": "sample string 28",
    "ItemNumber": "sample string 29",
    "ItemDesc": "sample string 30"
  },
  {
    "Trans_Num": 1,
    "RunDate": "2026-11-21T06:08:33.3109877+00:00",
    "BatchNum": "sample string 3",
    "BagType": "sample string 4",
    "BagTypeColor": "sample string 5",
    "SOPNUMBE": "sample string 6",
    "CUSTINFO": "sample string 7",
    "QtyTons": 8.1,
    "Density": 9,
    "NPK": "sample string 10",
    "BatchStatus": "sample string 11",
    "SpargeType": "sample string 12",
    "Printed": true,
    "NmbrLabels": 14,
    "NmbrFlySheets": 15,
    "BatchComments": "sample string 16",
    "CreditIssue": true,
    "MixType": "sample string 18",
    "ProdType": "sample string 19",
    "ProdTypeDesc": "sample string 20",
    "TagType": "sample string 21",
    "Shift": "sample string 22",
    "RequestedShipDate": "2026-11-21T06:08:33.3109877+00:00",
    "ShipDate": "2026-11-21T06:08:33.3109877+00:00",
    "ContainsPolyon": true,
    "HasControlledRelease": true,
    "LabelDescription": "sample string 27",
    "TagWeight": "sample string 28",
    "ItemNumber": "sample string 29",
    "ItemDesc": "sample string 30"
  }
]

application/xml, text/xml

Sample:
<ArrayOfBatchInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OperationsManagerAPI.Models">
  <BatchInformation>
    <BagType>sample string 4</BagType>
    <BagTypeColor>sample string 5</BagTypeColor>
    <BatchComments>sample string 16</BatchComments>
    <BatchNum>sample string 3</BatchNum>
    <BatchStatus>sample string 11</BatchStatus>
    <CUSTINFO>sample string 7</CUSTINFO>
    <ContainsPolyon>true</ContainsPolyon>
    <CreditIssue>true</CreditIssue>
    <Density>9</Density>
    <HasControlledRelease>true</HasControlledRelease>
    <ItemDesc>sample string 30</ItemDesc>
    <ItemNumber>sample string 29</ItemNumber>
    <LabelDescription>sample string 27</LabelDescription>
    <MixType>sample string 18</MixType>
    <NPK>sample string 10</NPK>
    <NmbrFlySheets>15</NmbrFlySheets>
    <NmbrLabels>14</NmbrLabels>
    <Printed>true</Printed>
    <ProdType>sample string 19</ProdType>
    <ProdTypeDesc>sample string 20</ProdTypeDesc>
    <QtyTons>8.1</QtyTons>
    <RequestedShipDate>2026-11-21T06:08:33.3109877+00:00</RequestedShipDate>
    <RunDate>2026-11-21T06:08:33.3109877+00:00</RunDate>
    <SOPNUMBE>sample string 6</SOPNUMBE>
    <Shift>sample string 22</Shift>
    <ShipDate>2026-11-21T06:08:33.3109877+00:00</ShipDate>
    <SpargeType>sample string 12</SpargeType>
    <TagType>sample string 21</TagType>
    <TagWeight>sample string 28</TagWeight>
    <Trans_Num>1</Trans_Num>
  </BatchInformation>
  <BatchInformation>
    <BagType>sample string 4</BagType>
    <BagTypeColor>sample string 5</BagTypeColor>
    <BatchComments>sample string 16</BatchComments>
    <BatchNum>sample string 3</BatchNum>
    <BatchStatus>sample string 11</BatchStatus>
    <CUSTINFO>sample string 7</CUSTINFO>
    <ContainsPolyon>true</ContainsPolyon>
    <CreditIssue>true</CreditIssue>
    <Density>9</Density>
    <HasControlledRelease>true</HasControlledRelease>
    <ItemDesc>sample string 30</ItemDesc>
    <ItemNumber>sample string 29</ItemNumber>
    <LabelDescription>sample string 27</LabelDescription>
    <MixType>sample string 18</MixType>
    <NPK>sample string 10</NPK>
    <NmbrFlySheets>15</NmbrFlySheets>
    <NmbrLabels>14</NmbrLabels>
    <Printed>true</Printed>
    <ProdType>sample string 19</ProdType>
    <ProdTypeDesc>sample string 20</ProdTypeDesc>
    <QtyTons>8.1</QtyTons>
    <RequestedShipDate>2026-11-21T06:08:33.3109877+00:00</RequestedShipDate>
    <RunDate>2026-11-21T06:08:33.3109877+00:00</RunDate>
    <SOPNUMBE>sample string 6</SOPNUMBE>
    <Shift>sample string 22</Shift>
    <ShipDate>2026-11-21T06:08:33.3109877+00:00</ShipDate>
    <SpargeType>sample string 12</SpargeType>
    <TagType>sample string 21</TagType>
    <TagWeight>sample string 28</TagWeight>
    <Trans_Num>1</Trans_Num>
  </BatchInformation>
</ArrayOfBatchInformation>