Open API Endpoints from the ERP Manager navigation. The screen lists inbound surfaces that expose mapped ERP data to the storefront. Each endpoint pairs a data mapping with a named API function and carries toggles that control its runtime behaviour.
List view
Control | Purpose |
Type | This filter narrows the list to all endpoints or only those with Cron Job enabled. Its options are All and Cron. |
Ready | This filter narrows the list by the Ready toggle, so you can separate endpoints that are cleared for use from those still being prepared. |
API Function | This filter narrows the list to endpoints that implement the selected API function. Use it to find an endpoint serving a particular function when the list is long. |
Control | Purpose |
Rows per page | This control determines how many records appear on each page. |
Pagination controls | Use the pagination controls to move between pages. |
Column | Description |
Data mapping | This column contains the name of the data mapping the endpoint serves. |
Api function | This column contains the API function identifier that the endpoint implements. |
Ready | This column indicates whether the endpoint is marked ready for use. |
Sync once | This column indicates whether a one-time synchronisation is configured for the endpoint. |
Cron job | This column indicates whether a scheduled cron job is enabled for the endpoint. |
Pricing calculator | This column indicates whether the pricing calculator is enabled for the endpoint. |
Action | Description |
Sync | This action triggers a synchronisation run for all selected endpoints. Select one or more rows before selecting Sync. |
Create | This action opens the create form for a new API endpoint. |
Delete | This action deletes all selected endpoints. Select one or more rows before selecting Delete. |
Create and detail form
An existing record uses the Edit Api Endpoint heading, and a new record uses the same fields.
Field | Description | Required | State |
Data mapping | This field contains the data mapping that the endpoint exposes. | The field is required. | The field is read-only on an existing record, and its Open button is disabled. |
Api function | This field contains the API function that the endpoint implements. | The field is required. | The field is read-only on an existing record. |
Ready | When on, this toggle marks the endpoint as ready and available for use. | The field is optional. | The field is available as a toggle. |
Cron Job | When on, this toggle enables a cron job schedule for the endpoint. | The field is optional. | The field is available as a toggle. |
Sync once | When on, this toggle configures a single synchronisation run for the endpoint. | The field is optional. | The field is available as a toggle. |
Pricing Calculator | When on, this toggle activates the pricing calculator for the endpoint. | The field is optional. | The field is available as a toggle. |
Action | Description | State |
Delete | This action permanently deletes the endpoint record. | The action is available on the existing-record form. |
Save | This action saves all changes to the endpoint. | The action is disabled on the existing-record form shown. |
Notes
Data mapping and Api function are read-only on an existing record. To change either, delete the endpoint and create a new one with the correct values.
The Ready, Sync once, Cron job, and Pricing calculator columns reflect the toggle states set in the detail form. The list does not display the toggle values explicitly, and cells appear empty when a toggle is not set.
Related