rogergerecke/shopware-6-php-swagger-client

This endpoint reference contains an overview of all endpoints comprising the Shopware Admin API. For a better overview, all CRUD-endpoints are hidden by default. If you want to show also CRUD-endpoints add the query parameter `type=jsonapi`.

Maintainers

Details

github.com/rogergerecke/shopware-6-php-swagger-client

Homepage

Source

Issues

Installs: 0

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

dev-main 2022-01-27 16:11 UTC

Requires

Requires (Dev)

unlicense 35671e6184eaa332fb795e008557a1494d5923ab

phprestapisdkopenapiopenapitoolsopenapi-generator

This package is auto-updated.

Last update: 2022-02-09 16:20:34 UTC

README

This endpoint reference contains an overview of all endpoints comprising the Shopware Admin API.

For a better overview, all CRUD-endpoints are hidden by default. If you want to show also CRUD-endpoints add the query parameter type=jsonapi.

Installation & Usage

Requirements

PHP 7.3 and later. Should also work with PHP 8.0 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/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure OAuth2 access token for authorization: oAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\AssetManagementApi(
    // 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
);
$media_id = 'media_id_example'; // string | Identifier of the media entity.
$extension = 'extension_example'; // string | Extension of the uploaded file. For example `png`
$file_name = 'file_name_example'; // string | Name of the uploaded file. If not provided the media identifier will be used as name
$body = "/path/to/file.txt"; // \SplFileObject

try {
    $apiInstance->upload($media_id, $extension, $file_name, $body);
} catch (Exception $e) {
    echo 'Exception when calling AssetManagementApi->upload: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://redkitty.de/api

Class Method HTTP request Description
AssetManagementApi upload POST /_action/media/{mediaId}/upload Upload a file to a media entity
AuthorizationAuthenticationApi token POST /oauth/token Fetch an access token
BulkOperationsApi sync POST /_action/sync Bulk edit entities
DatabaseMigrationsApi migrate POST /_action/database/migrate Execute migrations
DatabaseMigrationsApi migrateDestructive POST /_action/database/migrate-destructive Execute destructive migrations
DatabaseMigrationsApi syncMigrations POST /_action/database/sync-migration Sync migrations to the database
DocumentManagementApi createDocument POST /_action/order/{orderId}/document/{documentTypeName} Create a document for an order
DocumentManagementApi downloadDocument GET /_action/document/{documentId}/{deepLinkCode} Download a document
DocumentManagementApi numberRangeReserve GET /_action/number-range/reserve/{type}/{saleschannel?} Reserve or preview a document number
DocumentManagementApi uploadToDocument POST /_action/document/{documentId}/upload Upload a file for a document
MailOperationsApi build POST /_action/mail-template/build Preview a mail template
MailOperationsApi send POST /_action/mail-template/send Send a mail
MailOperationsApi validate POST /_action/mail-template/validate Validate a mail content
OrderManagementApi orderDeliveryStateTransition POST /_action/order_delivery/{orderDeliveryId}/state/{transition} Transition an order delivery to a new state
OrderManagementApi orderStateTransition POST /_action/order/{orderId}/state/{transition} Transition an order to a new state
OrderManagementApi orderTransactionStateTransition POST /_action/order_transaction/{orderTransactionId}/state/{transition} Transition an order transaction to a new state
SystemInfoHealthcheckApi apiInfo GET /_info/openapi3.json Get OpenAPI Specification
SystemInfoHealthcheckApi businessEvents GET /_info/events.json Get Business events
SystemInfoHealthcheckApi config GET /_info/config Get API information
SystemInfoHealthcheckApi flowActions GET /_info/flow-actions.json Get actions for flow builder
SystemInfoHealthcheckApi infoShopwareVersion GET /_info/version Get the Shopware version
SystemOperationsApi clearCache DELETE /_action/cache Clear caches
SystemOperationsApi clearCacheAndScheduleWarmUp DELETE /_action/cache_warmup Clear and warm up caches
SystemOperationsApi clearContainerCache DELETE /_action/container_cache Clear container caches
SystemOperationsApi clearOldCacheFolders DELETE /_action/cleanup Clear old cache folders
SystemOperationsApi consumeMessages POST /_action/message-queue/consume Consume messages from the message queue.
SystemOperationsApi getMinRunInterval GET /_action/scheduled-task/min-run-interval Get the minimum schedules task interval
SystemOperationsApi index POST /_action/index Run indexer
SystemOperationsApi indexing POST /_action/indexing Run indexer
SystemOperationsApi indexing_0 POST /_action/indexing/products Send product indexing message
SystemOperationsApi info GET /_action/cache_info Get cache information
SystemOperationsApi iterate POST /_action/indexing/{indexer} Iterate an indexer
SystemOperationsApi runScheduledTasks POST /_action/scheduled-task/run Run scheduled tasks.

Models

Authorization

oAuth

  • Type: OAuth
  • Flow: password
  • Authorization URL: ``
  • Scopes:
    • write: Full write access

oAuth

  • Type: OAuth
  • Flow: application
  • Authorization URL: ``
  • Scopes:
    • write: Full write access

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: 6.4.8.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen