README

Manage your product data, send images and much more.

This PHP package is automatically generated by the Swagger Codegen project:

API version: V1
Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/mehr-it/otto-products-api-client.git"
    }
  ],
  "require": {
    "mehr-it/otto-products-api-client": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/./vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new MehrIt\OttoProductsApiClient\Api\BrandsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

try {
    $result = $apiInstance->getBrands();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BrandsApi->getBrands: ', $e->getMessage(), PHP_EOL;
}
?>

Documentation for API Endpoints

All URIs are relative to /

Class	Method	HTTP request	Description
BrandsApi	getBrands	GET /v1/products/brands	Read the list of brands that are known on the Otto market place.
CategoriesApi	getCategoryGroups	GET /v1/products/categories	Read the product categories and associated attributes of the OTTO market place. The total number of results could be limited by specifying query parameters. Generally the resulting product categories values will be paginated. The default page length is 100 product categories per response, the page size limit is 2000. The links specified in the result can be used to page through the total result space.
MarketplaceStatusApi	getMarketPlaceStatus	GET /v1/products/{sku}/marketplace-status	Read the marketplace status for a single product variation.
MarketplaceStatusApi	getMarketPlaceStatusList	GET /v1/products/marketplace-status	Read the marketplace status for your product variations. The total number of results could be limited by specifying query parameters. Generally the resulting marketplace status will be paginated. The default page length is 100 product variations per response, also the page size limit. The links specified in the result can be used to page through the total result space.
ProductActiveStatusApi	getActiveStatus	GET /v1/products/active-status	Read the active status of your product variations. The total number of results could be limited by specifying query parameters. Generally the resulting active status values will be paginated. The default page length is 100 active status entries per response, also the page size limit. The links specified in the result can be used to page through the total result space. Replaces corresponding online-status endpoint which now is marked as deprecated.
ProductActiveStatusApi	getVariationActiveStatus	GET /v1/products/{sku}/active-status	Read the active status of a single product variation. Replaces corresponding online-status endpoint which now is marked as deprecated.
ProductActiveStatusApi	updateActiveStatus	POST /v1/products/active-status	Update the active status of your product variations and get a process-id to query results. Replaces corresponding online-status endpoint which now is marked as deprecated.
ProductOnlineStatusApi	getOnlineStatus	GET /v1/products/online-status	DEPRECATED - please use the corresponding active-status endpoint instead.
ProductOnlineStatusApi	getVariationOnlineStatus	GET /v1/products/{sku}/online-status	DEPRECATED - please use the corresponding active-status endpoint instead.
ProductOnlineStatusApi	updateOnlineStatus	POST /v1/products/online-status	DEPRECATED - please use the corresponding active-status endpoint instead.
ProductsApi	createOrUpdateProductVariations	POST /v1/products	Create or update your product variations and get a process-id to query results. The limit for the number of product variations in one request is 500.
ProductsApi	getPartnerProducts	GET /v1/products	Read your product variations. The total number of results could be limited by specifying query parameters. Generally the resulting product variations will be paginated. The default page length is 100 product variations per response, also the page size limit. The links specified in the result can be used to page through the total result space.
ProductsApi	getProductVariation	GET /v1/products/{sku}	Read a single product variation.

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

mehr-it / otto-products-api-client

Maintainers

Details