Skip to main content

​
Create a Unified API

1

Open Catalog

Go to Catalog
2

Create

Click Create Unified API

​
Basic Details

FieldDescription
NameAPI identifier in kebab-case (e.g., wms)
LabelDisplay name (e.g., “Warehouse Management”)
CategoryOrganizational grouping
The name sets the API path: /unified/{name}

​
Add Resources

Resources are the data types in your API (e.g., orders, inventory).
1

Open Resources Tab

Click Resources tab
2

Add Resource

Click Add Resource
3

Name Resource

Enter name in snake_case (e.g., orders)

​
Define Schema

The schema describes your response structure: 
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique order identifier"
    },
    "status": {
      "type": "string",
      "description": "Order status"
    },
    "line_items": {
      "type": "array",
      "description": "Products in the order"
    }
  }
}

​
Add Methods

Methods define operations on resources.
1

Select Resource

Select your resource
2

Open Mapping Tab

Click Mapping tab
3

Add Method

Click Add Method
Standard methods: list, get, create, update, delete

​
Configure Mappings

For each integration, define how to translate data.

​
Query Mapping

Transform query parameters: 
Unified query: {status: "pending"}
Mapped to ShipHero: {order_status: "PENDING"}

​
Response Mapping

Transform responses using JSONata: 
{
  "id": order_id,
  "status": $lowercase(order_status),
  "created_at": created_date
}

​
Request Body Mapping

For create/update operations: 
{
  "order_title": body.name,
  "line_items": body.items
}

​
Static Responses

For endpoints that return fixed data:
  1. Enable Static Mapping
  2. Define the response:
{
  "statuses": ["pending", "processing", "shipped", "delivered"]
}
No API call is made - the static response is returned directly.

​
Before and After Steps

​
Before Steps

Run before the main API call:
  • Fetch related data
  • Validate inputs
  • Set up context

​
After Steps

Run after the main API call:
  • Enrich responses
  • Fetch complete records after creates
  • Log events