Skip to content

Get tagging settings

API v2 is in public beta: endpoints and fields can change before general availability. See the changelog

GET/back_in_stock/settings/tagging

Costs 1 rate-limit point · Rate limits

Read back-in-stock order tagging settings.

While order_tags.enabled is true, STOQ adds order_tags.tag in Shopify to each order it attributes to a back-in-stock alert with medium or high confidence. An order is tagged once, so changing the tag later leaves orders already tagged as they are. Change these with PATCH /back_in_stock/settings/tagging.

Also searched asget tagging settingsshow order taggingview order tagwhat tag is applied to recovered orderstagging

Returns

  • order_tagsobject
    Show 2 child attributesHide child attributes
    • enabledboolean
      Example: true
    • tagstring
      Example: string

Errors

404
not_found

The path is valid but nothing with that id exists in this store.

422
validation_failed

The request failed validation.

Any request can also fail with auth_invalid (401) or rate_limited (429).

Every error has the same shape: see Errors and the list of error codes.

GET/back_in_stock/settings/tagging
curl "https://app.stoqapp.com/api/v2/external/back_in_stock/settings/tagging" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "order_tags": {
    "enabled": true,
    "tag": "string"
  }
}