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
Name | Description | Type | Additional information |
---|---|---|---|
id | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
PdeOrderHeaderName | Description | Type | Additional 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": "b9hDqzsmIUuivdLj1h5Jqg==", "orderIdentifier": "ab43d86f-263b-4b21-a2bd-d2e3d61e49aa", "backToBack": 1, "b2bGuid": "NmNKDU//902wvuDyVECEbA==", "b2bIdentifier": "0d4a6336-ff4f-4df7-b0be-e0f25440846c", "status": 2, "created": "2025-10-05T00:04:02.6813257", "createdLocal": "2025-10-05T00:04:02.6813257", "createdByUser": "sample string 3", "storeID": 1, "transferGuid": "09pmJF9hEEWtX82OAL2MPw==", "transferIdentifier": "2466dad3-615f-4510-ad5f-cd8e00bd8c3f", "transferInvoiceIdentifier": "XTWKCk2F3UmOscZ5KGpWMQ==", "transferInvoiceGuid": "0a8a355d-854d-49dd-8eb1-c679286a5631", "transferType": 1, "supplierIdentifier": "5mYKcqUMXESlF2NJ8mc2fg==", "supplierIdentifierGuid": "720a66e6-0ca5-445c-a517-6349f267367e", "description": "sample string 4", "rows": 1, "cartons": 1, "units": 1, "sentCount": 1, "sent": "2025-10-05T00:04:02.6813257", "sentLocal": "2025-10-05T00:04:02.6813257", "sentByUser": "sample string 5", "lastSentStatus": 1, "received": "2025-10-05T00:04:02.6813257", "receivedLocal": "2025-10-05T00:04:02.6813257", "completed": "2025-10-05T00:04:02.6813257", "completedLocal": "2025-10-05T00:04:02.6813257", "updated": "2025-10-05T00:04:02.6813257", "updatedLocal": "2025-10-05T00:04:02.6813257", "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": "EMu9WNvzDESFx0qXVeHXYg==", "orderIdentifier": "58bdcb10-f3db-440c-85c7-4a9755e1d762", "pluG_UID": "ewuf+xlKUEafX2nZo5NTCg==", "pluGuid": "fb9f0b7b-4a19-4650-9f5f-69d9a393530a", "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>NmNKDU//902wvuDyVECEbA==</B2bGuid> <B2bIdentifier>0d4a6336-ff4f-4df7-b0be-e0f25440846c</B2bIdentifier> <BackToBack>1</BackToBack> <Cartons>1</Cartons> <Completed>2025-10-05T00:04:02.6813257+00:00</Completed> <CompletedLocal>2025-10-05T00:04:02.6813257+00:00</CompletedLocal> <Created>2025-10-05T00:04:02.6813257+00:00</Created> <CreatedByUser>sample string 3</CreatedByUser> <CreatedLocal>2025-10-05T00:04:02.6813257+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>b9hDqzsmIUuivdLj1h5Jqg==</OrderGuid> <OrderID>1</OrderID> <OrderIdentifier>ab43d86f-263b-4b21-a2bd-d2e3d61e49aa</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>EMu9WNvzDESFx0qXVeHXYg==</OrderGuid> <OrderIdentifier>58bdcb10-f3db-440c-85c7-4a9755e1d762</OrderIdentifier> <PLUG_UID>ewuf+xlKUEafX2nZo5NTCg==</PLUG_UID> <PluGuid>fb9f0b7b-4a19-4650-9f5f-69d9a393530a</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>EMu9WNvzDESFx0qXVeHXYg==</OrderGuid> <OrderIdentifier>58bdcb10-f3db-440c-85c7-4a9755e1d762</OrderIdentifier> <PLUG_UID>ewuf+xlKUEafX2nZo5NTCg==</PLUG_UID> <PluGuid>fb9f0b7b-4a19-4650-9f5f-69d9a393530a</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-10-05T00:04:02.6813257+00:00</Received> <ReceivedLocal>2025-10-05T00:04:02.6813257+00:00</ReceivedLocal> <Rows>1</Rows> <Sent>2025-10-05T00:04:02.6813257+00:00</Sent> <SentByUser>sample string 5</SentByUser> <SentCount>1</SentCount> <SentLocal>2025-10-05T00:04:02.6813257+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>5mYKcqUMXESlF2NJ8mc2fg==</SupplierIdentifier> <SupplierIdentifierGuid>720a66e6-0ca5-445c-a517-6349f267367e</SupplierIdentifierGuid> <SupplierName>sample string 18</SupplierName> <TradingPartner>1</TradingPartner> <TransferGuid>09pmJF9hEEWtX82OAL2MPw==</TransferGuid> <TransferIdentifier>2466dad3-615f-4510-ad5f-cd8e00bd8c3f</TransferIdentifier> <TransferInvoiceGuid>0a8a355d-854d-49dd-8eb1-c679286a5631</TransferInvoiceGuid> <TransferInvoiceIdentifier>XTWKCk2F3UmOscZ5KGpWMQ==</TransferInvoiceIdentifier> <TransferType>1</TransferType> <Units>1</Units> <Updated>2025-10-05T00:04:02.6813257+00:00</Updated> <UpdatedLocal>2025-10-05T00:04:02.6813257+00:00</UpdatedLocal> <WarehouseNote>sample string 6</WarehouseNote> <WarehouseRef>sample string 7</WarehouseRef> </PdeOrderHeader>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Sample:
PK � E[�]\� 5 xl/workbook.xml � (� ����0D�&�C��*J�N\�z4Ж�5��B $��ξ>Z���v�{�sW�6�!g̋5���L;i��0I�bVJ%����v>S氇���<]h�����"�/( ��r�#��͞ G�d�ug��%�~S<¶����� %ѹ7=Q�r5 ���SHD��.�4�{�q��.�PK � E[���� � [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 � E[�V�' ' _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="Re513ec29cc3f4626" /></Relationships>PK � E[�~M xl/worksheets/sheet1.xml � (� ��]S�<��J&��#�V_�1P ���ڻ��4���� ��W Q��wb��+��9R<��;��=eE9�g}��~/������A��������?�şr�eU/�g�^q�W���`Pގ��L�l����tX�_�߃��nr��䷏�lV @3(��a�*Ǔ�����5�ʇ"�S���'����h��g�+���~*��������${.�>��K�?���9��B;h�O�_�Qv7|��.��l�{\���6�/�����w��t�w��y2��}�H����������X�R�:X�I�h�" /����ղ^��K�����������z|�8��҂l���z�q�fYo����j���R�^o��vG�ݲ����y��;# |K�_����RD`D��� ��8g[��+�veNF�dW�d�N�qgta��;�ѹ�<Y�*�8�j�V�t��I�ξ���>,�m �=i�71�o��D��d�O��ɀ�@f��h32r(��"�2ʡv�e+H�D�;�E�^A���[�{�keDj�H�D�N*�2-"z��=�];D��tݵ���sp��`��- "z������s�ͣ'@�����P=%:�AEU��ԉF�@� ?\�"� ��au ���T��M�Ɍhk�T��cm�9$����H�;�"��l�e�*@/��m�H�A��8�ԖI庮""�j$A$�>