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": "5d653ff8-adf2-47c4-b7da-22bad433e0a0",
"PublicId": "sample string 2",
"Name": "sample string 3",
"CreationDateUtc": "2026-10-23T13:15:08.4783864+00:00",
"ModifiedDateUtc": "2026-10-23T13:15:08.4783864+00:00",
"PaymentDateUtc": "2026-10-23T13:15:08.4783864+00:00",
"VatRate": 5.0,
"PricePaid": 6.0,
"UserId": "a4463e58-5659-47a0-ba53-bad3ebe613a6",
"TenantId": "e5dd776a-399b-4328-ace6-b24a9170624f",
"StatusChanges": [
{
"Id": 1,
"Status": "sample string 2",
"ChangeDateUtc": "2026-10-23T13:15:08.4783864+00:00",
"Description": "sample string 4",
"UserId": "3ce7399c-1112-4928-ace5-20165009fdf4"
},
{
"Id": 1,
"Status": "sample string 2",
"ChangeDateUtc": "2026-10-23T13:15:08.4783864+00:00",
"Description": "sample string 4",
"UserId": "3ce7399c-1112-4928-ace5-20165009fdf4"
}
],
"Status": "sample string 2",
"IsTemporary": true,
"DeliveryAddressId": "b34fd7af-4f7b-4809-b82e-9aef0ff18aea",
"ExternalProductionId": "sample string 10",
"Campaigns": [
{
"Name": "sample string 1",
"PublicId": "sample string 2",
"ModifiedDateUtc": "2026-10-23T13:15:08.4783864+00:00",
"UserJourney": "sample string 3",
"ServiceType": 0,
"Quantity": 4,
"ApprovalResponses": [
{
"Id": "4ab70665-34ed-41aa-91b2-e3ea9815440d",
"CreationDate": "2026-10-23T13:15:08.4783864+00:00",
"ApproverUserId": "6aebb2d6-0763-4057-9c40-c967c91b92bb",
"Note": "sample string 4",
"Status": 0,
"CampaignId": "e915906a-e8b4-47ef-95c7-ae0807d99472"
},
{
"Id": "4ab70665-34ed-41aa-91b2-e3ea9815440d",
"CreationDate": "2026-10-23T13:15:08.4783864+00:00",
"ApproverUserId": "6aebb2d6-0763-4057-9c40-c967c91b92bb",
"Note": "sample string 4",
"Status": 0,
"CampaignId": "e915906a-e8b4-47ef-95c7-ae0807d99472"
}
],
"SupplierId": "60e51aa5-3709-40c3-a475-edb443e18d5b",
"OrderId": "c2a54ff2-9130-4382-878c-3d60bdc96912",
"CampaignProperties": [
{
"Id": "69e64552-7570-4e66-b7c4-6983e28c03d9",
"CampaignId": "cbd215aa-cc7a-46d2-90de-872ad6fee01f",
"Name": "sample string 3",
"Value": "sample string 4"
},
{
"Id": "69e64552-7570-4e66-b7c4-6983e28c03d9",
"CampaignId": "cbd215aa-cc7a-46d2-90de-872ad6fee01f",
"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-10-23T13:15:08.4783864+00:00",
"ExpiryDate": "2026-10-23T13:15:08.4783864+00:00",
"Cancelled": true,
"IsPercentageDiscount": true,
"Entitlement": 7.0,
"MinSpend": 1.0,
"MaxSpend": 1.0,
"MaxDiscount": 1.0,
"ForAllUsers": true,
"Deleted": true,
"VoucherUsers": [
{
"UserId": "965cd044-8614-449f-a844-e64771f7fcd1",
"SingleUse": true,
"ApplyAutomatically": true
},
{
"UserId": "965cd044-8614-449f-a844-e64771f7fcd1",
"SingleUse": true,
"ApplyAutomatically": true
}
],
"MinimumQuantity": 1,
"VoucherProductType": "sample string 10",
"NewCustomerOnly": true,
"VoucherProperties": [
{
"Id": "dc9ea43e-81e0-4119-957c-e35d4e811adc",
"CreationDateUtc": "2026-10-23T13:15:08.4783864+00:00",
"VoucherId": 3,
"Name": "sample string 4",
"Value": "sample string 5",
"Type": 0
},
{
"Id": "dc9ea43e-81e0-4119-957c-e35d4e811adc",
"CreationDateUtc": "2026-10-23T13:15:08.4783864+00:00",
"VoucherId": 3,
"Name": "sample string 4",
"Value": "sample string 5",
"Type": 0
}
]
},
"OrderStatusChanges": [
{
"Id": 1,
"Status": "sample string 2",
"ChangeDateUtc": "2026-10-23T13:15:08.4783864+00:00",
"Description": "sample string 4",
"UserId": "3ce7399c-1112-4928-ace5-20165009fdf4"
},
{
"Id": 1,
"Status": "sample string 2",
"ChangeDateUtc": "2026-10-23T13:15:08.4783864+00:00",
"Description": "sample string 4",
"UserId": "3ce7399c-1112-4928-ace5-20165009fdf4"
}
],
"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": "95e5e58c-0fad-4ab7-ad89-1c8544f91f06",
"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": "b993e379-75af-4001-bfe8-cc1dbb162a8d",
"DeliveryDate": "2026-10-23T13:15:08.4783864+00:00",
"PaperSize": "sample string 17",
"CentralMailerCampaignId": "be2eb828-e8e3-4c7d-8b8f-a760ae900fa1",
"OrderProductionCompletedDate": null,
"Id": "4559a590-811e-4d0d-8575-16859ca64566",
"CreationDateUtc": "2026-10-23T13:15:08.4783864+00:00",
"UserId": "ea51a407-713f-4f7a-bf49-2d7b899bdf81",
"TenantId": "7328ee72-0d8a-4ee3-83d0-7d5fb990d722",
"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-10-23T13:15:08.4783864+00:00",
"UserJourney": "sample string 3",
"ServiceType": 0,
"Quantity": 4,
"ApprovalResponses": [
{
"Id": "4ab70665-34ed-41aa-91b2-e3ea9815440d",
"CreationDate": "2026-10-23T13:15:08.4783864+00:00",
"ApproverUserId": "6aebb2d6-0763-4057-9c40-c967c91b92bb",
"Note": "sample string 4",
"Status": 0,
"CampaignId": "e915906a-e8b4-47ef-95c7-ae0807d99472"
},
{
"Id": "4ab70665-34ed-41aa-91b2-e3ea9815440d",
"CreationDate": "2026-10-23T13:15:08.4783864+00:00",
"ApproverUserId": "6aebb2d6-0763-4057-9c40-c967c91b92bb",
"Note": "sample string 4",
"Status": 0,
"CampaignId": "e915906a-e8b4-47ef-95c7-ae0807d99472"
}
],
"SupplierId": "60e51aa5-3709-40c3-a475-edb443e18d5b",
"OrderId": "c2a54ff2-9130-4382-878c-3d60bdc96912",
"CampaignProperties": [
{
"Id": "69e64552-7570-4e66-b7c4-6983e28c03d9",
"CampaignId": "cbd215aa-cc7a-46d2-90de-872ad6fee01f",
"Name": "sample string 3",
"Value": "sample string 4"
},
{
"Id": "69e64552-7570-4e66-b7c4-6983e28c03d9",
"CampaignId": "cbd215aa-cc7a-46d2-90de-872ad6fee01f",
"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-10-23T13:15:08.4783864+00:00",
"ExpiryDate": "2026-10-23T13:15:08.4783864+00:00",
"Cancelled": true,
"IsPercentageDiscount": true,
"Entitlement": 7.0,
"MinSpend": 1.0,
"MaxSpend": 1.0,
"MaxDiscount": 1.0,
"ForAllUsers": true,
"Deleted": true,
"VoucherUsers": [
{
"UserId": "965cd044-8614-449f-a844-e64771f7fcd1",
"SingleUse": true,
"ApplyAutomatically": true
},
{
"UserId": "965cd044-8614-449f-a844-e64771f7fcd1",
"SingleUse": true,
"ApplyAutomatically": true
}
],
"MinimumQuantity": 1,
"VoucherProductType": "sample string 10",
"NewCustomerOnly": true,
"VoucherProperties": [
{
"Id": "dc9ea43e-81e0-4119-957c-e35d4e811adc",
"CreationDateUtc": "2026-10-23T13:15:08.4783864+00:00",
"VoucherId": 3,
"Name": "sample string 4",
"Value": "sample string 5",
"Type": 0
},
{
"Id": "dc9ea43e-81e0-4119-957c-e35d4e811adc",
"CreationDateUtc": "2026-10-23T13:15:08.4783864+00:00",
"VoucherId": 3,
"Name": "sample string 4",
"Value": "sample string 5",
"Type": 0
}
]
},
"OrderStatusChanges": [
{
"Id": 1,
"Status": "sample string 2",
"ChangeDateUtc": "2026-10-23T13:15:08.4783864+00:00",
"Description": "sample string 4",
"UserId": "3ce7399c-1112-4928-ace5-20165009fdf4"
},
{
"Id": 1,
"Status": "sample string 2",
"ChangeDateUtc": "2026-10-23T13:15:08.4783864+00:00",
"Description": "sample string 4",
"UserId": "3ce7399c-1112-4928-ace5-20165009fdf4"
}
],
"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": "95e5e58c-0fad-4ab7-ad89-1c8544f91f06",
"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": "b993e379-75af-4001-bfe8-cc1dbb162a8d",
"DeliveryDate": "2026-10-23T13:15:08.4783864+00:00",
"PaperSize": "sample string 17",
"CentralMailerCampaignId": "be2eb828-e8e3-4c7d-8b8f-a760ae900fa1",
"OrderProductionCompletedDate": null,
"Id": "4559a590-811e-4d0d-8575-16859ca64566",
"CreationDateUtc": "2026-10-23T13:15:08.4783864+00:00",
"UserId": "ea51a407-713f-4f7a-bf49-2d7b899bdf81",
"TenantId": "7328ee72-0d8a-4ee3-83d0-7d5fb990d722",
"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": "a814afad-9920-4c33-ad22-052ad926c0db",
"CreationDateUtc": "2026-10-23T13:15:08.4783864+00:00",
"ConsignmentNumber": "sample string 3",
"CampaignId": "61627637-3c8b-49ef-a3ad-a4a039981dca",
"Reference": "sample string 4",
"OrderId": "e7aeceac-3403-44cb-9b14-f3746c96f8e8"
},
{
"Id": "a814afad-9920-4c33-ad22-052ad926c0db",
"CreationDateUtc": "2026-10-23T13:15:08.4783864+00:00",
"ConsignmentNumber": "sample string 3",
"CampaignId": "61627637-3c8b-49ef-a3ad-a4a039981dca",
"Reference": "sample string 4",
"OrderId": "e7aeceac-3403-44cb-9b14-f3746c96f8e8"
}
],
"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-10-23T13:15:08.4783864+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">4559a590-811e-4d0d-8575-16859ca64566</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">7328ee72-0d8a-4ee3-83d0-7d5fb990d722</TenantId>
<UserId xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">ea51a407-713f-4f7a-bf49-2d7b899bdf81</UserId>
<VatRateApplied xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">26</VatRateApplied>
<ApprovalGroupId>b993e379-75af-4001-bfe8-cc1dbb162a8d</ApprovalGroupId>
<ApprovalResponses>
<ApprovalResponseDto>
<ApproverUserId>6aebb2d6-0763-4057-9c40-c967c91b92bb</ApproverUserId>
<CampaignId>e915906a-e8b4-47ef-95c7-ae0807d99472</CampaignId>
<CreationDate>2026-10-23T13:15:08.4783864+00:00</CreationDate>
<Id>4ab70665-34ed-41aa-91b2-e3ea9815440d</Id>
<Note>sample string 4</Note>
<Status>Approved</Status>
</ApprovalResponseDto>
<ApprovalResponseDto>
<ApproverUserId>6aebb2d6-0763-4057-9c40-c967c91b92bb</ApproverUserId>
<CampaignId>e915906a-e8b4-47ef-95c7-ae0807d99472</CampaignId>
<CreationDate>2026-10-23T13:15:08.4783864+00:00</CreationDate>
<Id>4ab70665-34ed-41aa-91b2-e3ea9815440d</Id>
<Note>sample string 4</Note>
<Status>Approved</Status>
</ApprovalResponseDto>
</ApprovalResponses>
<CampaignProperties>
<PayCampaignPropertyDto>
<CampaignId>cbd215aa-cc7a-46d2-90de-872ad6fee01f</CampaignId>
<Id>69e64552-7570-4e66-b7c4-6983e28c03d9</Id>
<Name>sample string 3</Name>
<Value>sample string 4</Value>
</PayCampaignPropertyDto>
<PayCampaignPropertyDto>
<CampaignId>cbd215aa-cc7a-46d2-90de-872ad6fee01f</CampaignId>
<Id>69e64552-7570-4e66-b7c4-6983e28c03d9</Id>
<Name>sample string 3</Name>
<Value>sample string 4</Value>
</PayCampaignPropertyDto>
</CampaignProperties>
<CentralMailerCampaignId>be2eb828-e8e3-4c7d-8b8f-a760ae900fa1</CentralMailerCampaignId>
<DeliveryDate>2026-10-23T13:15:08.4783864+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-10-23T13:15:08.4783864+00:00</ModifiedDateUtc>
<Name>sample string 1</Name>
<OrderId>c2a54ff2-9130-4382-878c-3d60bdc96912</OrderId>
<OrderStatusChanges>
<StatusChangeDto>
<ChangeDateUtc>2026-10-23T13:15:08.4783864+00:00</ChangeDateUtc>
<Description>sample string 4</Description>
<Id>1</Id>
<Status>sample string 2</Status>
<UserId>3ce7399c-1112-4928-ace5-20165009fdf4</UserId>
</StatusChangeDto>
<StatusChangeDto>
<ChangeDateUtc>2026-10-23T13:15:08.4783864+00:00</ChangeDateUtc>
<Description>sample string 4</Description>
<Id>1</Id>
<Status>sample string 2</Status>
<UserId>3ce7399c-1112-4928-ace5-20165009fdf4</UserId>
</StatusChangeDto>
</OrderStatusChanges>
<OrganisationId>95e5e58c-0fad-4ab7-ad89-1c8544f91f06</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>60e51aa5-3709-40c3-a475-edb443e18d5b</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-10-23T13:15:08.4783864+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-10-23T13:15:08.4783864+00:00</StartDate>
<TenantId>sample string 4</TenantId>
<VoucherCode>sample string 3</VoucherCode>
<VoucherProductType>sample string 10</VoucherProductType>
<VoucherProperties>
<VoucherPropertyDto>
<CreationDateUtc>2026-10-23T13:15:08.4783864+00:00</CreationDateUtc>
<Id>dc9ea43e-81e0-4119-957c-e35d4e811adc</Id>
<Name>sample string 4</Name>
<Type>PrintingOptions</Type>
<Value>sample string 5</Value>
<VoucherId>3</VoucherId>
</VoucherPropertyDto>
<VoucherPropertyDto>
<CreationDateUtc>2026-10-23T13:15:08.4783864+00:00</CreationDateUtc>
<Id>dc9ea43e-81e0-4119-957c-e35d4e811adc</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>965cd044-8614-449f-a844-e64771f7fcd1</UserId>
</VoucherUserDto>
<VoucherUserDto>
<ApplyAutomatically>true</ApplyAutomatically>
<SingleUse>true</SingleUse>
<UserId>965cd044-8614-449f-a844-e64771f7fcd1</UserId>
</VoucherUserDto>
</VoucherUsers>
</Voucher>
</PayCampaignDto>
<PayCampaignDto>
<CreationDateUtc xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">2026-10-23T13:15:08.4783864+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">4559a590-811e-4d0d-8575-16859ca64566</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">7328ee72-0d8a-4ee3-83d0-7d5fb990d722</TenantId>
<UserId xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">ea51a407-713f-4f7a-bf49-2d7b899bdf81</UserId>
<VatRateApplied xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">26</VatRateApplied>
<ApprovalGroupId>b993e379-75af-4001-bfe8-cc1dbb162a8d</ApprovalGroupId>
<ApprovalResponses>
<ApprovalResponseDto>
<ApproverUserId>6aebb2d6-0763-4057-9c40-c967c91b92bb</ApproverUserId>
<CampaignId>e915906a-e8b4-47ef-95c7-ae0807d99472</CampaignId>
<CreationDate>2026-10-23T13:15:08.4783864+00:00</CreationDate>
<Id>4ab70665-34ed-41aa-91b2-e3ea9815440d</Id>
<Note>sample string 4</Note>
<Status>Approved</Status>
</ApprovalResponseDto>
<ApprovalResponseDto>
<ApproverUserId>6aebb2d6-0763-4057-9c40-c967c91b92bb</ApproverUserId>
<CampaignId>e915906a-e8b4-47ef-95c7-ae0807d99472</CampaignId>
<CreationDate>2026-10-23T13:15:08.4783864+00:00</CreationDate>
<Id>4ab70665-34ed-41aa-91b2-e3ea9815440d</Id>
<Note>sample string 4</Note>
<Status>Approved</Status>
</ApprovalResponseDto>
</ApprovalResponses>
<CampaignProperties>
<PayCampaignPropertyDto>
<CampaignId>cbd215aa-cc7a-46d2-90de-872ad6fee01f</CampaignId>
<Id>69e64552-7570-4e66-b7c4-6983e28c03d9</Id>
<Name>sample string 3</Name>
<Value>sample string 4</Value>
</PayCampaignPropertyDto>
<PayCampaignPropertyDto>
<CampaignId>cbd215aa-cc7a-46d2-90de-872ad6fee01f</CampaignId>
<Id>69e64552-7570-4e66-b7c4-6983e28c03d9</Id>
<Name>sample string 3</Name>
<Value>sample string 4</Value>
</PayCampaignPropertyDto>
</CampaignProperties>
<CentralMailerCampaignId>be2eb828-e8e3-4c7d-8b8f-a760ae900fa1</CentralMailerCampaignId>
<DeliveryDate>2026-10-23T13:15:08.4783864+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-10-23T13:15:08.4783864+00:00</ModifiedDateUtc>
<Name>sample string 1</Name>
<OrderId>c2a54ff2-9130-4382-878c-3d60bdc96912</OrderId>
<OrderStatusChanges>
<StatusChangeDto>
<ChangeDateUtc>2026-10-23T13:15:08.4783864+00:00</ChangeDateUtc>
<Description>sample string 4</Description>
<Id>1</Id>
<Status>sample string 2</Status>
<UserId>3ce7399c-1112-4928-ace5-20165009fdf4</UserId>
</StatusChangeDto>
<StatusChangeDto>
<ChangeDateUtc>2026-10-23T13:15:08.4783864+00:00</ChangeDateUtc>
<Description>sample string 4</Description>
<Id>1</Id>
<Status>sample string 2</Status>
<UserId>3ce7399c-1112-4928-ace5-20165009fdf4</UserId>
</StatusChangeDto>
</OrderStatusChanges>
<OrganisationId>95e5e58c-0fad-4ab7-ad89-1c8544f91f06</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>60e51aa5-3709-40c3-a475-edb443e18d5b</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-10-23T13:15:08.4783864+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-10-23T13:15:08.4783864+00:00</StartDate>
<TenantId>sample string 4</TenantId>
<VoucherCode>sample string 3</VoucherCode>
<VoucherProductType>sample string 10</VoucherProductType>
<VoucherProperties>
<VoucherPropertyDto>
<CreationDateUtc>2026-10-23T13:15:08.4783864+00:00</CreationDateUtc>
<Id>dc9ea43e-81e0-4119-957c-e35d4e811adc</Id>
<Name>sample string 4</Name>
<Type>PrintingOptions</Type>
<Value>sample string 5</Value>
<VoucherId>3</VoucherId>
</VoucherPropertyDto>
<VoucherPropertyDto>
<CreationDateUtc>2026-10-23T13:15:08.4783864+00:00</CreationDateUtc>
<Id>dc9ea43e-81e0-4119-957c-e35d4e811adc</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>965cd044-8614-449f-a844-e64771f7fcd1</UserId>
</VoucherUserDto>
<VoucherUserDto>
<ApplyAutomatically>true</ApplyAutomatically>
<SingleUse>true</SingleUse>
<UserId>965cd044-8614-449f-a844-e64771f7fcd1</UserId>
</VoucherUserDto>
</VoucherUsers>
</Voucher>
</PayCampaignDto>
</Campaigns>
<ConsignmentDetails>
<PayOrderConsignmentDetailDto>
<CampaignId>61627637-3c8b-49ef-a3ad-a4a039981dca</CampaignId>
<ConsignmentNumber>sample string 3</ConsignmentNumber>
<CreationDateUtc>2026-10-23T13:15:08.4783864+00:00</CreationDateUtc>
<Id>a814afad-9920-4c33-ad22-052ad926c0db</Id>
<OrderId>e7aeceac-3403-44cb-9b14-f3746c96f8e8</OrderId>
<Reference>sample string 4</Reference>
</PayOrderConsignmentDetailDto>
<PayOrderConsignmentDetailDto>
<CampaignId>61627637-3c8b-49ef-a3ad-a4a039981dca</CampaignId>
<ConsignmentNumber>sample string 3</ConsignmentNumber>
<CreationDateUtc>2026-10-23T13:15:08.4783864+00:00</CreationDateUtc>
<Id>a814afad-9920-4c33-ad22-052ad926c0db</Id>
<OrderId>e7aeceac-3403-44cb-9b14-f3746c96f8e8</OrderId>
<Reference>sample string 4</Reference>
</PayOrderConsignmentDetailDto>
</ConsignmentDetails>
<CreationDateUtc>2026-10-23T13:15:08.4783864+00:00</CreationDateUtc>
<CurrencyCode>sample string 14</CurrencyCode>
<DeliveryAddressId>b34fd7af-4f7b-4809-b82e-9aef0ff18aea</DeliveryAddressId>
<ExternalProductionId>sample string 10</ExternalProductionId>
<Id>5d653ff8-adf2-47c4-b7da-22bad433e0a0</Id>
<IsTemporary>true</IsTemporary>
<ModifiedDateUtc>2026-10-23T13:15:08.4783864+00:00</ModifiedDateUtc>
<Name>sample string 3</Name>
<PaymentDateUtc>2026-10-23T13:15:08.4783864+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-10-23T13:15:08.4783864+00:00</ChangeDateUtc>
<Description>sample string 4</Description>
<Id>1</Id>
<Status>sample string 2</Status>
<UserId>3ce7399c-1112-4928-ace5-20165009fdf4</UserId>
</StatusChangeDto>
<StatusChangeDto>
<ChangeDateUtc>2026-10-23T13:15:08.4783864+00:00</ChangeDateUtc>
<Description>sample string 4</Description>
<Id>1</Id>
<Status>sample string 2</Status>
<UserId>3ce7399c-1112-4928-ace5-20165009fdf4</UserId>
</StatusChangeDto>
</StatusChanges>
<TenantId>e5dd776a-399b-4328-ace6-b24a9170624f</TenantId>
<UserId>a4463e58-5659-47a0-ba53-bad3ebe613a6</UserId>
<VatRate>5</VatRate>
</PayOrderDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.