Quick Start Guide

This section walks through a complete API interaction in four steps: connect, discover, search, and update. By the end, you'll have a working mental model for using the API.

The snippets below are not executable code; they are for reference purposes only.

Step 1 — Test Your Connection

CODE

GET "https://your-server/api/Test"
→ "Successfully connected to InfolinxRest"

No authentication needed. If this fails, check your URL and network connectivity first.

Step 2 — Discover Item Types (Tabs)

CODE

GET "https://your-server/api/Tab" \
  -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ="

This returns all item types configured in your system. Note the Id values — you'll use them as TabId in subsequent calls. For example, if "Box" has Id: 202, that's your TabId for box operations.

Step 3 — Search for an Item

CODE

POST "https://your-server/api/itemsearch" \
  -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=" \
  -H "Content-Type: application/json" \
  -d '{
    "SpecialSearch": "none",
    "Barcode": "BOX001"
  }'

This finds an item by its exact barcode. The response includes the item's I_ID, all field values, and its current location. You can also search by field values using SearchTerms.

Step 4 — Update the Item

CODE

POST "https://your-server/api/item" \
  -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=" \
  -H "Content-Type: application/json" \
  -d '[{
    "columns": [
      { "ColumnName": "I_ID", "Value": 12345 },
      { "ColumnName": "QUICK_DESCRIPTION", "Value": "Updated Box Description" }
    ]
  }]'

Include I_ID to update an existing item (omit it to create a new one).
Only include the columns you want to change.
Check the Result field in the response to confirm success.

For updates, the I_ID must be in the columns array as an IRColumn entry — not in the top-level IRItem.Id property. Putting it in the wrong place will create a new item instead of updating.