Skip to main content

Creating Orders

The Partner API supports bank transfer payments only. When you create bulk orders, assignment orders, or kit orders through the API, invoices will be automatically sent to your registered partner billing email address.

Ordering Flows​

There are two main ordering flows available through the API:

Standard orders are the most common and efficient ordering flow. With standard orders, you purchase both the kits and assignments upfront, then receive tokens that can be used to create assignment orders for free later.

Benefits:

  • Pay for everything upfront
  • Receive assignment tokens for future use
  • No additional charges when creating assignments
  • Better cost management and planning

Process:

  1. Create a standard order specifying the number of kits needed
  2. Pay via bank transfer (invoice sent automatically)
  3. Receive assignment tokens equivalent to the number of kits ordered
  4. Use tokens when creating assignment orders (no additional charges)

Example workflow:

POST /orders
{
  "numberOfKits": 50,
  "paymentType": "bank-transfer"
}

You'll receive 50 assignment tokens that can be used for future assignments at no additional cost.

2. Kit Orders (Alternative Flow)​

Kit orders involve purchasing just the physical kits initially, then paying for assignments separately as you need them.

Process:

  1. Order kits through the kit endpoint
  2. Pay for kits via bank transfer (invoice sent automatically)
  3. Later, create assignment orders and pay for each assignment separately

When to use:

  • When you need physical kits immediately but assignments later
  • For smaller, more frequent ordering
  • When you prefer to pay for assignments as needed

Example workflow:

POST /kits
{
  "numberOfKits": 10
}

Then later, when creating assignments:

POST /assignments
{
  "sets": [...],
  "paymentType": "bank-transfer"
}

Each assignment will generate a separate invoice.

Payment and Invoicing​

  • Payment Method: Bank transfer only
  • Automatic Invoicing: Invoices are automatically sent to your registered billing email for all order types
  • Manual Approval: Kit orders require manual approval from our team
  • Billing:
    • Bulk orders: Single invoice for kits + assignments
    • Kit orders: Separate invoices for kits and each assignment batch

Getting Started​

  1. Set up your billing email in your partner profile
  2. Generate API keys from your partner dashboard
  3. Choose your preferred ordering flow based on your business needs
  4. Start with bulk orders for the most streamlined experience

For detailed API specifications and examples, refer to the full API documentation.