3 min read
Shopify Api Clients
Poq.Backend.Shopify.Client namespace provides Contracts and Clients that allow quick usage of Shopify API.
Contain all necessary contracts to use Shopify clients effectively.
Provides creation of user account in Shopify, accessing user account details, accessing user orders, obtain user order by id. It uses
ShopifyClientConfiguration.StoreFrontAccessToken to access Shopify Storefront Graphql API
CreateAccountAsynccreates customer account with provided parameters.
UpdateAccountAsyncupdates customer account. Requires customer access token.
GetAccountDetailsAsyncreturns customer account details. Requires customer access token.
GetAccountOrdersAsyncreturns customer orders.
GetAccountOrderAsyncreturns customer order details.
DeleteAccountAsyncmarks customer account as deleted.
Provides CRUD operation for user addresses.
CreateAddressAsynccreates customer address
UpdateAddressAsyncupdates customer address
DeleteAddressAsyncdeletes customer address
ListAddressesAsyncreturns list of customer addresses
SetDefaultAddressAsyncsets default customer address
GetAddressAsyncreturns address details
Provides CRUD operations for carts. It uses Shopify Graphql API to manipulate shopify carts.
CartBuyerIdentityUpdateAsyncupdate buyer identity of a cart. (connects certain customer to cart)
CartDiscountCodesUpdateAsyncadd, remove, update discount codes applied to the cart
CartNoteUpdateAsyncadd, remove, update cart note
CartAttributesUpdateAsyncadd, remove, update cart attributes (supports customizations)
CartLinesAddAsyncadd cart items
CartLinesRemoveAsyncremove cart item
CartLinesUpdateAsyncupdate cart item
GetCartAsyncreturns cart by its id
GetRawCartResponseAsyncreturns HttpResponseMessage received from getCart request
Provides creation of order with list of products inside.
CreateCheckoutAsynccreates shopify checkout with specified items and currencies.
AssociateCustomerToCheckoutAsyncassociates customer to shopify checkout. Resolves registered users access to shopify checkout.
This client is intended to support work with custom and smart collections defined in shopify administration.
GetCustomCollectionsAsyncobtains custom collections from Shopify Admin API
GetUpdatedCustomCollectionsAsyncobtains custom collections updated after specific data from Shopify Admin API
GetSmartCollectionsAsyncobtains smart collections from Shopify Admin API
GetUpdatedSmartCollectionsAsyncobtains smart collections updated after specific data from Shopify Admin API
GetCollectsAsyncobtains connections between product and collection from Shopify Admin API
GetCollectsByCollectionAsyncobtains products connections for specific collection from Shopify Admin API
GetCollectionsAsyncobtains collections matching search criteria(or all if no criteria is provided) from Shopify Graphql API
GetCollectionsAsyncoverload of the method above that allows extending Graphql query with additional or custom fields and usage of custom contract
Provides login, logout, token renewal operations.
GetTokenAsyncobtains access token for registered user(login).
TokenRenewAsyncrenews customer access token
LogoutAsyncdeletes customer access token
Provides information for physical stores defined in Shopify administration
GetLocationsAsyncobtains all locations defined in administration. Uses Shopify Admin Graphql API
Provides information for metafields defined in Shopify administration. Uses Shopify Admin Graphql API.
SetMetafieldAsyncset metafield for object.
GetMetafieldAsyncget metafield for object.
GetMetafieldsAsyncget all metafields for object.
When custom code is added to shopify site this client can obtain entire navigation tree defined in shopify administration. This client is used when building category tree from feed file.
GetNavigationLayoutAsyncobtains navigation menu from shopify using custom poq template page.
GetNavigationLayoutAsyncoverload available to obtain navigation from development stores. (Shopify development stores require password to access all web pages)
Provides listing all products, get product by collectionId, get products updated after certain date. This client is used to obtain products information and generate feed file.
GetProductsByCollectionAsyncobtains product in collection from Shopify Admin Rest API
GetUpdatedProductsAsyncobtains products updated after specific date from Shopify Admin Rest API
GetUpdatedProductsByCollectionAsyncobtains products in collection updated after specific date from Shopify Admin Rest API
GetProductsAsyncobtains all products from Shopify Admin Rest API.
GetProductsByCollectionIdAsyncobtains products in collection from Shopify Admin Rest API
GetProductsByIdsAsyncobtains products by their ids from Shopify Storefront Graphql API
GetProductsByIdsAsyncoverload of the method above that allows extending Graphql query with additional or custom fields and usage of custom contract
GetProductsByVariantIdsAsyncobtains products by variant ids from Shopify Storefront Graphql API
GetProductsByVariantIdsAsyncoverload of the method above that allows extending Graphql query with additional or custom fields and usage of custom contract
Provides methods to search in shopify inventory by several criteria
SearchAsyncsearches for products by keyword, price range and availability. Uses Shopify Storefront Graphql API
SearchAsyncoverload that allows extending Graphql query with additional or custom fields and usage of custom contract
SearchInCollectionAsyncsearches for products in certain collection by price range, availability and options filter(size, color). Uses Shopify Storefront Graphql API
SearchInCollectionAsyncoverload that allows extending Graphql query with additional or custom fields and usage of custom contract
GetCollectionFiltersAsyncobtains available filters for certain collection. Uses Shopify Storefront Graphql API
SearchByBarcodeAsyncspecific search query to search by product barcode in Shopify Storefront Graphql API.
SearchByBarcodeAsyncoverload that allows extending Graphql query with additional or custom fields and usage of custom contract