Skip to content

Decline product request

Declines a pending request or a waitlist place, giving back any seats it holds.

Needs the customer:write scope.

Call

  • Tool: decline_product_request
  • Scope: customer: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
request object Yes
{
  "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
        }
      ]
    },
    "request": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 512
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "product",
    "request"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
id string Yes
product_id string Yes
customer_id string Yes
status string Yes pending until the seller decides, waitlisted while it waits for a seat, then approved or declined.
tier object or null Yes The tier asked for; null for none.
price_id string or null Yes The price asked at.
payment string or null Yes A paid request’s payment: saved while its card waits to be charged on approval, held while its total is held on the card, charging once approved, due from the buyer once a charge failed or found no card; null for a free one or once decided.
hold_expires_at string or null Yes When a held request’s card hold is released, closing it as expired unless decided first; null otherwise.
quantity integer Yes How many tickets it asks for.
order_item_id string or null Yes The order line that asked, or the one a promotion recorded; null while on a waitlist.
grant_id string or null Yes The grant an approval gave.
created_at string Yes
decided_at string or null Yes
closed_reason string or null Yes expired for a request declined because its card hold was released before anyone decided; null otherwise.
customer object or null Yes Who they are, erased once their details are wiped.
answers array of object Yes Their answers to the product’s registration questions, in the questions’ order; none without customer:read.

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