Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding initial hyper t schemas. #1401

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions schemas/io.snowplow.ecomm/add_discount/jsonschema/1-0-0
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"description": "This event fires when a customer adds a discount to their order.",
"properties": {
"success": {
"type": [
"boolean",
"null"
]
},
"error_code": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"discount_id": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"type": "object",
"self": {
"vendor": "io.snowplow.ecomm",
"name": "add_discount",
"format": "jsonschema",
"version": "1-0-0"
},
"$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#",
"required": [
"discount_id"
]
}
28 changes: 28 additions & 0 deletions schemas/io.snowplow.ecomm/add_payment_method/jsonschema/1-0-0
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"description": "Event occurs when a payment method is added during checkout.",
"properties": {
"payment_id": {
misterpig marked this conversation as resolved.
Show resolved Hide resolved
"type": "string",
"maxLength": 255
},
"new_payment": {
"type": [
"boolean",
"null"
],
"description": "If this payment ID is new or from a saved payment on the customer's account."
}
},
"additionalProperties": false,
"type": "object",
"self": {
"vendor": "io.snowplow.ecomm",
"name": "add_payment_method",
"format": "jsonschema",
"version": "1-0-0"
},
"$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#",
"required": [
"payment_id"
]
}
26 changes: 26 additions & 0 deletions schemas/io.snowplow.ecomm/add_shipping/jsonschema/1-0-0
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"description": "Event occurrs when shipping information is added during checkout.",
"properties": {
"cart_id": {
"type": "string",
"maxLength": 255
},
"location_id": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"type": "object",
"self": {
"vendor": "io.snowplow.ecomm",
"name": "add_shipping",
"format": "jsonschema",
"version": "1-0-0"
},
"$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#",
"required": [
"cart_id",
"location_id"
]
}
47 changes: 47 additions & 0 deletions schemas/io.snowplow.ecomm/add_to_cart/jsonschema/1-0-0
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
{
"description": "Event occurs when a product or bundle is added to a cart.",
"properties": {
"item_id": {
"type": "string",
"maxLength": 255
},
"item_type": {
"type": "string",
"enum": ["product", "bundle"],
"description": "The general type of the item, currently supports the two types of a singular product and a bundle of products.",
"maxLength": 255
},
"quantity": {
"type": "integer",
misterpig marked this conversation as resolved.
Show resolved Hide resolved
"minimum": 1,
"maximum": 2147483647
},
"cart_id": {
"type": "string",
"maxLength": 255
},
"source": {
"type": [
"string",
"null"
],
"description": "Examples: \"catalog\", \"wishlist\"",
"maxLength": 255
}
},
"additionalProperties": false,
"type": "object",
"self": {
"vendor": "io.snowplow.ecomm",
"name": "add_to_cart",
"format": "jsonschema",
"version": "1-0-0"
},
"$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#",
"required": [
"item_id",
"item_type",
"quantity",
"cart_id"
]
}
43 changes: 43 additions & 0 deletions schemas/io.snowplow.ecomm/add_to_list/jsonschema/1-0-0
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
{
"description": "Event occurs when a product or bundle is added to a list by a customer; such as a comparison list, wish list, bookmarks/favorites list, or gift registry.",
"properties": {
"list_name": {
"type": [
"string",
"null"
],
"description": "Name of the list the product was added to.",
"maxLength": 255
},
"list_id": {
"type": "string",
"description": "A unique identifier for the list the product was added to, if not a generic common list.",
"maxLength": 255
},
"item_id": {
"type": "string",
"description": "ID reference to the entity (as listed in entity) that was added to the list.",
"maxLength": 255
},
"item_type": {
"type": "string",
"enum": ["product", "bundle"],
"description": "The general type of the item, currently supports the two types of a singular product and a bundle of products.",
"maxLength": 255
}
},
"additionalProperties": false,
"type": "object",
"self": {
"vendor": "io.snowplow.ecomm",
"name": "add_to_list",
"format": "jsonschema",
"version": "1-0-0"
},
"$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#",
"required": [
"list_id",
"item_id",
"item_type"
]
}
21 changes: 21 additions & 0 deletions schemas/io.snowplow.ecomm/begin_checkout/jsonschema/1-0-0
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"description": "Event occurs when a customer enters the checkout sequence",
"properties": {
"cart_id": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"type": "object",
"self": {
"vendor": "io.snowplow.ecomm",
"name": "begin_checkout",
"format": "jsonschema",
"version": "1-0-0"
},
"$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#",
"required": [
"cart_id"
]
}
29 changes: 29 additions & 0 deletions schemas/io.snowplow.ecomm/cancel_subscription/jsonschema/1-0-0
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"description": "Event occurs when a customer cancels for a subscription",
misterpig marked this conversation as resolved.
Show resolved Hide resolved
"properties": {
"subscription_id": {
"type": "string",
"maxLength": 255
},
"reason": {
"type": [
"string",
"null"
],
"description": "The reason if given in notes for why the subscription was cancelled.",
misterpig marked this conversation as resolved.
Show resolved Hide resolved
"maxLength": 512
}
},
"additionalProperties": false,
"type": "object",
"self": {
"vendor": "io.snowplow.ecomm",
"name": "cancel_subscription",
"format": "jsonschema",
"version": "1-0-0"
},
"$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#",
"required": [
"subscription_id"
]
}
Loading
Loading