DOCSEARCHbyAlgolia
Submit Docs

Jane API Reference

website·Indexed 35 days ago

https://dm-sdk-docs.iheartjane.com/

API reference documentation for Jane, including OpenAPI specifications for the DM SDK and Roots/partner APIs.

Tokens
514
Snippets
0
Records
6
Agent score
3%

What's inside Jane

  1. Overview of Jane API Reference and SDKs

    The Jane API ecosystem is divided into several specialized APIs for different integration needs:

    • DM SDK: Focuses on merchandising decisions (placements, faceted search, product lookups) and event tracking for attribution (sessions, impressions, clicks, conversions).
    • Jane Roots APIs: Provides read-only storefront menu data, operational data for Roots-powered storefronts (orders, delivery status, banners), and user-specific operations for logged-in shoppers (favorites, account details).
    • Partner APIs: Specialized endpoints for Feed Partners, Menu Feed Partners, and Store Operator Partners, typically requiring OAuth tokens for access to stores, carts, and curbside pickup settings.

  2. Manage shopper carts with Carts API V1

    The Carts API V1 is used to build and manage a shopper's cart. Key capabilities include adding and removing items, clearing the cart, obtaining price quotes, checking store checkout requirements and reservation slots, and uploading cart images.

  4. Manage storefront operations with Jane Roots Store Operations API V1

    The Jane Roots Store Operations API V1 provides operational data for Jane Roots-powered storefronts. This includes managing store and menu product records, carts, orders, delivery status, custom labels, specials, and banners.

  5. Perform user operations with Jane Roots External User API V1

    The Jane Roots External User API V1 allows operations on behalf of a logged-in shopper. This includes managing their specific cart and orders, handling product favorites, managing product review upvotes or reports, and accessing account details.

  6. Integrate with Jane Partner APIs

    Jane provides several partner-specific APIs that generally require OAuth tokens for authentication:

    • Feed Partner API V1: Accesses stores, store menu products, and carts via /external/v1/feed_partner/*.
    • Menu Feed Partner API V1: Accesses store menu products and curbside pickup settings via /external/v1/menu_feed_partner/*.
    • Store Operator Partner API V1: Accesses carts, store menu products, and curbside pickup/arrival via /external/v1/store_operator_partner/*.