Interchange API reference

Search by part number or description

GET /v1/search operationId searchParts

Finds candidate items. An exact manufacturer or supplier part number outranks a pattern match, and a pattern match outranks a text match, and identified_by says which applied. Candidates are not equivalences: call getEquivalents for those.

Works without a key. A key raises the limits.

Parameters

Responses

{
  "meta": {
    "api_version": "v1",
    "data_set": "sandbox"
  },
  "query": "ALDC200C",
  "status": "matched",
  "results": [
    {
      "ix_id": "IX-CAM-C-200-AL",
      "name": "Camlock Type C, 2\" (50 mm), aluminium",
      "identified_by": "exact_code",
      "matched_on": {
        "brand": "Dixon",
        "part_number": "ALDC200C"
      },
      "confidence": "verified",
      "safety_flags": []
    }
  ],
  "usage": {
    "attribution": "Source: Interchange (interchangeparts.com.au)",
    "disclaimer": "Cross-reference only. Check the manufacturer's current specification, rating and media compatibility before use."
  }
}

{
  "meta": {
    "api_version": "v1",
    "data_set": "sandbox"
  },
  "query": "ZZ-9999",
  "status": "no_verified_match",
  "reason": "No reviewed item has this part number or description.",
  "results": [],
  "usage": {
    "attribution": "Source: Interchange (interchangeparts.com.au)",
    "disclaimer": "Cross-reference only. Check the manufacturer's current specification, rating and media compatibility before use."
  }
}

Code examples

These calls will work when the sandbox opens. Until then they show the shape of a request and the answer you will get. Examples use the values from this operation’s specification.

curl -s "https://api.interchangeparts.com.au/v1/search?q=ALDC200C"

const response = await fetch("https://api.interchangeparts.com.au/v1/search?q=ALDC200C");
const body = await response.json();
console.log(response.status, body);

import requests

response = requests.get(
    "https://api.interchangeparts.com.au/v1/search",
    params={
        "q": "ALDC200C",
    },
)
print(response.status_code, response.json())

Get one item

GET /v1/items/{ix_id} operationId getItem

The specification, attributes and safety flags of one canonical item. A retired item still resolves and points to its successor in replaced_by. A withdrawn item does not resolve: it answers 410 Gone and must no longer be shown.

Works without a key. A key raises the limits.

Parameters

Responses

{
  "meta": {
    "api_version": "v1",
    "data_set": "sandbox"
  },
  "item": {
    "ix_id": "IX-CAM-C-200-AL",
    "name": "Camlock Type C, 2\" (50 mm), aluminium",
    "family": "camlock",
    "status": "published",
    "attributes": {
      "type": {
        "value": "C",
        "label": "Type",
        "detail": "Female coupler x hose tail"
      },
      "size": {
        "value": 50,
        "unit": "mm",
        "label": "Nominal size"
      },
      "bodyMaterial": {
        "value": "aluminium",
        "label": "Body material"
      },
      "grooveStandard": {
        "value": "A-A-59326",
        "label": "Groove standard"
      }
    },
    "safety_flags": [],
    "reviewed": "2026-10-28",
    "url": "https://interchangeparts.com.au/items/IX-CAM-C-200-AL"
  },
  "usage": {
    "attribution": "Source: Interchange (interchangeparts.com.au)",
    "disclaimer": "Cross-reference only. Check the manufacturer's current specification, rating and media compatibility before use."
  }
}

{
  "type": "https://interchangeparts.com.au/problems/not-found",
  "title": "Item not found",
  "status": 404,
  "code": "not_found",
  "detail": "No item has the ID IX-NOPE-X-000-ZZ.",
  "request_id": "req_7c1f3a"
}

{
  "type": "https://interchangeparts.com.au/problems/withdrawn",
  "title": "Item withdrawn",
  "status": 410,
  "code": "withdrawn",
  "detail": "This item was withdrawn after a correction.",
  "replaced_by": "IX-CAM-C-200-AL",
  "request_id": "req_7c1f3b"
}

Code examples

These calls will work when the sandbox opens. Until then they show the shape of a request and the answer you will get. Examples use the values from this operation’s specification.

curl -s "https://api.interchangeparts.com.au/v1/items/IX-CAM-C-200-AL"

const response = await fetch("https://api.interchangeparts.com.au/v1/items/IX-CAM-C-200-AL");
const body = await response.json();
console.log(response.status, body);

import requests

response = requests.get("https://api.interchangeparts.com.au/v1/items/IX-CAM-C-200-AL")
print(response.status_code, response.json())

