shopify-webhook-schemas 0.2.1 → 0.2.3

package/schemas/2025-07/app_subscriptions/approaching_capped_amount.json

@@ -0,0 +1,67 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "properties": {
+    "app_subscription": {
+      "properties": {
+        "admin_graphql_api_id": {
+          "format": "uri",
+          "type": "string"
+        },
+        "admin_graphql_api_shop_id": {
+          "format": "uri",
+          "type": "string"
+        },
+        "balance_used": {
+          "type": "integer"
+        },
+        "capped_amount": {
+          "type": "string"
+        },
+        "created_at": {
+          "format": "date-time",
+          "type": "string"
+        },
+        "currency": {
+          "type": "string"
+        },
+        "currency_code": {
+          "type": "string"
+        },
+        "interval": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "plan_handle": {
+          "type": "string"
+        },
+        "price": {
+          "type": "string"
+        },
+        "status": {
+          "type": "string"
+        },
+        "updated_at": {
+          "format": "date-time",
+          "type": "string"
+        }
+      },
+      "required": [
+        "admin_graphql_api_id",
+        "admin_graphql_api_shop_id",
+        "balance_used",
+        "capped_amount",
+        "created_at",
+        "currency_code",
+        "name",
+        "updated_at"
+      ],
+      "type": "object"
+    }
+  },
+  "required": [
+    "app_subscription"
+  ],
+  "type": "object"
+}

package/schemas/2025-07/app_subscriptions/update.json

@@ -0,0 +1,64 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "properties": {
+    "app_subscription": {
+      "properties": {
+        "admin_graphql_api_id": {
+          "format": "uri",
+          "type": "string"
+        },
+        "admin_graphql_api_shop_id": {
+          "format": "uri",
+          "type": "string"
+        },
+        "capped_amount": {
+          "type": "string"
+        },
+        "created_at": {
+          "format": "date-time",
+          "type": "string"
+        },
+        "currency": {
+          "type": "string"
+        },
+        "interval": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "plan_handle": {
+          "type": "string"
+        },
+        "price": {
+          "type": "string"
+        },
+        "status": {
+          "type": "string"
+        },
+        "updated_at": {
+          "format": "date-time",
+          "type": "string"
+        }
+      },
+      "required": [
+        "admin_graphql_api_id",
+        "admin_graphql_api_shop_id",
+        "capped_amount",
+        "created_at",
+        "currency",
+        "interval",
+        "name",
+        "plan_handle",
+        "price",
+        "status",
+        "updated_at"
+      ],
+      "type": "object"
+    }
+  },
+  "required": [
+    "app_subscription"
+  ],
+  "type": "object"
+}

package/schemas/2025-07/audit_events/admin_api_activity.json

