Create an integration mapping
Create a new integration mapping.
The mapping_config payload defines how source fields are transformed into the
destination shape. See the Integration Mapping Guide
for the rule structure, field-path syntax, the full transformation catalogue, and
fallback behavior.
A mapping may optionally be seeded from an existing source record by passing one of
the source_* foreign keys. source_supplier_purchase_order_shipment_id seeds the
mapping from an inbound purchase-order shipment and is used together with
action: PUSH_INBOUND_SHIPMENT. For inbound-shipment mappings you may pass
source_supplier_purchase_order_shipment_id on its own — source_purchase_order_id
is then inferred from the shipment’s linked purchase-order items (the majority PO).
The request is rejected if the shipment has no linked purchase-order items.
Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Body
Human-readable name for the mapping.
255What the mapping transforms.
PUSH_ORDERS, PUSH_PRODUCTS, PUSH_INBOUND_SHIPMENT Type of record the mapping reads from.
FULFILLMENT_ORDER, PRODUCT, PURCHASE_ORDER Integration account the source payload comes from.
Integration account the transformed payload is pushed to.
Seed the mapping from an existing fulfillment order.
Seed the mapping from an existing product.
Seed the mapping from an existing purchase order. For
PUSH_INBOUND_SHIPMENT mappings this may be omitted when
source_supplier_purchase_order_shipment_id is provided — it is then
inferred from the shipment's majority linked purchase-order items.
Seed the mapping from an existing inbound purchase-order shipment.
Used with action: PUSH_INBOUND_SHIPMENT. May be supplied without
source_purchase_order_id, in which case the purchase order is inferred
from the shipment's linked purchase-order items; the request is rejected
if the shipment has none.
Transformation rules. See the Integration Mapping Guide for the rule structure and field-path syntax.
Response
Integration mapping created