Model: checkout

1 min

Model Parameters

checkout
- cartcart
  Description
  Represents a cart.
  - idinteger<int32>
    Description
    The cart id.
    Format
    int32
  - namestringrequired
    Description
    The cart name.
  - customerIdstring<uuid>
    Description
    The customer the cart belongs to.
    Format
    uuid
  - marketstringrequired
    Description
    The market in which the cart is valid.
  - currencystringrequired
    Description
    The currency of the market in which the cart is valid.
  - lastUpdatedstring<date-time>
    Description
    The last updated timestamp.
    Format
    date-time
  - shipmentsshipment[]
    Description
    The shipments.
    - idinteger<int32>
      Description
      The shipping id.
      Format
      int32
    - shippingAddressaddress
      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.
      - countryCodestring
        Description
        The country code.
      - postalCodestring
        Description
        The postal code
      - regionNamestring
        Description
        The region name/state
      - emailstring
        Description
        The email.
      - phoneNumberstring
        Description
        The phone number.
      - namestring
        Description
        The name.
    - shippingMethodIdstring<uuid>
      Description
      The shipping method id.
      Format
      uuid
    - lineItemslineItem[]
      Description
      the line items that belong to the cart.
      - idinteger<int32>
        Description
        The line item id.
        Format
        int32
      - contentIdstring<uuid>
        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.
  - paymentspayment[]
    Description
    The payments.
    - amountnumber<decimal>
      Description
      Gets or sets the amount.
      Format
      decimal
    - authorizationCodestring
      Description
      Gets or sets the authorization code.
    - billingAddressaddress
      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.
      - countryCodestring
        Description
        The country code.
      - postalCodestring
        Description
        The postal code
      - regionNamestring
        Description
        The region name/state
      - emailstring
        Description
        The email.
      - phoneNumberstring
        Description
        The phone number.
      - namestring
        Description
        The name.
    - savedBillingAddressNamestring
      Description
      Gets or sets the billing address.
    - customerNamestring
      Description
      Gets or sets the name of the customer.
    - paymentIdinteger<int32>
      Description
      Gets the payment identifier.
      Format
      int32
    - systemKeywordstring
      Description
      Gets or sets the name of the payment method.
    - paymentTypestring
      Description
      Gets or sets the type of the payment.
    - providerTransactionIDstring
      Description
      Gets or sets the provider transaction identifier.
    - statusstring
      Description
      Gets or sets the status.
    - transactionIDstring
      Description
      Gets or sets the transaction identifier.
    - transactionTypestring
      Description
      Gets or sets the type of the transaction.
    - validationCodestring
      Description
      Gets or sets the validation code.
    - extendedPropertiesextendedProperty[]
      Description
      Custom properties added by partner or customer.
      - namestring
        Description
        Name of the property
      - valuestring
        Description
        The property value.
  - couponCodesstring[]
    Description
    The coupon codes.
- totalstotals
  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
  - shippingTotalsshippingTotals[]
    Description
    The shipping totals.
    - shipmentIdinteger<int32>
      Description
      The shipping id.
      Format
      int32
    - 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
    - lineItemPriceslineItemPrices[]
      Description
      The line item prices.
      - lineItemIdinteger<int32>
        Description
        The line item id.
        Format
        int32
      - extendedPricenumber<decimal>
        Description
        The extended price.
        Format
        decimal
      - discountedPricenumber<decimal>
        Description
        The discounted price.
        Format
        decimal
- availableShippingMethodsshippingMethod[]
  Description
  The available shipping methods per shipment.
  - shipmentIdinteger<int32>
    Description
    The shipping id.
    Format
    int32
  - idstring<uuid>
    Description
    The id.
    Format
    uuid
  - displayNamestring
    Description
    The display name.
  - pricenumber<decimal>
    Description
    The price.
    Format
    decimal
- validationIssueslineItemValidation[]
  Description
  The validation issues per line item.
  - contentIdstring<uuid>
    Description
    The content id.
    Format
    uuid
  - codestring
    Description
    The sku code.
  - validationIssuesstring[]
    Description
    The validation issues.

Represents the response data for cart operations.