Change Updates

Do not miss any Enjovia API changes, ever again

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

RSS
Enjovia API

Changelog

Last update:
Compare
17 structure changes including:
17 Modifications
Modified 17
GET /orders
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • redeemables, vouchers properties Modified
GET /orders/{order}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • redeemables, vouchers properties Modified
GET /terminal/redeemables/{redeemable}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • redeem_locations property Added
GET /terminal/search/vouchers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • redeemables property Modified
GET /vouchers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • redeemables property Modified
GET /vouchers/{voucher}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • redeemables property Modified
PATCH /orders/{order}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • redeemables, vouchers properties Modified
POST /orders/{order}/notes
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • redeemables, vouchers properties Modified
POST /orders/{order}/resend-vouchers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • vouchers property Modified
POST /redeemables/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • redeem_locations property Added
POST /redeemables/unredeem
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • redeem_locations property Added
POST /redeemables/{redeemable}/top-up
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • redeem_locations property Added
POST /redeemables/{redeemable}/update-validity
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • redeem_locations property Added
POST /terminal/basket/order
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • redeemables, vouchers properties Modified
POST /terminal/redeemables/redeem
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • redeem_locations property Added
POST /terminal/redeemables/redeem/undo
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • redeem_locations property Added
POST /vouchers/resend/email
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • vouchers property Modified
3.2.12
18 structure changes including:
18 Modifications
Modified 18
GET /orders
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tags, transaction, redeemables, vouchers properties Modified
GET /orders/{order}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tags, transaction, redeemables, vouchers properties Modified
GET /terminal/redeemables/{redeemable}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tags property Modified
GET /terminal/search/vouchers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • redeemables property Modified
GET /vouchers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • redeemables property Modified
GET /vouchers/{voucher}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • redeemables property Modified
PATCH /orders/{order}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tags, transaction, redeemables, vouchers properties Modified
PATCH /transactions/{transaction}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • discounts, tax_percentages properties Modified
POST /orders/{order}/notes
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • tags, transaction, redeemables, vouchers properties Modified
POST /orders/{order}/resend-vouchers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • vouchers property Modified
POST /redeemables/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tags property Modified
POST /redeemables/unredeem
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tags property Modified
POST /redeemables/{redeemable}/top-up
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tags property Modified
POST /redeemables/{redeemable}/update-validity
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tags property Modified
POST /terminal/basket/order
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • tags, transaction, redeemables, vouchers properties Modified
POST /terminal/redeemables/redeem
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tags property Modified
POST /terminal/redeemables/redeem/undo
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tags property Modified
POST /vouchers/resend/email
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • vouchers property Modified
3.2.9
21 structure changes including:
21 Modifications
Modified 21 Breaking
GET /orders
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tags, transaction, redeemables, vouchers properties Modified
GET /orders/{order}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tags, transaction, redeemables, vouchers properties Modified
GET /terminal/redeemables/{redeemable}
  • Header
  • Redeem-Location-ID header Modified
    • Header is now required
      Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tags property Modified
GET /terminal/search/vouchers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • redeemables property Modified
  • Header
  • Redeem-Location-ID header Added
GET /vouchers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • redeemables property Modified
GET /vouchers/{voucher}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • redeemables property Modified
PATCH /orders/{order}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tags, transaction, redeemables, vouchers properties Modified
PATCH /transactions/{transaction}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • discounts, tax_percentages properties Modified
POST /orders/{order}/notes
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • tags, transaction, redeemables, vouchers properties Modified
POST /orders/{order}/resend-vouchers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • vouchers property Modified
POST /redeemables/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tags property Modified
POST /redeemables/unredeem
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tags property Modified
POST /redeemables/{redeemable}/top-up
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tags property Modified
POST /redeemables/{redeemable}/update-validity
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tags property Modified
POST /terminal/basket/check-promotions
  • Header
  • Store-Subdomain header Modified
    • Header is now required
      Breaking
POST /terminal/basket/order
  • Header
  • Store-Subdomain header Modified
    • Header is now required
      Breaking
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • tags, transaction, redeemables, vouchers properties Modified
POST /terminal/basket/promotion/code
  • Header
  • Store-Subdomain header Modified
    • Header is now required
      Breaking
POST /terminal/basket/validate
  • Header
  • Store-Subdomain header Modified
    • Header is now required
      Breaking
POST /terminal/redeemables/redeem
  • Header
  • Redeem-Location-ID header Modified
    • Header is now required
      Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tags property Modified
POST /terminal/redeemables/redeem/undo
  • Header
  • Redeem-Location-ID header Modified
    • Header is now required
      Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tags property Modified
