JSDoc: Class: module:models/Order

new module:models/Order()

Constructs a new Order. Document representing an order.

Source:

models/Order.js, line 49

Members

(readonly) ChannelTypeEnum :String

Allowed values for the channel_type property.

Type:

String

Source:

models/Order.js, line 394

(readonly) ConfirmationStatusEnum :String

Allowed values for the confirmation_status property.

Type:

String

Source:

models/Order.js, line 474

(readonly) ExportStatusEnum :String

Allowed values for the export_status property.

Type:

String

Source:

models/Order.js, line 494

(readonly) PaymentStatusEnum :String

Allowed values for the payment_status property.

Type:

String

Source:

models/Order.js, line 526

(readonly) ShippingStatusEnum :String

Allowed values for the shipping_status property.

Type:

String

Source:

models/Order.js, line 552

(readonly) StatusEnum :String

Allowed values for the status property.

Type:

String

Source:

models/Order.js, line 578

(readonly) TaxationEnum :String

Allowed values for the taxation property.

Type:

String

Source:

models/Order.js, line 628

(inner) adjusted_merchandize_total_tax :Number

The products tax after discounts applying in purchase currency. Adjusted merchandize prices represent the sum of product prices before services such as shipping have been added, but after adjustment from promotions have been added.

Type:

Number

Source:

models/Order.js, line 193

(inner) adjusted_shipping_total_tax :Number

The tax of all shipping line items of the line item container after shipping adjustments have been applied.

Type:

Number

Source:

models/Order.js, line 198

(inner) billing_address :module:models/OrderAddress

The billing address. This property is part of basket checkout information only.

Type:

module:models/OrderAddress

Source:

models/Order.js, line 203

(inner) bonus_discount_line_items :Array.<module:models/BonusDiscountLineItem>

The bonus discount line items of the line item container.

Type:

Array.<module:models/BonusDiscountLineItem>

Source:

models/Order.js, line 208

(inner, constant) callcenter

value: "callcenter"

Source:

models/Order.js, line 406

(inner, constant) cancelled

value: "cancelled"

Source:

models/Order.js, line 608

(inner) channel_type :module:models/Order.ChannelTypeEnum

The sales channel for the order.

Type:

module:models/Order.ChannelTypeEnum

Source:

models/Order.js, line 213

(inner, constant) completed

value: "completed"

Source:

models/Order.js, line 602

(inner) confirmation_status :module:models/Order.ConfirmationStatusEnum

The confirmation status of the order.

Type:

module:models/Order.ConfirmationStatusEnum

Source:

models/Order.js, line 218

(inner, constant) confirmed

value: "confirmed"

Source:

models/Order.js, line 486

(inner) coupon_items :Array.<module:models/CouponItem>

The sorted array of coupon items. This array can be empty.

Type:

Array.<module:models/CouponItem>

Source:

models/Order.js, line 223

(inner, constant) created

value: "created"

Source:

models/Order.js, line 584

(inner) created_by :String

The name of the user who created the order.

Type:

String

Source:

models/Order.js, line 228

(inner) creation_date :Date

Returns the value of attribute 'creationDate'.

Type:

Date

Source:

models/Order.js, line 233

(inner) currency :String

The ISO 4217 mnemonic code of the currency.

Type:

String

Source:

models/Order.js, line 238

(inner) customer_info :module:models/CustomerInfo

The customer information for logged in customers. This property is part of basket checkout information only.

Type:

module:models/CustomerInfo

Source:

models/Order.js, line 243

(inner) customer_name :String

The name of the customer associated with this order.

Type:

String

Source:

models/Order.js, line 248

(inner, constant) customerservicecenter

value: "customerservicecenter"

Source:

models/Order.js, line 460

(inner, constant) dss

value: "dss"

Source:

models/Order.js, line 418

(inner) export_status :module:models/Order.ExportStatusEnum

The export status of the order.

Type:

module:models/Order.ExportStatusEnum

Source:

models/Order.js, line 253

(inner, constant) exported

value: "exported"

Source:

models/Order.js, line 506

(inner) external_order_status :String

The external status of the order.

Type:

String

Source:

models/Order.js, line 258

(inner, constant) facebookads

value: "facebookads"

Source:

models/Order.js, line 442

(inner, constant) failed

value: "failed"

Source:

models/Order.js, line 518

(inner, constant) failed

value: "failed"

Source:

models/Order.js, line 620

(inner) gift_certificate_items :Array.<module:models/GiftCertificateItem>

The sorted array of gift certificate line items. This array can be empty.

Type:

Array.<module:models/GiftCertificateItem>

Source:

models/Order.js, line 263

(inner) global_party_id :String

globalPartyId is managed by Customer 360. Its value can be changed.

Type:

String

Source:

models/Order.js, line 268

(inner, constant) gross

value: "gross"

Source:

models/Order.js, line 634

(inner, constant) instagramcommerce

value: "instagramcommerce"

Source:

models/Order.js, line 466

(inner) last_modified :Date

Returns the value of attribute 'lastModified'.

Type:

Date

Source:

models/Order.js, line 273

(inner, constant) marketplace

value: "marketplace"

Source:

models/Order.js, line 412

(inner) merchandize_total_tax :Number

The products total tax in purchase currency. Merchandize total prices represent the sum of product prices before services such as shipping or adjustment from promotions have been added.

Type:

Number

Source:

models/Order.js, line 278

(inner, constant) net

value: "net"

Source:

models/Order.js, line 640

