storefrontapp documentation
  1. Interfaces
  2. Order

File

projects/core/src/model/order.model.ts

Index

Properties

Properties

appliedOrderPromotions
appliedOrderPromotions: PromotionResult[]
Type : PromotionResult[]
Optional
appliedProductPromotions
appliedProductPromotions: PromotionResult[]
Type : PromotionResult[]
Optional
appliedVouchers
appliedVouchers: Voucher[]
Type : Voucher[]
Optional
calculated
calculated: boolean
Type : boolean
Optional
cancellable
cancellable: boolean
Type : boolean
Optional
code
code: string
Type : string
Optional
consignments
consignments: Consignment[]
Type : Consignment[]
Optional
costCenter
costCenter: CostCenter
Type : CostCenter
Optional
created
created: Date
Type : Date
Optional
deliveryAddress
deliveryAddress: Address
Type : Address
Optional
deliveryCost
deliveryCost: Price
Type : Price
Optional
deliveryItemsQuantity
deliveryItemsQuantity: number
Type : number
Optional
deliveryMode
deliveryMode: DeliveryMode
Type : DeliveryMode
Optional
deliveryOrderGroups
deliveryOrderGroups: DeliveryOrderEntryGroup[]
Type : DeliveryOrderEntryGroup[]
Optional
deliveryStatus
deliveryStatus: string
Type : string
Optional
deliveryStatusDisplay
deliveryStatusDisplay: string
Type : string
Optional
entries
entries: OrderEntry[]
Type : OrderEntry[]
Optional
guestCustomer
guestCustomer: boolean
Type : boolean
Optional
guid
guid: string
Type : string
Optional
net
net: boolean
Type : boolean
Optional
orderDiscounts
orderDiscounts: Price
Type : Price
Optional
orgCustomer
orgCustomer: B2BUser
Type : B2BUser
Optional
paymentInfo
paymentInfo: PaymentDetails
Type : PaymentDetails
Optional
pickupItemsQuantity
pickupItemsQuantity: number
Type : number
Optional
pickupOrderGroups
pickupOrderGroups: PickupOrderEntryGroup[]
Type : PickupOrderEntryGroup[]
Optional
productDiscounts
productDiscounts: Price
Type : Price
Optional
purchaseOrderNumber
purchaseOrderNumber: string
Type : string
Optional
returnable
returnable: boolean
Type : boolean
Optional
site
site: string
Type : string
Optional
status
status: string
Type : string
Optional
statusDisplay
statusDisplay: string
Type : string
Optional
store
store: string
Type : string
Optional
subTotal
subTotal: Price
Type : Price
Optional
totalDiscounts
totalDiscounts: Price
Type : Price
Optional
totalItems
totalItems: number
Type : number
Optional
totalPrice
totalPrice: Price
Type : Price
Optional
totalPriceWithTax
totalPriceWithTax: Price
Type : Price
Optional
totalTax
totalTax: Price
Type : Price
Optional
unconsignedEntries
unconsignedEntries: OrderEntry[]
Type : OrderEntry[]
Optional
user
user: Principal
Type : Principal
Optional 
import { Address } from './address.model';
import {
  DeliveryOrderEntryGroup,
  PaymentDetails,
  Principal,
  PromotionResult,
  Voucher,
} from './cart.model';
import { PaginationModel, SortModel } from './misc.model';
import { B2BUser, CostCenter } from './org-unit.model';
import { PointOfService } from './point-of-service.model';
import { Price, Product } from './product.model';

export interface DeliveryMode {
  code?: string;
  deliveryCost?: Price;
  description?: string;
  name?: string;
}

export interface OrderEntry {
  orderCode?: string;
  basePrice?: Price;
  deliveryMode?: DeliveryMode;
  deliveryPointOfService?: PointOfService;
  entryNumber?: number;
  product?: Product;
  quantity?: number;
  totalPrice?: Price;
  updateable?: boolean;
  returnedItemsPrice?: Price;
  returnableQuantity?: number;
  cancelledItemsPrice?: Price;
  cancellableQuantity?: number;
  promotions?: PromotionResult[];
}

