Trendsic Platform Service

<back to all web services

OrderHeadersRequest

The following routes are available for this service:
GET/v1/OrderHeaders/{ID}
GET,POST,OPTIONS/v1/OrderHeaders
POST/v1/OrderHeaders/Agent/{AgentID}
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class Address implements IConvertible
{
    int? ID;
    int? AddressTypeID;
    String? AddressContact;
    String? AttentionTo;
    String? AddressLine1;
    String? AddressLine2;
    String? AddressLine3;
    String? AddressCity;
    String? AddressState;
    String? AddressZip;
    String? AddressCountry;
    String? PhoneNumber;
    String? FaxNumber;
    String? UID;
    String? Name;

    Address({this.ID,this.AddressTypeID,this.AddressContact,this.AttentionTo,this.AddressLine1,this.AddressLine2,this.AddressLine3,this.AddressCity,this.AddressState,this.AddressZip,this.AddressCountry,this.PhoneNumber,this.FaxNumber,this.UID,this.Name});
    Address.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ID = json['ID'];
        AddressTypeID = json['AddressTypeID'];
        AddressContact = json['AddressContact'];
        AttentionTo = json['AttentionTo'];
        AddressLine1 = json['AddressLine1'];
        AddressLine2 = json['AddressLine2'];
        AddressLine3 = json['AddressLine3'];
        AddressCity = json['AddressCity'];
        AddressState = json['AddressState'];
        AddressZip = json['AddressZip'];
        AddressCountry = json['AddressCountry'];
        PhoneNumber = json['PhoneNumber'];
        FaxNumber = json['FaxNumber'];
        UID = json['UID'];
        Name = json['Name'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ID': ID,
        'AddressTypeID': AddressTypeID,
        'AddressContact': AddressContact,
        'AttentionTo': AttentionTo,
        'AddressLine1': AddressLine1,
        'AddressLine2': AddressLine2,
        'AddressLine3': AddressLine3,
        'AddressCity': AddressCity,
        'AddressState': AddressState,
        'AddressZip': AddressZip,
        'AddressCountry': AddressCountry,
        'PhoneNumber': PhoneNumber,
        'FaxNumber': FaxNumber,
        'UID': UID,
        'Name': Name
    };

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

class OrderHeader implements IConvertible
{
    int? ID;
    int? AgentID;
    int? CustomerID;
    String? AgentName;
    String? CustomerName;
    DateTime? OrderDate;
    int? OrderStatus;
    String? OrderStatusText;
    int? TotalQuantityUnits;
    double? TotalOrderCost;
    double? TotalProductCost;
    double? TotalOrderTax;
    double? TotalShippingCost;
    int? BillingAddressID;
    int? ShippingAddressID;
    double? CustomerPaidAmount;
    String? Notes;
    String? UID;
    bool? Recalculate;
    String? PublicOrderID;
    String? Address;
    Address? ShippingAddress;
    Address? BillingAddress;
    bool? isMultiShip;

    OrderHeader({this.ID,this.AgentID,this.CustomerID,this.AgentName,this.CustomerName,this.OrderDate,this.OrderStatus,this.OrderStatusText,this.TotalQuantityUnits,this.TotalOrderCost,this.TotalProductCost,this.TotalOrderTax,this.TotalShippingCost,this.BillingAddressID,this.ShippingAddressID,this.CustomerPaidAmount,this.Notes,this.UID,this.Recalculate,this.PublicOrderID,this.Address,this.ShippingAddress,this.BillingAddress,this.isMultiShip});
    OrderHeader.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ID = json['ID'];
        AgentID = json['AgentID'];
        CustomerID = json['CustomerID'];
        AgentName = json['AgentName'];
        CustomerName = json['CustomerName'];
        OrderDate = JsonConverters.fromJson(json['OrderDate'],'DateTime',context!);
        OrderStatus = json['OrderStatus'];
        OrderStatusText = json['OrderStatusText'];
        TotalQuantityUnits = json['TotalQuantityUnits'];
        TotalOrderCost = JsonConverters.toDouble(json['TotalOrderCost']);
        TotalProductCost = JsonConverters.toDouble(json['TotalProductCost']);
        TotalOrderTax = JsonConverters.toDouble(json['TotalOrderTax']);
        TotalShippingCost = JsonConverters.toDouble(json['TotalShippingCost']);
        BillingAddressID = json['BillingAddressID'];
        ShippingAddressID = json['ShippingAddressID'];
        CustomerPaidAmount = JsonConverters.toDouble(json['CustomerPaidAmount']);
        Notes = json['Notes'];
        UID = json['UID'];
        Recalculate = json['Recalculate'];
        PublicOrderID = json['PublicOrderID'];
        Address = json['Address'];
        ShippingAddress = JsonConverters.fromJson(json['ShippingAddress'],'Address',context!);
        BillingAddress = JsonConverters.fromJson(json['BillingAddress'],'Address',context!);
        isMultiShip = json['isMultiShip'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ID': ID,
        'AgentID': AgentID,
        'CustomerID': CustomerID,
        'AgentName': AgentName,
        'CustomerName': CustomerName,
        'OrderDate': JsonConverters.toJson(OrderDate,'DateTime',context!),
        'OrderStatus': OrderStatus,
        'OrderStatusText': OrderStatusText,
        'TotalQuantityUnits': TotalQuantityUnits,
        'TotalOrderCost': TotalOrderCost,
        'TotalProductCost': TotalProductCost,
        'TotalOrderTax': TotalOrderTax,
        'TotalShippingCost': TotalShippingCost,
        'BillingAddressID': BillingAddressID,
        'ShippingAddressID': ShippingAddressID,
        'CustomerPaidAmount': CustomerPaidAmount,
        'Notes': Notes,
        'UID': UID,
        'Recalculate': Recalculate,
        'PublicOrderID': PublicOrderID,
        'Address': Address,
        'ShippingAddress': JsonConverters.toJson(ShippingAddress,'Address',context!),
        'BillingAddress': JsonConverters.toJson(BillingAddress,'Address',context!),
        'isMultiShip': isMultiShip
    };

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

class OrderHeadersResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    List<OrderHeader>? OrderHeaders = [];

    OrderHeadersResponse({this.ResponseStatus,this.OrderHeaders});
    OrderHeadersResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        OrderHeaders = JsonConverters.fromJson(json['OrderHeaders'],'List<OrderHeader>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'OrderHeaders': JsonConverters.toJson(OrderHeaders,'List<OrderHeader>',context!)
    };

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

class OrderHeadersRequest implements IConvertible
{
    String? AgentID;
    List<OrderHeader>? OrderHeaders = [];

    OrderHeadersRequest({this.AgentID,this.OrderHeaders});
    OrderHeadersRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        AgentID = json['AgentID'];
        OrderHeaders = JsonConverters.fromJson(json['OrderHeaders'],'List<OrderHeader>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'AgentID': AgentID,
        'OrderHeaders': JsonConverters.toJson(OrderHeaders,'List<OrderHeader>',context!)
    };

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

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'Address': TypeInfo(TypeOf.Class, create:() => Address()),
    'OrderHeader': TypeInfo(TypeOf.Class, create:() => OrderHeader()),
    'OrderHeadersResponse': TypeInfo(TypeOf.Class, create:() => OrderHeadersResponse()),
    'List<OrderHeader>': TypeInfo(TypeOf.Class, create:() => <OrderHeader>[]),
    'OrderHeadersRequest': TypeInfo(TypeOf.Class, create:() => OrderHeadersRequest()),
});

Dart OrderHeadersRequest DTOs

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

HTTP + OTHER

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

POST /v1/OrderHeaders HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"AgentID":"00000000000000000000000000000000","OrderHeaders":[{"ID":0,"AgentID":0,"CustomerID":0,"AgentName":"String","CustomerName":"String","OrderDate":"0001-01-01T00:00:00.0000000","OrderStatus":0,"OrderStatusText":"String","TotalQuantityUnits":0,"TotalOrderCost":0,"TotalProductCost":0,"TotalOrderTax":0,"TotalShippingCost":0,"BillingAddressID":0,"ShippingAddressID":0,"CustomerPaidAmount":0,"Notes":"String","UID":"00000000000000000000000000000000","Recalculate":false,"PublicOrderID":"String","Address":"String","ShippingAddress":{"ID":0,"AddressTypeID":0,"AddressContact":"String","AttentionTo":"String","AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","AddressCity":"String","AddressState":"String","AddressZip":"String","AddressCountry":"String","PhoneNumber":"String","FaxNumber":"String","UID":"00000000000000000000000000000000","Name":"String"},"BillingAddress":{"ID":0,"AddressTypeID":0,"AddressContact":"String","AttentionTo":"String","AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","AddressCity":"String","AddressState":"String","AddressZip":"String","AddressCountry":"String","PhoneNumber":"String","FaxNumber":"String","UID":"00000000000000000000000000000000","Name":"String"},"isMultiShip":false}]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"OrderHeaders":[{"ID":0,"AgentID":0,"CustomerID":0,"AgentName":"String","CustomerName":"String","OrderDate":"0001-01-01T00:00:00.0000000","OrderStatus":0,"OrderStatusText":"String","TotalQuantityUnits":0,"TotalOrderCost":0,"TotalProductCost":0,"TotalOrderTax":0,"TotalShippingCost":0,"BillingAddressID":0,"ShippingAddressID":0,"CustomerPaidAmount":0,"Notes":"String","UID":"00000000000000000000000000000000","Recalculate":false,"PublicOrderID":"String","Address":"String","ShippingAddress":{"ID":0,"AddressTypeID":0,"AddressContact":"String","AttentionTo":"String","AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","AddressCity":"String","AddressState":"String","AddressZip":"String","AddressCountry":"String","PhoneNumber":"String","FaxNumber":"String","UID":"00000000000000000000000000000000","Name":"String"},"BillingAddress":{"ID":0,"AddressTypeID":0,"AddressContact":"String","AttentionTo":"String","AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","AddressCity":"String","AddressState":"String","AddressZip":"String","AddressCountry":"String","PhoneNumber":"String","FaxNumber":"String","UID":"00000000000000000000000000000000","Name":"String"},"isMultiShip":false}]}