Change Updates

Do not miss any Popsell API changes, ever again

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

RSS

Changelog

Last update:
Compare
11 structure changes including:
1 Breaking change
1 Addition
9 Modifications
1 Removal
Modified 9 Breaking
GET /ambassadors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /chat/chatrooms/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • established_dialogue property Modified
        • Full types went from boolean to string(date-time)
          Breaking
GET /manager/ambassadors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /manager/bi/realtime/activity
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /manager/chatrooms
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /manager/chatrooms/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • established_dialogue property Modified
        • Full types went from boolean to string(date-time)
          Breaking
GET /manager/orders
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /manager/products
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /widget/posts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
Removed 1 Breaking
PUT /chat/chatrooms/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
PATCH /chat/chatrooms/{id}
18 structure changes including:
6 Breaking changes
7 Additions
5 Modifications
6 Removals
Modified 5 Breaking
POST /manager/ambassadors
  • Response
  • 201 response Modified
    • application/json content type Modified
      • mobile_notification_enabled, notification_email_community, notification_email_pl_order properties Added
GET /chat/chatrooms/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • date_insert, last_rating, last_message_date, messages properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ambassadors property Added
GET /manager/ambassadors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • mobile_notification_enabled, notification_email_community, notification_email_pl_order properties Added
GET /manager/bi/realtime/chatrooms
  • Response
  • 200 response Modified
    • application/json content type Modified
      • waiting_conversations property Added
GET /manager/chatrooms/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • messages property Modified
Removed 6 Breaking
PUT /manager/products/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /manager/me
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /manager/ambassadors/{id}/decline
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /manager/ambassadors/{id}/approve
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /manager/ambassadors/{id}/alerts
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /manager/ambassadors/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 7
POST /platform/session-times
PATCH /manager/products/{id}
PATCH /manager/me
PATCH /manager/ambassadors/{id}/decline
PATCH /manager/ambassadors/{id}/approve
PATCH /manager/ambassadors/{id}/alerts
PATCH /manager/ambassadors/{id}
9 structure changes including:
9 Modifications
Modified 9 Breaking
GET /manager/ambassadors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • social_community_display property Modified
        • Full types went from string to boolean
          Breaking
GET /manager/me
  • Response
  • 200 response Modified
    • application/json content type Modified
      • social_community_display property Modified
        • Full types went from string to boolean
          Breaking
POST /auth/login
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
POST /auth/register
  • Response
  • 201 response Modified
    • application/json content type Modified
      • social_community_display property Modified
        • Full types went from string to boolean
          Breaking
POST /manager/ambassadors
  • Response
  • 201 response Modified
    • application/json content type Modified
      • social_community_display property Modified
        • Full types went from string to boolean
          Breaking
PUT /manager/ambassadors/{id}
  • Body
  • application/json content type Modified
    • social_community_display property Modified
      • Full types went from string to boolean
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • social_community_display property Modified
        • Full types went from string to boolean
          Breaking
PUT /manager/ambassadors/{id}/approve
  • Query
  • preview-mail query parameter Modified
    • Full types is now boolean
PUT /manager/ambassadors/{id}/decline
  • Query
  • preview-mail query parameter Modified
    • Full types is now boolean
PUT /manager/me
  • Response
  • 200 response Modified
    • application/json content type Modified
      • social_community_display property Modified
        • Full types went from string to boolean
          Breaking
2 structure changes including:
2 Additions
Added 2
PUT /manager/ambassadors/{id}/approve
PUT /manager/ambassadors/{id}/decline
5 structure changes including:
2 Additions
3 Modifications
Modified 3
GET /chat/chatrooms/{id}
  • Header
  • X-Popsell-Brand header Added
GET /chat/messages/{id}
  • Header
  • X-Popsell-Brand header Added
POST /chat/web-push/new-chat-message/${id_message}/ambassador/${id_ambassador}
  • Header
  • X-Popsell-Brand header Added
