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).
  • 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.