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": "46b8f02f-2097-4927-b21b-2c10b90c4a94",
"personId": "748cf11f-ce24-4b70-b644-e69dbc957f33",
"personName": "sample string 3",
"products": [
{
"id": "738a2105-0734-4411-a6d7-c7e60188ade0",
"name": "sample string 2",
"type": "sample string 3"
},
{
"id": "738a2105-0734-4411-a6d7-c7e60188ade0",
"name": "sample string 2",
"type": "sample string 3"
}
],
"campaignId": "735c8b59-9da2-4254-b5d9-b954fd97e0d8",
"campaignName": "sample string 4",
"updated": "2025-12-30T23:39:52.256421+01:00",
"status": 6,
"statusName": "sample string 7",
"orderLines": [
{
"id": "bf8ce4ca-e0ae-468d-87cf-9194e2ce2154",
"type": "sample string 2",
"count": 3.0,
"price": {
"id": "b2fca8f3-58df-4f6c-8b4f-424e4606d3a5",
"amount": 1.0,
"currency": "sample string 2",
"productId": "44cc1b6c-ffc0-4186-9daa-57598568a665",
"symbol": "sample string 3",
"isSymbolBefore": true
},
"names": [
"sample string 1",
"sample string 2"
],
"updated": "2025-12-30T23:39:52.256421+01:00",
"created": "2025-12-30T23:39:52.256421+01:00",
"campaignName": "sample string 6",
"campaignId": "533c8cf4-4185-4daf-8c5b-d55be828980b",
"productName": "sample string 7",
"productId": "0cfcd9e9-d733-4408-b2c7-edf1b25c8d5b",
"recurring": true
},
{
"id": "bf8ce4ca-e0ae-468d-87cf-9194e2ce2154",
"type": "sample string 2",
"count": 3.0,
"price": {
"id": "b2fca8f3-58df-4f6c-8b4f-424e4606d3a5",
"amount": 1.0,
"currency": "sample string 2",
"productId": "44cc1b6c-ffc0-4186-9daa-57598568a665",
"symbol": "sample string 3",
"isSymbolBefore": true
},
"names": [
"sample string 1",
"sample string 2"
],
"updated": "2025-12-30T23:39:52.256421+01:00",
"created": "2025-12-30T23:39:52.256421+01:00",
"campaignName": "sample string 6",
"campaignId": "533c8cf4-4185-4daf-8c5b-d55be828980b",
"productName": "sample string 7",
"productId": "0cfcd9e9-d733-4408-b2c7-edf1b25c8d5b",
"recurring": true
}
],
"postage": {
"id": "b2fca8f3-58df-4f6c-8b4f-424e4606d3a5",
"amount": 1.0,
"currency": "sample string 2",
"productId": "44cc1b6c-ffc0-4186-9daa-57598568a665",
"symbol": "sample string 3",
"isSymbolBefore": true
},
"price": {
"id": "b2fca8f3-58df-4f6c-8b4f-424e4606d3a5",
"amount": 1.0,
"currency": "sample string 2",
"productId": "44cc1b6c-ffc0-4186-9daa-57598568a665",
"symbol": "sample string 3",
"isSymbolBefore": true
},
"created": "2025-12-30T23:39:52.256421+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": "738a2105-0734-4411-a6d7-c7e60188ade0",
"name": "sample string 2",
"type": "sample string 3"
},
"fromCart": "fccf8e66-5795-48e1-87c2-1a1c69711bef",
"isExternalOrder": true,
"fulfillmentDate": "2025-12-30T23:39:52.256421+01:00",
"fulfillmentDeliveryDate": "2025-12-30T23:39:52.256421+01:00",
"captureDate": "2025-12-30T23:39:52.256421+01:00",
"paidDate": "2025-12-30T23:39:52.256421+01:00",
"shop": {
"id": "738a2105-0734-4411-a6d7-c7e60188ade0",
"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.