com.atiproto.payment.cart.get

atiproto.com

Documentation

Get a specific cart sent by the authenticated user, including resolved item and subscription records. One of `uri`, `itemUri`, or `subscriptionUri` is required.

main query

Get a specific cart sent by the authenticated user, including resolved item and subscription records. One of `uri`, `itemUri`, or `subscriptionUri` is required.

Parameters

itemUri string at-uri Optional

AT-URI of an item record. Returns the cart that contains this item. Ignored if uri is provided.

subscriptionUri string at-uri Optional

AT-URI of a subscription record. Returns the cart that contains this subscription. Ignored if uri or itemUri is provided.

uri string at-uri Optional

AT-URI of the cart record. Takes precedence over itemUri and subscriptionUri.

Output

Encodingapplication/json
checkoutUrl stringuri Optional

Checkout URL, only present when cart status is open

cid stringcid Optional

Cart record CID

items array Required

Resolved item records referenced by this cart

subscriptions array Required

Resolved subscription records referenced by this cart

uri stringat-uri Required

Cart record URI

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
AT-URI of an item record. Returns the cart that contains this item. Ignored if uri is provided.
AT-URI of a subscription record. Returns the cart that contains this subscription. Ignored if uri or itemUri is provided.
AT-URI of the cart record. Takes precedence over itemUri and subscriptionUri.
View raw schema 
{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "uri",
        "cart",
        "items",
        "subscriptions"
      ],
      "properties": {
        "cid": {
          "type": "string",
          "format": "cid",
          "description": "Cart record CID"
        },
        "uri": {
          "type": "string",
          "format": "at-uri",
          "description": "Cart record URI"
        },
        "cart": {
          "ref": "com.atiproto.cart#view",
          "type": "ref",
          "description": "The cart record data"
        },
        "items": {
          "type": "array",
          "items": {
            "ref": "com.atiproto.item#view",
            "type": "ref"
          },
          "description": "Resolved item records referenced by this cart"
        },
        "workflow": {
          "ref": "com.atiproto.actions#outboundWorkflow",
          "type": "ref",
          "description": "Side-effect workflow to sync server status with PDS status."
        },
        "checkoutUrl": {
          "type": "string",
          "format": "uri",
          "description": "Checkout URL, only present when cart status is open"
        },
        "subscriptions": {
          "type": "array",
          "items": {
            "ref": "com.atiproto.subscription#view",
            "type": "ref"
          },
          "description": "Resolved subscription records referenced by this cart"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {
      "uri": {
        "type": "string",
        "format": "at-uri",
        "description": "AT-URI of the cart record. Takes precedence over itemUri and subscriptionUri."
      },
      "itemUri": {
        "type": "string",
        "format": "at-uri",
        "description": "AT-URI of an item record. Returns the cart that contains this item. Ignored if uri is provided."
      },
      "subscriptionUri": {
        "type": "string",
        "format": "at-uri",
        "description": "AT-URI of a subscription record. Returns the cart that contains this subscription. Ignored if uri or itemUri is provided."
      }
    }
  },
  "description": "Get a specific cart sent by the authenticated user, including resolved item and subscription records. One of `uri`, `itemUri`, or `subscriptionUri` is required."
}

Lexicon Garden

@