POST api/v1/orders/consignmentNumber

Post the consignment number for a pay order.

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	globally unique identifier	None.
CreationDateUtc	date	None.
ConsignmentNumber	string	Required String length: inclusive between 0 and 512
CampaignId	globally unique identifier	None.
Reference	string	String length: inclusive between 0 and 2048
OrderId	globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": "53b04ec0-49a4-4786-9113-b2f1895ce3c6",
  "CreationDateUtc": "2025-12-11T11:11:23.3425937+00:00",
  "ConsignmentNumber": "sample string 3",
  "CampaignId": "7e339fc1-7ee0-417d-8de2-2a215d37e8e5",
  "Reference": "sample string 4",
  "OrderId": "49fa9ff4-9d01-4903-ab61-a3e922de7224"
}

application/xml, text/xml

Sample:

<PayOrderConsignmentDetailDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Pay.Models">
  <CampaignId>7e339fc1-7ee0-417d-8de2-2a215d37e8e5</CampaignId>
  <ConsignmentNumber>sample string 3</ConsignmentNumber>
  <CreationDateUtc>2025-12-11T11:11:23.3425937+00:00</CreationDateUtc>
  <Id>53b04ec0-49a4-4786-9113-b2f1895ce3c6</Id>
  <OrderId>49fa9ff4-9d01-4903-ab61-a3e922de7224</OrderId>
  <Reference>sample string 4</Reference>
</PayOrderConsignmentDetailDto>

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.