Versioning

This API serves 2 versions at once. The version is part of the path, so a request names the version it wants.

Versions#

New integrations should use v2.

v2 compared with v1#

New in v2:

• PATCH /api/v2/customers/{customer} — Update a customer
• DELETE /api/v2/customers/{customer} — Delete a customer
• GET /api/v2/orders/{order} — Retrieve an order
• POST /api/v2/orders/{order}/refunds — Refund an order
• GET /api/v2/products/{product} — Retrieve a product
• GET /api/v2/webhooks — List webhook endpoints
• POST /api/v2/webhooks — Register a webhook endpoint

In v1 but not in v2:

• GET /api/v1/products/search — Search products

The other 8 operations exist in both versions at the same path. Each one's page links to its newer edition.

What changed in the operations both versions have:

• GET /api/v2/customers — List customers
  • accepts a new optional query parameter q
• POST /api/v2/orders — Create an order
  • requires a new header parameter Idempotency-Key