POST /vouchers/resend/email
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • vouchers property Modified
3.2.8
21 structure changes including:
21 Modifications
Modified 21 Breaking
GET /orders
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tags, transaction, redeemables, vouchers properties Modified
GET /orders/{order}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tags, transaction, redeemables, vouchers properties Modified
GET /terminal/redeemables/{redeemable}
  • Header
  • Redeem-Location-ID header Modified
    • Header is no longer required
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tags property Modified
GET /terminal/search/vouchers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • redeemables property Modified
  • Header
  • Redeem-Location-ID header Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /vouchers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • redeemables property Modified
GET /vouchers/{voucher}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • redeemables property Modified
PATCH /orders/{order}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tags, transaction, redeemables, vouchers properties Modified
PATCH /transactions/{transaction}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • discounts, tax_percentages properties Modified
POST /orders/{order}/notes
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • tags, transaction, redeemables, vouchers properties Modified
POST /orders/{order}/resend-vouchers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • vouchers property Modified
POST /redeemables/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tags property Modified
POST /redeemables/unredeem
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tags property Modified
POST /redeemables/{redeemable}/top-up
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tags property Modified
POST /redeemables/{redeemable}/update-validity
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tags property Modified
POST /terminal/basket/check-promotions
  • Header
  • Store-Subdomain header Modified
    • Header is no longer required
POST /terminal/basket/order
  • Header
  • Store-Subdomain header Modified
    • Header is no longer required
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • tags, transaction, redeemables, vouchers properties Modified
POST /terminal/basket/promotion/code
  • Header
  • Store-Subdomain header Modified
    • Header is no longer required
POST /terminal/basket/validate
  • Header
  • Store-Subdomain header Modified
    • Header is no longer required
POST /terminal/redeemables/redeem
  • Header
  • Redeem-Location-ID header Modified
    • Header is no longer required
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tags property Modified
POST /terminal/redeemables/redeem/undo
  • Header
  • Redeem-Location-ID header Modified
    • Header is no longer required
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tags property Modified
POST /vouchers/resend/email
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • vouchers property Modified
8 structure changes including:
8 Modifications
Modified 8 Breaking
GET /terminal/redeemables/{redeemable}
  • Header
  • Redeem-Location-ID header Modified
    • Header is now required
      Breaking
GET /terminal/search/vouchers
  • Header
  • Redeem-Location-ID header Modified
    • Header is now required
      Breaking
POST /terminal/basket/check-promotions
  • Header
  • Store-Subdomain header Modified
    • Header is now required
      Breaking
POST /terminal/basket/order
  • Header
  • Store-Subdomain header Modified
    • Header is now required
      Breaking
POST /terminal/basket/promotion/code
  • Header
  • Store-Subdomain header Modified
    • Header is now required
      Breaking
POST /terminal/basket/validate
  • Header
  • Store-Subdomain header Modified
    • Header is now required
      Breaking
POST /terminal/redeemables/redeem
  • Header
  • Redeem-Location-ID header Modified
    • Header is now required
      Breaking
POST /terminal/redeemables/redeem/undo
  • Header
  • Redeem-Location-ID header Modified
    • Header is now required
      Breaking
1 structure change including:
1 Modification
Modified 1
GET /terminal/search/vouchers
  • Header
  • Redeem-Location-ID header Added
3.2.8
9 structure changes including:
2 Additions
7 Modifications
Modified 7
GET /orders
  • Query
  • sort, filter[tags][] query parameters Added
GET /orders/{order}/history
  • Query
  • sort query parameter Added
GET /orders/{order}/notes
  • Query
  • sort query parameter Added
GET /products
  • Query
  • filter[currency_code], filter[type], filter[is_active], filter[status], filter[categories.id][], filter[categories.slug], filter[stores.id][], filter[tags][], filter[has_activation_schedule], filter[has_deactivation_schedule], sort query parameters Added
GET /promotions
  • Query
  • filter[currency_code], filter[has_codes], filter[stores.id][], filter[tags][], filter[has_activation_schedule], filter[has_deactivation_schedule], sort query parameters Added
GET /redeem-locations
  • Query
  • filter[tags][], sort query parameters Added
GET /stores
  • Query
  • filter[currency_code], filter[is_live], filter[payment_gateway], filter[tags][], sort query parameters Added
Added 2
GET /vouchers
GET /vouchers/{voucher}
1 structure change including:
1 Addition
Added 1
GET /promotions
22 structure changes including:
3 Breaking changes
3 Additions
16 Modifications
3 Removals
Modified 16 Breaking
POST /vouchers/resend/email
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • vouchers property Modified
POST /terminal/redeemables/redeem/undo
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • valid_days property Modified
          • Type went from integer | null to array[string] | null
            Breaking
POST /terminal/redeemables/redeem
  • Body
  • application/json content type Modified
    • redeemable_ids, quantity properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • redeemables property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • valid_days property Modified
          • Type went from integer | null to array[string] | null
            Breaking
