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}
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using TicketUserServices.ServiceModel;
using TicketUserServices.ServiceModel.Types;

namespace TicketUserServices.ServiceModel
{
    public partial class WebshopOrderLedgerRequest
    {
        public virtual int OrderId { get; set; }
        public virtual int? OwnerId { get; set; }
    }

    public partial class WebshopOrderLedgerResult
    {
        public WebshopOrderLedgerResult()
        {
            Transactions = new List<WebshopOrderTransaction>{};
        }

        public virtual WebshopOrderSummary Order { get; set; }
        public virtual List<WebshopOrderTransaction> Transactions { get; set; }
        public virtual int StatusCode { get; set; }
        public virtual string Message { get; set; }
    }

    public partial class WebshopOrderLineSummary
    {
        public virtual int ID { get; set; }
        public virtual int ProductId { get; set; }
        public virtual int VariantId { get; set; }
        public virtual string ProductName { get; set; }
        public virtual string Size { get; set; }
        public virtual string Color { get; set; }
        public virtual int UnitPriceMinor { get; set; }
        public virtual int Quantity { get; set; }
        public virtual int LineTotalMinor { get; set; }
        public virtual string Status { get; set; }
        public virtual int? PayoutInfoId { get; set; }
        public virtual string PayoutTag { get; set; }
    }

    public partial class WebshopOrderSummary
    {
        public WebshopOrderSummary()
        {
            Lines = new List<WebshopOrderLineSummary>{};
        }

        public virtual int ID { get; set; }
        public virtual string OrderReference { get; set; }
        public virtual int OwnerId { get; set; }
        public virtual string Status { get; set; }
        public virtual int TotalMinor { get; set; }
        public virtual int DeliveryFeeMinor { get; set; }
        public virtual int TotalDiscountMinor { get; set; }
        public virtual string Currency { get; set; }
        public virtual string BuyerName { get; set; }
        public virtual string BuyerEmail { get; set; }
        public virtual string BuyerPhone { get; set; }
        public virtual string Address { get; set; }
        public virtual string City { get; set; }
        public virtual string ZipCode { get; set; }
        public virtual string Country { get; set; }
        public virtual string DeliveryType { get; set; }
        public virtual string DroppOrderId { get; set; }
        public virtual string DroppLocationId { get; set; }
        public virtual bool NeedsDeliveryAttention { get; set; }
        public virtual string PaymentMethodId { get; set; }
        public virtual string PaymentId { get; set; }
        public virtual string PaymentReference { get; set; }
        public virtual string DiscountCode { get; set; }
        public virtual int GiftPaidMinor { get; set; }
        public virtual DateTime CreatedAt { get; set; }
        public virtual DateTime UpdatedAt { get; set; }
        public virtual List<WebshopOrderLineSummary> Lines { get; set; }
    }

}

namespace TicketUserServices.ServiceModel.Types
{
    public partial class WebshopOrderTransaction
    {
        public virtual int ID { get; set; }
        public virtual int OrderId { get; set; }
        [StringLength(20)]
        public virtual string Kind { get; set; }

        public virtual int AmountMinor { get; set; }
        [StringLength(50)]
        public virtual string PaymentReference { get; set; }

        [StringLength(300)]
        public virtual string Note { get; set; }

        [StringLength(100)]
        public virtual string IdempotencyKey { get; set; }

        public virtual DateTime CreatedAt { get; set; }
        [StringLength(100)]
        public virtual string CreatedBy { get; set; }
    }

}

C# WebshopOrderLedgerRequest DTOs

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

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