@@ -0,0 +1,202 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "properties": {
+    "events": {
+      "items": {
+        "properties": {
+          "event": {
+            "properties": {
+              "action": {
+                "type": "string"
+              },
+              "actor": {
+                "properties": {
+                  "actor_identifier": {
+                    "type": "integer"
+                  },
+                  "actor_metadata": {
+                    "properties": {
+                      "api_version_requested": {
+                        "type": "string"
+                      },
+                      "api_version_served": {
+                        "type": "string"
+                      },
+                      "app_name": {
+                        "type": "string"
+                      },
+                      "ecosystem_category": {
+                        "type": "string"
+                      }
+                    },
+                    "required": [
+                      "api_version_requested",
+                      "api_version_served",
+                      "app_name",
+                      "ecosystem_category"
+                    ],
+                    "type": "object"
+                  },
+                  "actor_type": {
+                    "type": "string"
+                  },
+                  "on_behalf_of": {
+                    "properties": {
+                      "user_email": {
+                        "format": "email",
+                        "type": "string"
+                      }
+                    },
+                    "required": [
+                      "user_email"
+                    ],
+                    "type": "object"
+                  }
+                },
+                "required": [
+                  "actor_identifier",
+                  "actor_metadata",
+                  "actor_type",
+                  "on_behalf_of"
+                ],
+                "type": "object"
+              },
+              "additional_metadata": {
+                "properties": {
+                  "error_codes": {
+                    "items": false,
+                    "type": "array"
+                  },
+                  "mutation_names": {
+                    "items": false,
+                    "type": "array"
+                  },
+                  "query": {
+                    "type": "string"
+                  },
+                  "request_type": {
+                    "type": "string"
+                  },
+                  "variables": {
+                    "properties": {
+                      "first": {
+                        "type": "integer"
+                      }
+                    },
+                    "required": [
+                      "first"
+                    ],
+                    "type": "object"
+                  }
+                },
+                "required": [
+                  "error_codes",
+                  "mutation_names",
+                  "query",
+                  "request_type",
+                  "variables"
+                ],
+                "type": "object"
+              },
+              "context": {
+                "properties": {
+                  "context_identifier": {
+                    "format": "uuid",
+                    "type": "string"
+                  },
+                  "context_metadata": {
+                    "properties": {
+                      "api_request_failed": {
+                        "type": "boolean"
+                      },
+                      "client_ip": {
+                        "format": "ipv4",
+                        "type": "string"
+                      },
+                      "content_type": {
+                        "type": "string"
+                      },
+                      "response_code": {
+                        "type": "integer"
+                      },
+                      "response_time_ms": {
+                        "type": "number"
+                      },
+                      "user_agent": {
+                        "type": "string"
+                      }
+                    },
+                    "required": [
+                      "api_request_failed",
+                      "client_ip",
+                      "content_type",
+                      "response_code",
+                      "response_time_ms",
+                      "user_agent"
+                    ],
+                    "type": "object"
+                  },
+                  "context_type": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "context_identifier",
+                  "context_metadata",
+                  "context_type"
+                ],
+                "type": "object"
+              },
+              "subject": {
+                "properties": {
+                  "subject_identifier": {
+                    "format": "hostname",
+                    "type": "string"
+                  },
+                  "subject_metadata": {
+                    "type": "object"
+                  },
+                  "subject_type": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "subject_identifier",
+                  "subject_metadata",
+                  "subject_type"
+                ],
+                "type": "object"
+              },
+              "timestamp": {
+                "format": "date-time",
+                "type": "string"
+              }
+            },
+            "required": [
+              "action",
+              "actor",
+              "additional_metadata",
+              "context",
+              "subject",
+              "timestamp"
+            ],
+            "type": "object"
+          },
+          "time": {
+            "type": "integer"
+          }
+        },
+        "required": [
+          "event",
+          "time"
+        ],
+        "type": "object"
+      },
+      "type": "array"
+    }
+  },
+  "required": [
+    "events"
+  ],
+  "type": "object"
+}

package/schemas/2025-07/bulk_operations/finish.json

@@ -0,0 +1,38 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "properties": {
+    "admin_graphql_api_id": {
+      "format": "uri",
+      "type": "string"
+    },
+    "completed_at": {
+      "format": "date-time",
+      "type": "string"
+    },
+    "created_at": {
+      "format": "date-time",
+      "type": "string"
+    },
+    "error_code": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "status": {
+      "type": "string"
+    },
+    "type": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "admin_graphql_api_id",
+    "completed_at",
+    "created_at",
+    "error_code",
+    "status",
+    "type"
+  ],
+  "type": "object"
+}

package/schemas/2025-07/carts/create.json

