shopify-webhook-schemas 0.1.0

package/schemas/2023-10/fulfillments/update.json

@@ -0,0 +1,486 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "integer"
+    },
+    "order_id": {
+      "type": "integer"
+    },
+    "status": {
+      "type": "string"
+    },
+    "created_at": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "service": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "updated_at": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "tracking_company": {
+      "type": "string"
+    },
+    "shipment_status": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "location_id": {
+      "type": [
+        "integer",
+        "null"
+      ]
+    },
+    "origin_address": {
+      "type": [
+        "object",
+        "null"
+      ],
+      "properties": {
+        "first_name": {
+          "type": "string"
+        },
+        "address1": {
+          "type": "string"
+        },
+        "phone": {
+          "type": "string"
+        },
+        "city": {
+          "type": "string"
+        },
+        "zip": {
+          "type": "string"
+        },
+        "province": {
+          "type": "string"
+        },
+        "country": {
+          "type": "string"
+        },
+        "last_name": {
+          "type": "string"
+        },
+        "address2": {
+          "type": "null"
+        },
+        "company": {
+          "type": "string"
+        },
+        "latitude": {
+          "type": "null"
+        },
+        "longitude": {
+          "type": "null"
+        },
+        "name": {
+          "type": "string"
+        },
+        "country_code": {
+          "type": "string"
+        },
+        "province_code": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "first_name",
+        "address1",
+        "phone",
+        "city",
+        "zip",
+        "province",
+        "country",
+        "last_name",
+        "address2",
+        "company",
+        "latitude",
+        "longitude",
+        "name",
+        "country_code",
+        "province_code"
+      ]
+    },
+    "email": {
+      "type": "string",
+      "format": "email"
+    },
+    "destination": {
+      "type": "object",
+      "properties": {
+        "first_name": {
+          "type": "string"
+        },
+        "address1": {
+          "type": "string"
+        },
+        "phone": {
+          "type": "string"
+        },
+        "city": {
+          "type": "string"
+        },
+        "zip": {
+          "type": "string"
+        },
+        "province": {
+          "type": "string"
+        },
+        "country": {
+          "type": "string"
+        },
+        "last_name": {
+          "type": "string"
+        },
+        "address2": {
+          "type": "null"
+        },
+        "company": {
+          "type": "string"
+        },
+        "latitude": {
+          "type": "null"
+        },
+        "longitude": {
+          "type": "null"
+        },
+        "name": {
+          "type": "string"
+        },
+        "country_code": {
+          "type": "string"
+        },
+        "province_code": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "first_name",
+        "address1",
+        "phone",
+        "city",
+        "zip",
+        "province",
+        "country",
+        "last_name",
+        "address2",
+        "company",
+        "latitude",
+        "longitude",
+        "name",
+        "country_code",
+        "province_code"
+      ]
+    },
+    "line_items": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "integer"
+          },
+          "variant_id": {
+            "type": "integer"
+          },
+          "title": {
+            "type": "string"
+          },
+          "quantity": {
+            "type": "integer"
+          },
+          "sku": {
+            "type": "string"
+          },
+          "variant_title": {
+            "type": "null"
+          },
+          "vendor": {
+            "type": "null"
+          },
+          "fulfillment_service": {
+            "type": "string"
+          },
+          "product_id": {
+            "type": "integer"
+          },
+          "requires_shipping": {
+            "type": "boolean"
+          },
+          "taxable": {
+            "type": "boolean"
+          },
+          "gift_card": {
+            "type": "boolean"
+          },
+          "name": {
+            "type": "string"
+          },
+          "variant_inventory_management": {
+            "type": "string"
+          },
+          "properties": {
+            "type": "array",
+            "items": false
+          },
+          "product_exists": {
+            "type": "boolean"
+          },
+          "fulfillable_quantity": {
+            "type": "integer"
+          },
+          "grams": {
+            "type": "integer"
+          },
+          "price": {
+            "type": "string"
+          },
+          "total_discount": {
+            "type": "string"
+          },
+          "fulfillment_status": {
+            "type": "null"
+          },
+          "price_set": {
+            "type": "object",
+            "properties": {
+              "shop_money": {
+                "type": "object",
+                "properties": {
+                  "amount": {
+                    "type": "string"
+                  },
+                  "currency_code": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "amount",
+                  "currency_code"
+                ]
+              },
+              "presentment_money": {
+                "type": "object",
+                "properties": {
+                  "amount": {
+                    "type": "string"
+                  },
+                  "currency_code": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "amount",
+                  "currency_code"
+                ]
+              }
+            },
+            "required": [
+              "shop_money",
+              "presentment_money"
+            ]
+          },
+          "total_discount_set": {
+            "type": "object",
+            "properties": {
+              "shop_money": {
+                "type": "object",
+                "properties": {
+                  "amount": {
+                    "type": "string"
+                  },
+                  "currency_code": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "amount",
+                  "currency_code"
+                ]
+              },
+              "presentment_money": {
+                "type": "object",
+                "properties": {
+                  "amount": {
+                    "type": "string"
+                  },
+                  "currency_code": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "amount",
+                  "currency_code"
+                ]
+              }
+            },
+            "required": [
+              "shop_money",
+              "presentment_money"
+            ]
+          },
+          "discount_allocations": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "amount": {
+                  "type": "string"
+                },
+                "discount_application_index": {
+                  "type": "integer"
+                },
+                "amount_set": {
+                  "type": "object",
+                  "properties": {
+                    "shop_money": {
+                      "type": "object",
+                      "properties": {
+                        "amount": {
+                          "type": "string"
+                        },
+                        "currency_code": {
+                          "type": "string"
+                        }
+                      },
+                      "required": [
+                        "amount",
+                        "currency_code"
+                      ]
+                    },
+                    "presentment_money": {
+                      "type": "object",
+                      "properties": {
+                        "amount": {
+                          "type": "string"
+                        },
+                        "currency_code": {
+                          "type": "string"
+                        }
+                      },
+                      "required": [
+                        "amount",
+                        "currency_code"
+                      ]
+                    }
+                  },
+                  "required": [
+                    "shop_money",
+                    "presentment_money"
+                  ]
+                }
+              },
+              "required": [
+                "amount",
+                "discount_application_index",
+                "amount_set"
+              ]
+            }
+          },
+          "duties": {
+            "type": "array",
+            "items": false
+          },
+          "admin_graphql_api_id": {
+            "type": "string",
+            "format": "uri"
+          },
+          "tax_lines": {
+            "type": "array",
+            "items": false
+          }
+        },
+        "required": [
+          "id",
+          "variant_id",
+          "title",
+          "quantity",
+          "sku",
+          "variant_title",
+          "vendor",
+          "fulfillment_service",
+          "product_id",
+          "requires_shipping",
+          "taxable",
+          "gift_card",
+          "name",
+          "variant_inventory_management",
+          "properties",
+          "product_exists",
+          "fulfillable_quantity",
+          "grams",
+          "price",
+          "total_discount",
+          "fulfillment_status",
+          "price_set",
+          "total_discount_set",
+          "discount_allocations",
+          "duties",
+          "admin_graphql_api_id",
+          "tax_lines"
+        ]
+      }
+    },
+    "tracking_number": {
+      "type": "string"
+    },
+    "tracking_numbers": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "tracking_url": {
+      "type": "string",
+      "format": "uri"
+    },
+    "tracking_urls": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "format": "uri"
+      }
+    },
+    "receipt": {
+      "type": "object"
+    },
+    "name": {
+      "type": "string"
+    },
+    "admin_graphql_api_id": {
+      "type": "string",
+      "format": "uri"
+    }
+  },
+  "required": [
+    "id",
+    "order_id",
+    "status",
+    "created_at",
+    "service",
+    "updated_at",
+    "tracking_company",
+    "shipment_status",
+    "location_id",
+    "origin_address",
+    "email",
+    "destination",
+    "line_items",
+    "tracking_number",
+    "tracking_numbers",
+    "tracking_url",
+    "tracking_urls",
+    "receipt",
+    "name",
+    "admin_graphql_api_id"
+  ]
+}

