TicketUserServices

<back to all web services

WebshopOrderGetRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdmin, MobileAppRequires the permission:ReadData
The following routes are available for this service:
GET/Webshop/Order/{Reference}
import 'package:servicestack/servicestack.dart';

class LocalizedMessage implements IConvertible
{
    String? Is;
    String? en;

    LocalizedMessage({this.Is,this.en});
    LocalizedMessage.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Is = json['is'];
        en = json['en'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'is': Is,
        'en': en
    };

    getTypeName() => "LocalizedMessage";
    TypeContext? context = _ctx;
}

class WebshopOrderLineSummary implements IConvertible
{
    int? id;
    int? productId;
    int? variantId;
    String? productName;
    String? size;
    String? color;
    int? unitPriceMinor;
    int? quantity;
    int? lineTotalMinor;
    String? status;
    int? payoutInfoId;
    String? payoutTag;

    WebshopOrderLineSummary({this.id,this.productId,this.variantId,this.productName,this.size,this.color,this.unitPriceMinor,this.quantity,this.lineTotalMinor,this.status,this.payoutInfoId,this.payoutTag});
    WebshopOrderLineSummary.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        productId = json['productId'];
        variantId = json['variantId'];
        productName = json['productName'];
        size = json['size'];
        color = json['color'];
        unitPriceMinor = json['unitPriceMinor'];
        quantity = json['quantity'];
        lineTotalMinor = json['lineTotalMinor'];
        status = json['status'];
        payoutInfoId = json['payoutInfoId'];
        payoutTag = json['payoutTag'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'productId': productId,
        'variantId': variantId,
        'productName': productName,
        'size': size,
        'color': color,
        'unitPriceMinor': unitPriceMinor,
        'quantity': quantity,
        'lineTotalMinor': lineTotalMinor,
        'status': status,
        'payoutInfoId': payoutInfoId,
        'payoutTag': payoutTag
    };

    getTypeName() => "WebshopOrderLineSummary";
    TypeContext? context = _ctx;
}

class WebshopOrderSummary implements IConvertible
{
    int? id;
    String? orderReference;
    int? ownerId;
    String? status;
    int? totalMinor;
    int? deliveryFeeMinor;
    int? totalDiscountMinor;
    String? currency;
    String? buyerName;
    String? buyerEmail;
    String? buyerPhone;
    String? address;
    String? city;
    String? zipCode;
    String? country;
    String? deliveryType;
    String? droppOrderId;
    String? droppLocationId;
    bool? needsDeliveryAttention;
    String? paymentMethodId;
    String? paymentId;
    String? paymentReference;
    String? discountCode;
    int? giftPaidMinor;
    DateTime? createdAt;
    DateTime? updatedAt;
    List<WebshopOrderLineSummary>? lines;

