POST api/printBatch/printJob/register

Register Job ID and large payload in cache. If request/query/ids is null/empty, return null

Request Information

URI Parameters

None.

Body Parameters

PrintJobRequest
NameDescriptionTypeAdditional information
StoreID

integer

None.
Ids

Collection of globally unique identifier

None.
PriceDate

date

None.
IsTalker

boolean

None.
Query

PrintBatchDetailQuery

None.
IsBatch

(false: multi-selection Guids , true: printBatchDetailQuery) as print job input

 boolean

None.
LabelNames

Collection of string

None.
PrintSettings

Dictionary of string [key] and Object [value]

None.

Request Formats

application/json, text/json

Sample: 
{
  "storeID": 1,
  "ids": [
    "e35dacc0-ee51-4d58-a35f-2b2480395d09",
    "c3bf4559-693b-4a17-b02e-e54dad59b29c"
  ],
  "priceDate": "2026-06-03T18:32:13.3500859",
  "isTalker": true,
  "query": {
    "$id": "2",
    "headerIdentifier": "Gi1djIUDOE2Qw33YavrG0A==",
    "headerGuid": "8c5d2d1a-0385-4d38-90c3-7dd86afac6d0",
    "printRequestType": 1,
    "sortKind": 0,
    "sort": 0,
    "printed": true,
    "printDate": "2026-06-03T18:32:13.3500859",
    "utcOffset": 3.1,
    "useExactPrintDateTime": true,
    "keyword": "sample string 5",
    "search": 0,
    "shelfLocationGuids": [
      "16dc7593-8751-4a6f-a534-73c365d01362",
      "c5f190af-3a63-4dfc-9d8f-2b96cadb26ad"
    ],
    "supplierIdentifier": "wCMv198ht0ScAvlz8ol3yQ==",
    "supplierGuid": "d72f23c0-21df-44b7-9c02-f973f28977c9",
    "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,
    "chargeThrough": 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": [
      0,
      0
    ],
    "includeZeroQtyOnly": true,
    "labelPageLayoutG_UID": "pMqoEHrrYEeZ2JXkuWU55A==",
    "labelPageLayoutGuid": "10a8caa4-eb7a-4760-99d8-95e4b96539e4",
    "campaignStartDate": "2026-06-03T18:32:13.3500859",
    "campaignEndDate": "2026-06-03T18:32:13.3500859",
    "relations": true,
    "skip": 1,
    "take": 1,
    "totalCount": 1
  },
  "isBatch": true,
  "labelNames": [
    "sample string 1",
    "sample string 2"
  ],
  "printSettings": {
    "$id": "3",
    "sample string 1": {
      "$id": "4"
    },
    "sample string 3": {
      "$id": "5"
    }
  }
}

application/xml, text/xml

