POST api/couriers/booking/bookingResponse

Request Information

URI Parameters

None.

Body Parameters

BookingResponse
NameDescriptionTypeAdditional information
ID

integer

None.

Reference

string

None.

AltReference

string

None.

BookingDate

date

None.

DespatchReference

string

Max length: 15

ConsignmentNumber

string

Max length: 15

CostCentre

string

None.

DeliveryDeadlineDate

date

None.

IsSuccess

boolean

None.

ErrorCode

integer

None.

ErrorMessage

string

None.

BoxOrderID

integer

None.

FishboxOrderID

integer

None.

OrderDate

date

None.

CustomerOrderID

integer

None.

CourierID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "ID": 1,
  "Reference": "sample string 2",
  "AltReference": "sample string 3",
  "BookingDate": "2025-05-11T13:35:15.0052948+00:00",
  "DespatchReference": "sample string 4",
  "ConsignmentNumber": "sample string 5",
  "CostCentre": "sample string 6",
  "DeliveryDeadlineDate": "2025-05-11T13:35:15.0052948+00:00",
  "IsSuccess": true,
  "ErrorCode": 8,
  "ErrorMessage": "sample string 9",
  "BoxOrderID": 1,
  "FishboxOrderID": 1,
  "OrderDate": "2025-05-11T13:35:15.0052948+00:00",
  "CustomerOrderID": 1,
  "CourierID": 1
}

application/xml, text/xml

Sample:
<BookingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/cag.Data.Couriers">
  <AltReference>sample string 3</AltReference>
  <BookingDate>2025-05-11T13:35:15.0052948+00:00</BookingDate>
  <BoxOrderID>1</BoxOrderID>
  <ConsignmentNumber>sample string 5</ConsignmentNumber>
  <CostCentre>sample string 6</CostCentre>
  <CourierID>1</CourierID>
  <CustomerOrderID>1</CustomerOrderID>
  <DeliveryDeadlineDate>2025-05-11T13:35:15.0052948+00:00</DeliveryDeadlineDate>
  <DespatchReference>sample string 4</DespatchReference>
  <ErrorCode>8</ErrorCode>
  <ErrorMessage>sample string 9</ErrorMessage>
  <FishboxOrderID>1</FishboxOrderID>
  <ID>1</ID>
  <IsSuccess>true</IsSuccess>
  <OrderDate>2025-05-11T13:35:15.0052948+00:00</OrderDate>
  <Reference>sample string 2</Reference>
</BookingResponse>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.