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 .xml suffix or ?format=xml

HTTP + 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>