POST api/printBatch/designs/{designCount}/pageCount

This is a GET request masked as a POST request to get around query string limits for location filtering. Gets a count of labels printed based on current settings that can be used to determine a page count

Request Information

URI Parameters

NameDescriptionTypeAdditional information
designCount

The number of labels printed per label in page layout

 integer

Required

Body Parameters

Filtering options for print batch details(mostly focused on Store, Shelf Location, Department and Campaign)

PrintBatchDetailQuery
NameDescriptionTypeAdditional information
Take

integer

None.
Skip

integer

None.
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.
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.

Request Formats

application/json, text/json

Sample: 
{
  "take": 1,
  "skip": 1,
  "headerIdentifier": "/qKLYZEmfEiKwpRcvlkJ/A==",
  "headerGuid": "618ba2fe-2691-487c-8ac2-945cbe5909fc",
  "printRequestType": 1,
  "sortKind": 0,
  "sort": 0,
  "printed": true,
  "printDate": "2025-06-14T06:35:20.0097442",
  "utcOffset": 3.1,
  "useExactPrintDateTime": true,
  "keyword": "sample string 5",
  "search": 0,
  "shelfLocationGuids": [
    "dcba32d3-7af1-4c8b-954b-4a92f2650659",
    "9da3e492-e67b-4900-b780-1d9b335d7185"
  ],
  "supplierIdentifier": "vp1vLiF4kkOkP6EIVCTQBA==",
  "supplierGuid": "2e6f9dbe-7821-4392-a43f-a1085424d004",
  "storeID": 1,
  "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": "mf7E8cqBikKUMzgVb4n0Ig==",
  "labelPageLayoutGuid": "f1c4fe99-81ca-428a-9433-38156f89f422",
  "campaignStartDate": "2025-06-14T06:35:20.0097442",
  "campaignEndDate": "2025-06-14T06:35:20.0097442",
  "relations": true
}

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">
  <APN>sample string 6</APN>
  <CampaignEndDate>2025-06-14T06:35:20.0097442+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>2025-06-14T06:35:20.0097442+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>618ba2fe-2691-487c-8ac2-945cbe5909fc</HeaderGuid>
  <HeaderIdentifier>/qKLYZEmfEiKwpRcvlkJ/A==</HeaderIdentifier>
  <IncludeZeroQtyOnly>true</IncludeZeroQtyOnly>
  <ItemNumber>sample string 8</ItemNumber>
  <Keyword>sample string 5</Keyword>
  <LabelPageLayoutG_UID>mf7E8cqBikKUMzgVb4n0Ig==</LabelPageLayoutG_UID>
  <LabelPageLayoutGuid>f1c4fe99-81ca-428a-9433-38156f89f422</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>2025-06-14T06:35:20.0097442+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>dcba32d3-7af1-4c8b-954b-4a92f2650659</d2p1:guid>
    <d2p1:guid>9da3e492-e67b-4900-b780-1d9b335d7185</d2p1:guid>
  </ShelfLocationGuids>
  <Skip>1</Skip>
  <SlowMoving>true</SlowMoving>
  <Sort>Asc</Sort>
  <SortKind>Location</SortKind>
  <StartsWith>true</StartsWith>
  <StoreID>1</StoreID>
  <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>2e6f9dbe-7821-4392-a43f-a1085424d004</SupplierGuid>
  <SupplierIdentifier>vp1vLiF4kkOkP6EIVCTQBA==</SupplierIdentifier>
  <Take>1</Take>
  <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

A count of the number of labels that will be printed for the current settings

integer

Response Formats

application/json, text/json

Sample: 
1

application/xml, text/xml

