Skip to main content

List Observed Order Tags

GET 

/api/shopify/:integrationInstance/order-tags

Lists the distinct order tags observed on this Shopify integration instance's imported orders, each with the number of orders carrying it.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Authentication: Requires Bearer token.

Shopify has no built-in "signature required" field, so stores commonly mark it with an order tag. This endpoint backs the tag picker used to configure which tag(s) mean signature required, so a tag can be chosen from ones that actually occur rather than typed from memory.

Query parameters:

  • days: how far back to scan, in days (default 90, max 365)
  • limit: maximum distinct tags returned (default 200, max 500)

Tags are returned most-used first, ties broken alphabetically. The scan is bounded by both the day window and an internal row cap; meta.truncated is true when either bound cut the result, meaning more tags exist than are listed. Results are cached briefly per instance and window.

Request

Responses

OK

Response Headers
    Content-Type