TicketUserServices

<back to all web services

WebshopOrderLedgerRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequires the permission:ReadData
The following routes are available for this service:
GET/Webshop/Order/Ledger/{OrderId}
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class WebshopOrderLedgerRequest
    {
        public Integer orderId = null;
        public Integer ownerId = null;
        
        public Integer getOrderId() { return orderId; }
        public WebshopOrderLedgerRequest setOrderId(Integer value) { this.orderId = value; return this; }
        public Integer getOwnerId() { return ownerId; }
        public WebshopOrderLedgerRequest setOwnerId(Integer value) { this.ownerId = value; return this; }
    }

    public static class WebshopOrderLedgerResult
    {
        public WebshopOrderSummary order = null;
        public ArrayList<WebshopOrderTransaction> transactions = null;
        public Integer statusCode = null;
        public String message = null;
        
        public WebshopOrderSummary getOrder() { return order; }
        public WebshopOrderLedgerResult setOrder(WebshopOrderSummary value) { this.order = value; return this; }
        public ArrayList<WebshopOrderTransaction> getTransactions() { return transactions; }
        public WebshopOrderLedgerResult setTransactions(ArrayList<WebshopOrderTransaction> value) { this.transactions = value; return this; }
        public Integer getStatusCode() { return statusCode; }
        public WebshopOrderLedgerResult setStatusCode(Integer value) { this.statusCode = value; return this; }
        public String getMessage() { return message; }
        public WebshopOrderLedgerResult setMessage(String value) { this.message = value; return this; }
    }

    public static class WebshopOrderSummary
    {
        public Integer id = null;
        public String orderReference = null;
        public Integer ownerId = null;
        public String status = null;
        public Integer totalMinor = null;
        public Integer deliveryFeeMinor = null;
        public Integer totalDiscountMinor = null;
        public String currency = null;
        public String buyerName = null;
        public String buyerEmail = null;
        public String buyerPhone = null;
        public String address = null;
        public String city = null;
        public String zipCode = null;
        public String country = null;
        public String deliveryType = null;
        public String droppOrderId = null;
        public String droppLocationId = null;
        public Boolean needsDeliveryAttention = null;
        public String paymentMethodId = null;
        public String paymentId = null;
        public String paymentReference = null;
        public String discountCode = null;
        public Integer giftPaidMinor = null;
        public Date createdAt = null;
        public Date updatedAt = null;
        public ArrayList<WebshopOrderLineSummary> lines = null;
        
        public Integer getId() { return id; }
        public WebshopOrderSummary setId(Integer value) { this.id = value; return this; }
        public String getOrderReference() { return orderReference; }
        public WebshopOrderSummary setOrderReference(String value) { this.orderReference = value; return this; }
        public Integer getOwnerId() { return ownerId; }
        public WebshopOrderSummary setOwnerId(Integer value) { this.ownerId = value; return this; }
        public String getStatus() { return status; }
        public WebshopOrderSummary setStatus(String value) { this.status = value; return this; }
        public Integer getTotalMinor() { return totalMinor; }
        public WebshopOrderSummary setTotalMinor(Integer value) { this.totalMinor = value; return this; }
        public Integer getDeliveryFeeMinor() { return deliveryFeeMinor; }
        public WebshopOrderSummary setDeliveryFeeMinor(Integer value) { this.deliveryFeeMinor = value; return this; }
        public Integer getTotalDiscountMinor() { return totalDiscountMinor; }
        public WebshopOrderSummary setTotalDiscountMinor(Integer value) { this.totalDiscountMinor = value; return this; }
        public String getCurrency() { return currency; }
        public WebshopOrderSummary setCurrency(String value) { this.currency = value; return this; }
        public String getBuyerName() { return buyerName; }
        public WebshopOrderSummary setBuyerName(String value) { this.buyerName = value; return this; }
        public String getBuyerEmail() { return buyerEmail; }
        public WebshopOrderSummary setBuyerEmail(String value) { this.buyerEmail = value; return this; }
        public String getBuyerPhone() { return buyerPhone; }
        public WebshopOrderSummary setBuyerPhone(String value) { this.buyerPhone = value; return this; }
        public String getAddress() { return address; }
        public WebshopOrderSummary setAddress(String value) { this.address = value; return this; }
        public String getCity() { return city; }
        public WebshopOrderSummary setCity(String value) { this.city = value; return this; }
        public String getZipCode() { return zipCode; }
        public WebshopOrderSummary setZipCode(String value) { this.zipCode = value; return this; }
        public String getCountry() { return country; }
        public WebshopOrderSummary setCountry(String value) { this.country = value; return this; }
        public String getDeliveryType() { return deliveryType; }
        public WebshopOrderSummary setDeliveryType(String value) { this.deliveryType = value; return this; }
        public String getDroppOrderId() { return droppOrderId; }
        public WebshopOrderSummary setDroppOrderId(String value) { this.droppOrderId = value; return this; }
        public String getDroppLocationId() { return droppLocationId; }
        public WebshopOrderSummary setDroppLocationId(String value) { this.droppLocationId = value; return this; }
        public Boolean isNeedsDeliveryAttention() { return needsDeliveryAttention; }
        public WebshopOrderSummary setNeedsDeliveryAttention(Boolean value) { this.needsDeliveryAttention = value; return this; }
        public String getPaymentMethodId() { return paymentMethodId; }
        public WebshopOrderSummary setPaymentMethodId(String value) { this.paymentMethodId = value; return this; }
        public String getPaymentId() { return paymentId; }
        public WebshopOrderSummary setPaymentId(String value) { this.paymentId = value; return this; }
        public String getPaymentReference() { return paymentReference; }
        public WebshopOrderSummary setPaymentReference(String value) { this.paymentReference = value; return this; }
        public String getDiscountCode() { return discountCode; }
        public WebshopOrderSummary setDiscountCode(String value) { this.discountCode = value; return this; }
        public Integer getGiftPaidMinor() { return giftPaidMinor; }
        public WebshopOrderSummary setGiftPaidMinor(Integer value) { this.giftPaidMinor = value; return this; }
        public Date getCreatedAt() { return createdAt; }
        public WebshopOrderSummary setCreatedAt(Date value) { this.createdAt = value; return this; }
        public Date getUpdatedAt() { return updatedAt; }
        public WebshopOrderSummary setUpdatedAt(Date value) { this.updatedAt = value; return this; }
        public ArrayList<WebshopOrderLineSummary> getLines() { return lines; }
        public WebshopOrderSummary setLines(ArrayList<WebshopOrderLineSummary> value) { this.lines = value; return this; }
    }

    public static class WebshopOrderLineSummary
    {
        public Integer id = null;
        public Integer productId = null;
        public Integer variantId = null;
        public String productName = null;
        public String size = null;
        public String color = null;
        public Integer unitPriceMinor = null;
        public Integer quantity = null;
        public Integer lineTotalMinor = null;
        public String status = null;
        public Integer payoutInfoId = null;
        public String payoutTag = null;
        
        public Integer getId() { return id; }
        public WebshopOrderLineSummary setId(Integer value) { this.id = value; return this; }
        public Integer getProductId() { return productId; }
        public WebshopOrderLineSummary setProductId(Integer value) { this.productId = value; return this; }
        public Integer getVariantId() { return variantId; }
        public WebshopOrderLineSummary setVariantId(Integer value) { this.variantId = value; return this; }
        public String getProductName() { return productName; }
        public WebshopOrderLineSummary setProductName(String value) { this.productName = value; return this; }
        public String getSize() { return size; }
        public WebshopOrderLineSummary setSize(String value) { this.size = value; return this; }
        public String getColor() { return color; }
        public WebshopOrderLineSummary setColor(String value) { this.color = value; return this; }
        public Integer getUnitPriceMinor() { return unitPriceMinor; }
        public WebshopOrderLineSummary setUnitPriceMinor(Integer value) { this.unitPriceMinor = value; return this; }
        public Integer getQuantity() { return quantity; }
        public WebshopOrderLineSummary setQuantity(Integer value) { this.quantity = value; return this; }
        public Integer getLineTotalMinor() { return lineTotalMinor; }
        public WebshopOrderLineSummary setLineTotalMinor(Integer value) { this.lineTotalMinor = value; return this; }
        public String getStatus() { return status; }
        public WebshopOrderLineSummary setStatus(String value) { this.status = value; return this; }
        public Integer getPayoutInfoId() { return payoutInfoId; }
        public WebshopOrderLineSummary setPayoutInfoId(Integer value) { this.payoutInfoId = value; return this; }
        public String getPayoutTag() { return payoutTag; }
        public WebshopOrderLineSummary setPayoutTag(String value) { this.payoutTag = value; return this; }
    }

    public static class WebshopOrderTransaction
    {
        public Integer id = null;
        public Integer orderId = null;
        @StringLength(20)
        public String kind = null;

        public Integer amountMinor = null;
        @StringLength(50)
        public String paymentReference = null;

        @StringLength(300)
        public String note = null;

        @StringLength(100)
        public String idempotencyKey = null;

        public Date createdAt = null;
        @StringLength(100)
        public String createdBy = null;
        
        public Integer getId() { return id; }
        public WebshopOrderTransaction setId(Integer value) { this.id = value; return this; }
        public Integer getOrderId() { return orderId; }
        public WebshopOrderTransaction setOrderId(Integer value) { this.orderId = value; return this; }
        public String getKind() { return kind; }
        public WebshopOrderTransaction setKind(String value) { this.kind = value; return this; }
        public Integer getAmountMinor() { return amountMinor; }
        public WebshopOrderTransaction setAmountMinor(Integer value) { this.amountMinor = value; return this; }
        public String getPaymentReference() { return paymentReference; }
        public WebshopOrderTransaction setPaymentReference(String value) { this.paymentReference = value; return this; }
        public String getNote() { return note; }
        public WebshopOrderTransaction setNote(String value) { this.note = value; return this; }
        public String getIdempotencyKey() { return idempotencyKey; }
        public WebshopOrderTransaction setIdempotencyKey(String value) { this.idempotencyKey = value; return this; }
        public Date getCreatedAt() { return createdAt; }
        public WebshopOrderTransaction setCreatedAt(Date value) { this.createdAt = value; return this; }
        public String getCreatedBy() { return createdBy; }
        public WebshopOrderTransaction setCreatedBy(String value) { this.createdBy = value; return this; }
    }

}

Java WebshopOrderLedgerRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
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-01T00:00:00.0000000","updatedAt":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","createdBy":"String"}],"statusCode":0,"message":"String"}