POST /terminal/basket/validate
  • Body
  • application/json content type Modified
    • basket, customer properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • store_eni, customer_id, data properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • basket property Added
  • 403 response Added
POST /terminal/basket/order
  • Body
  • application/json content type Modified
    • items, payment_method, promotion, buyer properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • basket_id, is_test, payment_reference, buyer_email properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • store, redeemables, vouchers properties Modified
POST /redeemables/{redeemable}/update-validity
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • valid_days property Modified
          • Type went from integer | null to array[string] | null
            Breaking
POST /redeemables/{redeemable}/top-up
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • valid_days property Modified
          • Type went from integer | null to array[string] | null
            Breaking
POST /redeemables/unredeem
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • valid_days property Modified
          • Type went from integer | null to array[string] | null
            Breaking
POST /redeemables/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • valid_days property Modified
          • Type went from integer | null to array[string] | null
            Breaking
POST /orders/{order}/resend-vouchers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • vouchers property Modified
POST /orders/{order}/notes
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • store, redeemables, vouchers properties Modified
PATCH /orders/{order}
  • Body
  • application/json content type Modified
    • tags property Modified
      • Type went from array[string] to object
        Breaking
      • * property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • store, redeemables, vouchers properties Modified
GET /terminal/search/vouchers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • redeemables property Modified
GET /terminal/redeemables/{redeemable}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • valid_days property Modified
          • Type went from integer | null to array[string] | null
            Breaking
GET /orders/{order}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • store, redeemables, vouchers properties Modified
GET /orders
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • store, redeemables, vouchers properties Modified
Removed 3 Breaking
GET /terminal/search/products
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /terminal/search/redeem-locations
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /terminal/stores/{store}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 3
GET /stores
GET /redeem-locations
GET /products
7 structure changes including:
2 Breaking changes
1 Addition
4 Modifications
2 Removals
Modified 4 Breaking
PATCH /orders/{order}
  • Header
  • Store-Subdomain header Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Account-ID header Added
POST /packages/fulfil
  • Response
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 204 response Added
POST /packages/fulfil/outstanding
  • Response
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 204 response Added
POST /packages/tracking
  • Body
  • application/json content type Modified
    • package_ids, tracking_numbers properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • package_id, tracking_number properties Added
  • Response
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 204, 404 responses Added
Removed 2 Breaking
POST /packages/resend/post
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /vouchers/preview-pdf
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
POST /packages/resend/post
15 structure changes including:
13 Breaking changes
2 Modifications
13 Removals
Modified 2 Breaking
GET /terminal/products/{product}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id, eni, version, type, name, slug, is_active, status, validity, currency_code, monetary_options, price, from_price, comparison_price, tax_percentage, tax_value, liability, custom_fields, pdf_design_store_id, pdf_design, tags, last_purchased, created_at, updated_at, is_scheduled properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /terminal/search/products
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object property Modified
Removed 13 Breaking
GET /products
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /products/{product}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /search/products
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /products/monetary/{product}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /products/{product}/variants/{variant}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /products/delete
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /products/monetary
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /products/price
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /products/slug
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /products/variant
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /products/{product}/variants
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /products/{product}/variants/delete
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /products/{product}/variants/order
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
9 structure changes including:
9 Additions
Added 9
GET /terminal/products/{product}
GET /terminal/redeemables/{redeemable}
GET /terminal/search/products
GET /terminal/search/redeem-locations
GET /terminal/stores/{store}
POST /terminal/basket/check-promotions
POST /terminal/basket/promotion/code
POST /terminal/redeemables/redeem
POST /terminal/redeemables/redeem/undo
9 structure changes including:
9 Additions
Added 9
GET /terminal/products/{product}
GET /terminal/redeemables/{redeemable}
GET /terminal/search/products
GET /terminal/search/redeem-locations
GET /terminal/stores/{store}
POST /terminal/basket/check-promotions
POST /terminal/basket/promotion/code
POST /terminal/redeemables/redeem
POST /terminal/redeemables/redeem/undo
181 structure changes including:
138 Breaking changes
2 Additions
41 Modifications
138 Removals
Modified 41 Breaking
POST /orders/{order}/resend-vouchers
  • Response
  • 200 response Modified
    • application/json content type Added
  • 422 response Added
  • Body
  • application/json content type Added
  • Header
  • Account-ID header Added
POST /packages/download/envelopes
  • Header
  • Account-ID header Added
POST /packages/fulfil
  • Header
  • Account-ID header Added
POST /packages/fulfil/outstanding
  • Header
  • Account-ID header Added
  • Query
  • filter[store.id], filter[packaging_option.id], filter[delivery_method.id], search query parameters Added
POST /packages/resend/post
  • Header
  • Account-ID header Added
