Skip to content
STOQDevelopers
Open STOQ

Resource

View as Markdown

Back in Stock

API v1 is the older API. It still works, but new integrations should use API v2. Migrating from v1 to v2

The back in stock object

Attributes

  • idstring

    Unique identifier for the intent

  • blocked_atstring, nullable

    Timestamp when the intent was blocked from sending

  • channelstring

    Communication channel used for notifications (e.g., Email, SMS)

  • emailstring

    Customer's email address for notifications

  • notified_atstring, nullable

    Timestamp of the notification sent

  • optin_confirmedboolean

    Whether the customer has confirmed their GDPR opt-in for notifications

  • phonestring

    Customer's phone number for SMS notifications

  • quantityinteger

    Requested quantity of the product when back in stock

  • sent_notifications_countinteger

    Number of notifications sent for this intent

  • sourcestring
    Example: api
  • typestring

    Type of the intent (e.g., restock, wishlist_reminder)

  • unsubscribed_atstring, nullable

    Timestamp when the customer unsubscribed from notifications

  • created_atstring

    Timestamp when the intent was created

  • updated_atstring

    Timestamp when the intent was last updated

  • customer_idstring

    Unique identifier for the customer

  • intent_trigger_idstring, nullable

    Identifier for the trigger that created this intent

  • product_variant_idstring, nullable

    Internal product variant identifier

  • shop_idstring

    Unique identifier for the shop

  • shopify_inventory_item_idinteger, nullable

    Shopify's inventory item identifier

  • shopify_market_idinteger, nullable

    Shopify's market identifier for multi-market stores

  • shopify_product_idinteger, nullable

    Shopify's product identifier

  • shopify_variant_idinteger, nullable

    Shopify's variant identifier

  • customer_namestring, nullable

    Customer's full name

  • contactstring, nullable

    Customer's contact information

  • customer_unsubscribed_atstring, nullable

    Timestamp when the customer unsubscribed from all notifications

  • accepts_marketingboolean, nullable

    Whether the customer has opted in to receive marketing communications

  • notifications_countinteger, nullable

    Total number of notifications sent for this intent

Endpoints
The back in stock object
{
  "id": "8f3c2b1a-7d4e-4c2a-9f10-2b3c4d5e6f70",
  "channel": "email",
  "email": "shopper@example.com",
  "phone": null,
  "quantity": 1,
  "notified_at": null,
  "optin_confirmed": true,
  "source": "api",
  "type": "restock",
  "sent_notifications_count": 0,
  "created_at": "2026-06-20T14:30:00Z",
  "updated_at": "2026-06-20T14:30:00Z",
  "customer_id": "c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
  "shop_id": "a1b2c3d4-5e6f-7081-92a3-b4c5d6e7f809",
  "shopify_product_id": 7891234567890,
  "shopify_variant_id": 43900910010503,
  "accepts_marketing": true
}