The basket object

The baskets object allows you to manage shopping baskets that can be used to create Transactions.

Attributes

  • *id** integer The unique id for the basket object.
  • *customer** object
    The primary customer for the basket, an instance of the customer object.
  • *price** positive float or zero
    The subtotal price for the basket.
  • *fee** positive float or zero
    The fee value of the basket.
  • *discount** positive float or zero
    The total discount value of the basket.
  • *tax** positive float or zero
    The tax value of the basket.
  • *total** positive float or zero
    The total for the basket.
  • *due** positive float or zero
    The due amount for the basket.
  • *depositdue** _positive float or zero
    The deposit due, if active, amount for the basket.
  • *expired** boolean
    True if the basket has expired.
  • *expiresat** _timestamp
    The timestamp of when the basket expires.
  • *promotions** array_objects
    array of promotions applied to the basket, contains: basket promotion object.
  • *purchases** array_objects
    array of basket purchases, contains: basket purchase object.
  • *combinedtaxes_fees** _array_objects
    array of taxes and fees applied to the basket.