API Changelog

This is the changelog for Shout's Api. View past and upcoming changes here.

Changes to Shout's Api will be documented here. If you have any questions, please contact developer support.

Upcoming breaking changes will be posted as soon as we know about them. New api versions often have breaking changes from past api versions but we do our best to not break past api versions as well. A past version should continue working the same way it did when it was released.

Normally additions to the api will be added to the latest api version instead of creating a whole new version. If you are using an older api version, you may need to upgrade to the latest api version to use the new features.

Next Api Version

Release unknown

Api Version 20230615

Released 2023-08-15

Modified Webhooks

  • For select connect plugin types, we now include whether the connecting user would like to sync historical orders in the api_client_granted_user_created webhook. The webhook will include the field connect_import_order_history_at which will be either a Date or a null value.

Modified Endpoints

  • /orders - We added the fields shipping_link, shipping_state, and shipping_source to the orders endpoint. You can create and update orders with these fields. Creating or updating an order with a shipping_link or with a shipping_state with a value other than unknown or pre_transit will automatically update the shipped_at field of the order to prevent confusion, though we recommend that you continue to set the actual shipped_at value with your api calls.
  • /orders - The orders endpoint now supports GET, PUT, and DELETE requests using a connect reference_id. This enhancement allows for quicker connect integrations, as integrating systems no longer need to track Shout's order id in order to update orders via the API. You must prefix your reference id with the string reference_id- in the endpoint url. You can also add the HTTP header X-Fail-Creation-On-Duplicate-Reference-Id with the value true with your POST calls to ensure that duplicate orders are not created in connected accounts. Documentation.
  • /orders - The order endpoint now includes the field line_items.sku. New orders created with this field will automatically find or create the sku in the connected users account. SKUs allow the connected user the ability to filter and sort their contacts by the SKU(s) that the contact has purchased. Documentation.
  • /orders - The order endpoint now includes the field created_at. This allows you to more accurately add historical orders to Shout and to update the date orders were created via the endpoint. Documentation.

Fixed endpoints

  • /connect_client/:connect_client_id/upsert_connect_user - We fixed where creating new downline team members with the POST /connect_client/:connect_client_id/upsert_connect_user call was not adding the name to the connected user's contact. Documentation.

Api Version 20230615

Released 2023-06-15

Breaking Change

We changed the wording from "back office" to "connect" with our rebrand to "Shout Connect". All the same resources, endpoints, and fields are still available in this api version but the wording has changed to reflect the new branding.

Notable changes

  • The "Back Office Client" api resource is now called "Connect Client". The route changed from "/back_office_clients" to "/connect_clients"
  • The "Back Office User" api resource is now called "Connect User". The route changed from "/back_office_users" to "/connect_users"
  • On Connect Users the field "back_office_id" is now called "connect_id". "parent_back_office_id" is now called "parent_connect_id"
  • The back office plugin is now called the connect plugin
  • When booting the connect plugin please now specify "connect_id" instead of "back_office_id" in the query params. Using "back_office_id" will still work for now but will be removed soon.

New

New Resources

New Endpoints

Modified Endpoints

  • /messages/send_shout_message. Updated to support specifying Shout Connect fields like connect_id and user_id - Documentation
  • /messages/send_text_message. Updated to support specifying Shout Connect fields like connect_id and user_id - Documentation

Misc

  • Real api examples for many of the existing resources
  • Api docs cleanup to be more user friendly and easier to read
  • Api docs version and credential management

Api Version 20210901

Released 2021-09-01

Links