Punchout commands

Reference for the `revenexx punchout` commands — every subcommand with a runnable example.

Auto-generated. This page is generated from the revenexx CLI by tools/sync-cli-reference.mjs. Don't edit it by hand — your changes will be overwritten.

Every revenexx punchout subcommand, with a runnable example and the flags it accepts. Each flag is an API field: its type, allowed values and meaning are in the API reference. Some flag names carry a -_ (e.g. --attribute-_values) — that is the exact token the CLI accepts, so copy them verbatim. Run revenexx punchout <command> --help for the live options.

accounts-create

Bash
revenexx punchout accounts-create \
    --channel-code '' \
    --code '' \
    --name '' \
    --protocol ''

Flags: --channel-code <channel-code> --code <code> --name <name> --protocol <protocol> --auth-strategy <auth-strategy> --credential-domain <credential-domain> --credential-identity <credential-identity> --credential-secret <credential-secret> --echo-entry-parameters [value] --enabled [value] --external-id <external-id> --external-refs <external-refs> --fallback-contact-id <fallback-contact-id> --ids-customer-name <ids-customer-name> --login-token <login-token> --metadata <metadata> --organization-id <organization-id> --protocol-version <protocol-version> --purchase-mode <purchase-mode> --secure-oci [value] --session-ttl-override-minutes <session-ttl-override-minutes> --shared-secret <shared-secret> --source-data <source-data> --source-synced-at <source-synced-at> --start-page-url <start-page-url> --unknown-user-policy <unknown-user-policy>

accounts-delete

Bash
revenexx punchout accounts-delete \
    --id ''

Flags: --id <id>

accounts-get

Bash
revenexx punchout accounts-get \
    --id ''

Flags: --id <id>

accounts-list

Bash
revenexx punchout accounts-list

Flags: --limit <limit> --offset <offset> --order <order> --fallback-contact-id <fallback-contact-id> --filter <column=value>

accounts-preview

Bash
revenexx punchout accounts-preview \
    --id '' \
    --cart-id ''

Flags: --id <id> --cart-id <cart-id>

accounts-probe

Bash
revenexx punchout accounts-probe \
    --id '' \
    --data '{ "key": "value" }'

Flags: --id <id> --body <body>

accounts-test

Bash
revenexx punchout accounts-test \
    --id '' \
    --data '{ "key": "value" }'

Flags: --id <id> --body <body>

accounts-update

Bash
revenexx punchout accounts-update \
    --id ''

Flags: --id <id> --auth-strategy <auth-strategy> --channel-code <channel-code> --code <code> --credential-domain <credential-domain> --credential-identity <credential-identity> --credential-secret <credential-secret> --echo-entry-parameters [value] --enabled [value] --external-id <external-id> --external-refs <external-refs> --fallback-contact-id <fallback-contact-id> --ids-customer-name <ids-customer-name> --login-token <login-token> --metadata <metadata> --name <name> --organization-id <organization-id> --protocol <protocol> --protocol-version <protocol-version> --purchase-mode <purchase-mode> --secure-oci [value] --session-ttl-override-minutes <session-ttl-override-minutes> --shared-secret <shared-secret> --source-data <source-data> --source-synced-at <source-synced-at> --start-page-url <start-page-url> --unknown-user-policy <unknown-user-policy>

defaults

Bash
revenexx punchout defaults \
    --data '{ "key": "value" }'

Flags: --body <body>

entry-cxml

Bash
revenexx punchout entry-cxml \
    --account-code '' \
    --method ''

Flags: --account-code <account-code> --method <method> --body-b64 <body-b64> --client-ip <client-ip> --content-type <content-type> --headers <headers> --query <query>

entry-ids

Bash
revenexx punchout entry-ids \
    --method ''

Flags: --method <method> --body-b64 <body-b64> --client-ip <client-ip> --content-type <content-type> --headers <headers> --query <query>

entry-oci

Bash
revenexx punchout entry-oci \
    --account-code '' \
    --method ''

Flags: --account-code <account-code> --method <method> --body-b64 <body-b64> --client-ip <client-ip> --content-type <content-type> --headers <headers> --query <query>

entry-refusals-list

Bash
revenexx punchout entry-refusals-list

Flags: --limit <limit> --offset <offset> --order <order> --filter <column=value>

field-mappings-create

Bash
revenexx punchout field-mappings-create \
    --protocol '' \
    --source '' \
    --target '' \
    --target-kind ''

Flags: --protocol <protocol> --source <source> --target <target> --target-kind <target-kind> --account-id <account-id> --document <document> --emit <emit> --enabled [value] --mutators <mutators> --position <position> --scope <scope> --source-config <source-config>

field-mappings-delete

Bash
revenexx punchout field-mappings-delete \
    --id ''

Flags: --id <id>

field-mappings-export

Bash
revenexx punchout field-mappings-export \
    --account-id ''

Flags: --account-id <account-id>

field-mappings-get

Bash
revenexx punchout field-mappings-get \
    --id ''

Flags: --id <id>

field-mappings-import

Bash
revenexx punchout field-mappings-import \
    --account-id '' \
    --configuration '{ "key": "value" }'

Flags: --account-id <account-id> --configuration <configuration> --protocol <protocol>

field-mappings-list

Bash
revenexx punchout field-mappings-list

Flags: --limit <limit> --offset <offset> --order <order> --filter <column=value>

field-mappings-update

Bash
revenexx punchout field-mappings-update \
    --id ''

