Deprecations

Endpoints currently sunsetting

The following endpoints are being gradually disabled and will stop working completely after the date indicated in the table. Before the sunset date, those endpoints will randomly, at an increasing rate, return 410 Gone responses. After the sunset date endpoints will return an error response to all requests.

API version	Endpoint	Method	Replacement	Deprecation date	Sunset date
1.0	/api/1.0/register_sale/:id	GET	/api/2.0/sales/:id	01/06/2017	30/04/2018
1.0	/api/1.0/consignment/:id	GET	/api/2.0/consignments/:id	01/06/2017	30/04/2018
1.0	/api/1.0/consignment_product/:id	GET	N/A	01/06/2017	30/04/2018
1.0	/api/1.0/customer/:id	GET	/api/2.0/customers/:id	01/06/2017	30/04/2018
1.0	/api/1.0/supplier/:id	GET	/api/2.0/suppliers/:id	01/06/2017	30/04/2018

Deprecated endpoints

The following endpoints have been deprecated which means they should not be used in new applications. Instead, new endpoints should be used as indicated in the table below.

API version	Endpoint	Method	Replacement	Deprecation date	Sunset date
0.9	/api/consignment	GET	/api/2.0/consignments	01/06/2017	TBA
0.9	/api/consignment	POST	/api/2.0/consignments	01/06/2017	TBA
0.9	/api/consignment/:id	GET	/api/2.0/consignments/:id	01/06/2017	TBA
0.9	/api/consignment/:id	PUT	/api/2.0/consignments/:id	01/06/2017	TBA
0.9	/api/consignment/:id	DELETE	/api/2.0/consignments/:id	01/06/2017	TBA
0.9	/api/consignment_product	GET	/api/2.0/consignments/:id/products	01/06/2017	TBA
0.9	/api/consignment_product	POST	/api/2.0/consignments/:id/products	01/06/2017	TBA
0.9	/api/consignment_product/:id	PUT	/api/2.0/consignments/:consignment_id/products/:product_id	01/06/2017	TBA
0.9	/api/consignment_product/:id	DELETE	/api/2.0/consignments/:consignment_id/products/:product_id	01/06/2017	TBA
0.9	/api/customers	GET	/api/2.0/customers	01/06/2017	TBA
0.9	/api/customers	POST	/api/2.0/customers /api/2.0/customers	01/06/2017	TBA
0.9	/api/outlets	GET	/api/2.0/outlets	01/06/2017	TBA
0.9	/api/payment_types	GET	/api/2.0/payment_types	01/06/2017	TBA
0.9	/api/products	GET	/api/2.0/products /api/2.0/inventory	01/06/2017	TBA
0.9	/api/products/:id	GET	/api/2.0/products/:id /api/2.0/products/:id/inventory	01/06/2017	TBA
0.9	/api/register_sales	GET	/api/2.0/sales	01/06/2017	TBA
0.9	/api/register_sales/:id	GET	/api/2.0/sales/:id	01/06/2017	TBA
0.9	/api/registers	GET	/api/2.0/registers	01/06/2017	TBA
0.9	/api/supplier	GET	/api/2.0/suppliers	01/06/2017	TBA
0.9	/api/supplier/:id	GET	/api/2.0/suppliers/:id	01/06/2017	TBA
0.9	/api/taxes	GET	/api/2.0/taxes	01/06/2017	TBA
0.9	/api/users	GET	/api/2.0/users	01/06/2017	TBA
1.0	/api/1.0/product/:id	GET	/api/2.0/products/:id	01/06/2017	TBA
1.0	/api/1.0/product_type/:id	GET	/api/2.0/product_types/:id	01/06/2017	TBA
2.0	/api/2.0/price_books	GET	/api/3.0/price_books	01/07/2023	TBA
2.0	/api/2.0/price_books/:id	GET	/api/3.0/price_books/:id	01/07/2023	TBA
2.0	/api/2.0/price_books	POST	/api/3.0/price_books	01/07/2023	TBA
2.0	/api/2.0/price_books/:id	PUT	/api/3.0/price_books/:id	01/07/2023	TBA
2.0	/api/2.0/price_books/:id	DELETE	/api/3.0/price_books/:id	01/07/2023	TBA
2.0	/api/2.0/product_types	GET	/api/2.0/product_categories	25/10/2023	TBA