POST api/orders/consignmentNumber

Sets the consignment number of an order.

Request Information

URI Parameters

None.

Body Parameters

The model to set the consignment number with.

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": "98ab5bf6-6012-4d07-82fe-dd3132e57b54",
  "CreationDateUtc": "2026-01-21T09:48:14.6257024+00:00",
  "ConsignmentNumber": "sample string 3",
  "CampaignId": "1ea4654f-3646-4086-9c77-2f925011fb13",
  "Reference": "sample string 4",
  "OrderId": "3eb32462-ad1a-4426-8e51-644ff8f60da9"
}

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>1ea4654f-3646-4086-9c77-2f925011fb13</CampaignId>
  <ConsignmentNumber>sample string 3</ConsignmentNumber>
  <CreationDateUtc>2026-01-21T09:48:14.6257024+00:00</CreationDateUtc>
  <Id>98ab5bf6-6012-4d07-82fe-dd3132e57b54</Id>
  <OrderId>3eb32462-ad1a-4426-8e51-644ff8f60da9</OrderId>
  <Reference>sample string 4</Reference>
</PayOrderConsignmentDetailDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.