Poq Commerce Developer Documentation

website·Indexed 34 days ago

https://docs.poqcommerce.com/

Developer resources for Poq Commerce, featuring SDKs for .NET and Node.js to simplify BFC implementation. Includes integration guides and specialized SDKs for e-commerce platforms including Shopify, Magento, Salesforce Commerce Cloud (SFCC) via OCAPI, and Algolia.

Tokens
194.1K
Snippets
664
Records
1.6K
Agent score
52%

What's inside Poq Commerce

  1. Overview of Poq NodeJS SDK requirements and access

    The Poq NodeJS SDK provides Contracts, Clients, and Services to simplify integration between Poq mobile clients and the Poq platform or 3rd party platforms (e.g., Salesforce).

    Technical Requirements:

    • Supported NodeJS version: v14 LTS.
    • Written in TypeScript (supports typings), but compatible with pure JavaScript projects.

    Access: Packages are hosted in a private NPM Poq Organization repository. Developers must obtain credentials via support@poqcommerce.com before installation.

  2. Overview of the Poq SFCC SDK

    The Poq SFCC SDK provides the necessary contracts, clients, and services to integrate the Poq Platform with the SFCC OCAPI Shop API. The SDK is organized into three primary namespaces:

    • Ocapi: Contains OCAPI Contracts and Clients for interacting with the Shop API.
    • Integration: Contains specific contracts, services, extensions, and converters for Poq BFC integration.
    • Adapter: Contains converters used to map OCAPI Contracts to Poq Contracts.
  3. Overview of Android PoqSDK UI components

    The Android PoqSDK provides a set of customizable UI components designed for eCommerce patterns. These components use App Styling internally to adapt to the application's style. Available components include buttons (AddToCartButton, AddToWishlistView), product displays (ProductCardView, ProductCarouselView, ProductImageView), feedback screens (EmptyScreen, ErrorScreen, UpdateScreen), and utility views (CustomDialog, CustomSnackBar, InputFormFields, PriceView, TextLink, WebViewLayout).
  4. Overview of Stores SDK features

    The Stores SDK provides a suite of tools for customer store-related actions. Available feature SDKs include: Store Finder, Store Availability, BOPIS (Buy Online, Pick Up In Store), BOPIS Multi-shipment, and In-Store Mode. These features are bundled within the Stores component module.
  5. Overview of Poq BigCommerce SDK

    The Poq BigCommerce SDK provides contracts, clients, and services to integrate the Poq Platform with the BigCommerce API. It is organized into two primary namespaces: Client (containing contracts and clients for the BigCommerce API) and Services (containing Poq-specific services). Note that the SDK does not currently cover the entire BigCommerce API.
  6. Overview of Poq app payment flow

    Poq apps handle customer payments by loading the website's payment page within a native webview. This ensures a seamless transition between the native app experience and the web-based checkout. The integration consists of two primary phases:

    1. Cart Transfer Phase: The process of moving the customer's cart contents from the app to the webview. This is triggered when a user taps 'Checkout', calling the Cart Transfer API to request the payment page and load the corresponding URL in the app.
    2. Web Checkout Phase: The actual payment process occurring on the website. This phase relies on the Poq JS Bridge (a JavaScript snippet added to the website's HTML) to maintain the connection between the web page and the app. Once the order is complete, the bridge sends a message to the app to close the webview.
  7. Overview of Poq.Sfcc.Ocapi for SFCC Shop API

    The Poq.Sfcc.Ocapi namespace provides a set of Contracts, Clients, and Extensions designed to simplify the usage of the Salesforce Commerce Cloud (SFCC) OCAPI Shop API. It allows for customizations by extending provided contract classes.
  8. Overview of the Poq NodeJS SDK

    The Poq NodeJS SDK provides a set of Contracts, Clients, and Services designed to simplify the integration process between Poq mobile clients and the Poq platform, as well as third-party platforms such as Salesforce.
  9. Overview of PoqFirebase integration

    The PoqFirebase integration wraps the Firebase SDK to provide essential services including Google Analytics, Performance Monitoring, App Distribution, and Crashlytics. Additionally, it is used to minify share URLs when sharing products within the app.
  10. Overview of Dynamic Content SDK for Android

    The Dynamic Content SDK allows developers to render API-driven UI components and deliver personalized content to users based on the provided DynamicContentUser data. The SDK is integrated via the platform module and consists of a Component module and a Feature module.
  11. Overview of Firebase Dynamic Links in Poq

    Dynamic Links are created using Google Firebase to provide deep linking to specific screens within a Poq app. They handle routing based on the user's environment: if the app is installed, the user is taken to a specific screen; if not, they are directed to the App Store, Google Play Store, or a relevant page on the e-commerce website. Firebase also provides tracking for these links to measure app marketing campaign attribution.