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

1 min

Model Parameters

EPiServer.ServiceApi.Commerce.Models.Order.ShipmentModel
- 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.

Shipment contains information about the particular shipment. Line Items will reference the shipment object they belong to.