Flags: --id <id> --account-id <account-id> --document <document> --emit <emit> --enabled [value] --mutators <mutators> --position <position> --protocol <protocol> --scope <scope> --source <source> --source-config <source-config> --target <target> --target-kind <target-kind>

sessions-claim

Bash
revenexx punchout sessions-claim \
    --psid '' \
    --data '{ "key": "value" }'

Flags: --psid <psid> --body <body>

sessions-create

Bash
revenexx punchout sessions-create \
    --account-id '' \
    --channel-code '' \
    --expires-at 2026-01-01T12:00:00Z \
    --protocol '' \
    --psid ''

Flags: --account-id <account-id> --channel-code <channel-code> --expires-at <expires-at> --protocol <protocol> --psid <psid> --cart-id <cart-id> --claimed-at <claimed-at> --closed-reason <closed-reason> --contact-id <contact-id> --correlation-key <correlation-key> --entry-action <entry-action> --entry-intent <entry-intent> --entry-payload <entry-payload> --external-user-id <external-user-id> --order-id <order-id> --order-number <order-number> --order-status <order-status> --ordered-at <ordered-at> --organization-id <organization-id> --origin <origin> --purchase-mode <purchase-mode> --return-method <return-method> --return-url <return-url> --secure-session-id <secure-session-id> --secure-session-used-at <secure-session-used-at> --secure-transmission-id <secure-transmission-id> --status <status> --transferred-at <transferred-at>

sessions-delete

Bash
revenexx punchout sessions-delete \
    --id ''

Flags: --id <id>

sessions-get

Bash
revenexx punchout sessions-get \
    --id ''

Flags: --id <id>

sessions-list

Bash
revenexx punchout sessions-list

Flags: --limit <limit> --offset <offset> --order <order> --filter <column=value>

sessions-ordered

Bash
revenexx punchout sessions-ordered \
    --psid '' \
    --data '{ "key": "value" }'

Flags: --psid <psid> --body <body>

sessions-return

Bash
revenexx punchout sessions-return \
    --psid '' \
    --data '{ "key": "value" }'

Flags: --psid <psid> --body <body>

sessions-update

Bash
revenexx punchout sessions-update \
    --id ''

Flags: --id <id> --account-id <account-id> --cart-id <cart-id> --channel-code <channel-code> --claimed-at <claimed-at> --closed-reason <closed-reason> --contact-id <contact-id> --correlation-key <correlation-key> --entry-action <entry-action> --entry-intent <entry-intent> --entry-payload <entry-payload> --expires-at <expires-at> --external-user-id <external-user-id> --order-id <order-id> --order-number <order-number> --order-status <order-status> --ordered-at <ordered-at> --organization-id <organization-id> --origin <origin> --protocol <protocol> --psid <psid> --purchase-mode <purchase-mode> --return-method <return-method> --return-url <return-url> --secure-session-id <secure-session-id> --secure-session-used-at <secure-session-used-at> --secure-transmission-id <secure-transmission-id> --status <status> --transferred-at <transferred-at>

setup-get

Bash
revenexx punchout setup-get

transfer-items-create

Bash
revenexx punchout transfer-items-create \
    --name '' \
    --quantity 9.99 \
    --transfer-id ''

Flags: --name <name> --quantity <quantity> --transfer-id <transfer-id> --currency <currency> --external-ref <external-ref> --line-gross <line-gross> --line-net <line-net> --metadata <metadata> --position <position> --product-id <product-id> --sku <sku> --tax-rate <tax-rate> --unit <unit> --unit-price <unit-price>

transfer-items-get

Bash
revenexx punchout transfer-items-get \
    --id ''

Flags: --id <id>

transfer-items-list

Bash
revenexx punchout transfer-items-list

Flags: --limit <limit> --offset <offset> --order <order> --filter <column=value>

transfers-create

Bash
revenexx punchout transfers-create \
    --account-id '' \
    --correlation-key '' \
    --protocol '' \
    --session-id ''

Flags: --account-id <account-id> --correlation-key <correlation-key> --protocol <protocol> --session-id <session-id> --cart-id <cart-id> --contact-id <contact-id> --currency <currency> --external-id <external-id> --external-refs <external-refs> --item-count <item-count> --matched-at <matched-at> --matched-order-id <matched-order-id> --organization-id <organization-id> --payload <payload> --problems [problems...] --source-data <source-data> --source-synced-at <source-synced-at> --target-url <target-url> --total-gross <total-gross> --total-net <total-net> --transferred-at <transferred-at>

transfers-get

Bash
revenexx punchout transfers-get \
    --id ''

Flags: --id <id>

transfers-list

Bash
revenexx punchout transfers-list

Flags: --limit <limit> --offset <offset> --order <order> --filter <column=value>

transfers-update

Bash
revenexx punchout transfers-update \
    --id ''

Flags: --id <id> --account-id <account-id> --cart-id <cart-id> --contact-id <contact-id> --correlation-key <correlation-key> --currency <currency> --external-id <external-id> --external-refs <external-refs> --item-count <item-count> --matched-at <matched-at> --matched-order-id <matched-order-id> --organization-id <organization-id> --payload <payload> --problems [problems...] --protocol <protocol> --session-id <session-id> --source-data <source-data> --source-synced-at <source-synced-at> --target-url <target-url> --total-gross <total-gross> --total-net <total-net> --transferred-at <transferred-at>

vocabularies-get

Bash
revenexx punchout vocabularies-get \
    --name auth-strategies

Flags: --name <name>

vocabularies-list

Bash
revenexx punchout vocabularies-list

Flags: --filter <column=value>

Was this page helpful?