Description

n8n-nodes-xpsship

Community node package for integrating n8n with the XPS Ship REST API.

This repository ships one custom n8n node, one credential type, compiled runtime files under dist/, and documentation for the live workflow compatibility contract.

Install | Credentials | Repository Structure | Build Semantics | Runtime Semantics | Compatibility Contract | Operations | Validation

Install

n8n Community Nodes

In n8n:

1. Go to Settings > Community Nodes.
2. Select Install a community node.
3. Enter n8n-nodes-xpsship.
4. Install and restart n8n.

Manual Install

npm install n8n-nodes-xpsship

For repository development:

npm install
npm run build

Credentials

Credential type: xpsApi

Defined in credentials/XPSApi.credentials.ts.

| Field | Purpose |
| — | — |
| API Key | XPS Ship API key, sent in the RSIS Authorization header |
| Customer ID | XPS Ship customer id used in endpoint paths |

Repository Structure

Important tracked files and runtime outputs:

• README.md
• LICENSE
• package.json
• package-lock.json
• tsconfig.json
• credentials/XPSApi.credentials.ts
• credentials/xpsshipper.svg
• credentials/xpsshipper.dark.svg
• nodes/XPS.node.ts
• nodes/README.md
• nodes/EXAMPLES.md
• nodes/XPS.node.enhanced.ts
• nodes/XPS.node.ts.original
• nodes/XPS.node.ts.backup
• nodes/XPS.node.ts.v1.backup
• nodes/xpsshipper.svg
• nodes/xpsshipper.dark.svg
• dist/credentials/XPSApi.credentials.js
• dist/credentials/XPSApi.credentials.d.ts
• dist/credentials/xpsshipper.svg
• dist/credentials/xpsshipper.dark.svg
• dist/nodes/XPS.node.js
• dist/nodes/XPS.node.d.ts
• dist/nodes/xpsshipper.svg
• dist/nodes/xpsshipper.dark.svg
• docs/BUILDANDRELEASE.md
• docs/WORKFLOW_COMPATIBILITY.md

Build Semantics

Build command:

npm run build

Current build script:

npx --yes @n8n/node-cli build

Development watch script:

npx --yes @n8n/node-cli dev

The package now uses the official n8n node tool for build and lint. The tool compiles TypeScript and copies packaged static files, including the light and dark SVG icon files.

Package manifest semantics:

| Field | Current value |
| — | — |
| Package | n8n-nodes-xpsship |
| Runtime node entry | dist/nodes/XPS.node.js |
| Runtime credential entry | dist/credentials/XPSApi.credentials.js |
| Source node | nodes/XPS.node.ts |
| Source credential | credentials/XPSApi.credentials.ts |
| Icon | file:xpsshipper.svg |

More detail: Workflow Compatibility.

Operations

The node currently exposes 7 resources and 14 operation values.

| Resource Display | Resource Value | Operations |
| — | — | — |
| Quote | quote | get |
| Order | order | create, delete, assignTags, unassignTags |
| Shipment | shipment | get, list, search |
| Label | label | download |
| Service | service | list, listIntegratedQuoting, listTags |
| Tag | tag | list |
| API Request | apiRequest | make |

Service Notes

• Shipment get and list responses must request JSON output; preserve json: true on those GET calls.
• API Request is an authenticated escape hatch under /restapi/v1/customers/{customerId} for XPS endpoints that are not worth first-class node fields yet.
• The resource value is xps, not xpsShip or xpsshipper.
• Backup/original TypeScript files in nodes/ are historical references and are not runtime manifest entries.

Validation

Minimum local validation:

npm run verify:release

Minimum live validation after deployment:

1. Confirm n8n health is green.
2. Confirm n8n is loading the intended package commit.
3. Confirm the public icon route returns SVG.
4. Query saved workflows for n8n-nodes-xpsship.xps nodes.
5. Validate saved typeVersion values against declared versions.
6. Validate saved resource and operation values against current option lists.
7. Open representative workflows in the n8n editor and verify icon, subtitle, resource, operation, and required fields.

Do not skip browser/editor validation after large node builds.

Related Docs

• Workflow Compatibility
• Node-local notes
• GitHub repository
• n8n community nodes documentation

License

See the repository license file.