GET api/weborder/{orderId}
DEPRECATED - Provides the matching web order, given a web order id. Use "fetch/{orderId:int}"
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
orderId |
The web order id. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
PublicAPI.Models.WebOrderHeaderOutputDTOOfWebOrderLineName | Description | Type | Additional information |
---|---|---|---|
Id | integer |
Range: inclusive between 1 and 2147483647 |
|
ShopId | integer |
Range: inclusive between 1 and 2147483647 |
|
OrderNo | string |
String length: inclusive between 0 and 255 |
|
OrderReference | string |
String length: inclusive between 0 and 255 |
|
OrderedOn | date |
None. |
|
PickedUpOn | date |
None. |
|
CreatedOn | date |
None. |
|
ModifiedOn | date |
None. |
|
IsPaid | boolean |
Required Range: inclusive between false and true |
|
LoyaltyMemberId | string |
String length: inclusive between 0 and 255 |
|
MemberId | integer |
Range: inclusive between 1 and 9,22337203685478E+18 |
|
WebshopId | integer |
Range: inclusive between 1 and 2147483647 |
|
ReceiveAddress | string |
String length: inclusive between 0 and 255 |
|
ReturnAddress | string |
String length: inclusive between 0 and 2147483647 |
|
WebOrderLines | Collection of WebOrderLine |
None. |
Response Formats
application/json, text/json
Sample:
{ "Id": 1, "ShopId": 2, "OrderNo": "sample string 3", "OrderReference": "sample string 4", "OrderedOn": "2025-05-04T05:20:11.2855462+02:00", "PickedUpOn": "2025-05-04T05:20:11.2855462+02:00", "CreatedOn": "2025-05-04T05:20:11.2855462+02:00", "ModifiedOn": "2025-05-04T05:20:11.2855462+02:00", "IsPaid": true, "LoyaltyMemberId": "sample string 10", "MemberId": 11, "WebshopId": 12, "ReceiveAddress": "sample string 13", "ReturnAddress": "sample string 14", "WebOrderLines": [ { "Id": 1, "VariantId": 2, "Status": "All", "ModifiedOn": "2025-05-04T05:20:11.2855462+02:00", "SalesPrice": 4.1, "EffectiveSalesPrice": 5.1, "DiscountAmount": 6.1, "DeliveryNo": "sample string 7", "Notes": "sample string 8" }, { "Id": 1, "VariantId": 2, "Status": "All", "ModifiedOn": "2025-05-04T05:20:11.2855462+02:00", "SalesPrice": 4.1, "EffectiveSalesPrice": 5.1, "DiscountAmount": 6.1, "DeliveryNo": "sample string 7", "Notes": "sample string 8" } ] }
application/xml, text/xml
Sample:
<WebOrderHeaderOutputDTOOfWebOrderLineOutputDTOiTlCtTkQ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PublicAPI.Models"> <ReceiveAddress>sample string 13</ReceiveAddress> <ReturnAddress>sample string 14</ReturnAddress> <WebOrderLines> <WebOrderLineOutputDTO> <DeliveryNo>sample string 7</DeliveryNo> <DiscountAmount>6.1</DiscountAmount> <EffectiveSalesPrice>5.1</EffectiveSalesPrice> <Notes>sample string 8</Notes> <SalesPrice>4.1</SalesPrice> <Id>1</Id> <ModifiedOn>2025-05-04T05:20:11.2855462+02:00</ModifiedOn> <Status>All</Status> <VariantId>2</VariantId> </WebOrderLineOutputDTO> <WebOrderLineOutputDTO> <DeliveryNo>sample string 7</DeliveryNo> <DiscountAmount>6.1</DiscountAmount> <EffectiveSalesPrice>5.1</EffectiveSalesPrice> <Notes>sample string 8</Notes> <SalesPrice>4.1</SalesPrice> <Id>1</Id> <ModifiedOn>2025-05-04T05:20:11.2855462+02:00</ModifiedOn> <Status>All</Status> <VariantId>2</VariantId> </WebOrderLineOutputDTO> </WebOrderLines> <CreatedOn>2025-05-04T05:20:11.2855462+02:00</CreatedOn> <Id>1</Id> <IsPaid>true</IsPaid> <LoyaltyMemberId>sample string 10</LoyaltyMemberId> <MemberId>11</MemberId> <ModifiedOn>2025-05-04T05:20:11.2855462+02:00</ModifiedOn> <OrderNo>sample string 3</OrderNo> <OrderReference>sample string 4</OrderReference> <OrderedOn>2025-05-04T05:20:11.2855462+02:00</OrderedOn> <PickedUpOn>2025-05-04T05:20:11.2855462+02:00</PickedUpOn> <ShopId>2</ShopId> <WebshopId>12</WebshopId> </WebOrderHeaderOutputDTOOfWebOrderLineOutputDTOiTlCtTkQ>