Change Updates

Do not miss any Class Manager API changes, ever again

Subscribe to the Class Manager API changelog to be up to date on recent changes.

RSS
Class Manager

May 7, 2025

dev
dev
Compare

API structure has changed

34 structure changes including:
1 Breaking change
22 Additions
12 Modifications
Modified 12 Breaking
GET /v1/integrations/stripe/{familyId}/payment-intents/{entityId}/get
  • Path went from /v1/integrations/stripe/{familyId}/payment-intents/{transactionDetail} to /v1/integrations/stripe/{familyId}/payment-intents/{entityId}/get (same operationId)
    Breaking
  • Path
  • transactionDetail path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • entityId path parameter Added
GET /v1/transactions/
  • Query
  • where query parameter Modified
    • orderId query parameter Added
      • DateFilterSchema, TextFilterSchema, NumberFilterSchema, DecimalFilterSchema, SelectFilterSchema, MultiSelectFilterSchema, BooleanFilterSchema query parameters Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • transaction property Modified
POST /v1/basket/{familyId}/checkout
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • orderId property Added
POST /v1/integrations/stripe/{familyId}/payment-intents/capture/{paymentIntentId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • orderId property Added
POST /v1/integrations/stripe/{familyId}/payment-intents/charge-payment-method
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • orderId property Added
POST /v1/integrations/stripe/{familyId}/refunds/{transactionDetailId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • orderId property Added
POST /v1/payment-links/{paymentLinkId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • aggregateTransaction property Modified
        • transaction property Modified
POST /v1/payment-links/{paymentLinkId}/process
  • Response
  • 200 response Modified
    • application/json content type Modified
      • debitAggregateTransaction property Modified
        • transaction property Modified
      • creditAggregateTransaction property Modified
        • transaction property Modified
POST /v1/transactions/create-custom
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • orderId property Added
POST /v1/transactions/create-from-season
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • orderId property Added
POST /v1/transactions/create-manual-payment
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • orderId property Added
POST /v1/transactions/{transaction}/create-credit-note
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • orderId property Added
Added 22
POST /v1/shop/products/archive
POST /v1/shop/product/
POST /v1/shop/category
POST /v1/order/update
POST /v1/checkout/prepare-payment
DELETE /v1/shop/category/{id}
GET /v1/order/{id}
GET /v1/orders
GET /v1/shop/category
GET /v1/shop/companyproducts
GET /v1/shop/product-recommendations
GET /v1/shop/product/{id}
GET /v1/shop/products
POST /v1/basket
POST /v1/basket/add-drop-in-to-basket
POST /v1/basket/add-enrolment-to-basket
POST /v1/basket/add-product-to-basket
POST /v1/basket/remove-drop-in-from-basket
POST /v1/basket/remove-enrolment-from-basket
POST /v1/basket/remove-product-from-basket
POST /v1/checkout
POST /v1/checkout/finalise