All Release Notes

Updated structure for HTTP API documentation

23 November 2023
Announcement
General

We've reorganized our HTTP API documentation to better accommodate our growing number of APIs. The new structure is tailored to make navigation more intuitive, improving productivity and facilitating a more effective integration and use of our APIs.

A key highlight is the increased visibility of our performance tips. These tips are now readily accessible in the API reference, providing you with valuable insights for optimizing your use of our APIs.

Changes:

  • [Doc] Renamed the following chapters:
    • General Topics to API fundamentals
    • Carts, Orders & Shopping Lists to Cart and order management
    • Customize Data and Customize Behavior to API extensibility
  • [Doc] Moved the following pages:
    • Authorization, Scopes to API fundamentals > Security and privacy
    • Performance tips to API fundamentals
    • GDPR compliance to API fundamentals > Security and privacy
    • Discount Predicates and Discount Predicate Field Identifiers to Pricing and Discounts
    • Client logging to API fundamentals > General concepts
    • Tax Categories to API fundamentals > Project configuration
    • Authorization and Scopes to API fundamentals > Security and privacy
    • API Clients to API fundamentals > Security and privacy
    • All Me endpoints to Customers > Me endpoints
    • Configuration to API fundamentals > Project configuration
    • State Machines API extensibility > States
    • Quotes to Cart and order management > Quotes
    • Shipping Methods and Zones to Cart and order management > Shipping