GET api/pde/order/id/{id}

Returns the order details as needed to summarise them for the PDE order receiving screen.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

None.

Response Information

Resource Description

PdeOrderHeader
NameDescriptionTypeAdditional information
OrderID

integer

None.

OrderGuid

Collection of byte

None.

OrderIdentifier

globally unique identifier

None.

BackToBack

integer

None.

B2bGuid

Collection of byte

None.

B2bIdentifier

globally unique identifier

None.

Status

OrderStatus

None.

Created

date

None.

CreatedLocal

date

None.

CreatedByUser

string

String length: inclusive between 0 and 255

StoreID

integer

None.

TransferGuid

Collection of byte

None.

TransferIdentifier

globally unique identifier

None.

TransferInvoiceIdentifier

Collection of byte

None.

TransferInvoiceGuid

globally unique identifier

None.

TransferType

TransferType

None.

SupplierIdentifier

Collection of byte

None.

SupplierIdentifierGuid

globally unique identifier

None.

Description

string

None.

Rows

integer

None.

Cartons

integer

None.

Units

integer

None.

SentCount

integer

None.

Sent

date

None.

SentLocal

date

None.

SentByUser

string

String length: inclusive between 0 and 255

LastSentStatus

integer

None.

Received

date

None.

ReceivedLocal

date

None.

Completed

date

None.

CompletedLocal

date

None.

Updated

date

None.

UpdatedLocal

date

None.

WarehouseNote

string

None.

WarehouseRef

string

None.

PdeSerialNumber

string

None.

TradingPartner

OrderTradingPartner

None.

OrderType

string

String length: inclusive between 0 and 20

OrderTypeDescription

string

String length: inclusive between 0 and 255

StateCode

string

String length: inclusive between 0 and 20

MailCarbonCopy

When Placing an order via email, send a Blind Carbon Copy to the current User

boolean

None.

MailTo

string

None.

MailBcc

string

None.

Liquor

boolean

None.

Summary

string

Data type: MultilineText

Notes

string

Data type: MultilineText

SupplierName

string

None.

StoreName

string

None.

OrderCode

OrderCode

None.

PdeDetails

Collection of PdeOrderDetail

None.

Response Formats

application/json, text/json

Sample:
{
  "orderID": 1,
  "orderGuid": "G1rXoeKE00W1pM8k2+TAvg==",
  "orderIdentifier": "a1d75a1b-84e2-45d3-b5a4-cf24dbe4c0be",
  "backToBack": 1,
  "b2bGuid": "kQCWwl5z3USiGyxGb+D6gQ==",
  "b2bIdentifier": "c2960091-735e-44dd-a21b-2c466fe0fa81",
  "status": 2,
  "created": "2025-06-14T07:12:49.0492348",
  "createdLocal": "2025-06-14T07:12:49.0492348",
  "createdByUser": "sample string 3",
  "storeID": 1,
  "transferGuid": "x91jr9FyFUmpLskoGxCNIQ==",
  "transferIdentifier": "af63ddc7-72d1-4915-a92e-c9281b108d21",
  "transferInvoiceIdentifier": "1i57yjGGPESr9fO0IjqdXg==",
  "transferInvoiceGuid": "ca7b2ed6-8631-443c-abf5-f3b4223a9d5e",
  "transferType": 1,
  "supplierIdentifier": "+fwQYhF9OkqLr0AgmPg2EQ==",
  "supplierIdentifierGuid": "6210fcf9-7d11-4a3a-8baf-402098f83611",
  "description": "sample string 4",
  "rows": 1,
  "cartons": 1,
  "units": 1,
  "sentCount": 1,
  "sent": "2025-06-14T07:12:49.0492348",
  "sentLocal": "2025-06-14T07:12:49.0492348",
  "sentByUser": "sample string 5",
  "lastSentStatus": 1,
  "received": "2025-06-14T07:12:49.0492348",
  "receivedLocal": "2025-06-14T07:12:49.0492348",
  "completed": "2025-06-14T07:12:49.0492348",
  "completedLocal": "2025-06-14T07:12:49.0492348",
  "updated": "2025-06-14T07:12:49.0492348",
  "updatedLocal": "2025-06-14T07:12:49.0492348",
  "warehouseNote": "sample string 6",
  "warehouseRef": "sample string 7",
  "pdeSerialNumber": "sample string 8",
  "tradingPartner": 1,
  "orderType": "sample string 1",
  "orderTypeDescription": "sample string 2",
  "stateCode": "sample string 11",
  "mailCarbonCopy": true,
  "mailTo": "sample string 13",
  "mailBcc": "sample string 14",
  "liquor": true,
  "summary": "sample string 16",
  "notes": "sample string 17",
  "supplierName": "sample string 18",
  "storeName": "sample string 19",
  "orderCode": {
    "$id": "2",
    "code": "sample string 1",
    "description": "sample string 2"
  },
  "pdeDetails": [
    {
      "$id": "3",
      "id": 1,
      "orderGuid": "r/fB9ShqVU2tKln6LTdnnA==",
      "orderIdentifier": "f5c1f7af-6a28-4d55-ad2a-59fa2d37679c",
      "pluG_UID": "jnABcxRk00eYYH9efO3DDw==",
      "pluGuid": "7301708e-6414-47d3-9860-7f5e7cedc30f",
      "apn": "sample string 1",
      "cartonCost": 1,
      "cartons": 1,
      "units": 1,
      "weight": 1,
      "receivedCartons": 1,
      "receivedUnits": 1,
      "description": "sample string 2",
      "unitCost": 1,
      "unitCostDecimals": 3,
      "currentUnitCost": 1,
      "currentUnitCostDecimals": 1,
      "cartonQuantity": 1
    },
    {
      "$ref": "3"
    }
  ]
}

