This commit is contained in:
2026-09-15 10:26:34 +08:00
commit ecf36afa56
10493 changed files with 1404888 additions and 0 deletions
@@ -0,0 +1,152 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\Sales\Api\OrderRepositoryInterface;
use Magento\Sales\Model\Order;
use Magento\TestFramework\TestCase\WebapiAbstract;
/**
* Class CreditMemoCreateRefundTest
*/
class CreditMemoCreateRefundTest extends WebapiAbstract
{
const RESOURCE_PATH = '/V1/creditmemo/refund';
const SERVICE_READ_NAME = 'salesCreditmemoManagementV1';
const SERVICE_VERSION = 'V1';
/**
* @var \Magento\Framework\ObjectManagerInterface
*/
protected $objectManager;
protected function setUp(): void
{
$this->objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
}
/**
* @magentoApiDataFixture Magento/Sales/_files/invoice.php
*/
public function testInvoke()
{
/** @var \Magento\Sales\Model\Order $order */
$orderCollection = $this->objectManager->get(\Magento\Sales\Model\ResourceModel\Order\Collection::class);
$order = $orderCollection->getFirstItem();
$items = [];
if (TESTS_WEB_API_ADAPTER == self::ADAPTER_REST) {
$items = $this->getItemsForRest($order);
} else {
$items = $this->getItemsForSoap($order);
}
$serviceInfo = [
'rest' => [
'resourcePath' => self::RESOURCE_PATH,
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => self::SERVICE_READ_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_READ_NAME.'refund',
],
];
$data = [
'order_id' => $order->getId(),
'subtotal' => $order->getSubtotal(),
'grand_total' => $order->getGrandTotal(),
'base_grand_total' => $order->getBaseGrandTotal(),
'base_shipping_amount' => $order->getBaseShippingAmount(),
'shipping_address_id' => $order->getShippigAddressId(),
'billing_address_id' => $order->getBillingAddressId(),
'invoiceId' => $order->getInvoiceCollection()->getFirstItem()->getId(),
'adjustment' => null,
'adjustment_negative' => null,
'adjustment_positive' => null,
'base_adjustment' => null,
'base_adjustment_negative' => null,
'base_adjustment_positive' => null,
'base_currency_code' => null,
'base_discount_amount' => null,
'base_discount_tax_compensation_amount' => null,
'base_shipping_discount_tax_compensation_amnt' => null,
'base_shipping_incl_tax' => null,
'base_shipping_tax_amount' => null,
'base_subtotal' => null,
'base_subtotal_incl_tax' => null,
'base_tax_amount' => null,
'base_to_global_rate' => null,
'base_to_order_rate' => null,
'created_at' => null,
'creditmemo_status' => null,
'discount_amount' => null,
'discount_description' => null,
'email_sent' => null,
'entity_id' => null,
'global_currency_code' => null,
'discount_tax_compensation_amount' => null,
'increment_id' => null,
'invoice_id' => null,
'order_currency_code' => null,
'shipping_amount' => null,
'shipping_discount_tax_compensation_amount' => null,
'shipping_incl_tax' => null,
'shipping_tax_amount' => null,
'state' => null,
'store_currency_code' => null,
'store_id' => null,
'store_to_base_rate' => null,
'store_to_order_rate' => null,
'subtotal_incl_tax' => null,
'tax_amount' => null,
'transaction_id' => null,
'updated_at' => null,
'items' => $items,
];
$result = $this->_webApiCall(
$serviceInfo,
['creditmemo' => $data, 'offline_requested' => true]
);
$this->assertNotEmpty($result);
$order = $this->objectManager->get(OrderRepositoryInterface::class)->get($order->getId());
$this->assertEquals(Order::STATE_CLOSED, $order->getState());
}
private function getItemsForRest($order)
{
$items = [];
/** @var \Magento\Sales\Model\Order\Item $orderItem */
foreach ($order->getAllItems() as $orderItem) {
$items[] = [
'order_item_id' => $orderItem->getId(),
'qty' => $orderItem->getQtyInvoiced(),
'price' => $orderItem->getPrice(),
'row_total' => $orderItem->getRowTotal(),
'entity_id' => null,
];
}
return $items;
}
private function getItemsForSoap($order)
{
$items = [];
/** @var \Magento\Sales\Model\Order\Item $orderItem */
foreach ($order->getAllItems() as $orderItem) {
$items[] = array_merge($orderItem->getData(), [
'order_item_id' => $orderItem->getId(),
'qty' => $orderItem->getQtyInvoiced(),
'price' => $orderItem->getPrice(),
'row_total' => $orderItem->getRowTotal(),
'entity_id' => null,
]);
}
return $items;
}
}
@@ -0,0 +1,114 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Magento\Sales\Service\V1;
use Magento\Checkout\Test\Fixture\PlaceOrder as PlaceOrderFixture;
use Magento\Checkout\Test\Fixture\SetBillingAddress as SetBillingAddressFixture;
use Magento\Checkout\Test\Fixture\SetDeliveryMethod as SetDeliveryMethodFixture;
use Magento\Checkout\Test\Fixture\SetGuestEmail as SetGuestEmailFixture;
use Magento\Checkout\Test\Fixture\SetPaymentMethod as SetPaymentMethodFixture;
use Magento\Checkout\Test\Fixture\SetShippingAddress as SetShippingAddressFixture;
use Magento\Framework\Exception\NoSuchEntityException;
use Magento\Framework\Webapi\Rest\Request;
use Magento\Sales\Api\Data\OrderInterface;
use Magento\Sales\Test\Fixture\Invoice as InvoiceFixture;
use Magento\TestFramework\Fixture\DataFixture;
use Magento\TestFramework\TestCase\WebapiAbstract;
use Magento\Framework\ObjectManagerInterface;
use Magento\TestFramework\Fixture\DataFixtureStorage;
use Magento\TestFramework\Fixture\DataFixtureStorageManager;
use Magento\TestFramework\Helper\Bootstrap;
use Magento\Catalog\Test\Fixture\Product as ProductFixture;
use Magento\ConfigurableProduct\Test\Fixture\Attribute as AttributeFixture;
use Magento\ConfigurableProduct\Test\Fixture\Product as ConfigurableProductFixture;
use Magento\Quote\Test\Fixture\GuestCart as GuestCartFixture;
use Magento\ConfigurableProduct\Test\Fixture\AddProductToCart as AddConfigurableProductToCartFixture;
/**
* API test for credit memo generation with configurable product decimal quantity.
*/
class CreditMemoGenerateIfConfigurableProductWithDecimalQuantityTest extends WebapiAbstract
{
private const SERVICE_REFUND_ORDER_NAME = 'salesRefundOrderV1';
/**
* @var ObjectManagerInterface
*/
private $objectManager;
/**
* @var DataFixtureStorage
*/
private $fixtures;
protected function setUp(): void
{
$this->objectManager = Bootstrap::getObjectManager();
$this->fixtures = $this->objectManager->get(DataFixtureStorageManager::class)->getStorage();
}
#[
DataFixture(ProductFixture::class, ['stock_item' => ['is_qty_decimal' => true]], as: 'p1'),
DataFixture(ProductFixture::class, as: 'p2'),
DataFixture(AttributeFixture::class, as: 'attr'),
DataFixture(
ConfigurableProductFixture::class,
['_options' => ['$attr$'], '_links' => ['$p1$', '$p2$']],
'cp1'
),
DataFixture(GuestCartFixture::class, as: 'cart'),
DataFixture(
AddConfigurableProductToCartFixture::class,
['cart_id' => '$cart.id$', 'product_id' => '$cp1.id$', 'child_product_id' => '$p1.id$', 'qty' => 2.6],
),
DataFixture(SetBillingAddressFixture::class, ['cart_id' => '$cart.id$']),
DataFixture(SetShippingAddressFixture::class, ['cart_id' => '$cart.id$']),
DataFixture(SetGuestEmailFixture::class, ['cart_id' => '$cart.id$']),
DataFixture(SetDeliveryMethodFixture::class, ['cart_id' => '$cart.id$']),
DataFixture(SetPaymentMethodFixture::class, ['cart_id' => '$cart.id$']),
DataFixture(PlaceOrderFixture::class, ['cart_id' => '$cart.id$'], 'order'),
DataFixture(InvoiceFixture::class, ['order_id' => '$order.id$']),
]
public function testCreditMemoGenerationWithConfigurableProductDecimalQuantity(): void
{
$order = $this->fixtures->get('order');
try {
$creditMemoResult = $this->_webApiCall(
$this->getServiceData($order),
[
'orderId' => $order->getEntityId()
]
);
$this->assertGreaterThan(0, (int) $creditMemoResult);
} catch (NoSuchEntityException $e) {
$this->fail('Failed asserting that Creditmemo was not created');
}
}
/**
* Prepares and returns info for API service.
*
* @param OrderInterface $order
*
* @return array
*/
private function getServiceData(OrderInterface $order)
{
return [
'rest' => [
'resourcePath' => '/V1/order/' . $order->getEntityId() . '/refund',
'httpMethod' => Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => self::SERVICE_REFUND_ORDER_NAME,
'serviceVersion' => 'V1',
'operation' => self::SERVICE_REFUND_ORDER_NAME . 'execute',
]
];
}
}
@@ -0,0 +1,85 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Magento\Sales\Service\V1;
use Magento\Sales\Api\Data\CreditmemoCommentInterface as Comment;
use Magento\TestFramework\TestCase\WebapiAbstract;
class CreditmemoAddCommentTest extends WebapiAbstract
{
/**
* Service read name
*/
public const SERVICE_READ_NAME = 'salesCreditmemoCommentRepositoryV1';
/**
* Service version
*/
public const SERVICE_VERSION = 'V1';
/**
* Creditmemo increment id
*/
public const CREDITMEMO_INCREMENT_ID = '100000001';
/**
* @var \Magento\Framework\ObjectManagerInterface
*/
protected $objectManager;
/**
* Set up
*
* @return void
*/
protected function setUp(): void
{
$this->objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
}
/**
* Test creditmemo add comment service
*
* @magentoApiDataFixture Magento/Sales/_files/creditmemo_with_list.php
*/
public function testCreditmemoAddComment()
{
/** @var \Magento\Sales\Model\ResourceModel\Order\Creditmemo\Collection $creditmemoCollection */
$creditmemoCollection =
$this->objectManager->get(\Magento\Sales\Model\ResourceModel\Order\Creditmemo\Collection::class);
$creditmemo = $creditmemoCollection->getFirstItem();
$commentData = [
Comment::COMMENT => 'Hello world!',
Comment::ENTITY_ID => null,
Comment::CREATED_AT => null,
Comment::PARENT_ID => $creditmemo->getId(),
Comment::IS_VISIBLE_ON_FRONT => 1,
Comment::IS_CUSTOMER_NOTIFIED => 1
];
$requestData = ['entity' => $commentData];
$serviceInfo = [
'rest' => [
'resourcePath' => '/V1/creditmemo/' . $creditmemo->getId() . '/comments',
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => self::SERVICE_READ_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_READ_NAME . 'save',
],
];
$result = $this->_webApiCall($serviceInfo, $requestData);
self::assertNotEmpty($result);
self::assertNotEmpty($result[Comment::ENTITY_ID]);
self::assertEquals($creditmemo->getId(), $result[Comment::PARENT_ID]);
}
}
@@ -0,0 +1,51 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\TestFramework\TestCase\WebapiAbstract;
/**
* Class CreditmemoCancelTest
*/
class CreditmemoCancelTest extends WebapiAbstract
{
const SERVICE_VERSION = 'V1';
const SERVICE_NAME = 'salesCreditmemoManagementV1';
const CREDITMEMO_INCREMENT_ID = '100000001';
/**
* @magentoApiDataFixture Magento/Sales/_files/creditmemo_with_list.php
*/
public function testCreditmemoCancel()
{
$this->expectException(\Exception::class);
$this->expectExceptionMessage('You can not cancel Credit Memo');
$objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
/** @var \Magento\Sales\Model\ResourceModel\Order\Creditmemo\Collection $creditmemoCollection */
$creditmemoCollection = $objectManager->get(
\Magento\Sales\Model\ResourceModel\Order\Creditmemo\Collection::class
);
$creditmemo = $creditmemoCollection->getFirstItem();
$serviceInfo = [
'rest' => [
'resourcePath' => '/V1/creditmemo/' . $creditmemo->getId(),
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_PUT,
],
'soap' => [
'service' => self::SERVICE_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_NAME . 'cancel',
],
];
$requestData = ['id' => $creditmemo->getId()];
$this->_webApiCall($serviceInfo, $requestData);
}
}
@@ -0,0 +1,73 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\Framework\Webapi\Rest\Request;
use Magento\Sales\Api\CreditmemoCommentRepositoryInterface;
use Magento\Sales\Api\Data\CreditmemoCommentInterface;
use Magento\Sales\Api\Data\CreditmemoCommentInterfaceFactory;
use Magento\Sales\Api\Data\CreditmemoInterface;
use Magento\Sales\Model\ResourceModel\Order\Creditmemo\Collection;
use Magento\TestFramework\Helper\Bootstrap;
use Magento\TestFramework\TestCase\WebapiAbstract;
/**
* Class CreditmemoCommentsListTest
*/
class CreditmemoCommentsListTest extends WebapiAbstract
{
const SERVICE_NAME = 'salesCreditmemoManagementV1';
const SERVICE_VERSION = 'V1';
/**
* @magentoApiDataFixture Magento/Sales/_files/creditmemo_for_get.php
*/
public function testCreditmemoCommentsList()
{
$comment = 'Credit Memo Comment';
$objectManager = Bootstrap::getObjectManager();
/** @var Collection $creditmemoCollection */
$creditmemoCollection = $objectManager->get(Collection::class);
/** @var CreditmemoInterface $creditmemo */
$creditmemo = $creditmemoCollection->getFirstItem();
$creditmemoComment = $objectManager->get(CreditmemoCommentInterfaceFactory::class)
->create(
[
'data' => [
CreditmemoCommentInterface::COMMENT => $comment,
CreditmemoCommentInterface::PARENT_ID => $creditmemo->getEntityId(),
CreditmemoCommentInterface::IS_VISIBLE_ON_FRONT => true,
CreditmemoCommentInterface::IS_CUSTOMER_NOTIFIED => true,
]
]
);
/** @var CreditmemoCommentRepositoryInterface $creditMemoRepository */
$creditmemoRepository = $objectManager->get(CreditmemoCommentRepositoryInterface::class);
$creditmemoRepository->save($creditmemoComment);
$serviceInfo = [
'rest' => [
'resourcePath' => '/V1/creditmemo/' . $creditmemo->getEntityId() . '/comments',
'httpMethod' => Request::HTTP_METHOD_GET,
],
'soap' => [
'service' => self::SERVICE_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_NAME . 'getCommentsList',
],
];
$result = $this->_webApiCall($serviceInfo, ['id' => $creditmemo->getEntityId()]);
self::assertNotEmpty($result['items']);
$item = $result['items'][0];
self::assertNotEmpty($item[CreditmemoCommentInterface::ENTITY_ID]);
self::assertEquals($comment, $item[CreditmemoCommentInterface::COMMENT]);
}
}
@@ -0,0 +1,111 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\TestFramework\TestCase\WebapiAbstract;
/**
* Class CreditmemoCreateTest
*/
class CreditmemoCreateTest extends WebapiAbstract
{
const RESOURCE_PATH = '/V1/creditmemo';
const SERVICE_READ_NAME = 'salesCreditmemoRepositoryV1';
const SERVICE_VERSION = 'V1';
/**
* @var \Magento\Framework\ObjectManagerInterface
*/
protected $objectManager;
protected function setUp(): void
{
$this->objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
}
/**
* @magentoApiDataFixture Magento/Sales/_files/invoice.php
*/
public function testInvoke()
{
/** @var \Magento\Sales\Model\Order $order */
$orderCollection = $this->objectManager->get(\Magento\Sales\Model\ResourceModel\Order\Collection::class);
$order = $orderCollection->getFirstItem();
/** @var \Magento\Sales\Model\Order\Item $orderItem */
$orderItem = current($order->getAllItems());
$items = [
$orderItem->getId() => ['order_item_id' => $orderItem->getId(), 'qty' => $orderItem->getQtyInvoiced()],
];
$serviceInfo = [
'rest' => [
'resourcePath' => self::RESOURCE_PATH,
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => self::SERVICE_READ_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_READ_NAME . 'save',
],
];
$data = [
'adjustment' => null,
'adjustment_negative' => null,
'adjustment_positive' => null,
'base_adjustment' => null,
'base_adjustment_negative' => null,
'base_adjustment_positive' => null,
'base_currency_code' => null,
'base_discount_amount' => null,
'base_grand_total' => null,
'base_discount_tax_compensation_amount' => null,
'base_shipping_amount' => null,
'base_shipping_discount_tax_compensation_amnt' => null,
'base_shipping_incl_tax' => null,
'base_shipping_tax_amount' => null,
'base_subtotal' => null,
'base_subtotal_incl_tax' => null,
'base_tax_amount' => null,
'base_to_global_rate' => null,
'base_to_order_rate' => null,
'billing_address_id' => null,
'created_at' => null,
'creditmemo_status' => null,
'discount_amount' => null,
'discount_description' => null,
'email_sent' => null,
'entity_id' => null,
'global_currency_code' => null,
'grand_total' => null,
'discount_tax_compensation_amount' => null,
'increment_id' => null,
'invoice_id' => null,
'order_currency_code' => null,
'order_id' => $order->getId(),
'shipping_address_id' => null,
'shipping_amount' => null,
'shipping_discount_tax_compensation_amount' => null,
'shipping_incl_tax' => null,
'shipping_tax_amount' => null,
'state' => null,
'store_currency_code' => null,
'store_id' => null,
'store_to_base_rate' => null,
'store_to_order_rate' => null,
'subtotal' => null,
'subtotal_incl_tax' => null,
'tax_amount' => null,
'transaction_id' => null,
'updated_at' => null,
'items' => $items,
];
$result = $this->_webApiCall($serviceInfo, ['entity' => $data]);
$this->assertNotEmpty($result);
}
}
@@ -0,0 +1,47 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\TestFramework\TestCase\WebapiAbstract;
/**
* Class CreditmemoEmailTest
*/
class CreditmemoEmailTest extends WebapiAbstract
{
const SERVICE_VERSION = 'V1';
const SERVICE_NAME = 'salesCreditmemoManagementV1';
const CREDITMEMO_INCREMENT_ID = '100000001';
/**
* @magentoApiDataFixture Magento/Sales/_files/creditmemo_with_list.php
*/
public function testCreditmemoEmail()
{
$objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
/** @var \Magento\Sales\Model\ResourceModel\Order\Creditmemo\Collection $creditmemoCollection */
$creditmemoCollection = $objectManager->get(
\Magento\Sales\Model\ResourceModel\Order\Creditmemo\Collection::class
);
$creditmemo = $creditmemoCollection->getFirstItem();
$serviceInfo = [
'rest' => [
'resourcePath' => '/V1/creditmemo/' . $creditmemo->getId() . '/emails',
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => self::SERVICE_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_NAME . 'notify',
],
];
$requestData = ['id' => $creditmemo->getId()];
$this->_webApiCall($serviceInfo, $requestData);
}
}
@@ -0,0 +1,141 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\Catalog\Test\Fixture\Product as ProductFixture;
use Magento\Checkout\Test\Fixture\PlaceOrder as PlaceOrderFixture;
use Magento\Checkout\Test\Fixture\SetBillingAddress as SetBillingAddressFixture;
use Magento\Checkout\Test\Fixture\SetDeliveryMethod as SetDeliveryMethodFixture;
use Magento\Checkout\Test\Fixture\SetGuestEmail as SetGuestEmailFixture;
use Magento\Checkout\Test\Fixture\SetPaymentMethod as SetPaymentMethodFixture;
use Magento\Checkout\Test\Fixture\SetShippingAddress as SetShippingAddressFixture;
use Magento\Quote\Test\Fixture\AddProductToCart as AddProductToCartFixture;
use Magento\Quote\Test\Fixture\GuestCart as GuestCartFixture;
use Magento\Sales\Test\Fixture\Creditmemo as CreditmemoFixture;
use Magento\Sales\Test\Fixture\Invoice as InvoiceFixture;
use Magento\Sales\Test\Fixture\Shipment as ShipmentFixture;
use Magento\TestFramework\Fixture\DataFixture;
use Magento\TestFramework\Fixture\DataFixtureStorage;
use Magento\TestFramework\Fixture\DataFixtureStorageManager;
use Magento\TestFramework\TestCase\WebapiAbstract;
class CreditmemoGetTest extends WebapiAbstract
{
/**
* Resource path
*/
private const RESOURCE_PATH = '/V1/creditmemo';
/**
* Service read name
*/
private const SERVICE_READ_NAME = 'salesCreditmemoRepositoryV1';
/**
* Service version
*/
private const SERVICE_VERSION = 'V1';
/**
* Creditmemo id
*/
private const CREDITMEMO_INCREMENT_ID = '100000001';
/**
* @var \Magento\Framework\ObjectManagerInterface
*/
protected $objectManager;
/**
* Required fields are in the answer
*
* @var array
*/
protected $requiredFields = [
'entity_id',
'store_id',
'base_shipping_tax_amount',
'base_discount_amount',
'grand_total',
'base_subtotal_incl_tax',
'shipping_amount',
'subtotal_incl_tax',
'base_shipping_amount',
'base_adjustment',
'base_subtotal',
'discount_amount',
'subtotal',
'adjustment',
'base_grand_total',
'base_tax_amount',
'shipping_tax_amount',
'tax_amount',
'order_id',
'state',
'increment_id',
];
/**
* @var DataFixtureStorage
*/
private $fixtures;
/**
* Set up
*/
protected function setUp(): void
{
$this->objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
$this->fixtures = $this->objectManager->get(DataFixtureStorageManager::class)->getStorage();
}
/**
* Test creditmemo get service
*/
#[
DataFixture(ProductFixture::class, as: 'product'),
DataFixture(GuestCartFixture::class, as: 'cart'),
DataFixture(AddProductToCartFixture::class, ['cart_id' => '$cart.id$', 'product_id' => '$product.id$']),
DataFixture(SetBillingAddressFixture::class, ['cart_id' => '$cart.id$']),
DataFixture(SetShippingAddressFixture::class, ['cart_id' => '$cart.id$']),
DataFixture(SetGuestEmailFixture::class, ['cart_id' => '$cart.id$']),
DataFixture(SetDeliveryMethodFixture::class, ['cart_id' => '$cart.id$']),
DataFixture(SetPaymentMethodFixture::class, ['cart_id' => '$cart.id$']),
DataFixture(PlaceOrderFixture::class, ['cart_id' => '$cart.id$'], 'order'),
DataFixture(InvoiceFixture::class, ['order_id' => '$order.id$']),
DataFixture(ShipmentFixture::class, ['order_id' => '$order.id$']),
DataFixture(CreditmemoFixture::class, ['order_id' => '$order.id$'], 'creditmemo'),
]
public function testCreditmemoGet()
{
$creditmemo = $this->fixtures->get('creditmemo');
$serviceInfo = [
'rest' => [
'resourcePath' => self::RESOURCE_PATH . '/' . $creditmemo->getId(),
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
],
'soap' => [
'service' => self::SERVICE_READ_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_READ_NAME . 'get',
],
];
$actual = $this->_webApiCall($serviceInfo, ['id' => $creditmemo->getId()]);
$expected = $creditmemo->getData();
foreach ($this->requiredFields as $field) {
$this->assertArrayHasKey($field, $actual);
$this->assertEquals($expected[$field], $actual[$field]);
}
//check that nullable fields were marked as optional and were not sent
foreach ($actual as $value) {
$this->assertNotNull($value);
}
}
}
@@ -0,0 +1,112 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\Framework\Api\SortOrderBuilder;
use Magento\TestFramework\Helper\Bootstrap;
use Magento\TestFramework\TestCase\WebapiAbstract;
/**
* Class CreditmemoListTest
*/
class CreditmemoListTest extends WebapiAbstract
{
/**
* Resource path
*/
const RESOURCE_PATH = '/V1/creditmemos';
/**
* Service read name
*/
const SERVICE_READ_NAME = 'salesCreditmemoRepositoryV1';
/**
* Service version
*/
const SERVICE_VERSION = 'V1';
/**
* @var \Magento\Framework\ObjectManagerInterface
*/
protected $objectManager;
/**
* Set up
*/
protected function setUp(): void
{
$this->objectManager = Bootstrap::getObjectManager();
}
/**
* Test creditmemo list service
*
* @magentoApiDataFixture Magento/Sales/_files/creditmemo_list.php
*/
public function testCreditmemoList()
{
/** @var SortOrderBuilder $sortOrderBuilder */
$sortOrderBuilder = $this->objectManager->get(
SortOrderBuilder::class
);
/** @var $searchCriteriaBuilder \Magento\Framework\Api\SearchCriteriaBuilder */
$searchCriteriaBuilder = $this->objectManager->create(
\Magento\Framework\Api\SearchCriteriaBuilder::class
);
/** @var $filterBuilder \Magento\Framework\Api\FilterBuilder */
$filterBuilder = $this->objectManager->create(
\Magento\Framework\Api\FilterBuilder::class
);
$stateFilter = $filterBuilder
->setField('state')
->setValue((string)\Magento\Sales\Model\Order\Creditmemo::STATE_OPEN)
->setConditionType('eq')
->create();
$incrementFilter = $filterBuilder
->setField('increment_id')
->setValue('456')
->setConditionType('eq')
->create();
$zeroStatusFilter = $filterBuilder
->setField('creditmemo_status')
->setValue('0')
->setConditionType('eq')
->create();
$sortOrder = $sortOrderBuilder
->setField('grand_total')
->setDirection('ASC')
->create();
$searchCriteriaBuilder->addFilters([$stateFilter]);
$searchCriteriaBuilder->addFilters([$incrementFilter, $zeroStatusFilter]);
$searchCriteriaBuilder->addSortOrder($sortOrder);
$searchCriteriaBuilder->setPageSize(20);
$searchData = $searchCriteriaBuilder->create()->__toArray();
$requestData = ['searchCriteria' => $searchData];
$serviceInfo = [
'rest' => [
'resourcePath' => self::RESOURCE_PATH . '?' . http_build_query($requestData),
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
],
'soap' => [
'service' => self::SERVICE_READ_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_READ_NAME . 'getList',
],
];
$result = $this->_webApiCall($serviceInfo, $requestData);
// TODO Test fails, due to the inability of the framework API to handle data collection
$this->assertArrayHasKey('items', $result);
$this->assertCount(2, $result['items']);
$this->assertArrayHasKey('search_criteria', $result);
$this->assertEquals('789', $result['items'][0]['increment_id']);
$this->assertEquals('456', $result['items'][1]['increment_id']);
$this->assertEquals($searchData, $result['search_criteria']);
}
}
@@ -0,0 +1,62 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Magento\Sales\Service\V1;
use Magento\Sales\Api\Data\InvoiceCommentInterface;
use Magento\TestFramework\TestCase\WebapiAbstract;
class InvoiceAddCommentTest extends WebapiAbstract
{
/**
* Service read name
*/
public const SERVICE_READ_NAME = 'salesInvoiceCommentRepositoryV1';
/**
* Service version
*/
public const SERVICE_VERSION = 'V1';
/**
* Test invoice add comment service
*
* @magentoApiDataFixture Magento/Sales/_files/invoice.php
*/
public function testInvoiceAddComment()
{
$objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
/** @var \Magento\Sales\Model\Order\Invoice $invoice */
$invoiceCollection = $objectManager->get(\Magento\Sales\Model\ResourceModel\Order\Invoice\Collection::class);
$invoice = $invoiceCollection->getFirstItem();
$commentData = [
InvoiceCommentInterface::COMMENT => 'Hello world!',
InvoiceCommentInterface::ENTITY_ID => null,
InvoiceCommentInterface::CREATED_AT => null,
InvoiceCommentInterface::PARENT_ID => $invoice->getId(),
InvoiceCommentInterface::IS_VISIBLE_ON_FRONT => 1,
InvoiceCommentInterface::IS_CUSTOMER_NOTIFIED => 1
];
$requestData = ['entity' => $commentData];
$serviceInfo = [
'rest' => [
'resourcePath' => '/V1/invoices/comments',
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => self::SERVICE_READ_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_READ_NAME . 'save',
],
];
$result = $this->_webApiCall($serviceInfo, $requestData);
$this->assertNotEmpty($result);
}
}
@@ -0,0 +1,44 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\TestFramework\TestCase\WebapiAbstract;
/**
* Class InvoiceCaptureTest
*/
class InvoiceCaptureTest extends WebapiAbstract
{
const SERVICE_VERSION = 'V1';
const SERVICE_NAME = 'salesInvoiceManagementV1';
/**
* @magentoApiDataFixture Magento/Sales/_files/invoice.php
*/
public function testInvoiceCapture()
{
$this->expectException(\Exception::class);
$objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
/** @var \Magento\Sales\Model\Order\Invoice $invoice */
$invoice = $objectManager->get(\Magento\Sales\Model\Order\Invoice::class)->loadByIncrementId('100000001');
$serviceInfo = [
'rest' => [
'resourcePath' => '/V1/invoices/' . $invoice->getId() . '/capture',
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => self::SERVICE_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_NAME . 'setCapture',
],
];
$requestData = ['id' => $invoice->getId()];
$this->_webApiCall($serviceInfo, $requestData);
}
}
@@ -0,0 +1,56 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\TestFramework\TestCase\WebapiAbstract;
/**
* Class InvoiceCommentsListTest
*/
class InvoiceCommentsListTest extends WebapiAbstract
{
const SERVICE_NAME = 'salesInvoiceManagementV1';
const SERVICE_VERSION = 'V1';
/**
* @magentoApiDataFixture Magento/Sales/_files/invoice.php
*/
public function testInvoiceCommentsList()
{
$comment = 'Test comment';
$objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
/** @var \Magento\Sales\Model\ResourceModel\Order\Invoice\Collection $invoiceCollection */
$invoiceCollection = $objectManager->get(\Magento\Sales\Model\ResourceModel\Order\Invoice\Collection::class);
$invoice = $invoiceCollection->getFirstItem();
$invoiceComment = $objectManager->get(\Magento\Sales\Model\Order\Invoice\Comment::class);
$invoiceComment->setComment($comment);
$invoiceComment->setParentId($invoice->getId());
$invoiceComment->save();
$serviceInfo = [
'rest' => [
'resourcePath' => '/V1/invoices/' . $invoice->getId() . '/comments',
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
],
'soap' => [
'service' => self::SERVICE_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_NAME . 'getCommentsList',
],
];
$requestData = ['id' => $invoice->getId()];
// TODO Test fails, due to the inability of the framework API to handle data collection
$result = $this->_webApiCall($serviceInfo, $requestData);
foreach ($result['items'] as $item) {
/** @var \Magento\Sales\Model\Order\Invoice\Comment $invoiceHistoryStatus */
$invoiceHistoryStatus = $objectManager->get(\Magento\Sales\Model\Order\Invoice\Comment::class)
->load($item['entity_id']);
$this->assertEquals($invoiceHistoryStatus->getComment(), $item['comment']);
}
}
}
@@ -0,0 +1,127 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\TestFramework\TestCase\WebapiAbstract;
/**
* Class InvoiceCreateTest
*/
class InvoiceCreateTest extends WebapiAbstract
{
const RESOURCE_PATH = '/V1/invoices';
const SERVICE_READ_NAME = 'salesInvoiceRepositoryV1';
const SERVICE_VERSION = 'V1';
/**
* @var \Magento\Framework\ObjectManagerInterface
*/
protected $objectManager;
protected function setUp(): void
{
$this->objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
}
/**
* @magentoApiDataFixture Magento/Sales/_files/order.php
*/
public function testInvoke()
{
/** @var \Magento\Sales\Model\Order $order */
$order = $this->objectManager->create(\Magento\Sales\Model\Order::class)->loadByIncrementId('100000001');
$serviceInfo = [
'rest' => [
'resourcePath' => self::RESOURCE_PATH,
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => self::SERVICE_READ_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_READ_NAME . 'save',
],
];
$orderItems = $order->getAllItems();
$data = [
'order_id' => $order->getId(),
'base_currency_code' => null,
'base_discount_amount' => null,
'base_grand_total' => null,
'base_discount_tax_compensation_amount' => null,
'base_shipping_amount' => null,
'base_shipping_discount_tax_compensation_amnt' => null,
'base_shipping_incl_tax' => null,
'base_shipping_tax_amount' => null,
'base_subtotal' => null,
'base_subtotal_incl_tax' => null,
'base_tax_amount' => null,
'base_total_refunded' => null,
'base_to_global_rate' => null,
'base_to_order_rate' => null,
'billing_address_id' => null,
'can_void_flag' => null,
'created_at' => null,
'discount_amount' => null,
'discount_description' => null,
'email_sent' => null,
'entity_id' => null,
'global_currency_code' => null,
'grand_total' => null,
'discount_tax_compensation_amount' => null,
'increment_id' => null,
'is_used_for_refund' => null,
'order_currency_code' => null,
'shipping_address_id' => null,
'shipping_amount' => null,
'shipping_discount_tax_compensation_amount' => null,
'shipping_incl_tax' => null,
'shipping_tax_amount' => null,
'state' => null,
'store_currency_code' => null,
'store_id' => null,
'store_to_base_rate' => null,
'store_to_order_rate' => null,
'subtotal' => null,
'subtotal_incl_tax' => null,
'tax_amount' => null,
'total_qty' => '1',
'transaction_id' => null,
'updated_at' => null,
'items' => [
[
'orderItemId' => $orderItems[0]->getId(),
'qty' => 2,
'additionalData' => null,
'baseCost' => null,
'baseDiscountAmount' => null,
'baseDiscountTaxCompensationAmount' => null,
'basePrice' => null,
'basePriceInclTax' => null,
'baseRowTotal' => null,
'baseRowTotalInclTax' => null,
'baseTaxAmount' => null,
'description' => null,
'discountAmount' => null,
'discountTaxCompensationAmount' => null,
'name' => null,
'entity_id' => null,
'parentId' => null,
'price' => null,
'priceInclTax' => null,
'productId' => null,
'rowTotal' => null,
'rowTotalInclTax' => null,
'sku' => 'sku' . uniqid(),
'taxAmount' => null,
],
],
];
$result = $this->_webApiCall($serviceInfo, ['entity' => $data]);
$this->assertNotEmpty($result);
}
}
@@ -0,0 +1,42 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\TestFramework\TestCase\WebapiAbstract;
/**
* Class InvoiceEmailTest
*/
class InvoiceEmailTest extends WebapiAbstract
{
const SERVICE_VERSION = 'V1';
const SERVICE_NAME = 'salesInvoiceManagementV1';
/**
* @magentoApiDataFixture Magento/Sales/_files/invoice.php
*/
public function testInvoiceEmail()
{
$objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
$invoiceCollection = $objectManager->get(\Magento\Sales\Model\ResourceModel\Order\Invoice\Collection::class);
$invoice = $invoiceCollection->getFirstItem();
$serviceInfo = [
'rest' => [
'resourcePath' => '/V1/invoices/' . $invoice->getId() . '/emails',
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => self::SERVICE_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_NAME . 'notify',
],
];
$requestData = ['id' => $invoice->getId()];
$result = $this->_webApiCall($serviceInfo, $requestData);
$this->assertTrue($result);
}
}
@@ -0,0 +1,57 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\TestFramework\TestCase\WebapiAbstract;
/**
* Class InvoiceGetTest
*/
class InvoiceGetTest extends WebapiAbstract
{
const RESOURCE_PATH = '/V1/invoices';
const SERVICE_READ_NAME = 'salesInvoiceRepositoryV1';
const SERVICE_VERSION = 'V1';
/**
* @magentoApiDataFixture Magento/Sales/_files/invoice.php
*/
public function testInvoiceGet()
{
$objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
/** @var \Magento\Sales\Model\Order\Invoice $invoice */
$invoiceCollection = $objectManager->get(\Magento\Sales\Model\ResourceModel\Order\Invoice\Collection::class);
$invoice = $invoiceCollection->getFirstItem();
$expectedInvoiceData = [
'grand_total' => '100.0000',
'subtotal' => '100.0000',
'increment_id' => $invoice->getIncrementId(),
];
$serviceInfo = [
'rest' => [
'resourcePath' => self::RESOURCE_PATH . '/' . $invoice->getId(),
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
],
'soap' => [
'service' => self::SERVICE_READ_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_READ_NAME . 'get',
],
];
$result = $this->_webApiCall($serviceInfo, ['id' => $invoice->getId()]);
foreach ($expectedInvoiceData as $field => $value) {
$this->assertArrayHasKey($field, $result);
$this->assertEquals($value, $result[$field]);
}
//check that nullable fields were marked as optional and were not sent
foreach ($result as $value) {
$this->assertNotNull($value);
}
}
}
@@ -0,0 +1,99 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\Framework\Api\SortOrderBuilder;
use Magento\TestFramework\TestCase\WebapiAbstract;
/**
* Class InvoiceListTest
*/
class InvoiceListTest extends WebapiAbstract
{
const RESOURCE_PATH = '/V1/invoices';
const SERVICE_READ_NAME = 'salesInvoiceRepositoryV1';
const SERVICE_VERSION = 'V1';
/**
* @var \Magento\Framework\ObjectManagerInterface
*/
protected $objectManager;
protected function setUp(): void
{
$this->objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
}
/**
* @magentoApiDataFixture Magento/Sales/_files/invoice_list.php
*/
public function testInvoiceList()
{
/** @var SortOrderBuilder $sortOrderBuilder */
$sortOrderBuilder = $this->objectManager->get(
SortOrderBuilder::class
);
/** @var $searchCriteriaBuilder \Magento\Framework\Api\SearchCriteriaBuilder */
$searchCriteriaBuilder = $this->objectManager->create(
\Magento\Framework\Api\SearchCriteriaBuilder::class
);
/** @var $filterBuilder \Magento\Framework\Api\FilterBuilder */
$filterBuilder = $this->objectManager->create(
\Magento\Framework\Api\FilterBuilder::class
);
$stateFilter = $filterBuilder
->setField('state')
->setValue((string)\Magento\Sales\Model\Order\Creditmemo::STATE_OPEN)
->setConditionType('eq')
->create();
$incrementFilter = $filterBuilder
->setField('increment_id')
->setValue('456')
->setConditionType('eq')
->create();
$zeroStatusFilter = $filterBuilder
->setField('can_void_flag')
->setValue('0')
->setConditionType('eq')
->create();
$sortOrder = $sortOrderBuilder
->setField('grand_total')
->setDirection('ASC')
->create();
$searchCriteriaBuilder->addFilters([$stateFilter]);
$searchCriteriaBuilder->addFilters([$incrementFilter, $zeroStatusFilter]);
$searchCriteriaBuilder->addSortOrder($sortOrder);
$searchCriteriaBuilder->setPageSize(20);
$searchData = $searchCriteriaBuilder->create()->__toArray();
$requestData = ['searchCriteria' => $searchData];
$serviceInfo = [
'rest' => [
'resourcePath' => self::RESOURCE_PATH . '?' . http_build_query($requestData),
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
],
'soap' => [
'service' => self::SERVICE_READ_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_READ_NAME . 'getList',
],
];
$result = $this->_webApiCall($serviceInfo, $requestData);
// TODO Test fails, due to the inability of the framework API to handle data collection
$this->assertArrayHasKey('items', $result);
$this->assertCount(2, $result['items']);
$this->assertArrayHasKey('search_criteria', $result);
$this->assertEquals('789', $result['items'][0]['increment_id']);
$this->assertEquals('456', $result['items'][1]['increment_id']);
$this->assertEquals($searchData, $result['search_criteria']);
}
}
@@ -0,0 +1,44 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\TestFramework\TestCase\WebapiAbstract;
/**
* Class InvoiceVoidTest
*/
class InvoiceVoidTest extends WebapiAbstract
{
const SERVICE_VERSION = 'V1';
const SERVICE_NAME = 'salesInvoiceManagementV1';
/**
* @magentoApiDataFixture Magento/Sales/_files/invoice.php
*/
public function testInvoiceVoid()
{
$this->expectException(\Exception::class);
$objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
/** @var \Magento\Sales\Model\Order\Invoice $invoice */
$invoice = $objectManager->get(\Magento\Sales\Model\Order\Invoice::class)->loadByIncrementId('100000001');
$serviceInfo = [
'rest' => [
'resourcePath' => '/V1/invoices/' . $invoice->getId() . '/void',
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => self::SERVICE_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_NAME . 'setVoid',
],
];
$requestData = ['id' => $invoice->getId()];
$this->_webApiCall($serviceInfo, $requestData);
}
}
@@ -0,0 +1,97 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\Sales\Api\Data\OrderAddressInterface as OrderAddress;
use Magento\TestFramework\TestCase\WebapiAbstract;
/**
* Test for address update
*/
class OrderAddressUpdateTest extends WebapiAbstract
{
const SERVICE_VERSION = 'V1';
const SERVICE_NAME = 'salesOrderAddressRepositoryV1';
/**
* @magentoApiDataFixture Magento/Sales/_files/order.php
* @SuppressWarnings(PHPMD.UnusedLocalVariable)
*/
public function testOrderAddressUpdate()
{
$objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
/** @var \Magento\Sales\Model\Order $order */
$order = $objectManager->get(\Magento\Sales\Model\Order::class)->loadByIncrementId('100000001');
$address = [
OrderAddress::REGION => 'CA',
OrderAddress::POSTCODE => '11111',
OrderAddress::LASTNAME => 'lastname',
OrderAddress::STREET => ['street'],
OrderAddress::CITY => 'city',
OrderAddress::EMAIL => 'email@email.com',
OrderAddress::COMPANY => 'company',
OrderAddress::TELEPHONE => 't123456789',
OrderAddress::COUNTRY_ID => 'US',
OrderAddress::FIRSTNAME => 'firstname',
OrderAddress::ADDRESS_TYPE => 'billing',
OrderAddress::PARENT_ID => $order->getId(),
OrderAddress::ENTITY_ID => $order->getBillingAddressId(),
OrderAddress::CUSTOMER_ADDRESS_ID => null,
OrderAddress::CUSTOMER_ID => null,
OrderAddress::FAX => null,
OrderAddress::MIDDLENAME => null,
OrderAddress::PREFIX => null,
OrderAddress::REGION_ID => null,
OrderAddress::SUFFIX => null,
OrderAddress::VAT_ID => null,
OrderAddress::VAT_IS_VALID => null,
OrderAddress::VAT_REQUEST_DATE => null,
OrderAddress::VAT_REQUEST_ID => null,
OrderAddress::VAT_REQUEST_SUCCESS => null,
];
$requestData = ['entity' => $address];
$serviceInfo = [
'rest' => [
'resourcePath' => '/V1/orders/' . $order->getId(),
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_PUT,
],
'soap' => [
'service' => self::SERVICE_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_NAME . 'save',
],
];
$result = $this->_webApiCall($serviceInfo, $requestData);
$this->assertGreaterThan(1, count($result));
/** @var \Magento\Sales\Model\Order $actualOrder */
$actualOrder = $objectManager->get(\Magento\Sales\Model\Order::class)->load($order->getId());
$billingAddress = $actualOrder->getBillingAddress();
$validate = [
OrderAddress::REGION => 'CA',
OrderAddress::POSTCODE => '11111',
OrderAddress::LASTNAME => 'lastname',
OrderAddress::STREET => 'street',
OrderAddress::CITY => 'city',
OrderAddress::EMAIL => 'email@email.com',
OrderAddress::COMPANY => 'company',
OrderAddress::TELEPHONE => 't123456789',
OrderAddress::COUNTRY_ID => 'US',
OrderAddress::FIRSTNAME => 'firstname',
OrderAddress::ADDRESS_TYPE => 'billing',
OrderAddress::PARENT_ID => $order->getId(),
OrderAddress::ENTITY_ID => $order->getBillingAddressId(),
];
foreach ($validate as $key => $field) {
$this->assertEquals($validate[$key], $billingAddress->getData($key));
}
}
}
@@ -0,0 +1,98 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\Framework\ObjectManagerInterface;
use Magento\Sales\Model\Order;
use Magento\TestFramework\Helper\Bootstrap;
use Magento\TestFramework\TestCase\WebapiAbstract;
/**
* Canceling of the order
*/
class OrderCancelTest extends WebapiAbstract
{
const SERVICE_VERSION = 'V1';
const SERVICE_NAME = 'salesOrderManagementV1';
/**
* @var ObjectManagerInterface
*/
private $objectManager;
/**
* @inheritdoc
*/
protected function setUp(): void
{
$this->objectManager = Bootstrap::getObjectManager();
}
/**
* Gets order by increment ID.
*
* @param string $incrementId
* @return Order
*/
private function getOrder(string $incrementId): Order
{
return $this->objectManager->create(Order::class)->loadByIncrementId($incrementId);
}
/**
* Send API request for canceling the order
*
* @param Order $order
* @return array|bool|float|int|string
*/
private function sendCancelRequest(Order $order)
{
$serviceInfo = [
'rest' => [
'resourcePath' => '/V1/orders/' . $order->getId() . '/cancel',
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => self::SERVICE_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_NAME . 'cancel',
],
];
$requestData = ['id' => $order->getId()];
return $this->_webApiCall($serviceInfo, $requestData);
}
/**
* @magentoApiDataFixture Magento/Sales/_files/order.php
*/
public function testOrderCancel()
{
$order = $this->getOrder('100000001');
$result = $this->sendCancelRequest($order);
$this->assertTrue($result);
}
/**
* @magentoApiDataFixture Magento/Sales/_files/order_state_hold.php
*/
public function testOrderWithStateHoldedShouldNotBeCanceled()
{
$order = $this->getOrder('100000001');
$result = $this->sendCancelRequest($order);
$this->assertFalse($result);
}
/**
* @magentoApiDataFixture Magento/Sales/_files/order_with_shipping_and_invoice.php
*/
public function testOrderWithStateCompleteShouldNotBeCanceled()
{
$order = $this->getOrder('100000001');
$result = $this->sendCancelRequest($order);
$this->assertFalse($result);
}
}
@@ -0,0 +1,49 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\TestFramework\TestCase\WebapiAbstract;
class OrderCommentsListTest extends WebapiAbstract
{
const SERVICE_NAME = 'salesOrderManagementV1';
const SERVICE_VERSION = 'V1';
/**
* @magentoApiDataFixture Magento/Sales/_files/order.php
*/
public function testOrderCommentsList()
{
$comment = 'Test comment';
$objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
/** @var \Magento\Sales\Model\Order $order */
$order = $objectManager->get(\Magento\Sales\Model\Order::class)->loadByIncrementId('100000001');
$history = $order->addStatusHistoryComment($comment, $order->getStatus());
$history->save();
$serviceInfo = [
'rest' => [
'resourcePath' => '/V1/orders/' . $order->getId() . '/comments',
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
],
'soap' => [
'service' => self::SERVICE_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_NAME . 'getCommentsList',
],
];
$requestData = ['id' => $order->getId()];
$result = $this->_webApiCall($serviceInfo, $requestData);
foreach ($result['items'] as $history) {
$orderHistoryStatus = $objectManager->get(\Magento\Sales\Model\Order\Status\History::class)
->load($history['entity_id']);
$this->assertEquals($orderHistoryStatus->getComment(), $history['comment']);
$this->assertEquals($orderHistoryStatus->getStatus(), $history['status']);
}
}
}
@@ -0,0 +1,304 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\TestFramework\TestCase\WebapiAbstract;
use Magento\Catalog\Api\Data\ProductCustomOptionInterface;
/**
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
*/
class OrderCreateTest extends WebapiAbstract
{
private const RESOURCE_PATH = '/V1/orders';
private const SERVICE_READ_NAME = 'salesOrderRepositoryV1';
private const SERVICE_VERSION = 'V1';
private const ORDER_INCREMENT_ID = '100000001';
/**
* @var \Magento\Framework\ObjectManagerInterface
*/
protected $objectManager;
protected function setUp(): void
{
$this->objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
}
/**
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
*/
protected function prepareOrder()
{
/** @var \Magento\Sales\Model\Order $orderBuilder */
$orderFactory = $this->objectManager->get(\Magento\Sales\Model\OrderFactory::class);
/** @var \Magento\Sales\Api\Data\OrderItemFactory $orderItemFactory */
$orderItemFactory = $this->objectManager->get(\Magento\Sales\Model\Order\ItemFactory::class);
/** @var \Magento\Sales\Api\Data\OrderPaymentFactory $orderPaymentFactory */
$orderPaymentFactory = $this->objectManager->get(\Magento\Sales\Model\Order\PaymentFactory::class);
/** @var \Magento\Sales\Model\Order\AddressRepository $orderAddressRepository */
$orderAddressRepository = $this->objectManager->get(\Magento\Sales\Model\Order\AddressRepository::class);
/** @var \Magento\Store\Model\StoreManagerInterface $storeManager */
$storeManager = $this->objectManager->get(\Magento\Store\Model\StoreManagerInterface::class);
$order = $orderFactory->create(
['data' => $this->getDataStructure(\Magento\Sales\Api\Data\OrderInterface::class)]
);
$orderItem = $orderItemFactory->create(
['data' => $this->getDataStructure(\Magento\Sales\Api\Data\OrderItemInterface::class)]
);
$orderPayment = $orderPaymentFactory->create(
['data' => $this->getDataStructure(\Magento\Sales\Api\Data\OrderPaymentInterface::class)]
);
$email = uniqid() . 'email@example.com';
$orderItem->setSku('sku#1');
if (TESTS_WEB_API_ADAPTER == self::ADAPTER_SOAP) {
$orderItem->setData('parent_item', $orderItem->getData() + ['parent_item' => null]);
$orderItem->setAdditionalData('test');
} else {
$orderItem->setData('parent_item', ['weight' => 1]);
}
$orderPayment->setCcLast4('4444');
$orderPayment->setMethod('checkmo');
$orderPayment->setAccountStatus('ok');
$orderPayment->setAdditionalInformation([]);
$order->setCustomerEmail($email);
$order->setBaseGrandTotal(100);
$order->setGrandTotal(100);
$order->setShippingDescription('Flat Rate - Fixed');
$order->setIsVirtual(0);
$order->setStoreId($storeManager->getDefaultStoreView()->getId());
$order->setBaseDiscountAmount(0);
$order->setBaseShippingAmount(5);
$order->setBaseShippingTaxAmount(0);
$order->setBaseSubtotal(100);
$order->setBaseTaxAmount(0);
$order->setBaseToGlobalRate(1);
$order->setBaseToOrderRate(1);
$order->setDiscountAmount(0);
$order->setShippingAmount(0);
$order->setShippingTaxAmount(0);
$order->setStoreToOrderRate(0);
$order->setBaseToOrderRate(0);
$order->setSubtotal(100);
$order->setTaxAmount(0);
$order->setTotalQtyOrdered(1);
$order->setCustomerIsGuest(1);
$order->setCustomerNoteNotify(0);
$order->setCustomerGroupId(0);
$order->setBaseSubtotalInclTax(100);
$order->setWeight(1);
$order->setBaseCurrencyCode('USD');
$order->setShippingInclTax(5);
$order->setBaseShippingInclTax(5);
$this->addProductOption($orderItem);
$order->setItems([$orderItem->getData()]);
$order->setData('payment', $orderPayment->getData());
$orderAddressBilling = $orderAddressRepository->create();
$orderAddressBilling->setCity('City');
$orderAddressBilling->setPostcode('12345');
$orderAddressBilling->setLastname('Last Name');
$orderAddressBilling->setFirstname('First Name');
$orderAddressBilling->setTelephone('+00(000)-123-45-57');
$orderAddressBilling->setStreet(['Street']);
$orderAddressBilling->setCountryId('US');
$orderAddressBilling->setRegion('California');
$orderAddressBilling->setAddressType('billing');
$orderAddressBilling->setRegionId(12);
$orderAddressShipping = $orderAddressRepository->create();
$orderAddressShipping->setCity('City2');
$orderAddressShipping->setPostcode('12345');
$orderAddressShipping->setLastname('Last Name2');
$orderAddressShipping->setFirstname('First Name2');
$orderAddressShipping->setTelephone('+00(000)-123-45-57');
$orderAddressShipping->setStreet(['Street']);
$orderAddressShipping->setCountryId('US');
$orderAddressShipping->setRegion('California');
$orderAddressShipping->setAddressType('shipping');
$orderAddressShipping->setRegionId(12);
$orderData = $order->getData();
$orderData['billing_address'] = $orderAddressBilling->getData();
$orderData['billing_address']['street'] = ['Street'];
$address = $orderAddressShipping->getData();
$address['street'] = ['Street'];
$orderData['extension_attributes']['shipping_assignments'] =
[
[
'shipping' => [
'address' => $address,
'method' => 'flatrate_flatrate'
],
'items' => [$orderItem->getData()],
'stock_id' => null,
]
];
$orderData['extension_attributes']['taxes'] = [
[
'code' => 'US-NY-*-Rate 1',
'title' => 'US-NY-*-Rate 1',
'percent' => 5,
'amount' => 0.75,
'base_amount' => 0.75,
'base_real_amount' => 0.75,
'position' => 0,
'priority' => 0,
'process' => 0
],
];
$orderData['extension_attributes']['additional_itemized_taxes'] = [
[
'tax_percent' => 5,
'tax_code' => 'US-NY-*-Rate 1',
'amount' => 0.25,
'base_amount' => 0.25,
'real_amount' => 0.25,
'real_base_amount' => 0.25,
'taxable_item_type' => 'shipping',
]
];
$orderData['items'][0]['extension_attributes']['itemized_taxes'] = [
[
'tax_percent' => 5,
'tax_code' => 'US-NY-*-Rate 1',
'amount' => 0.5,
'base_amount' => 0.5,
'real_amount' => 0.5,
'real_base_amount' => 0.5,
'taxable_item_type' => 'product',
]
];
return $orderData;
}
protected function getDataStructure($className)
{
$refClass = new \ReflectionClass($className);
$constants = $refClass->getConstants();
$data = array_fill_keys($constants, null);
unset($data['custom_attributes']);
return $data;
}
/**
* @param array $orderItem
* @return void
*/
protected function addProductOption($orderItem)
{
/** @var \Magento\Catalog\Api\ProductRepositoryInterface $productRepository */
$productRepository = $this->objectManager->create(\Magento\Catalog\Api\ProductRepositoryInterface::class);
$product = $productRepository->get('simple');
$options = [];
foreach ($product->getOptions() as $option) {
$options[] = [
'option_id' => $option->getId(),
'option_value' => $this->getOptionRequestValue($option),
];
}
$data['extension_attributes']['custom_options'] = $options;
$orderItem->setData('product_option', $data);
$orderItem->setPrice(10);
$orderItem->setBasePrice(10);
}
/**
* @param ProductCustomOptionInterface $option
* @return null|string
*/
protected function getOptionRequestValue(ProductCustomOptionInterface $option)
{
$returnValue = null;
switch ($option->getType()) {
case 'field':
$returnValue = 'Test value';
break;
case 'date_time':
$returnValue = '2015-09-09 07:16:00';
break;
case 'drop_down':
$returnValue = '3-1-select';
break;
case 'radio':
$returnValue = '4-1-radio';
break;
}
return $returnValue;
}
/**
* @magentoApiDataFixture Magento/Catalog/_files/product_simple.php
*/
public function testOrderCreate()
{
$order = $this->prepareOrder();
$serviceInfo = [
'rest' => [
'resourcePath' => self::RESOURCE_PATH,
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => self::SERVICE_READ_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_READ_NAME . 'save',
],
];
$result = $this->_webApiCall($serviceInfo, ['entity' => $order]);
$getServiceInfo = [
'rest' => [
'resourcePath' => self::RESOURCE_PATH . '/' . $result['entity_id'],
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
],
'soap' => [
'service' => self::SERVICE_READ_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_READ_NAME . 'get',
],
];
$result = $this->_webApiCall($getServiceInfo, ['id' => $result['entity_id']]);
$this->assertEquals(100, $result['base_grand_total']);
$this->assertEquals(100, $result['grand_total']);
$shipping = $result['extension_attributes']['shipping_assignments'][0]['shipping'];
$this->assertGreaterThan(0, $shipping['address']['entity_id']);
$this->assertEquals(['Street'], $shipping['address']['street']);
$this->assertEquals('flatrate_flatrate', $shipping['method']);
$taxes = $result['extension_attributes']['taxes'];
$this->assertCount(1, $taxes);
$this->assertEquals('US-NY-*-Rate 1', $taxes[0]['code']);
$this->assertEquals('US-NY-*-Rate 1', $taxes[0]['title']);
$this->assertEquals(5, $taxes[0]['percent']);
$this->assertEquals(0.75, $taxes[0]['amount']);
$this->assertEquals(0.75, $taxes[0]['base_amount']);
$this->assertCount(1, $result['extension_attributes']['additional_itemized_taxes']);
$shippingTaxItem = $result['extension_attributes']['additional_itemized_taxes'][0];
$this->assertEquals('shipping', $shippingTaxItem['taxable_item_type']);
$this->assertEquals(5, $shippingTaxItem['tax_percent']);
$this->assertEquals(0.25, $shippingTaxItem['amount']);
$this->assertEquals(0.25, $shippingTaxItem['base_amount']);
$this->assertEquals(0.25, $shippingTaxItem['real_amount']);
$this->assertCount(1, $result['items'][0]['extension_attributes']['itemized_taxes']);
$orderItemTaxItem = $result['items'][0]['extension_attributes']['itemized_taxes'][0];
$this->assertEquals('product', $orderItemTaxItem['taxable_item_type']);
$this->assertEquals(5, $orderItemTaxItem['tax_percent']);
$this->assertEquals(0.50, $orderItemTaxItem['amount']);
$this->assertEquals(0.50, $orderItemTaxItem['base_amount']);
$this->assertEquals(0.50, $orderItemTaxItem['real_amount']);
$this->assertEquals($result['items'][0]['item_id'], $orderItemTaxItem['item_id']);
}
}
@@ -0,0 +1,39 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\TestFramework\TestCase\WebapiAbstract;
class OrderEmailTest extends WebapiAbstract
{
const SERVICE_VERSION = 'V1';
const SERVICE_NAME = 'salesOrderManagementV1';
/**
* @magentoApiDataFixture Magento/Sales/_files/order.php
*/
public function testOrderEmail()
{
$order = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()
->create(\Magento\Sales\Model\Order::class);
$order->loadByIncrementId('100000001');
$serviceInfo = [
'rest' => [
'resourcePath' => '/V1/orders/' . $order->getId() . '/emails',
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => self::SERVICE_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_NAME . 'notify',
],
];
$requestData = ['id' => $order->getId()];
$this->assertTrue($this->_webApiCall($serviceInfo, $requestData));
}
}
@@ -0,0 +1,57 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\TestFramework\TestCase\WebapiAbstract;
/**
* Class OrderGetStatusTest
* @package Magento\Sales\Service\V1
*/
class OrderGetStatusTest extends WebapiAbstract
{
const RESOURCE_PATH = '/V1/orders/%d/statuses';
const SERVICE_READ_NAME = 'salesOrderManagementV1';
const SERVICE_VERSION = 'V1';
const ORDER_INCREMENT_ID = '100000001';
/**
* @var \Magento\Framework\ObjectManagerInterface
*/
protected $objectManager;
protected function setUp(): void
{
$this->objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
}
/**
* @magentoApiDataFixture Magento/Sales/_files/order.php
*/
public function testOrderGetStatus()
{
/** @var \Magento\Sales\Model\Order $order */
$order = $this->objectManager->create(\Magento\Sales\Model\Order::class);
$order->loadByIncrementId(self::ORDER_INCREMENT_ID);
$serviceInfo = [
'rest' => [
'resourcePath' => sprintf(self::RESOURCE_PATH, $order->getId()),
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
],
'soap' => [
'service' => self::SERVICE_READ_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_READ_NAME . 'getStatus',
],
];
$this->assertEquals($order->getStatus(), $this->_webApiCall($serviceInfo, ['id' => $order->getId()]));
}
}
@@ -0,0 +1,232 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Magento\Sales\Service\V1;
use Magento\Framework\ObjectManagerInterface;
use Magento\Framework\Webapi\Rest\Request;
use Magento\Sales\Api\Data\OrderInterface;
use Magento\Sales\Model\Order;
use Magento\TestFramework\Helper\Bootstrap;
use Magento\TestFramework\TestCase\WebapiAbstract;
class OrderGetTest extends WebapiAbstract
{
private const RESOURCE_PATH = '/V1/orders';
private const SERVICE_READ_NAME = 'salesOrderRepositoryV1';
private const SERVICE_VERSION = 'V1';
private const ORDER_INCREMENT_ID = '100000001';
/**
* @var ObjectManagerInterface
*/
private $objectManager;
/**
* @inheritdoc
*/
protected function setUp(): void
{
$this->objectManager = Bootstrap::getObjectManager();
}
/**
* Checks order attributes.
*
* @magentoApiDataFixture Magento/Sales/_files/order.php
*/
public function testOrderGet(): void
{
$expectedOrderData = [
'base_subtotal' => '100.0000',
'subtotal' => '100.0000',
'customer_is_guest' => '1',
'increment_id' => self::ORDER_INCREMENT_ID,
];
$expectedPayments = [
'method' => 'checkmo',
'additional_information' => [
0 => '11122', // last transaction id
// metadata
1 => json_encode([
'type' => 'free',
'fraudulent' => false
])
]
];
$expectedBillingAddressNotEmpty = [
'city',
'postcode',
'lastname',
'street',
'region',
'telephone',
'country_id',
'firstname',
];
$expectedShippingAddress = [
'address_type' => 'shipping',
'city' => 'Los Angeles',
'email' => 'customer@example.com',
'postcode' => '11111',
'region' => 'CA'
];
$result = $this->makeServiceCall(self::ORDER_INCREMENT_ID);
foreach ($expectedOrderData as $field => $value) {
self::assertArrayHasKey($field, $result);
self::assertEquals($value, $result[$field]);
}
self::assertArrayHasKey('payment', $result);
foreach ($expectedPayments as $field => $value) {
self::assertEquals($value, $result['payment'][$field]);
}
self::assertArrayHasKey('billing_address', $result);
foreach ($expectedBillingAddressNotEmpty as $field) {
self::assertArrayHasKey($field, $result['billing_address']);
}
self::assertArrayHasKey('extension_attributes', $result);
self::assertArrayHasKey('shipping_assignments', $result['extension_attributes']);
$shippingAssignments = $result['extension_attributes']['shipping_assignments'];
self::assertCount(1, $shippingAssignments);
$shippingAddress = $shippingAssignments[0]['shipping']['address'];
foreach ($expectedShippingAddress as $key => $value) {
self::assertArrayHasKey($key, $shippingAddress);
self::assertEquals($value, $shippingAddress[$key]);
}
//check that nullable fields were marked as optional and were not sent
foreach ($result as $value) {
self::assertNotNull($value);
}
}
/**
* Checks order extension attributes.
*
* @magentoApiDataFixture Magento/Sales/_files/order_with_tax.php
*/
public function testOrderGetExtensionAttributes(): void
{
$expectedTax = [
'code' => 'US-NY-*-Rate 1',
'type' => 'shipping'
];
$result = $this->makeServiceCall(self::ORDER_INCREMENT_ID);
$appliedTaxes = $result['extension_attributes']['applied_taxes'];
self::assertEquals($expectedTax['code'], $appliedTaxes[0]['code']);
$appliedTaxes = $result['extension_attributes']['item_applied_taxes'];
self::assertEquals($expectedTax['type'], $appliedTaxes[0]['type']);
self::assertNotEmpty($appliedTaxes[0]['applied_taxes']);
self::assertFalse($result['extension_attributes']['converting_from_quote']);
self::assertArrayHasKey('payment_additional_info', $result['extension_attributes']);
self::assertNotEmpty($result['extension_attributes']['payment_additional_info']);
$taxes = $result['extension_attributes']['taxes'];
$this->assertCount(1, $taxes);
$this->assertEquals('US-NY-*-Rate 1', $taxes[0]['code']);
$this->assertEquals(8.37, $taxes[0]['percent']);
$this->assertCount(1, $result['extension_attributes']['additional_itemized_taxes']);
$shippingTaxItem = $result['extension_attributes']['additional_itemized_taxes'][0];
$this->assertEquals(8.37, $shippingTaxItem['tax_percent']);
$this->assertEquals(45, $shippingTaxItem['amount']);
$this->assertEquals(45, $shippingTaxItem['base_amount']);
$this->assertEquals(45, $shippingTaxItem['real_amount']);
$this->assertEquals('shipping', $shippingTaxItem['taxable_item_type']);
$this->assertEquals('US-NY-*-Rate 1', $shippingTaxItem['tax_code']);
}
/**
* Checks if the order contains product option attributes.
*
* @magentoApiDataFixture Magento/Sales/_files/order_with_bundle.php
*/
public function testGetOrderWithProductOption(): void
{
$expected = [
'extension_attributes' => [
'bundle_options' => [
[
'option_id' => 1,
'option_selections' => [1],
'option_qty' => 1
]
]
]
];
$result = $this->makeServiceCall(self::ORDER_INCREMENT_ID);
$bundleProduct = $this->getBundleProduct($result['items']);
self::assertNotEmpty($bundleProduct, '"Bundle Product" should not be empty.');
self::assertNotEmpty($bundleProduct['product_option'], '"Product Option" should not be empty.');
self::assertEquals($expected, $bundleProduct['product_option']);
}
/**
* Gets order by increment ID.
*
* @param string $incrementId
* @return OrderInterface
*/
private function getOrder(string $incrementId): OrderInterface
{
/** @var Order $order */
$order = $this->objectManager->create(Order::class);
$order->loadByIncrementId($incrementId);
return $order;
}
/**
* Makes service call.
*
* @param string $incrementId
* @return array
*/
private function makeServiceCall(string $incrementId): array
{
$order = $this->getOrder($incrementId);
$serviceInfo = [
'rest' => [
'resourcePath' => self::RESOURCE_PATH . '/' . $order->getId(),
'httpMethod' => Request::HTTP_METHOD_GET,
],
'soap' => [
'service' => self::SERVICE_READ_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_READ_NAME . 'get',
],
];
return $this->_webApiCall($serviceInfo, ['id' => $order->getId()]);
}
/**
* Gets a bundle product from the result.
*
* @param array $items
* @return array
*/
private function getBundleProduct(array $items): array
{
foreach ($items as $item) {
if ($item['product_type'] == 'bundle') {
return $item;
}
}
return [];
}
}
@@ -0,0 +1,97 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Magento\Sales\Service\V1;
use Magento\Framework\ObjectManagerInterface;
use Magento\Framework\Webapi\Rest\Request;
use Magento\Sales\Api\Data\OrderInterface;
use Magento\Sales\Api\OrderRepositoryInterface;
use Magento\Sales\Model\Order;
use Magento\TestFramework\Helper\Bootstrap;
use Magento\TestFramework\TestCase\WebapiAbstract;
/**
* Test for hold order.
*/
class OrderHoldTest extends WebapiAbstract
{
private const SERVICE_VERSION = 'V1';
private const SERVICE_NAME = 'salesOrderManagementV1';
/**
* @var ObjectManagerInterface
*/
private $objectManager;
/**
* @var OrderRepositoryInterface
*/
private $orderRepository;
/**
* @inheritDoc
*/
protected function setUp(): void
{
$this->objectManager = Bootstrap::getObjectManager();
$this->orderRepository = $this->objectManager->get(OrderRepositoryInterface::class);
}
/**
* Test hold order and check order items product options after.
*
* @magentoApiDataFixture Magento/Sales/_files/order_with_two_configurable_variations.php
*
* @return void
*/
public function testOrderHold(): void
{
$order = $this->objectManager->get(Order::class)
->loadByIncrementId('100000001');
$orderId = $order->getId();
$orderItemsProductOptions = $this->getOrderItemsProductOptions($order);
$serviceInfo = [
'rest' => [
'resourcePath' => '/V1/orders/' . $orderId . '/hold',
'httpMethod' => Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => self::SERVICE_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_NAME . 'hold',
],
];
$requestData = ['id' => $orderId];
$result = $this->_webApiCall($serviceInfo, $requestData);
$this->assertTrue($result);
$this->assertEquals(
$orderItemsProductOptions,
$this->getOrderItemsProductOptions($this->orderRepository->get($orderId))
);
}
/**
* Return order items product options
*
* @param OrderInterface $order
* @return array
*/
private function getOrderItemsProductOptions(OrderInterface $order): array
{
$result = [];
foreach ($order->getItems() as $orderItem) {
$result[] = $orderItem->getProductOptions();
}
return $result;
}
}
@@ -0,0 +1,193 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
/**
* API test for creation of Invoice for certain Order.
*/
class OrderInvoiceCreateTest extends \Magento\TestFramework\TestCase\WebapiAbstract
{
const SERVICE_READ_NAME = 'salesInvoiceOrderV1';
const SERVICE_VERSION = 'V1';
/**
* @var \Magento\Framework\ObjectManagerInterface
*/
private $objectManager;
/**
* @var \Magento\Sales\Api\InvoiceRepositoryInterface
*/
private $invoiceRepository;
protected function setUp(): void
{
$this->objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
$this->invoiceRepository = $this->objectManager->get(
\Magento\Sales\Api\InvoiceRepositoryInterface::class
);
}
/**
* @magentoApiDataFixture Magento/Sales/_files/order_new.php
*/
public function testInvoiceCreate()
{
/** @var \Magento\Sales\Model\Order $existingOrder */
$existingOrder = $this->objectManager->create(\Magento\Sales\Model\Order::class)
->loadByIncrementId('100000001');
$serviceInfo = [
'rest' => [
'resourcePath' => '/V1/order/' . $existingOrder->getId() . '/invoice',
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => self::SERVICE_READ_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_READ_NAME . 'execute',
],
];
$requestData = [
'orderId' => $existingOrder->getId(),
'items' => [],
'comment' => [
'comment' => 'Test Comment',
'is_visible_on_front' => 1,
],
];
/** @var \Magento\Sales\Api\Data\OrderItemInterface $item */
foreach ($existingOrder->getAllItems() as $item) {
$requestData['items'][] = [
'order_item_id' => $item->getItemId(),
'qty' => $item->getQtyOrdered(),
];
}
$result = $this->_webApiCall($serviceInfo, $requestData);
$this->assertNotEmpty($result);
try {
$this->invoiceRepository->get($result);
} catch (\Magento\Framework\Exception\NoSuchEntityException $e) {
$this->fail('Failed asserting that Invoice was created');
}
/** @var \Magento\Sales\Model\Order $updatedOrder */
$updatedOrder = $this->objectManager->create(\Magento\Sales\Model\Order::class)
->loadByIncrementId('100000001');
$this->assertNotEquals(
$existingOrder->getStatus(),
$updatedOrder->getStatus(),
'Failed asserting that Order status was changed'
);
}
/**
* Tests that MAGETWO-95346 was fixed for bundled products
*
* @codingStandardsIgnoreStart
* @codingStandardsIgnoreEnd
* @magentoApiDataFixture Magento/Sales/_files/order_with_bundle.php
*/
public function testOrderWithBundleInvoicedWithInvalidQuantitiesReturnsError()
{
$this->expectException(\Exception::class);
$this->expectExceptionMessageMatches(
'/Invoice Document Validation Error\\(s\\):(?:\\n|\\\\n)'
. 'The invoice can\'t be created without products. Add products and try again./'
);
/** @var \Magento\Sales\Model\Order $existingOrder */
$existingOrder = $this->objectManager->create(\Magento\Sales\Model\Order::class)
->loadByIncrementId('100000001');
$serviceInfo = [
'rest' => [
'resourcePath' => '/V1/order/' . $existingOrder->getId() . '/invoice',
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => self::SERVICE_READ_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_READ_NAME . 'execute',
],
];
$requestData = [
'orderId' => $existingOrder->getId(),
'notify' => true,
'appendComment' => true,
'items' => [
[
'order_item_id' => -1,
'qty' => 1
]
],
'comment' => [
'comment' => 'Test offline',
'isVisibleOnFront' => 1,
],
];
$this->_webApiCall($serviceInfo, $requestData);
}
/**
* Tests that MAGETWO-95346 was fixed for configurable products
*
* @codingStandardsIgnoreStart
* @codingStandardsIgnoreEnd
* @magentoApiDataFixture Magento/Sales/_files/order_configurable_product.php
*/
public function testOrderWithConfigurableProductInvoicedWithInvalidQuantitiesReturnsError()
{
$this->expectException(\Exception::class);
$this->expectExceptionMessageMatches(
'/Invoice Document Validation Error\\(s\\):(?:\\n|\\\\n)'
. 'The invoice can\'t be created without products. Add products and try again./'
);
/** @var \Magento\Sales\Model\Order $existingOrder */
$existingOrder = $this->objectManager->create(\Magento\Sales\Model\Order::class)
->loadByIncrementId('100000001');
$serviceInfo = [
'rest' => [
'resourcePath' => '/V1/order/' . $existingOrder->getId() . '/invoice',
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => self::SERVICE_READ_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_READ_NAME . 'execute',
],
];
$requestData = [
'orderId' => $existingOrder->getId(),
'notify' => true,
'appendComment' => true,
'items' => [
[
'order_item_id' => -1,
'qty' => 1
]
],
'comment' => [
'comment' => 'Test offline',
'isVisibleOnFront' => 1,
],
];
$this->_webApiCall($serviceInfo, $requestData);
}
}
@@ -0,0 +1,108 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\TestFramework\TestCase\WebapiAbstract;
class OrderItemGetListTest extends WebapiAbstract
{
const RESOURCE_PATH = '/V1/orders/items';
const SERVICE_VERSION = 'V1';
const SERVICE_NAME = 'salesOrderItemRepositoryV1';
const ORDER_INCREMENT_ID = '100000001';
/**
* @var \Magento\TestFramework\ObjectManager
*/
protected $objectManager;
protected function setUp(): void
{
$this->objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
}
/**
* @magentoApiDataFixture Magento/Sales/_files/order_item_list.php
*/
public function testGetList()
{
$expectedRowTotals = [112, 102, 92];
/** @var \Magento\Framework\Api\SortOrderBuilder $sortOrderBuilder */
$sortOrderBuilder = $this->objectManager->get(
\Magento\Framework\Api\SortOrderBuilder::class
);
/** @var \Magento\Sales\Model\Order $order */
$order = $this->objectManager->create(\Magento\Sales\Model\Order::class);
$order->loadByIncrementId(self::ORDER_INCREMENT_ID);
/** @var $searchCriteriaBuilder \Magento\Framework\Api\SearchCriteriaBuilder */
$searchCriteriaBuilder = $this->objectManager->create(\Magento\Framework\Api\SearchCriteriaBuilder::class);
/** @var $filterBuilder \Magento\Framework\Api\FilterBuilder */
$filterBuilder = $this->objectManager->create(\Magento\Framework\Api\FilterBuilder::class);
$filter2 = $filterBuilder->setField('product_type')
->setValue('configurable')
->create();
$filter3 = $filterBuilder->setField('base_price')
->setValue(110)
->setConditionType('gteq')
->create();
$filter4 = $filterBuilder->setField('product_type')
->setValue('simple')
->setConditionType('neq')
->create();
$sortOrder = $sortOrderBuilder->setField('row_total')
->setDirection('DESC')
->create();
$searchCriteriaBuilder->addFilters([$filter4]);
$searchCriteriaBuilder->addFilters([$filter2, $filter3]);
$searchCriteriaBuilder->addSortOrder($sortOrder);
$requestData = ['searchCriteria' => $searchCriteriaBuilder->create()->__toArray()];
$serviceInfo = [
'rest' => [
'resourcePath' => self::RESOURCE_PATH . '?' . http_build_query($requestData),
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
],
'soap' => [
'service' => self::SERVICE_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_NAME . 'getList',
],
];
$response = $this->_webApiCall($serviceInfo, $requestData);
$this->assertIsArray($response);
$this->assertArrayHasKey('items', $response);
$this->assertCount(3, $response['items']);
$this->assertIsArray($response['items'][0]);
$rowTotals = [];
foreach ($response['items'] as $item) {
$rowTotals[] = $item['row_total'];
}
$this->assertEquals($expectedRowTotals, $rowTotals);
}
/**
* @param \Magento\Sales\Model\Order\Item $orderItem
* @param array $response
* @return void
*/
protected function assertOrderItem(\Magento\Sales\Model\Order\Item $orderItem, array $response)
{
$this->assertEquals($orderItem->getId(), $response['item_id']);
$this->assertEquals($orderItem->getOrderId(), $response['order_id']);
$this->assertEquals($orderItem->getProductId(), $response['product_id']);
$this->assertEquals($orderItem->getProductType(), $response['product_type']);
$this->assertEquals($orderItem->getBasePrice(), $response['base_price']);
$this->assertEquals($orderItem->getRowTotal(), $response['row_total']);
}
}
@@ -0,0 +1,112 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\TestFramework\TestCase\WebapiAbstract;
class OrderItemGetTest extends WebapiAbstract
{
const RESOURCE_PATH = '/V1/orders/items';
const SERVICE_VERSION = 'V1';
const SERVICE_NAME = 'salesOrderItemRepositoryV1';
const ORDER_INCREMENT_ID = '100000001';
/**
* @var \Magento\TestFramework\ObjectManager
*/
protected $objectManager;
protected function setUp(): void
{
$this->objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
}
/**
* @magentoApiDataFixture Magento/Sales/_files/order.php
*/
public function testGet()
{
/** @var \Magento\Sales\Model\Order $order */
$order = $this->objectManager->create(\Magento\Sales\Model\Order::class);
$order->loadByIncrementId(self::ORDER_INCREMENT_ID);
/** @var \Magento\Sales\Model\Order\Item $orderItem */
$orderItem = current($order->getItems());
$serviceInfo = [
'rest' => [
'resourcePath' => self::RESOURCE_PATH . '/' . $orderItem->getId(),
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
],
'soap' => [
'service' => self::SERVICE_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_NAME . 'get',
],
];
$response = $this->_webApiCall($serviceInfo, ['id' => $orderItem->getId()]);
$this->assertIsArray($response);
$this->assertOrderItem($orderItem, $response);
//check that nullable fields were marked as optional and were not sent
foreach ($response as $fieldName => $value) {
if ($fieldName == 'sku') {
continue;
}
$this->assertNotNull($value);
}
}
/**
* @param \Magento\Sales\Model\Order\Item $orderItem
* @param array $response
* @return void
*/
protected function assertOrderItem(\Magento\Sales\Model\Order\Item $orderItem, array $response)
{
$this->assertEquals($orderItem->getId(), $response['item_id']);
$this->assertEquals($orderItem->getOrderId(), $response['order_id']);
$this->assertEquals($orderItem->getProductId(), $response['product_id']);
$this->assertEquals($orderItem->getProductType(), $response['product_type']);
$this->assertEquals($orderItem->getBasePrice(), $response['base_price']);
$this->assertEquals($orderItem->getRowTotal(), $response['row_total']);
}
/**
* @magentoApiDataFixture Magento/Sales/_files/order_with_discount.php
*/
public function testGetOrderWithDiscount()
{
/** @var \Magento\Sales\Model\Order $order */
$order = $this->objectManager->create(\Magento\Sales\Model\Order::class);
$order->loadByIncrementId(self::ORDER_INCREMENT_ID);
/** @var \Magento\Sales\Model\Order\Item $orderItem */
$orderItem = current($order->getItems());
$serviceInfo = [
'rest' => [
'resourcePath' => self::RESOURCE_PATH . '/' . $orderItem->getId(),
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
],
'soap' => [
'service' => self::SERVICE_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_NAME . 'get',
],
];
$response = $this->_webApiCall($serviceInfo, ['id' => $orderItem->getId()]);
$this->assertIsArray($response);
$this->assertEquals(8.00, $response['row_total']);
$this->assertEquals(8.00, $response['base_row_total']);
$this->assertEquals(9.00, $response['row_total_incl_tax']);
$this->assertEquals(9.00, $response['base_row_total_incl_tax']);
}
}
@@ -0,0 +1,151 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\TestFramework\TestCase\WebapiAbstract;
class OrderListTest extends WebapiAbstract
{
private const RESOURCE_PATH = '/V1/orders';
private const SERVICE_READ_NAME = 'salesOrderRepositoryV1';
private const SERVICE_VERSION = 'V1';
/**
* @var \Magento\Framework\ObjectManagerInterface
*/
protected $objectManager;
protected function setUp(): void
{
$this->objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
}
/**
* @magentoApiDataFixture Magento/Sales/_files/order_list.php
*/
public function testOrderList()
{
$searchData = $this->getSearchData();
$requestData = ['searchCriteria' => $searchData];
$serviceInfo = [
'rest' => [
'resourcePath' => self::RESOURCE_PATH . '?' . http_build_query($requestData),
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
],
'soap' => [
'service' => self::SERVICE_READ_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_READ_NAME . 'getList',
],
];
$result = $this->_webApiCall($serviceInfo, $requestData);
$this->assertArrayHasKey('items', $result);
$this->assertCount(2, $result['items']);
$this->assertArrayHasKey('search_criteria', $result);
$this->assertEquals($searchData, $result['search_criteria']);
$this->assertEquals('100000002', $result['items'][0]['increment_id']);
$this->assertEquals('100000001', $result['items'][1]['increment_id']);
}
/**
* @magentoApiDataFixture Magento/Sales/_files/order_list_with_tax.php
*/
public function testOrderListExtensionAttributes()
{
$searchData = $this->getSearchData();
$requestData = ['searchCriteria' => $searchData];
$serviceInfo = [
'rest' => [
'resourcePath' => self::RESOURCE_PATH . '?' . http_build_query($requestData),
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
],
'soap' => [
'service' => self::SERVICE_READ_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_READ_NAME . 'getList',
],
];
$result = $this->_webApiCall($serviceInfo, $requestData);
$expectedTax = [
'code' => 'US-NY-*-Rate 1',
'type' => 'shipping'
];
$appliedTaxes = $result['items'][0]['extension_attributes']['applied_taxes'];
$this->assertEquals($expectedTax['code'], $appliedTaxes[0]['code']);
$appliedTaxes = $result['items'][0]['extension_attributes']['item_applied_taxes'];
$this->assertEquals($expectedTax['type'], $appliedTaxes[0]['type']);
$this->assertNotEmpty($appliedTaxes[0]['applied_taxes']);
$this->assertFalse($result['items'][0]['extension_attributes']['converting_from_quote']);
$this->assertArrayHasKey('payment_additional_info', $result['items'][0]['extension_attributes']);
$this->assertNotEmpty($result['items'][0]['extension_attributes']['payment_additional_info']);
$taxes = $result['items'][0]['extension_attributes']['taxes'];
$this->assertCount(1, $taxes);
$this->assertEquals('US-NY-*-Rate 1', $taxes[0]['code']);
$this->assertEquals(8.37, $taxes[0]['percent']);
$this->assertCount(1, $result['items'][0]['extension_attributes']['additional_itemized_taxes']);
$shippingTaxItem = $result['items'][0]['extension_attributes']['additional_itemized_taxes'][0];
$this->assertEquals(8.37, $shippingTaxItem['tax_percent']);
$this->assertEquals(45, $shippingTaxItem['amount']);
$this->assertEquals(45, $shippingTaxItem['base_amount']);
$this->assertEquals(45, $shippingTaxItem['real_amount']);
$this->assertEquals('shipping', $shippingTaxItem['taxable_item_type']);
$this->assertEquals('US-NY-*-Rate 1', $shippingTaxItem['tax_code']);
}
/**
* Get search data for request.
*
* @return array
*/
private function getSearchData() : array
{
/** @var \Magento\Framework\Api\SortOrderBuilder $sortOrderBuilder */
$sortOrderBuilder = $this->objectManager->get(
\Magento\Framework\Api\SortOrderBuilder::class
);
/** @var $searchCriteriaBuilder \Magento\Framework\Api\SearchCriteriaBuilder */
$searchCriteriaBuilder = $this->objectManager->create(
\Magento\Framework\Api\SearchCriteriaBuilder::class
);
/** @var $filterBuilder \Magento\Framework\Api\FilterBuilder */
$filterBuilder = $this->objectManager->create(
\Magento\Framework\Api\FilterBuilder::class
);
$filter1 = $filterBuilder
->setField('status')
->setValue('processing')
->setConditionType('eq')
->create();
$filter2 = $filterBuilder
->setField('state')
->setValue(\Magento\Sales\Model\Order::STATE_NEW)
->setConditionType('eq')
->create();
$filter3 = $filterBuilder
->setField('increment_id')
->setValue('100000001')
->setConditionType('eq')
->create();
$sortOrder = $sortOrderBuilder->setField('grand_total')
->setDirection('DESC')
->create();
$searchCriteriaBuilder->addFilters([$filter1]);
$searchCriteriaBuilder->addFilters([$filter2, $filter3]);
$searchCriteriaBuilder->addSortOrder($sortOrder);
$searchCriteriaBuilder->setPageSize(20);
$searchData = $searchCriteriaBuilder->create()->__toArray();
return $searchData;
}
}
@@ -0,0 +1,96 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\Sales\Api\Data\OrderStatusHistoryInterface;
use Magento\TestFramework\TestCase\WebapiAbstract;
/**
* Class OrderCommentAddTest
*
* @package Magento\Sales\Service\V1
*/
class OrderStatusHistoryAddTest extends WebapiAbstract
{
const SERVICE_READ_NAME = 'salesOrderManagementV1';
const SERVICE_VERSION = 'V1';
const ORDER_INCREMENT_ID = '100000001';
/**
* @var \Magento\Framework\ObjectManagerInterface
*/
protected $objectManager;
protected function setUp(): void
{
$this->objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
}
/**
* @magentoApiDataFixture Magento/Sales/_files/order.php
* @SuppressWarnings(PHPMD.UnusedLocalVariable)
*/
public function testOrderCommentAdd()
{
/** @var \Magento\Sales\Model\Order $order */
$order = $this->objectManager->create(\Magento\Sales\Model\Order::class);
$order->loadByIncrementId(self::ORDER_INCREMENT_ID);
$commentData = [
OrderStatusHistoryInterface::COMMENT => 'Hello',
OrderStatusHistoryInterface::ENTITY_ID => null,
OrderStatusHistoryInterface::IS_CUSTOMER_NOTIFIED => 1,
OrderStatusHistoryInterface::CREATED_AT => null,
OrderStatusHistoryInterface::PARENT_ID => $order->getId(),
OrderStatusHistoryInterface::ENTITY_NAME => null,
OrderStatusHistoryInterface::STATUS => $order->getStatus(),
OrderStatusHistoryInterface::IS_VISIBLE_ON_FRONT => 1,
];
$requestData = ['id' => $order->getId(), 'statusHistory' => $commentData];
$serviceInfo = [
'rest' => [
'resourcePath' => '/V1/orders/' . $order->getId() . '/comments',
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => self::SERVICE_READ_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_READ_NAME . 'addComment',
],
];
$this->_webApiCall($serviceInfo, $requestData);
//Verification
$comments = $order->load($order->getId())->getAllStatusHistory();
$comment = reset($comments);
$this->assertEquals(
$commentData[OrderStatusHistoryInterface::COMMENT],
$comment->getComment()
);
$this->assertEquals(
$commentData[OrderStatusHistoryInterface::PARENT_ID],
$comment->getParentId()
);
$this->assertEquals(
$commentData[OrderStatusHistoryInterface::IS_CUSTOMER_NOTIFIED],
$comment->getIsCustomerNotified()
);
$this->assertEquals(
$commentData[OrderStatusHistoryInterface::IS_VISIBLE_ON_FRONT],
$comment->getIsVisibleOnFront()
);
$this->assertEquals(
$commentData[OrderStatusHistoryInterface::STATUS],
$comment->getStatus()
);
}
}
@@ -0,0 +1,43 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\TestFramework\TestCase\WebapiAbstract;
class OrderUnHoldTest extends WebapiAbstract
{
const SERVICE_VERSION = 'V1';
const SERVICE_NAME = 'salesOrderManagementV1';
/**
* @magentoApiDataFixture Magento/Sales/_files/order.php
*/
public function testOrderUnHold()
{
$objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
/** @var \Magento\Sales\Model\Order $order */
$order = $objectManager->get(\Magento\Sales\Model\Order::class)->loadByIncrementId('100000001');
if ($order->canHold()) {
$order->hold()->save();
}
$serviceInfo = [
'rest' => [
'resourcePath' => '/V1/orders/' . $order->getId() . '/unhold',
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => self::SERVICE_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_NAME . 'unHold',
],
];
$requestData = ['id' => $order->getId()];
$result = $this->_webApiCall($serviceInfo, $requestData);
$this->assertTrue($result);
}
}
@@ -0,0 +1,542 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Magento\Sales\Service\V1;
use Magento\Sales\Model\Order;
use Magento\TestFramework\TestCase\WebapiAbstract;
use Magento\Sales\Api\Data\OrderInterface;
/**
* Test order updating via webapi
*/
class OrderUpdateTest extends WebapiAbstract
{
private const RESOURCE_PATH = '/V1/orders';
private const SERVICE_NAME = 'salesOrderRepositoryV1';
private const SERVICE_VERSION = 'V1';
private const ORDER_INCREMENT_ID = '100000001';
/**
* @var \Magento\Framework\ObjectManagerInterface
*/
private $objectManager;
/**
* @inheritDoc
*/
protected function setUp(): void
{
$this->objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
}
/**
* Check order increment id after updating via webapi
*
* @magentoApiDataFixture Magento/Sales/_files/order.php
*/
public function testOrderUpdate()
{
/** @var Order $order */
$order = $this->objectManager->get(Order::class)->loadByIncrementId(self::ORDER_INCREMENT_ID);
$serviceInfo = [
'rest' => [
'resourcePath' => self::RESOURCE_PATH,
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => self::SERVICE_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_NAME . 'save',
],
];
$result = $this->_webApiCall($serviceInfo, ['entity' => $this->getOrderData($order)]);
$this->assertGreaterThan(1, count($result));
/** @var Order $actualOrder */
$actualOrder = $this->objectManager->get(Order::class)->load($order->getId());
$this->assertEquals(
$order->getData(OrderInterface::INCREMENT_ID),
$actualOrder->getData(OrderInterface::INCREMENT_ID)
);
//Ship the order and check increment id.
$serviceInfo = [
'rest' => [
'resourcePath' => '/V1/order/' . $order->getId() . '/ship',
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => 'salesShipOrderV1',
'serviceVersion' => self::SERVICE_VERSION,
'operation' => 'salesShipOrderV1' . 'execute',
],
];
$shipmentId = $this->_webApiCall($serviceInfo, $this->getDataForShipment($order));
$this->assertNotEmpty($shipmentId);
$actualOrder = $this->objectManager->get(Order::class)->load($order->getId());
$this->assertEquals(
$order->getData(OrderInterface::INCREMENT_ID),
$actualOrder->getData(OrderInterface::INCREMENT_ID)
);
//Invoice the order and check increment id.
$serviceInfo = [
'rest' => [
'resourcePath' => '/V1/invoices',
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => 'salesInvoiceRepositoryV1',
'serviceVersion' => self::SERVICE_VERSION,
'operation' => 'salesInvoiceRepositoryV1' . 'save',
],
];
$result = $this->_webApiCall($serviceInfo, ['entity' => $this->getDataForInvoice($order)]);
$this->assertNotEmpty($result);
$actualOrder = $this->objectManager->get(Order::class)->load($order->getId());
$this->assertEquals(
$order->getData(OrderInterface::INCREMENT_ID),
$actualOrder->getData(OrderInterface::INCREMENT_ID)
);
//Create creditmemo for the order and check increment id.
$serviceInfo = [
'rest' => [
'resourcePath' => '/V1/creditmemo',
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => 'salesCreditmemoRepositoryV1',
'serviceVersion' => self::SERVICE_VERSION,
'operation' => 'salesCreditmemoRepositoryV1' . 'save',
],
];
$result = $this->_webApiCall($serviceInfo, ['entity' => $this->getDataForCreditmemo($order)]);
$this->assertNotEmpty($result);
$actualOrder = $this->objectManager->get(Order::class)->load($order->getId());
$this->assertEquals(
$order->getData(OrderInterface::INCREMENT_ID),
$actualOrder->getData(OrderInterface::INCREMENT_ID)
);
}
/**
* Check order increment id after updating via webapi
*
* @magentoApiDataFixture Magento/Sales/_files/order.php
*/
public function testOrderStatusUpdate()
{
/** @var Order $order */
$order = $this->objectManager->get(Order::class)
->loadByIncrementId(self::ORDER_INCREMENT_ID);
$entityData = $this->getOrderData($order);
$entityData[OrderInterface::STATE] = 'complete';
$entityData[OrderInterface::STATUS] = 'complete';
$requestData = ['entity' => $entityData];
$serviceInfo = [
'rest' => [
'resourcePath' => '/V1/orders',
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => self::SERVICE_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_NAME . 'save',
],
];
$result = $this->_webApiCall($serviceInfo, $requestData);
$this->assertGreaterThan(1, count($result));
/** @var Order $actualOrder */
$actualOrder = $this->objectManager->get(Order::class)->load($order->getId());
$this->assertEquals(
$order->getData(OrderInterface::INCREMENT_ID),
$actualOrder->getData(OrderInterface::INCREMENT_ID)
);
}
/**
* Check order increment id after updating via webapi
*
* @magentoApiDataFixture Magento/Sales/_files/order.php
*/
public function testOrderNoAttributesProvidedUpdate()
{
/** @var Order $order */
$order = $this->objectManager->get(Order::class)
->loadByIncrementId(self::ORDER_INCREMENT_ID);
$entityData = $this->getOrderData($order);
if (TESTS_WEB_API_ADAPTER == self::ADAPTER_SOAP) {
$this->markTestSkipped("Soap calls are more strict and contains attributes.");
return;
}
$requestData = ['entity' => ['entity_id' => $entityData['entity_id']]];
$serviceInfo = [
'rest' => [
'resourcePath' => '/V1/orders',
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => self::SERVICE_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_NAME . 'save',
],
];
$result = $this->_webApiCall($serviceInfo, $requestData);
$this->assertGreaterThan(1, count($result));
/** @var Order $actualOrder */
$actualOrder = $this->objectManager->get(Order::class)->load($order->getId());
$this->assertEquals(
$order->getData(OrderInterface::INCREMENT_ID),
$actualOrder->getData(OrderInterface::INCREMENT_ID)
);
}
/**
* Check that changes to taxes extension attribute are saved
*
* @magentoApiDataFixture Magento/Sales/_files/order_with_tax.php
*/
public function testUpdateTaxesExtensionAttributes()
{
/** @var Order $order */
$order = $this->objectManager->get(Order::class)
->loadByIncrementId(self::ORDER_INCREMENT_ID);
$getServiceInfo = [
'rest' => [
'resourcePath' => self::RESOURCE_PATH . '/' . $order->getEntityId(),
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
],
'soap' => [
'service' => self::SERVICE_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_NAME . 'get',
],
];
$postServiceInfo = [
'rest' => [
'resourcePath' => '/V1/orders',
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => self::SERVICE_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_NAME . 'save',
],
];
$data = $this->_webApiCall($getServiceInfo, ['id' => $order->getEntityId()]);
$data['extension_attributes']['taxes'][0]['code'] = 'US-NY-*-Rate';
$data['extension_attributes']['taxes'][0]['percent'] = 5;
$data['extension_attributes']['additional_itemized_taxes'][0]['tax_percent'] = 5;
$data['extension_attributes']['additional_itemized_taxes'][0]['amount'] = 0.25;
$data['extension_attributes']['additional_itemized_taxes'][0]['base_amount'] = 0.25;
$data['extension_attributes']['additional_itemized_taxes'][0]['real_amount'] = 0.25;
$data['items'][0]['extension_attributes']['itemized_taxes'] = [
[
'tax_percent' => 5,
'tax_code' => 'US-NY-*-Rate',
'amount' => 0.5,
'base_amount' => 0.5,
'real_amount' => 0.5,
'real_base_amount' => 0.5,
'taxable_item_type' => 'product',
]
];
$this->_webApiCall($postServiceInfo, ['entity' => $data]);
$result = $this->_webApiCall($getServiceInfo, ['id' => $order->getEntityId()]);
$taxes = $result['extension_attributes']['taxes'];
$this->assertCount(1, $taxes);
$this->assertEquals('US-NY-*-Rate', $taxes[0]['code']);
$this->assertEquals(5, $taxes[0]['percent']);
// check that amount is not automatically calculated
$this->assertEquals($data['extension_attributes']['taxes'][0]['amount'], $taxes[0]['amount']);
$this->assertCount(1, $result['extension_attributes']['additional_itemized_taxes']);
$shippingTaxItem = $result['extension_attributes']['additional_itemized_taxes'][0];
$this->assertEquals('shipping', $shippingTaxItem['taxable_item_type']);
$this->assertEquals(5, $shippingTaxItem['tax_percent']);
$this->assertEquals(0.25, $shippingTaxItem['amount']);
$this->assertEquals(0.25, $shippingTaxItem['base_amount']);
$this->assertEquals(0.25, $shippingTaxItem['real_amount']);
$this->assertCount(1, $result['items'][0]['extension_attributes']['itemized_taxes']);
$orderItemTaxItem = $result['items'][0]['extension_attributes']['itemized_taxes'][0];
$this->assertEquals('product', $orderItemTaxItem['taxable_item_type']);
$this->assertEquals(5, $orderItemTaxItem['tax_percent']);
$this->assertEquals(0.50, $orderItemTaxItem['amount']);
$this->assertEquals(0.50, $orderItemTaxItem['base_amount']);
$this->assertEquals(0.50, $orderItemTaxItem['real_amount']);
$this->assertEquals($result['items'][0]['item_id'], $orderItemTaxItem['item_id']);
// test when additional_itemized_taxes and taxes are not provided
$data = $result;
$additionalItemizedTaxes = $data['extension_attributes']['additional_itemized_taxes'];
$orderItemAssociatedItemizedTaxes = $data['items'][0]['extension_attributes']['itemized_taxes'];
unset($data['extension_attributes']['taxes']);
unset($data['extension_attributes']['additional_itemized_taxes']);
unset($data['items'][0]['extension_attributes']['additional_itemized_taxes']);
$this->_webApiCall($postServiceInfo, ['entity' => $data]);
$result = $this->_webApiCall($getServiceInfo, ['id' => $order->getEntityId()]);
$this->assertEquals(
$taxes,
$result['extension_attributes']['taxes']
);
$this->assertEquals(
$additionalItemizedTaxes,
$result['extension_attributes']['additional_itemized_taxes']
);
$this->assertEquals(
$orderItemAssociatedItemizedTaxes,
$result['items'][0]['extension_attributes']['itemized_taxes']
);
}
/**
* Prepare order data for request
*
* @param Order $order
* @return array
*/
private function getOrderData(Order $order)
{
if (TESTS_WEB_API_ADAPTER == self::ADAPTER_SOAP) {
$entityData = $order->getData();
unset($entityData[OrderInterface::INCREMENT_ID]);
$entityData[OrderInterface::STATE] = 'processing';
$entityData[OrderInterface::STATUS] = 'processing';
$orderData = $order->getData();
$orderData['billing_address'] = $order->getBillingAddress()->getData();
$orderData['billing_address']['street'] = ['Street'];
$orderItems = [];
foreach ($order->getItems() as $item) {
$orderItems[] = $item->getData();
}
$orderData['items'] = $orderItems;
$shippingAddress = $order->getShippingAddress()->getData();
$orderData['extension_attributes']['shipping_assignments'] =
[
[
'shipping' => [
'address' => $shippingAddress,
'method' => 'flatrate_flatrate'
],
'items' => $order->getItems(),
'stock_id' => null,
]
];
} else {
$orderData = [
OrderInterface::ENTITY_ID => $order->getId(),
OrderInterface::STATE => 'processing',
OrderInterface::STATUS => 'processing'
];
}
return $orderData;
}
/**
* Get data for invoice from order.
*
* @param Order $order
* @return array
*/
private function getDataForInvoice(Order $order): array
{
$orderItems = $order->getAllItems();
return [
'order_id' => $order->getId(),
'base_currency_code' => null,
'base_discount_amount' => null,
'base_grand_total' => null,
'base_discount_tax_compensation_amount' => null,
'base_shipping_amount' => null,
'base_shipping_discount_tax_compensation_amnt' => null,
'base_shipping_incl_tax' => null,
'base_shipping_tax_amount' => null,
'base_subtotal' => null,
'base_subtotal_incl_tax' => null,
'base_tax_amount' => null,
'base_total_refunded' => null,
'base_to_global_rate' => null,
'base_to_order_rate' => null,
'billing_address_id' => null,
'can_void_flag' => null,
'created_at' => null,
'discount_amount' => null,
'discount_description' => null,
'email_sent' => null,
'entity_id' => null,
'global_currency_code' => null,
'grand_total' => null,
'discount_tax_compensation_amount' => null,
'increment_id' => null,
'is_used_for_refund' => null,
'order_currency_code' => null,
'shipping_address_id' => null,
'shipping_amount' => null,
'shipping_discount_tax_compensation_amount' => null,
'shipping_incl_tax' => null,
'shipping_tax_amount' => null,
'state' => null,
'store_currency_code' => null,
'store_id' => null,
'store_to_base_rate' => null,
'store_to_order_rate' => null,
'subtotal' => null,
'subtotal_incl_tax' => null,
'tax_amount' => null,
'total_qty' => '1',
'transaction_id' => null,
'updated_at' => null,
'items' => [
[
'orderItemId' => $orderItems[0]->getId(),
'qty' => 2,
'additionalData' => null,
'baseCost' => null,
'baseDiscountAmount' => null,
'baseDiscountTaxCompensationAmount' => null,
'basePrice' => null,
'basePriceInclTax' => null,
'baseRowTotal' => null,
'baseRowTotalInclTax' => null,
'baseTaxAmount' => null,
'description' => null,
'discountAmount' => null,
'discountTaxCompensationAmount' => null,
'name' => null,
'entity_id' => null,
'parentId' => null,
'price' => null,
'priceInclTax' => null,
'productId' => null,
'rowTotal' => null,
'rowTotalInclTax' => null,
'sku' => 'sku' . uniqid(),
'taxAmount' => null,
],
],
];
}
/**
* Get data for creditmemo.
*
* @param Order $order
* @return array
*/
private function getDataForCreditmemo(Order $order): array
{
$orderItem = current($order->getAllItems());
$items = [
$orderItem->getId() => ['order_item_id' => $orderItem->getId(), 'qty' => $orderItem->getQtyInvoiced()],
];
return [
'adjustment' => null,
'adjustment_negative' => null,
'adjustment_positive' => null,
'base_adjustment' => null,
'base_adjustment_negative' => null,
'base_adjustment_positive' => null,
'base_currency_code' => null,
'base_discount_amount' => null,
'base_grand_total' => null,
'base_discount_tax_compensation_amount' => null,
'base_shipping_amount' => null,
'base_shipping_discount_tax_compensation_amnt' => null,
'base_shipping_incl_tax' => null,
'base_shipping_tax_amount' => null,
'base_subtotal' => null,
'base_subtotal_incl_tax' => null,
'base_tax_amount' => null,
'base_to_global_rate' => null,
'base_to_order_rate' => null,
'billing_address_id' => null,
'created_at' => null,
'creditmemo_status' => null,
'discount_amount' => null,
'discount_description' => null,
'email_sent' => null,
'entity_id' => null,
'global_currency_code' => null,
'grand_total' => null,
'discount_tax_compensation_amount' => null,
'increment_id' => null,
'invoice_id' => null,
'order_currency_code' => null,
'order_id' => $order->getId(),
'shipping_address_id' => null,
'shipping_amount' => null,
'shipping_discount_tax_compensation_amount' => null,
'shipping_incl_tax' => null,
'shipping_tax_amount' => null,
'state' => null,
'store_currency_code' => null,
'store_id' => null,
'store_to_base_rate' => null,
'store_to_order_rate' => null,
'subtotal' => null,
'subtotal_incl_tax' => null,
'tax_amount' => null,
'transaction_id' => null,
'updated_at' => null,
'items' => $items,
];
}
/**
* Get data for shipment.
*
* @param Order $order
* @return array
*/
private function getDataForShipment(Order $order): array
{
$requestShipData = [
'orderId' => $order->getId(),
'items' => [],
'comment' => [
'comment' => 'Test Comment',
'is_visible_on_front' => 1,
],
'tracks' => [
[
'track_number' => 'TEST_TRACK_0001',
'title' => 'Simple shipment track',
'carrier_code' => 'UPS'
]
]
];
foreach ($order->getAllItems() as $item) {
if ($item->getProductType() == 'simple') {
$requestShipData['items'][] = [
'order_item_id' => $item->getItemId(),
'qty' => $item->getQtyOrdered(),
];
break;
}
}
return $requestShipData;
}
}
@@ -0,0 +1,384 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\Sales\Model\Order;
/**
* API test for creation of Creditmemo for certain Order.
*/
class RefundOrderTest extends \Magento\TestFramework\TestCase\WebapiAbstract
{
const SERVICE_READ_NAME = 'salesRefundOrderV1';
const SERVICE_VERSION = 'V1';
/**
* @var \Magento\Framework\ObjectManagerInterface
*/
private $objectManager;
/**
* @var \Magento\Sales\Api\CreditmemoRepositoryInterface
*/
private $creditmemoRepository;
protected function setUp(): void
{
$this->objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
$this->creditmemoRepository = $this->objectManager->get(
\Magento\Sales\Api\CreditmemoRepositoryInterface::class
);
}
/**
* @magentoApiDataFixture Magento/Sales/_files/order_with_shipping_and_invoice.php
*/
public function testShortRequest()
{
/** @var \Magento\Sales\Model\Order $existingOrder */
$existingOrder = $this->objectManager->create(\Magento\Sales\Model\Order::class)
->loadByIncrementId('100000001');
$result = $this->_webApiCall(
$this->getServiceData($existingOrder),
['orderId' => $existingOrder->getEntityId()]
);
$this->assertNotEmpty(
$result,
'Failed asserting that the received response is correct'
);
/** @var \Magento\Sales\Model\Order $updatedOrder */
$updatedOrder = $this->objectManager->create(\Magento\Sales\Model\Order::class)
->loadByIncrementId($existingOrder->getIncrementId());
try {
$creditmemo = $this->creditmemoRepository->get($result);
$expectedItems = $this->getOrderItems($existingOrder);
$actualCreditmemoItems = $this->getCreditmemoItems($creditmemo);
$actualRefundedOrderItems = $this->getRefundedOrderItems($updatedOrder);
$this->assertEquals(
$expectedItems,
$actualCreditmemoItems,
'Failed asserting that the Creditmemo contains all requested items'
);
$this->assertEquals(
$expectedItems,
$actualRefundedOrderItems,
'Failed asserting that all requested order items were refunded'
);
$this->assertEquals(
$creditmemo->getShippingAmount(),
$existingOrder->getShippingAmount(),
'Failed asserting that the Creditmemo contains correct shipping amount'
);
$this->assertEquals(
$creditmemo->getShippingAmount(),
$updatedOrder->getShippingRefunded(),
'Failed asserting that proper shipping amount of the Order was refunded'
);
$this->assertEquals(
Order::STATE_COMPLETE,
$updatedOrder->getStatus(),
'Failed asserting that order status has not changed'
);
} catch (\Magento\Framework\Exception\NoSuchEntityException $e) {
$this->fail('Failed asserting that Creditmemo was created');
}
}
/**
* @magentoApiDataFixture Magento/Sales/_files/order_with_shipping_and_invoice.php
*/
public function testFullRequest()
{
/** @var \Magento\Sales\Model\Order $existingOrder */
$existingOrder = $this->objectManager->create(\Magento\Sales\Model\Order::class)
->loadByIncrementId('100000001');
$expectedItems = $this->getOrderItems($existingOrder);
$expectedItems[0]['qty'] = $expectedItems[0]['qty'] - 1;
$expectedComment = [
'comment' => 'Test Comment',
'is_visible_on_front' => 1
];
$expectedShippingAmount = 15;
$expectedAdjustmentPositive = 5.53;
$expectedAdjustmentNegative = 5.53;
$result = $this->_webApiCall(
$this->getServiceData($existingOrder),
[
'orderId' => $existingOrder->getEntityId(),
'items' => $expectedItems,
'comment' => $expectedComment,
'arguments' => [
'shipping_amount' => $expectedShippingAmount,
'adjustment_positive' => $expectedAdjustmentPositive,
'adjustment_negative' => $expectedAdjustmentNegative
]
]
);
$this->assertNotEmpty(
$result,
'Failed asserting that the received response is correct'
);
/** @var \Magento\Sales\Model\Order $updatedOrder */
$updatedOrder = $this->objectManager->create(\Magento\Sales\Model\Order::class)
->loadByIncrementId($existingOrder->getIncrementId());
try {
$creditmemo = $this->creditmemoRepository->get($result);
$actualCreditmemoItems = $this->getCreditmemoItems($creditmemo);
$actualCreditmemoComment = $this->getRecentComment($creditmemo);
$actualRefundedOrderItems = $this->getRefundedOrderItems($updatedOrder);
$this->assertEquals(
$expectedItems,
$actualCreditmemoItems,
'Failed asserting that the Creditmemo contains all requested items'
);
$this->assertEquals(
$expectedItems,
$actualRefundedOrderItems,
'Failed asserting that all requested order items were refunded'
);
$this->assertEquals(
$expectedComment,
$actualCreditmemoComment,
'Failed asserting that the Creditmemo contains correct comment'
);
$this->assertEquals(
$expectedShippingAmount,
$creditmemo->getShippingAmount(),
'Failed asserting that the Creditmemo contains correct shipping amount'
);
$this->assertEquals(
$expectedShippingAmount,
$updatedOrder->getShippingRefunded(),
'Failed asserting that proper shipping amount of the Order was refunded'
);
$this->assertEquals(
$expectedAdjustmentPositive,
$creditmemo->getAdjustmentPositive(),
'Failed asserting that the Creditmemo contains correct positive adjustment'
);
$this->assertEquals(
$expectedAdjustmentNegative,
$creditmemo->getAdjustmentNegative(),
'Failed asserting that the Creditmemo contains correct negative adjustment'
);
$this->assertEquals(
$existingOrder->getStatus(),
$updatedOrder->getStatus(),
'Failed asserting that order status was NOT changed'
);
} catch (\Magento\Framework\Exception\NoSuchEntityException $e) {
$this->fail('Failed asserting that Creditmemo was created');
}
}
/**
* Test order will keep same(custom) status after partial refund, if state has not been changed.
*
* @magentoApiDataFixture Magento/Sales/_files/order_with_invoice_and_custom_status.php
*/
public function testOrderStatusPartialRefund()
{
/** @var \Magento\Sales\Model\Order $existingOrder */
$existingOrder = $this->objectManager->create(\Magento\Sales\Model\Order::class)
->loadByIncrementId('100000001');
$items = $this->getOrderItems($existingOrder);
$items[0]['qty'] -= 1;
$result = $this->_webApiCall(
$this->getServiceData($existingOrder),
[
'orderId' => $existingOrder->getEntityId(),
'items' => $items,
]
);
$this->assertNotEmpty(
$result,
'Failed asserting that the received response is correct'
);
/** @var \Magento\Sales\Model\Order $updatedOrder */
$updatedOrder = $this->objectManager->create(\Magento\Sales\Model\Order::class)
->loadByIncrementId($existingOrder->getIncrementId());
$this->assertSame('custom_processing', $updatedOrder->getStatus());
$this->assertSame('processing', $updatedOrder->getState());
}
/**
* Test order will change custom status after total refund, when state has been changed.
*
* @magentoApiDataFixture Magento/Sales/_files/order_with_invoice_and_custom_status.php
*/
public function testOrderStatusTotalRefund()
{
/** @var \Magento\Sales\Model\Order $existingOrder */
$existingOrder = $this->objectManager->create(\Magento\Sales\Model\Order::class)
->loadByIncrementId('100000001');
$items = $this->getOrderItems($existingOrder);
$result = $this->_webApiCall(
$this->getServiceData($existingOrder),
[
'orderId' => $existingOrder->getEntityId(),
'items' => $items,
]
);
$this->assertNotEmpty(
$result,
'Failed asserting that the received response is correct'
);
/** @var \Magento\Sales\Model\Order $updatedOrder */
$updatedOrder = $this->objectManager->create(\Magento\Sales\Model\Order::class)
->loadByIncrementId($existingOrder->getIncrementId());
$this->assertSame('complete', $updatedOrder->getStatus());
$this->assertSame('complete', $updatedOrder->getState());
}
/**
* Prepares and returns info for API service.
*
* @param \Magento\Sales\Api\Data\OrderInterface $order
*
* @return array
*/
private function getServiceData(\Magento\Sales\Api\Data\OrderInterface $order)
{
return [
'rest' => [
'resourcePath' => '/V1/order/' . $order->getEntityId() . '/refund',
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => self::SERVICE_READ_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_READ_NAME . 'execute',
]
];
}
/**
* Gets all items of given Order in proper format.
*
* @param \Magento\Sales\Model\Order $order
*
* @return array
*/
private function getOrderItems(\Magento\Sales\Model\Order $order)
{
$items = [];
/** @var \Magento\Sales\Api\Data\OrderItemInterface $item */
foreach ($order->getAllItems() as $item) {
$items[] = [
'order_item_id' => $item->getItemId(),
'qty' => $item->getQtyOrdered(),
];
}
return $items;
}
/**
* Gets refunded items of given Order in proper format.
*
* @param \Magento\Sales\Model\Order $order
*
* @return array
*/
private function getRefundedOrderItems(\Magento\Sales\Model\Order $order)
{
$items = [];
/** @var \Magento\Sales\Api\Data\OrderItemInterface $item */
foreach ($order->getAllItems() as $item) {
if ($item->getQtyRefunded() > 0) {
$items[] = [
'order_item_id' => $item->getItemId(),
'qty' => $item->getQtyRefunded(),
];
}
}
return $items;
}
/**
* Gets all items of given Creditmemo in proper format.
*
* @param \Magento\Sales\Api\Data\CreditmemoInterface $creditmemo
*
* @return array
*/
private function getCreditmemoItems(\Magento\Sales\Api\Data\CreditmemoInterface $creditmemo)
{
$items = [];
/** @var \Magento\Sales\Api\Data\CreditmemoItemInterface $item */
foreach ($creditmemo->getItems() as $item) {
$items[] = [
'order_item_id' => $item->getOrderItemId(),
'qty' => $item->getQty(),
];
}
return $items;
}
/**
* Gets the most recent comment of given Creditmemo in proper format.
*
* @param \Magento\Sales\Api\Data\CreditmemoInterface $creditmemo
*
* @return array|null
*/
private function getRecentComment(\Magento\Sales\Api\Data\CreditmemoInterface $creditmemo)
{
$comments = $creditmemo->getComments();
if ($comments) {
$comment = reset($comments);
return [
'comment' => $comment->getComment(),
'is_visible_on_front' => $comment->getIsVisibleOnFront(),
];
}
return null;
}
}
@@ -0,0 +1,507 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Magento\Sales\Service\V1;
use Magento\Catalog\Api\ProductRepositoryInterface;
use Magento\Catalog\Model\Product\Type;
use Magento\Framework\ObjectManagerInterface;
use Magento\Sales\Api\Data\OrderItemInterface;
use Magento\Sales\Api\ShipmentRepositoryInterface;
use Magento\Sales\Model\Order;
/**
* API test for creation of Shipment for certain Order.
*/
class ShipOrderTest extends \Magento\TestFramework\TestCase\WebapiAbstract
{
public const SERVICE_READ_NAME = 'salesShipOrderV1';
public const SERVICE_VERSION = 'V1';
/**
* @var ObjectManagerInterface
*/
private $objectManager;
/**
* @var ShipmentRepositoryInterface
*/
private $shipmentRepository;
/**
* @var ProductRepositoryInterface
*/
private $productRepository;
/**
* @inheritdoc
*/
protected function setUp(): void
{
$this->objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
$this->shipmentRepository = $this->objectManager->get(ShipmentRepositoryInterface::class);
$this->productRepository = $this->objectManager->get(ProductRepositoryInterface::class);
}
/**
* @magentoApiDataFixture Magento/Sales/_files/order_configurable_product.php
*/
public function testConfigurableShipOrder()
{
$this->markTestSkipped('https://github.com/magento-engcom/msi/issues/1335');
$productsQuantity = 1;
/** @var Order $existingOrder */
$existingOrder = $this->getOrder('100000001');
$requestData = [
'orderId' => $existingOrder->getId(),
];
$shipmentId = (int)$this->_webApiCall($this->getServiceInfo($existingOrder), $requestData);
$this->assertNotEmpty($shipmentId);
$shipment = null;
try {
$shipment = $this->shipmentRepository->get($shipmentId);
} catch (\Magento\Framework\Exception\NoSuchEntityException $e) {
$this->fail('Failed asserting that Shipment was created');
}
$orderedQty = 0;
/** @var \Magento\Sales\Model\Order\Item $item */
foreach ($existingOrder->getItems() as $item) {
if ($item->isDummy(true)) {
continue;
}
$orderedQty += $item->getQtyOrdered();
}
$this->assertEquals(
(int)$shipment->getTotalQty(),
(int)$orderedQty,
'Failed asserting that quantity of ordered and shipped items is equal'
);
$this->assertEquals(
$productsQuantity,
count($shipment->getItems()),
'Failed asserting that quantity of products and sales shipment items is equal'
);
}
/**
* Tests that order doesn't change a status from custom to the default after shipment creation.
*
* @magentoApiDataFixture Magento/Sales/_files/order_status.php
*/
public function testShipOrderStatusPreserve()
{
$incrementId = '100000001';
$orderStatus = 'example';
/** @var Order $existingOrder */
$order = $this->getOrder($incrementId);
$this->assertEquals($orderStatus, $order->getStatus());
$requestData = [
'orderId' => $order->getId(),
];
/** @var OrderItemInterface $item */
foreach ($order->getAllItems() as $item) {
$requestData['items'][] = [
'order_item_id' => $item->getItemId(),
'qty' => $item->getQtyOrdered(),
];
}
$shipmentId = $this->_webApiCall($this->getServiceInfo($order), $requestData);
$this->assertNotEmpty($shipmentId);
$actualOrder = $this->getOrder($order->getIncrementId());
$this->assertEquals(
$order->getStatus(),
$actualOrder->getStatus(),
'Failed asserting that Order status wasn\'t changed'
);
}
/**
* @magentoApiDataFixture Magento/Sales/_files/order_new.php
*/
public function testShipOrder()
{
/** @var Order $existingOrder */
$existingOrder = $this->getOrder('100000001');
$requestData = [
'orderId' => $existingOrder->getId(),
'items' => [],
'comment' => [
'comment' => 'Test Comment',
'is_visible_on_front' => 1,
],
'tracks' => [
[
'track_number' => 'TEST_TRACK_0001',
'title' => 'Simple shipment track',
'carrier_code' => 'UPS',
],
],
];
/** @var OrderItemInterface $item */
foreach ($existingOrder->getAllItems() as $item) {
$requestData['items'][] = [
'order_item_id' => $item->getItemId(),
'qty' => $item->getQtyOrdered(),
];
}
$result = $this->_webApiCall($this->getServiceInfo($existingOrder), $requestData);
$this->assertNotEmpty($result);
try {
$this->shipmentRepository->get($result);
} catch (\Magento\Framework\Exception\NoSuchEntityException $e) {
$this->fail('Failed asserting that Shipment was created');
}
/** @var Order $updatedOrder */
$updatedOrder = $this->getOrder('100000001');
$this->assertNotEquals(
$existingOrder->getStatus(),
$updatedOrder->getStatus(),
'Failed asserting that Order status was changed'
);
}
/**
* Tests that not providing a tracking number produces the correct error. See MAGETWO-95429
* @codingStandardsIgnoreStart
* @codingStandardsIgnoreEnd
* @magentoApiDataFixture Magento/Sales/_files/order_new.php
*/
public function testShipOrderWithoutTrackingNumberReturnsError()
{
$this->expectException(\Exception::class);
$this->expectExceptionMessageMatches(
'/Shipment Document Validation Error\\(s\\):(?:\\n|\\\\n)Please enter a tracking number./'
);
$this->_markTestAsRestOnly('SOAP requires an tracking number to be provided so this case is not possible.');
/** @var Order $existingOrder */
$existingOrder = $this->getOrder('100000001');
$requestData = [
'orderId' => $existingOrder->getId(),
'comment' => [
'comment' => 'Test Comment',
'is_visible_on_front' => 1,
],
'tracks' => [
[
'title' => 'Simple shipment track',
'carrier_code' => 'UPS',
],
],
];
$this->_webApiCall($this->getServiceInfo($existingOrder), $requestData);
}
/**
* @magentoApiDataFixture Magento/Bundle/_files/order_with_bundle_shipped_separately.php
*/
public function testPartialShipOrderWithBundleShippedSeparately()
{
$existingOrder = $this->getOrder('100000001');
$requestData = [
'orderId' => $existingOrder->getId(),
'items' => [],
'comment' => [
'comment' => 'Test Comment',
'is_visible_on_front' => 1,
],
'tracks' => [
[
'track_number' => 'TEST_TRACK_0001',
'title' => 'Simple shipment track',
'carrier_code' => 'UPS',
],
],
];
$shippedItemId = null;
foreach ($existingOrder->getAllItems() as $item) {
if ($item->getProductType() == 'simple') {
$requestData['items'][] = [
'order_item_id' => $item->getItemId(),
'qty' => $item->getQtyOrdered(),
];
$shippedItemId = $item->getItemId();
break;
}
}
$shipmentId = $this->_webApiCall($this->getServiceInfo($existingOrder), $requestData);
$this->assertNotEmpty($shipmentId);
$shipment = null;
try {
$shipment = $this->shipmentRepository->get($shipmentId);
} catch (\Magento\Framework\Exception\NoSuchEntityException $e) {
$this->fail('Failed asserting that Shipment was created');
}
$this->assertEquals(1, $shipment->getTotalQty());
/** @var Order $existingOrder */
$existingOrder = $this->getOrder('100000001');
foreach ($existingOrder->getAllItems() as $item) {
if ($item->getItemId() == $shippedItemId) {
$this->assertEquals(1, $item->getQtyShipped());
continue;
} elseif ($item->getParentItem()) {
$this->assertEquals(0, $item->getQtyShipped());
}
}
}
/**
* @magentoApiDataFixture Magento/Bundle/_files/order_with_2_bundles_shipping_separately.php
*/
public function testPartialShipOrderWithTwoBundleShippedSeparatelyContainsSameSimple()
{
$order = $this->getOrder('order_bundle_separately_shipped');
$requestData = [
'orderId' => $order->getId(),
'items' => [],
'comment' => [
'comment' => 'Test Comment',
'is_visible_on_front' => 1,
],
'tracks' => [],
];
$shippedItemId = null;
$parentItemId = null;
foreach ($order->getAllItems() as $item) {
if ($item->getSku() === 'simple1') {
$requestData['items'][] = [
'order_item_id' => $item->getItemId(),
'qty' => $item->getQtyOrdered(),
];
$shippedItemId = $item->getItemId();
$parentItemId = $item->getParentItemId();
break;
}
}
$shipmentId = $this->_webApiCall($this->getServiceInfo($order), $requestData);
$this->assertNotEmpty($shipmentId);
$shipment = null;
try {
$shipment = $this->shipmentRepository->get($shipmentId);
} catch (\Magento\Framework\Exception\NoSuchEntityException $e) {
$this->fail('Failed asserting that Shipment was created');
}
$this->assertEquals(1, $shipment->getTotalQty());
$order = $this->getOrder('order_bundle_separately_shipped');
foreach ($order->getAllItems() as $item) {
if (in_array($item->getItemId(), [$shippedItemId, $parentItemId])) {
$this->assertEquals(1, $item->getQtyShipped());
continue;
}
$this->assertEquals(0, $item->getQtyShipped());
}
try {
$this->_webApiCall($this->getServiceInfo($order), $requestData);
$this->fail('Expected exception was not raised');
} catch (\Exception $exception) {
$this->assertExceptionMessage(
$exception,
'Shipment Document Validation Error(s): You can\'t create a shipment without products.'
);
}
}
/**
* @magentoApiDataFixture Magento/Bundle/_files/order_with_bundle_shipped_separately.php
*/
public function testValidationShipTogetherWithBundleShippedSeparate()
{
$order = $this->getOrder('100000001');
$requestData = [
'orderId' => $order->getId(),
'items' => [],
'comment' => [
'comment' => 'Test Comment',
'is_visible_on_front' => 1,
],
'tracks' => [],
];
foreach ($order->getAllItems() as $item) {
if ($item->getProductType() === Type::TYPE_BUNDLE) {
$requestData['items'][] = [
'order_item_id' => $item->getItemId(),
'qty' => $item->getQtyOrdered(),
];
break;
}
}
try {
$this->_webApiCall($this->getServiceInfo($order), $requestData);
$this->fail('Expected exception was not raised');
} catch (\Exception $exception) {
$this->assertExceptionMessage(
$exception,
'Shipment Document Validation Error(s): '
. 'You can\'t create a shipment without products. '
. 'Cannot create shipment as bundle product "bundle-product" has shipment type "Separately". '
. 'Bundle product options should be shipped instead.'
);
}
foreach ($order->getAllItems() as $item) {
if ($item->getProductType() === Type::TYPE_SIMPLE) {
$requestData['items'] = [
[
'order_item_id' => $item->getItemId(),
'qty' => $item->getQtyOrdered(),
],
];
break;
}
}
$this->_webApiCall($this->getServiceInfo($order), $requestData);
}
/**
* @magentoApiDataFixture Magento/Bundle/_files/order_with_bundle_shipped_together.php
*/
public function testValidationShipTogetherWithBundleShippedTogether()
{
$order = $this->getOrder('100000001');
$requestData = [
'orderId' => $order->getId(),
'items' => [],
'comment' => [
'comment' => 'Test Comment',
'is_visible_on_front' => 1,
],
'tracks' => [],
];
foreach ($order->getAllItems() as $item) {
if ($item->getProductType() === Type::TYPE_SIMPLE) {
$requestData['items'][] = [
'order_item_id' => $item->getItemId(),
'qty' => $item->getQtyOrdered(),
];
break;
}
}
try {
$this->_webApiCall($this->getServiceInfo($order), $requestData);
$this->fail('Expected exception was not raised');
} catch (\Exception $exception) {
$this->assertExceptionMessage(
$exception,
'Shipment Document Validation Error(s): '
. 'You can\'t create a shipment without products. '
. 'Cannot create shipment as bundle product "bundle-product" has shipment type "Together". '
. 'Bundle product itself should be shipped instead.'
);
}
foreach ($order->getAllItems() as $item) {
if ($item->getProductType() === Type::TYPE_BUNDLE) {
$requestData['items'] = [
[
'order_item_id' => $item->getItemId(),
'qty' => $item->getQtyOrdered(),
],
];
break;
}
}
$this->_webApiCall($this->getServiceInfo($order), $requestData);
}
/**
* @param Order $order
* @return array
*/
private function getServiceInfo(Order $order): array
{
$serviceInfo = [
'rest' => [
'resourcePath' => '/V1/order/' . $order->getId() . '/ship',
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => self::SERVICE_READ_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_READ_NAME . 'execute',
],
];
return $serviceInfo;
}
/**
* Returns order by increment id.
*
* @param string $incrementId
* @return Order
*/
private function getOrder(string $incrementId): Order
{
return $this->objectManager->create(Order::class)->loadByIncrementId($incrementId);
}
/**
* Assert correct exception message.
*
* @param \Exception $exception
* @param string $expectedMessage
* @return void
*/
private function assertExceptionMessage(\Exception $exception, string $expectedMessage): void
{
$actualMessage = '';
switch (TESTS_WEB_API_ADAPTER) {
case self::ADAPTER_SOAP:
$actualMessage = trim(preg_replace('/\s+/', ' ', $exception->getMessage()));
break;
case self::ADAPTER_REST:
$error = $this->processRestExceptionResult($exception);
$actualMessage = $error['message'];
break;
}
$this->assertEquals($expectedMessage, $actualMessage);
}
}
@@ -0,0 +1,78 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Magento\Sales\Service\V1;
use Magento\Sales\Api\Data\ShipmentCommentInterface;
use Magento\TestFramework\TestCase\WebapiAbstract;
class ShipmentAddCommentTest extends WebapiAbstract
{
/**
* Service read name
*/
public const SERVICE_READ_NAME = 'salesShipmentCommentRepositoryV1';
/**
* Service version
*/
public const SERVICE_VERSION = 'V1';
/**
* Shipment increment id
*/
public const SHIPMENT_INCREMENT_ID = '100000001';
/**
* @var \Magento\Framework\ObjectManagerInterface
*/
protected $objectManager;
protected function setUp(): void
{
$this->objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
}
/**
* Test shipment add comment service
*
* @magentoApiDataFixture Magento/Sales/_files/shipment.php
*/
public function testShipmentAddComment()
{
/** @var \Magento\Sales\Model\ResourceModel\Order\Shipment\Collection $shipmentCollection */
$shipmentCollection = $this->objectManager->get(
\Magento\Sales\Model\ResourceModel\Order\Shipment\Collection::class
);
$shipment = $shipmentCollection->getFirstItem();
$commentData = [
ShipmentCommentInterface::COMMENT => 'Hello world!',
ShipmentCommentInterface::ENTITY_ID => null,
ShipmentCommentInterface::CREATED_AT => null,
ShipmentCommentInterface::PARENT_ID => $shipment->getId(),
ShipmentCommentInterface::IS_VISIBLE_ON_FRONT => 1,
ShipmentCommentInterface::IS_CUSTOMER_NOTIFIED => 1
];
$requestData = ['entity' => $commentData];
$serviceInfo = [
'rest' => [
'resourcePath' => '/V1/shipment/' . $shipment->getId() . '/comments',
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => self::SERVICE_READ_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_READ_NAME . 'save',
],
];
$result = $this->_webApiCall($serviceInfo, $requestData);
$this->assertNotEmpty($result);
}
}
@@ -0,0 +1,144 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Magento\Sales\Service\V1;
use Magento\Framework\Webapi\Rest\Request;
use Magento\Sales\Api\Data\ShipmentTrackInterface;
use Magento\Sales\Model\Order\Shipment\Track;
use Magento\Sales\Model\ResourceModel\Order\Shipment\Collection;
use Magento\TestFramework\Helper\Bootstrap;
use Magento\TestFramework\TestCase\WebapiAbstract;
/**
* Sales Shipment Track Repository API test
*/
class ShipmentAddTrackTest extends WebapiAbstract
{
/**
* Read name of service
*/
const SERVICE_READ_NAME = 'salesShipmentTrackRepositoryV1';
/**
* Version of service
*/
const SERVICE_VERSION = 'V1';
/**
* Increment id for shipment
*/
const SHIPMENT_INCREMENT_ID = '100000001';
/**
* @var \Magento\Framework\ObjectManagerInterface
*/
private $objectManager;
/**
* @inheritdoc
*/
protected function setUp(): void
{
$this->objectManager = Bootstrap::getObjectManager();
}
/**
* Creates shipment track item.
*
* @magentoApiDataFixture Magento/Sales/_files/shipment.php
*/
public function testShipmentAddTrack()
{
$shipmentCollection = $this->objectManager->get(Collection::class);
/** @var \Magento\Sales\Model\Order\Shipment $shipment */
$shipment = $shipmentCollection->getFirstItem();
$trackData = [
ShipmentTrackInterface::ENTITY_ID => null,
ShipmentTrackInterface::ORDER_ID => $shipment->getOrderId(),
ShipmentTrackInterface::PARENT_ID => $shipment->getId(),
ShipmentTrackInterface::WEIGHT => 20,
ShipmentTrackInterface::QTY => 5,
ShipmentTrackInterface::TRACK_NUMBER => 2,
ShipmentTrackInterface::DESCRIPTION => 'Shipment description',
ShipmentTrackInterface::TITLE => 'Shipment title',
ShipmentTrackInterface::CARRIER_CODE => Track::CUSTOM_CARRIER_CODE,
];
$result = $this->_webApiCall($this->getServiceInfo(), ['entity' => $trackData]);
self::assertNotEmpty($result);
self::assertNotEmpty($result[ShipmentTrackInterface::ENTITY_ID]);
self::assertEquals($shipment->getId(), $result[ShipmentTrackInterface::PARENT_ID]);
}
/**
* Shipment Tracking throw an error if order doesn't exist.
*
* @magentoApiDataFixture Magento/Sales/_files/shipment.php
* @magentoApiDataFixture Magento/Sales/_files/order_list.php
*/
public function testShipmentTrackWithFailedOrderId()
{
/** @var \Magento\Sales\Model\Order $order */
$orderCollection = $this->objectManager->get(\Magento\Sales\Model\ResourceModel\Order\Collection::class);
$order = $orderCollection->getLastItem();
// Order ID from Magento/Sales/_files/order_list.php
$failedOrderId = $order->getId();
$shipmentCollection = $this->objectManager->get(Collection::class);
/** @var \Magento\Sales\Model\Order\Shipment $shipment */
$shipment = $shipmentCollection->getFirstItem();
$trackData = [
ShipmentTrackInterface::ENTITY_ID => null,
ShipmentTrackInterface::ORDER_ID => $failedOrderId,
ShipmentTrackInterface::PARENT_ID => $shipment->getId(),
ShipmentTrackInterface::WEIGHT => 20,
ShipmentTrackInterface::QTY => 5,
ShipmentTrackInterface::TRACK_NUMBER => 2,
ShipmentTrackInterface::DESCRIPTION => 'Shipment description',
ShipmentTrackInterface::TITLE => 'Shipment title',
ShipmentTrackInterface::CARRIER_CODE => Track::CUSTOM_CARRIER_CODE,
];
$exceptionMessage = '';
try {
$this->_webApiCall($this->getServiceInfo(), ['entity' => $trackData]);
} catch (\SoapFault $e) {
$exceptionMessage = $e->getMessage();
} catch (\Exception $e) {
$errorObj = $this->processRestExceptionResult($e);
$exceptionMessage = $errorObj['message'];
}
$this->assertStringContainsString(
$exceptionMessage,
'Could not save the shipment tracking.',
'SoapFault or CouldNotSaveException does not contain exception message.'
);
}
/**
* Returns details about API endpoints and services.
*
* @return array
*/
private function getServiceInfo()
{
return [
'rest' => [
'resourcePath' => '/V1/shipment/track',
'httpMethod' => Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => self::SERVICE_READ_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_READ_NAME . 'save',
],
];
}
}
@@ -0,0 +1,56 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\TestFramework\TestCase\WebapiAbstract;
/**
* Class ShipmentCommentsListTest
*/
class ShipmentCommentsListTest extends WebapiAbstract
{
const SERVICE_NAME = 'salesShipmentManagementV1';
const SERVICE_VERSION = 'V1';
/**
* @magentoApiDataFixture Magento/Sales/_files/shipment.php
*/
public function testShipmentCommentsList()
{
$comment = 'Test comment';
$objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
/** @var \Magento\Sales\Model\ResourceModel\Order\Shipment\Collection $shipmentCollection */
$shipmentCollection = $objectManager->get(\Magento\Sales\Model\ResourceModel\Order\Shipment\Collection::class);
$shipment = $shipmentCollection->getFirstItem();
$shipmentComment = $objectManager->get(\Magento\Sales\Model\Order\Shipment\Comment::class);
$shipmentComment->setComment($comment);
$shipmentComment->setParentId($shipment->getId());
$shipmentComment->save();
$serviceInfo = [
'rest' => [
'resourcePath' => '/V1/shipment/' . $shipment->getId() . '/comments',
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
],
'soap' => [
'service' => self::SERVICE_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_NAME . 'getCommentsList',
],
];
$requestData = ['id' => $shipment->getId()];
$result = $this->_webApiCall($serviceInfo, $requestData);
// TODO Test fails, due to the inability of the framework API to handle data collection
foreach ($result['items'] as $item) {
/** @var \Magento\Sales\Model\Order\Shipment\Comment $shipmentHistoryStatus */
$shipmentHistoryStatus = $objectManager->get(\Magento\Sales\Model\Order\Shipment\Comment::class)
->load($item['entity_id']);
$this->assertEquals($shipmentHistoryStatus->getComment(), $item['comment']);
}
}
}
@@ -0,0 +1,112 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Magento\Sales\Service\V1;
use Magento\TestFramework\TestCase\WebapiAbstract;
/**
* Class ShipmentCreateTest
*
* Test shipment save API
*/
class ShipmentCreateTest extends WebapiAbstract
{
public const RESOURCE_PATH = '/V1/shipment';
public const SERVICE_READ_NAME = 'salesShipmentRepositoryV1';
public const SERVICE_VERSION = 'V1';
/**
* @var \Magento\Framework\ObjectManagerInterface
*/
protected $objectManager;
protected function setUp(): void
{
$this->objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
}
/**
* @magentoApiDataFixture Magento/Sales/_files/order.php
*/
public function testInvoke()
{
/** @var \Magento\Sales\Model\Order $order */
$order = $this->objectManager->create(\Magento\Sales\Model\Order::class)->loadByIncrementId('100000001');
$orderItem = current($order->getAllItems());
$items = [
[
'order_item_id' => $orderItem->getId(),
'qty' => $orderItem->getQtyOrdered(),
'additional_data' => null,
'description' => null,
'entity_id' => 1,
'name' => null,
'parent_id' => null,
'price' => null,
'product_id' => null,
'row_total' => null,
'sku' => 'simple',
'weight' => null,
],
];
$serviceInfo = [
'rest' => [
'resourcePath' => self::RESOURCE_PATH,
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => self::SERVICE_READ_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_READ_NAME . 'save',
],
];
$data = [
'order_id' => $order->getId(),
'entity_id' => null,
'store_id' => null,
'total_weight' => null,
'total_qty' => null,
'email_sent' => null,
'customer_id' => null,
'shipping_address_id' => null,
'billing_address_id' => null,
'shipment_status' => null,
'increment_id' => null,
'created_at' => null,
'updated_at' => null,
'shipping_label' => null,
'tracks' => [
[
'carrier_code' => 'UPS',
'order_id' => $order->getId(),
'title' => 'ground',
'description' => null,
'track_number' => '12345678',
'parent_id' => null,
'created_at' => null,
'updated_at' => null,
'qty' => null,
'weight' => null
]
],
'items' => $items,
'comments' => [
[
'comment' => 'Shipment-related comment.',
'is_customer_notified' => null,
'is_visible_on_front' => null,
'parent_id' => null
]
],
];
$result = $this->_webApiCall($serviceInfo, ['entity' => $data]);
$this->assertNotEmpty($result);
}
}
@@ -0,0 +1,43 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\TestFramework\TestCase\WebapiAbstract;
/**
* Class ShipmentEmailTest
*/
class ShipmentEmailTest extends WebapiAbstract
{
const SERVICE_VERSION = 'V1';
const SERVICE_NAME = 'salesShipmentManagementV1';
/**
* @magentoApiDataFixture Magento/Sales/_files/shipment.php
*/
public function testShipmentEmail()
{
$objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
$shipmentCollection = $objectManager->get(\Magento\Sales\Model\ResourceModel\Order\Shipment\Collection::class);
$shipment = $shipmentCollection->getFirstItem();
$serviceInfo = [
'rest' => [
'resourcePath' => '/V1/shipment/' . $shipment->getId() . '/emails',
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST,
],
'soap' => [
'service' => self::SERVICE_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_NAME . 'notify',
],
];
$requestData = ['id' => $shipment->getId()];
$result = $this->_webApiCall($serviceInfo, $requestData);
$this->assertTrue($result);
}
}
@@ -0,0 +1,91 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\Framework\Api\ExtensibleDataInterface;
use Magento\Framework\Api\SimpleDataObjectConverter;
use Magento\TestFramework\TestCase\WebapiAbstract;
/**
* Class ShipmentGetTest
*/
class ShipmentGetTest extends WebapiAbstract
{
const RESOURCE_PATH = '/V1/shipment';
const SERVICE_READ_NAME = 'salesShipmentRepositoryV1';
const SERVICE_VERSION = 'V1';
/**
* @var \Magento\Framework\ObjectManagerInterface
*/
protected $objectManager;
protected function setUp(): void
{
$this->objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
}
/**
* @magentoApiDataFixture Magento/Sales/_files/shipment.php
*/
public function testShipmentGet()
{
/** @var \Magento\Sales\Model\Order\Shipment $shipment */
$shipmentCollection = $this->objectManager->get(
\Magento\Sales\Model\ResourceModel\Order\Shipment\Collection::class
);
$shipment = $shipmentCollection->getFirstItem();
$shipment->load($shipment->getId());
$serviceInfo = [
'rest' => [
'resourcePath' => self::RESOURCE_PATH . '/' . $shipment->getId(),
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
],
'soap' => [
'service' => self::SERVICE_READ_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_READ_NAME . 'get',
],
];
$result = $this->_webApiCall($serviceInfo, ['id' => $shipment->getId()]);
$data = $result;
$this->assertArrayHasKey('items', $result);
$this->assertArrayHasKey('tracks', $result);
unset($data['items']);
unset($data['packages']);
unset($data['tracks']);
foreach ($data as $key => $value) {
if (!empty($value)) {
if ($key === ExtensibleDataInterface::EXTENSION_ATTRIBUTES_KEY) {
foreach ($value as $extensionAttributeKey => $extensionAttributeValue) {
$methodName = 'get' .
SimpleDataObjectConverter::snakeCaseToUpperCamelCase($extensionAttributeKey);
$this->assertEquals(
$shipment->getExtensionAttributes()->$methodName(),
$extensionAttributeValue
);
}
} else {
$this->assertEquals($shipment->getData($key), $value, $key);
}
}
}
$shipmentItem = $this->objectManager->get(\Magento\Sales\Model\Order\Shipment\Item::class);
foreach ($result['items'] as $item) {
$shipmentItem->load($item['entity_id']);
foreach ($item as $key => $value) {
$this->assertEquals($shipmentItem->getData($key), $value, $key);
}
}
$shipmentTrack = $this->objectManager->get(\Magento\Sales\Model\Order\Shipment\Track::class);
foreach ($result['tracks'] as $item) {
$shipmentTrack->load($item['entity_id']);
foreach ($item as $key => $value) {
$this->assertEquals($shipmentTrack->getData($key), $value, $key);
}
}
}
}
@@ -0,0 +1,55 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\TestFramework\TestCase\WebapiAbstract;
/**
* Class ShipmentLabelGetTest
*/
class ShipmentLabelGetTest extends WebapiAbstract
{
const RESOURCE_PATH = '/V1/shipment';
const SERVICE_READ_NAME = 'salesShipmentManagementV1';
const SERVICE_VERSION = 'V1';
/**
* @var \Magento\Framework\ObjectManagerInterface
*/
protected $objectManager;
protected function setUp(): void
{
$this->objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
}
/**
* @magentoApiDataFixture Magento/Sales/_files/shipment.php
*/
public function testShipmentGet()
{
/** @var \Magento\Sales\Model\Order\Shipment $shipment */
$shipmentCollection = $this->objectManager->get(
\Magento\Sales\Model\ResourceModel\Order\Shipment\Collection::class
);
$shipment = $shipmentCollection->getFirstItem();
$shipment->setShippingLabel('test_shipping_label');
$shipment->save();
$serviceInfo = [
'rest' => [
'resourcePath' => self::RESOURCE_PATH . '/' . $shipment->getId() . '/label',
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
],
'soap' => [
'service' => self::SERVICE_READ_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_READ_NAME . 'getLabel',
],
];
$result = $this->_webApiCall($serviceInfo, ['id' => $shipment->getId()]);
$this->assertEquals($result, base64_encode('test_shipping_label'));
}
}
@@ -0,0 +1,97 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\TestFramework\TestCase\WebapiAbstract;
/**
* Class ShipmentListTest
*/
class ShipmentListTest extends WebapiAbstract
{
const RESOURCE_PATH = '/V1/shipments';
const SERVICE_READ_NAME = 'salesShipmentRepositoryV1';
const SERVICE_VERSION = 'V1';
/**
* @var \Magento\Framework\ObjectManagerInterface
*/
protected $objectManager;
protected function setUp(): void
{
$this->objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
}
/**
* @magentoApiDataFixture Magento/Sales/_files/shipment_list.php
*/
public function testShipmentList()
{
/** @var \Magento\Framework\Api\SortOrderBuilder $sortOrderBuilder */
$sortOrderBuilder = $this->objectManager->get(
\Magento\Framework\Api\SortOrderBuilder::class
);
/** @var $searchCriteriaBuilder \Magento\Framework\Api\SearchCriteriaBuilder */
$searchCriteriaBuilder = $this->objectManager->create(
\Magento\Framework\Api\SearchCriteriaBuilder::class
);
/** @var $filterBuilder \Magento\Framework\Api\FilterBuilder */
$filterBuilder = $this->objectManager->create(
\Magento\Framework\Api\FilterBuilder::class
);
$filter1 = $filterBuilder
->setField('shipment_status')
->setValue(1)
->setConditionType('eq')
->create();
$filter2 = $filterBuilder
->setField('store_id')
->setValue(1)
->setConditionType('eq')
->create();
$filter3 = $filterBuilder
->setField('shipping_address_id')
->setValue(3)
->setConditionType('eq')
->create();
$sortOrder = $sortOrderBuilder->setField('increment_id')
->setDirection('ASC')
->create();
$searchCriteriaBuilder->addFilters([$filter1, $filter2]);
$searchCriteriaBuilder->addFilters([$filter3]);
$searchCriteriaBuilder->addSortOrder($sortOrder);
$searchCriteriaBuilder->setPageSize(20);
$searchData = $searchCriteriaBuilder->create()->__toArray();
$requestData = ['searchCriteria' => $searchData];
$serviceInfo = [
'rest' => [
'resourcePath' => self::RESOURCE_PATH . '?' . http_build_query($requestData),
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
],
'soap' => [
'service' => self::SERVICE_READ_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_READ_NAME . 'getList',
],
];
$result = $this->_webApiCall($serviceInfo, $requestData);
// TODO Test fails, due to the inability of the framework API to handle data collection
$this->assertArrayHasKey('items', $result);
$this->assertCount(2, $result['items']);
$this->assertArrayHasKey('search_criteria', $result);
$this->assertEquals($searchData, $result['search_criteria']);
$this->assertEquals('100000002', $result['items'][0]['increment_id']);
$this->assertEquals('100000003', $result['items'][1]['increment_id']);
$this->assertEquals(base64_encode('shipping_label_100000002'), $result['items'][0]['shipping_label']);
$this->assertEquals(base64_encode('shipping_label_100000003'), $result['items'][1]['shipping_label']);
}
}
@@ -0,0 +1,120 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\Framework\Api\SearchCriteriaBuilder;
use Magento\Framework\Webapi\Rest\Request;
use Magento\Sales\Api\Data\ShipmentTrackInterface;
use Magento\Sales\Api\ShipmentTrackRepositoryInterface;
use Magento\Sales\Model\Order\Shipment\Track;
use Magento\Sales\Model\Order\Shipment\TrackFactory;
use Magento\Sales\Model\ResourceModel\Order\Shipment\Collection;
use Magento\TestFramework\Helper\Bootstrap;
use Magento\TestFramework\TestCase\WebapiAbstract;
/**
* Class ShipmentRemoveTrackTest
*/
class ShipmentRemoveTrackTest extends WebapiAbstract
{
/**
* Service read name
*/
const SERVICE_READ_NAME = 'salesShipmentTrackRepositoryV1';
/**
* Service version
*/
const SERVICE_VERSION = 'V1';
/**
* Shipment increment id
*/
const SHIPMENT_INCREMENT_ID = '100000001';
/**
* @var \Magento\Framework\ObjectManagerInterface
*/
private $objectManager;
/**
* @inheritdoc
*/
protected function setUp(): void
{
$this->objectManager = Bootstrap::getObjectManager();
}
/**
* Test shipment remove track service
*
* @magentoApiDataFixture Magento/Sales/_files/shipment.php
*/
public function testShipmentRemoveTrack()
{
$shipmentCollection = $this->objectManager->get(Collection::class);
/** @var \Magento\Sales\Model\Order\Shipment $shipment */
$shipment = $shipmentCollection->getFirstItem();
$trackEntity = $this->objectManager->get(TrackFactory::class)
->create(
[
'data' => [
ShipmentTrackInterface::ENTITY_ID => null,
ShipmentTrackInterface::ORDER_ID => $shipment->getOrderId(),
ShipmentTrackInterface::PARENT_ID => $shipment->getId(),
ShipmentTrackInterface::WEIGHT => 20,
ShipmentTrackInterface::QTY => 5,
ShipmentTrackInterface::TRACK_NUMBER => 2,
ShipmentTrackInterface::DESCRIPTION => 'Shipment description',
ShipmentTrackInterface::TITLE => 'Shipment title',
ShipmentTrackInterface::CARRIER_CODE => Track::CUSTOM_CARRIER_CODE,
]
]
);
/** @var ShipmentTrackInterface $trackEntity */
$trackEntity = $this->objectManager->get(ShipmentTrackRepositoryInterface::class)
->save($trackEntity);
$serviceInfo = [
'rest' => [
'resourcePath' => '/V1/shipment/track/' . $trackEntity->getEntityId(),
'httpMethod' => Request::HTTP_METHOD_DELETE,
],
'soap' => [
'service' => self::SERVICE_READ_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_READ_NAME . 'deleteById',
],
];
$result = $this->_webApiCall($serviceInfo, ['id' => $trackEntity->getEntityId()]);
self::assertTrue($result);
$this->assertNoAvailableTrackItems($shipment->getId());
}
/**
* Performs assertion for provided shipment.
*
* @param int $shipmentId
* @return void
*/
private function assertNoAvailableTrackItems($shipmentId)
{
/** @var SearchCriteriaBuilder $searchCriteriaBuilder */
$searchCriteriaBuilder = $this->objectManager->get(SearchCriteriaBuilder::class);
$searchCriteria = $searchCriteriaBuilder->addFilter(ShipmentTrackInterface::PARENT_ID, $shipmentId)
->create();
$items = $this->objectManager->get(ShipmentTrackRepositoryInterface::class)
->getList($searchCriteria)
->getItems();
self::assertEmpty($items);
}
}
@@ -0,0 +1,231 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Service\V1;
use Magento\Sales\Model\Order;
use Magento\Sales\Model\Order\Payment;
use Magento\Sales\Model\Order\Payment\Transaction;
use Magento\TestFramework\TestCase\WebapiAbstract;
/**
* Class TransactionReadTest
*/
class TransactionTest extends WebapiAbstract
{
/**
* Service read name
*/
const SERVICE_READ_NAME = 'salesTransactionRepositoryV1';
/**
* Resource path for REST
*/
const RESOURCE_PATH = '/V1/transactions';
/**
* Service version
*/
const SERVICE_VERSION = 'V1';
/**
* @var \Magento\Framework\ObjectManagerInterface
*/
protected $objectManager;
protected function setUp(): void
{
$this->objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
}
/**
* Tests list of order transactions
*
* @magentoApiDataFixture Magento/Sales/_files/transactions_detailed.php
*/
public function testTransactionGet()
{
/** @var Order $order */
$order = $this->objectManager->create(\Magento\Sales\Model\Order::class);
/**
* @var $transactionRepository \Magento\Sales\Model\Order\Payment\Transaction\Repository
*/
$transactionRepository = \Magento\Sales\Model\Order\Payment\Transaction\Repository::class;
$transactionRepository = $this->objectManager->create($transactionRepository);
$order->loadByIncrementId('100000006');
/** @var Payment $payment */
$payment = $order->getPayment();
/** @var Transaction $transaction */
$transaction = $transactionRepository->getByTransactionId('trx_auth', $payment->getId(), $order->getId());
$childTransactions = $transaction->getChildTransactions();
$childTransaction = reset($childTransactions);
$expectedData = $this->getPreparedTransactionData($transaction);
$childTransactionData = $this->getPreparedTransactionData($childTransaction);
$expectedData['child_transactions'][] = $childTransactionData;
$serviceInfo = [
'rest' => [
'resourcePath' => self::RESOURCE_PATH . '/' . $transaction->getId(),
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
],
'soap' => [
'service' => self::SERVICE_READ_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_READ_NAME . 'get',
],
];
$result = $this->_webApiCall($serviceInfo, ['id' => $transaction->getId()]);
ksort($expectedData);
ksort($result);
$this->assertEquals($expectedData, $result);
}
/**
* Tests list of order transactions
* @magentoApiDataFixture Magento/Sales/_files/transactions_list.php
*/
public function testTransactionList()
{
/** @var Order $order */
$order = $this->objectManager->create(\Magento\Sales\Model\Order::class);
/**
* @var $transactionRepository \Magento\Sales\Model\Order\Payment\Transaction\Repository
*/
$transactionRepository = \Magento\Sales\Model\Order\Payment\Transaction\Repository::class;
$transactionRepository = $this->objectManager->create($transactionRepository);
$order->loadByIncrementId('100000006');
/** @var Payment $payment */
$payment = $order->getPayment();
/** @var Transaction $transaction */
$transaction = $transactionRepository->getByTransactionId('trx_auth', $payment->getId(), $order->getId());
$childTransactions = $transaction->getChildTransactions();
$childTransaction = reset($childTransactions);
/** @var $searchCriteriaBuilder \Magento\Framework\Api\SearchCriteriaBuilder */
$searchCriteriaBuilder = $this->objectManager->create(
\Magento\Framework\Api\SearchCriteriaBuilder::class
);
/** @var $filterBuilder \Magento\Framework\Api\FilterBuilder */
$filterBuilder = $this->objectManager->create(
\Magento\Framework\Api\FilterBuilder::class
);
/** @var \Magento\Framework\Api\SortOrderBuilder $sortOrderBuilder */
$sortOrderBuilder = $this->objectManager->create(
\Magento\Framework\Api\SortOrderBuilder::class
);
$filter1 = $filterBuilder->setField('txn_id')
->setValue('%trx_auth%')
->setConditionType('like')
->create();
$filter2 = $filterBuilder->setField('txn_id')
->setValue('trx_capture')
->setConditionType('eq')
->create();
$filter3 = $filterBuilder->setField('parent_txn_id')
->setValue(null)
->setConditionType('null')
->create();
$filter4 = $filterBuilder->setField('is_closed')
->setValue(0)
->setConditionType('eq')
->create();
$sortOrder = $sortOrderBuilder->setField('parent_id')
->setDirection('ASC')
->create();
$searchCriteriaBuilder->addFilters([$filter1, $filter2]);
$searchCriteriaBuilder->addFilters([$filter3, $filter4]);
$searchCriteriaBuilder->addSortOrder($sortOrder);
$searchCriteriaBuilder->setPageSize(20);
$searchData = $searchCriteriaBuilder->create()->__toArray();
$requestData = ['searchCriteria' => $searchData];
$serviceInfo = [
'rest' => [
'resourcePath' => self::RESOURCE_PATH . '?' . http_build_query($requestData),
'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
],
'soap' => [
'service' => self::SERVICE_READ_NAME,
'serviceVersion' => self::SERVICE_VERSION,
'operation' => self::SERVICE_READ_NAME . 'getList',
],
];
$result = $this->_webApiCall($serviceInfo, $requestData);
$this->assertArrayHasKey('items', $result);
$transactionData = $this->getPreparedTransactionData($transaction);
$childTransactionData = $this->getPreparedTransactionData($childTransaction);
$transactionData['child_transactions'][] = $childTransactionData;
$expectedData = [$transactionData, $childTransactionData];
$this->assertEquals($expectedData, $result['items']);
$this->assertArrayHasKey('search_criteria', $result);
$this->assertEquals($searchData, $result['search_criteria']);
}
/**
* @param Transaction $transaction
* @return array
*/
private function getPreparedTransactionData(Transaction $transaction)
{
$additionalInfo = [];
foreach ($transaction->getAdditionalInformation() as $value) {
$additionalInfo[] = $value;
}
$expectedData = ['transaction_id' => (int)$transaction->getId()];
if ($transaction->getParentId() !== null) {
$expectedData['parent_id'] = (int)$transaction->getParentId();
}
$expectedData = array_merge(
$expectedData,
[
'order_id' => (int)$transaction->getOrderId(),
'payment_id' => (int)$transaction->getPaymentId(),
'txn_id' => $transaction->getTxnId(),
'parent_txn_id' => ($transaction->getParentTxnId() ? (string)$transaction->getParentTxnId() : null),
'txn_type' => $transaction->getTxnType(),
'is_closed' => (int)$transaction->getIsClosed(),
'additional_information' => ['data'],
'created_at' => $transaction->getCreatedAt(),
'child_transactions' => [],
]
);
return $expectedData;
}
/**
* @deprecated
* @return array
*/
public function filtersDataProvider()
{
/** @var $filterBuilder \Magento\Framework\Api\FilterBuilder */
$filterBuilder = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->create(
\Magento\Framework\Api\FilterBuilder::class
);
return [
[
[
$filterBuilder->setField('created_at')->setValue('2020-12-12 00:00:00')
->setConditionType('lteq')->create(),
],
]
];
}
}