POST /packages/tracking
  • Header
  • Account-ID header Added
POST /products/delete
  • Response
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 204 response Added
  • Header
  • Account-ID header Added
POST /products/monetary
  • Body
  • application/json content type Modified
    • description, min_value, max_value properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • is_active, status, monetary_options, validity, tax_percentage, pdf_design_store_id, custom_fields, tags properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • id, name, slug, description, type, currency_code, list_price, variants, addons, redeem_locations, created_at, updated_at properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • data property Added
  • 422 response Modified
    • application/json content type Added
  • 404 response Added
  • Header
  • Account-ID header Added
POST /products/price
  • Body
  • application/json content type Modified
    • price property Modified
      • Type went from number to integer
        Breaking
    • description property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • is_active, status, comparison_price, liability, validity, tax_percentage, custom_fields, tags properties Added
  • Response
  • 201 response Modified
    • application/json content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Header
  • Account-ID header Added
POST /products/variant
  • Body
  • application/json content type Modified
    • description, variants properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • is_active, status, tax_percentage, pdf_design_store_id, custom_fields, tags properties Added
  • Response
  • 201 response Modified
    • application/json content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Header
  • Account-ID header Added
POST /products/{product}/variants
  • Path went from /products/{id}/variants to /products/{product}/variants (same operationId)
  • Body
  • application/json content type Modified
    • price property Modified
      • Type went from number to integer
        Breaking
    • comparison_price, validity, increment_version properties Added
  • Path
  • id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • product path parameter Added
  • Header
  • Account-ID header Added
  • Response
  • 422 response Added
POST /products/{product}/variants/delete
  • Path went from /products/{id}/variants/delete to /products/{product}/variants/delete (same operationId)
  • Body
  • application/json content type Modified
    • increment_version property Added
  • Path
  • id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • product path parameter Added
  • Response
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 204 response Added
  • Header
  • Account-ID header Added
POST /products/{product}/variants/order
  • Path went from /products/{id}/variants/order to /products/{product}/variants/order (same operationId)
  • Path
  • id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • product path parameter Added
  • Header
  • Account-ID header Added
  • Response
  • 422 response Added
POST /redeemables/cancel
  • Response
  • 200 response Modified
    • application/json content type Added
  • 403, 404 responses Added
  • Header
  • Account-ID header Added
POST /redeemables/unredeem
  • Response
  • 200 response Modified
    • application/json content type Added
  • 422 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 403, 404 responses Added
  • Header
  • Account-ID header Added
POST /redeemables/{redeemable}/top-up
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id, type, status, valid_from, valid_to, valid_days, currency_code, monetary_value, name, custom_fields, tags, created_at, updated_at, is_live, invalid_reason properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • data property Added
  • 403 response Added
  • Header
  • Account-ID header Added
POST /redeemables/{redeemable}/update-validity
  • Body
  • application/json content type Modified
    • valid_from property Modified
      • Type went from string(date) to string(date) | null
    • valid_to property Modified
      • Property is now required
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id, type, status, valid_from, valid_to, valid_days, currency_code, monetary_value, name, custom_fields, tags, created_at, updated_at, is_live, invalid_reason properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • data property Added
  • Header
  • Account-ID header Added
POST /terminal/basket/order
  • Body
  • application/json content type Modified
    • items property Modified
      • product_id, variant_id, quantity, value, vouchers properties Added
    • promotion, buyer properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • id, is_live, is_imported, reference, custom_checkout_fields, tags, created_at, updated_at, transaction, redeemables, vouchers, notes_count, notes properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • data property Added
  • Header
  • Store-Subdomain header Added
POST /terminal/basket/validate
  • Body
  • application/json content type Modified
    • items property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • basket, customer properties Added
  • Response
  • 200 response Modified
    • application/json content type Added
  • Header
  • Store-Subdomain header Added
POST /vouchers/pdfs
  • Header
  • Account-ID header Added
  • Response
  • 404, 422 responses Added
POST /vouchers/preview-pdf
  • Body
  • application/json content type Modified
    • voucher_id property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • scale, pages, pdf_design properties Added
  • Response
  • 200 response Modified
    • application/pdf content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • application/json content type Added
  • 422 response Added
  • Header
  • Account-ID header Added
POST /vouchers/resend/email
  • Body
  • application/json content type Modified
    • from_name, recipient_name, message properties Added
  • Response
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 201, 404 responses Added
  • Header
  • Account-ID header Added
GET /orders
  • Query
  • search query parameter Modified
    • Type went from string to string | null
  • filter[is_live][], filter[is_imported][], filter[store.id][], filter[transaction.currency_code][], filter[type][], filter[payment_gateway][] query parameters Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • transaction, redeemables, vouchers, notes properties Modified
        • store property Added
      • links property Added
  • 401, 403 responses Added
  • Header
  • Account-ID header Added
