Customer API Guide

Introduction

Customer API allows you to synchronize all IndicaOnline customers with third-party integration systems.

Customer API allows you to:

  • send all customer profile data present in IndicaOnline to a third-party system;
  • synchronize all customer profile updates with a third-party system;
  • exchange necessary attachments for validating customers;
  • return information about all customers present in your IndicaOnline account;
  • synchronize all manual patient groups present in IndicaOnline with a third-party system;
  • return information about all manual patient groups present in your IndicaOnline account.

Endpoints

  • Create customer -  Allows you to create a customer profile. Usually, it’s utilized when a first time customer without a profile is making an order.
  • Update customer by ID - Allows you to update an existing customer profile. Available only to PRO tariff users.
  • Patch customer by ID -  Allows you to update a specific field in a customer profile. Available only to PRO tariff users.
  • Get customer by ID - Allows you to request customer information using their unique ID. Available only to PRO tariff users.
  • Get customer by state ID - Allows you to request customer information using their state ID. Available only to PRO tariff users.
  • Get customers - Allows you to request information on all customer profiles that were created within the specified date range.
  • Get customer by patient ID - Allows you to link a customer’s data between v.1.1.0 and v.2.0.0.
  • Get customer groups - Allows you to request information on all manual and automatic patient groups.

Limitations

  • Attached documents must be one of the following types: jpeg; jpg; png; pdf.