com.atiproto.cart

atiproto.com

Documentation

A record representing a shopping cart for items/subscriptions

main record

A record representing a shopping cart for items/subscriptions

Record Key any Any valid record key

Properties

completedAt string datetime Optional

Completion timestamp

createdAt string datetime Required

Creation timestamp

currency string Required

ISO 4217 currency code

maxLength: 3 bytes
expiresAt string datetime Required

Expiration timestamp

items array of ref #cartItem Required

No description available.

status string Required

Cart status

maxLength: 64 bytes
Allowed: open, completed, expired, abandoned
total integer Required

Total amount in cents

View raw schema 
{
  "key": "any",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "items",
      "currency",
      "total",
      "status",
      "createdAt",
      "expiresAt"
    ],
    "properties": {
      "items": {
        "type": "array",
        "items": {
          "ref": "#cartItem",
          "type": "ref"
        }
      },
      "total": {
        "type": "integer",
        "description": "Total amount in cents"
      },
      "status": {
        "enum": [
          "open",
          "completed",
          "expired",
          "abandoned"
        ],
        "type": "string",
        "maxLength": 64,
        "description": "Cart status"
      },
      "currency": {
        "type": "string",
        "maxLength": 3,
        "description": "ISO 4217 currency code"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "Creation timestamp"
      },
      "expiresAt": {
        "type": "string",
        "format": "datetime",
        "description": "Expiration timestamp"
      },
      "completedAt": {
        "type": "string",
        "format": "datetime",
        "description": "Completion timestamp"
      }
    }
  },
  "description": "A record representing a shopping cart for items/subscriptions"
}
cartItem object

No description available.

Properties

recordUri string at-uri Required

AT-URI for item on record

type string Required

Type of cart item: item or subscription

maxLength: 128 bytes
View raw schema 
{
  "type": "object",
  "required": [
    "type",
    "recordUri"
  ],
  "properties": {
    "type": {
      "enum": [
        "com.atiproto.item",
        "com.atiproto.subscription"
      ],
      "type": "string",
      "maxLength": 128,
      "description": "Type of cart item: item or subscription"
    },
    "recordUri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI for item on record"
    }
  }
}
view object

View of a cart record for use in API responses

Properties

completedAt string datetime Optional

Completion timestamp

createdAt string datetime Required

Creation timestamp

currency string Required

ISO 4217 currency code

maxLength: 3 bytes
expiresAt string datetime Required

Expiration timestamp

items array of ref#cartItem Required

No description available.

status string Required

Cart status

maxLength: 64 bytes
total integer Required

Total amount in cents

uri string at-uri Required

AT-URI of the cart record

View raw schema 
{
  "type": "object",
  "required": [
    "uri",
    "items",
    "currency",
    "total",
    "status",
    "createdAt",
    "expiresAt"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the cart record"
    },
    "items": {
      "type": "array",
      "items": {
        "ref": "#cartItem",
        "type": "ref"
      }
    },
    "total": {
      "type": "integer",
      "description": "Total amount in cents"
    },
    "status": {
      "enum": [
        "open",
        "completed",
        "expired",
        "abandoned"
      ],
      "type": "string",
      "maxLength": 64,
      "description": "Cart status"
    },
    "currency": {
      "type": "string",
      "maxLength": 3,
      "description": "ISO 4217 currency code"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime",
      "description": "Creation timestamp"
    },
    "expiresAt": {
      "type": "string",
      "format": "datetime",
      "description": "Expiration timestamp"
    },
    "completedAt": {
      "type": "string",
      "format": "datetime",
      "description": "Completion timestamp"
    }
  },
  "description": "View of a cart record for use in API responses"
}

Lexicon Garden

@