Skip to content
This repository has been archived by the owner on Apr 27, 2023. It is now read-only.

shopiqo/bigbuy-php-api-client

Repository files navigation

REST client for BigBuy

OpenAPI spefication to interact with bigbuy.eu

Installation & Usage

Requirements

PHP 7.3 and later. Should also work with PHP 8.0 or 8.1 but has not been tested.

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/shopiqo/bigbuy-php-api-client.git"
    }
  ],
  "require": {
    "shopiqo/bigbuy-php-api-client": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/REST client for BigBuy/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure Bearer authorization: API_KEY
$config = Efsa\Client\Bigbuy\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Efsa\Client\Bigbuy\Api\CatalogAPIApi(
    // 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(),
    $config
);
$id = 56; // int
$format = json; // string
$isoCode = de; // string

try {
    $apiInstance->getCatalogAttribute($id, $format, $isoCode);
} catch (Exception $e) {
    echo 'Exception when calling CatalogAPIApi->getCatalogAttribute: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.bigbuy.eu

Class Method HTTP request Description
CatalogAPIApi getCatalogAttribute GET /rest/catalog/attribute/{id}.{_format} Get a single attribute
CatalogAPIApi getCatalogAttributeGroup GET /rest/catalog/attributegroup/{id}.{_format} Get a single attribute group
CatalogAPIApi getCatalogAttributeGroups GET /rest/catalog/attributegroups.{_format} Lists all attribute groups
CatalogAPIApi getCatalogAttributeLanguages GET /rest/catalog/attributealllanguages/{id}.{_format} Get languages of a single attribute
CatalogAPIApi getCatalogAttributegroupalllanguages GET /rest/catalog/attributegroupalllanguages/{id}.{_format} Get all languages of a single attribute group
CatalogAPIApi getCatalogCategories GET /rest/catalog/categories.{_format} Lists all categories
CatalogAPIApi getCatalogCategory GET /rest/catalog/category/{id}.{_format} Returns the selected category
CatalogAPIApi getCatalogCategoryalllanguages GET /rest/catalog/categoryalllanguages/{id}.{_format} Lists all categories
CatalogAPIApi getCatalogLanguages GET /rest/catalog/languages.{_format} Returns all languages
CatalogAPIApi getCatalogManufacturer GET /rest/catalog/manufacturer/{id}.{_format} Get a single manufacturer
CatalogAPIApi getCatalogManufacturers GET /rest/catalog/manufacturers.{_format} Returns all manufacturers
CatalogAPIApi getCatalogProduct GET /rest/catalog/product/{id}.{_format} Returns the selected product
CatalogAPIApi getCatalogProductcategories GET /rest/catalog/productcategories/{id}.{_format} Get product categories
CatalogAPIApi getCatalogProductimages GET /rest/catalog/productimages/{id}.{_format} Get a single product images
CatalogAPIApi getCatalogProductinformation GET /rest/catalog/productinformation/{id}.{_format} Get a single product
CatalogAPIApi getCatalogProductinformationalllanguages GET /rest/catalog/productinformationalllanguages/{id}.{_format} Get a single product
CatalogAPIApi getCatalogProductinformationbysku GET /rest/catalog/productinformationbysku/{sku}.{_format} Get a single product by sku
CatalogAPIApi getCatalogProducts GET /rest/catalog/products.{_format} Returns all products
CatalogAPIApi getCatalogProductsinformation GET /rest/catalog/productsinformation.{_format} Returns all products
CatalogAPIApi getCatalogProductsstock GET /rest/catalog/productsstock.{_format} Returns all products stock
CatalogAPIApi getCatalogProductsstockavailable GET /rest/catalog/productsstockavailable.{_format} Returns all products with available stock
CatalogAPIApi getCatalogProductsstockbyreference POST /rest/catalog/productsstockbyreference.{_format} Returns all selected products stock
CatalogAPIApi getCatelogAttributes GET /rest/catalog/attributes.{_format} Lists all attributes
ModuleAPIApi getAllModules GET /rest/module/.{_format} Get all Modules
ModuleAPIApi getAllModulesPlatforms GET /rest/module/platforms.{_format} Get all module platforms
OrderAPIApi getOrderCarriersStructure GET /rest/order/carriers/new.{_format} Get order carriers structure
OrderAPIApi getOrderShippingAddressStructure GET /rest/order/addresses/new.{_format} Get order shipping address structure
ShippingAPIApi getTheListOfAvailableCarriers GET /rest/shipping/carriers.{_format} Get the list of available carriers
TrackingAPIApi getTheListOfAvailableTrackings GET /rest/tracking/carriers.{_format} Get the list of available trackings
TrackingAPIApi getTheListOfAvailableTrackingsForThePassedOrdersYaml POST /rest/tracking/orders.{_format} Get the list of available trackings for the passed orders.
TrackingAPIApi getTrackingStatusByOrderId GET /rest/tracking/order/{id}.{_format} Get tracking status by order id

Models

Authorization

API_KEY

  • Type: Bearer authentication

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: v202102
    • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published