Change Updates

Do not miss any Partner API changes, ever again

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

RSS
Partner API

Jan 12, 2025

main
2.0.0
Compare

API structure has changed

3 structure changes including:
3 Modifications
Modified 3 Breaking
GET /certificates/{certificate}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • brand property Modified
        • Type went from string(slug) to string(slug) | null
      • personalisedMessage property Modified
        • Type went from string to string | null
      • numberOfUnits property Modified
        • Property is now required
          Breaking
      • unit property Modified
        • photos property Modified
          • Type went from array to object | null
            Breaking
        • species property Modified
          • Type went from string to string | null
      • event property Modified
        • Type went from object to object | null
GET /orders/{order}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • organization property Modified
        • logo property Modified
          • Type went from string(url) to string(url) | null
      • allocatedUnits property Modified
        • photos property Modified
          • Type went from array to object | null
            Breaking
POST /shopify/webhook/orders/paid
  • Body
  • application/json content type Modified
    • id property Modified
      • Type went from string to integer
        Breaking