Skip to main content

Override Levels

LevelScope
Environment LevelApplies to all accounts using an integration in an environment
Integrated Account LevelApplies to a specific connected account
Account-level overrides take precedence over environment-level.

Override at Integrated Account Level

Via API

curl -X PATCH 'https://api.usehandled.io/api/v1/ipaas/integrated-account/{id}' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "unified_model_override": {
      "wms": {
        "orders": {
          "list": {
            "query_mapping": "{ \"warehouse_id\": query.location_id }",
            "response_mapping": "{ \"location\": response.warehouse_name }"
          }
        }
      }
    }
  }'

Structure

unified_model_override:
  {unified_api_name}:
    {resource}:
      {method}:
        query_mapping: "JSONata expression"
        response_mapping: "JSONata expression"

Override at Environment Level

Via UI

1

Open Unified API

Go to Installed Unified API > Mapping
2

Select Integration

Select the integration
3

Edit Mapping

Click the edit icon next to the method
4

Modify

Modify mappings (Query, Response, Error, Headers)
5

Save

Save changes

Via API

# Get the installed unified model ID
curl 'https://api.usehandled.io/api/v1/ipaas/environment-unified-model?unified_model.name=wms' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

# Apply override
curl -X PATCH 'https://api.usehandled.io/api/v1/ipaas/environment-unified-model/{id}' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "override": {
      "resources": {
        "orders": {
          "integration_mapping": {
            "shiphero": {
              "list": {
                "response_mapping": "{ \"custom_field\": response.extra_data }"
              }
            }
          }
        }
      }
    }
  }'

Available Bindings

Use these in your JSONata expressions:
BindingDescription
responseRaw API response
queryMapped query parameters
rawQueryOriginal query parameters
bodyRequest body
contextAccount variables