application/xml, text/xml

Sample:
<PdeOrderHeader xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.EMC.Orders">
  <B2bGuid>kQCWwl5z3USiGyxGb+D6gQ==</B2bGuid>
  <B2bIdentifier>c2960091-735e-44dd-a21b-2c466fe0fa81</B2bIdentifier>
  <BackToBack>1</BackToBack>
  <Cartons>1</Cartons>
  <Completed>2025-06-14T07:12:49.0492348+00:00</Completed>
  <CompletedLocal>2025-06-14T07:12:49.0492348+00:00</CompletedLocal>
  <Created>2025-06-14T07:12:49.0492348+00:00</Created>
  <CreatedByUser>sample string 3</CreatedByUser>
  <CreatedLocal>2025-06-14T07:12:49.0492348+00:00</CreatedLocal>
  <Description>sample string 4</Description>
  <LastSentStatus>1</LastSentStatus>
  <Liquor>true</Liquor>
  <MailBcc>sample string 14</MailBcc>
  <MailCarbonCopy>true</MailCarbonCopy>
  <MailTo>sample string 13</MailTo>
  <Notes>sample string 17</Notes>
  <OrderCode xmlns:d2p1="http://schemas.datacontract.org/2004/07/EziManager.Models.Integrations.Ordering">
    <d2p1:Code>sample string 1</d2p1:Code>
    <d2p1:Description>sample string 2</d2p1:Description>
  </OrderCode>
  <OrderGuid>G1rXoeKE00W1pM8k2+TAvg==</OrderGuid>
  <OrderID>1</OrderID>
  <OrderIdentifier>a1d75a1b-84e2-45d3-b5a4-cf24dbe4c0be</OrderIdentifier>
  <OrderType>sample string 1</OrderType>
  <OrderTypeDescription>sample string 2</OrderTypeDescription>
  <PdeDetails>
    <PdeOrderDetail>
      <APN>sample string 1</APN>
      <CartonCost>1</CartonCost>
      <CartonQuantity>1</CartonQuantity>
      <Cartons>1</Cartons>
      <CurrentUnitCost>1</CurrentUnitCost>
      <CurrentUnitCostDecimals>1</CurrentUnitCostDecimals>
      <Description>sample string 2</Description>
      <ID>1</ID>
      <OrderGuid>r/fB9ShqVU2tKln6LTdnnA==</OrderGuid>
      <OrderIdentifier>f5c1f7af-6a28-4d55-ad2a-59fa2d37679c</OrderIdentifier>
      <PLUG_UID>jnABcxRk00eYYH9efO3DDw==</PLUG_UID>
      <PluGuid>7301708e-6414-47d3-9860-7f5e7cedc30f</PluGuid>
      <ReceivedCartons>1</ReceivedCartons>
      <ReceivedUnits>1</ReceivedUnits>
      <UnitCost>1</UnitCost>
      <UnitCostDecimals>3</UnitCostDecimals>
      <Units>1</Units>
      <Weight>1</Weight>
    </PdeOrderDetail>
    <PdeOrderDetail>
      <APN>sample string 1</APN>
      <CartonCost>1</CartonCost>
      <CartonQuantity>1</CartonQuantity>
      <Cartons>1</Cartons>
      <CurrentUnitCost>1</CurrentUnitCost>
      <CurrentUnitCostDecimals>1</CurrentUnitCostDecimals>
      <Description>sample string 2</Description>
      <ID>1</ID>
      <OrderGuid>r/fB9ShqVU2tKln6LTdnnA==</OrderGuid>
      <OrderIdentifier>f5c1f7af-6a28-4d55-ad2a-59fa2d37679c</OrderIdentifier>
      <PLUG_UID>jnABcxRk00eYYH9efO3DDw==</PLUG_UID>
      <PluGuid>7301708e-6414-47d3-9860-7f5e7cedc30f</PluGuid>
      <ReceivedCartons>1</ReceivedCartons>
      <ReceivedUnits>1</ReceivedUnits>
      <UnitCost>1</UnitCost>
      <UnitCostDecimals>3</UnitCostDecimals>
      <Units>1</Units>
      <Weight>1</Weight>
    </PdeOrderDetail>
  </PdeDetails>
  <PdeSerialNumber>sample string 8</PdeSerialNumber>
  <Received>2025-06-14T07:12:49.0492348+00:00</Received>
  <ReceivedLocal>2025-06-14T07:12:49.0492348+00:00</ReceivedLocal>
  <Rows>1</Rows>
  <Sent>2025-06-14T07:12:49.0492348+00:00</Sent>
  <SentByUser>sample string 5</SentByUser>
  <SentCount>1</SentCount>
  <SentLocal>2025-06-14T07:12:49.0492348+00:00</SentLocal>
  <StateCode>sample string 11</StateCode>
  <Status>2</Status>
  <StoreID>1</StoreID>
  <StoreName>sample string 19</StoreName>
  <Summary>sample string 16</Summary>
  <SupplierIdentifier>+fwQYhF9OkqLr0AgmPg2EQ==</SupplierIdentifier>
  <SupplierIdentifierGuid>6210fcf9-7d11-4a3a-8baf-402098f83611</SupplierIdentifierGuid>
  <SupplierName>sample string 18</SupplierName>
  <TradingPartner>1</TradingPartner>
  <TransferGuid>x91jr9FyFUmpLskoGxCNIQ==</TransferGuid>
  <TransferIdentifier>af63ddc7-72d1-4915-a92e-c9281b108d21</TransferIdentifier>
  <TransferInvoiceGuid>ca7b2ed6-8631-443c-abf5-f3b4223a9d5e</TransferInvoiceGuid>
  <TransferInvoiceIdentifier>1i57yjGGPESr9fO0IjqdXg==</TransferInvoiceIdentifier>
  <TransferType>1</TransferType>
  <Units>1</Units>
  <Updated>2025-06-14T07:12:49.0492348+00:00</Updated>
  <UpdatedLocal>2025-06-14T07:12:49.0492348+00:00</UpdatedLocal>
  <WarehouseNote>sample string 6</WarehouseNote>
  <WarehouseRef>sample string 7</WarehouseRef>
