Order.xml

<?xml version="1.0" ?>

<resources xmlns="https://api-platform.com/schema/metadata"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="https://api-platform.com/schema/metadata https://api-platform.com/schema/metadata/metadata-2.0.xsd"
>
    <resource class="%sylius.model.order.class%" shortName="Order">
        <attribute name="normalization_context">
            <attribute name="groups">
                <attribute>admin:order:read</attribute>
            </attribute>
        </attribute>

        <attribute name="validation_groups">sylius</attribute>

        <collectionOperations>
            <collectionOperation name="admin_get">
                <attribute name="method">GET</attribute>
                <attribute name="path">admin/orders</attribute>
            </collectionOperation>

            <collectionOperation name="shop_post">
                <attribute name="method">POST</attribute>
                <attribute name="path">/shop/orders</attribute>
                <attribute name="messenger">input</attribute>
                <attribute name="input">Sylius\Bundle\ApiBundle\Command\Cart\PickupCart</attribute>
                <attribute name="denormalization_context">
                    <attribute name="groups">shop:order:create</attribute>
                </attribute>
                <attribute name="openapi_context">
                    <attribute name="summary">Pickups a new cart. Provided locale code has to be one of available for a particular channel.</attribute>                </attribute>
            </collectionOperation>

            <collectionOperation name="shop_get">
                <attribute name="method">GET</attribute>
                <attribute name="path">/shop/orders</attribute>
                <attribute name="normalization_context">
                    <attribute name="groups">
                        <attribute>shop:order:read</attribute>
                    </attribute>
                </attribute>
            </collectionOperation>
        </collectionOperations>

        <itemOperations>
            <itemOperation name="admin_get">
                <attribute name="method">GET</attribute>
                <attribute name="path">/admin/orders/{tokenValue}</attribute>
            </itemOperation>

            <itemOperation name="shop_get">
                <attribute name="method">GET</attribute>
                <attribute name="path">/shop/orders/{tokenValue}</attribute>
                <attribute name="normalization_context">
                    <attribute name="groups">shop:cart:read</attribute>
                </attribute>
            </itemOperation>

            <itemOperation name="shop_delete">
                <attribute name="method">DELETE</attribute>
                <attribute name="path">/shop/orders/{tokenValue}</attribute>
                <attribute name="openapi_context">
                    <attribute name="summary">Deletes cart</attribute>
                </attribute>
                <attribute name="normalization_context">
                    <attribute name="groups">shop:order:read</attribute>
                </attribute>
            </itemOperation>

            <itemOperation name="admin_cancel">
                <attribute name="method">PATCH</attribute>
                <attribute name="path">/admin/orders/{tokenValue}/cancel</attribute>
                <attribute name="input">false</attribute>
                <attribute name="controller">sylius.api.order_state_machine_transition_applicator:cancel</attribute>
                <attribute name="denormalization_context">
                    <attribute name="groups">admin:order:update</attribute>
                </attribute>
                <attribute name="openapi_context">
                    <attribute name="summary">Cancels Order</attribute>
                </attribute>
            </itemOperation>

            <itemOperation name="shop_add_item">
                <attribute name="method">PATCH</attribute>
                <attribute name="path">/shop/orders/{tokenValue}/items</attribute>
                <attribute name="messenger">input</attribute>
                <attribute name="input">Setono\SyliusGiftCardPlugin\Api\Command\AddItemToCart</attribute>
                <attribute name="normalization_context">
                    <attribute name="groups">shop:cart:read</attribute>
                </attribute>
                <attribute name="denormalization_context">
                    <attribute name="groups">shop:cart:add_item</attribute>
                </attribute>
                <attribute name="openapi_context">
                    <attribute name="summary">Adds Item to cart</attribute>
                </attribute>
            </itemOperation>

            <itemOperation name="shop_address">
                <attribute name="method">PATCH</attribute>
                <attribute name="path">/shop/orders/{tokenValue}/address</attribute>
                <attribute name="messenger">input</attribute>
                <attribute name="input">Sylius\Bundle\ApiBundle\Command\Checkout\AddressOrder</attribute>
                <attribute name="denormalization_context">
                    <attribute name="groups">shop:cart:address</attribute>
                </attribute>
                <attribute name="normalization_context">
                    <attribute name="groups">shop:cart:read</attribute>
                </attribute>
                <attribute name="openapi_context">
                    <attribute name="summary">Addresses cart to given location, logged in Customer does not have to provide an email</attribute>
                </attribute>
            </itemOperation>

            <itemOperation name="shop_select_shipping_method">
                <attribute name="method">PATCH</attribute>
                <attribute name="validation_groups">
                    <attribute>sylius</attribute>
                </attribute>
                <attribute name="path">/shop/orders/{tokenValue}/shipments/{shipmentId}</attribute>
                <attribute name="messenger">input</attribute>
                <attribute name="input">Sylius\Bundle\ApiBundle\Command\Checkout\ChooseShippingMethod</attribute>
                <attribute name="denormalization_context">
                    <attribute name="groups">shop:cart:select_shipping_method</attribute>
                </attribute>
                <attribute name="normalization_context">
                    <attribute name="groups">shop:cart:read</attribute>
                </attribute>
                <attribute name="openapi_context">
                    <attribute name="summary">Selects shipping methods for particular shipment</attribute>
                    <attribute name="parameters">
                        <attribute>
                            <attribute name="name">tokenValue</attribute>
                            <attribute name="in">path</attribute>
                            <attribute name="required">true</attribute>
                            <attribute name="schema">
                                <attribute name="type">string</attribute>
                            </attribute>
                        </attribute>
                        <attribute>
                            <attribute name="name">shipmentId</attribute>
                            <attribute name="in">path</attribute>
                            <attribute name="required">true</attribute>
                            <attribute name="schema">
                                <attribute name="type">string</attribute>
                            </attribute>
                        </attribute>
                    </attribute>
                </attribute>
            </itemOperation>

            <itemOperation name="shop_select_payment_method">
                <attribute name="method">PATCH</attribute>
                <attribute name="path">/shop/orders/{tokenValue}/payments/{paymentId}</attribute>
                <attribute name="messenger">input</attribute>
                <attribute name="input">Sylius\Bundle\ApiBundle\Command\Checkout\ChoosePaymentMethod</attribute>
                <attribute name="denormalization_context">
                    <attribute name="groups">shop:cart:select_payment_method</attribute>
                </attribute>
                <attribute name="normalization_context">
                    <attribute name="groups">shop:cart:read</attribute>
                </attribute>
                <attribute name="openapi_context">
                    <attribute name="summary">Selects payment methods for particular payment</attribute>
                    <attribute name="parameters">
                        <attribute>
                            <attribute name="name">tokenValue</attribute>
                            <attribute name="in">path</attribute>
                            <attribute name="required">true</attribute>
                            <attribute name="schema">
                                <attribute name="type">string</attribute>
                            </attribute>
                        </attribute>
                        <attribute>
                            <attribute name="name">paymentId</attribute>
                            <attribute name="in">path</attribute>
                            <attribute name="required">true</attribute>
                            <attribute name="schema">
                                <attribute name="type">string</attribute>
                            </attribute>
                        </attribute>
                    </attribute>
                </attribute>
            </itemOperation>

            <itemOperation name="shop_account_change_payment_method">
                <attribute name="method">PATCH</attribute>
                <attribute name="path">/shop/account/orders/{tokenValue}/payments/{paymentId}</attribute>
                <attribute name="messenger">input</attribute>
                <attribute name="input">Sylius\Bundle\ApiBundle\Command\Account\ChangePaymentMethod</attribute>
                <attribute name="denormalization_context">
                    <attribute name="groups">shop:order:account:change_payment_method</attribute>
                </attribute>
                <attribute name="normalization_context">
                    <attribute name="groups">shop:order:account:read</attribute>
                </attribute>
                <attribute name="openapi_context">
                    <attribute name="summary">Change the payment method as logged shop user</attribute>
                    <attribute name="parameters">
                        <attribute>
                            <attribute name="name">tokenValue</attribute>
                            <attribute name="in">path</attribute>
                            <attribute name="required">true</attribute>
                            <attribute name="schema">
                                <attribute name="type">string</attribute>
                            </attribute>
                        </attribute>
                        <attribute>
                            <attribute name="name">paymentId</attribute>
                            <attribute name="in">path</attribute>
                            <attribute name="required">true</attribute>
                            <attribute name="schema">
                                <attribute name="type">string</attribute>
                            </attribute>
                        </attribute>
                    </attribute>
                </attribute>
            </itemOperation>

            <itemOperation name="get_configuration">
                <attribute name="method">GET</attribute>
                <attribute name="controller">sylius.api.get_configuration_action</attribute>
                <attribute name="path">/shop/orders/{tokenValue}/payments/{paymentId}/configuration</attribute>
                <attribute name="openapi_context">
                    <attribute name="summary">Retrieve payment method configuration</attribute>
                    <attribute name="parameters">
                        <attribute>
                            <attribute name="name">tokenValue</attribute>
                            <attribute name="in">path</attribute>
                            <attribute name="required">true</attribute>
                            <attribute name="schema">
                                <attribute name="type">string</attribute>
                            </attribute>
                        </attribute>
                        <attribute>
                            <attribute name="name">paymentId</attribute>
                            <attribute name="in">path</attribute>
                            <attribute name="required">true</attribute>
                            <attribute name="schema">
                                <attribute name="type">string</attribute>
                            </attribute>
                        </attribute>
                    </attribute>
                </attribute>
            </itemOperation>

            <itemOperation name="shop_complete">
                <attribute name="method">PATCH</attribute>
                <attribute name="path">/shop/orders/{tokenValue}/complete</attribute>
                <attribute name="validation_groups">
                    <attribute>sylius</attribute>
                    <attribute>sylius_checkout_complete</attribute>
                </attribute>
                <attribute name="messenger">input</attribute>
                <attribute name="input">Sylius\Bundle\ApiBundle\Command\Checkout\CompleteOrder</attribute>
                <attribute name="denormalization_context">
                    <attribute name="groups">shop:cart:complete</attribute>
                </attribute>
                <attribute name="normalization_context">
                    <attribute name="groups">shop:cart:read</attribute>
                </attribute>
                <attribute name="openapi_context">
                    <attribute name="summary">Completes checkout</attribute>
                </attribute>
            </itemOperation>

            <itemOperation name="shop_remove_item">
                <attribute name="method">DELETE</attribute>
                <attribute name="path">/shop/orders/{tokenValue}/items/{itemId}</attribute>
                <attribute name="messenger">input</attribute>
                <attribute name="controller">Sylius\Bundle\ApiBundle\Controller\DeleteOrderItemAction</attribute>
                <attribute name="write">false</attribute>
                <attribute name="denormalization_context">
                    <attribute name="groups">shop:cart:remove_item</attribute>
                </attribute>
                <attribute name="openapi_context">
                    <attribute name="parameters">
                        <attribute>
                            <attribute name="name">tokenValue</attribute>
                            <attribute name="in">path</attribute>
                            <attribute name="required">true</attribute>
                            <attribute name="schema">
                                <attribute name="type">string</attribute>
                            </attribute>
                        </attribute>
                        <attribute>
                            <attribute name="name">itemId</attribute>
                            <attribute name="in">path</attribute>
                            <attribute name="required">true</attribute>
                            <attribute name="schema">
                                <attribute name="type">string</attribute>
                            </attribute>
                        </attribute>
                    </attribute>
                </attribute>
            </itemOperation>

            <itemOperation name="shop_change_quantity">
                <attribute name="method">PATCH</attribute>
                <attribute name="path">/shop/orders/{tokenValue}/items/{orderItemId}</attribute>
                <attribute name="messenger">input</attribute>
                <attribute name="input">Sylius\Bundle\ApiBundle\Command\Cart\ChangeItemQuantityInCart</attribute>
                <attribute name="denormalization_context">
                    <attribute name="groups">shop:cart:change_quantity</attribute>
                </attribute>
                <attribute name="openapi_context">
                    <attribute name="summary">Changes quantity of order item</attribute>
                    <attribute name="parameters">
                        <attribute>
                            <attribute name="name">tokenValue</attribute>
                            <attribute name="in">path</attribute>
                            <attribute name="required">true</attribute>
                            <attribute name="schema">
                                <attribute name="type">string</attribute>
                            </attribute>
                        </attribute>
                        <attribute>
                            <attribute name="name">orderItemId</attribute>
                            <attribute name="in">path</attribute>
                            <attribute name="required">true</attribute>
                            <attribute name="schema">
                                <attribute name="type">string</attribute>
                            </attribute>
                        </attribute>
                    </attribute>
                </attribute>
            </itemOperation>

            <itemOperation name="shop_apply_coupon">
                <attribute name="method">PATCH</attribute>
                <attribute name="path">/shop/orders/{tokenValue}/apply-coupon</attribute>
                <attribute name="messenger">input</attribute>
                <attribute name="input">Sylius\Bundle\ApiBundle\Command\Cart\ApplyCouponToCart</attribute>
                <attribute name="denormalization_context">
                    <attribute name="groups">shop:cart:apply_coupon</attribute>
                </attribute>
                <attribute name="openapi_context">
                    <attribute name="summary">Applies coupon to cart</attribute>
                </attribute>
            </itemOperation>

            <itemOperation name="shop_put">
                <attribute name="method">PUT</attribute>
                <attribute name="path">/shop/orders/{tokenValue}</attribute>
                <attribute name="denormalization_context">
                    <attribute name="groups">admin:cart:update</attribute>
                </attribute>
            </itemOperation>
        </itemOperations>

        <subresourceOperations>
            <subresourceOperation name="items_get_subresource">
                <attribute name="method">GET</attribute>
                <attribute name="path">/shop/orders/{tokenValue}/items</attribute>
            </subresourceOperation>

            <subresourceOperation name="shipments_get_subresource">
                <attribute name="method">GET</attribute>
                <attribute name="path">/admin/orders/{tokenValue}/shipments</attribute>
            </subresourceOperation>

            <subresourceOperation name="payments_get_subresource">
                <attribute name="method">GET</attribute>
                <attribute name="path">/admin/orders/{tokenValue}/payments</attribute>
            </subresourceOperation>

            <subresourceOperation name="adjustments_get_subresource">
                <attribute name="method">GET</attribute>
                <attribute name="path">/shop/orders/{tokenValue}/adjustments</attribute>
            </subresourceOperation>

            <subresourceOperation name="payments_methods_get_subresource">
                <attribute name="method">GET</attribute>
                <attribute name="path">/shop/orders/{tokenValue}/payments/{payments}/methods</attribute>
            </subresourceOperation>

            <subresourceOperation name="shipments_methods_get_subresource">
                <attribute name="method">GET</attribute>
                <attribute name="path">/shop/orders/{tokenValue}/shipments/{shipments}/methods</attribute>
            </subresourceOperation>

            <subresourceOperation name="items_adjustments_get_subresource">
                <attribute name="method">GET</attribute>
                <attribute name="path">/shop/orders/{tokenValue}/items/{items}/adjustments</attribute>
            </subresourceOperation>
        </subresourceOperations>

        <property name="id" identifier="false" writable="false" />
        <property name="number" identifier="false" writable="false" />
        <property name="tokenValue" identifier="true" writable="false" />
        <property name="channel" writable="false" />
        <property name="customer" writable="false" />
        <property name="shipments" writable="false">
            <subresource resourceClass="%sylius.model.shipment.class%" />
        </property>
        <property name="payments" writable="false">
            <subresource resourceClass="%sylius.model.payment.class%" />
        </property>
        <property name="state" writable="false" />
        <property name="paymentState" writable="false" />
        <property name="shippingState" writable="false" />
        <property name="total" writable="false" />
        <property name="orderPromotionTotal" writable="false" />
        <property name="items" readable="true" writable="true">
            <subresource resourceClass="%sylius.model.order_item.class%" />
        </property>
        <property name="notes" writable="true" />
        <property name="itemsTotal" readable="true" />
        <property name="taxTotal" readable="true"/>
        <property name="adjustments" writable="false">
            <subresource resourceClass="%sylius.model.adjustment.class%" />
        </property>
        <property name="billingAddress" writable="false" />
        <property name="shippingAddress" writable="false" />
        <property name="localeCode" writable="true" />
    </resource>
</resources>