Download the PHP package zero-to-prod/spapi-orders-cli without Composer
On this page you can find all versions of the php package zero-to-prod/spapi-orders-cli. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download zero-to-prod/spapi-orders-cli
More information about zero-to-prod/spapi-orders-cli
Files in zero-to-prod/spapi-orders-cli
Package spapi-orders-cli
Short Description A CLI for Amazon Selling Partner API (SPAPI) Orders API.
License MIT
Homepage https://github.com/zero-to-prod/spapi-orders-cli
Informations about the package spapi-orders-cli
Zerotoprod\SpapiOrdersCli
Contents
- Introduction
- Requirements
- Installation
- Documentation Publishing
- Automatic Documentation Publishing
- Usage
- Available Commands
spapi-orders-cli:srcspapi-orders-cli:get-orderspapi-orders-cli:get-order-itemsspapi-orders-cli:get-order-buyer-infospapi-orders-cli:get-order-address
- Available Commands
- Docker Image
- Local Development
- Image Development
- Contributing
Introduction
A CLI for Amazon Selling Partner API (SPAPI) Orders API.
Requirements
- PHP 8.1 or higher.
Installation
Install Zerotoprod\SpapiOrdersCli via Composer:
This will add the package to your project's dependencies and create an autoloader entry for it.
Documentation Publishing
You can publish this README to your local documentation directory.
This can be useful for providing documentation for AI agents.
This can be done using the included script:
Automatic Documentation Publishing
You can automatically publish documentation by adding the following to your composer.json:
Usage
Run this command to see the available commands:
Available Commands
spapi-orders-cli:src
Displays the project's GitHub repository URL.
Usage:
Arguments: None
Example:
Sample Output:
spapi-orders-cli:get-order
Retrieves order details from Amazon's Selling Partner API for a specific order ID.
Usage:
Required Arguments:
refresh_token- The LWA refresh tokenclient_id- Get this value when you register your applicationclient_secret- Get this value when you register your applicationtarget_application- The application ID for the target application to which access is being delegatedorder_id- The Amazon Order ID
Options:
--user_agent- User Agent (optional)--response- Returns the full response (flag)--expiresIn- The expiresIn value for the restrictedDataToken (flag)
Example:
Sample Output:
spapi-orders-cli:get-order-items
Retrieves the items for a specific order from Amazon's Selling Partner API.
Usage:
Required Arguments:
refresh_token- The LWA refresh tokenclient_id- Get this value when you register your applicationclient_secret- Get this value when you register your applicationtarget_application- The application ID for the target application to which access is being delegatedorder_id- The Amazon Order ID
Options:
--user_agent- User Agent (optional)--response- Returns the full response (flag)--expiresIn- The expiresIn value for the restrictedDataToken (flag)
Example:
Sample Output:
spapi-orders-cli:get-order-buyer-info
Retrieves buyer information for a specific order from Amazon's Selling Partner API.
Usage:
Required Arguments:
refresh_token- The LWA refresh tokenclient_id- Get this value when you register your applicationclient_secret- Get this value when you register your applicationtarget_application- The application ID for the target application to which access is being delegatedorder_id- The Amazon Order ID
Options:
--user_agent- User Agent (optional)--response- Returns the full response (flag)--expiresIn- The expiresIn value for the restrictedDataToken (flag)
Example:
Sample Output:
spapi-orders-cli:get-order-address
Returns the shipping address for the specified order from Amazon's Selling Partner API.
Usage:
Required Arguments:
refresh_token- The LWA refresh tokenclient_id- Get this value when you register your applicationclient_secret- Get this value when you register your applicationtarget_application- The application ID for the target application to which access is being delegatedorder_id- The Amazon Order ID
Options:
--user_agent- User Agent (optional)--response- Returns the full response (flag)--expiresIn- The expiresIn value for the restrictedDataToken (flag)
Example:
Sample Output:
Note: All SPAPI commands return JSON-formatted responses. Make sure to have valid Amazon SP-API credentials and proper permissions to access order data.
Docker Image
You can also run the cli using the docker image:
Contributing
Contributions, issues, and feature requests are welcome! Feel free to check the issues page if you want to contribute.
- Fork the repository.
- Create a new branch (
git checkout -b feature-branch). - Commit changes (
git commit -m 'Add some feature'). - Push to the branch (
git push origin feature-branch). - Create a new Pull Request.
All versions of spapi-orders-cli with dependencies
ext-json Version *
symfony/console Version ^7.2
zero-to-prod/data-model Version ^81.9
zero-to-prod/spapi-orders Version ^3.0
zero-to-prod/spapi-lwa Version ^4.0
zero-to-prod/spapi-tokens Version ^3.1.2
ext-curl Version *
zero-to-prod/spapi-rdt Version ^4.0
zero-to-prod/package-helper Version ^1.1.3