graycore / magento2-orders-graphql
A Magento 2 module that adds a fully featured GraphQL orders endpoint.
Fund package maintenance!
graycoreio
Installs: 149
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Type:magento2-module
Requires
- php: >=7.0.0
- magento/framework: *
- magento/module-graph-ql: *
- magento/module-quote: *
- magento/module-sales: *
- magento/module-store: *
Requires (Dev)
- magento/magento-coding-standard: ^5.0
- phpunit/phpunit: ^8.5
- squizlabs/php_codesniffer: ^3.4
README
A Magento 2 module that adds a fully featured GraphQL orders endpoint.
Note that this is scheduled to be obsolete and deprecated in Magento 2.4.1 given that an officially maintained GraphQL order module will be released.
Installation
composer require graycore/magento2-orders-graphql
Usage
Guest Orders
For guest carts, use the graycoreGuestOrders
query and pass in the cart ID as cartId
:
query GetGuestOrders { graycoreGuestOrders(cartId: "dsfg67dsfg65sd6fgs8dhffdgs") { orders { id } } }
Customer Orders
For customer carts, use the graycoreCustomerOrders
query. There is an optional orderNumber
parameter which will return a specific order. Not passing orderNumber
will return all of the authenticated customer's orders. Authenticate the customer according to normal Magento procedures.
query GetCustomerOrders { graycoreCustomerOrders( orderNumber: "0000000001" ) { orders { id } } }
Schema
Refer to the GraphQL schema for documentation about the types available in the queries.