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": "397c2910-efb4-40a6-a051-84cabc7f2f5c",
"PublicId": "sample string 2",
"Name": "sample string 3",
"CreationDateUtc": "2026-01-21T09:50:29.708943+00:00",
"ModifiedDateUtc": "2026-01-21T09:50:29.708943+00:00",
"PaymentDateUtc": "2026-01-21T09:50:29.708943+00:00",
"VatRate": 5.0,
"PricePaid": 6.0,
"UserId": "e67a5424-1371-49fc-ba91-3b5c929c2839",
"TenantId": "267e2369-bdc4-44f1-b33f-910d082f7f97",
"StatusChanges": [
{
"Id": 1,
"Status": "sample string 2",
"ChangeDateUtc": "2026-01-21T09:50:29.708943+00:00",
"Description": "sample string 4",
"UserId": "305e9332-6c6a-44a7-8451-f27093fdb0e1"
},
{
"Id": 1,
"Status": "sample string 2",
"ChangeDateUtc": "2026-01-21T09:50:29.708943+00:00",
"Description": "sample string 4",
"UserId": "305e9332-6c6a-44a7-8451-f27093fdb0e1"
}
],
"Status": "sample string 2",
"IsTemporary": true,
"DeliveryAddressId": "81aa477c-8bb5-47a7-9551-ff8731e5a9fa",
"ExternalProductionId": "sample string 10",
"Campaigns": [
{
"Name": "sample string 1",
"PublicId": "sample string 2",
"ModifiedDateUtc": "2026-01-21T09:50:29.708943+00:00",
"UserJourney": "sample string 3",
"ServiceType": 0,
"Quantity": 4,
"ApprovalResponses": [
{
"Id": "63b5dc11-f3d1-41a0-9ca0-004f4aa50197",
"CreationDate": "2026-01-21T09:50:29.708943+00:00",
"ApproverUserId": "1bec6bc2-e2f9-47b6-90d1-0b5c6abf1ec9",
"Note": "sample string 4",
"Status": 0,
"CampaignId": "163559d9-e8c3-4c95-b266-02c3913076ee"
},
{
"Id": "63b5dc11-f3d1-41a0-9ca0-004f4aa50197",
"CreationDate": "2026-01-21T09:50:29.708943+00:00",
"ApproverUserId": "1bec6bc2-e2f9-47b6-90d1-0b5c6abf1ec9",
"Note": "sample string 4",
"Status": 0,
"CampaignId": "163559d9-e8c3-4c95-b266-02c3913076ee"
}
],
"SupplierId": "614d7377-b055-487f-b800-333d43cd6835",
"OrderId": "fb9888de-c70a-483f-8b33-14ea5dc53f98",
"CampaignProperties": [
{
"Id": "7eefeed6-d4cb-444f-88ae-526dbdffe67d",
"CampaignId": "1b08de75-db65-4d87-a6da-9b52f913adb6",
"Name": "sample string 3",
"Value": "sample string 4"
},
{
"Id": "7eefeed6-d4cb-444f-88ae-526dbdffe67d",
"CampaignId": "1b08de75-db65-4d87-a6da-9b52f913adb6",
"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-01-21T09:50:29.708943+00:00",
"ExpiryDate": "2026-01-21T09:50:29.708943+00:00",
"Cancelled": true,
"IsPercentageDiscount": true,
"Entitlement": 7.0,
"MinSpend": 1.0,
"MaxSpend": 1.0,
"MaxDiscount": 1.0,
"ForAllUsers": true,
"Deleted": true,
"VoucherUsers": [
{
"UserId": "d700b00a-2d01-4b9c-bf60-e551b165a1a0",
"SingleUse": true,
"ApplyAutomatically": true
},
{
"UserId": "d700b00a-2d01-4b9c-bf60-e551b165a1a0",
"SingleUse": true,
"ApplyAutomatically": true
}
],
"MinimumQuantity": 1,
"VoucherProductType": "sample string 10",
"NewCustomerOnly": true,
"VoucherProperties": [
{
"Id": "26848846-45ef-49c0-a28b-95e08a372c48",
"CreationDateUtc": "2026-01-21T09:50:29.708943+00:00",
"VoucherId": 3,
"Name": "sample string 4",
"Value": "sample string 5",
"Type": 0
},
{
"Id": "26848846-45ef-49c0-a28b-95e08a372c48",
"CreationDateUtc": "2026-01-21T09:50:29.708943+00:00",
"VoucherId": 3,
"Name": "sample string 4",
"Value": "sample string 5",
"Type": 0
}
]
},
"OrderStatusChanges": [
{
"Id": 1,
"Status": "sample string 2",
"ChangeDateUtc": "2026-01-21T09:50:29.708943+00:00",
"Description": "sample string 4",
"UserId": "305e9332-6c6a-44a7-8451-f27093fdb0e1"
},
{
"Id": 1,
"Status": "sample string 2",
"ChangeDateUtc": "2026-01-21T09:50:29.708943+00:00",
"Description": "sample string 4",
"UserId": "305e9332-6c6a-44a7-8451-f27093fdb0e1"
}
],
"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": "3525f709-abfe-46b2-a97a-708375772c1e",
"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": "bc876cad-ad06-4675-bf59-a5e8112fe718",
"DeliveryDate": "2026-01-21T09:50:29.708943+00:00",
"PaperSize": "sample string 17",
"CentralMailerCampaignId": "b77b084e-1099-46e4-babc-ed58ba16ebc5",
"OrderProductionCompletedDate": null,
"Id": "bb5fa0f1-2291-46d7-9774-026980caa53e",
"CreationDateUtc": "2026-01-21T09:50:29.708943+00:00",
"UserId": "fd288c1f-1ace-44c5-972a-3faba13437be",
"TenantId": "1d15acca-01a9-4394-aabb-31f96d79c725",
"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-01-21T09:50:29.708943+00:00",
"UserJourney": "sample string 3",
"ServiceType": 0,
"Quantity": 4,
"ApprovalResponses": [
{
"Id": "63b5dc11-f3d1-41a0-9ca0-004f4aa50197",
"CreationDate": "2026-01-21T09:50:29.708943+00:00",
"ApproverUserId": "1bec6bc2-e2f9-47b6-90d1-0b5c6abf1ec9",
"Note": "sample string 4",
"Status": 0,
"CampaignId": "163559d9-e8c3-4c95-b266-02c3913076ee"
},
{
"Id": "63b5dc11-f3d1-41a0-9ca0-004f4aa50197",
"CreationDate": "2026-01-21T09:50:29.708943+00:00",
"ApproverUserId": "1bec6bc2-e2f9-47b6-90d1-0b5c6abf1ec9",
"Note": "sample string 4",
"Status": 0,
"CampaignId": "163559d9-e8c3-4c95-b266-02c3913076ee"
}
],
"SupplierId": "614d7377-b055-487f-b800-333d43cd6835",
"OrderId": "fb9888de-c70a-483f-8b33-14ea5dc53f98",
"CampaignProperties": [
{
"Id": "7eefeed6-d4cb-444f-88ae-526dbdffe67d",
"CampaignId": "1b08de75-db65-4d87-a6da-9b52f913adb6",
"Name": "sample string 3",
"Value": "sample string 4"
},
{
"Id": "7eefeed6-d4cb-444f-88ae-526dbdffe67d",
"CampaignId": "1b08de75-db65-4d87-a6da-9b52f913adb6",
"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-01-21T09:50:29.708943+00:00",
"ExpiryDate": "2026-01-21T09:50:29.708943+00:00",
"Cancelled": true,
"IsPercentageDiscount": true,
"Entitlement": 7.0,
"MinSpend": 1.0,
"MaxSpend": 1.0,
"MaxDiscount": 1.0,
"ForAllUsers": true,
"Deleted": true,
"VoucherUsers": [
{
"UserId": "d700b00a-2d01-4b9c-bf60-e551b165a1a0",
"SingleUse": true,
"ApplyAutomatically": true
},
{
"UserId": "d700b00a-2d01-4b9c-bf60-e551b165a1a0",
"SingleUse": true,
"ApplyAutomatically": true
}
],
"MinimumQuantity": 1,
"VoucherProductType": "sample string 10",
"NewCustomerOnly": true,
"VoucherProperties": [
{
"Id": "26848846-45ef-49c0-a28b-95e08a372c48",
"CreationDateUtc": "2026-01-21T09:50:29.708943+00:00",
"VoucherId": 3,
"Name": "sample string 4",
"Value": "sample string 5",
"Type": 0
},
{
"Id": "26848846-45ef-49c0-a28b-95e08a372c48",
"CreationDateUtc": "2026-01-21T09:50:29.708943+00:00",
"VoucherId": 3,
"Name": "sample string 4",
"Value": "sample string 5",
"Type": 0
}
]
},
"OrderStatusChanges": [
{
"Id": 1,
"Status": "sample string 2",
"ChangeDateUtc": "2026-01-21T09:50:29.708943+00:00",
"Description": "sample string 4",
"UserId": "305e9332-6c6a-44a7-8451-f27093fdb0e1"
},
{
"Id": 1,
"Status": "sample string 2",
"ChangeDateUtc": "2026-01-21T09:50:29.708943+00:00",
"Description": "sample string 4",
"UserId": "305e9332-6c6a-44a7-8451-f27093fdb0e1"
}
],
"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": "3525f709-abfe-46b2-a97a-708375772c1e",
"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": "bc876cad-ad06-4675-bf59-a5e8112fe718",
"DeliveryDate": "2026-01-21T09:50:29.708943+00:00",
"PaperSize": "sample string 17",
"CentralMailerCampaignId": "b77b084e-1099-46e4-babc-ed58ba16ebc5",
"OrderProductionCompletedDate": null,
"Id": "bb5fa0f1-2291-46d7-9774-026980caa53e",
"CreationDateUtc": "2026-01-21T09:50:29.708943+00:00",
"UserId": "fd288c1f-1ace-44c5-972a-3faba13437be",
"TenantId": "1d15acca-01a9-4394-aabb-31f96d79c725",
"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": "9abafcab-f426-4870-9d22-dfff00d32975",
"CreationDateUtc": "2026-01-21T09:50:29.708943+00:00",
"ConsignmentNumber": "sample string 3",
"CampaignId": "4daff729-3502-4540-ad7b-09f40b49f5fb",
"Reference": "sample string 4",
"OrderId": "d3f5148e-90a8-489c-81e2-39f39360af49"
},
{
"Id": "9abafcab-f426-4870-9d22-dfff00d32975",
"CreationDateUtc": "2026-01-21T09:50:29.708943+00:00",
"ConsignmentNumber": "sample string 3",
"CampaignId": "4daff729-3502-4540-ad7b-09f40b49f5fb",
"Reference": "sample string 4",
"OrderId": "d3f5148e-90a8-489c-81e2-39f39360af49"
}
],
"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-01-21T09:50:29.708943+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">bb5fa0f1-2291-46d7-9774-026980caa53e</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">1d15acca-01a9-4394-aabb-31f96d79c725</TenantId>
<UserId xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">fd288c1f-1ace-44c5-972a-3faba13437be</UserId>
<VatRateApplied xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">26</VatRateApplied>
<ApprovalGroupId>bc876cad-ad06-4675-bf59-a5e8112fe718</ApprovalGroupId>
<ApprovalResponses>
<ApprovalResponseDto>
<ApproverUserId>1bec6bc2-e2f9-47b6-90d1-0b5c6abf1ec9</ApproverUserId>
<CampaignId>163559d9-e8c3-4c95-b266-02c3913076ee</CampaignId>
<CreationDate>2026-01-21T09:50:29.708943+00:00</CreationDate>
<Id>63b5dc11-f3d1-41a0-9ca0-004f4aa50197</Id>
<Note>sample string 4</Note>
<Status>Approved</Status>
</ApprovalResponseDto>
<ApprovalResponseDto>
<ApproverUserId>1bec6bc2-e2f9-47b6-90d1-0b5c6abf1ec9</ApproverUserId>
<CampaignId>163559d9-e8c3-4c95-b266-02c3913076ee</CampaignId>
<CreationDate>2026-01-21T09:50:29.708943+00:00</CreationDate>
<Id>63b5dc11-f3d1-41a0-9ca0-004f4aa50197</Id>
<Note>sample string 4</Note>
<Status>Approved</Status>
</ApprovalResponseDto>
</ApprovalResponses>
<CampaignProperties>
<PayCampaignPropertyDto>
<CampaignId>1b08de75-db65-4d87-a6da-9b52f913adb6</CampaignId>
<Id>7eefeed6-d4cb-444f-88ae-526dbdffe67d</Id>
<Name>sample string 3</Name>
<Value>sample string 4</Value>
</PayCampaignPropertyDto>
<PayCampaignPropertyDto>
<CampaignId>1b08de75-db65-4d87-a6da-9b52f913adb6</CampaignId>
<Id>7eefeed6-d4cb-444f-88ae-526dbdffe67d</Id>
<Name>sample string 3</Name>
<Value>sample string 4</Value>
</PayCampaignPropertyDto>
</CampaignProperties>
<CentralMailerCampaignId>b77b084e-1099-46e4-babc-ed58ba16ebc5</CentralMailerCampaignId>
<DeliveryDate>2026-01-21T09:50:29.708943+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-01-21T09:50:29.708943+00:00</ModifiedDateUtc>
<Name>sample string 1</Name>
<OrderId>fb9888de-c70a-483f-8b33-14ea5dc53f98</OrderId>
<OrderStatusChanges>
<StatusChangeDto>
<ChangeDateUtc>2026-01-21T09:50:29.708943+00:00</ChangeDateUtc>
<Description>sample string 4</Description>
<Id>1</Id>
<Status>sample string 2</Status>
<UserId>305e9332-6c6a-44a7-8451-f27093fdb0e1</UserId>
</StatusChangeDto>
<StatusChangeDto>
<ChangeDateUtc>2026-01-21T09:50:29.708943+00:00</ChangeDateUtc>
<Description>sample string 4</Description>
<Id>1</Id>
<Status>sample string 2</Status>
<UserId>305e9332-6c6a-44a7-8451-f27093fdb0e1</UserId>
</StatusChangeDto>
</OrderStatusChanges>
<OrganisationId>3525f709-abfe-46b2-a97a-708375772c1e</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>614d7377-b055-487f-b800-333d43cd6835</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-01-21T09:50:29.708943+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-01-21T09:50:29.708943+00:00</StartDate>
<TenantId>sample string 4</TenantId>
<VoucherCode>sample string 3</VoucherCode>
<VoucherProductType>sample string 10</VoucherProductType>
<VoucherProperties>
<VoucherPropertyDto>
<CreationDateUtc>2026-01-21T09:50:29.708943+00:00</CreationDateUtc>
<Id>26848846-45ef-49c0-a28b-95e08a372c48</Id>
<Name>sample string 4</Name>
<Type>PrintingOptions</Type>
<Value>sample string 5</Value>
<VoucherId>3</VoucherId>
</VoucherPropertyDto>
<VoucherPropertyDto>
<CreationDateUtc>2026-01-21T09:50:29.708943+00:00</CreationDateUtc>
<Id>26848846-45ef-49c0-a28b-95e08a372c48</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>d700b00a-2d01-4b9c-bf60-e551b165a1a0</UserId>
</VoucherUserDto>
<VoucherUserDto>
<ApplyAutomatically>true</ApplyAutomatically>
<SingleUse>true</SingleUse>
<UserId>d700b00a-2d01-4b9c-bf60-e551b165a1a0</UserId>
</VoucherUserDto>
</VoucherUsers>
</Voucher>
</PayCampaignDto>
<PayCampaignDto>
<CreationDateUtc xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">2026-01-21T09:50:29.708943+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">bb5fa0f1-2291-46d7-9774-026980caa53e</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">1d15acca-01a9-4394-aabb-31f96d79c725</TenantId>
<UserId xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">fd288c1f-1ace-44c5-972a-3faba13437be</UserId>
<VatRateApplied xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">26</VatRateApplied>
<ApprovalGroupId>bc876cad-ad06-4675-bf59-a5e8112fe718</ApprovalGroupId>
<ApprovalResponses>
<ApprovalResponseDto>
<ApproverUserId>1bec6bc2-e2f9-47b6-90d1-0b5c6abf1ec9</ApproverUserId>
<CampaignId>163559d9-e8c3-4c95-b266-02c3913076ee</CampaignId>
<CreationDate>2026-01-21T09:50:29.708943+00:00</CreationDate>
<Id>63b5dc11-f3d1-41a0-9ca0-004f4aa50197</Id>
<Note>sample string 4</Note>
<Status>Approved</Status>
</ApprovalResponseDto>
<ApprovalResponseDto>
<ApproverUserId>1bec6bc2-e2f9-47b6-90d1-0b5c6abf1ec9</ApproverUserId>
<CampaignId>163559d9-e8c3-4c95-b266-02c3913076ee</CampaignId>
<CreationDate>2026-01-21T09:50:29.708943+00:00</CreationDate>
<Id>63b5dc11-f3d1-41a0-9ca0-004f4aa50197</Id>
<Note>sample string 4</Note>
<Status>Approved</Status>
</ApprovalResponseDto>
</ApprovalResponses>
<CampaignProperties>
<PayCampaignPropertyDto>
<CampaignId>1b08de75-db65-4d87-a6da-9b52f913adb6</CampaignId>
<Id>7eefeed6-d4cb-444f-88ae-526dbdffe67d</Id>
<Name>sample string 3</Name>
<Value>sample string 4</Value>
</PayCampaignPropertyDto>
<PayCampaignPropertyDto>
<CampaignId>1b08de75-db65-4d87-a6da-9b52f913adb6</CampaignId>
<Id>7eefeed6-d4cb-444f-88ae-526dbdffe67d</Id>
<Name>sample string 3</Name>
<Value>sample string 4</Value>
</PayCampaignPropertyDto>
</CampaignProperties>
<CentralMailerCampaignId>b77b084e-1099-46e4-babc-ed58ba16ebc5</CentralMailerCampaignId>
<DeliveryDate>2026-01-21T09:50:29.708943+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-01-21T09:50:29.708943+00:00</ModifiedDateUtc>
<Name>sample string 1</Name>
<OrderId>fb9888de-c70a-483f-8b33-14ea5dc53f98</OrderId>
<OrderStatusChanges>
<StatusChangeDto>
<ChangeDateUtc>2026-01-21T09:50:29.708943+00:00</ChangeDateUtc>
<Description>sample string 4</Description>
<Id>1</Id>
<Status>sample string 2</Status>
<UserId>305e9332-6c6a-44a7-8451-f27093fdb0e1</UserId>
</StatusChangeDto>
<StatusChangeDto>
<ChangeDateUtc>2026-01-21T09:50:29.708943+00:00</ChangeDateUtc>
<Description>sample string 4</Description>
<Id>1</Id>
<Status>sample string 2</Status>
<UserId>305e9332-6c6a-44a7-8451-f27093fdb0e1</UserId>
</StatusChangeDto>
</OrderStatusChanges>
<OrganisationId>3525f709-abfe-46b2-a97a-708375772c1e</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>614d7377-b055-487f-b800-333d43cd6835</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-01-21T09:50:29.708943+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-01-21T09:50:29.708943+00:00</StartDate>
<TenantId>sample string 4</TenantId>
<VoucherCode>sample string 3</VoucherCode>
<VoucherProductType>sample string 10</VoucherProductType>
<VoucherProperties>
<VoucherPropertyDto>
<CreationDateUtc>2026-01-21T09:50:29.708943+00:00</CreationDateUtc>
<Id>26848846-45ef-49c0-a28b-95e08a372c48</Id>
<Name>sample string 4</Name>
<Type>PrintingOptions</Type>
<Value>sample string 5</Value>
<VoucherId>3</VoucherId>
</VoucherPropertyDto>
<VoucherPropertyDto>
<CreationDateUtc>2026-01-21T09:50:29.708943+00:00</CreationDateUtc>
<Id>26848846-45ef-49c0-a28b-95e08a372c48</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>d700b00a-2d01-4b9c-bf60-e551b165a1a0</UserId>
</VoucherUserDto>
<VoucherUserDto>
<ApplyAutomatically>true</ApplyAutomatically>
<SingleUse>true</SingleUse>
<UserId>d700b00a-2d01-4b9c-bf60-e551b165a1a0</UserId>
</VoucherUserDto>
</VoucherUsers>
</Voucher>
</PayCampaignDto>
</Campaigns>
<ConsignmentDetails>
<PayOrderConsignmentDetailDto>
<CampaignId>4daff729-3502-4540-ad7b-09f40b49f5fb</CampaignId>
<ConsignmentNumber>sample string 3</ConsignmentNumber>
<CreationDateUtc>2026-01-21T09:50:29.708943+00:00</CreationDateUtc>
<Id>9abafcab-f426-4870-9d22-dfff00d32975</Id>
<OrderId>d3f5148e-90a8-489c-81e2-39f39360af49</OrderId>
<Reference>sample string 4</Reference>
</PayOrderConsignmentDetailDto>
<PayOrderConsignmentDetailDto>
<CampaignId>4daff729-3502-4540-ad7b-09f40b49f5fb</CampaignId>
<ConsignmentNumber>sample string 3</ConsignmentNumber>
<CreationDateUtc>2026-01-21T09:50:29.708943+00:00</CreationDateUtc>
<Id>9abafcab-f426-4870-9d22-dfff00d32975</Id>
<OrderId>d3f5148e-90a8-489c-81e2-39f39360af49</OrderId>
<Reference>sample string 4</Reference>
</PayOrderConsignmentDetailDto>
</ConsignmentDetails>
<CreationDateUtc>2026-01-21T09:50:29.708943+00:00</CreationDateUtc>
<CurrencyCode>sample string 14</CurrencyCode>
<DeliveryAddressId>81aa477c-8bb5-47a7-9551-ff8731e5a9fa</DeliveryAddressId>
<ExternalProductionId>sample string 10</ExternalProductionId>
<Id>397c2910-efb4-40a6-a051-84cabc7f2f5c</Id>
<IsTemporary>true</IsTemporary>
<ModifiedDateUtc>2026-01-21T09:50:29.708943+00:00</ModifiedDateUtc>
<Name>sample string 3</Name>
<PaymentDateUtc>2026-01-21T09:50:29.708943+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-01-21T09:50:29.708943+00:00</ChangeDateUtc>
<Description>sample string 4</Description>
<Id>1</Id>
<Status>sample string 2</Status>
<UserId>305e9332-6c6a-44a7-8451-f27093fdb0e1</UserId>
</StatusChangeDto>
<StatusChangeDto>
<ChangeDateUtc>2026-01-21T09:50:29.708943+00:00</ChangeDateUtc>
<Description>sample string 4</Description>
<Id>1</Id>
<Status>sample string 2</Status>
<UserId>305e9332-6c6a-44a7-8451-f27093fdb0e1</UserId>
</StatusChangeDto>
</StatusChanges>
<TenantId>267e2369-bdc4-44f1-b33f-910d082f7f97</TenantId>
<UserId>e67a5424-1371-49fc-ba91-3b5c929c2839</UserId>
<VatRate>5</VatRate>
</PayOrderDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.