@@ -0,0 +1,324 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "properties": {
+    "created_at": {
+      "format": "date-time",
+      "type": "string"
+    },
+    "id": {
+      "type": "string"
+    },
+    "line_items": {
+      "items": {
+        "properties": {
+          "discounted_price": {
+            "type": "string"
+          },
+          "discounted_price_set": {
+            "properties": {
+              "presentment_money": {
+                "properties": {
+                  "amount": {
+                    "type": "string"
+                  },
+                  "currency_code": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "amount",
+                  "currency_code"
+                ],
+                "type": "object"
+              },
+              "shop_money": {
+                "properties": {
+                  "amount": {
+                    "type": "string"
+                  },
+                  "currency_code": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "amount",
+                  "currency_code"
+                ],
+                "type": "object"
+              }
+            },
+            "required": [
+              "presentment_money",
+              "shop_money"
+            ],
+            "type": "object"
+          },
+          "discounts": {
+            "items": false,
+            "type": "array"
+          },
+          "gift_card": {
+            "type": "boolean"
+          },
+          "grams": {
+            "type": "integer"
+          },
+          "id": {
+            "type": "integer"
+          },
+          "key": {
+            "type": "string"
+          },
+          "line_price": {
+            "type": "string"
+          },
+          "line_price_set": {
+            "properties": {
+              "presentment_money": {
+                "properties": {
+                  "amount": {
+                    "type": "string"
+                  },
+                  "currency_code": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "amount",
+                  "currency_code"
+                ],
+                "type": "object"
+              },
+              "shop_money": {
+                "properties": {
+                  "amount": {
+                    "type": "string"
+                  },
+                  "currency_code": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "amount",
+                  "currency_code"
+                ],
+                "type": "object"
+              }
+            },
+            "required": [
+              "presentment_money",
+              "shop_money"
+            ],
+            "type": "object"
+          },
+          "original_line_price": {
+            "type": "string"
+          },
+          "original_line_price_set": {
+            "properties": {
+              "presentment_money": {
+                "properties": {
+                  "amount": {
+                    "type": "string"
+                  },
+                  "currency_code": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "amount",
+                  "currency_code"
+                ],
+                "type": "object"
+              },
+              "shop_money": {
+                "properties": {
+                  "amount": {
+                    "type": "string"
+                  },
+                  "currency_code": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "amount",
+                  "currency_code"
+                ],
+                "type": "object"
+              }
+            },
+            "required": [
+              "presentment_money",
+              "shop_money"
+            ],
+            "type": "object"
+          },
+          "original_price": {
+            "type": "string"
+          },
+          "price": {
+            "type": "string"
+          },
+          "price_set": {
+            "properties": {
+              "presentment_money": {
+                "properties": {
+                  "amount": {
+                    "type": "string"
+                  },
+                  "currency_code": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "amount",
+                  "currency_code"
+                ],
+                "type": "object"
+              },
+              "shop_money": {
+                "properties": {
+                  "amount": {
+                    "type": "string"
+                  },
+                  "currency_code": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "amount",
+                  "currency_code"
+                ],
+                "type": "object"
+              }
+            },
+            "required": [
+              "presentment_money",
+              "shop_money"
+            ],
+            "type": "object"
+          },
+          "product_id": {
+            "type": "integer"
+          },
+          "properties": {
+            "type": [
+              "null",
+              "object"
+            ]
+          },
+          "quantity": {
+            "type": "integer"
+          },
+          "sku": {
+            "type": "string"
+          },
+          "taxable": {
+            "type": "boolean"
+          },
+          "title": {
+            "type": "string"
+          },
+          "total_discount": {
+            "type": "string"
+          },
+          "total_discount_set": {
+            "properties": {
+              "presentment_money": {
+                "properties": {
+                  "amount": {
+                    "type": "string"
+                  },
+                  "currency_code": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "amount",
+                  "currency_code"
+                ],
+                "type": "object"
+              },
+              "shop_money": {
+                "properties": {
+                  "amount": {
+                    "type": "string"
+                  },
+                  "currency_code": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "amount",
+                  "currency_code"
+                ],
+                "type": "object"
+              }
+            },
+            "required": [
+              "presentment_money",
+              "shop_money"
+            ],
+            "type": "object"
+          },
+          "variant_id": {
+            "type": "integer"
+          },
+          "vendor": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "discounted_price",
+          "discounted_price_set",
+          "discounts",
+          "gift_card",
+          "grams",
+          "id",
+          "key",
+          "line_price",
+          "line_price_set",
+          "original_line_price",
+          "original_line_price_set",
+          "original_price",
+          "price",
+          "price_set",
+          "product_id",
+          "properties",
+          "quantity",
+          "sku",
+          "taxable",
+          "title",
+          "total_discount",
+          "total_discount_set",
+          "variant_id",
+          "vendor"
+        ],
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "note": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "token": {
+      "type": "string"
+    },
+    "updated_at": {
+      "format": "date-time",
+      "type": "string"
+    }
+  },
+  "required": [
+    "created_at",
+    "id",
+    "line_items",
+    "note",
+    "token",
+    "updated_at"
+  ],
+  "type": "object"
+}