Skip to main content

Create an outbound mapping

An outbound mapping defines how platform data is shaped and sent to a client's ERP.

N
Written by Niyaz

Use an outbound mapping to bind a source model to a payload schema and define how platform data is shaped and sent to a client's ERP.

Create Outbound Mapping form with Name, Basic api schema, Payload schema, Cancel, and Save controls.

Before you begin

  • Prepare a payload schema that targets the ERP endpoint, or create one first if it does not exist.

  • Ensure that a basic API schema is available for the source model you intend to map.

Steps

  1. In the ERP Manager sidebar, select Outbound Mappings. The Outbound Mappings list displays Name and Source Model columns.

  2. Select Create. The Create Outbound Mapping form opens.

  3. In Name, enter a descriptive name for the mapping.

  4. In Basic api schema, select the source model that supplies the data. The available options include Order, OrderLine, PriceOffer, PriceOfferLine, PriorityOrder, ReturnDocument, ReturnLine, and Shipping.

  5. In Payload schema, select the payload schema that defines the ERP's expected structure.

  6. Select Save. The mapping is saved and the record opens on the General Info tab.

  7. Select the Relation tab to configure field mappings.

  8. On the Relation tab, select Create Outbound Mapping Line. The Create Property Mapping Line dialog opens.

  9. In Payload field, select the payload field to map. In Source name, select the corresponding source field.

  10. Optional: In Simple logic rule, select a conversion rule, enter a Default value, or set Required and Allow Null as needed.

  11. Select Save in the Create Property Mapping Line dialog. Repeat the mapping-line steps for each top-level field you need to map.

  12. For a field that represents a nested object or list, select its row in the Outbound Mapping Lines table. Create a child field for the selected parent. A child-level Outbound Mapping Lines table appears beneath the parent row.

  13. Add each child field mapping using the same mapping-line process.

  14. Repeat the nested-field process for any additional parent fields that have nested children.

Result

The outbound mapping appears in the Outbound Mappings list. Its Relation tab holds the full set of field mappings, including top-level lines and nested child fields. ERP Manager uses these mappings when sending platform data to the client's ERP.

If something goes wrong

  • If Save is disabled, select a value for Basic api schema and Payload schema before continuing.

  • If the expected source model is not listed, create the basic query first.

  • If the expected payload schema is not listed, create the missing payload schema first.

Related

Did this answer your question?