Path parameters

• id string Required

Responses

• 200 application/json

  Order

  Hide response attributes Show response attributes object

  • id string Required
  • status string Required

    Current status of the order

    Values are order-placed, awaiting-supplier, awaiting-collection, dispatched, delivered, cancelled, refunded, or completed.

  • createdAt string(date-time) Required
  • orderDisp string Required
  • familyId string Required
  • familyName string Required
  • paid string Required

    Values are no, part-paid, or yes.

  • grossPrice integer Required
  • netPrice integer Required
  • discountAmount integer Required
  • taxAmount integer | null Required
  • totalTendered integer Required
  • totalDue integer Required
  • totalWithCredit integer Required

    Gross price minus total credits applied

  • totalRemaining integer Required

    Amount remaining to be paid (totalWithCredit - totalTendered)

  • creditSum integer Required

    Credit sum

  • subs array[object] Required
    Hide subs attributes Show subs attributes object

    • id string Required
    • createdAt string(date-time) Required
    • OrderSubDisp string Required
    • type string Required
    • status string Required

      Current status of the order

      Values are order-placed, awaiting-supplier, awaiting-collection, dispatched, delivered, cancelled, refunded, or completed.

    • paid string

      Values are no, part-paid, or yes.

    • grossPrice integer Required
    • netPrice integer Required
    • discountAmount integer Required
    • taxAmount integer | null Required
    • items array[object] Required
      Hide items attributes Show items attributes object

      • id string Required
      • status string Required

        Current status of the order

        Values are order-placed, awaiting-supplier, awaiting-collection, dispatched, delivered, cancelled, refunded, or completed.

      • createdAt string(date-time) Required
      • description string Required
      • type string Required
      • paid string Required

        Values are no, part-paid, or yes.

      • quantity integer Required
      • unitPrice integer Required
      • grossPrice integer Required
      • netPrice integer Required
      • discountAmount integer Required
      • taxAmount integer | null Required
      • maxCreditableAmount integer Required

        The maximum amount that can be credited for this item

      • dueAmount integer Required

        The amount left to pay

        Default value is 0.

      • creditSum integer Required

        The amount credited for this item

        Default value is 0.

      • entityId string | null Required

        A prefixed-id linking to another model

      • allowedStatuses array[string] Required

        Current status of the order

        Values are order-placed, awaiting-supplier, awaiting-collection, dispatched, delivered, cancelled, refunded, or completed.

      • meta object Required

        Additional metadata for the order item

        Hide meta attribute Show meta attribute object

        • attributes object

          Dynamic attributes with unknown keys and values

          Additional properties are allowed.

  • payments array[object] Required
    Hide payments attributes Show payments attributes object

    • id string Required

      Payment ID

    • method string Required

      For launch, we'll only be supporting "stripe" as a payment method. It makes sense to use the term Stripe here because we'll be displaying Stripe Elements on the frontend for it, and it gives us options in the future to expand to other payment methods (gocardless, for example))

      Values are account-credit, classpass, discount-code, stripe, or manual.

    • orderId string Required

      Order ID

    • orderItemId string | null Required

      Order item ID

    • amount integer Required
  • paymentSchedules array[object]
    Hide paymentSchedules attributes Show paymentSchedules attributes object

    • id string Required
    • orderItemId string Required
    • amount integer Required
    • paymentDate string(date) Required
    • status string Required

      Values are upcoming, due, overdue, failed, paid, or cancelled.

    • createdAt string(date-time) Required
• 403 application/json

  Not authorized

  Hide response attributes Show response attributes object

  Error schema

  • statusCode number Required

    Status Code

  • messages array[string] Required

    List of error messages

  • exception object

    Exception

• 422 application/json

  Validation error

  Hide response attributes Show response attributes object

  • statusCode number Required

    Status Code

  • messages array[string] Required

    List of error messages

  • exception object

    Exception