export interface CancelOrReturnRequestEntryInput {
  orderEntryNumber?: number;
  quantity?: number;
}

export interface ReturnRequestEntryInputList {
  orderCode?: string;
  returnRequestEntryInputs?: CancelOrReturnRequestEntryInput[];
}

export interface CancellationRequestEntryInputList {
  cancellationRequestEntryInputs?: CancelOrReturnRequestEntryInput[];
}

export interface ReturnRequestEntry {
  orderEntry?: OrderEntry;
  expectedQuantity?: number;
  refundAmount?: Price;
}

export interface ReturnRequest {
  cancellable?: boolean;
  code?: string;
  creationTime?: Date;
  deliveryCost?: Price;
  order?: Order;
  refundDeliveryCost?: boolean;
  returnEntries?: ReturnRequestEntry[];
  returnLabelDownloadUrl?: string;
  rma?: string;
  status?: string;
  subTotal?: Price;
  totalPrice?: Price;
}

export interface ReturnRequestList {
  returnRequests?: ReturnRequest[];
  pagination?: PaginationModel;
  sorts?: SortModel[];
}

export interface ReturnRequestModification {
  status?: string;
}

export interface PickupOrderEntryGroup {
  deliveryPointOfService?: PointOfService;
  distance?: number;
  entries?: OrderEntry[];
  quantity?: number;
  totalPriceWithTax?: Price;
}

export interface PromotionOrderEntryConsumed {
  adjustedUnitPrice?: number;
  code?: string;
  orderEntryNumber?: number;
  quantity?: number;
}

export interface ConsignmentEntry {
  orderEntry?: OrderEntry;
  quantity?: number;
  shippedQuantity?: number;
}

export interface Consignment {
  code?: string;
  deliveryPointOfService?: PointOfService;
  entries?: ConsignmentEntry[];
  shippingAddress?: Address;
  status?: string;
  statusDate?: Date;
  trackingID?: string;
}

export interface OrderHistory {
  code?: string;
  guid?: string;
  placed?: Date;
  status?: string;
  statusDisplay?: string;
  total?: Price;
}

export interface OrderHistoryList {
  orders?: OrderHistory[];
  pagination?: PaginationModel;
  sorts?: SortModel[];
}

export interface Order {
  appliedOrderPromotions?: PromotionResult[];
  appliedProductPromotions?: PromotionResult[];
  appliedVouchers?: Voucher[];
  calculated?: boolean;
  code?: string;
  consignments?: Consignment[];
  costCenter?: CostCenter;
  created?: Date;
  deliveryAddress?: Address;
  deliveryCost?: Price;
  deliveryItemsQuantity?: number;
  deliveryMode?: DeliveryMode;
  deliveryOrderGroups?: DeliveryOrderEntryGroup[];
  deliveryStatus?: string;
  deliveryStatusDisplay?: string;
  entries?: OrderEntry[];
  guestCustomer?: boolean;
  guid?: string;
  net?: boolean;
  orderDiscounts?: Price;
  orgCustomer?: B2BUser;
  paymentInfo?: PaymentDetails;
  pickupItemsQuantity?: number;
  pickupOrderGroups?: PickupOrderEntryGroup[];
  productDiscounts?: Price;
  purchaseOrderNumber?: string;
  site?: string;
  status?: string;
  statusDisplay?: string;
  store?: string;
  subTotal?: Price;
  totalDiscounts?: Price;
  totalItems?: number;
  totalPrice?: Price;
  totalPriceWithTax?: Price;
  totalTax?: Price;
  unconsignedEntries?: OrderEntry[];
  user?: Principal;
  returnable?: boolean;
  cancellable?: boolean;
}

result-matching ""

    No results matching ""