Use ERP Manager to define the structure of the JSON body that it sends to an ERP endpoint, then add the schema's fields.

Before you begin

Configure at least one client connection before creating the schema. For connection setup instructions, see Connect an ERP.

Steps

In the sidebar, select Payload Schemas. The list of existing schemas opens.
Select Create. The Create Payload Schema form opens.
In Client connection, select the client connection to associate with the schema.
In Name, enter a unique name for the schema.
Optional: In Endpoint, enter the API path without a leading slash, such as create-sale-order.
In Method, select one of POST, PUT, PATCH, or DELETE.
In Root type, select Object or Array for the schema's root JSON structure. Use Object for a single JSON object and Array for a JSON array.
Select Save. ERP Manager creates the schema and opens its detail view with General and Fields tabs.
Select the Fields tab. The Payload Fields table opens.
To add a top-level field, select Create Payload Field. The Create Payload Field form opens.
In Name, enter the field name. In Data type, select one of String, Int, Float, Bool, Association one, or Association many.
Select Save on the field form. The new field appears in the Payload Fields table with its Name and Data Type.
Expand the existing parent field's row, then open child-field creation.
Complete the child field form and select Save. The child field appears in the nested Payload Fields table beneath the parent.
Repeat the top-level and nested field steps until all fields are defined.

The payload schema is saved and appears in the Payload Schemas list with its name, method, endpoint, and root type.

If Save is disabled, select values for Client connection, Method, and Root type before saving.
If a field does not appear, confirm that you selected Save on the field form. Unsaved field forms are discarded if you navigate away.