Every brand's part mapped to an item

GET /v1/items/{ix_id}/equivalents operationId getEquivalents

Exact equivalents are parts that map to this item. Near matches are different items that fit the same way but differ in a stated attribute, such as material, and are always listed apart from exact equivalents. Equivalents are sorted by brand name, A to Z. They are never ordered by plan or payment.

Works without a key. A key raises the limits.

Parameters

Responses

{
  "meta": {
    "api_version": "v1",
    "data_set": "sandbox"
  },
  "ix_id": "IX-CAM-C-200-AL",
  "name": "Camlock Type C, 2\" (50 mm), aluminium",
  "status": "matched",
  "equivalents": [
    {
      "brand": "Alfagomma",
      "part_number": "CC-200-AL",
      "confidence": "verified",
      "reviewed": "2026-10-28",
      "evidence": "standard"
    },
    {
      "brand": "Dixon",
      "part_number": "ALDC200C",
      "confidence": "verified",
      "reviewed": "2026-10-28",
      "evidence": "standard"
    }
  ],
  "near_matches": [
    {
      "ix_id": "IX-CAM-C-200-SS6",
      "name": "Camlock Type C, 2\" (50 mm), 316 stainless",
      "same_fit": true,
      "differences": [
        {
          "attribute": "bodyMaterial",
          "this_value": "aluminium",
          "other_value": "stainless-316"
        }
      ]
    }
  ],
  "safety_flags": [],
  "suppliers_url": "https://interchangeparts.com.au/items/IX-CAM-C-200-AL#suppliers",
  "usage": {
    "attribution": "Source: Interchange (interchangeparts.com.au)",
    "disclaimer": "Cross-reference only. Check the manufacturer's current specification, rating and media compatibility before use."
  }
}

{
  "type": "https://interchangeparts.com.au/problems/not-found",
  "title": "Item not found",
  "status": 404,
  "code": "not_found",
  "detail": "No item has the ID IX-NOPE-X-000-ZZ.",
  "request_id": "req_7c1f3a"
}

{
  "type": "https://interchangeparts.com.au/problems/withdrawn",
  "title": "Item withdrawn",
  "status": 410,
  "code": "withdrawn",
  "detail": "This item was withdrawn after a correction.",
  "replaced_by": "IX-CAM-C-200-AL",
  "request_id": "req_7c1f3b"
}

Code examples

These calls will work when the sandbox opens. Until then they show the shape of a request and the answer you will get. Examples use the values from this operation’s specification.

curl -s "https://api.interchangeparts.com.au/v1/items/IX-CAM-C-200-AL/equivalents"

const response = await fetch("https://api.interchangeparts.com.au/v1/items/IX-CAM-C-200-AL/equivalents");
const body = await response.json();
console.log(response.status, body);

import requests

response = requests.get("https://api.interchangeparts.com.au/v1/items/IX-CAM-C-200-AL/equivalents")
print(response.status_code, response.json())

Suppliers who list an item

GET /v1/items/{ix_id}/suppliers operationId listSuppliers

Suppliers are always sorted by name, A to Z, and a supplier's plan is never exposed or used for ordering. Stock and price are per branch, so a branch in one state never shows stock held in another. They appear only where the supplier chooses to share them.

Works without a key. A key raises the limits.

Parameters

Responses

{
  "type": "https://interchangeparts.com.au/problems/not-found",
  "title": "Item not found",
  "status": 404,
  "code": "not_found",
  "detail": "No item has the ID IX-NOPE-X-000-ZZ.",
  "request_id": "req_7c1f3a"
}

{
  "type": "https://interchangeparts.com.au/problems/withdrawn",
  "title": "Item withdrawn",
  "status": 410,
  "code": "withdrawn",
  "detail": "This item was withdrawn after a correction.",
  "replaced_by": "IX-CAM-C-200-AL",
  "request_id": "req_7c1f3b"
}

Code examples

These calls will work when the sandbox opens. Until then they show the shape of a request and the answer you will get. Examples use the values from this operation’s specification.

curl -s "https://api.interchangeparts.com.au/v1/items/IX-CAM-C-200-AL/suppliers"

const response = await fetch("https://api.interchangeparts.com.au/v1/items/IX-CAM-C-200-AL/suppliers");
const body = await response.json();
console.log(response.status, body);

import requests

response = requests.get("https://api.interchangeparts.com.au/v1/items/IX-CAM-C-200-AL/suppliers")
print(response.status_code, response.json())

