For the complete documentation index, see llms.txt. This page is also available as Markdown.

trading-partner-connectors

Browse the pre-configured connection templates used to onboard EDI trading partners. Celigo publishes a catalog of more than 590 definitions covering EDI, AS2, VAN, and other B2B transports. list and get are the common case. create, update, and delete exist for definition management, but Celigo curates the published catalog centrally.

The group was renamed in celigo-cli 2026.8.1. It was previously tp-connectors, which remains a working alias. celigo tp-connectors list and celigo trading-partner-connectors list are the same command.

REST API: Trading Partner Connectors

celigo trading-partner-connectors <subcommand> [args] [flags]

Supports all global flags.


Subcommands

Subcommand
Purpose

list

List every trading partner connector definition.

get <id>

Fetch one trading partner connector definition by ID.

create

Create a trading partner connector definition (--file <path> or stdin).

update <id>

Update a trading partner connector definition (--file <path> or stdin).

delete <id>

Delete a trading partner connector definition.


celigo trading-partner-connectors list

List every trading partner connector definition in the catalog.

Signature

celigo trading-partner-connectors list

Arguments

None.

Flags

Flag
Type
Default
Description

--fields <spec>

string

default

Fields to request per row. default returns _id, name, and the table columns; all returns complete documents; a comma-separated list requests specific fields. See field projection.

This list has no --limit flag. To cap the output, filter with --jq.

Example

Corresponds to: GET /v1/tpconnectors


celigo trading-partner-connectors get

Fetch a single trading partner connector definition by ID.

Signature

Arguments

Argument
Type
Required
Description

<id>

string

Yes

Trading partner connector _id.

Flags

None beyond the global flags.

Example

Corresponds to: GET /v1/tpconnectors/{_id}


celigo trading-partner-connectors create

Create a trading partner connector definition from a JSON body (--file <path> or stdin).

Signature

Flags

Flag
Type
Default
Description

-f, --file <path>

string

JSON body file (or pipe via stdin).

Request body

A JSON object matching the POST /v1/tpconnectors request schema.

Example

Corresponds to: POST /v1/tpconnectors


celigo trading-partner-connectors update

Update a trading partner connector definition from a JSON body (--file <path> or stdin).

⚠️ update replaces the entire definition. PUT erases any field you omit. GET the definition first, edit it, then send the complete object back.

Signature

Arguments

Argument
Type
Required
Description

<id>

string

Yes

Trading partner connector _id.

Flags

Flag
Type
Default
Description

-f, --file <path>

string

JSON body file (or pipe via stdin).

Example

Corresponds to: PUT /v1/tpconnectors/{_id}


celigo trading-partner-connectors delete

Delete a trading partner connector definition. The command prompts for confirmation unless you pass -y.

⚠️ Deleting a trading partner connector cannot be undone. Delete only definitions you created. The published catalog entries are managed centrally by Celigo.

Signature

Arguments

Argument
Type
Required
Description

<id>

string

Yes

Trading partner connector _id.

Flags

Flag
Type
Default
Description

-y, --yes

boolean

false

Skip the confirmation prompt.

Example

Corresponds to: DELETE /v1/tpconnectors/{_id}


Gotchas

  • tp-connectors is still a valid alias. The group was renamed in celigo-cli 2026.8.1, and the old name continues to work. Existing scripts need no change. New scripts should use trading-partner-connectors, which matches the resource name in the REST API reference.

  • Celigo curates the published catalog. create, update, and delete exist for definition management, but Celigo owns the 590-plus published entries. These subcommands do not edit them. To change a published entry, contact Celigo.

  • These entries describe trading partners, not generic HTTP endpoints. A trading partner connector covers an EDI, AS2, or VAN counterparty. For the HTTP connector catalog used by application-style connections, see http-connectors.

  • The API path is tpconnectors, with no hyphen. The command is trading-partner-connectors; the endpoint is /v1/tpconnectors. The old command name matched the endpoint spelling more closely, which is why the alias remains.

  • The catalog is large. To find a partner by name, filter list with --jq, for example --jq 'map(select(.name | test("walmart";"i")))'. --format table also keeps the output readable.

  • http-connectors — the sibling HTTP connector catalog for non-B2B systems.

  • edi-profiles — EDI profile definitions that pair with trading partner connectors during onboarding.

Last updated

Was this helpful?