Skip to content

Reinstate product

Sells a discontinued product again.

Needs the product:write scope.

Call

  • Tool: reinstate_product
  • Scope: product:write
  • Writes, and may change or remove what is there.
  • Acts on a store.

Arguments

Name Type Required Description
store string No The store to act on.
product object Yes
full true No Answers the texts, attachments and file lists the short answer leaves out.
{
  "type": "object",
  "properties": {
    "store": {
      "type": "string",
      "description": "The store to act on."
    },
    "product": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "id"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "slug": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "slug"
          ],
          "additionalProperties": false
        }
      ]
    },
    "full": {
      "description": "Answers the texts, attachments and file lists the short answer leaves out.",
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "product"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
status string Yes
category string Yes
listing string Yes
id string Yes
slug string Yes
title string Yes
subtitle string or null Yes The short line shown under the title.
priority number Yes
published_at string or null Yes
discontinued_at string or null Yes
unlisted_at string or null Yes
created_at string or null Yes
updated_at string or null Yes
settings object Yes
metadata object Yes
unlisted boolean Yes
in_use array of object Yes
poster object or null No
path string Yes The storefront path.
url string or null Yes The absolute URL on the store’s verified hostname, or null before it has one.
tiers array of object Yes
prices array of object Yes
delete_blocked_by array of object Yes
stats array of object Yes
ratings object Yes
event_map object or null Yes An event’s venue maps at its location’s point, one image per theme; null until drawn, or for any other product.
feed_url string or null Yes The public feed’s absolute URL, for a blog or a podcast that is published (discontinued too), listed and on a verified hostname; else null.
description string or null No The page’s long description, in the rich text format as stored; answered only with full.
what_you_get string or null No What a buyer gets, in the rich text format as stored; answered only with full.
files object No The files its prose names; answered only with full.
created array of object Yes The attachments the write bound: the files its new prose names.

The answer’s full shape is on its API reference page.

Errors

A refused call is a tool error. Its structuredContent holds a code and its context, except for client-fault. This tool may answer:

  • invalid: an argument is malformed; context.path names it.
  • invalid at ["store"]: store is missing while the connection reaches more than one store, or names a store it doesn’t reach.
  • not_found: nothing matches a reference given.
  • conflict: the call clashes with the current state; context names the field and, where it helps, its current value, and for a from, live, expect or version that no longer matches, the argument (path) and what it takes (reason).
  • not_permitted: this connection may not make this call. When context.reason is limit, too many calls: retry_after says when to try again.
  • internal or unavailable: the call failed inside Sherpo, and the write may have landed. This write takes no idempotency key, so read the state back before trying again.
  • client-fault: the server failed around the call. core_answer ok means the write landed, so don’t send it again. When reached_core is false, nothing happened and the call may be made again. Otherwise, this write takes no idempotency key, so read the state back before trying again.
  • HTTP 403 with insufficient_scope: the connection lacks the scope this tool needs.
  • HTTP 401 with invalid_token: the access token expired or the connection ended. Refresh the token, and connect again if the refresh fails or the new token is refused too.

Any other code may come back too, such as a conflict when the state changed under the call. When the answer was already streaming, a 401 or 403 comes back as a tool error with only its text. See Errors for every code and its context.

Type to search…

↑↓ navigate↵ selectEsc close