    WebshopOrderSummary({this.id,this.orderReference,this.ownerId,this.status,this.totalMinor,this.deliveryFeeMinor,this.totalDiscountMinor,this.currency,this.buyerName,this.buyerEmail,this.buyerPhone,this.address,this.city,this.zipCode,this.country,this.deliveryType,this.droppOrderId,this.droppLocationId,this.needsDeliveryAttention,this.paymentMethodId,this.paymentId,this.paymentReference,this.discountCode,this.giftPaidMinor,this.createdAt,this.updatedAt,this.lines});
    WebshopOrderSummary.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        orderReference = json['orderReference'];
        ownerId = json['ownerId'];
        status = json['status'];
        totalMinor = json['totalMinor'];
        deliveryFeeMinor = json['deliveryFeeMinor'];
        totalDiscountMinor = json['totalDiscountMinor'];
        currency = json['currency'];
        buyerName = json['buyerName'];
        buyerEmail = json['buyerEmail'];
        buyerPhone = json['buyerPhone'];
        address = json['address'];
        city = json['city'];
        zipCode = json['zipCode'];
        country = json['country'];
        deliveryType = json['deliveryType'];
        droppOrderId = json['droppOrderId'];
        droppLocationId = json['droppLocationId'];
        needsDeliveryAttention = json['needsDeliveryAttention'];
        paymentMethodId = json['paymentMethodId'];
        paymentId = json['paymentId'];
        paymentReference = json['paymentReference'];
        discountCode = json['discountCode'];
        giftPaidMinor = json['giftPaidMinor'];
        createdAt = JsonConverters.fromJson(json['createdAt'],'DateTime',context!);
        updatedAt = JsonConverters.fromJson(json['updatedAt'],'DateTime',context!);
        lines = JsonConverters.fromJson(json['lines'],'List<WebshopOrderLineSummary>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'orderReference': orderReference,
        'ownerId': ownerId,
        'status': status,
        'totalMinor': totalMinor,
        'deliveryFeeMinor': deliveryFeeMinor,
        'totalDiscountMinor': totalDiscountMinor,
        'currency': currency,
        'buyerName': buyerName,
        'buyerEmail': buyerEmail,
        'buyerPhone': buyerPhone,
        'address': address,
        'city': city,
        'zipCode': zipCode,
        'country': country,
        'deliveryType': deliveryType,
        'droppOrderId': droppOrderId,
        'droppLocationId': droppLocationId,
        'needsDeliveryAttention': needsDeliveryAttention,
        'paymentMethodId': paymentMethodId,
        'paymentId': paymentId,
        'paymentReference': paymentReference,
        'discountCode': discountCode,
        'giftPaidMinor': giftPaidMinor,
        'createdAt': JsonConverters.toJson(createdAt,'DateTime',context!),
        'updatedAt': JsonConverters.toJson(updatedAt,'DateTime',context!),
        'lines': JsonConverters.toJson(lines,'List<WebshopOrderLineSummary>',context!)
    };

    getTypeName() => "WebshopOrderSummary";
    TypeContext? context = _ctx;
}

class WebshopOrderResult implements IConvertible
{
    bool? success;
    String? reason;
    LocalizedMessage? message;
    String? orderReference;
    WebshopOrderSummary? order;
    int? statusCode;

    WebshopOrderResult({this.success,this.reason,this.message,this.orderReference,this.order,this.statusCode});
    WebshopOrderResult.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        success = json['success'];
        reason = json['reason'];
        message = JsonConverters.fromJson(json['message'],'LocalizedMessage',context!);
        orderReference = json['orderReference'];
        order = JsonConverters.fromJson(json['order'],'WebshopOrderSummary',context!);
        statusCode = json['statusCode'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'success': success,
        'reason': reason,
        'message': JsonConverters.toJson(message,'LocalizedMessage',context!),
        'orderReference': orderReference,
        'order': JsonConverters.toJson(order,'WebshopOrderSummary',context!),
        'statusCode': statusCode
    };

    getTypeName() => "WebshopOrderResult";
    TypeContext? context = _ctx;
}

class WebshopOrderGetRequest implements IConvertible
{
    String? reference;
    int? ownerId;

    WebshopOrderGetRequest({this.reference,this.ownerId});
    WebshopOrderGetRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        reference = json['reference'];
        ownerId = json['ownerId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'reference': reference,
        'ownerId': ownerId
    };

    getTypeName() => "WebshopOrderGetRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'stubbur_app.azurewebsites.net', types: <String, TypeInfo> {
    'LocalizedMessage': TypeInfo(TypeOf.Class, create:() => LocalizedMessage()),
    'WebshopOrderLineSummary': TypeInfo(TypeOf.Class, create:() => WebshopOrderLineSummary()),
    'WebshopOrderSummary': TypeInfo(TypeOf.Class, create:() => WebshopOrderSummary()),
    'List<WebshopOrderLineSummary>': TypeInfo(TypeOf.Class, create:() => <WebshopOrderLineSummary>[]),
    'WebshopOrderResult': TypeInfo(TypeOf.Class, create:() => WebshopOrderResult()),
    'WebshopOrderGetRequest': TypeInfo(TypeOf.Class, create:() => WebshopOrderGetRequest()),
});

Dart WebshopOrderGetRequest DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Webshop/Order/{Reference} HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"success":false,"reason":"String","message":{"is":"String","en":"String"},"orderReference":"String","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"}]},"statusCode":0}