This article contains the following information related to APIs.
- API Version
- Pagination Info
- Throttling Info
- Handling Errors
API version of Acumatica Connector depends on the <Endpoint version> provided in the Swagger URL during the Vault entry creation.
For more information on Acumatica Endpoint Version:
Pagination in case of Acumatica can be achieved by using parameters such as $filter and $top
For instance :
First export the first 100 sales orders from your AcumaticaERP instance by using SalesOrder_GetList.bps providing the value of $top as 100.
Since the primary key of the Sales Order entity is composed by the Order Type and the Order Number, in this example you will be using a combination of filter parameters for the Order Type and Order Number fields. To request sales orders from 100 to 200 of the SO type, you should use SalesOrder_GetList.bps providing the value of $top as 100 and $filter as OrderType eq 'SO' and OrderNbr gt '<OrderNbr>' where <OrderNbr> is the number of the last sales order exported with a previous bps call.
For more information on Parameters for Retrieving Records from Acumatica, please visit: https://help-2019r2.acumatica.com/(W(12))/Wiki/ShowWiki.aspx?pageid=c5e2f36a-0971-4b33-b127-3c3fe14106ff
When API calls are declined by Acumatica due to throttling, the Business Process from the Acumatica Connector Project will fail with a 429 status code.
For more information on how concurrent requests are handled by Acumatica, please refer to the section License Restrictions for API Users in:
For more information on License Monitoring Console form to view rate limits please visit: https://help.acumatica.com/Help?ScreenId=ShowWiki&pageid=06869c57-819d-4626-a5a8-72507e6a79d8
When the Acumatica Connector Business Process's API call is successful (returning status code between 200 & 300), the BP task will pass and return response payload. (Note: the task is marked as completed in the Admin Console perspective/Auditor View).
Should the Acumatica Connector Business Process's API call fail (response status code not between 200 & 300), then the BP task fails without returning any response payload. (Note: the task is marked as failed; the error payload is returned from Acumatica, and stack traces are logged in the Admin Console perspective/Auditor View).
Should the Shopify Connector Business Process's API call execution fail (which can be an internal error such as payload parse issue), then the BP task will fail without returning any response payload. The task will be marked as failed in the Admin Console perspective/Auditor View, and stack traces are logged.