API structure has changed
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
-
Removing a resource is always breaking unless it was deprecated before
-
transactable, voucher properties Removed
-
application/json content type Modified
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
-
Removing a resource is always breaking unless it was deprecated before
- value property Added
-
amount property Removed
- 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
-
Removing a resource is always breaking unless it was deprecated before
-
transactable, voucher properties Removed
-
application/json content type Modified
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
-
Removing a resource is always breaking unless it was deprecated before
- package_ids, tracking_numbers properties Added
-
package_id, tracking_number properties Removed
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
-
Removing a resource is always breaking unless it was deprecated before
- postal_package_ids property Added
-
package_ids property Removed
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
-
Removing a resource is always breaking unless it was deprecated before
- collection_package_ids, postal_package_ids properties Added
-
package_ids property Removed
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
-
Removing a resource is always breaking unless it was deprecated before
- postal_package_ids property Added
-
package_ids property Removed
POST /orders/{order}/resend-vouchers
- Path
-
order path parameter Modified
-
Type went from
integertostring(uuid)Breaking
-
Type went from
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
-
Removing a resource is always breaking unless it was deprecated before
- custom_checkout_fields, tags properties Added
-
status, notes properties Removed
- Path
-
order path parameter Modified
-
Type went from
integertostring(uuid)Breaking
-
Type went from
- 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
-
application/json content type Modified
GET /orders/{order}
- Path
-
order path parameter Modified
-
Type went from
integertostring(uuid)Breaking
-
Type went from
- 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
-
application/json content type Modified
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
-
data property Modified
-
application/json content type Modified
- Query
-
status, from_date, to_date query parameters Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
- 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}