GET /orders/{order}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id, is_live, is_imported, reference, custom_checkout_fields, tags, created_at, updated_at, transaction, redeemables, vouchers, notes_count, notes properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • data property Added
  • Header
  • Account-ID header Added
GET /orders/{order}/history
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type went from array[object] to object
        Breaking
      • data, links, meta properties Added
  • Header
  • Account-ID header Added
  • Query
  • page, per_page query parameters Added
GET /orders/{order}/notes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • user property Added
      • links, meta properties Added
  • Header
  • Account-ID header Added
  • Query
  • page, per_page query parameters Added
GET /packages/download/envelopes/outstanding
  • Header
  • Account-ID header Added
  • Query
  • filter[store.id], filter[packaging_option.id], filter[delivery_method.id], search query parameters Added
GET /packages/fulfilled/delivery-methods
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type went from array[object] to object
        Breaking
      • data property Added
  • Header
  • Account-ID header Added
GET /packages/fulfilled/packaging-options
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type went from array[object] to object
        Breaking
      • data property Added
  • Header
  • Account-ID header Added
GET /packages/outstanding/delivery-methods
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type went from array[object] to object
        Breaking
      • data property Added
  • Header
  • Account-ID header Added
GET /packages/outstanding/packaging-options
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type went from array[object] to object
        Breaking
      • data property Added
  • Header
  • Account-ID header Added
GET /products
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • description, list_price, variants, addons, redeem_locations properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • eni, version, is_active, status, validity, monetary_options, price, from_price, comparison_price, tax_percentage, tax_value, liability, custom_fields, pdf_design_store_id, pdf_design, tags, last_purchased, is_scheduled properties Added
      • links property Added
  • 401, 403 responses Added
  • Header
  • Account-ID header Added
  • Query
  • sort, filter[currency_code][], filter[type][], filter[is_active][], filter[status][], include query parameters Added
GET /products/{product}
  • Path went from /products/{id} to /products/{product} (same operationId)
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id, name, slug, description, type, currency_code, list_price, variants, addons, redeem_locations, created_at, updated_at properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • data property Added
  • 401, 403 responses Added
  • Path
  • id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • product path parameter Added
  • Header
  • Account-ID header Added
GET /search/products
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type went from array[object] to object
        Breaking
      • data property Added
  • 401, 403, 422 responses Added
  • Query
  • query query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • search, filter[currency_code][] query parameters Added
  • Header
  • Account-ID header Added
GET /terminal/search/vouchers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type went from array[object] to object
        Breaking
      • data property Added
  • Query
  • query query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • search query parameter Added
  • Header
  • Account-ID header Added
GET /vouchers/pdfs/outstanding
  • Header
  • Account-ID header Added
  • Query
  • filter[store.id], filter[packaging_option.id], filter[delivery_method.id], search query parameters Added
PATCH /orders/{order}
  • Body
  • application/json content type Modified
    • tags property Modified
      • Type went from object to array[string]
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id, is_live, is_imported, reference, custom_checkout_fields, tags, created_at, updated_at, transaction, redeemables, vouchers, notes_count, notes properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • data property Added
  • 403 response Added
  • Header
  • Store-Subdomain header Added
PATCH /products/monetary/{product}
  • Path went from /products/monetary/{id} to /products/monetary/{product} (same operationId)
  • Body
  • application/json content type Modified
    • description, min_value, max_value properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • slug, is_active, status, monetary_options, validity, tax_percentage, custom_fields, tags, scheduled_for, increment_version properties Added
  • Response
  • 200 response Modified
    • application/json content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • 422 response Added
  • Path
  • id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • product path parameter Added
  • Header
  • Account-ID header Added
PATCH /products/{product}/variants/{variant}
  • Path went from /products/{id}/variants/{variantId} to /products/{product}/variants/{variant} (same operationId)
  • Body
  • application/json content type Modified
    • price property Modified
      • Type went from number to integer
        Breaking
    • comparison_price, validity, increment_version properties Added
  • Path
  • id, variantId path parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • product, variant path parameters Added
  • Header
  • Account-ID header Added
PATCH /transactions/{transaction}
  • Body
  • application/json content type Modified
    • payment_reference property Modified
      • Type went from string to string | null
    • status property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id, list_prices_include_tax, list_price, promotion_name, promotion_code, discounts, tax_percentages, tax, value, currency_code, buyer, marketing_consent, completed_at, type, is_imported, payment_gateway, payment_reference properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • data property Added
  • Header
  • Account-ID header Added
POST /orders/{order}/notes
  • Response
  • 201 response Modified
    • application/json content type Modified
      • id, content, created_at properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • data property Added
  • 422 response Added
  • Header
  • Account-ID header Added
