Skip to main content
POST
Update 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.

Path Parameters

id
integer
required

Integration mapping ID

Body

application/json
name
string
Maximum string length: 255
description
string | null
source_order_id
integer | null

Source fulfillment order. Mutually exclusive with the other two source_* order fields.

source_product_id
integer | null

Source product. Mutually exclusive with the other two source_* order fields.

source_purchase_order_id
integer | null

Source purchase order. Mutually exclusive with the other two source_* order fields.

source_supplier_purchase_order_shipment_id
integer | null

Inbound purchase-order shipment the mapping is sourced from (for PUSH_INBOUND_SHIPMENT mappings). Setting this without source_purchase_order_id infers the purchase order from the shipment's linked purchase-order items; the request is rejected if the shipment has none.

mapping_config
object[] | null
is_active
boolean | null

Response

Successful response

data
object

Updated integration mapping record (same shape as GET /integration-mappings/{id}).