Sample: 
<long xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</long>

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Sample: 
PKj4�Z��ƶ5xl/workbook.xml �(�����0��J}�(PC�����k��.8%��(IE�R�n�����q�Ә�}Ԡ}�Jޅ`s�t���%w�8�!J�#�l�6�[�pL�
�Ѿ�����[G���(�aA)��W�c���!i���Zw2,!�M3l��Ө��5�lvnm�S�\.�p�P`z�bsN�	�����w�PKj4�Z����	�[Content_Types].xml �(����J�0�_��*M�D��V�*��d�
�d�k��<�H���V���=
��|�o��|����������+�����7l���e۶~=E�"�zlXO�@Ճ��C�3]HNR~���R��uU�<���������a��36��b7םQ
�1Z�$�8z�R��3
tP��-c�� g����_M��Of���~O�s�T���� ����P<�D��e=1Z��a2�b
��%#H'�2}���e�B)��~j/F�t��PK
j4�Z��;''_rels/.rels �(�<?xml version="1.0" encoding="utf-8"?><Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="xl/workbook.xml" Id="R693186aef53b4222" /></Relationships>PKj4�Z��4�xl/worksheets/sheet1.xml �(��Q�n� ��}%��j�U���n�ۙ%N@
82����6M�e������<��Ȯ@��ox��8�bg���9�w����t	 ��aO
71N{!Bk���	|z둜�)�A`��N��|۪�	�Q�T*;���G+L�+ܸJ9m=W��I=�g}Ï5gBɂ|���_1�m|"^r��5�*X�|.�_�u��y�o�<�LLz(��Pv�l�gN�ʹ�.��?m��j�M�v��z��+��:騕$\�礚��G����Z�kf���ߎW�Is:#F����W�PKj4�Z΢h$�Pxl/_rels/workbook.xml.rels �(����n� @�׀�S;
�ҥk���0Vl@@���:��E���C�L���������2�qrV`VQ��*7Lv���]�w��f��h&Q�Q`��_��E��y���]Xd�i���(G 5�+J�f�����N�I��S�l�L^]8F�0:�0B���w`U�b�4�_I-ٽn����.�On��y���u�����448��2F�S�/]:��B�oh�2�������{"W�b�PKj4�ZЃc'2E
xl/styles.xml �(��S�j�0��&0���0�^�]v��:��d;��H��Kj�vG�Mz�zOHr�iB8v�F��WEG�?s�Oh�lff�uZМ���ށh�R���6�'��2��������ɳ�UŦ`<Қo���x���8��K�6BC ^�کĖ��B���n��f8����9� ����CUk��#��U�ub��WUB;��k���&�
AR>��� ��im��ΑF���YO��%�}���LJ\in�,���9oy}��y.�$��6��ųNJ�c��T��rĘ)փBR淶�E3ʟ�\��q��PKj4�Z�/���xl/sharedStrings.xml �(�5�A� �B�nA�h&�@@ڵ����������d2;}Ҧ�X9frp(�9/�V���p��i�[&t�E5��YTO��r՚���R7�\���u�\*����M��9��#��s#qЧ��������~PK-j4�Z��ƶ5xl/workbook.xmlPK-j4�Z����	��[Content_Types].xmlPK-
j4�Z��;''U_rels/.relsPK-j4�Z��4��xl/worksheets/sheet1.xmlPK-j4�Z΢h$�P-xl/_rels/workbook.xml.relsPK-j4�ZЃc'2E
sxl/styles.xmlPK-j4�Z�/����xl/sharedStrings.xmlPK��

application/vnd.ms-excel

Sample: 
PKj4�Zm���5xl/workbook.xml �(�����0��&�C���R8q���{-[i�?ik��-%�x�3;�����a��z2��
bt5!A�y8X&����$��X)��Ί�II�x�xTքA��W�?��<�>QO+Jsep��!Ėfws�2ߺ���"�)�a�EV�p

�x�e��7����*
7Zą+y�J�㍽���n?PKj4�Z����	�[Content_Types].xml �(����J�0�_��*M�D��V�*��d�
�d�k��<�H���V���=
��|�o��|����������+�����7l���e۶~=E�"�zlXO�@Ճ��C�3]HNR~���R��uU�<���������a��36��b7םQ
�1Z�$�8z�R��3
tP��-c�� g����_M��Of���~O�s�T���� ����P<�D��e=1Z��a2�b
��%#H'�2}���e�B)��~j/F�t��PK
j4�Zzܫ''_rels/.rels �(�<?xml version="1.0" encoding="utf-8"?><Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="xl/workbook.xml" Id="R1f5ba9d92ea644a3" /></Relationships>PKj4�Z��4�xl/worksheets/sheet1.xml �(��Q�n� ��}%��j�U���n�ۙ%N@
82����6M�e������<��Ȯ@��ox��8�bg���9�w����t	 ��aO
71N{!Bk���	|z둜�)�A`��N��|۪�	�Q�T*;���G+L�+ܸJ9m=W��I=�g}Ï5gBɂ|���_1�m|"^r��5�*X�|.�_�u��y�o�<�LLz(��Pv�l�gN�ʹ�.��?m��j�M�v��z��+��:騕$\�礚��G����Z�kf���ߎW�Is:#F����W�PKj4�Z}4�Pxl/_rels/workbook.xml.rels �(���MN�0F�b͞�	n��ݰa[z���DM��v���G�
XE�Tb�����==i���c�}�zgk�3AV���mM�h�*�n�;*����S`iņ����AwU���:��QŔ��OJU^��~Πk&۟'����5�>���0u�: �+�"��S
��,Q�=55�D��J�K���i�񛩅x~����CsX.*Q���2��h��O��;��3�C�d���,K\���_l�PKj4�ZЃc'2E
xl/styles.xml �(��S�j�0��&0���0�^�]v��:��d;��H��Kj�vG�Mz�zOHr�iB8v�F��WEG�?s�Oh�lff�uZМ���ށh�R���6�'��2��������ɳ�UŦ`<Қo���x���8��K�6BC ^�کĖ��B���n��f8����9� ����CUk��#��U�ub��WUB;��k���&�
AR>��� ��im��ΑF���YO��%�}���LJ\in�,���9oy}��y.�$��6��ųNJ�c��T��rĘ)փBR淶�E3ʟ�\��q��PKj4�Z�/���xl/sharedStrings.xml �(�5�A� �B�nA�h&�@@ڵ����������d2;}Ҧ�X9frp(�9/�V���p��i�[&t�E5��YTO��r՚���R7�\���u�\*����M��9��#��s#qЧ��������~PK-j4�Zm���5xl/workbook.xmlPK-j4�Z����	��[Content_Types].xmlPK-
j4�Zzܫ''U_rels/.relsPK-j4�Z��4��xl/worksheets/sheet1.xmlPK-j4�Z}4�P-xl/_rels/workbook.xml.relsPK-j4�ZЃc'2E
sxl/styles.xmlPK-j4�Z�/����xl/sharedStrings.xmlPK��