Point of Sale API Release Notes

Use Point of Sale (POS) APIs, Service Provider Interfaces (SPIs), and webhooks to extend your retail operations.

  • To learn about using POS APIs, see the Guides.
  • To browse the API endpoints, use the left navigation. POS APIs are broken into three main groups: APIs, SPIs, and webhooks.
  • To download the full specification, see POS API (Full Specification).

  • Fiscal SPI: New SPI for fiscal integration operations. This SPI enables POS to delegate fiscal operations (SALE, RETURN, LOGIN, LOGOUT, etc.) to a merchant-provided SI connector and includes three endpoints:

    • Fiscal Health Check SPI: Verify fiscal middleware/service availability before processing operations.
    • Fiscal Control Transaction SPI: Handle control transactions such as LOGIN, LOGOUT, ABORT_TRANSACTION, CASH_IN, CASH_OUT, STORE_CLOSE, ZERO_RECEIPT, and DELETE_CART_ITEM.
    • Fiscal Transaction SPI: Handle fiscal transactions for SALE, RETURN, EXCHANGE, and DUPLICATE_PRINT operations.
    • Configure in CMS under Store Management | Integration | Custom API Connectors with API Key FISCAL_SERVICE.

  • Visual Search SPI: New SPI for visual product search that uses external image recognition providers. This SPI enables store associates to search products by photographing them with the POS device camera and includes two endpoints:

    • Visual Search API (POST /products/upload): Uploads an image for visual product search using multipart/form-data. Maps to VISUAL_SEARCH_UPLOAD connector. Required.
    • Product Filter API (POST /products): Filters, sorts, or paginates visual search results using JSON body with searchId. Maps to VISUAL_SEARCH connector. Optional - only required if supporting pagination, filtering, or sorting.
    • Configure in CMS under Store Management | Integration | Custom API Connectors with API Keys VISUAL_SEARCH_UPLOAD and VISUAL_SEARCH.
    • Enable in Modules | Search | Visual Search to show camera icon in Retail Cloud POS.

  • Wishlist SPI: New SPI to perform wishlist operations via a customer-managed provider adapter. This SPI enables retailers to integrate any wishlist provider without Retail Cloud engineering involvement and includes one endpoint with three operations:

    • Get Customer Wishlist (GET): Retrieves customer wishlist as a list of product IDs.
    • Add Products to Wishlist (POST): Adds one or more products to customer wishlist. Supports bulk operations.
    • Remove Product from Wishlist (DELETE): Removes a product from customer wishlist using query parameter.
    • The API returns product IDs only; POS enriches them with full product details from Solr.
    • Configure in CMS under Store Management | Integration | Custom API Connectors with API Key WISHLIST.
  • Fulfillment Order API: New cancellation endpoints added:
    • Cancel BOFIS Items (POST /merchant/v1/sa/fulfillment/orders/{bofisOrderId}/stores/{storeId}/bofis/cancel): Cancel BOFIS (Buy Online, Fulfill In Store) items.
    • Cancel ROPIS Items (POST /merchant/v1/sa/fulfillment/orders/{orderId}/stores/{storeId}/ropis/cancel): Cancel ROPIS (Reserve Online, Pick In Store) items.
  • Gift Card SPI: New SPI for gift card operations including balance check, activation, adding funds, redemption, and void/reversal operations. Configure in CMS under Store Management | Integrations | Custom Connectors with API Key GIFT_CARD_SERVICE.
  • Warranty SPI: New SPI for warranty eligibility checks. Implement this endpoint to retrieve eligible warranty products for merchandise items in the cart. Configure in CMS with API Key WARRANTY_LOOKUP.
  • Quote SPI: New SPI for quote management operations.
  • Promotion Events Webhook: New webhook for promotion event notifications.
  • Merchant API endpoints now document v1 as the only supported version.
  • Store Group Management API: Request bodies are now documented.
  • Clienteling SPI (Create/Update Customer):
    • addressList deprecated in requests only (still returned in responses).
    • customerLoyaltyProfile field deprecated from spec (use loyaltyProfile instead).
  • Customer Profile and Wallet: New fields added to support card-on-file and payment imprint functionality.