Help

1 min read

Magento Api Clients

Poq.Backend.Magento.Client namespace provides Contracts and Clients that allow quick usage of Magento API.

Contracts

Contain all necessary contracts to use Magento clients effectively.

Clients

List of Available Clients

AccountClient

Provides creation of user account in Magento, accessing user account details and etc

Methods

  • RegisterAsync creates customer account with provided parameters.

  • LoginAsync loges customer in.

  • GetCurrentUserDataAsync returns customer account details.

  • UpdateUserDataAsync updates customer account details.

CartClient

Provides cart manipulation capabilities

Methods
  • GetGuestCartAsync returns guest cart.
  • CreateGuestCartAsync creates a guest cart.
  • CreateUserCartFromGuestCartAsync creates new guest cart from existing guest cart.
  • AddGuestCartItemAsync adds an item to guest cart.
  • UpdateGuestCartItemAsync updates item in the guest cart.
  • RemoveGuestCartItemAsync removes item from the guest cart.
  • CreateRegisteredUserCartAsync creates cart for the logged in user.
  • GetRegisteredUserCartAsync returns cart for the logged in user.
  • AddRegisteredCartItemAsync adds item to the logged in user cart.
  • UpdateRegisteredCartItemAsync updates item in the logged in user cart
  • RemoveRegisteredCartItemAsync removes item from the logged in user cart.

CategoryClient

Provides methods to retrieve categories

Methods
  • GetCategoriesAsync returns categories.

ConfigurableProductsClient

Provides methods to retrieve configurable products

Methods
  • GetProductChildrenAsync returns simple products of the configurable prodduct.

ProductAttributesClient

Provides methods to retrieve product attributes

Methods
  • GetAttributeAsync returns product attribute by attribute code.
  • GetProductAttributesAsync returns all product attributes.

ProductRenderInfoClient

Provides methods to retrieve render info

Methods
  • GetProductRenderInfoAsync returns product render info by entity ids.
  • GetProductRenderInfoBySkusAsync returns product render info by skus.

ProductStockStatusClient

Provides methods to retrieve stock statuses

Methods
  • GetProductStockAsync returns product stock info.

SearchClient

Provides methods to retrieve search results

Methods
  • SearchAsync returns search result from /search endpoint.
  • GetProductsByAttributeAsync searches product by attribute using /products endpoint.
  • GetProductsBySkusAsync searches product by skus using /products endpoint.
  • GetProductsByEntityIdsAsync searches product by entity ids using /products endpoint.