Peddler is a Ruby interface for Amazon's Selling Partner API (SP-API), enabling sellers and vendors to programmatically access critical data like orders, shipments, and payments. It simplifies integration by being automatically generated from Amazon's official OpenAPI models, offering a robust and up-to-date solution for managing Amazon marketplace operations.

How It Works

The gem is auto-generated from the latest Amazon SP-API OpenAPI models, ensuring comprehensive and current coverage. It handles authentication via Login with Amazon (LWA) credentials and refresh tokens. A key advantage is its integration with the Structure gem, providing typed responses based on Ruby's Data class for enhanced developer experience, runtime type checking, and better IDE support.

Quick Start & Requirements

• Installation: Add gem 'peddler' to your Gemfile.
• Prerequisites: Requires Amazon developer registration and obtaining Login with Amazon (LWA) credentials. Set LWA_CLIENT_ID and LWA_CLIENT_SECRET environment variables. A seller-provided refresh token is necessary for accessing data.
• Links: API docs (Swagger models), API samples.

Highlighted Details

• Extensive API Coverage: Offers Ruby interfaces for all Amazon SP-API endpoints, including Orders, Catalog, Fulfillment, Data Management, Vendor, and more, across various versions.
• Typed Responses: Utilizes the Structure gem for type-safe parsing of API responses into Ruby Data objects, improving code clarity and reducing errors.
• Automatic Generation: Ensures API definitions are kept current by being generated directly from Amazon's official OpenAPI specifications.
• Rate Limiting & Retries: Built-in support for handling Amazon's API rate limits, with configurable retry attempts and exponential backoff.

Maintenance & Community

No specific details regarding contributors, sponsorships, or community channels (e.g., Discord, Slack) are provided in the README.

Licensing & Compatibility

The license type is not explicitly stated in the provided README.

Limitations & Caveats

The README does not detail specific limitations or known issues. As an auto-generated library, its accuracy and completeness are dependent on the timely updates of Amazon's SP-API OpenAPI specifications.