Model: EPiServer.ServiceApi.Commerce.Models.Order.OrderFormModel

1 min

Model Parameters

EPiServer.ServiceApi.Commerce.Models.Order.OrderFormModel
- ShipmentsEPiServer.ServiceApi.Commerce.Models.Order.ShipmentModel[]
  Description
  Gets or sets the shipments.
  - DiscountsModelEPiServer.ServiceApi.Commerce.Models.Order.DiscountModel[]
    Description
    Gets the discounts.
    - DiscountIdinteger<int32>
      Description
      Gets or sets the discount id.
      Format
      int32
    - DiscountAmountnumber<double>
      Description
      Gets or sets the discount amount. Either fixed money value or percentage.
      Format
      double
    - DiscountCodestring
      Description
      Gets or sets the discount code. Also known as a coupon code.
    - DiscountNamestring
      Description
      Gets or sets the name of the discount.
    - DisplayMessagestring
      Description
      Gets or sets the display message.
    - DiscountValuenumber<double>
      Description
      Gets or sets the discount amount. The amount of discount that was applied. It will equal to DiscountAmount if it is a fixed monetary value. For the percentage based discount this value will be different.
      Format
      double
  - ShipmentIdinteger<int32>
    Description
    Gets the shipment id.
    Format
    int32
  - ShippingMethodIdstring<uuid>
    Example
    00000000-0000-0000-0000-000000000000
    Description
    Gets or sets the shipping method id.
    Format
    uuid
  - ShippingMethodNamestring
    Description
    Gets or sets the name of the shipping method.
  - ShippingTaxnumber<double>
    Description
    Gets or sets the shipment tax.
    Format
    double
  - ShippingAddressIdstring
    Description
    Gets or sets the shipping address name.
  - ShipmentTrackingNumberstring
    Description
    Gets or sets the shipment tracking number.
  - ShippingDiscountAmountnumber<double>
    Description
    Gets or sets the shipping discount amount.
    Format
    double
  - ShippingSubTotalnumber<double>
    Description
    Gets or sets the shipping sub total.
    Format
    double
  - ShippingTotalnumber<double>
    Description
    Gets or sets the total shipping cost, including shipping discounts (if any) and shipping tax.
    Format
    double
  - Statusstring
    Description
    Gets or sets the status.
  - PrevStatusstring
    Description
    Gets or sets the previous status.
  - PickListIdinteger<int32>
    Description
    Gets or sets the pick list id.
    Format
    int32
  - SubTotalnumber<double>
    Description
    Gets or sets the sub total.
    Format
    double
  - WarehouseCodestring
    Description
    Gets or sets the warehouse code.
  - LineItemsEPiServer.ServiceApi.Commerce.Models.Order.LineItemModel[]
    Description
    Gets or sets the collection of line items.
    - LineItemIdinteger<int32>
      Description
      Gets the identity of the line item.
      Format
      int32
    - Codestring
      Description
      Gets the code of the variation content the line item represent. This property works as the connection between the line item and the variation content.
    - DisplayNamestring
      Description
      Gets or sets the display name.
    - PlacedPricenumber<double>
      Description
      Gets the price for one item that this line item represent. This property don't take any discounts in consideration.
      Format
      double
    - ExtendedPricenumber<double>
      Description
      Gets the extended price for the line item. Includes order-level discount amount (which is spread over all line items in the shipment) and the line item discount amount.
      Format
      double
    - DiscountedPricenumber<double>
      Description
      Gets the line item discounted price. Only calculates the price with the "line item discount amount," that is, the discount for a specific item.
      Format
      double
    - Quantitynumber<double>
      Description
      Gets or sets the number of items this line item contains.
      Format
      double
    - ReturnQuantitynumber<double>
      Description
      Gets or sets the returned in stock quantity.
      Format
      double
    - InventoryTrackingStatusinteger<int32>
      Description
      Gets or sets the inventory tracking status on whether to check inventory.
      Format
      int32
      Allowed
      01
    - IsInventoryAllocatedboolean
      Description
      Gets or sets a value indicating whether this instance has allocated inventory for the {EPiServer.Commerce.Order.ILineItem.Quantity}.
    - IsGiftboolean
      Description
      Gets or sets a value indicating whether the line item is a gift item.
    - PropertiesEPiServer.ServiceApi.Commerce.Models.Order.PropertyItemModel[]
      Description
      Gets the list of key value pairs for dealing with custom properties.
      - Keystring
        Description
        Key of the property.
      - Valuestring
        Description
        Value of the property.
  - PropertiesEPiServer.ServiceApi.Commerce.Models.Order.PropertyItemModel[]
    Description
    Gets or sets the list of key value pairs for dealing with custom properties.
    - Keystring
      Description
      Key of the property.
    - Valuestring
      Description
      Value of the property.
