POST api/printBatches/details/printed

Mark all details that match with provided print batch filters

Request Information

URI Parameters

None.

Body Parameters

Print Batch filters

Name	Description	Type	Additional information
HeaderIdentifier		Collection of byte	None.
HeaderGuid		globally unique identifier	None.
PrintRequestType		PrintRequestType	None.
SortKind		PrintBatchSortKind	None.
Sort		SortOrder	None.
Printed	Whether to include the print batch details that have been printed	boolean	None.
PrintDate	The date that a print batch detail was printed, incompatible with printed filter being set to false	date	None.
UTCOffset	UTC offset to be used with the single date to get the results accurately	decimal number	None.
UseExactPrintDateTime		boolean	None.
Keyword		string	None.
Search		ProductQuerySearch	None.
ShelfLocationGuids	Print Batch Details assigned to these location only	Collection of globally unique identifier	None.
SupplierIdentifier	Print Batch Details with product with this preffered supplier only	Collection of byte	None.
SupplierGuid		globally unique identifier	None.
StoreID		integer	None.
Stores		Collection of integer	None.
PLU	PLU	integer	None.
APN		string	None.
Name		string	None.
ItemNumber	Item number	string	None.
DirectNumber	PluOrderingDetail.ItemCode	string	None.
DepartmentCode	Print Batch Details with product in this department	string	None.
SubDepartmentCode	Print Batch Details with product in this sub department Added for react app	string	None.
MinorDepartmentCode	Print Batch Details with product in this minor department Added for react app	string	None.
Tobacco	Print Batch Details with product has a tobacco product type	boolean	None.
Liquor	Print Batch Details with product has a liquor product type	boolean	Deprecated.
GlutenFree	Print Batch Details with product that is gluten free	boolean	None.
ExcludeTalkers	Print Batch details with a product that has departments with matching ExcludeTalkers values	boolean	None.
Direct	Print Batch details with a product that has a SupplierDirect Warehouse Indicator	boolean	None.
Variety	Print Batch details with a product that has a Variety Warehouse Indicator	boolean	None.
Warehouse	Print Batch details with a product that has a WarehouseLine Warehouse Indicator	boolean	None.
SlowMoving	Print Batch Details with product is (not) Slow Moving? (true or false option, matched to Product value)	boolean	None.
GeneralMerchandise	Print Batch Details with product is (not) General Merchandise? (true or false option, matched to Product value)	boolean	None.
HasCampaign	Print Batch Details with products that has a campaign (when it's set to true)	boolean	None.
ComplianceIndicator	Print Batch Details with product has this ComplianceIndicator/CoreRangeIndicator	string	None.
ComplianceIndicators	Print Batch Details with product has these ComplianceIndicators/CoreRangeIndicators	Collection of string	None.
Grades	Print Batch Details with product has these ProductGrade(s)	Collection of string	None.
StartsWith	Whether to make searches starting with rather than anywhere.	boolean	None.
ExcludeZeroQty	Excludes any talkers with zero quantity	boolean	None.
CampaignNames	Filter batch details by campaign names. Added for react app	Collection of string	None.
DepartmentCodes	Filter batch details by department codes. Added for react app	Collection of string	None.
SubDepartmentCodes	Filter batch details by subdepartment codes Added for react app	Collection of string	None.
MinorDepartmentCodes	Filter batch details by minordepartment codes Added for react app	Collection of string	None.
LesserDepartmentCodes	Filter batch details by lesserdepartment codes Added for react app	Collection of string	None.
WarehouseDirectIndicators	filter by warehouse indicator of PLU	Collection of string	None.
Users	Filter print batch details by users	Collection of string	None.
PrintBatchTypes	filter by PrintBatchtypes	Collection of integer	None.
IncludeZeroQtyOnly	filter labels having 0 Qty only - for react app	boolean	None.
LabelPageLayoutG_UID		Collection of byte	None.
LabelPageLayoutGuid		globally unique identifier	None.
CampaignStartDate	The detail campaign will starts after this date	date	None.
CampaignEndDate	The detail campaign will starts before this date	date	None.
Relations	Load all product, location, bin and operator models	boolean	None.
Skip	Number of records to skip over	integer	None.
Take	Number of records to take	integer	None.
TotalCount		integer	Relation. This field may not always be loaded or used for updates.

Request Formats

application/json, text/json

Sample:

{
  "headerIdentifier": "dQufm+KOKUCGDqVaxq80Ww==",
  "headerGuid": "9b9f0b75-8ee2-4029-860e-a55ac6af345b",
  "printRequestType": 1,
  "sortKind": 0,
  "sort": 0,
  "printed": true,
  "printDate": "2026-04-03T06:20:58.4508533",
  "utcOffset": 3.1,
  "useExactPrintDateTime": true,
  "keyword": "sample string 5",
  "search": 0,
  "shelfLocationGuids": [
    "594a858c-31f3-4a6d-b7ea-18cf87758b18",
    "f7a1f1c9-6c14-4adc-a608-19ea633dacf8"
  ],
  "supplierIdentifier": "BK09FSlSG0WPRIrgcsehYQ==",
  "supplierGuid": "153dad04-5229-451b-8f44-8ae072c7a161",
  "storeID": 1,
  "stores": [
    1,
    2
  ],
  "plu": 1,
  "apn": "sample string 6",
  "name": "sample string 7",
  "itemNumber": "sample string 8",
  "directNumber": "sample string 9",
  "departmentCode": "sample string 10",
  "subDepartmentCode": "sample string 11",
  "minorDepartmentCode": "sample string 12",
  "tobacco": true,
  "liquor": true,
  "glutenFree": true,
  "excludeTalkers": true,
  "direct": true,
  "variety": true,
  "warehouse": true,
  "slowMoving": true,
  "generalMerchandise": true,
  "hasCampaign": true,
  "complianceIndicator": "sample string 14",
  "complianceIndicators": [
    "sample string 1",
    "sample string 2"
  ],
  "grades": [
    "sample string 1",
    "sample string 2"
  ],
  "startsWith": true,
  "excludeZeroQty": true,
  "campaignNames": [
    "sample string 1",
    "sample string 2"
  ],
  "departmentCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "subDepartmentCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "minorDepartmentCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "lesserDepartmentCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "warehouseDirectIndicators": [
    "sample string 1",
    "sample string 2"
  ],
  "users": [
    "sample string 1",
    "sample string 2"
  ],
  "printBatchTypes": [
    1,
    2
  ],
  "includeZeroQtyOnly": true,
  "labelPageLayoutG_UID": "qrVRgdRQPEO0zqaTyAdgkQ==",
  "labelPageLayoutGuid": "8151b5aa-50d4-433c-b4ce-a693c8076091",
  "campaignStartDate": "2026-04-03T06:20:58.4508533",
  "campaignEndDate": "2026-04-03T06:20:58.4508533",
  "relations": true,
  "skip": 1,
  "take": 1,
  "totalCount": 1
}

application/xml, text/xml

Sample:

<PrintBatchDetailQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.EMC.Labels">
  <Skip xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.Common">1</Skip>
  <Take xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.Common">1</Take>
  <TotalCount xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.Common">1</TotalCount>
  <APN>sample string 6</APN>
  <CampaignEndDate>2026-04-03T06:20:58.4508533+00:00</CampaignEndDate>
  <CampaignNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </CampaignNames>
  <CampaignStartDate>2026-04-03T06:20:58.4508533+00:00</CampaignStartDate>
  <ComplianceIndicator>sample string 14</ComplianceIndicator>
  <ComplianceIndicators xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ComplianceIndicators>
  <DepartmentCode>sample string 10</DepartmentCode>
  <DepartmentCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </DepartmentCodes>
  <Direct>true</Direct>
  <DirectNumber>sample string 9</DirectNumber>
  <ExcludeTalkers>true</ExcludeTalkers>
  <ExcludeZeroQty>true</ExcludeZeroQty>
  <GeneralMerchandise>true</GeneralMerchandise>
  <GlutenFree>true</GlutenFree>
  <Grades xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Grades>
  <HasCampaign>true</HasCampaign>
  <HeaderGuid>9b9f0b75-8ee2-4029-860e-a55ac6af345b</HeaderGuid>
  <HeaderIdentifier>dQufm+KOKUCGDqVaxq80Ww==</HeaderIdentifier>
  <IncludeZeroQtyOnly>true</IncludeZeroQtyOnly>
  <ItemNumber>sample string 8</ItemNumber>
  <Keyword>sample string 5</Keyword>
  <LabelPageLayoutG_UID>qrVRgdRQPEO0zqaTyAdgkQ==</LabelPageLayoutG_UID>
  <LabelPageLayoutGuid>8151b5aa-50d4-433c-b4ce-a693c8076091</LabelPageLayoutGuid>
  <LesserDepartmentCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </LesserDepartmentCodes>
  <Liquor>true</Liquor>
  <MinorDepartmentCode>sample string 12</MinorDepartmentCode>
  <MinorDepartmentCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </MinorDepartmentCodes>
  <Name>sample string 7</Name>
  <PLU>1</PLU>
  <PrintBatchTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </PrintBatchTypes>
  <PrintDate>2026-04-03T06:20:58.4508533+00:00</PrintDate>
  <PrintRequestType>1</PrintRequestType>
  <Printed>true</Printed>
  <Relations>true</Relations>
  <Search>Default</Search>
  <ShelfLocationGuids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>594a858c-31f3-4a6d-b7ea-18cf87758b18</d2p1:guid>
    <d2p1:guid>f7a1f1c9-6c14-4adc-a608-19ea633dacf8</d2p1:guid>
  </ShelfLocationGuids>
  <SlowMoving>true</SlowMoving>
  <Sort>Asc</Sort>
  <SortKind>Location</SortKind>
  <StartsWith>true</StartsWith>
  <StoreID>1</StoreID>
  <Stores xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Stores>
  <SubDepartmentCode>sample string 11</SubDepartmentCode>
  <SubDepartmentCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </SubDepartmentCodes>
  <SupplierGuid>153dad04-5229-451b-8f44-8ae072c7a161</SupplierGuid>
  <SupplierIdentifier>BK09FSlSG0WPRIrgcsehYQ==</SupplierIdentifier>
  <Tobacco>true</Tobacco>
  <UTCOffset>3.1</UTCOffset>
  <UseExactPrintDateTime>true</UseExactPrintDateTime>
  <Users xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Users>
  <Variety>true</Variety>
  <Warehouse>true</Warehouse>
  <WarehouseDirectIndicators xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </WarehouseDirectIndicators>
</PrintBatchDetailQuery>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.