</PdeOrderHeader>

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Sample:
PK�9�Zt�찵5xl/workbook.xml �(�����0��&�C����N\�z𾔭m�?ik��-%�x�3;��4�������ɄڷT��j���!��C�v�z
1I�dVű����DVE�<N�5A*�J���G�D�zZQ����@H�4{(�C����.&ak�����/�"4����d�6��L��U�.�ǒp����a
�~w_PK�9�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
�9�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="R5a9c5969f0444270" /></Relationships>PK�9�Z-��O	xl/worksheets/sheet1.xml �(��Y[s�<�+V�['I�i����K����4�q���
�0^���/`�+��]ir����n�'+��|q8����M>�-~��������c^�^N���b��8N����h���f��2��Exw��q~�F����&;�o�٢�fTdw�2����çl�ɵ�/��d=���S��x�Lf!�j��"�=��Ez
����`���e�˝��j)����Տ��áXcG
��z��b0�n�w����,�����%��������|��n8�����g�rz8�Da �o�e>�z����Oq���m�T�6� ���z��6�j�\�Jkh���q���2q<:��	��z�{��l�M5�X'
���I���vo���m�\5oH�G�������x�3^�(Qe��j�B�7����Vr�jNF�ɾ��Qv��;%�q�ղs�Qx�R�D�S�=ZՑ!JO�]�8!�#�g�tdԞ4���oxNٮQ}���4���L�a]DFJ����U���ʨC�{��A�[��a�z�odT“"1%:����td���i]���7CT����v7�J��j��ʎQxзB���*�B��C����PQzJ���T��N4jM�r]s�RT�w��j�4�Ae�]�+AT���E�P��
UH��h�**R�zRQ���*��
Ћp��]���T5E�B���s��vd��T��*�$U%I���I(������Q�(z�FI��e2I�Jt�!J���$Q�Ͱ=��Q�;jM�Q�h�f�ZD�7C�"VZD����@N� 玣uԢ��h1d�
�6R���'�����"s2.�GE�8(֯C��S���O��,�E�ϑ8�Y�n�M��#^5PG�4��x�D`q�D�:�Maꈳ&��o�WG�k"|�a�����V?2B�'Bx��@���0���j�2��7B���@�������{�@�������v2�nʘ�)cC ���	�)cE ���8e��)cHEHNK*�rʘR�SƖ���SQ�g*�3cMEyf��(ό9��̸)ό=����)όA���8)όE���x)όI��̸+�G��m�T]6AL7;�FBM6�!YNZFx�=�)!;�fw��l�j�(!��&��I�{>�3)"��-��н���Sw���H�e�_�G��@���1���-��hyw����������?��R���-=~�X�=�'{`_�=��f�C$�o�C;cSC9o�i���v�8��v�X��v�x��vr�`h;aLkh;a\���mc��3�QM��u�`�^\1���ڋ�8ڹN��$+N�̊�5q���PK�9�Z�7���Pxl/_rels/workbook.xml.rels �(���KN�0@�b͞8iBB��ݰa��{GM��v��������ĂMW��==i���޾�{%zgY��t����S�O�ݬw4`L��S`i�&�i�y��F��Ȧ�v~ĘR��	�;�<���3����CtZ����<�d�`���1�쀾�(��5Y�{Qv�lK]+��9V�%0~7���_��|&S*l�,�B�˪}l�*cГ�G�.=w��gjKR5�Z6UQV�j�j��/6_PK�9�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��PK�9�Z�����	xl/sharedStrings.xml �(���mo�8ǿJ�{0��)I���U��[�����졵l�6��~�3�V�M�M�̏y��LVg?�v���%�Q'�%S\ȧu������X�Z%q��D����;s�Ҭ�gk�?�sÞ���#��X�S?�M��yF�];�IR�;2�15H���y4��w�������|����jn7��h���e<�8J+�z�ρ��S�Gh��̟G{�`3�n�i-z���׊A�	;�?�P��o�N�4M�����?��/J0���e��{����*��@ô���ݫ����Jz�G)�g|py���-8���w
Ǝ4��{d(^|����zQ]�bHd� ����2��A��@��*�
��c3ewPho���j�d�ܜ�O[��8�����&��
��	�Vr��}��T�zΘ7Sw[�����yl���7��B�/͸�!p8~�h��h]�~������{����BH�riM�)�<#�r���s��^*F�"I��,��<�u!(ˋ����2��e��$��|�ye4E�9[�%�)ɫtA��HXE˴N��S/$�eM��,2�g�@�,H��9�T|�^�4iXS�%O�d@��'4�ʦ̊�D��q�8���xy�����	o�}���o�~�[�~�'���H5�?�
HxB߸-jM|%->i���yƟ���6mU�"{u���,��~O��).o��M�����uWYǹ�C��PK-�9�Zt�찵5xl/workbook.xmlPK-�9�Z����	��[Content_Types].xmlPK-
�9�Z�,�''T_rels/.relsPK-�9�Z-��O	�xl/worksheets/sheet1.xmlPK-�9�Z�7���Pa	xl/_rels/workbook.xml.relsPK-�9�ZЃc'2E
�
xl/styles.xmlPK-�9�Z�����	 xl/sharedStrings.xmlPK�E

application/vnd.ms-excel

Sample:
PK�9�Zٟ�ж5xl/workbook.xml �(�����0D�J��(�P����ҵCwN� 	JR��o�ԭ��|~>>;4��F�
[����`̵=*p3�;a��}1#�l�6�[��,���Y�K�]/'G7�?,7Y����^�J�Դ:��K���٭2{��$l��_a�Ū��%��%�s�Jz��2�$��-�1OҼ���q����PK�9�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
�9�Z�]5''_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="R75487302757e42fa" /></Relationships>PK�9�Z-��O	xl/worksheets/sheet1.xml �(��Y[s�<�+V�['I�i����K����4�q���
�0^���/`�+��]ir����n�'+��|q8����M>�-~��������c^�^N���b��8N����h���f��2��Exw��q~�F����&;�o�٢�fTdw�2����çl�ɵ�/��d=���S��x�Lf!�j��"�=��Ez
����`���e�˝��j)����Տ��áXcG
��z��b0�n�w����,�����%��������|��n8�����g�rz8�Da �o�e>�z����Oq���m�T�6� ���z��6�j�\�Jkh���q���2q<:��	��z�{��l�M5�X'
���I���vo���m�\5oH�G�������x�3^�(Qe��j�B�7����Vr�jNF�ɾ��Qv��;%�q�ղs�Qx�R�D�S�=ZՑ!JO�]�8!�#�g�tdԞ4���oxNٮQ}���4���L�a]DFJ����U���ʨC�{��A�[��a�z�odT“"1%:����td���i]���7CT����v7�J��j��ʎQxзB���*�B��C����PQzJ���T��N4jM�r]s�RT�w��j�4�Ae�]�+AT���E�P��
UH��h�**R�zRQ���*��
Ћp��]���T5E�B���s��vd��T��*�$U%I���I(������Q�(z�FI��e2I�Jt�!J���$Q�Ͱ=��Q�;jM�Q�h�f�ZD�7C�"VZD����@N� 玣uԢ��h1d�
�6R���'�����"s2.�GE�8(֯C��S���O��,�E�ϑ8�Y�n�M��#^5PG�4��x�D`q�D�:�Maꈳ&��o�WG�k"|�a�����V?2B�'Bx��@���0���j�2��7B���@�������{�@�������v2�nʘ�)cC ���	�)cE ���8e��)cHEHNK*�rʘR�SƖ���SQ�g*�3cMEyf��(ό9��̸)ό=����)όA���8)όE���x)όI��̸+�G��m�T]6AL7;�FBM6�!YNZFx�=�)!;�fw��l�j�(!��&��I�{>�3)"��-��н���Sw���H�e�_�G��@���1���-��hyw����������?��R���-=~�X�=�'{`_�=��f�C$�o�C;cSC9o�i���v�8��v�X��v�x��vr�`h;aLkh;a\���mc��3�QM��u�`�^\1���ڋ�8ڹN��$+N�̊�5q���PK�9�Z~���Pxl/_rels/workbook.xml.rels �(���Kn�0@�b;��"��-�N2�#;�M)g�G�jQ�
Rݰ���I3�����4�Wt~���0 hZ�
���ԓ��vs�Q�8��0{W��A�0�)���I���hbGY7�S��Y�'�#M+�[2�I���C�J
->��<�	��ź�׈�Q�C
?%Oo�'�
d��p�K%Y�T�@��B���uD����/d�jU����Uޥ�P-v/��K/��党b
O��rdY^H~S�w��PK�9�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��PK�9�Z�����	xl/sharedStrings.xml �(���mo�8ǿJ�{0��)I���U��[�����졵l�6��~�3�V�M�M�̏y��LVg?�v���%�Q'�%S\ȧu������X�Z%q��D����;s�Ҭ�gk�?�sÞ���#��X�S?�M��yF�];�IR�;2�15H���y4��w�������|����jn7��h���e<�8J+�z�ρ��S�Gh��̟G{�`3�n�i-z���׊A�	;�?�P��o�N�4M�����?��/J0���e��{����*��@ô���ݫ����Jz�G)�g|py���-8���w
Ǝ4��{d(^|����zQ]�bHd� ����2��A��@��*�
��c3ewPho���j�d�ܜ�O[��8�����&��
��	�Vr��}��T�zΘ7Sw[�����yl���7��B�/͸�!p8~�h��h]�~������{����BH�riM�)�<#�r���s��^*F�"I��,��<�u!(ˋ����2��e��$��|�ye4E�9[�%�)ɫtA��HXE˴N��S/$�eM��,2�g�@�,H��9�T|�^�4iXS�%O�d@��'4�ʦ̊�D��q�8���xy�����	o�}���o�~�[�~�'���H5�?�
HxB߸-jM|%->i���yƟ���6mU�"{u���,��~O��).o��M�����uWYǹ�C��PK-�9�Zٟ�ж5xl/workbook.xmlPK-�9�Z����	��[Content_Types].xmlPK-
�9�Z�]5''U_rels/.relsPK-�9�Z-��O	�xl/worksheets/sheet1.xmlPK-�9�Z~���Pb	xl/_rels/workbook.xml.relsPK-�9�ZЃc'2E
�
xl/styles.xmlPK-�9�Z�����	"xl/sharedStrings.xmlPK�G