Removed 138 Breaking
POST /exports/redeem-locations/csv
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /exports/promotions/{id}/codes/csv
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /exports/promotions/csv
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /exports/redemptions/csv
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /exports/stores/csv
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /exports/products/csv
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /exports/outstanding/csv
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /exports/invoice/transactions/csv
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /addons/{id}/products/remove
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /exports/transactions/csv
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /exports/users/csv
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /imports
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /invitations
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /invitations/accept
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /invitations/decline
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /invitations/{id}/permissions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /invitations/{id}/redeem-locations
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /invitations/{id}/stores
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /auth/login
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /auth/login/username
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /auth/logout
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /auth/request-password-reset
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /auth/reset-password
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /auth/signup-from-invitation
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /categories
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /categories/delete
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /codes/code
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /collection-points
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /collection-points/delete
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /delivery-methods
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /delivery-methods/delete
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /emails/domains
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /emails/domains/{hostname}/delete
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /exports/addons/csv
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /exports/expirations/csv
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /notifications/fulfilment
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /stores/multi-product
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /stores/single-product
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /stores/subdomain
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /stores/{id}/categories
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /stores/{id}/categories/order
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /stores/{id}/live
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /stores/{id}/products
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /terminal/basket/check-promotions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /terminal/basket/promotion/code
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /terminal/redeemables/redeem
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /terminal/vouchers
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /transactions/{transaction}/resend
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /users
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /users/remove
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /users/{id}/permissions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /users/{id}/redeem-locations
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /users/{id}/stores
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /packaging-options
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /packaging-options/delete
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /payment-gateways/connect/paypal/complete
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /payment-gateways/connect/paypal/generate-url
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /payment-gateways/connect/stripe/complete
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /payment-gateways/connect/stripe/generate-url
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /payment-gateways/remove
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /products/slug
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /products/{id}/addons
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /products/{id}/redeem-locations
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /promotions/delete
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /promotions/total-order
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /promotions/{id}/codes/delete
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /promotions/{id}/stores
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /redeem-locations
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /redeem-locations/delete
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /schedules/delete
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /emails/domains/{hostname}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /imports
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /invitations
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /invitations/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /invitations/{id}/display
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /invoices
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /invoices/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /partner
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /payment-gateways
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /promotions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /promotions/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /redeem-locations
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /redeem-locations/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /sanctum/csrf-cookie
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /search/addons
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /search/categories
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /search/email-domains
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /invitations/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /stores/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /accounts
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /addons
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /addons/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /auth/check
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /auth/check/redeem-location
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /auth/verify-email/{userId}/{hash}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /categories
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /categories/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /codes
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /currencies/used-by-addons
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /currencies/used-by-products
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /currencies/used-by-promotions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /currencies/used-by-stores
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /currencies/used-by-transactions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /emails/domains
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /collection-points/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /delivery-methods/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /invitations/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /notifications/fulfilment/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /packaging-options/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /products/price/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /products/variant/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /promotions/total-order/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /promotions/{type}/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /redeem-locations/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /stores/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /subscriptions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /users/{id}/email
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /users/{id}/username
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /addons
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /addons/delete
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /addons/{id}/products/add
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /search/payment-gateways
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /search/redeem-locations
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /search/stores
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /stores
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /stores/all/with-trashed
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /stores/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /subscriptions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /terminal/products/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /terminal/redeemables/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /terminal/search/products
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /terminal/search/redeem-locations
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /terminal/stores/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /users
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /users/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /addons/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /auth
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /categories/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 2
POST /transactions/{transaction}/resend
POST /products/slug
175 structure changes including:
165 Additions
10 Modifications
Modified 10 Breaking
POST /redeemables/{redeemable}/update-validity
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transactable, voucher properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /redeemables/{redeemable}/top-up
  • Body
  • application/json content type Modified
    • amount property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • value property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transactable, voucher properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /packages/tracking
  • Body
  • application/json content type Modified
    • package_id, tracking_number properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • package_ids, tracking_numbers properties Added
POST /packages/resend/post
  • Body
  • application/json content type Modified
    • package_ids property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • postal_package_ids property Added
POST /packages/fulfil
  • Body
  • application/json content type Modified
    • package_ids property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • collection_package_ids, postal_package_ids properties Added
POST /packages/download/envelopes
  • Body
  • application/json content type Modified
    • package_ids property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • postal_package_ids property Added
POST /orders/{order}/resend-vouchers
  • Path
  • order path parameter Modified
    • Type went from integer to string(uuid)
      Breaking
