Notice: You are browsing the documentation for PrestaShop 8, which is currently in development.

You might want to read the documentation for the current version, PrestaShop 1.7.

Webservice domain

Webservice Commands

AddWebserviceKeyCommand

PrestaShop\PrestaShop\Core\Domain\Webservice\Command\AddWebserviceKeyCommand Adds new webservice key which is used to access PrestaShop´┐Żs API

Command details
Constructor parameters
  • $string $key
  • $string $description
  • $bool $status
  • $array $permissions
  • $array $associatedShops
Handler class PrestaShop\PrestaShop\Adapter\Webservice\CommandHandler\AddWebserviceKeyHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Webservice\CommandHandler\AddWebserviceKeyHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\Webservice\ValueObject\WebserviceKeyId

EditWebserviceKeyCommand

PrestaShop\PrestaShop\Core\Domain\Webservice\Command\EditWebserviceKeyCommand Edits webservice key data

Command details
Constructor parameters
  • $int $webserviceKeyId
Handler class PrestaShop\PrestaShop\Adapter\Webservice\CommandHandler\EditWebserviceKeyHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Webservice\CommandHandler\EditWebserviceKeyHandlerInterface
Return type void

Webservice Queries

GetWebserviceKeyForEditing

PrestaShop\PrestaShop\Core\Domain\Webservice\Query\GetWebserviceKeyForEditing Get webservice key data for editing

Query details
Constructor parameters
  • $int $webserviceKeyId
Handler class PrestaShop\PrestaShop\Adapter\Webservice\QueryHandler\GetWebserviceKeyForEditingHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Webservice\QueryHandler\GetWebserviceKeyForEditingHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\Webservice\QueryResult\EditableWebserviceKey