API structure has changed
79 structure changes including:
3 Breaking changes
49 Additions
27 Modifications
3 Removals
Modified
27
Breaking
GET /manager/predefined-messages/{id}
- Response
-
200 response Modified
-
application/json content type Modified
-
position, active 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
-
position, active properties Removed
-
application/json content type Modified
GET /manager/quiz
- Query
-
filter[active] query parameter Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
GET /manager/quiz/{id}
- Response
-
200 response Modified
-
application/json content type Modified
- my_answers, post properties Added
-
application/json content type Modified
GET /widget/ambassadors
- Query
- filter[last_action_date_after], filter[has_address_geocode] query parameters Added
GET /widget/ambassadors/{id}
- Response
-
200 response Modified
-
application/json content type Modified
-
location 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
-
location property Removed
-
application/json content type Modified
GET /widget/ambassadors/{id}/posts
- Query
-
filter[view_on_blog] query parameter Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
GET /widget/config
- Response
-
200 response Modified
-
application/json content type Modified
-
picking property Modified
-
nameSelector, imageSelector, priceSelector, skuSelector properties Modified
-
Type went from
string
toobject
Breaking
-
Type went from
- descriptionSelector property Added
-
nameSelector, imageSelector, priceSelector, skuSelector properties Modified
-
picking property Modified
-
application/json content type Modified
GET /{environment}/me
- Response
-
200 response Modified
-
application/json content type Modified
- status_role, manager_role, ids_guest_accounts properties Added
-
application/json content type Modified
GET /{environment}/posts
- Response
-
200 response Modified
-
application/json content type Modified
- object-1 property Added
-
application/json content type Modified
- Query
-
filter[view_on_blog] query parameter Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
GET /{environment}/posts/{id}
- Response
-
200 response Modified
-
application/json content type Modified
-
comments property Modified
- author property Modified
-
date_post, view_on_blog, link, data1, data2, thread_last_update, is_on_boarding, is_welcome, shareable, no_comment 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
- video, quiz properties Added
-
comments property Modified
-
application/json content type Modified
PATCH /manager/ambassadors/{id}
- Body
-
application/json content type Modified
-
register_src 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
-
register_src property Removed
- Response
-
200 response Modified
-
application/json content type Modified
-
register_src 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
-
register_src property Removed
-
application/json content type Modified
PATCH /manager/posts/{id}
- Body
-
application/json content type Modified
-
is_on_boarding, is_welcome, data1, data2, thread_last_update 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
- visibility property Added
-
is_on_boarding, is_welcome, data1, data2, thread_last_update properties Removed
- Response
-
200 response Modified
-
application/json content type Modified
-
comments property Modified
- author property Modified
-
date_post, view_on_blog, link, data1, data2, thread_last_update, is_on_boarding, is_welcome, shareable, no_comment 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
- video, quiz properties Added
-
comments property Modified
-
application/json content type Modified
PATCH /manager/predefined-messages/{id}
- Body
-
application/json content type Modified
-
position, active 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
-
position, active properties Removed
- Response
-
200 response Modified
-
application/json content type Modified
-
position, active 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
-
position, active properties Removed
-
application/json content type Modified
PATCH /manager/products/{id}
- Body
-
application/json content type Modified
-
Content type is now required Breaking
-
Content type is now required
PATCH /manager/quiz/{id}
- Response
-
200 response Modified
-
application/json content type Modified
- my_answers, post properties Added
-
application/json content type Modified
PATCH /{environment}/me
- Body
-
application/json content type Modified
-
password_confirmation 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
-
password_confirmation property Removed
- Response
-
200 response Modified
-
application/json content type Modified
- status_role, manager_role, ids_guest_accounts properties Added
-
application/json content type Modified
POST /auth/login
- Response
-
200 response Modified
-
application/json content type Modified
-
user property Modified
- status_role, manager_role, ids_guest_accounts properties Added
-
user property Modified
-
application/json content type Modified
- 403 response Added
POST /auth/register
- Body
-
application/json content type Modified
-
shopify_customer_id, facebook_id, google_id, apple_id, id_address_geocode 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
- store_id, roles, address properties Added
-
shopify_customer_id, facebook_id, google_id, apple_id, id_address_geocode properties Removed
- Response
-
201 response Modified
-
application/json content type Modified
- status_role, manager_role, ids_guest_accounts properties Added
-
application/json content type Modified
POST /chat/copilot/reword-message
- Body
-
application/json content type Modified
- last_message property Added
POST /manager/ambassadors
- Response
-
201 response Modified
-
application/json content type Modified
-
register_src 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
-
register_src property Removed
-
application/json content type Modified
POST /manager/posts
- Body
-
application/json content type Modified
-
link, date_post, data1, data2, thread_last_update, is_welcome 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
- id_ambassador property Added
-
link, date_post, data1, data2, thread_last_update, is_welcome properties Removed
- Response
-
201 response Modified
-
application/json content type Modified
-
comments property Modified
- author property Modified
-
date_post, view_on_blog, link, data1, data2, thread_last_update, is_on_boarding, is_welcome, shareable, no_comment 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
- video, quiz properties Added
-
comments property Modified
-
application/json content type Modified
POST /manager/predefined-messages
- Body
-
application/json content type Modified
-
position, active 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
-
position, active properties Removed
- Response
-
201 response Modified
-
application/json content type Modified
-
position, active 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
-
position, active properties Removed
-
application/json content type Modified
POST /manager/products
- Body
-
application/json content type Modified
-
Content type is now required Breaking
-
type, price, name, sku, stock properties Modified
- Properties are no longer required
-
stock_available property Modified
- Property is no longer required
-
Type went from
number
tointeger(nullable)
Breaking
-
image 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
- images property Added
-
Content type is now required
POST /manager/quiz
- Response
-
201 response Modified
-
application/json content type Modified
- my_answers, post properties Added
-
application/json content type Modified
GET /manager/orders/{id}
- Response
-
200 response Modified
-
application/json content type Modified
- assignment property Added
-
application/json content type Modified
GET /manager/ambassadors/{id}
- Response
-
200 response Modified
-
application/json content type Modified
-
register_src 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
-
register_src property Removed
-
application/json content type Modified
DELETE /manager/posts/{id}
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
- 204 response Added
Removed
3
Breaking
GET /manager/platform-config
- Removing a resource is always breaking unless it was deprecated before Breaking
PATCH /manager/platform-config
- Removing a resource is always breaking unless it was deprecated before Breaking
POST /manager/images
- Removing a resource is always breaking unless it was deprecated before Breaking
Added
49
POST /{environment}/images
POST /widget/wallet/apple-wallet/create-wallet
POST /widget/push-notification
POST /widget/orders
POST /widget/me/signed-url
POST /wallet/apple-web-service/v1/devices/{deviceLibraryIdentifier}/registrations/{passTypeIdentifier}/{serialNumber}
POST /platform/quiz/{id}/participate
POST /platform/push-notification
POST /platform/products/pick-product
GET /platform/posts/{post}/likes
GET /platform/posts/{post}/comments
GET /platform/ambassadors/{id}/stats
GET /platform/ambassadors/{id}/orders
GET /platform/ambassadors/{id}/notifications
GET /platform/ambassadors/{id}/challenges
GET /platform/ambassadors/{id}/challenge-histories
GET /platform/ambassadors/{id}
GET /platform/ambassadors
GET /manager/vectors/{vector_id}/actions/{action_id}
GET /manager/vectors/{id}
GET /manager/vectors
GET /manager/challenges/{id}
GET /manager/challenges
GET /manager/ambassadors/{id}/challenge-histories
DELETE /wallet/apple-web-service/v1/devices/{deviceLibraryIdentifier}/registrations/{passTypeIdentifier}/{serialNumber}
DELETE /platform/posts/{post}/like
DELETE /platform/comments/{comment}
DELETE /manager/vectors/{vector_id}/actions/{action_id}
DELETE /manager/vectors/{id}
POST /platform/posts/{post}/like
POST /platform/posts/{post}/comments
POST /platform/popliste/{id}/image
POST /platform/popliste
POST /manager/vectors/{vector_id}/actions
POST /manager/vectors
POST /manager/popliste
POST /manager/challenges
POST /manager/ambassadors/{id}/challenge-histories
POST /auth/signed-url/{user}
PATCH /platform/me/point-of-sale/{pointOfSale}
PATCH /platform/me/address-geocode
PATCH /platform/comments/{comment}
PATCH /notifications/{id}/read
PATCH /manager/vectors/{vector_id}/actions/{action_id}
PATCH /manager/vectors/{id}
PATCH /manager/popliste/{id}
PATCH /manager/challenges/{id}
GET /wallet/apple-web-service/v1/passes/{passTypeIdentifier}/{serialNumber}
GET /wallet/apple-web-service/v1/devices/{deviceLibraryIdentifier}/registrations/{passTypeIdentifier}