UCO API (ver. 2.16)

GET api/v1/Despatch/DES_CR_GET_DespatchedToCustomer?CustomerId={CustomerId}&StartDate={StartDate}&EndDate={EndDate}

Obtain a list of despatch records for a customer and time period

Request Information

URI Parameters

Name	Description	Type	Additional information
CustomerId	The Customer Id for which despatch records will be retrieved	globally unique identifier	Required
StartDate	The start date and time (in local time)	date	Required
EndDate	The end date and time (in local time)	date	Required

Body Parameters

None.

Response Information

Resource Description

Collection of DespatchRecord

Name	Description	Type	Additional information
DateDespatched		date	None.
NumContainers		integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "DateDespatched": "2026-08-16T17:20:38.9535138+00:00",
    "NumContainers": 1
  },
  {
    "DateDespatched": "2026-08-16T17:20:38.9535138+00:00",
    "NumContainers": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfDespatchRecord xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/nfuels_sharedmodels.Models.Collection">
  <DespatchRecord>
    <DateDespatched>2026-08-16T17:20:38.9535138+00:00</DateDespatched>
    <NumContainers>1</NumContainers>
  </DespatchRecord>
  <DespatchRecord>
    <DateDespatched>2026-08-16T17:20:38.9535138+00:00</DateDespatched>
    <NumContainers>1</NumContainers>
  </DespatchRecord>
</ArrayOfDespatchRecord>