Skip to main content
POST
Create an integration mapping

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Body

application/json
name
string
required

Human-readable name for the mapping.

Maximum string length: 255
action
enum<string>
required

What the mapping transforms.

Available options:
PUSH_ORDERS,
PUSH_PRODUCTS,
PUSH_INBOUND_SHIPMENT
description
string | null
source_type
enum<string> | null

Type of record the mapping reads from.

Available options:
FULFILLMENT_ORDER,
PRODUCT,
PURCHASE_ORDER
source_integration_account_id
integer | null

Integration account the source payload comes from.

destination_integration_account_id
integer | null

Integration account the transformed payload is pushed to.

source_order_id
integer | null

Seed the mapping from an existing fulfillment order.

source_product_id
integer | null

Seed the mapping from an existing product.

source_purchase_order_id
integer | null

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.

source_supplier_purchase_order_shipment_id
integer | null

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.

mapping_config
object[] | null

Transformation rules. See the Integration Mapping Guide for the rule structure and field-path syntax.

source_schema
object[] | null
destination_schema
object[] | null
is_active
boolean | null

Response

Integration mapping created

data
object