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

Changelog

Last update:
Compare
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
1 structure change including:
1 Breaking change
1 Removal
Removed 1 Breaking
POST /upload
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
3 structure changes including:
1 Addition
2 Modifications
Modified 2 Breaking
GET /certificates/{certificate}
  • Path went from /certificates/{order} to /certificates/{certificate} (same operationId)
  • Response
  • 200 response Modified
    • image/svg+xml content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • application/json content type Added
  • 404 response Added
  • Path
  • order path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • certificate path parameter Added
GET /orders/{order}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • organization property Modified
Added 1
GET /certificates/{certificate}/image
2 structure changes including:
2 Modifications
Modified 2 Breaking
GET /orders/{order}
  • Response
  • 401 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /orgs/{organization}
  • Response
  • 401 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking