POST api/order/{id}/update
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | string |
Required |
Body Parameters
OrderDto| Name | Description | Type | Additional information |
|---|---|---|---|
| ShortUnique | string |
None. |
|
| Id | globally unique identifier |
None. |
|
| PersonId | globally unique identifier |
None. |
|
| PersonName | string |
None. |
|
| Products | Collection of EntityDto |
None. |
|
| CampaignId | globally unique identifier |
None. |
|
| CampaignName | string |
None. |
|
| Updated | date |
None. |
|
| Status | integer |
None. |
|
| StatusName | string |
None. |
|
| OrderLines | Collection of OrderLineDto |
None. |
|
| Postage | PriceDto |
None. |
|
| Price | PriceDto |
None. |
|
| Created | date |
None. |
|
| Recurring | boolean |
None. |
|
| FullfillmentCompany | string |
None. |
|
| FulfillmentId | string |
None. |
|
| PaymentId | string |
None. |
|
| PaymentCompany | string |
None. |
|
| Comment | string |
None. |
|
| DeliveryMethod | string |
None. |
|
| PaymentCompanySubscriptionId | string |
None. |
|
| StatusDto | StatusDto |
None. |
|
| CampaignCode | string |
None. |
|
| Campaign | EntityDto |
None. |
|
| FromCart | globally unique identifier |
None. |
|
| IsExternalOrder | boolean |
None. |
|
| FulfillmentDate | date |
None. |
|
| FulfillmentDeliveryDate | date |
None. |
|
| CaptureDate | date |
None. |
|
| PaidDate | date |
None. |
|
| Shop | EntityDto |
None. |
|
| FulfillmentStatus | string |
None. |
|
| FulfillmentPurchaseOrderId | string |
None. |
|
| PaymentStatus | string |
None. |
|
| PaymentMethod | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"shortUnique": "sample string 1",
"id": "9bccc2fb-8fb7-4046-8edb-d8801db082f7",
"personId": "ef14fc2d-58b2-44d5-af2a-3835dc3200d8",
"personName": "sample string 3",
"products": [
{
"id": "a66ea2b0-14f9-494e-a7b5-5582339b1760",
"name": "sample string 2",
"type": "sample string 3"
},
{
"id": "a66ea2b0-14f9-494e-a7b5-5582339b1760",
"name": "sample string 2",
"type": "sample string 3"
}
],
"campaignId": "c6a9e949-d2f2-4d34-ade8-a3c3cb009a02",
"campaignName": "sample string 4",
"updated": "2026-03-09T10:52:10.3455245+01:00",
"status": 6,
"statusName": "sample string 7",
"orderLines": [
{
"id": "0032d787-567c-465f-a316-5d8738b8330e",
"type": "sample string 2",
"count": 3.0,
"price": {
"id": "d5abf94d-624f-415e-aa60-2166eb5ef7a2",
"amount": 1.0,
"currency": "sample string 2",
"productId": "72b58158-5c0a-4588-a095-8ac13570fd29",
"symbol": "sample string 3",
"isSymbolBefore": true
},
"names": [
"sample string 1",
"sample string 2"
],
"updated": "2026-03-09T10:52:10.3630246+01:00",
"created": "2026-03-09T10:52:10.3630246+01:00",
"campaignName": "sample string 6",
"campaignId": "c4e26b39-fdf2-4c97-8208-7aa5a0b34da9",
"productName": "sample string 7",
"productId": "aedc8e1f-8818-46cd-a5e5-56821c69650f",
"recurring": true
},
{
"id": "0032d787-567c-465f-a316-5d8738b8330e",
"type": "sample string 2",
"count": 3.0,
"price": {
"id": "d5abf94d-624f-415e-aa60-2166eb5ef7a2",
"amount": 1.0,
"currency": "sample string 2",
"productId": "72b58158-5c0a-4588-a095-8ac13570fd29",
"symbol": "sample string 3",
"isSymbolBefore": true
},
"names": [
"sample string 1",
"sample string 2"
],
"updated": "2026-03-09T10:52:10.3630246+01:00",
"created": "2026-03-09T10:52:10.3630246+01:00",
"campaignName": "sample string 6",
"campaignId": "c4e26b39-fdf2-4c97-8208-7aa5a0b34da9",
"productName": "sample string 7",
"productId": "aedc8e1f-8818-46cd-a5e5-56821c69650f",
"recurring": true
}
],
"postage": {
"id": "d5abf94d-624f-415e-aa60-2166eb5ef7a2",
"amount": 1.0,
"currency": "sample string 2",
"productId": "72b58158-5c0a-4588-a095-8ac13570fd29",
"symbol": "sample string 3",
"isSymbolBefore": true
},
"price": {
"id": "d5abf94d-624f-415e-aa60-2166eb5ef7a2",
"amount": 1.0,
"currency": "sample string 2",
"productId": "72b58158-5c0a-4588-a095-8ac13570fd29",
"symbol": "sample string 3",
"isSymbolBefore": true
},
"created": "2026-03-09T10:52:10.3630246+01:00",
"recurring": true,
"fullfillmentCompany": "sample string 10",
"fulfillmentId": "sample string 11",
"paymentId": "sample string 12",
"paymentCompany": "sample string 13",
"comment": "sample string 14",
"deliveryMethod": "sample string 15",
"paymentCompanySubscriptionId": "sample string 16",
"statusDto": {
"id": 1,
"name": "sample string 2",
"readableName": "sample string 3",
"type": "sample string 4",
"color": "sample string 5"
},
"campaignCode": "sample string 17",
"campaign": {
"id": "a66ea2b0-14f9-494e-a7b5-5582339b1760",
"name": "sample string 2",
"type": "sample string 3"
},
"fromCart": "8bf5c38a-2a69-4d7f-bbe7-c58b47d2199a",
"isExternalOrder": true,
"fulfillmentDate": "2026-03-09T10:52:10.3630246+01:00",
"fulfillmentDeliveryDate": "2026-03-09T10:52:10.3630246+01:00",
"captureDate": "2026-03-09T10:52:10.3630246+01:00",
"paidDate": "2026-03-09T10:52:10.3630246+01:00",
"shop": {
"id": "a66ea2b0-14f9-494e-a7b5-5582339b1760",
"name": "sample string 2",
"type": "sample string 3"
},
"fulfillmentStatus": "sample string 18",
"fulfillmentPurchaseOrderId": "sample string 19",
"paymentStatus": "sample string 20",
"paymentMethod": "sample string 21"
}
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.