bricre / amazon-selling-partner-sdk-shipping
API client generated from OpenAPI definition from Amazon Selling Partner API for Shipping
Requires
- allansun/openapi-runtime: ^2.1
Requires (Dev)
- allansun/openapi-code-generator: ^0.2.5
- allansun/openapi-parser: ^2.1.4
This package is auto-updated.
Last update: 2024-10-24 05:13:27 UTC
README
Code generated from Amazon's Swagger file using allansun/openapi-code-generator.
Generated code is well self-documented with proper PHPDoc annotations.
Please refer to Amazon's documentation for detailed API behaviour explanation.
Installation
composer require bricre/amazon-selling-partner-sdk-shipping
You will also need a PSR-7 based client or Symfony's HTTP Foundation based client
So either use Guzzle (or any other PSR-7 compatible clients)
composer require guzzlehttp/guzzle
or Symfony HTTP Client
composer require symfony/http-client
Versioning
This project matches Amazon's API versioning.
Due to the restriction of Composer, version number like '2021-01-01' will be changed to '2021.01.01'.
Should you found a matching version not being available. Please contact the author to generate against correct version.
Usage
First you need to configure OpenAPI\RunTime\Client with required credentials and predefined responses types. You only need to do this once (or create a service in your dependency injection).
You may also want to check out Amazon's document about how to authorize your request
<?php use Amz\Shipping\ResponseTypes; use OpenAPI\Runtime\Client; use OpenAPI\Runtime\SimplePsrResponseHandlerStack; Client::configure( new \GuzzleHttp\Client([ 'base_uri' => 'https://sellingpartnerapi-na.amazon.com/', 'headers'=>[ 'Authorization'=> 'Bearer <accessToken>' ] ]), new SimplePsrResponseHandlerStack(new ResponseTypes()) );
Then in your business logic you can call API operations directly
<?php use Amz\AplusContent\Api\AplusContent; use Ebay\Sell\Account\Api\Program; $api = new AplusContent(); $docs = $api->searchContentDocuments(['marketplaceId'=>'xxxxxx']);
Author
- Allan Sun - Initial work