(inner, constant) new

value: "new"

Source:

models/Order.js, line 590

(inner, constant) not_confirmed

value: "not_confirmed"

Source:

models/Order.js, line 480

(inner, constant) not_exported

value: "not_exported"

Source:

models/Order.js, line 500

(inner, constant) not_paid

value: "not_paid"

Source:

models/Order.js, line 532

(inner, constant) not_shipped

value: "not_shipped"

Source:

models/Order.js, line 558

(inner) notes :module:models/SimpleLink

The notes for the line item container.

Type:

module:models/SimpleLink

Source:

models/Order.js, line 283

(inner, constant) onlinereservation

value: "onlinereservation"

Source:

models/Order.js, line 454

(inner, constant) open

value: "open"

Source:

models/Order.js, line 596

(inner) order_no :String

The order number of the order.

Type:

String

Source:

models/Order.js, line 288

(inner) order_price_adjustments :Array.<module:models/PriceAdjustment>

The array of order level price adjustments. This array can be empty.

Type:

Array.<module:models/PriceAdjustment>

Source:

models/Order.js, line 293

(inner) order_token :String

The order token used to secure the lookup of an order on base of the plain order number. The order token contains only URL safe characters.

Type:

String

Source:

models/Order.js, line 298

(inner) order_total :Number

The total price of the order, including products, shipping and tax. This property is part of basket checkout information only.

Type:

Number

Source:

models/Order.js, line 303

(inner, constant) paid

value: "paid"

Source:

models/Order.js, line 544

(inner, constant) part_paid

value: "part_paid"

Source:

models/Order.js, line 538

(inner, constant) part_shipped

value: "part_shipped"

Source:

models/Order.js, line 564

(inner) payment_instruments :Array.<module:models/OrderPaymentInstrument>

The payment instruments list for the order.

Type:

Array.<module:models/OrderPaymentInstrument>

Source:

models/Order.js, line 308

(inner) payment_status :module:models/Order.PaymentStatusEnum

The payment status of the order.

Type:

module:models/Order.PaymentStatusEnum

Source:

models/Order.js, line 313

(inner, constant) pinterest

value: "pinterest"

Source:

models/Order.js, line 430

(inner) product_items :Array.<module:models/ProductItem>

The sorted array of product items (up to a maximum of 50 items). This array can be empty.

Type:

Array.<module:models/ProductItem>

Source:

models/Order.js, line 318

(inner) product_sub_total :Number

The total price of all product items after all product discounts. Depending on taxation policy the returned price is net or gross.

Type:

Number

Source:

models/Order.js, line 323

(inner) product_total :Number

The total price of all product items after all product and order discounts. Depending on taxation policy the returned price is net or gross.

Type:

Number

Source:

models/Order.js, line 328

(inner, constant) ready

value: "ready"

Source:

models/Order.js, line 512

(inner, constant) replaced

value: "replaced"

Source:

models/Order.js, line 614

(inner) shipments :Array.<module:models/Shipment>

The array of shipments. This property is part of basket checkout information only.

Type:

Array.<module:models/Shipment>

Source:

models/Order.js, line 333

(inner, constant) shipped

value: "shipped"

Source:

models/Order.js, line 570

(inner) shipping_items :Array.<module:models/ShippingItem>

The sorted array of shipping items. This array can be empty.

Type:

Array.<module:models/ShippingItem>

Source:

models/Order.js, line 338

(inner) shipping_status :module:models/Order.ShippingStatusEnum

The shipping status of the order.

Type:

module:models/Order.ShippingStatusEnum

Source:

models/Order.js, line 343

(inner) shipping_total :Number

The total shipping price of the order after all shipping discounts. Excludes tax if taxation policy is net. Includes tax if taxation policy is gross. This property is part of basket checkout information only.

Type:

Number

Source:

models/Order.js, line 348

(inner) shipping_total_tax :Number

The tax of all shipping line items of the line item container before shipping adjustments have been applied.

Type:

Number

Source:

models/Order.js, line 353

(inner) site_id :String

The site where the order resides.

Type:

String

Source:

models/Order.js, line 358

(inner) source_code :String

Gets the source code assigned to this basket.

Type:

String

Source:

models/Order.js, line 363

(inner) status :module:models/Order.StatusEnum

The status of the order.

Type:

module:models/Order.StatusEnum

Source:

models/Order.js, line 368

(inner, constant) store

value: "store"

Source:

models/Order.js, line 424

(inner, constant) storefront

value: "storefront"

Source:

models/Order.js, line 400

(inner, constant) subscriptions

value: "subscriptions"

Source:

models/Order.js, line 448

(inner) tax_total :Number

The total tax amount of the order. This property is part of basket checkout information only.

Type:

Number

Source:

models/Order.js, line 373

(inner) taxation :module:models/Order.TaxationEnum

The taxation the line item container is based on.

Type:

module:models/Order.TaxationEnum

Source:

models/Order.js, line 378

(inner, constant) twitter

value: "twitter"

Source:

models/Order.js, line 436

Methods

(static) constructFromObject(data, obj) → {module:models/Order}

Constructs a Order from a plain JavaScript object, optionally creating a new instance. Copies all relevant properties from data to obj if supplied or a new instance if not.

Parameters:

Name	Type	Description
`data`	Object	The plain JavaScript object bearing properties of interest.
`obj`	module:models/Order	Optional instance to populate.

Source:

models/Order.js, line 67

Returns:

The populated Order instance.

Type: module:models/Order