bricre/amazon-selling-partner-sdk-vendor-transaction-status

API client generated from OpenAPI definition from Amazon Selling Partner API for Retail Procurement Transaction Status

v1 2021-09-23 22:19 UTC

This package is auto-updated.

Last update: 2024-11-24 05:13:34 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-vendor-transaction-status

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\VendorTransactionStatus\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