External IDs map iPaaS.com internal record IDs to IDs in external systems (for example, Shopify, Magento, or NetSuite). They appear as an external_ids array on POST/PUT request bodies and in GET responses.
Request shape (nested inside a parent record's POST/PUT)
Each item in the external_ids array:
Field | Type | Required | Description |
| long | Yes | The iPaaS.com System Id (Subscription Id) for the external system this ID belongs to. Must be greater than 0. |
| string | Yes | The ID of this record in the external system. |
| string | No | The iPaaS internal ID of the record. When nested inside a parent POST/PUT, this is typically populated automatically from the parent context. |
Example (nested inside a parent POST/PUT)
{
"name": "Example Product",
"external_ids": [
{
"system_id": 5,
"external_id": "SKU-12345"
}
]
}
Response shape (when reading a parent record)
Each item in the external_ids array on a response:
Field | Type | Description |
| string | The external ID record's own iPaaS.com id. |
| long | The iPaaS.com System Id (Subscription Id) for the external system. |
| string | The ID of this record in the external system. |
| string | The iPaaS internal ID of the parent record. |
Managing external IDs directly
Each data API also exposes dedicated External ID endpoints for looking up, creating, updating, and deleting external ID mappings outside of the parent record's POST/PUT:
GET /v2/External/LookupExternal/{id}/{systemId}/{tableName}: Get the external ID for a record by iPaaS ID, system, and table.GET /v2/External/LookupSpaceport/{systemId}/{tableName}/{externalid}: Get the iPaaS ID for a record by external ID, system, and table.POST /v2/External/LookupSpecial: Same as LookupSpaceport but accepts the external ID in the request body (for IDs with special characters).GET /v2/External/Missing/{systemId}/{tableName}: Find records that don't have an external ID for a given system.POST /v2/External/UpdateExternalId: Create or update an external ID mapping.DELETE /v2/External: remove an external ID mapping.