Match what you know about a part

POST /v1/match/attributes operationId matchAttributes

For a client that has read a fitting, for example from a photo, and wants the item it could be. Send the attributes you are sure of. The response never fills a gap by guessing: where the answer depends on an attribute you did not send, status is needs_confirmation and confirm holds the questions to put to the person. Ask them and call again with the answers.

Works without a key. A key raises the limits.

Request body

application/json, MatchAttributesRequest, required

{
  "family": "camlock",
  "attributes": {
    "type": "C",
    "size": 50,
    "bodyMaterial": "aluminium"
  }
}

Responses

{
  "meta": {
    "api_version": "v1",
    "data_set": "sandbox"
  },
  "status": "needs_confirmation",
  "candidates": [
    {
      "ix_id": "IX-CAM-C-200-AL",
      "name": "Camlock Type C, 2\" (50 mm), aluminium",
      "safety_flags": [],
      "depends_on": [
        "grooveStandard",
        "endSize"
      ]
    }
  ],
  "confirm": [
    {
      "key": "grooveStandard",
      "question": "Is the groove standard (A-A-59326) or 68 degree?",
      "options": [
        {
          "value": "A-A-59326",
          "label": "Standard"
        },
        {
          "value": "68deg",
          "label": "68 degree"
        }
      ]
    },
    {
      "key": "endSize",
      "question": "What is the nominal size of the other end, the hose tail for a Type C?",
      "options": [
        {
          "value": 50,
          "label": "50 mm"
        }
      ]
    }
  ],
  "safety_flags": [],
  "usage": {
    "attribution": "Source: Interchange (interchangeparts.com.au)",
    "disclaimer": "Cross-reference only. Check the manufacturer's current specification, rating and media compatibility before use."
  }
}

Code examples

These calls will work when the sandbox opens. Until then they show the shape of a request and the answer you will get. Examples use the values from this operation’s specification.

curl -s -X POST "https://api.interchangeparts.com.au/v1/match/attributes" \
  -H "Content-Type: application/json" \
  -d '{
  "family": "camlock",
  "attributes": {
    "type": "C",
    "size": 50,
    "bodyMaterial": "aluminium"
  }
}'

const response = await fetch("https://api.interchangeparts.com.au/v1/match/attributes", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "family": "camlock",
    "attributes": {
      "type": "C",
      "size": 50,
      "bodyMaterial": "aluminium"
    }
  }),
});
const body = await response.json();
console.log(response.status, body);

import requests

response = requests.post(
    "https://api.interchangeparts.com.au/v1/match/attributes",
    json={
        "family": "camlock",
        "attributes": {
            "type": "C",
            "size": 50,
            "bodyMaterial": "aluminium",
        },
    },
)
print(response.status_code, response.json())

Match a list of your part numbers

POST /v1/match operationId matchBatch

Maps up to 1,000 of your own part numbers or descriptions to IX IDs in one call. Needs an API key on a plan that includes batch matching. Each row has its own status, so one unmatched row does not fail the batch. Your rows are used to answer this request and are not added to the public catalogue.

Needs an API key on a plan that includes it.

Request body

application/json, MatchBatchRequest, required

{
  "rows": [
    {
      "ref": "row-1",
      "text": "ALDC200C"
    },
    {
      "ref": "row-2",
      "text": "2 inch type C aluminium camlock",
      "brand": "Dixon"
    }
  ]
}

Responses

Code examples

These calls will work when the sandbox opens. Until then they show the shape of a request and the answer you will get. Examples use the values from this operation’s specification.

curl -s -X POST "https://api.interchangeparts.com.au/v1/match" \
  -H "Authorization: Bearer $INTERCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "rows": [
    {
      "ref": "row-1",
      "text": "ALDC200C"
    },
    {
      "ref": "row-2",
      "text": "2 inch type C aluminium camlock",
      "brand": "Dixon"
    }
  ]
}'

const response = await fetch("https://api.interchangeparts.com.au/v1/match", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.INTERCHANGE_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "rows": [
      {
        "ref": "row-1",
        "text": "ALDC200C"
      },
      {
        "ref": "row-2",
        "text": "2 inch type C aluminium camlock",
        "brand": "Dixon"
      }
    ]
  }),
});
const body = await response.json();
console.log(response.status, body);

import os
import requests