Sample: 
<PrintJobRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.EMC.Labels">
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>e35dacc0-ee51-4d58-a35f-2b2480395d09</d2p1:guid>
    <d2p1:guid>c3bf4559-693b-4a17-b02e-e54dad59b29c</d2p1:guid>
  </Ids>
  <IsBatch>true</IsBatch>
  <IsTalker>true</IsTalker>
  <LabelNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </LabelNames>
  <PriceDate>2026-06-03T18:32:13.3500859+00:00</PriceDate>
  <PrintSettings xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </PrintSettings>
  <Query>
    <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-06-03T18:32:13.3500859+00:00</CampaignEndDate>
    <CampaignNames xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </CampaignNames>
    <CampaignStartDate>2026-06-03T18:32:13.3500859+00:00</CampaignStartDate>
    <ChargeThrough>true</ChargeThrough>
    <ComplianceIndicator>sample string 14</ComplianceIndicator>
    <ComplianceIndicators xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </ComplianceIndicators>
    <DepartmentCode>sample string 10</DepartmentCode>
    <DepartmentCodes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </DepartmentCodes>
    <Direct>true</Direct>
    <DirectNumber>sample string 9</DirectNumber>
    <ExcludeTalkers>true</ExcludeTalkers>
    <ExcludeZeroQty>true</ExcludeZeroQty>
    <GeneralMerchandise>true</GeneralMerchandise>
    <GlutenFree>true</GlutenFree>
    <Grades xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Grades>
    <HasCampaign>true</HasCampaign>
    <HeaderGuid>8c5d2d1a-0385-4d38-90c3-7dd86afac6d0</HeaderGuid>
    <HeaderIdentifier>Gi1djIUDOE2Qw33YavrG0A==</HeaderIdentifier>
    <IncludeZeroQtyOnly>true</IncludeZeroQtyOnly>
    <ItemNumber>sample string 8</ItemNumber>
    <Keyword>sample string 5</Keyword>
    <LabelPageLayoutG_UID>pMqoEHrrYEeZ2JXkuWU55A==</LabelPageLayoutG_UID>
    <LabelPageLayoutGuid>10a8caa4-eb7a-4760-99d8-95e4b96539e4</LabelPageLayoutGuid>
    <LesserDepartmentCodes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </LesserDepartmentCodes>
    <Liquor>true</Liquor>
    <MinorDepartmentCode>sample string 12</MinorDepartmentCode>
    <MinorDepartmentCodes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </MinorDepartmentCodes>
    <Name>sample string 7</Name>
    <PLU>1</PLU>
    <PrintBatchTypes xmlns:d3p1="http://gapsolutions.com.au/schema/ezimanager">
      <d3p1:PrintBatchType>PDE</d3p1:PrintBatchType>
      <d3p1:PrintBatchType>PDE</d3p1:PrintBatchType>
    </PrintBatchTypes>
    <PrintDate>2026-06-03T18:32:13.3500859+00:00</PrintDate>
    <PrintRequestType>1</PrintRequestType>
    <Printed>true</Printed>
    <Relations>true</Relations>
    <Search>Default</Search>
    <ShelfLocationGuids xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>16dc7593-8751-4a6f-a534-73c365d01362</d3p1:guid>
      <d3p1:guid>c5f190af-3a63-4dfc-9d8f-2b96cadb26ad</d3p1:guid>
    </ShelfLocationGuids>
    <SlowMoving>true</SlowMoving>
    <Sort>Asc</Sort>
    <SortKind>Location</SortKind>
    <StartsWith>true</StartsWith>
    <StoreID>1</StoreID>
    <Stores xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </Stores>
    <SubDepartmentCode>sample string 11</SubDepartmentCode>
    <SubDepartmentCodes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </SubDepartmentCodes>
    <SupplierGuid>d72f23c0-21df-44b7-9c02-f973f28977c9</SupplierGuid>
    <SupplierIdentifier>wCMv198ht0ScAvlz8ol3yQ==</SupplierIdentifier>
    <Tobacco>true</Tobacco>
    <UTCOffset>3.1</UTCOffset>
    <UseExactPrintDateTime>true</UseExactPrintDateTime>
    <Users xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Users>
    <Variety>true</Variety>
    <Warehouse>true</Warehouse>
    <WarehouseDirectIndicators xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </WarehouseDirectIndicators>
  </Query>
  <StoreID>1</StoreID>
</PrintJobRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample: 
"sample string 1"

application/xml, text/xml

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

text/csv

Sample:

