Piggy Logo
Postman
Getting started
  • Overview
  • Migrate to v3 🚀
  • Testing
  • Error handling
  • Client Libraries
  • Webhooks
  • Loyalty Tokens
Guides
OAuth API
Registers & POS API
Back to home

ChangeLog

Stay up to date for all developments concerning our API, highly recommended for integrating partners. Sign up here.

As the Piggy Loyalty system keeps innovating and improving, new features become available for the API as well. From time to time, we'll add new API calls, fields, and other resources. All changes will be documented and can be found here.


July 2023


July 14, 2023

    • The Webhook subscription system is now live! The following events are now available for webhooks: contact_created, contact_updated, credit_reception_created, prepaid_transaction_created, voucher_redeemed and form_submission_completed.

June 2023


June 30, 2023

    • Promotions and Voucher API calls are now available for both Register & OAuth API.

June 28, 2023

    • In the V3 OAuth API, it is now possible to retrieve an Account's Forms.
    • In the V3 OAuth API, it is now possible to retrieve an Account's Brand Kit.

May 2023


May 9, 2023

    • It is now possible to request a contact auth token.

May 4, 2023

    • Deleting Contacts is now possible over API.

February 2023


February 3, 2023

    • In the V3 OAuth API, it is now possible to create a loyalty token.

October 2022


October 14, 2022

    • In the V3 OAuth API, it is now possible to calculate credits before doing a credit reception.

October 12, 2022

    • In the V3 OAuth API, it is now possible to generate a login URL for the Custom App.

August 2022


August 3, 2022

  • In the V3 API, it is now possible to set loyalty transaction attributes on the 'Create Credit Reception' API call.

July 2022


July 25, 2022

  • 'Link Contact Identifier' API calls are now live for both OAuth & Register.
  • 'Claim Anonymous Contact' API calls are now live for both OAuth & Register.

June 2022


June 29, 2022

  • Units API calls are now available for the OAuth & Register API.

June 23, 2022

  • Automation API calls are now available for the OAuth API.

June 14, 2022

  • Contact Verification API calls are now available for the OAuth API.

June 8, 2022

  • The Get Giftcard Transaction API call is now available for both the Register API and the OAuth API.

May 2022


May 25, 2022

  • The Subscription Types and Contact Subscriptions API calls are now available for both the Register API and the OAuth API.

April 2022


April 28, 2022

March 2022


March 21, 2022

  • The new V3 API is now live! The new API contains some breaking changes – so make sure to carefully read the migration guide – but also contains some new features and new API calls:
  • Prepaid transactions
  • Create custom Reward Attributes via API
  • Support for Units has been added
  • Support for Contact Identifiers has been added

February 2022


February 16, 2022

  • Anonymously registering customers is now possibly via API.

November 2021


November 5, 2021

  • The List Members API call is now available.

October 2021


October 14, 2021

  • Guides for employee loyalty programs are now live. Check them out here.

October 7, 2021

  • Claim Reward API calls can now also be conducted using a member ID instead of a loyalty card ID.

September 2021


September 17, 2021

  • The Get Rewards response has been expanded to include the 'external_property' and 'media' properties.

September 7, 2021

  • The examples views are now part of larger tutorials which should give a better sense of the integration process.
  • OAuth guides and examples views as well as a Get Started guide have been added.
  • Also, important decisions that need to be made in the integration process are discussed more thoroughly.
  • All guides and examples can be found here.

September 2, 2021

  • Example views for the Register API is now live. Check them out here.

August 2021


August 2, 2021

  • Added the is_subscribed field to the 'Update Marketing Recipient' API calls of the OAuth API and Register API.

June 2021


June 22, 2021

May 2021


May 27, 2021

  • Example response in creation of reward receptions API calls have been updated. It now includes the new 'External Property'. Please note: the credits returned on reward receptions are now negative numbers.

May 21, 2021

May 14, 2021

April 2021


April 23, 2021

  • Updated the Member and Loyalty Card calls to include Custom Attributes in the response.

April 13, 2021

  • Our first SDK for PHP has been released! Check it out here.
  • Removed all Sandbox references from the API Docs. Testing is to be done from the Production Environment from now on. Developers already testing on the Sandbox environment may continue to do so.
  • Added Staged Credit Reception calls for the Register API.

March 2021


March 31, 2021

March 17, 2021

March 16, 2021

March 15, 2021

  • Information about Custom Attributes is now available. Relatively new entities, they concern both Loyalty and Marketing.
  • API calls for the Marketing system are now available. These API calls concern Marketing Recipients only, check them out for the Register API and for the OAuth API.

March 12, 2021

  • Added instructions on creating (most) entities in the Business Dashboard. The instructions have been added underneath each entity on the Entities page.

March 5, 2021

  • API calls for the Giftcards system are now available. These API calls concern the creation of giftcard transactions and retrieval of giftcard information. Check them out for the Register API and for the OAuth API.