Warning: You are browsing the documentation for PrestaShop 1.7, which is outdated.

You might want to read an updated version of this page for the current version, PrestaShop 8. Read the updated version of this page

Learn how to upgrade to the latest version.

OrderState domain

OrderState Commands


PrestaShop\PrestaShop\Core\Domain\OrderState\Command\AddOrderStateCommand Adds new order state with provided data

Command details
Constructor parameters
  • $array $localizedNames
  • $string $color
  • $bool $loggable
  • $bool $invoice
  • $bool $hidden
  • $bool $sendEmail
  • $bool $pdfInvoice
  • $bool $pdfDelivery
  • $bool $shipped
  • $bool $paid
  • $bool $delivery
  • $array $localizedTemplates
Handler class PrestaShop\PrestaShop\Adapter\OrderState\CommandHandler\AddOrderStateHandler


  • PrestaShop\PrestaShop\Core\Domain\OrderState\CommandHandler\AddOrderStateHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\OrderState\ValueObject\OrderStateId


PrestaShop\PrestaShop\Core\Domain\OrderState\Command\EditOrderStateCommand Edits provided order state. It can edit either all or partial data. Only not-null values are considered when editing order state. For example, if the name is null, then the original value is not modified, however, if name is set, then the original value will be overwritten.

Command details
Constructor parameters
  • $int $orderStateId
Handler class PrestaShop\PrestaShop\Adapter\OrderState\CommandHandler\EditOrderStateHandler


  • PrestaShop\PrestaShop\Core\Domain\OrderState\CommandHandler\EditOrderStateHandlerInterface
Return type void

OrderState Queries


PrestaShop\PrestaShop\Core\Domain\OrderState\Query\GetOrderStateForEditing Gets order state information for editing.

Query details
Constructor parameters
  • $int $orderStateId
Handler class PrestaShop\PrestaShop\Adapter\OrderState\QueryHandler\GetOrderStateForEditingHandler


  • PrestaShop\PrestaShop\Core\Domain\OrderState\QueryHandler\GetOrderStateForEditingHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\OrderState\QueryResult\EditableOrderState