Added 2
GET /chat/chatrooms/{id}/check-dialogue
PUT /chat/chatrooms/{id}
3 structure changes including:
3 Additions
Added 3
GET /chat/chatrooms/{id}
GET /chat/messages/{id}
POST /chat/web-push/new-chat-message/${id_message}/ambassador/${id_ambassador}
2 structure changes including:
1 Addition
1 Modification
Modified 1
GET /brand
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id_brand, product_price_display_limit, widget_wl_cta_chat_topic, widget_community_default_sort_amb_by, brand_config properties Added
Added 1
GET /brand-config
4 structure changes including:
4 Modifications
Modified 4
GET /manager/ambassadors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nb_sales, nb_chat_sales, nb_purchases properties Added
GET /manager/chatrooms
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /manager/ambassadors
  • Response
  • 201 response Modified
    • application/json content type Modified
      • nb_sales, nb_chat_sales, nb_purchases properties Added
PUT /manager/ambassadors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • nb_sales, nb_chat_sales, nb_purchases properties Added
8 structure changes including:
1 Breaking change
4 Additions
3 Modifications
1 Removal
Modified 3 Breaking
GET /manager/ambassadors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /manager/orders
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
  • Query
  • sort, filter[order_search], filter[id_ambassador], filter[attribution], filter[last_status], filter[type] query parameters Added
GET /manager/orders/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id_ambassador, id_buyer, id_ambassador_chat properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ambassador, buyer, ambassador_chat properties Added
Removed 1 Breaking
GET /manager/bi/activity
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 4
GET /manager/bi/realtime/activity
GET /manager/bi/realtime/chatrooms
GET /manager/bi/realtime/members
GET /manager/bi/realtime/orders
3 structure changes including:
3 Modifications
Modified 3
GET /manager/ambassadors/{id}
  • Response
  • 200 response Modified
    • point_of_sale_label property Added
POST /manager/ambassadors
  • Response
  • 201 response Modified
    • point_of_sale_label property Added
PUT /manager/ambassadors/{id}
  • Response
  • 200 response Modified
    • point_of_sale_label property Added
10 structure changes including:
10 Modifications
Modified 10 Breaking
GET /ambassadors
  • Response
  • 200 response Modified
    • data property Modified
GET /ambassadors/{id}
  • Response
  • 200 response Modified
    • online property Added
GET /brand
  • Response
  • 200 response Modified
    • register_restriction property Added
GET /manager/ambassadors
  • Response
  • 200 response Modified
    • data property Modified
GET /manager/ambassadors/{id}
  • Response
  • 200 response Modified
    • sponsor property Modified
    • online property Added
GET /manager/bi/activity
  • Response
  • 200 response Modified
    • data property Modified
  • Query
  • filter[online_only], filter[id_ambassador], filter[ignore_inactive] query parameters Added
GET /manager/chatrooms
  • Response
  • 200 response Modified
    • data property Modified
  • Query
  • filter[is_dialog] query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • filter[dialogue] query parameter Added
GET /manager/chatrooms/{id}
  • Response
  • 200 response Modified
    • messages property Modified
    • last_action_date property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • date_insert, source, established_dialogue, last_rating, last_message_date properties Added
POST /manager/ambassadors
  • Response
  • 201 response Modified
    • sponsor property Modified
    • online property Added
PUT /manager/ambassadors/{id}
  • Response
  • 200 response Modified
    • sponsor property Modified
    • online property Added
1 structure change including:
1 Modification
Modified 1
GET /manager/bi/activity
  • Query
  • sort query parameter Added
5 structure changes including:
5 Modifications
Modified 5 Breaking
GET /manager/ambassadors
  • Response
  • 200 response Modified
    • data property Modified
  • Query
  • sort query parameter Added
GET /manager/ambassadors/{id}
  • Response
  • 200 response Modified
    • nb_public_popliste, nb_private_popliste properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • nb_conversations, nb_diffused_publications, sponsor, role properties Added