Sample not available.

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Sample: 
PK��\(P�5xl/workbook.xml �(�����0��&�C�p�R8q���{�E�O�||�	$޼���~;|4�ӓ���]A�l����'cQO��8%�$�L��+S��I]�� �4�w�z���ay�P4�CjXQJHM��>7{H�"'c�;������/E�PX�JA��ܚ�Ɣ�\N���d,�R��4f��ҝ��8l��/PK��\����	�[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
��\X�
''_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="Rb6089f106f8b41fd" /></Relationships>PK��\(��$�xl/worksheets/sheet1.xml �(��QMo� �+��
���*IU���۴�vf�P��4��3d�&�`���=��x�=��]ɗ��㺒��}��cUL�ADFp��:�� D�5X8��Z�ުH�������h�E��r+<�*�T�f|f�W<�&[��Le�q�*C��=�Ж���LTEF��¯��1>�)ynJ.3V�_��g
�j��+NO`:iC��Sc�ͬI{�̪{~'�DM�z��ȵ\����n�Y=�����<+�4Y󬢪
��L�)J����{�d!n������������g����>PK��\�8��Pxl/_rels/workbook.xml.rels �(���KN�0@�b͞؉���ݰ���3��&vd����G�
XE�Tb�������4����ڼM#9���-��V�n�}��jجW;eL�s iņL���A�d�܌6u��)�=��:�i��#�K�2��2��N�A�S�	m�L_�?����1��S
��,Q�l�ve���B�u.�@���B��~����;(�\����]e��ؽD�.�tZ�j5�%V�)���Fo�b�PK��\Ѓ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��PK��\1uf��xl/sharedStrings.xml �(�5�A
�0E�2�ަ��$]�@ڱ
4�����޸p�y|޳�;��*1��}�#�y�<;�߮��h�)����a�VD�]Y.��l��� ].č<rMA۬��R)L�iZ͡�&��c�X�a������M�U/!��ZAmA��F�5?dZ��PK-��\(P�5xl/workbook.xmlPK-��\����	�[Content_Types].xmlPK-
��\X�
''V_rels/.relsPK-��\(��$��xl/worksheets/sheet1.xmlPK-��\�8��P8xl/_rels/workbook.xml.relsPK-��\Ѓc'2E
xl/styles.xmlPK-��\1uf���xl/sharedStrings.xmlPK��

application/vnd.ms-excel

Sample: 
PK��\u~�~�5xl/workbook.xml �(�����0D�&�C��`�")��x��}m��@[����[ �x�3;�v��|�t�#��P���1%cA�h ܀6��b��ŜRZ`��۠��eg汇��
�]h����dh���mi��§f�c�e2ֺ�I�b�)>ö�Y+�@Jf�&+�S�K��{R\�\)u�N2�tco0����PK��\����	�[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
��\(���''_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="Ra7d6eab2cd164af4" /></Relationships>PK��\(��$�xl/worksheets/sheet1.xml �(��QMo� �+��
���*IU���۴�vf�P��4��3d�&�`���=��x�=��]ɗ��㺒��}��cUL�ADFp��:�� D�5X8��Z�ުH�������h�E��r+<�*�T�f|f�W<�&[��Le�q�*C��=�Ж���LTEF��¯��1>�)ynJ.3V�_��g
�j��+NO`:iC��Sc�ͬI{�̪{~'�DM�z��ȵ\����n�Y=�����<+�4Y󬢪
��L�)J����{�d!n������������g����>PK��\:`l�Pxl/_rels/workbook.xml.rels �(���KN�0@�b͞�&����ݰa[z��Q;�]�gc���V� �X��j4��'�|�lvo�H^0�!�xŀ�������]��f���e"�aN���ԁ�y^S���I�*��Kdž8�\���Y���3��qɀk&9�g�1X;h|�4����k���3���=�~J�^�
ȓ�`�*�e˭��5� �fj)�GL�^��BFpijD[����o*�TD�c���iY^�)�R�u�l#W��F��b�PK��\Ѓ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��PK��\1uf��xl/sharedStrings.xml �(�5�A
�0E�2�ަ��$]�@ڱ
4�����޸p�y|޳�;��*1��}�#�y�<;�߮��h�)����a�VD�]Y.��l��� ].č<rMA۬��R)L�iZ͡�&��c�X�a������M�U/!��ZAmA��F�5?dZ��PK-��\u~�~�5xl/workbook.xmlPK-��\����	��[Content_Types].xmlPK-
��\(���''U_rels/.relsPK-��\(��$��xl/worksheets/sheet1.xmlPK-��\:`l�P7xl/_rels/workbook.xml.relsPK-��\Ѓc'2E
|xl/styles.xmlPK-��\1uf���xl/sharedStrings.xmlPK��