Platform Docs

Changes to the REST API - May 30th, 2018

We at Clover are always working on optimizing our REST API services for 3rd party developers. This includes addressing issues of inefficiency and redundancy in our REST API expansions.

At this stage in our process, we are deprecating the following expansions in the next 3 weeks. If you are currently using any of these expansions, you can use workarounds (mentioned below) that are more efficient. These deprecations affect apps that are built using our REST API.

Deprecated Expansion
Workaround

/v3/merchants/{M_ID}/customers?expand=orders

GET /v3/merchants/{M_ID}/orders to find orders and customers associated with them

/v3/merchants/{M_ID}/employees?expand=orders

GET /v3/merchants/{M_ID}/employees/{EMP_ID}/orders to find orders for a specific employee

/v3/merchants/{M_ID}/employees?expand=payments

GET /v3/merchants/{M_ID}/employees/{EMP_ID}/payments to find payments for a specific employee

/v3/merchants/{M_ID}/employees/{EMP_ID}?expand=orders

GET /v3/merchants/{M_ID}/employees/{EMP_ID}/orders

/v3/merchants/{M_ID}/employees/{EMP_ID}?expand=payments

GET /v3/merchants/{M_ID}/employees/{EMP_ID}/payments

/v3/merchants/{M_ID}/orders?expand=customers

Use GET /v3/merchants/{M_ID}/orders to get an array of customer IDs. For a chosen customer ID, use GET /v3/merchants/{M_ID}/customers/{CUSTOMER_ID}.

/v3/merchants/{M_ID}/payments?expand=employee

Use GET /v3/merchants/{M_ID}/payments to get an Employee object, which includes an employee ID. For a chosen employee ID, use GET /v3/merchants/{M_ID}/employees/{EMP_ID}.

For questions and feedback, please use https://community.clover.com.

To receive more 3rd party developers communication from Clover, sign up here.


Changes to the REST API - May 30th, 2018


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.