GET /manager/bi/activity
  • Query
  • page, per_page query parameters Added
POST /manager/ambassadors
  • Response
  • 201 response Modified
    • nb_public_popliste, nb_private_popliste properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • nb_conversations, nb_diffused_publications, sponsor, role properties Added
PUT /manager/ambassadors/{id}
  • Response
  • 200 response Modified
    • nb_public_popliste, nb_private_popliste properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • nb_conversations, nb_diffused_publications, sponsor, role properties Added
9 structure changes including:
2 Breaking changes
3 Additions
4 Modifications
2 Removals
Modified 4 Breaking
GET /manager/ambassadors
  • Response
  • 200 response Modified
    • data property Modified
GET /manager/ambassadors/{id}
  • Response
  • 200 response Modified
    • active property Modified
      • Full types went from boolean to integer(int32)
        Breaking
POST /manager/ambassadors
  • Response
  • 201 response Modified
    • active property Modified
      • Full types went from boolean to integer(int32)
        Breaking
PUT /manager/ambassadors/{id}
  • Response
  • 200 response Modified
    • active property Modified
      • Full types went from boolean to integer(int32)
        Breaking
Removed 2 Breaking
GET /manager/bi/report
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /manager/bi/visuals
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 3
GET /manager/bi/activity
GET /manager/bi/report
POST /manager/bi/visuals
1 structure change including:
1 Modification
Modified 1
GET /manager/chatrooms
  • Query
  • filter[source], filter[ignore_empty], filter[is_dialog], filter[last_rating], filter[ambassador] query parameters Added
2 structure changes including:
2 Additions
Added 2
GET /manager/chatrooms
GET /manager/chatrooms/{id}
2 structure changes including:
2 Modifications
Modified 2 Breaking
GET /manager/ambassadors
  • Query
  • filter[manager_users_only] query parameter Added
POST /manager/bi/visuals
  • Body
  • content type Modified
    • title, page_name, visual_name properties Removed
    • visuals property Added
  • Response
  • 201 response Modified
    • title, pageName, visualName properties Removed
    • message property Added
  • 200 response Removed
1 structure change including:
1 Modification
Modified 1
GET /brand
  • Header
  • X-Popsell-Domain header Modified
15 structure changes including:
1 Breaking change
7 Additions
7 Modifications
1 Removal
Modified 7 Breaking
GET /manager/ambassadors
  • Query
  • filter[ambassador_search], filter[has_role], filter[active], filter[status], filter[suspicious], filter[quarantine] query parameters Added
GET /manager/products
  • Response
  • 200 response Modified
    • data property Modified
GET /manager/products/{id}
  • Response
  • 200 response Modified
    • stock property Modified
    • discount_percentage, price_catalog, reference_unit_price, youtube_id, url, image properties Added
POST /auth/register
  • Body
  • content type Modified
    • password_confirmation property Removed
POST /auth/reset-password
  • Body
  • content type Modified
    • password_confirmation property Removed
POST /manager/products
  • Response
  • 201 response Modified
    • stock property Modified
    • discount_percentage, price_catalog, reference_unit_price, youtube_id, url, image properties Added
PUT /manager/products/{id}
  • Response
  • 200 response Modified
    • stock property Modified
    • discount_percentage, price_catalog, reference_unit_price, youtube_id, url, image properties Added
Removed 1 Breaking
GET /manager/me/brand
Added 7
GET /brand
GET /manager/alerts
GET /manager/ambassadors/{id}/alerts
GET /widget/posts
GET /widget/posts/{id}
POST /widget/analytics
PUT /manager/ambassadors/{id}/alerts
1 structure change including:
1 Modification
Modified 1 Breaking
GET /manager/bi/report
  • Response
  • 200 response Modified
    • embedUrl, accessToken, tokenExpiry, reportId properties Removed
    • report property Added