/ 
eBay-Client-OpenAPI3-0.01
/ ebayapi3

NAME

ebayapi3 - command-line client for eBay::Client::OpenAPI3

SYNOPSIS

ebayapi3 oauth2

ebayapi3 browse \
    --limit 200 \
    --category_ids 13885 \
    --stats \
    --continue \
    --as yaml > latest.yaml

ebayapi3 item --itemid 21323232123 --as json

ebayapi3 rate --as summary

DESCRIPTION

ebayapi3 is the command-line interface used with eBay::Client::OpenAPI3. The initial CPAN packaging deliberately preserves its pre-CPAN command behavior because existing applications use this utility.

The available subcommands are oauth2, browse, item, rate, and help. With no subcommand, the utility defaults to oauth2 as before.

CONFIGURATION

By default the utility reads ~/.ebayapi3.conf. The documented --config option is accepted by each API subcommand in version 0.01 so a different INI file can be selected explicitly.

[eBay]
client_id            = your-client-id
client_secret        = your-client-secret
affiliateCampaignId  = your-epn-campaign-id
affiliateReferenceId = optional-reference-id

COMMANDS

oauth2

Obtains a new application OAuth token.

The historical default output is the bare access token. For compatibility, --as json retains the existing behavior: it prints the encoded token response and then the bare access token. This is not changed in the initial CPAN packaging pass.

browse

Calls the Browse API item_summary/search endpoint.

The default output selected by the executable is JSON. --as compactjson and --as yaml are also supported. This corrects older POD which said YAML was the default even though the executable actually defaulted to JSON.

--continue retains the existing pagination behavior. In particular, JSON page responses are written consecutively; the utility does not wrap them in a new JSON array in version 0.01. Existing consumers depending on that stream are therefore not forced to change for the CPAN release.

--nextcmd likewise retains the existing command format, including emitting a YAML continuation command.

Common options include:

--as=s
--brand=s@
--buyopt=s@
--category_ids=s
--config=s
--q=s
--filter=s@
--continue
--limit=i
--max=i
--nextcmd
--offset=i
--sort=s
--stats

Unless --buyopt is supplied, the utility retains its existing AUCTION buying option filter.

item

Retrieves one item by its numeric legacy eBay item ID.

ebayapi3 item --itemid 21323232123 --as json

Output modes are json, compactjson, and summary.

rate

Retrieves Developer Analytics rate-limit information for the Browse API.

Output modes are json, compactjson, and summary.

help

Prints command help to STDERR. The historical non-zero help return status is retained in version 0.01.

EXIT STATUS

Normal API commands return 0 on success and 1 for the handled API failures that were already reported by the command. The explicit help command retains its historical status of 1.

COMPATIBILITY

Version 0.01 adds a callable run() entry point to make the command dispatcher testable, but normal execution still invokes exactly the same subcommands and preserves the existing CLI output/pagination semantics. The new entry point is primarily an internal testing seam.

BUGS AND SUPPORT

https://github.com/oodler577/p5-eBay-Client-OpenAPI3/issues

AUTHOR

Oodler 577 <oodler@cpan.org>

LICENSE AND COPYRIGHT

This software is copyright (c) 2026 by Brett Estrade.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.