PATCH /orders/{order}
  • Body
  • application/json content type Modified
    • status, notes properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • custom_checkout_fields, tags properties Added
  • Path
  • order path parameter Modified
    • Type went from integer to string(uuid)
      Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id, is_live, is_imported, reference, custom_checkout_fields, tags, created_at, updated_at, transaction, redeemables, vouchers, notes_count, notes properties Added
GET /orders/{order}
  • Path
  • order path parameter Modified
    • Type went from integer to string(uuid)
      Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id, is_live, is_imported, reference, custom_checkout_fields, tags, created_at, updated_at, transaction, redeemables, vouchers, notes_count, notes properties Added
GET /orders
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id, is_live, is_imported, reference, custom_checkout_fields, tags, created_at, updated_at, transaction, redeemables, vouchers, notes_count, notes properties Added
  • Query
  • status, from_date, to_date query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • search query parameter Added
Added 165
POST /invitations/{id}/redeem-locations
POST /invitations/{id}/permissions
POST /invitations/decline
POST /invitations/accept
POST /invitations
POST /imports
POST /exports/users/csv
POST /exports/transactions/csv
POST /exports/stores/csv
GET /invoices
POST /invitations/{id}/stores
POST /notifications/fulfilment
POST /orders/{order}/notes
POST /packaging-options
POST /packaging-options/delete
POST /payment-gateways/connect/paypal/complete
POST /payment-gateways/connect/paypal/generate-url
POST /payment-gateways/connect/stripe/complete
POST /payment-gateways/connect/stripe/generate-url
POST /payment-gateways/remove
POST /auth/signup-from-invitation
POST /categories
POST /categories/delete
POST /codes/code
POST /collection-points
POST /collection-points/delete
POST /delivery-methods
POST /delivery-methods/delete
POST /emails/domains
POST /emails/domains/{hostname}/delete
POST /exports/addons/csv
POST /exports/expirations/csv
POST /exports/invoice/transactions/csv
POST /exports/outstanding/csv
POST /exports/products/csv
POST /exports/promotions/csv
POST /exports/promotions/{id}/codes/csv
POST /exports/redeem-locations/csv
POST /exports/redemptions/csv
POST /products/delete
POST /stores/{id}/categories
POST /stores/{id}/categories/order
POST /stores/{id}/live
POST /stores/{id}/products
POST /terminal/basket/check-promotions
POST /terminal/basket/order
POST /terminal/basket/promotion/code
POST /terminal/basket/validate
POST /terminal/redeemables/redeem
POST /terminal/vouchers
POST /transactions/{transaction}/resend
POST /users
POST /users/remove
POST /users/{id}/permissions
POST /users/{id}/redeem-locations
POST /users/{id}/stores
POST /vouchers/pdfs
POST /vouchers/preview-pdf
POST /vouchers/resend/email
POST /products/monetary
POST /products/price
POST /products/slug
POST /products/variant
POST /products/{id}/addons
POST /products/{id}/redeem-locations
POST /products/{id}/variants
POST /products/{id}/variants/delete
POST /products/{id}/variants/order
POST /promotions/delete
POST /promotions/total-order
POST /promotions/{id}/codes/delete
POST /promotions/{id}/stores
POST /redeem-locations
POST /redeem-locations/delete
POST /schedules/delete
POST /stores/multi-product
POST /stores/single-product
POST /stores/subdomain
GET /invoices/{id}
GET /orders/{order}/history
GET /orders/{order}/notes
GET /packages/fulfilled/delivery-methods
GET /packages/fulfilled/packaging-options
GET /packages/outstanding/delivery-methods
GET /packages/outstanding/packaging-options
GET /partner
GET /payment-gateways
GET /products
GET /products/{id}
GET /promotions
GET /promotions/{id}
GET /redeem-locations
GET /redeem-locations/{id}
GET /sanctum/csrf-cookie
GET /search/addons
GET /search/categories
GET /search/email-domains
GET /search/payment-gateways
GET /search/products
DELETE /invitations/{id}
DELETE /stores/{id}
GET /accounts
GET /addons
GET /addons/{id}
GET /auth/check
GET /auth/check/redeem-location
GET /auth/verify-email/{userId}/{hash}
GET /categories
GET /categories/{id}
GET /codes
GET /currencies/used-by-addons
GET /currencies/used-by-products
GET /currencies/used-by-promotions
GET /currencies/used-by-stores
GET /currencies/used-by-transactions
GET /emails/domains
GET /emails/domains/{hostname}
GET /imports
GET /invitations
GET /invitations/{id}
GET /invitations/{id}/display
PATCH /packaging-options/{id}
PATCH /products/monetary/{id}
PATCH /products/price/{id}
PATCH /products/variant/{id}
PATCH /products/{id}/variants/{variantId}
PATCH /promotions/total-order/{id}
PATCH /promotions/{type}/{id}
PATCH /redeem-locations/{id}
PATCH /stores/{id}
PATCH /subscriptions
PATCH /transactions/{transaction}
PATCH /users/{id}/email
PATCH /users/{id}/username
POST /addons
POST /addons/delete
POST /addons/{id}/products/add
POST /addons/{id}/products/remove
POST /auth/login
POST /auth/login/username
POST /auth/logout
POST /auth/request-password-reset
POST /auth/reset-password
GET /search/redeem-locations
GET /search/stores
GET /stores
GET /stores/all/with-trashed
GET /stores/{id}
GET /subscriptions
GET /terminal/products/{id}
GET /terminal/redeemables/{id}
GET /terminal/search/products
GET /terminal/search/redeem-locations
GET /terminal/search/vouchers
GET /terminal/stores/{id}
GET /users
GET /users/{id}
GET /vouchers/pdfs/outstanding
PATCH /addons/{id}
PATCH /auth
PATCH /categories/{id}
PATCH /collection-points/{id}
PATCH /delivery-methods/{id}
PATCH /invitations/{id}
PATCH /notifications/fulfilment/{id}
35 structure changes including:
33 Breaking changes
2 Modifications
33 Removals
Modified 2 Breaking
POST /redeemables/{redeemable}/top-up
  • Response
  • 200 response Modified
    • application/json content type Modified
      • redeem_locations property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /redeemables/{redeemable}/update-validity
  • Response
  • 200 response Modified
    • application/json content type Modified
      • redeem_locations property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
