Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Introduction

The purpose of this service is to provide new and held orders.
See Service for information about request limit

Parameters

ParameterDetailsRequired
CustomerCodeThe Customer Code of the accountMandatory
SiteCodeThe Site Code of the accountMandatory

Example

https://<pathtoapi>/service/NewAndHeldOrders/CustomerCode/XYZ/SiteCode/AB

Response


Code Block
languagexml
titleSample
<NewAndHeldOrders>
  <HD>
    <CustC>TEST</CustC>
    <CustN>Test comp LTD</CustN>
    <OrdRef>7</OrdRef>
    <DocRef>PRED8116</DocRef>
    <DName>GDPR ERASED</DName>
    <DPost>SW20 0QU</DPost>
    <OrdDt>2012-04-26T00:00:00</OrdDt>
    <Cases>11</Cases>
    <Singles>0</Singles>
    <DefCust>TEST</DefCust>
  </HD>
  <HD>
    <CustC>TEST</CustC>
    <CustN>Test comp LTD</CustN>
    <OrdRef>53</OrdRef>
    <DocRef>53</DocRef>
    <DName>Corsham (A1)</DName>
    <DPost>SN13 9PP</DPost>
    <OrdDt>2012-05-07T05:50:44.443</OrdDt>
    <Cases>1</Cases>
    <Singles>0</Singles>
    <DefCust>TEST</DefCust>
  </HD>
</NewAndHeldOrders>

...

SegmentSegment
L1

Segment
L2

Field Description
NewAndHeldOrders



HD
Herder element 


CustCCustomer code


CustNCustomer name


OrdRefOrder reference


DocRefDocument reference 


DNameDelivery name


DPostDelivery postcode


OrdDtOrder date


CasesCases


SinglesSingles


DefCustDeferment customer

HD

NewAndHeldOrders


Response Codes

Common response codes

CodeMessage
200Order found and response prepared successfully.
204No order found for the parameters provided.

...