response = requests.post(
    "https://api.interchangeparts.com.au/v1/match",
    headers={"Authorization": f"Bearer {os.environ['INTERCHANGE_API_KEY']}"},
    json={
        "rows": [
            {
                "ref": "row-1",
                "text": "ALDC200C",
            },
            {
                "ref": "row-2",
                "text": "2 inch type C aluminium camlock",
                "brand": "Dixon",
            },
        ],
    },
)
print(response.status_code, response.json())

Product families

GET /v1/families operationId listFamilies

The families that exist. Use the keys with getFamily and matchAttributes.

Works without a key. A key raises the limits.

Responses

Code examples

These calls will work when the sandbox opens. Until then they show the shape of a request and the answer you will get. Examples use the values from this operation’s specification.

curl -s "https://api.interchangeparts.com.au/v1/families"

const response = await fetch("https://api.interchangeparts.com.au/v1/families");
const body = await response.json();
console.log(response.status, body);

import requests

response = requests.get("https://api.interchangeparts.com.au/v1/families")
print(response.status_code, response.json())

A family's attribute vocabulary

GET /v1/families/{family} operationId getFamily

The attributes of a family and the values each accepts, with the role each plays in matching. Use these terms and values when you call matchAttributes.

Works without a key. A key raises the limits.

Parameters

Responses

{
  "type": "https://interchangeparts.com.au/problems/not-found",
  "title": "Item not found",
  "status": 404,
  "code": "not_found",
  "detail": "No item has the ID IX-NOPE-X-000-ZZ.",
  "request_id": "req_7c1f3a"
}

Code examples

These calls will work when the sandbox opens. Until then they show the shape of a request and the answer you will get. Examples use the values from this operation’s specification.

curl -s "https://api.interchangeparts.com.au/v1/families/camlock"

const response = await fetch("https://api.interchangeparts.com.au/v1/families/camlock");
const body = await response.json();
console.log(response.status, body);

import requests

response = requests.get("https://api.interchangeparts.com.au/v1/families/camlock")
print(response.status_code, response.json())

What has changed since you last looked

GET /v1/changes operationId listChanges

Items that were published, corrected, retired or withdrawn after a point in time. Use this, or webhooks, to keep a copy current. Needs an API key.

First call: send since. Every response has a next_cursor. Keep it and send it as cursor on the next call, without since. When changes is empty you have caught up, and the cursor is still the place to resume from.

Needs an API key on a plan that includes it.

Parameters

Responses

Code examples

These calls will work when the sandbox opens. Until then they show the shape of a request and the answer you will get. Examples use the values from this operation’s specification.

curl -s "https://api.interchangeparts.com.au/v1/changes?since=2026-10-28T00%3A00%3A00Z" \
  -H "Authorization: Bearer $INTERCHANGE_API_KEY"

const response = await fetch("https://api.interchangeparts.com.au/v1/changes?since=2026-10-28T00%3A00%3A00Z", {
  headers: {
    Authorization: `Bearer ${process.env.INTERCHANGE_API_KEY}`,
  },
});
const body = await response.json();
console.log(response.status, body);

import os
import requests

response = requests.get(
    "https://api.interchangeparts.com.au/v1/changes",
    params={
        "since": "2026-10-28T00:00:00Z",
    },
    headers={"Authorization": f"Bearer {os.environ['INTERCHANGE_API_KEY']}"},
)
print(response.status_code, response.json())

item.updated: An item you follow changed

POST to your endpoint

Sent to the endpoint you register for a key on a plan that includes webhooks.

Verify every delivery before you trust it. The Interchange-Signature header looks like t=1761874000,v1=3f9a…. t is the Unix time we sent it. v1 is the hex HMAC-SHA256, with your signing secret, of the string t, a full stop, and the raw request body. Recompute it over the exact bytes you received, compare in constant time, and reject the delivery if it does not match or if t is more than 5 minutes from your clock. The timestamp is inside the signature, so a captured delivery cannot be replayed later.

Respond with any 2xx within 10 seconds. Failed deliveries are retried with backoff for 24 hours, and a retry carries a fresh t and signature, so handlers must be idempotent: use event_id.

Headers

Body

ChangeEvent

{
  "event_id": "evt_01J9ZQ3K8M",
  "type": "item.withdrawn",
  "occurred_at": "2026-10-30T02:14:00Z",
  "ix_id": "IX-CAM-C-200-AL-RETIRED",
  "replaced_by": "IX-CAM-C-200-AL",
  "reason": "correction",
  "url": "https://interchangeparts.com.au/items/IX-CAM-C-200-AL"
}

Your response

Respond with any 2xx within 10 seconds.