Removed 33 Breaking
GET /accounts
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /accounts/slug/{slug}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /analytics/outstanding-total
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /analytics/redemptions-by-date-range
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /analytics/sales-by-date-range
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /auth/check
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /codes
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /promotions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /promotions/{promotion}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /redeem-locations
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /redeem-locations/{redeemLocation}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /terminal/vouchers
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /terminal/vouchers/{voucher}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /accounts/{account}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /promotions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /redeem-locations/{redeemLocation}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /accounts
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /auth/login
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /auth/login/username
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /auth/logout
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /auth/request-password-reset
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /auth/reset-password
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /auth/signup
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /codes/code
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /promotions/code
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /promotions/free-item
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /promotions/total-order
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /promotions/{promotion}/codes
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /promotions/{promotion}/codes/delete
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /redeem-locations
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /redeem-locations/delete
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /terminal/vouchers
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /terminal/vouchers/resend/email
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
57 structure changes including:
44 Breaking changes
13 Modifications
44 Removals
Modified 13 Breaking
GET /accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • has_multiple_stores property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /accounts/slug/{slug}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • has_multiple_stores property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /auth/check
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • has_multiple_stores property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • stores property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /terminal/vouchers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • store property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /terminal/vouchers/{voucher}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • store property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
PATCH /accounts/{account}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • has_multiple_stores property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /accounts
  • Response
  • 201 response Modified
    • application/json content type Modified
      • has_multiple_stores property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /auth/login
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
        • accounts property Modified
        • stores property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /auth/login/username
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
        • accounts property Modified
        • stores property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /auth/signup
  • Response
  • 201 response Modified
    • application/json content type Modified
      • user property Modified
        • accounts property Modified
        • stores property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /redeemables/{redeemable}/top-up
  • Response
  • 200 response Modified
    • application/json content type Modified
      • voucher property Modified
        • store property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /redeemables/{redeemable}/update-validity
  • Response
  • 200 response Modified
    • application/json content type Modified
      • voucher property Modified
        • store property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /terminal/vouchers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • store property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
Removed 44 Breaking
DELETE /stores/{store}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /addons
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /addons/{addon}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /analytics/products/value
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /categories
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /categories/{category}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /products
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /products/{product}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /storefront/category/{slug}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /storefront/product/{slug}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /storefront/store
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /stores
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /stores/{store}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /addons
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /addons/{addon}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /categories
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /products
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /stores/{store}/collection-points/{collection_point}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /stores/{store}/delivery-methods/{delivery_method}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /stores/{store}/packaging-options/{packaging_option}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /addons
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /addons/delete
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /addons/{addon}/products
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /addons/{addon}/products/add
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /addons/{addon}/products/remove
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /categories/delete
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /categories/{category}/products
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /collection-points/delete
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /delivery-methods/delete
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /packaging-options/delete
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /products/delete
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /products/monetary
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /products/price
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /products/variant
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /storefront/basket/validate
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /storefront/transaction/paypal/basket/initiate
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /storefront/transaction/stripe/basket/initiate
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /stores/multi-product
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /stores/single-product
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /stores/{store}/collection-points
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /stores/{store}/delivery-methods
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /stores/{store}/live
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /stores/{store}/packaging-options
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /stores/{store}/products
  • Removing a resource is always breaking unless it was deprecated before
    Breaking