- LineItemsEPiServer.ServiceApi.Commerce.Models.Order.LineItemModel[]
  Description
  Gets or sets the line items.
  - LineItemIdinteger<int32>
    Description
    Gets the identity of the line item.
    Format
    int32
  - Codestring
    Description
    Gets the code of the variation content the line item represent. This property works as the connection between the line item and the variation content.
  - DisplayNamestring
    Description
    Gets or sets the display name.
  - PlacedPricenumber<double>
    Description
    Gets the price for one item that this line item represent. This property don't take any discounts in consideration.
    Format
    double
  - ExtendedPricenumber<double>
    Description
    Gets the extended price for the line item. Includes order-level discount amount (which is spread over all line items in the shipment) and the line item discount amount.
    Format
    double
  - DiscountedPricenumber<double>
    Description
    Gets the line item discounted price. Only calculates the price with the "line item discount amount," that is, the discount for a specific item.
    Format
    double
  - Quantitynumber<double>
    Description
    Gets or sets the number of items this line item contains.
    Format
    double
  - ReturnQuantitynumber<double>
    Description
    Gets or sets the returned in stock quantity.
    Format
    double
  - InventoryTrackingStatusinteger<int32>
    Description
    Gets or sets the inventory tracking status on whether to check inventory.
    Format
    int32
    Allowed
    01
  - IsInventoryAllocatedboolean
    Description
    Gets or sets a value indicating whether this instance has allocated inventory for the {EPiServer.Commerce.Order.ILineItem.Quantity}.
  - IsGiftboolean
    Description
    Gets or sets a value indicating whether the line item is a gift item.
  - PropertiesEPiServer.ServiceApi.Commerce.Models.Order.PropertyItemModel[]
    Description
    Gets the list of key value pairs for dealing with custom properties.
    - Keystring
      Description
      Key of the property.
    - Valuestring
      Description
      Value of the property.
- PaymentsEPiServer.ServiceApi.Commerce.Models.Order.PaymentModel[]
  - Amountnumber<double>
    Format
    double
  - AuthorizationCodestring
  - BillingAddressIdstring
  - CustomerNamestring
  - ImplementationClassstring
  - PaymentIdinteger<int32>
    Format
    int32
  - PaymentMethodIdstring<uuid>
    Example
    00000000-0000-0000-0000-000000000000
    Format
    uuid
  - PaymentMethodNamestring
  - PaymentTypeModelinteger<int32>
    Format
    int32
    Allowed
    012345
  - Statusstring
  - TransactionTypestring
  - ValidationCodestring
  - PropertiesEPiServer.ServiceApi.Commerce.Models.Order.PropertyItemModel[]
    Description
    Custom property item.
    - Keystring
      Description
      Key of the property.
    - Valuestring
      Description
      Value of the property.
- DiscountsEPiServer.ServiceApi.Commerce.Models.Order.DiscountModel[]
  Description
  Gets or sets the discounts.
  - DiscountIdinteger<int32>
    Description
    Gets or sets the discount id.
    Format
    int32
  - DiscountAmountnumber<double>
    Description
    Gets or sets the discount amount. Either fixed money value or percentage.
    Format
    double
  - DiscountCodestring
    Description
    Gets or sets the discount code. Also known as a coupon code.
  - DiscountNamestring
    Description
    Gets or sets the name of the discount.
  - DisplayMessagestring
    Description
    Gets or sets the display message.
  - DiscountValuenumber<double>
    Description
    Gets or sets the discount amount. The amount of discount that was applied. It will equal to DiscountAmount if it is a fixed monetary value. For the percentage based discount this value will be different.
    Format
    double
- ReturnCommentstring
  Description
  Gets or sets the rma comment.
- ReturnTypestring
  Description
  Gets or sets the Return Type. For example can be "Refund", "Exchange" etc.
- ReturnAuthCodestring
  Description
  Gets or sets the RMA auth code. Using for procedure RMA authentications.
- OrderFormIdinteger<int32>
  Description
  Gets the order form id.
  Format
  int32
- Namestring
  Description
  Gets or sets the name.
- BillingAddressIdstring
  Description
  Gets or sets the billing address id. The id is the name of the address in OrderAddress collection.
- ShippingTotalnumber<double>
  Description
  Gets or sets the shipping total, does not includes discounts that have been applied to each shipment.
  Format
  double
- HandlingTotalnumber<double>
  Description
  Gets or sets the handling total.
  Format
  double
- TaxTotalnumber<double>
  Description
  Gets or sets the tax total.
  Format
  double
- DiscountAmountnumber<double>
  Description
  Gets or sets the discount amount. This amount includes shipping discounts as well.
  Format
  double
- SubTotalnumber<double>
  Description
  Gets or sets the sub total.
  Format
  double
- Totalnumber<double>
  Description
  Gets or sets the total.
  Format
  double
- Statusstring
  Description
  Gets or sets the status.
- RmaNumberstring
  Description
  Gets or sets the RMA number.
- AuthorizedPaymentTotalnumber<double>
  Description
  Gets or sets the authorized payment total.
  Format
  double
- CapturedPaymentTotalnumber<double>
  Description
  Gets or sets the captured payment total.
  Format
  double
- PropertiesEPiServer.ServiceApi.Commerce.Models.Order.PropertyItemModel[]
  Description
  Gets the list of key value pairs for dealing with custom properties.
  - Keystring
    Description
    Key of the property.
  - Valuestring
    Description
    Value of the property.

Contains the order information.