package/schemas/2023-10/inventory_items/create.json

@@ -0,0 +1,72 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "integer"
+    },
+    "sku": {
+      "type": "string"
+    },
+    "created_at": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "updated_at": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "requires_shipping": {
+      "type": "boolean"
+    },
+    "cost": {
+      "type": [
+        "number",
+        "null"
+      ]
+    },
+    "country_code_of_origin": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "province_code_of_origin": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "harmonized_system_code": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "tracked": {
+      "type": "boolean"
+    },
+    "country_harmonized_system_codes": {
+      "type": "array",
+      "items": false
+    },
+    "admin_graphql_api_id": {
+      "type": "string",
+      "format": "uri"
+    }
+  },
+  "required": [
+    "id",
+    "sku",
+    "created_at",
+    "updated_at",
+    "requires_shipping",
+    "cost",
+    "country_code_of_origin",
+    "province_code_of_origin",
+    "harmonized_system_code",
+    "tracked",
+    "country_harmonized_system_codes",
+    "admin_graphql_api_id"
+  ]
+}

package/schemas/2023-10/inventory_items/delete.json

@@ -0,0 +1,43 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "integer"
+    },
+    "country_code_of_origin": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "province_code_of_origin": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "harmonized_system_code": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "country_harmonized_system_codes": {
+      "type": "array",
+      "items": false
+    },
+    "admin_graphql_api_id": {
+      "type": "string",
+      "format": "uri"
+    }
+  },
+  "required": [
+    "id",
+    "country_code_of_origin",
+    "province_code_of_origin",
+    "harmonized_system_code",
+    "country_harmonized_system_codes",
+    "admin_graphql_api_id"
+  ]
+}

package/schemas/2023-10/inventory_items/update.json

@@ -0,0 +1,72 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "integer"
+    },
+    "sku": {
+      "type": "string"
+    },
+    "created_at": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "updated_at": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "requires_shipping": {
+      "type": "boolean"
+    },
+    "cost": {
+      "type": [
+        "number",
+        "null"
+      ]
+    },
+    "country_code_of_origin": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "province_code_of_origin": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "harmonized_system_code": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "tracked": {
+      "type": "boolean"
+    },
+    "country_harmonized_system_codes": {
+      "type": "array",
+      "items": false
+    },
+    "admin_graphql_api_id": {
+      "type": "string",
+      "format": "uri"
+    }
+  },
+  "required": [
+    "id",
+    "sku",
+    "created_at",
+    "updated_at",
+    "requires_shipping",
+    "cost",
+    "country_code_of_origin",
+    "province_code_of_origin",
+    "harmonized_system_code",
+    "tracked",
+    "country_harmonized_system_codes",
+    "admin_graphql_api_id"
+  ]
+}

package/schemas/2023-10/inventory_levels/connect.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "inventory_item_id": {
+      "type": "integer"
+    },
+    "location_id": {
+      "type": "integer"
+    },
+    "available": {
+      "type": [
+        "integer",
+        "null"
+      ]
+    },
+    "updated_at": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "admin_graphql_api_id": {
+      "type": "string",
+      "format": "uri"
+    }
+  },
+  "required": [
+    "inventory_item_id",
+    "location_id",
+    "available",
+    "updated_at",
+    "admin_graphql_api_id"
+  ]
+}