| 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 .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/Ledger/{OrderId} HTTP/1.1
Host: stubbur-app.azurewebsites.net
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
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
}
]
},
transactions:
[
{
id: 0,
orderId: 0,
kind: String,
amountMinor: 0,
paymentReference: String,
note: String,
idempotencyKey: String,
createdAt: 0001-01-01,
createdBy: String
}
],
statusCode: 0,
message: String
}