| Requires any of the roles: | Admin, TeamAdmin | Requires the permission: | ReadData |
| GET | /Webshop/Order/Ledger/{OrderId} |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class WebshopOrderLedgerRequest
{
var orderId:Int? = null
var ownerId:Int? = null
}
open class WebshopOrderLedgerResult
{
var order:WebshopOrderSummary? = null
var transactions:ArrayList<WebshopOrderTransaction> = ArrayList<WebshopOrderTransaction>()
var statusCode:Int? = null
var message:String? = null
}
open class WebshopOrderSummary
{
var id:Int? = null
var orderReference:String? = null
var ownerId:Int? = null
var status:String? = null
var totalMinor:Int? = null
var deliveryFeeMinor:Int? = null
var totalDiscountMinor:Int? = null
var currency:String? = null
var buyerName:String? = null
var buyerEmail:String? = null
var buyerPhone:String? = null
var address:String? = null
var city:String? = null
var zipCode:String? = null
var country:String? = null
var deliveryType:String? = null
var droppOrderId:String? = null
var droppLocationId:String? = null
var needsDeliveryAttention:Boolean? = null
var paymentMethodId:String? = null
var paymentId:String? = null
var paymentReference:String? = null
var discountCode:String? = null
var giftPaidMinor:Int? = null
var createdAt:Date? = null
var updatedAt:Date? = null
var lines:ArrayList<WebshopOrderLineSummary> = ArrayList<WebshopOrderLineSummary>()
}
open class WebshopOrderLineSummary
{
var id:Int? = null
var productId:Int? = null
var variantId:Int? = null
var productName:String? = null
var size:String? = null
var color:String? = null
var unitPriceMinor:Int? = null
var quantity:Int? = null
var lineTotalMinor:Int? = null
var status:String? = null
var payoutInfoId:Int? = null
var payoutTag:String? = null
}
open class WebshopOrderTransaction
{
var id:Int? = null
var orderId:Int? = null
@StringLength(20)
var kind:String? = null
var amountMinor:Int? = null
@StringLength(50)
var paymentReference:String? = null
@StringLength(300)
var note:String? = null
@StringLength(100)
var idempotencyKey:String? = null
var createdAt:Date? = null
@StringLength(100)
var createdBy:String? = null
}
Kotlin WebshopOrderLedgerRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Webshop/Order/Ledger/{OrderId} HTTP/1.1
Host: stubbur-app.azurewebsites.net
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<WebshopOrderLedgerResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
<Message>String</Message>
<Order>
<Address>String</Address>
<BuyerEmail>String</BuyerEmail>
<BuyerName>String</BuyerName>
<BuyerPhone>String</BuyerPhone>
<City>String</City>
<Country>String</Country>
<CreatedAt>0001-01-01T00:00:00</CreatedAt>
<Currency>String</Currency>
<DeliveryFeeMinor>0</DeliveryFeeMinor>
<DeliveryType>String</DeliveryType>
<DiscountCode>String</DiscountCode>
<DroppLocationId>String</DroppLocationId>
<DroppOrderId>String</DroppOrderId>
<GiftPaidMinor>0</GiftPaidMinor>
<ID>0</ID>
<Lines>
<WebshopOrderLineSummary>
<Color>String</Color>
<ID>0</ID>
<LineTotalMinor>0</LineTotalMinor>
<PayoutInfoId>0</PayoutInfoId>
<PayoutTag>String</PayoutTag>
<ProductId>0</ProductId>
<ProductName>String</ProductName>
<Quantity>0</Quantity>
<Size>String</Size>
<Status>String</Status>
<UnitPriceMinor>0</UnitPriceMinor>
<VariantId>0</VariantId>
</WebshopOrderLineSummary>
</Lines>
<NeedsDeliveryAttention>false</NeedsDeliveryAttention>
<OrderReference>String</OrderReference>
<OwnerId>0</OwnerId>
<PaymentId>String</PaymentId>
<PaymentMethodId>String</PaymentMethodId>
<PaymentReference>String</PaymentReference>
<Status>String</Status>
<TotalDiscountMinor>0</TotalDiscountMinor>
<TotalMinor>0</TotalMinor>
<UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
<ZipCode>String</ZipCode>
</Order>
<StatusCode>0</StatusCode>
<Transactions xmlns:d2p1="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel.Types">
<d2p1:WebshopOrderTransaction>
<d2p1:AmountMinor>0</d2p1:AmountMinor>
<d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
<d2p1:CreatedBy>String</d2p1:CreatedBy>
<d2p1:ID>0</d2p1:ID>
<d2p1:IdempotencyKey>String</d2p1:IdempotencyKey>
<d2p1:Kind>String</d2p1:Kind>
<d2p1:Note>String</d2p1:Note>
<d2p1:OrderId>0</d2p1:OrderId>
<d2p1:PaymentReference>String</d2p1:PaymentReference>
</d2p1:WebshopOrderTransaction>
</Transactions>
</WebshopOrderLedgerResult>