PUT api/orders/{id}
Updates an order.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The id of the order to update. |
globally unique identifier |
Required |
Body Parameters
The order model to update with.
PayOrderDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| PublicId | string |
String length: inclusive between 0 and 10 |
|
| Name | string |
String length: inclusive between 0 and 255 |
|
| CreationDateUtc | date |
None. |
|
| ModifiedDateUtc | date |
None. |
|
| PaymentDateUtc | date |
None. |
|
| VatRate | decimal number |
None. |
|
| PricePaid | decimal number |
None. |
|
| UserId | globally unique identifier |
Required |
|
| TenantId | globally unique identifier |
Required |
|
| StatusChanges | Collection of StatusChangeDto |
None. |
|
| Status | string |
None. |
|
| IsTemporary | boolean |
None. |
|
| DeliveryAddressId | globally unique identifier |
None. |
|
| ExternalProductionId | string |
String length: inclusive between 0 and 100 |
|
| Campaigns | Collection of PayCampaignDto |
None. |
|
| PaymentProvider | string |
None. |
|
| PaymentStatus | string |
None. |
|
| PaymentIs3d | boolean |
None. |
|
| ConsignmentDetails | Collection of PayOrderConsignmentDetailDto |
None. |
|
| CurrencyCode | string |
Required String length: inclusive between 0 and 3 |
Request Formats
application/json, text/json
Sample:
{
"Id": "88ba7b62-239e-4766-b38f-f762b435fc1a",
"PublicId": "sample string 2",
"Name": "sample string 3",
"CreationDateUtc": "2026-03-16T13:54:23.8906379+00:00",
"ModifiedDateUtc": "2026-03-16T13:54:23.8906379+00:00",
"PaymentDateUtc": "2026-03-16T13:54:23.8906379+00:00",
"VatRate": 5.0,
"PricePaid": 6.0,
"UserId": "8d648468-0a57-4a3c-a86d-9d6c7228881d",
"TenantId": "b022e950-a767-4c7d-806a-873ef9bcc2c5",
"StatusChanges": [
{
"Id": 1,
"Status": "sample string 2",
"ChangeDateUtc": "2026-03-16T13:54:23.8906379+00:00",
"Description": "sample string 4",
"UserId": "91c977f9-b481-4f64-9f26-7f0c254986ca"
},
{
"Id": 1,
"Status": "sample string 2",
"ChangeDateUtc": "2026-03-16T13:54:23.8906379+00:00",
"Description": "sample string 4",
"UserId": "91c977f9-b481-4f64-9f26-7f0c254986ca"
}
],
"Status": "sample string 2",
"IsTemporary": true,
"DeliveryAddressId": "ab8d20cc-1569-4b09-9126-436807da063d",
"ExternalProductionId": "sample string 10",
"Campaigns": [
{
"Name": "sample string 1",
"PublicId": "sample string 2",
"ModifiedDateUtc": "2026-03-16T13:54:23.8906379+00:00",
"UserJourney": "sample string 3",
"ServiceType": 0,
"Quantity": 4,
"ApprovalResponses": [
{
"Id": "906b4c88-cb9b-481c-a18c-eb5d447738cf",
"CreationDate": "2026-03-16T13:54:23.8906379+00:00",
"ApproverUserId": "574de022-3c52-4055-aca5-8699fbf2ab4d",
"Note": "sample string 4",
"Status": 0,
"CampaignId": "d866c47c-c42a-405e-a421-f141fd0ab92e"
},
{
"Id": "906b4c88-cb9b-481c-a18c-eb5d447738cf",
"CreationDate": "2026-03-16T13:54:23.8906379+00:00",
"ApproverUserId": "574de022-3c52-4055-aca5-8699fbf2ab4d",
"Note": "sample string 4",
"Status": 0,
"CampaignId": "d866c47c-c42a-405e-a421-f141fd0ab92e"
}
],
"SupplierId": "7727be95-3c41-4e16-aecd-1fbc456e6e9f",
"OrderId": "fcc47fb5-6285-4964-b55a-9d5c0646ebf1",
"CampaignProperties": [
{
"Id": "2b2e4294-60f7-4535-a2ea-bddd7b1de7b7",
"CampaignId": "0c2780ac-620b-4e13-960a-cdcb0956898a",
"Name": "sample string 3",
"Value": "sample string 4"
},
{
"Id": "2b2e4294-60f7-4535-a2ea-bddd7b1de7b7",
"CampaignId": "0c2780ac-620b-4e13-960a-cdcb0956898a",
"Name": "sample string 3",
"Value": "sample string 4"
}
],
"Voucher": {
"Id": 1,
"Description": "sample string 2",
"VoucherCode": "sample string 3",
"TenantId": "sample string 4",
"StartDate": "2026-03-16T13:54:23.8906379+00:00",
"ExpiryDate": "2026-03-16T13:54:23.8906379+00:00",
"Cancelled": true,
"IsPercentageDiscount": true,
"Entitlement": 7.0,
"MinSpend": 1.0,
"MaxSpend": 1.0,
"MaxDiscount": 1.0,
"ForAllUsers": true,
"Deleted": true,
"VoucherUsers": [
{
"UserId": "7d934397-4f35-4126-9975-e6082b52f30a",
"SingleUse": true,
"ApplyAutomatically": true
},
{
"UserId": "7d934397-4f35-4126-9975-e6082b52f30a",
"SingleUse": true,
"ApplyAutomatically": true
}
],
"MinimumQuantity": 1,
"VoucherProductType": "sample string 10",
"NewCustomerOnly": true,
"VoucherProperties": [
{
"Id": "ca804f1a-3d12-4f3a-821e-ef1f607905d1",
"CreationDateUtc": "2026-03-16T13:54:23.8906379+00:00",
"VoucherId": 3,
"Name": "sample string 4",
"Value": "sample string 5",
"Type": 0
},
{
"Id": "ca804f1a-3d12-4f3a-821e-ef1f607905d1",
"CreationDateUtc": "2026-03-16T13:54:23.8906379+00:00",
"VoucherId": 3,
"Name": "sample string 4",
"Value": "sample string 5",
"Type": 0
}
]
},
"OrderStatusChanges": [
{
"Id": 1,
"Status": "sample string 2",
"ChangeDateUtc": "2026-03-16T13:54:23.8906379+00:00",
"Description": "sample string 4",
"UserId": "91c977f9-b481-4f64-9f26-7f0c254986ca"
},
{
"Id": 1,
"Status": "sample string 2",
"ChangeDateUtc": "2026-03-16T13:54:23.8906379+00:00",
"Description": "sample string 4",
"UserId": "91c977f9-b481-4f64-9f26-7f0c254986ca"
}
],
"OrderStatus": "sample string 2",
"IsTemporary": true,
"RB_ArtWorkToken": "sample string 7",
"PR_Key": "sample string 8",
"PR_UDPRN": "sample string 9",
"Ext_TemplateId": 1,
"Ext_ArtworkId": 1,
"Ext_ResourceId": 1,
"FileLocation": "sample string 10",
"OrganisationId": "017849e4-300e-4ce5-a17e-4a4676734b82",
"OrganisationName": "sample string 11",
"TemplateName": "sample string 12",
"UserName": "sample string 13",
"Ext_MailerType": "sample string 14",
"Envelope": "sample string 15",
"Variant": "sample string 16",
"ApprovalGroupId": "7672b6e4-9a7a-4f00-9a1f-36c72f3c5745",
"DeliveryDate": "2026-03-16T13:54:23.8906379+00:00",
"PaperSize": "sample string 17",
"CentralMailerCampaignId": "be595588-9335-4c35-8c1c-a83459bf522b",
"OrderProductionCompletedDate": null,
"Id": "2e1cb84a-44b4-46f5-a6ee-08191ccbe97f",
"CreationDateUtc": "2026-03-16T13:54:23.8906379+00:00",
"UserId": "b92cb7fa-fa4f-47c3-9efd-0e79a0e1c33d",
"TenantId": "c2500e68-2d25-497e-a380-6f89c5da0020",
"SubtotalExVat": 22.0,
"SubtotalIncVat": 23.0,
"DiscountedTotalExVat": 24.0,
"DiscountedTotalIncVat": 25.0,
"VatRateApplied": 26.0
},
{
"Name": "sample string 1",
"PublicId": "sample string 2",
"ModifiedDateUtc": "2026-03-16T13:54:23.8906379+00:00",
"UserJourney": "sample string 3",
"ServiceType": 0,
"Quantity": 4,
"ApprovalResponses": [
{
"Id": "906b4c88-cb9b-481c-a18c-eb5d447738cf",
"CreationDate": "2026-03-16T13:54:23.8906379+00:00",
"ApproverUserId": "574de022-3c52-4055-aca5-8699fbf2ab4d",
"Note": "sample string 4",
"Status": 0,
"CampaignId": "d866c47c-c42a-405e-a421-f141fd0ab92e"
},
{
"Id": "906b4c88-cb9b-481c-a18c-eb5d447738cf",
"CreationDate": "2026-03-16T13:54:23.8906379+00:00",
"ApproverUserId": "574de022-3c52-4055-aca5-8699fbf2ab4d",
"Note": "sample string 4",
"Status": 0,
"CampaignId": "d866c47c-c42a-405e-a421-f141fd0ab92e"
}
],
"SupplierId": "7727be95-3c41-4e16-aecd-1fbc456e6e9f",
"OrderId": "fcc47fb5-6285-4964-b55a-9d5c0646ebf1",
"CampaignProperties": [
{
"Id": "2b2e4294-60f7-4535-a2ea-bddd7b1de7b7",
"CampaignId": "0c2780ac-620b-4e13-960a-cdcb0956898a",
"Name": "sample string 3",
"Value": "sample string 4"
},
{
"Id": "2b2e4294-60f7-4535-a2ea-bddd7b1de7b7",
"CampaignId": "0c2780ac-620b-4e13-960a-cdcb0956898a",
"Name": "sample string 3",
"Value": "sample string 4"
}
],
"Voucher": {
"Id": 1,
"Description": "sample string 2",
"VoucherCode": "sample string 3",
"TenantId": "sample string 4",
"StartDate": "2026-03-16T13:54:23.8906379+00:00",
"ExpiryDate": "2026-03-16T13:54:23.8906379+00:00",
"Cancelled": true,
"IsPercentageDiscount": true,
"Entitlement": 7.0,
"MinSpend": 1.0,
"MaxSpend": 1.0,
"MaxDiscount": 1.0,
"ForAllUsers": true,
"Deleted": true,
"VoucherUsers": [
{
"UserId": "7d934397-4f35-4126-9975-e6082b52f30a",
"SingleUse": true,
"ApplyAutomatically": true
},
{
"UserId": "7d934397-4f35-4126-9975-e6082b52f30a",
"SingleUse": true,
"ApplyAutomatically": true
}
],
"MinimumQuantity": 1,
"VoucherProductType": "sample string 10",
"NewCustomerOnly": true,
"VoucherProperties": [
{
"Id": "ca804f1a-3d12-4f3a-821e-ef1f607905d1",
"CreationDateUtc": "2026-03-16T13:54:23.8906379+00:00",
"VoucherId": 3,
"Name": "sample string 4",
"Value": "sample string 5",
"Type": 0
},
{
"Id": "ca804f1a-3d12-4f3a-821e-ef1f607905d1",
"CreationDateUtc": "2026-03-16T13:54:23.8906379+00:00",
"VoucherId": 3,
"Name": "sample string 4",
"Value": "sample string 5",
"Type": 0
}
]
},
"OrderStatusChanges": [
{
"Id": 1,
"Status": "sample string 2",
"ChangeDateUtc": "2026-03-16T13:54:23.8906379+00:00",
"Description": "sample string 4",
"UserId": "91c977f9-b481-4f64-9f26-7f0c254986ca"
},
{
"Id": 1,
"Status": "sample string 2",
"ChangeDateUtc": "2026-03-16T13:54:23.8906379+00:00",
"Description": "sample string 4",
"UserId": "91c977f9-b481-4f64-9f26-7f0c254986ca"
}
],
"OrderStatus": "sample string 2",
"IsTemporary": true,
"RB_ArtWorkToken": "sample string 7",
"PR_Key": "sample string 8",
"PR_UDPRN": "sample string 9",
"Ext_TemplateId": 1,
"Ext_ArtworkId": 1,
"Ext_ResourceId": 1,
"FileLocation": "sample string 10",
"OrganisationId": "017849e4-300e-4ce5-a17e-4a4676734b82",
"OrganisationName": "sample string 11",
"TemplateName": "sample string 12",
"UserName": "sample string 13",
"Ext_MailerType": "sample string 14",
"Envelope": "sample string 15",
"Variant": "sample string 16",
"ApprovalGroupId": "7672b6e4-9a7a-4f00-9a1f-36c72f3c5745",
"DeliveryDate": "2026-03-16T13:54:23.8906379+00:00",
"PaperSize": "sample string 17",
"CentralMailerCampaignId": "be595588-9335-4c35-8c1c-a83459bf522b",
"OrderProductionCompletedDate": null,
"Id": "2e1cb84a-44b4-46f5-a6ee-08191ccbe97f",
"CreationDateUtc": "2026-03-16T13:54:23.8906379+00:00",
"UserId": "b92cb7fa-fa4f-47c3-9efd-0e79a0e1c33d",
"TenantId": "c2500e68-2d25-497e-a380-6f89c5da0020",
"SubtotalExVat": 22.0,
"SubtotalIncVat": 23.0,
"DiscountedTotalExVat": 24.0,
"DiscountedTotalIncVat": 25.0,
"VatRateApplied": 26.0
}
],
"PaymentProvider": "sample string 11",
"PaymentStatus": "sample string 12",
"PaymentIs3d": true,
"ConsignmentDetails": [
{
"Id": "7f4076a7-d265-4349-8255-4805f717a550",
"CreationDateUtc": "2026-03-16T13:54:23.8906379+00:00",
"ConsignmentNumber": "sample string 3",
"CampaignId": "2b658d62-4c0b-4893-bc02-a9ecbd2cf41d",
"Reference": "sample string 4",
"OrderId": "ee33225d-304f-4770-a672-ee4e278f209e"
},
{
"Id": "7f4076a7-d265-4349-8255-4805f717a550",
"CreationDateUtc": "2026-03-16T13:54:23.8906379+00:00",
"ConsignmentNumber": "sample string 3",
"CampaignId": "2b658d62-4c0b-4893-bc02-a9ecbd2cf41d",
"Reference": "sample string 4",
"OrderId": "ee33225d-304f-4770-a672-ee4e278f209e"
}
],
"CurrencyCode": "sample string 14"
}
application/xml, text/xml
Sample:
<PayOrderDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Pay.Models">
<Campaigns>
<PayCampaignDto>
<CreationDateUtc xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">2026-03-16T13:54:23.8906379+00:00</CreationDateUtc>
<DiscountedTotalExVat xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">24</DiscountedTotalExVat>
<DiscountedTotalIncVat xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">25</DiscountedTotalIncVat>
<Id xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">2e1cb84a-44b4-46f5-a6ee-08191ccbe97f</Id>
<SubtotalExVat xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">22</SubtotalExVat>
<SubtotalIncVat xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">23</SubtotalIncVat>
<TenantId xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">c2500e68-2d25-497e-a380-6f89c5da0020</TenantId>
<UserId xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">b92cb7fa-fa4f-47c3-9efd-0e79a0e1c33d</UserId>
<VatRateApplied xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">26</VatRateApplied>
<ApprovalGroupId>7672b6e4-9a7a-4f00-9a1f-36c72f3c5745</ApprovalGroupId>
<ApprovalResponses>
<ApprovalResponseDto>
<ApproverUserId>574de022-3c52-4055-aca5-8699fbf2ab4d</ApproverUserId>
<CampaignId>d866c47c-c42a-405e-a421-f141fd0ab92e</CampaignId>
<CreationDate>2026-03-16T13:54:23.8906379+00:00</CreationDate>
<Id>906b4c88-cb9b-481c-a18c-eb5d447738cf</Id>
<Note>sample string 4</Note>
<Status>Approved</Status>
</ApprovalResponseDto>
<ApprovalResponseDto>
<ApproverUserId>574de022-3c52-4055-aca5-8699fbf2ab4d</ApproverUserId>
<CampaignId>d866c47c-c42a-405e-a421-f141fd0ab92e</CampaignId>
<CreationDate>2026-03-16T13:54:23.8906379+00:00</CreationDate>
<Id>906b4c88-cb9b-481c-a18c-eb5d447738cf</Id>
<Note>sample string 4</Note>
<Status>Approved</Status>
</ApprovalResponseDto>
</ApprovalResponses>
<CampaignProperties>
<PayCampaignPropertyDto>
<CampaignId>0c2780ac-620b-4e13-960a-cdcb0956898a</CampaignId>
<Id>2b2e4294-60f7-4535-a2ea-bddd7b1de7b7</Id>
<Name>sample string 3</Name>
<Value>sample string 4</Value>
</PayCampaignPropertyDto>
<PayCampaignPropertyDto>
<CampaignId>0c2780ac-620b-4e13-960a-cdcb0956898a</CampaignId>
<Id>2b2e4294-60f7-4535-a2ea-bddd7b1de7b7</Id>
<Name>sample string 3</Name>
<Value>sample string 4</Value>
</PayCampaignPropertyDto>
</CampaignProperties>
<CentralMailerCampaignId>be595588-9335-4c35-8c1c-a83459bf522b</CentralMailerCampaignId>
<DeliveryDate>2026-03-16T13:54:23.8906379+00:00</DeliveryDate>
<Envelope>sample string 15</Envelope>
<Ext_ArtworkId>1</Ext_ArtworkId>
<Ext_MailerType>sample string 14</Ext_MailerType>
<Ext_ResourceId>1</Ext_ResourceId>
<Ext_TemplateId>1</Ext_TemplateId>
<FileLocation>sample string 10</FileLocation>
<IsTemporary>true</IsTemporary>
<ModifiedDateUtc>2026-03-16T13:54:23.8906379+00:00</ModifiedDateUtc>
<Name>sample string 1</Name>
<OrderId>fcc47fb5-6285-4964-b55a-9d5c0646ebf1</OrderId>
<OrderStatusChanges>
<StatusChangeDto>
<ChangeDateUtc>2026-03-16T13:54:23.8906379+00:00</ChangeDateUtc>
<Description>sample string 4</Description>
<Id>1</Id>
<Status>sample string 2</Status>
<UserId>91c977f9-b481-4f64-9f26-7f0c254986ca</UserId>
</StatusChangeDto>
<StatusChangeDto>
<ChangeDateUtc>2026-03-16T13:54:23.8906379+00:00</ChangeDateUtc>
<Description>sample string 4</Description>
<Id>1</Id>
<Status>sample string 2</Status>
<UserId>91c977f9-b481-4f64-9f26-7f0c254986ca</UserId>
</StatusChangeDto>
</OrderStatusChanges>
<OrganisationId>017849e4-300e-4ce5-a17e-4a4676734b82</OrganisationId>
<OrganisationName>sample string 11</OrganisationName>
<PR_Key>sample string 8</PR_Key>
<PR_UDPRN>sample string 9</PR_UDPRN>
<PaperSize>sample string 17</PaperSize>
<PublicId>sample string 2</PublicId>
<Quantity>4</Quantity>
<RB_ArtWorkToken>sample string 7</RB_ArtWorkToken>
<ServiceType>DesignPrintAndDistribution</ServiceType>
<SupplierId>7727be95-3c41-4e16-aecd-1fbc456e6e9f</SupplierId>
<TemplateName>sample string 12</TemplateName>
<UserJourney>sample string 3</UserJourney>
<UserName>sample string 13</UserName>
<Variant>sample string 16</Variant>
<Voucher>
<Cancelled>true</Cancelled>
<Deleted>true</Deleted>
<Description>sample string 2</Description>
<Entitlement>7</Entitlement>
<ExpiryDate>2026-03-16T13:54:23.8906379+00:00</ExpiryDate>
<ForAllUsers>true</ForAllUsers>
<Id>1</Id>
<IsPercentageDiscount>true</IsPercentageDiscount>
<MaxDiscount>1</MaxDiscount>
<MaxSpend>1</MaxSpend>
<MinSpend>1</MinSpend>
<MinimumQuantity>1</MinimumQuantity>
<NewCustomerOnly>true</NewCustomerOnly>
<StartDate>2026-03-16T13:54:23.8906379+00:00</StartDate>
<TenantId>sample string 4</TenantId>
<VoucherCode>sample string 3</VoucherCode>
<VoucherProductType>sample string 10</VoucherProductType>
<VoucherProperties>
<VoucherPropertyDto>
<CreationDateUtc>2026-03-16T13:54:23.8906379+00:00</CreationDateUtc>
<Id>ca804f1a-3d12-4f3a-821e-ef1f607905d1</Id>
<Name>sample string 4</Name>
<Type>PrintingOptions</Type>
<Value>sample string 5</Value>
<VoucherId>3</VoucherId>
</VoucherPropertyDto>
<VoucherPropertyDto>
<CreationDateUtc>2026-03-16T13:54:23.8906379+00:00</CreationDateUtc>
<Id>ca804f1a-3d12-4f3a-821e-ef1f607905d1</Id>
<Name>sample string 4</Name>
<Type>PrintingOptions</Type>
<Value>sample string 5</Value>
<VoucherId>3</VoucherId>
</VoucherPropertyDto>
</VoucherProperties>
<VoucherUsers>
<VoucherUserDto>
<ApplyAutomatically>true</ApplyAutomatically>
<SingleUse>true</SingleUse>
<UserId>7d934397-4f35-4126-9975-e6082b52f30a</UserId>
</VoucherUserDto>
<VoucherUserDto>
<ApplyAutomatically>true</ApplyAutomatically>
<SingleUse>true</SingleUse>
<UserId>7d934397-4f35-4126-9975-e6082b52f30a</UserId>
</VoucherUserDto>
</VoucherUsers>
</Voucher>
</PayCampaignDto>
<PayCampaignDto>
<CreationDateUtc xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">2026-03-16T13:54:23.8906379+00:00</CreationDateUtc>
<DiscountedTotalExVat xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">24</DiscountedTotalExVat>
<DiscountedTotalIncVat xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">25</DiscountedTotalIncVat>
<Id xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">2e1cb84a-44b4-46f5-a6ee-08191ccbe97f</Id>
<SubtotalExVat xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">22</SubtotalExVat>
<SubtotalIncVat xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">23</SubtotalIncVat>
<TenantId xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">c2500e68-2d25-497e-a380-6f89c5da0020</TenantId>
<UserId xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">b92cb7fa-fa4f-47c3-9efd-0e79a0e1c33d</UserId>
<VatRateApplied xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">26</VatRateApplied>
<ApprovalGroupId>7672b6e4-9a7a-4f00-9a1f-36c72f3c5745</ApprovalGroupId>
<ApprovalResponses>
<ApprovalResponseDto>
<ApproverUserId>574de022-3c52-4055-aca5-8699fbf2ab4d</ApproverUserId>
<CampaignId>d866c47c-c42a-405e-a421-f141fd0ab92e</CampaignId>
<CreationDate>2026-03-16T13:54:23.8906379+00:00</CreationDate>
<Id>906b4c88-cb9b-481c-a18c-eb5d447738cf</Id>
<Note>sample string 4</Note>
<Status>Approved</Status>
</ApprovalResponseDto>
<ApprovalResponseDto>
<ApproverUserId>574de022-3c52-4055-aca5-8699fbf2ab4d</ApproverUserId>
<CampaignId>d866c47c-c42a-405e-a421-f141fd0ab92e</CampaignId>
<CreationDate>2026-03-16T13:54:23.8906379+00:00</CreationDate>
<Id>906b4c88-cb9b-481c-a18c-eb5d447738cf</Id>
<Note>sample string 4</Note>
<Status>Approved</Status>
</ApprovalResponseDto>
</ApprovalResponses>
<CampaignProperties>
<PayCampaignPropertyDto>
<CampaignId>0c2780ac-620b-4e13-960a-cdcb0956898a</CampaignId>
<Id>2b2e4294-60f7-4535-a2ea-bddd7b1de7b7</Id>
<Name>sample string 3</Name>
<Value>sample string 4</Value>
</PayCampaignPropertyDto>
<PayCampaignPropertyDto>
<CampaignId>0c2780ac-620b-4e13-960a-cdcb0956898a</CampaignId>
<Id>2b2e4294-60f7-4535-a2ea-bddd7b1de7b7</Id>
<Name>sample string 3</Name>
<Value>sample string 4</Value>
</PayCampaignPropertyDto>
</CampaignProperties>
<CentralMailerCampaignId>be595588-9335-4c35-8c1c-a83459bf522b</CentralMailerCampaignId>
<DeliveryDate>2026-03-16T13:54:23.8906379+00:00</DeliveryDate>
<Envelope>sample string 15</Envelope>
<Ext_ArtworkId>1</Ext_ArtworkId>
<Ext_MailerType>sample string 14</Ext_MailerType>
<Ext_ResourceId>1</Ext_ResourceId>
<Ext_TemplateId>1</Ext_TemplateId>
<FileLocation>sample string 10</FileLocation>
<IsTemporary>true</IsTemporary>
<ModifiedDateUtc>2026-03-16T13:54:23.8906379+00:00</ModifiedDateUtc>
<Name>sample string 1</Name>
<OrderId>fcc47fb5-6285-4964-b55a-9d5c0646ebf1</OrderId>
<OrderStatusChanges>
<StatusChangeDto>
<ChangeDateUtc>2026-03-16T13:54:23.8906379+00:00</ChangeDateUtc>
<Description>sample string 4</Description>
<Id>1</Id>
<Status>sample string 2</Status>
<UserId>91c977f9-b481-4f64-9f26-7f0c254986ca</UserId>
</StatusChangeDto>
<StatusChangeDto>
<ChangeDateUtc>2026-03-16T13:54:23.8906379+00:00</ChangeDateUtc>
<Description>sample string 4</Description>
<Id>1</Id>
<Status>sample string 2</Status>
<UserId>91c977f9-b481-4f64-9f26-7f0c254986ca</UserId>
</StatusChangeDto>
</OrderStatusChanges>
<OrganisationId>017849e4-300e-4ce5-a17e-4a4676734b82</OrganisationId>
<OrganisationName>sample string 11</OrganisationName>
<PR_Key>sample string 8</PR_Key>
<PR_UDPRN>sample string 9</PR_UDPRN>
<PaperSize>sample string 17</PaperSize>
<PublicId>sample string 2</PublicId>
<Quantity>4</Quantity>
<RB_ArtWorkToken>sample string 7</RB_ArtWorkToken>
<ServiceType>DesignPrintAndDistribution</ServiceType>
<SupplierId>7727be95-3c41-4e16-aecd-1fbc456e6e9f</SupplierId>
<TemplateName>sample string 12</TemplateName>
<UserJourney>sample string 3</UserJourney>
<UserName>sample string 13</UserName>
<Variant>sample string 16</Variant>
<Voucher>
<Cancelled>true</Cancelled>
<Deleted>true</Deleted>
<Description>sample string 2</Description>
<Entitlement>7</Entitlement>
<ExpiryDate>2026-03-16T13:54:23.8906379+00:00</ExpiryDate>
<ForAllUsers>true</ForAllUsers>
<Id>1</Id>
<IsPercentageDiscount>true</IsPercentageDiscount>
<MaxDiscount>1</MaxDiscount>
<MaxSpend>1</MaxSpend>
<MinSpend>1</MinSpend>
<MinimumQuantity>1</MinimumQuantity>
<NewCustomerOnly>true</NewCustomerOnly>
<StartDate>2026-03-16T13:54:23.8906379+00:00</StartDate>
<TenantId>sample string 4</TenantId>
<VoucherCode>sample string 3</VoucherCode>
<VoucherProductType>sample string 10</VoucherProductType>
<VoucherProperties>
<VoucherPropertyDto>
<CreationDateUtc>2026-03-16T13:54:23.8906379+00:00</CreationDateUtc>
<Id>ca804f1a-3d12-4f3a-821e-ef1f607905d1</Id>
<Name>sample string 4</Name>
<Type>PrintingOptions</Type>
<Value>sample string 5</Value>
<VoucherId>3</VoucherId>
</VoucherPropertyDto>
<VoucherPropertyDto>
<CreationDateUtc>2026-03-16T13:54:23.8906379+00:00</CreationDateUtc>
<Id>ca804f1a-3d12-4f3a-821e-ef1f607905d1</Id>
<Name>sample string 4</Name>
<Type>PrintingOptions</Type>
<Value>sample string 5</Value>
<VoucherId>3</VoucherId>
</VoucherPropertyDto>
</VoucherProperties>
<VoucherUsers>
<VoucherUserDto>
<ApplyAutomatically>true</ApplyAutomatically>
<SingleUse>true</SingleUse>
<UserId>7d934397-4f35-4126-9975-e6082b52f30a</UserId>
</VoucherUserDto>
<VoucherUserDto>
<ApplyAutomatically>true</ApplyAutomatically>
<SingleUse>true</SingleUse>
<UserId>7d934397-4f35-4126-9975-e6082b52f30a</UserId>
</VoucherUserDto>
</VoucherUsers>
</Voucher>
</PayCampaignDto>
</Campaigns>
<ConsignmentDetails>
<PayOrderConsignmentDetailDto>
<CampaignId>2b658d62-4c0b-4893-bc02-a9ecbd2cf41d</CampaignId>
<ConsignmentNumber>sample string 3</ConsignmentNumber>
<CreationDateUtc>2026-03-16T13:54:23.8906379+00:00</CreationDateUtc>
<Id>7f4076a7-d265-4349-8255-4805f717a550</Id>
<OrderId>ee33225d-304f-4770-a672-ee4e278f209e</OrderId>
<Reference>sample string 4</Reference>
</PayOrderConsignmentDetailDto>
<PayOrderConsignmentDetailDto>
<CampaignId>2b658d62-4c0b-4893-bc02-a9ecbd2cf41d</CampaignId>
<ConsignmentNumber>sample string 3</ConsignmentNumber>
<CreationDateUtc>2026-03-16T13:54:23.8906379+00:00</CreationDateUtc>
<Id>7f4076a7-d265-4349-8255-4805f717a550</Id>
<OrderId>ee33225d-304f-4770-a672-ee4e278f209e</OrderId>
<Reference>sample string 4</Reference>
</PayOrderConsignmentDetailDto>
</ConsignmentDetails>
<CreationDateUtc>2026-03-16T13:54:23.8906379+00:00</CreationDateUtc>
<CurrencyCode>sample string 14</CurrencyCode>
<DeliveryAddressId>ab8d20cc-1569-4b09-9126-436807da063d</DeliveryAddressId>
<ExternalProductionId>sample string 10</ExternalProductionId>
<Id>88ba7b62-239e-4766-b38f-f762b435fc1a</Id>
<IsTemporary>true</IsTemporary>
<ModifiedDateUtc>2026-03-16T13:54:23.8906379+00:00</ModifiedDateUtc>
<Name>sample string 3</Name>
<PaymentDateUtc>2026-03-16T13:54:23.8906379+00:00</PaymentDateUtc>
<PaymentIs3d>true</PaymentIs3d>
<PaymentProvider>sample string 11</PaymentProvider>
<PaymentStatus>sample string 12</PaymentStatus>
<PricePaid>6</PricePaid>
<PublicId>sample string 2</PublicId>
<StatusChanges>
<StatusChangeDto>
<ChangeDateUtc>2026-03-16T13:54:23.8906379+00:00</ChangeDateUtc>
<Description>sample string 4</Description>
<Id>1</Id>
<Status>sample string 2</Status>
<UserId>91c977f9-b481-4f64-9f26-7f0c254986ca</UserId>
</StatusChangeDto>
<StatusChangeDto>
<ChangeDateUtc>2026-03-16T13:54:23.8906379+00:00</ChangeDateUtc>
<Description>sample string 4</Description>
<Id>1</Id>
<Status>sample string 2</Status>
<UserId>91c977f9-b481-4f64-9f26-7f0c254986ca</UserId>
</StatusChangeDto>
</StatusChanges>
<TenantId>b022e950-a767-4c7d-806a-873ef9bcc2c5</TenantId>
<UserId>8d648468-0a57-4a3c-a86d-9d6c7228881d</UserId>
<VatRate>5</VatRate>
</PayOrderDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.