Model: OrderApiModel

1 min

Model Parameters

OrderApiModel
- OrderNumberstring
  Description
  The order number.
- CustomerIdstring<uuid>
  Example
  00000000-0000-0000-0000-000000000000
  Description
  The customer the order belongs to.
  Format
  uuid
- Marketstring
  Description
  The market in which the order was placed.
- Currencystring
  Description
  The currency of the market in which the order was placed.
- ShipmentsShipmentModel[]
  Description
  The shipments of the order.
  - Idstring<uuid>
    Example
    00000000-0000-0000-0000-000000000000
    Description
    The shipping id.
    Format
    uuid
  - ShippingAddressAddressModel
    Description
    Represents a customer address todo: associate with commerce customers via business foundation? todo: add more properties.
    - FirstNamestring
      Description
      The first name.
    - LastNamestring
      Description
      The last name.
    - Line1string
      Description
      The line1.
    - Line2string
      Description
      The line2.
    - Citystring
      Description
      The city.
    - CountryNamestring
      Description
      The country name.
    - PostalCodestring
      Description
      The postal code
    - RegionNamestring
      Description
      The region name/state
    - Emailstring
      Description
      The email.
    - PhoneNumberstring
      Description
      The phone number.
  - ShippingMethodIdstring<uuid>
    Example
    00000000-0000-0000-0000-000000000000
    Description
    The shipping method id.
    Format
    uuid
  - LineItemsLineItemModel[]
    Description
    the line items that belong to the cart.
    - Idstring<uuid>
      Example
      00000000-0000-0000-0000-000000000000
      Description
      The line item id.
      Format
      uuid
    - ContentIdstring<uuid>
      Example
      00000000-0000-0000-0000-000000000000
      Description
      The content id.
      Format
      uuid
    - Codestring
      Description
      The sku code.
    - PlacedPricenumber<decimal>
      Description
      The placed price.
      Format
      decimal
    - Quantitynumber<decimal>required
      Description
      The quantity.
      Format
      decimal
    - DisplayNamestring
      Description
      The display name.
    - IsGiftboolean
      Description
      Indicates whether the line item is a gift item.
- TotalsTotalsModel
  Description
  Represents cart totals.
  - Totalnumber<decimal>
    Description
    The total.
    Format
    decimal
  - SubTotalnumber<decimal>
    Description
    The subtotal.
    Format
    decimal
  - ShippingTotalnumber<decimal>
    Description
    The shipping total.
    Format
    decimal
  - HandlingTotalnumber<decimal>
    Description
    The handling total.
    Format
    decimal
  - TaxTotalnumber<decimal>
    Description
    The tax total.
    Format
    decimal
  - DiscountTotalnumber<decimal>
    Description
    The order form discount total.
    Format
    decimal
  - ShippingTotalsShippingTotalsModel[]
    Description
    The shipping totals.
    - ShipmentIdstring<uuid>
      Example
      00000000-0000-0000-0000-000000000000
      Description
      The shipping id.
      Format
      uuid
    - ShippingCostnumber<decimal>
      Description
      The shipping cost.
      Format
      decimal
    - ShippingTaxnumber<decimal>
      Description
      The shipping tax.
      Format
      decimal
    - ItemsTotalnumber<decimal>
      Description
      The extended price total for the line items in the shipment.
      Format
      decimal
    - LineItemPricesLineItemPricesModel[]
      Description
      The line item prices.
      - LineItemIdstring<uuid>
        Example
        00000000-0000-0000-0000-000000000000
        Description
        The line item id.
        Format
        uuid
      - ExtendedPricenumber<decimal>
        Description
        The extended price.
        Format
        decimal
      - DiscountedPricenumber<decimal>
        Description
        The discounted price.
        Format
        decimal

Represents a purchase order.