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}

export class WebshopOrderLineSummary
{
    public id?: number;
    public productId?: number;
    public variantId?: number;
    public productName?: string;
    public size?: string;
    public color?: string;
    public unitPriceMinor?: number;
    public quantity?: number;
    public lineTotalMinor?: number;
    public status?: string;
    public payoutInfoId?: number;
    public payoutTag?: string;

    public constructor(init?: Partial<WebshopOrderLineSummary>) { (Object as any).assign(this, init); }
}

export class WebshopOrderSummary
{
    public id?: number;
    public orderReference?: string;
    public ownerId?: number;
    public status?: string;
    public totalMinor?: number;
    public deliveryFeeMinor?: number;
    public totalDiscountMinor?: number;
    public currency?: string;
    public buyerName?: string;
    public buyerEmail?: string;
    public buyerPhone?: string;
    public address?: string;
    public city?: string;
    public zipCode?: string;
    public country?: string;
    public deliveryType?: string;
    public droppOrderId?: string;
    public droppLocationId?: string;
    public needsDeliveryAttention?: boolean;
    public paymentMethodId?: string;
    public paymentId?: string;
    public paymentReference?: string;
    public discountCode?: string;
    public giftPaidMinor?: number;
    public createdAt?: string;
    public updatedAt?: string;
    public lines?: WebshopOrderLineSummary[];

    public constructor(init?: Partial<WebshopOrderSummary>) { (Object as any).assign(this, init); }
}

export class WebshopOrderTransaction
{
    public id?: number;
    public orderId?: number;
    // @StringLength(20)
    public kind?: string;

    public amountMinor?: number;
    // @StringLength(50)
    public paymentReference?: string;

    // @StringLength(300)
    public note?: string;

    // @StringLength(100)
    public idempotencyKey?: string;

    public createdAt?: string;
    // @StringLength(100)
    public createdBy?: string;

    public constructor(init?: Partial<WebshopOrderTransaction>) { (Object as any).assign(this, init); }
}

export class WebshopOrderLedgerResult
{
    public order?: WebshopOrderSummary;
    public transactions?: WebshopOrderTransaction[];
    public statusCode?: number;
    public message?: string;

    public constructor(init?: Partial<WebshopOrderLedgerResult>) { (Object as any).assign(this, init); }
}

export class WebshopOrderLedgerRequest
{
    public orderId?: number;
    public ownerId?: number;

    public constructor(init?: Partial<WebshopOrderLedgerRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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>