Skip to content

Simulate checkout

Prices each of a product's prices as the checkout would charge a customer, or a new one, with an optional coupon, quantity and later time, writing nothing; naming a customer needs `customer:read`, and a coupon `discount:read`.

Needs the price:read scope.

Call

  • Tool: simulate_checkout
  • Scope: price:read
  • Reads only.
  • Acts on a store.

Arguments

Name Type Required Description
store string No The store to act on.
customer object or null No Null or absent for a new customer.
product object Yes
coupon string No A discount’s code, or its id, as the checkout reads a coupon.
at string No When to price at; now when absent, never earlier, and a date alone is that day’s start in UTC.
quantity integer No How many of a one-time price; one when absent.
{
  "type": "object",
  "properties": {
    "store": {
      "type": "string",
      "description": "The store to act on."
    },
    "customer": {
      "description": "Null or absent for a new customer.",
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "id"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "product": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 512
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": false
    },
    "coupon": {
      "description": "A discount's code, or its id, as the checkout reads a coupon.",
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "at": {
      "description": "When to price at; now when absent, never earlier, and a date alone is that day's start in UTC.",
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})(?:T(\\d{2}):(\\d{2})(?::(\\d{2})(?:\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"
    },
    "quantity": {
      "description": "How many of a one-time price; one when absent.",
      "type": "integer",
      "minimum": 1,
      "maximum": 99
    }
  },
  "required": [
    "product"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
at string Yes When the prices were read at.
customer object or null Yes
product object Yes
coupon string or null Yes
quantity number Yes
owned object or null Yes What the customer already holds of the product, or null.
prices array of object Yes Every live price, and an archived one the customer’s plan still renews on, in the checkout’s order.

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