Model: shipment

1 min

Model Parameters

shipment
- 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.