| Requires any of the roles: | Admin, TeamAdmin, MobileApp | Requires the permission: | ReadData |
| GET | /Webshop/Order/{Reference} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Reference | path | string | No | |
| OwnerId | query | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Success | form | bool | No | |
| Reason | form | string | No | |
| Message | form | LocalizedMessage | No | |
| OrderReference | form | string | No | |
| Order | form | WebshopOrderSummary | No | |
| StatusCode | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Is | form | string | No | |
| En | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ID | form | int | No | |
| OrderReference | form | string | No | |
| OwnerId | form | int | No | |
| Status | form | string | No | |
| TotalMinor | form | int | No | |
| DeliveryFeeMinor | form | int | No | |
| TotalDiscountMinor | form | int | No | |
| Currency | form | string | No | |
| BuyerName | form | string | No | |
| BuyerEmail | form | string | No | |
| BuyerPhone | form | string | No | |
| Address | form | string | No | |
| City | form | string | No | |
| ZipCode | form | string | No | |
| Country | form | string | No | |
| DeliveryType | form | string | No | |
| DroppOrderId | form | string | No | |
| DroppLocationId | form | string | No | |
| NeedsDeliveryAttention | form | bool | No | |
| PaymentMethodId | form | string | No | |
| PaymentId | form | string | No | |
| PaymentReference | form | string | No | |
| DiscountCode | form | string | No | |
| GiftPaidMinor | form | int | No | |
| CreatedAt | form | DateTime | No | |
| UpdatedAt | form | DateTime | No | |
| Lines | form | List<WebshopOrderLineSummary> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ID | form | int | No | |
| ProductId | form | int | No | |
| VariantId | form | int | No | |
| ProductName | form | string | No | |
| Size | form | string | No | |
| Color | form | string | No | |
| UnitPriceMinor | form | int | No | |
| Quantity | form | int | No | |
| LineTotalMinor | form | int | No | |
| Status | form | string | No | |
| PayoutInfoId | form | int? | No | |
| PayoutTag | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Webshop/Order/{Reference} HTTP/1.1
Host: stubbur-app.azurewebsites.net
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
success: False,
reason: String,
message:
{
is: String,
en: String
},
orderReference: String,
order:
{
id: 0,
orderReference: String,
ownerId: 0,
status: String,
totalMinor: 0,
deliveryFeeMinor: 0,
totalDiscountMinor: 0,
currency: String,
buyerName: String,
buyerEmail: String,
buyerPhone: String,
address: String,
city: String,
zipCode: String,
country: String,
deliveryType: String,
droppOrderId: String,
droppLocationId: String,
needsDeliveryAttention: False,
paymentMethodId: String,
paymentId: String,
paymentReference: String,
discountCode: String,
giftPaidMinor: 0,
createdAt: 0001-01-01,
updatedAt: 0001-01-01,
lines:
[
{
id: 0,
productId: 0,
variantId: 0,
productName: String,
size: String,
color: String,
unitPriceMinor: 0,
quantity: 0,
lineTotalMinor: 0,
status: String,
payoutInfoId: 0,
payoutTag: String
}
]
},
statusCode: 0
}