Change Updates

Do not miss any Referspecs API changes, ever again

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

RSS

May 8, 2025

main
1.0.0
Compare

API structure has changed

Next change
9 structure changes including:
2 Breaking changes
1 Addition
6 Modifications
2 Removals
Modified 6 Breaking
DELETE /products/{id}
  • Response
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 204 response Added
GET /products
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type went from object to array[object]
        Breaking
      • object, data, has_more, url properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • Product property Added
  • Query
  • limit, active query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /products/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id property Modified
        • Permission is now readOnly
        • Property is now required
          Breaking
      • name property Modified
        • Property is now required
          Breaking
      • object, active, created, default_price, images, livemode, metadata, package_dimensions, shippable, statement_descriptor, tax_code, unit_label, updated, url properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • image, price properties Added
POST /message/guest
  • Body
  • application/json content type Modified
    • prompt property Modified
      • Property is now required
        Breaking
    • history property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • serial, message, from, summary properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • response property Added
POST /message/logged-in
  • Body
  • application/json content type Modified
    • prompt property Modified
      • Property is now required
        Breaking
    • history property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • serial, message, from, summary properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • response property Added
POST /products
  • Body
  • application/json content type Modified
    • id, active, default_price_data, images, metadata, package_dimensions, shippable, statement_descriptor, tax_code, unit_label, url properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • image, price properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • id property Modified
        • Permission is now readOnly
        • Property is now required
          Breaking
      • name property Modified
        • Property is now required
          Breaking
      • object, active, created, default_price, images, livemode, metadata, package_dimensions, shippable, statement_descriptor, tax_code, unit_label, updated, url properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • image, price properties Added
Removed 2 Breaking
GET /products/search
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /products/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
PATCH /products/{id}