2 · Build your catalog

Orders are built from products, so set up what you sell first.

Endpoints: Products · Taxes · Discounts · Fees · Groups · Units


Steps

  1. Optional: create groups and units to organise products: POST /product_groups, POST /product_units.
  2. Create the taxes, discounts and fees you'll use: POST /product_taxes, POST /product_discounts, POST /product_fees.
  3. Optional: preview a product's totals before saving it: POST /products/calculate.
  4. Create each product: POST /products. Set its type, price and currency, and attach a tax, fee or discount by ID.
flowchart LR
  GU["Groups & units
  (optional)"] --> Product
  TDF["Taxes, discounts
  & fees"] --> Product
  Product["Product
  POST /products"] --> Line["Used on
  order lines"]

Good to know

  • A product's type sets how it's paid: single_payment, instalment, subscription or metered.
  • Tax is included in the price, not added on top.
  • Only fixed-amount fees are supported right now.
  • To stop selling a product, set its product_status to inactive. It stays on existing orders.

Next

Continue to 3 · Create customers & orders.