Skip to content

Read discount

Reads one discount.

Needs the discount:read scope.

Call

  • Tool: get_discount
  • Scope: discount:read
  • Reads only.
  • Acts on a store.

Arguments

Name Type Required Description
store string No The store to act on.
discount object Yes
{
  "type": "object",
  "properties": {
    "store": {
      "type": "string",
      "description": "The store to act on."
    },
    "discount": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 512
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "discount"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
name string or null Yes
status string Yes
id string Yes
priority number Yes
created_at string or null Yes
currency string or null Yes
code string or null Yes
applies string Yes
amount_off number Yes
percent_off number Yes
floor_amount number or null Yes
cap_amount number or null Yes
floor_percent number or null Yes
supply_total number or null Yes
supply_consumed number Yes
supply_per_customer number or null Yes
starts_at string or null Yes
ends_at string or null Yes
archived_at string or null Yes
customers array of string Yes
usage object Yes
scopes array of object Yes
affiliates_ended object Yes
affiliate_earnings array of object or null Yes
exponent number or null Yes
affiliates array of object Yes

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.
  • 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. A read marked transient may be retried.
  • client-fault: the server failed around the call. reached_core says whether it reached Sherpo; the call may be made 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