@friggframework/core 2.0.0--canary.703.12b980b.0 → 2.0.0--canary.707.df80bfd.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +11 -0
- package/CLAUDE.md +28 -0
- package/README.md +105 -0
- package/application/commands/integration-commands.js +20 -10
- package/application/commands/scheduler-commands.js +11 -7
- package/application/commands/user-commands.js +17 -5
- package/application/index.js +6 -2
- package/core/Worker.js +31 -7
- package/core/create-handler.js +9 -0
- package/credential/repositories/credential-repository-documentdb.js +34 -0
- package/credential/repositories/credential-repository-interface.js +15 -0
- package/credential/repositories/credential-repository-mongo.js +23 -0
- package/credential/repositories/credential-repository-postgres.js +28 -0
- package/credential/use-cases/credential-operations-for-user.js +202 -0
- package/credential/use-cases/reauthorize-credential-for-user.js +73 -0
- package/database/config.js +48 -24
- package/database/documentdb-encryption-service.js +9 -22
- package/database/documentdb-utils.js +2 -2
- package/database/encryption/README.md +78 -14
- package/database/encryption/documentdb-encryption-service.md +78 -1
- package/database/encryption/encryption-config.js +219 -0
- package/database/encryption/encryption-schema-registry.js +121 -24
- package/database/encryption/field-encryption-service.js +69 -5
- package/database/encryption/integration-mapping-encryption.js +1 -1
- package/database/encryption/test-support/fake-ciphertext.js +15 -0
- package/database/organization-where.js +18 -0
- package/database/prisma.js +15 -38
- package/database/unique-violation.js +25 -0
- package/database/use-cases/check-encryption-health-use-case.js +43 -52
- package/errors/index.js +0 -4
- package/extensions/bootstrap-runner.js +43 -0
- package/extensions/extension-loader.js +230 -0
- package/extensions/index.js +44 -0
- package/extensions/initialize-app.js +123 -0
- package/extensions/prisma-composer.js +270 -0
- package/extensions/route-mounter.js +103 -0
- package/extensions/schema-composer.js +188 -0
- package/generated/prisma-mongodb/edge.js +33 -42
- package/generated/prisma-mongodb/index-browser.js +30 -39
- package/generated/prisma-mongodb/index.d.ts +3187 -2005
- package/generated/prisma-mongodb/index.js +33 -42
- package/generated/prisma-mongodb/package.json +1 -1
- package/generated/prisma-mongodb/schema.prisma +86 -59
- package/generated/prisma-mongodb/wasm.js +33 -42
- package/generated/prisma-postgresql/edge.js +33 -42
- package/generated/prisma-postgresql/index-browser.js +30 -39
- package/generated/prisma-postgresql/index.d.ts +3380 -2177
- package/generated/prisma-postgresql/index.js +33 -42
- package/generated/prisma-postgresql/package.json +1 -1
- package/generated/prisma-postgresql/schema.prisma +81 -57
- package/generated/prisma-postgresql/wasm.js +33 -42
- package/handlers/WEBHOOKS.md +0 -29
- package/handlers/app-definition-loader.js +128 -19
- package/handlers/app-handler-helpers.js +27 -8
- package/handlers/backend-utils.js +31 -25
- package/handlers/integration-event-dispatcher.js +3 -7
- package/handlers/middleware/admin-auth.js +14 -1
- package/handlers/routers/auth.js +46 -10
- package/handlers/routers/health.js +13 -4
- package/handlers/routers/integration-defined-routers.js +144 -92
- package/handlers/routers/integration-webhook-routers.js +100 -50
- package/handlers/workers/integration-defined-workers.js +5 -2
- package/index.js +66 -16
- package/infrastructure/scheduler/index.js +19 -6
- package/infrastructure/scheduler/netlify-scheduler-adapter.js +216 -0
- package/infrastructure/scheduler/scheduled-job-repository.js +118 -0
- package/infrastructure/scheduler/scheduler-service-factory.js +55 -7
- package/integrations/index.js +1 -14
- package/integrations/integration-base.js +2 -163
- package/integrations/integration-router.js +132 -102
- package/integrations/repositories/integration-mapping-repository-documentdb.js +0 -50
- package/integrations/repositories/integration-mapping-repository-interface.js +0 -15
- package/integrations/repositories/integration-mapping-repository-mongo.js +0 -29
- package/integrations/repositories/integration-mapping-repository-postgres.js +0 -30
- package/integrations/repositories/integration-mapping-repository.js +0 -29
- package/integrations/repositories/integration-not-found.js +14 -0
- package/integrations/repositories/integration-repository-documentdb.js +37 -9
- package/integrations/repositories/integration-repository-interface.js +17 -4
- package/integrations/repositories/integration-repository-mongo.js +64 -96
- package/integrations/repositories/integration-repository-postgres.js +63 -81
- package/integrations/repositories/process-repository-mongo.js +1 -1
- package/integrations/schedule-config.js +80 -0
- package/integrations/tests/doubles/test-integration-repository.js +12 -1
- package/integrations/use-cases/create-integration.js +56 -31
- package/integrations/use-cases/delete-integration-for-user.js +4 -4
- package/integrations/use-cases/dispatch-ongoing-syncs.js +100 -0
- package/integrations/use-cases/get-integration-for-user.js +2 -4
- package/integrations/use-cases/get-integration-instance.js +4 -4
- package/integrations/use-cases/get-integrations-for-user.js +79 -39
- package/integrations/use-cases/get-possible-integrations.js +2 -7
- package/integrations/use-cases/index.js +7 -1
- package/integrations/use-cases/integration-operations-for-user.js +256 -0
- package/integrations/use-cases/resolve-integration-ownership.js +177 -0
- package/integrations/use-cases/update-integration.js +4 -4
- package/integrations/utils/map-integration-dto.js +43 -14
- package/management-api/create-management-api-router.js +49 -0
- package/management-api/error-response.js +116 -0
- package/management-api/management-api-config.js +151 -0
- package/management-api/meta-router.js +76 -0
- package/management-api/openapi/build-openapi.js +144 -0
- package/management-api/openapi/components.js +415 -0
- package/management-api/openapi/v1-operations.js +83 -0
- package/management-api/openapi/v2-operations.js +264 -0
- package/management-api/route-registry.js +411 -0
- package/management-api/test-support/http-client.js +39 -0
- package/management-api/use-cases/get-management-api-meta.js +57 -0
- package/management-api/v1-deprecation.js +120 -0
- package/management-api/v2/create-v2-router.js +85 -0
- package/management-api/v2/dependencies.js +281 -0
- package/management-api/v2/dto.js +143 -0
- package/management-api/v2/handlers/authorization.js +94 -0
- package/management-api/v2/handlers/credentials.js +33 -0
- package/management-api/v2/handlers/entities.js +77 -0
- package/management-api/v2/handlers/integrations.js +128 -0
- package/management-api/v2/handlers/proxy.js +34 -0
- package/management-api/v2/request.js +85 -0
- package/management-api/v2/test-support/fake-dependencies.js +103 -0
- package/modules/domain/authorization-session.js +144 -0
- package/modules/entity-scope.js +15 -0
- package/modules/entity-type-registry.js +311 -0
- package/modules/index.js +14 -0
- package/modules/module-factory.js +12 -0
- package/modules/module.js +53 -2
- package/modules/proxy/proxy-bases.js +169 -0
- package/modules/proxy/proxy-errors.js +31 -0
- package/modules/proxy/proxy-path.js +183 -0
- package/modules/proxy/proxy-policy.js +277 -0
- package/modules/repositories/authorization-session-repository-documentdb.js +112 -0
- package/modules/repositories/authorization-session-repository-factory.js +31 -0
- package/modules/repositories/authorization-session-repository-interface.js +47 -0
- package/modules/repositories/authorization-session-repository-prisma.js +87 -0
- package/modules/repositories/entity-not-found.js +18 -0
- package/modules/repositories/module-repository-documentdb.js +51 -6
- package/modules/repositories/module-repository-interface.js +19 -2
- package/modules/repositories/module-repository-mongo.js +67 -74
- package/modules/repositories/module-repository-postgres.js +66 -74
- package/modules/repositories/module-repository.js +2 -1
- package/modules/requester/proxy-request.js +245 -0
- package/modules/requester/requester.js +35 -5
- package/modules/scope-config.js +192 -0
- package/modules/scope-policy.js +112 -0
- package/modules/scope-resolution.js +288 -0
- package/modules/scope-visibility.js +247 -0
- package/modules/tests/doubles/in-memory-authorization-session-repository.js +45 -0
- package/modules/tests/doubles/ownership-matching.js +18 -0
- package/modules/use-cases/authorize-entity-for-user.js +61 -0
- package/modules/use-cases/create-entity-from-credential.js +113 -0
- package/modules/use-cases/entity-operations-for-user.js +162 -0
- package/modules/use-cases/entity-types.js +139 -0
- package/modules/use-cases/execute-entity-proxy-request.js +331 -0
- package/modules/use-cases/get-authorization-requirements.js +100 -0
- package/modules/use-cases/get-entities-for-user.js +26 -13
- package/modules/use-cases/get-entity-module-for-user.js +113 -0
- package/modules/use-cases/get-entity-options-by-id.js +10 -4
- package/modules/use-cases/get-entity-options-by-type.js +1 -1
- package/modules/use-cases/get-module-instance-from-type.js +1 -1
- package/modules/use-cases/get-module.js +10 -4
- package/modules/use-cases/manage-access.js +21 -0
- package/modules/use-cases/multi-step-authorization.js +329 -0
- package/modules/use-cases/process-authorization-callback.js +53 -19
- package/modules/use-cases/refresh-entity-options.js +10 -4
- package/modules/use-cases/test-module-auth.js +10 -4
- package/package.json +6 -7
- package/prisma-mongodb/schema.prisma +86 -59
- package/prisma-postgresql/migrations/20261003000000_add_authorization_session/migration.sql +28 -0
- package/prisma-postgresql/migrations/20261015000000_add_organization_membership/migration.sql +26 -0
- package/prisma-postgresql/migrations/20261016000000_add_entity_integration_organization/migration.sql +25 -0
- package/prisma-postgresql/migrations/20261017000000_add_scheduled_job/migration.sql +28 -0
- package/prisma-postgresql/schema.prisma +81 -57
- package/providers/index.js +23 -0
- package/providers/resolve-provider.js +93 -0
- package/providers/runtime-detection.js +124 -0
- package/queues/index.js +25 -0
- package/queues/providers/index.js +11 -0
- package/queues/providers/netlify-background-provider.js +150 -0
- package/queues/providers/qstash-queue-provider.js +219 -0
- package/queues/providers/sqs-queue-provider.js +70 -0
- package/queues/queue-client-interface.js +55 -0
- package/queues/queue-message-auth.js +193 -0
- package/queues/queue-provider-factory.js +101 -0
- package/queues/queue-provider.js +65 -0
- package/queues/queuer-util.js +2 -9
- package/queues/sqs-queue-client.js +81 -0
- package/types/index.d.ts +2 -0
- package/types/modules/index.d.ts +214 -0
- package/types/user/index.d.ts +134 -0
- package/user/adopter-jwt-config.js +177 -0
- package/user/adopter-jwt-errors.js +59 -0
- package/user/adopter-token-verifier.js +122 -0
- package/user/app-user-helpers.js +97 -0
- package/user/create-user-authentication.js +64 -0
- package/user/membership.js +51 -0
- package/user/repositories/organization-membership-record.js +19 -0
- package/user/repositories/organization-membership-repository-documentdb.js +106 -0
- package/user/repositories/organization-membership-repository-factory.js +42 -0
- package/user/repositories/organization-membership-repository-interface.js +57 -0
- package/user/repositories/organization-membership-repository-mongo.js +13 -0
- package/user/repositories/organization-membership-repository-postgres.js +29 -0
- package/user/repositories/organization-membership-repository-prisma.js +81 -0
- package/user/repositories/user-repository-documentdb.js +27 -2
- package/user/repositories/user-repository-interface.js +18 -0
- package/user/repositories/user-repository-mongo.js +24 -0
- package/user/repositories/user-repository-postgres.js +18 -0
- package/user/tests/doubles/adopter-jwt-fixtures.js +220 -0
- package/user/use-cases/authenticate-user.js +7 -1
- package/user/use-cases/ensure-organization-membership.js +92 -0
- package/user/use-cases/find-individual-users-by-organization.js +54 -0
- package/user/use-cases/get-user-from-adopter-jwt.js +95 -124
- package/user/use-cases/get-user-from-x-frigg-headers.js +83 -80
- package/user/user.js +64 -1
- package/errors/mapping-already-exists-error.js +0 -14
- package/handlers/workers/integration-triggers.js +0 -25
- package/infrastructure/scheduler/recurrence.js +0 -204
- package/integrations/define/DESIGN.md +0 -122
- package/integrations/define/config.js +0 -98
- package/integrations/define/define-app.js +0 -66
- package/integrations/define/define-extension.js +0 -154
- package/integrations/define/define-integration.js +0 -335
- package/integrations/define/examples/deal-alerts.js +0 -140
- package/integrations/define/extension-binding.js +0 -174
- package/integrations/define/index.js +0 -11
- package/integrations/define/json-schema-lite.js +0 -68
- package/integrations/define/subscriptions.js +0 -186
- package/integrations/define/tests/fixtures/hubspot.js +0 -109
- package/integrations/define/tests/fixtures/slack.js +0 -26
- package/integrations/define/use.js +0 -39
- package/integrations/definitions/README.md +0 -278
- package/integrations/definitions/canonical.js +0 -11
- package/integrations/definitions/capabilities/AUDIT.md +0 -480
- package/integrations/definitions/capabilities/acmeerp.capabilities.json +0 -633
- package/integrations/definitions/capabilities/asana.capabilities.json +0 -279
- package/integrations/definitions/capabilities/calendly.capabilities.json +0 -385
- package/integrations/definitions/capabilities/docusign.capabilities.json +0 -314
- package/integrations/definitions/capabilities/fathom.capabilities.json +0 -238
- package/integrations/definitions/capabilities/github.capabilities.json +0 -585
- package/integrations/definitions/capabilities/hubspot.capabilities.json +0 -822
- package/integrations/definitions/capabilities/jira.capabilities.json +0 -391
- package/integrations/definitions/capabilities/klaviyo.capabilities.json +0 -503
- package/integrations/definitions/capabilities/linear.capabilities.json +0 -378
- package/integrations/definitions/capabilities/netsuite.capabilities.json +0 -535
- package/integrations/definitions/capabilities/notion.capabilities.json +0 -208
- package/integrations/definitions/capabilities/phone.capabilities.json +0 -511
- package/integrations/definitions/capabilities/pipedrive.capabilities.json +0 -430
- package/integrations/definitions/capabilities/quickbooks.capabilities.json +0 -635
- package/integrations/definitions/capabilities/salesforce.capabilities.json +0 -568
- package/integrations/definitions/capabilities/shopify.capabilities.json +0 -1128
- package/integrations/definitions/capabilities/slack.capabilities.json +0 -373
- package/integrations/definitions/capabilities/stripe.capabilities.json +0 -630
- package/integrations/definitions/capabilities/webflow.capabilities.json +0 -196
- package/integrations/definitions/capabilities/zendesk.capabilities.json +0 -422
- package/integrations/definitions/compile.js +0 -80
- package/integrations/definitions/config-form.js +0 -137
- package/integrations/definitions/examples/acme-erp-quickbooks.definition.json +0 -467
- package/integrations/definitions/examples/asana-slack.definition.json +0 -219
- package/integrations/definitions/examples/calendly-salesforce.definition.json +0 -459
- package/integrations/definitions/examples/docusign-salesforce.definition.json +0 -305
- package/integrations/definitions/examples/fathom-hubspot-notion.definition.json +0 -575
- package/integrations/definitions/examples/github-linear.definition.json +0 -322
- package/integrations/definitions/examples/hubspot-slack.definition.json +0 -427
- package/integrations/definitions/examples/klaviyo-hubspot.definition.json +0 -336
- package/integrations/definitions/examples/phone-hubspot.definition.json +0 -633
- package/integrations/definitions/examples/pipedrive-hubspot.definition.json +0 -136
- package/integrations/definitions/examples/pipedrive-phone.definition.json +0 -340
- package/integrations/definitions/examples/records/phone-hubspot.definition-version.json +0 -652
- package/integrations/definitions/examples/records/phone-hubspot.integration.json +0 -86
- package/integrations/definitions/examples/records/phone-hubspot.mappings.json +0 -39
- package/integrations/definitions/examples/records/phone-hubspot.workflow-run.json +0 -62
- package/integrations/definitions/examples/shopify-klaviyo.definition.json +0 -488
- package/integrations/definitions/examples/shopify-netsuite.definition.json +0 -622
- package/integrations/definitions/examples/stripe-quickbooks.definition.json +0 -476
- package/integrations/definitions/examples/webflow-hubspot-slack.definition.json +0 -262
- package/integrations/definitions/examples/zendesk-jira.definition.json +0 -604
- package/integrations/definitions/expressions.js +0 -229
- package/integrations/definitions/index.js +0 -48
- package/integrations/definitions/integration-runtime.js +0 -779
- package/integrations/definitions/interpreter.js +0 -104
- package/integrations/definitions/manifests.js +0 -177
- package/integrations/definitions/renderers/common.js +0 -67
- package/integrations/definitions/renderers/html.js +0 -129
- package/integrations/definitions/renderers/hubspot.js +0 -59
- package/integrations/definitions/renderers/preview.js +0 -154
- package/integrations/definitions/renderers/slack.js +0 -146
- package/integrations/definitions/repositories/definition-version-repository.js +0 -67
- package/integrations/definitions/repositories/workflow-run-repository.js +0 -80
- package/integrations/definitions/router.js +0 -170
- package/integrations/definitions/runtime.js +0 -268
- package/integrations/definitions/schema/capability-manifest.v0.1.schema.json +0 -549
- package/integrations/definitions/schema/installation.v0.1.schema.json +0 -130
- package/integrations/definitions/schema/integration-definition.v0.1.schema.json +0 -909
- package/integrations/definitions/schema/records.md +0 -105
- package/integrations/definitions/schema-check.js +0 -58
- package/integrations/definitions/scripts/check-manifests.js +0 -220
- package/integrations/definitions/scripts/validate.js +0 -66
- package/integrations/definitions/steps.js +0 -123
- package/integrations/definitions/sync-engine.js +0 -297
- package/integrations/definitions/tests/helpers-fake-crm.js +0 -49
- package/integrations/definitions/transforms.js +0 -91
- package/integrations/definitions/use-cases/definition-use-cases.js +0 -245
- package/integrations/definitions/validate.js +0 -436
- package/integrations/definitions/versioning.js +0 -176
- package/integrations/definitions/webhooks.js +0 -119
- package/integrations/integration-types.js +0 -73
- package/integrations/triggers.js +0 -244
- package/integrations/use-cases/run-trigger-tick.js +0 -155
- package/integrations/use-cases/run-trigger.js +0 -77
- package/prisma-postgresql/migrations/20261018000000_add_data_defined_integrations/migration.sql +0 -66
- package/prisma-postgresql/migrations/20261019000000_workflow_run_waits/migration.sql +0 -7
- package/prisma-postgresql/migrations/20261019120000_definition_workspace/migration.sql +0 -5
|
@@ -1,1128 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"$schema": "https://friggframework.org/schemas/capability-manifest/v0.1.json",
|
|
3
|
-
"module": "shopify",
|
|
4
|
-
"label": "Shopify",
|
|
5
|
-
"package": "@friggframework/api-module-shopify",
|
|
6
|
-
"version": "3.1.0",
|
|
7
|
-
"auth": "oauth2",
|
|
8
|
-
"objects": {
|
|
9
|
-
"customer": {
|
|
10
|
-
"label": "Customer",
|
|
11
|
-
"fields": [
|
|
12
|
-
{
|
|
13
|
-
"name": "id",
|
|
14
|
-
"type": "id",
|
|
15
|
-
"readOnly": true
|
|
16
|
-
},
|
|
17
|
-
{
|
|
18
|
-
"name": "email",
|
|
19
|
-
"type": "email",
|
|
20
|
-
"tag": "contact.email"
|
|
21
|
-
},
|
|
22
|
-
{
|
|
23
|
-
"name": "first_name",
|
|
24
|
-
"type": "string",
|
|
25
|
-
"tag": "person.givenName"
|
|
26
|
-
},
|
|
27
|
-
{
|
|
28
|
-
"name": "last_name",
|
|
29
|
-
"type": "string",
|
|
30
|
-
"tag": "person.familyName"
|
|
31
|
-
},
|
|
32
|
-
{
|
|
33
|
-
"name": "phone",
|
|
34
|
-
"type": "phone",
|
|
35
|
-
"tag": "contact.phone"
|
|
36
|
-
},
|
|
37
|
-
{
|
|
38
|
-
"name": "tags",
|
|
39
|
-
"type": "string",
|
|
40
|
-
"tag": "record.tags"
|
|
41
|
-
},
|
|
42
|
-
{
|
|
43
|
-
"name": "note",
|
|
44
|
-
"type": "text"
|
|
45
|
-
},
|
|
46
|
-
{
|
|
47
|
-
"name": "email_marketing_consent.state",
|
|
48
|
-
"type": "enum",
|
|
49
|
-
"tag": "contact.emailConsent",
|
|
50
|
-
"values": [
|
|
51
|
-
"subscribed",
|
|
52
|
-
"not_subscribed",
|
|
53
|
-
"pending",
|
|
54
|
-
"unsubscribed",
|
|
55
|
-
"redacted",
|
|
56
|
-
"invalid"
|
|
57
|
-
]
|
|
58
|
-
},
|
|
59
|
-
{
|
|
60
|
-
"name": "default_address.company",
|
|
61
|
-
"type": "string",
|
|
62
|
-
"tag": "organization.name"
|
|
63
|
-
},
|
|
64
|
-
{
|
|
65
|
-
"name": "default_address.address1",
|
|
66
|
-
"type": "string",
|
|
67
|
-
"tag": "address.line1"
|
|
68
|
-
},
|
|
69
|
-
{
|
|
70
|
-
"name": "default_address.city",
|
|
71
|
-
"type": "string",
|
|
72
|
-
"tag": "address.locality"
|
|
73
|
-
},
|
|
74
|
-
{
|
|
75
|
-
"name": "default_address.province_code",
|
|
76
|
-
"type": "string",
|
|
77
|
-
"tag": "address.region"
|
|
78
|
-
},
|
|
79
|
-
{
|
|
80
|
-
"name": "default_address.zip",
|
|
81
|
-
"type": "string",
|
|
82
|
-
"tag": "address.postalCode"
|
|
83
|
-
},
|
|
84
|
-
{
|
|
85
|
-
"name": "default_address.country_code",
|
|
86
|
-
"type": "string",
|
|
87
|
-
"tag": "address.country"
|
|
88
|
-
},
|
|
89
|
-
{
|
|
90
|
-
"name": "orders_count",
|
|
91
|
-
"type": "number",
|
|
92
|
-
"tag": "customer.orderCount",
|
|
93
|
-
"readOnly": true
|
|
94
|
-
},
|
|
95
|
-
{
|
|
96
|
-
"name": "total_spent",
|
|
97
|
-
"type": "number",
|
|
98
|
-
"tag": "customer.lifetimeValue",
|
|
99
|
-
"readOnly": true
|
|
100
|
-
},
|
|
101
|
-
{
|
|
102
|
-
"name": "created_at",
|
|
103
|
-
"type": "datetime",
|
|
104
|
-
"tag": "record.createdAt",
|
|
105
|
-
"readOnly": true
|
|
106
|
-
},
|
|
107
|
-
{
|
|
108
|
-
"name": "updated_at",
|
|
109
|
-
"type": "datetime",
|
|
110
|
-
"tag": "record.updatedAt",
|
|
111
|
-
"readOnly": true
|
|
112
|
-
}
|
|
113
|
-
],
|
|
114
|
-
"sync": {
|
|
115
|
-
"id": "id",
|
|
116
|
-
"updatedAt": "updated_at",
|
|
117
|
-
"list": {
|
|
118
|
-
"capability": "customer.list",
|
|
119
|
-
"cursor": "page_info",
|
|
120
|
-
"limit": "limit",
|
|
121
|
-
"since": "updated_at_min",
|
|
122
|
-
"items": "customers",
|
|
123
|
-
"next": "nextPageInfo"
|
|
124
|
-
},
|
|
125
|
-
"get": {
|
|
126
|
-
"capability": "customer.get",
|
|
127
|
-
"id": "id"
|
|
128
|
-
},
|
|
129
|
-
"create": {
|
|
130
|
-
"capability": "customer.create",
|
|
131
|
-
"body": "customer"
|
|
132
|
-
},
|
|
133
|
-
"update": {
|
|
134
|
-
"capability": "customer.update",
|
|
135
|
-
"id": "id",
|
|
136
|
-
"body": "customer"
|
|
137
|
-
}
|
|
138
|
-
}
|
|
139
|
-
},
|
|
140
|
-
"order": {
|
|
141
|
-
"label": "Order",
|
|
142
|
-
"fields": [
|
|
143
|
-
{
|
|
144
|
-
"name": "id",
|
|
145
|
-
"type": "id",
|
|
146
|
-
"readOnly": true
|
|
147
|
-
},
|
|
148
|
-
{
|
|
149
|
-
"name": "name",
|
|
150
|
-
"type": "string",
|
|
151
|
-
"tag": "order.number",
|
|
152
|
-
"readOnly": true
|
|
153
|
-
},
|
|
154
|
-
{
|
|
155
|
-
"name": "order_number",
|
|
156
|
-
"type": "number",
|
|
157
|
-
"readOnly": true
|
|
158
|
-
},
|
|
159
|
-
{
|
|
160
|
-
"name": "email",
|
|
161
|
-
"type": "email",
|
|
162
|
-
"tag": "contact.email"
|
|
163
|
-
},
|
|
164
|
-
{
|
|
165
|
-
"name": "created_at",
|
|
166
|
-
"type": "datetime",
|
|
167
|
-
"tag": "order.createdAt",
|
|
168
|
-
"readOnly": true
|
|
169
|
-
},
|
|
170
|
-
{
|
|
171
|
-
"name": "processed_at",
|
|
172
|
-
"type": "datetime"
|
|
173
|
-
},
|
|
174
|
-
{
|
|
175
|
-
"name": "currency",
|
|
176
|
-
"type": "string",
|
|
177
|
-
"tag": "order.currency"
|
|
178
|
-
},
|
|
179
|
-
{
|
|
180
|
-
"name": "financial_status",
|
|
181
|
-
"type": "enum",
|
|
182
|
-
"tag": "order.paymentStatus",
|
|
183
|
-
"values": [
|
|
184
|
-
"pending",
|
|
185
|
-
"authorized",
|
|
186
|
-
"partially_paid",
|
|
187
|
-
"paid",
|
|
188
|
-
"partially_refunded",
|
|
189
|
-
"refunded",
|
|
190
|
-
"voided"
|
|
191
|
-
]
|
|
192
|
-
},
|
|
193
|
-
{
|
|
194
|
-
"name": "fulfillment_status",
|
|
195
|
-
"type": "enum",
|
|
196
|
-
"tag": "order.fulfillmentStatus",
|
|
197
|
-
"values": [
|
|
198
|
-
"unfulfilled",
|
|
199
|
-
"partial",
|
|
200
|
-
"fulfilled",
|
|
201
|
-
"restocked"
|
|
202
|
-
]
|
|
203
|
-
},
|
|
204
|
-
{
|
|
205
|
-
"name": "subtotal_price",
|
|
206
|
-
"type": "number",
|
|
207
|
-
"tag": "order.subtotal"
|
|
208
|
-
},
|
|
209
|
-
{
|
|
210
|
-
"name": "total_discounts",
|
|
211
|
-
"type": "number",
|
|
212
|
-
"tag": "order.discount"
|
|
213
|
-
},
|
|
214
|
-
{
|
|
215
|
-
"name": "total_tax",
|
|
216
|
-
"type": "number",
|
|
217
|
-
"tag": "order.tax"
|
|
218
|
-
},
|
|
219
|
-
{
|
|
220
|
-
"name": "total_price",
|
|
221
|
-
"type": "number",
|
|
222
|
-
"tag": "order.total"
|
|
223
|
-
},
|
|
224
|
-
{
|
|
225
|
-
"name": "total_shipping_price_set.shop_money.amount",
|
|
226
|
-
"type": "number",
|
|
227
|
-
"tag": "order.shipping"
|
|
228
|
-
},
|
|
229
|
-
{
|
|
230
|
-
"name": "customer.id",
|
|
231
|
-
"type": "string"
|
|
232
|
-
},
|
|
233
|
-
{
|
|
234
|
-
"name": "line_items",
|
|
235
|
-
"type": "lineItem[]",
|
|
236
|
-
"tag": "order.lineItems"
|
|
237
|
-
},
|
|
238
|
-
{
|
|
239
|
-
"name": "discount_codes",
|
|
240
|
-
"type": "json"
|
|
241
|
-
},
|
|
242
|
-
{
|
|
243
|
-
"name": "shipping_address.name",
|
|
244
|
-
"type": "string",
|
|
245
|
-
"tag": "person.fullName"
|
|
246
|
-
},
|
|
247
|
-
{
|
|
248
|
-
"name": "shipping_address.address1",
|
|
249
|
-
"type": "string",
|
|
250
|
-
"tag": "address.line1"
|
|
251
|
-
},
|
|
252
|
-
{
|
|
253
|
-
"name": "shipping_address.city",
|
|
254
|
-
"type": "string",
|
|
255
|
-
"tag": "address.locality"
|
|
256
|
-
},
|
|
257
|
-
{
|
|
258
|
-
"name": "shipping_address.province_code",
|
|
259
|
-
"type": "string",
|
|
260
|
-
"tag": "address.region"
|
|
261
|
-
},
|
|
262
|
-
{
|
|
263
|
-
"name": "shipping_address.zip",
|
|
264
|
-
"type": "string",
|
|
265
|
-
"tag": "address.postalCode"
|
|
266
|
-
},
|
|
267
|
-
{
|
|
268
|
-
"name": "shipping_address.country_code",
|
|
269
|
-
"type": "string",
|
|
270
|
-
"tag": "address.country"
|
|
271
|
-
},
|
|
272
|
-
{
|
|
273
|
-
"name": "note",
|
|
274
|
-
"type": "text"
|
|
275
|
-
},
|
|
276
|
-
{
|
|
277
|
-
"name": "tags",
|
|
278
|
-
"type": "string",
|
|
279
|
-
"tag": "record.tags"
|
|
280
|
-
},
|
|
281
|
-
{
|
|
282
|
-
"name": "source_name",
|
|
283
|
-
"type": "string"
|
|
284
|
-
}
|
|
285
|
-
],
|
|
286
|
-
"sync": {
|
|
287
|
-
"id": "id",
|
|
288
|
-
"updatedAt": "updated_at",
|
|
289
|
-
"list": {
|
|
290
|
-
"capability": "order.list",
|
|
291
|
-
"cursor": "page_info",
|
|
292
|
-
"limit": "limit",
|
|
293
|
-
"since": "updated_at_min",
|
|
294
|
-
"items": "orders",
|
|
295
|
-
"next": "nextPageInfo"
|
|
296
|
-
},
|
|
297
|
-
"get": {
|
|
298
|
-
"capability": "order.get",
|
|
299
|
-
"id": "id"
|
|
300
|
-
},
|
|
301
|
-
"update": {
|
|
302
|
-
"capability": "order.update",
|
|
303
|
-
"id": "id",
|
|
304
|
-
"body": "order"
|
|
305
|
-
}
|
|
306
|
-
}
|
|
307
|
-
},
|
|
308
|
-
"fulfillment": {
|
|
309
|
-
"label": "Fulfillment",
|
|
310
|
-
"fields": [
|
|
311
|
-
{
|
|
312
|
-
"name": "id",
|
|
313
|
-
"type": "id",
|
|
314
|
-
"readOnly": true
|
|
315
|
-
},
|
|
316
|
-
{
|
|
317
|
-
"name": "order_id",
|
|
318
|
-
"type": "string"
|
|
319
|
-
},
|
|
320
|
-
{
|
|
321
|
-
"name": "status",
|
|
322
|
-
"type": "enum",
|
|
323
|
-
"values": [
|
|
324
|
-
"pending",
|
|
325
|
-
"open",
|
|
326
|
-
"success",
|
|
327
|
-
"cancelled",
|
|
328
|
-
"error",
|
|
329
|
-
"failure"
|
|
330
|
-
]
|
|
331
|
-
},
|
|
332
|
-
{
|
|
333
|
-
"name": "tracking_company",
|
|
334
|
-
"type": "string",
|
|
335
|
-
"tag": "shipment.carrier"
|
|
336
|
-
},
|
|
337
|
-
{
|
|
338
|
-
"name": "tracking_number",
|
|
339
|
-
"type": "string",
|
|
340
|
-
"tag": "shipment.trackingNumber"
|
|
341
|
-
},
|
|
342
|
-
{
|
|
343
|
-
"name": "tracking_url",
|
|
344
|
-
"type": "string",
|
|
345
|
-
"tag": "shipment.trackingUrl"
|
|
346
|
-
},
|
|
347
|
-
{
|
|
348
|
-
"name": "created_at",
|
|
349
|
-
"type": "datetime",
|
|
350
|
-
"readOnly": true
|
|
351
|
-
}
|
|
352
|
-
]
|
|
353
|
-
},
|
|
354
|
-
"refund": {
|
|
355
|
-
"label": "Refund",
|
|
356
|
-
"fields": [
|
|
357
|
-
{
|
|
358
|
-
"name": "id",
|
|
359
|
-
"type": "id",
|
|
360
|
-
"readOnly": true
|
|
361
|
-
},
|
|
362
|
-
{
|
|
363
|
-
"name": "order_id",
|
|
364
|
-
"type": "string"
|
|
365
|
-
},
|
|
366
|
-
{
|
|
367
|
-
"name": "created_at",
|
|
368
|
-
"type": "datetime",
|
|
369
|
-
"readOnly": true
|
|
370
|
-
},
|
|
371
|
-
{
|
|
372
|
-
"name": "note",
|
|
373
|
-
"type": "text"
|
|
374
|
-
},
|
|
375
|
-
{
|
|
376
|
-
"name": "refund_line_items",
|
|
377
|
-
"type": "json"
|
|
378
|
-
},
|
|
379
|
-
{
|
|
380
|
-
"name": "transactions",
|
|
381
|
-
"type": "json"
|
|
382
|
-
}
|
|
383
|
-
]
|
|
384
|
-
},
|
|
385
|
-
"checkout": {
|
|
386
|
-
"label": "Abandoned checkout",
|
|
387
|
-
"fields": [
|
|
388
|
-
{
|
|
389
|
-
"name": "id",
|
|
390
|
-
"type": "id",
|
|
391
|
-
"readOnly": true
|
|
392
|
-
},
|
|
393
|
-
{
|
|
394
|
-
"name": "token",
|
|
395
|
-
"type": "string"
|
|
396
|
-
},
|
|
397
|
-
{
|
|
398
|
-
"name": "email",
|
|
399
|
-
"type": "email",
|
|
400
|
-
"tag": "contact.email"
|
|
401
|
-
},
|
|
402
|
-
{
|
|
403
|
-
"name": "abandoned_checkout_url",
|
|
404
|
-
"type": "string"
|
|
405
|
-
},
|
|
406
|
-
{
|
|
407
|
-
"name": "total_price",
|
|
408
|
-
"type": "number",
|
|
409
|
-
"tag": "order.total"
|
|
410
|
-
},
|
|
411
|
-
{
|
|
412
|
-
"name": "currency",
|
|
413
|
-
"type": "string",
|
|
414
|
-
"tag": "order.currency"
|
|
415
|
-
},
|
|
416
|
-
{
|
|
417
|
-
"name": "line_items",
|
|
418
|
-
"type": "lineItem[]",
|
|
419
|
-
"tag": "order.lineItems"
|
|
420
|
-
},
|
|
421
|
-
{
|
|
422
|
-
"name": "customer.id",
|
|
423
|
-
"type": "string"
|
|
424
|
-
},
|
|
425
|
-
{
|
|
426
|
-
"name": "created_at",
|
|
427
|
-
"type": "datetime",
|
|
428
|
-
"readOnly": true
|
|
429
|
-
},
|
|
430
|
-
{
|
|
431
|
-
"name": "completed_at",
|
|
432
|
-
"type": "datetime",
|
|
433
|
-
"readOnly": true
|
|
434
|
-
}
|
|
435
|
-
]
|
|
436
|
-
},
|
|
437
|
-
"inventoryLevel": {
|
|
438
|
-
"label": "Inventory level",
|
|
439
|
-
"fields": [
|
|
440
|
-
{
|
|
441
|
-
"name": "inventory_item_id",
|
|
442
|
-
"type": "id"
|
|
443
|
-
},
|
|
444
|
-
{
|
|
445
|
-
"name": "location_id",
|
|
446
|
-
"type": "string"
|
|
447
|
-
},
|
|
448
|
-
{
|
|
449
|
-
"name": "available",
|
|
450
|
-
"type": "number",
|
|
451
|
-
"tag": "inventory.available"
|
|
452
|
-
},
|
|
453
|
-
{
|
|
454
|
-
"name": "updated_at",
|
|
455
|
-
"type": "datetime",
|
|
456
|
-
"readOnly": true
|
|
457
|
-
}
|
|
458
|
-
]
|
|
459
|
-
}
|
|
460
|
-
},
|
|
461
|
-
"events": {
|
|
462
|
-
"order.created": {
|
|
463
|
-
"delivery": "webhook",
|
|
464
|
-
"subscribe": "webhook.create",
|
|
465
|
-
"description": "Shopify topic orders/create. The payload is the resource itself.",
|
|
466
|
-
"object": "order",
|
|
467
|
-
"payload": {
|
|
468
|
-
"id": 5612789014562,
|
|
469
|
-
"admin_graphql_api_id": "gid://shopify/Order/5612789014562",
|
|
470
|
-
"name": "#1042",
|
|
471
|
-
"order_number": 1042,
|
|
472
|
-
"email": "dana.reyes@example.com",
|
|
473
|
-
"created_at": "2026-10-18T09:14:22-05:00",
|
|
474
|
-
"processed_at": "2026-10-18T09:14:21-05:00",
|
|
475
|
-
"currency": "USD",
|
|
476
|
-
"financial_status": "paid",
|
|
477
|
-
"fulfillment_status": null,
|
|
478
|
-
"subtotal_price": "128.00",
|
|
479
|
-
"total_discounts": "12.80",
|
|
480
|
-
"total_tax": "9.50",
|
|
481
|
-
"total_price": "139.70",
|
|
482
|
-
"total_shipping_price_set": {
|
|
483
|
-
"shop_money": {
|
|
484
|
-
"amount": "15.00",
|
|
485
|
-
"currency_code": "USD"
|
|
486
|
-
}
|
|
487
|
-
},
|
|
488
|
-
"discount_codes": [
|
|
489
|
-
{
|
|
490
|
-
"code": "FALL10",
|
|
491
|
-
"amount": "12.80",
|
|
492
|
-
"type": "percentage"
|
|
493
|
-
}
|
|
494
|
-
],
|
|
495
|
-
"note": "Gift wrap please",
|
|
496
|
-
"tags": "wholesale",
|
|
497
|
-
"source_name": "web",
|
|
498
|
-
"customer": {
|
|
499
|
-
"id": 7012345678901,
|
|
500
|
-
"email": "dana.reyes@example.com",
|
|
501
|
-
"first_name": "Dana",
|
|
502
|
-
"last_name": "Reyes"
|
|
503
|
-
},
|
|
504
|
-
"line_items": [
|
|
505
|
-
{
|
|
506
|
-
"id": 13579246801,
|
|
507
|
-
"variant_id": 44012345678,
|
|
508
|
-
"product_id": 8123456789,
|
|
509
|
-
"sku": "TW-MUG-12",
|
|
510
|
-
"title": "Acme Mug",
|
|
511
|
-
"variant_title": "12 oz / Slate",
|
|
512
|
-
"quantity": 2,
|
|
513
|
-
"price": "32.00",
|
|
514
|
-
"total_discount": "6.40"
|
|
515
|
-
},
|
|
516
|
-
{
|
|
517
|
-
"id": 13579246802,
|
|
518
|
-
"variant_id": 44012345690,
|
|
519
|
-
"product_id": 8123456790,
|
|
520
|
-
"sku": "TW-PRESS-01",
|
|
521
|
-
"title": "Pour-over Press",
|
|
522
|
-
"variant_title": null,
|
|
523
|
-
"quantity": 1,
|
|
524
|
-
"price": "64.00",
|
|
525
|
-
"total_discount": "6.40"
|
|
526
|
-
}
|
|
527
|
-
],
|
|
528
|
-
"shipping_address": {
|
|
529
|
-
"name": "Dana Reyes",
|
|
530
|
-
"address1": "501 Congress Ave",
|
|
531
|
-
"city": "Austin",
|
|
532
|
-
"province_code": "TX",
|
|
533
|
-
"zip": "78701",
|
|
534
|
-
"country_code": "US",
|
|
535
|
-
"phone": "+15125550142"
|
|
536
|
-
}
|
|
537
|
-
},
|
|
538
|
-
"match": "orders/create",
|
|
539
|
-
"headers": {
|
|
540
|
-
"x-shopify-topic": "orders/create",
|
|
541
|
-
"x-shopify-webhook-id": "b54557e4-order-created",
|
|
542
|
-
"x-shopify-shop-domain": "acme.myshopify.com"
|
|
543
|
-
}
|
|
544
|
-
},
|
|
545
|
-
"order.paid": {
|
|
546
|
-
"delivery": "webhook",
|
|
547
|
-
"subscribe": "webhook.create",
|
|
548
|
-
"description": "Shopify topic orders/paid. The payload is the resource itself.",
|
|
549
|
-
"object": "order",
|
|
550
|
-
"payload": {
|
|
551
|
-
"id": 5612789014562,
|
|
552
|
-
"admin_graphql_api_id": "gid://shopify/Order/5612789014562",
|
|
553
|
-
"name": "#1042",
|
|
554
|
-
"order_number": 1042,
|
|
555
|
-
"email": "dana.reyes@example.com",
|
|
556
|
-
"created_at": "2026-10-18T09:14:22-05:00",
|
|
557
|
-
"processed_at": "2026-10-18T09:14:21-05:00",
|
|
558
|
-
"currency": "USD",
|
|
559
|
-
"financial_status": "paid",
|
|
560
|
-
"fulfillment_status": null,
|
|
561
|
-
"subtotal_price": "128.00",
|
|
562
|
-
"total_discounts": "12.80",
|
|
563
|
-
"total_tax": "9.50",
|
|
564
|
-
"total_price": "139.70",
|
|
565
|
-
"total_shipping_price_set": {
|
|
566
|
-
"shop_money": {
|
|
567
|
-
"amount": "15.00",
|
|
568
|
-
"currency_code": "USD"
|
|
569
|
-
}
|
|
570
|
-
},
|
|
571
|
-
"discount_codes": [
|
|
572
|
-
{
|
|
573
|
-
"code": "FALL10",
|
|
574
|
-
"amount": "12.80",
|
|
575
|
-
"type": "percentage"
|
|
576
|
-
}
|
|
577
|
-
],
|
|
578
|
-
"note": "Gift wrap please",
|
|
579
|
-
"tags": "wholesale",
|
|
580
|
-
"source_name": "web",
|
|
581
|
-
"customer": {
|
|
582
|
-
"id": 7012345678901,
|
|
583
|
-
"email": "dana.reyes@example.com",
|
|
584
|
-
"first_name": "Dana",
|
|
585
|
-
"last_name": "Reyes"
|
|
586
|
-
},
|
|
587
|
-
"line_items": [
|
|
588
|
-
{
|
|
589
|
-
"id": 13579246801,
|
|
590
|
-
"variant_id": 44012345678,
|
|
591
|
-
"product_id": 8123456789,
|
|
592
|
-
"sku": "TW-MUG-12",
|
|
593
|
-
"title": "Acme Mug",
|
|
594
|
-
"variant_title": "12 oz / Slate",
|
|
595
|
-
"quantity": 2,
|
|
596
|
-
"price": "32.00",
|
|
597
|
-
"total_discount": "6.40"
|
|
598
|
-
},
|
|
599
|
-
{
|
|
600
|
-
"id": 13579246802,
|
|
601
|
-
"variant_id": 44012345690,
|
|
602
|
-
"product_id": 8123456790,
|
|
603
|
-
"sku": "TW-PRESS-01",
|
|
604
|
-
"title": "Pour-over Press",
|
|
605
|
-
"variant_title": null,
|
|
606
|
-
"quantity": 1,
|
|
607
|
-
"price": "64.00",
|
|
608
|
-
"total_discount": "6.40"
|
|
609
|
-
}
|
|
610
|
-
],
|
|
611
|
-
"shipping_address": {
|
|
612
|
-
"name": "Dana Reyes",
|
|
613
|
-
"address1": "501 Congress Ave",
|
|
614
|
-
"city": "Austin",
|
|
615
|
-
"province_code": "TX",
|
|
616
|
-
"zip": "78701",
|
|
617
|
-
"country_code": "US",
|
|
618
|
-
"phone": "+15125550142"
|
|
619
|
-
}
|
|
620
|
-
},
|
|
621
|
-
"match": "orders/paid",
|
|
622
|
-
"headers": {
|
|
623
|
-
"x-shopify-topic": "orders/paid",
|
|
624
|
-
"x-shopify-webhook-id": "b54557e4-order-paid",
|
|
625
|
-
"x-shopify-shop-domain": "acme.myshopify.com"
|
|
626
|
-
}
|
|
627
|
-
},
|
|
628
|
-
"order.updated": {
|
|
629
|
-
"delivery": "webhook",
|
|
630
|
-
"subscribe": "webhook.create",
|
|
631
|
-
"description": "Shopify topic orders/updated. The payload is the resource itself.",
|
|
632
|
-
"object": "order",
|
|
633
|
-
"payload": {
|
|
634
|
-
"id": 5612789014562,
|
|
635
|
-
"admin_graphql_api_id": "gid://shopify/Order/5612789014562",
|
|
636
|
-
"name": "#1042",
|
|
637
|
-
"order_number": 1042,
|
|
638
|
-
"email": "dana.reyes@example.com",
|
|
639
|
-
"created_at": "2026-10-18T09:14:22-05:00",
|
|
640
|
-
"processed_at": "2026-10-18T09:14:21-05:00",
|
|
641
|
-
"currency": "USD",
|
|
642
|
-
"financial_status": "paid",
|
|
643
|
-
"fulfillment_status": null,
|
|
644
|
-
"subtotal_price": "128.00",
|
|
645
|
-
"total_discounts": "12.80",
|
|
646
|
-
"total_tax": "9.50",
|
|
647
|
-
"total_price": "139.70",
|
|
648
|
-
"total_shipping_price_set": {
|
|
649
|
-
"shop_money": {
|
|
650
|
-
"amount": "15.00",
|
|
651
|
-
"currency_code": "USD"
|
|
652
|
-
}
|
|
653
|
-
},
|
|
654
|
-
"discount_codes": [
|
|
655
|
-
{
|
|
656
|
-
"code": "FALL10",
|
|
657
|
-
"amount": "12.80",
|
|
658
|
-
"type": "percentage"
|
|
659
|
-
}
|
|
660
|
-
],
|
|
661
|
-
"note": "Gift wrap please",
|
|
662
|
-
"tags": "wholesale, gift",
|
|
663
|
-
"source_name": "web",
|
|
664
|
-
"customer": {
|
|
665
|
-
"id": 7012345678901,
|
|
666
|
-
"email": "dana.reyes@example.com",
|
|
667
|
-
"first_name": "Dana",
|
|
668
|
-
"last_name": "Reyes"
|
|
669
|
-
},
|
|
670
|
-
"line_items": [
|
|
671
|
-
{
|
|
672
|
-
"id": 13579246801,
|
|
673
|
-
"variant_id": 44012345678,
|
|
674
|
-
"product_id": 8123456789,
|
|
675
|
-
"sku": "TW-MUG-12",
|
|
676
|
-
"title": "Acme Mug",
|
|
677
|
-
"variant_title": "12 oz / Slate",
|
|
678
|
-
"quantity": 2,
|
|
679
|
-
"price": "32.00",
|
|
680
|
-
"total_discount": "6.40"
|
|
681
|
-
},
|
|
682
|
-
{
|
|
683
|
-
"id": 13579246802,
|
|
684
|
-
"variant_id": 44012345690,
|
|
685
|
-
"product_id": 8123456790,
|
|
686
|
-
"sku": "TW-PRESS-01",
|
|
687
|
-
"title": "Pour-over Press",
|
|
688
|
-
"variant_title": null,
|
|
689
|
-
"quantity": 1,
|
|
690
|
-
"price": "64.00",
|
|
691
|
-
"total_discount": "6.40"
|
|
692
|
-
}
|
|
693
|
-
],
|
|
694
|
-
"shipping_address": {
|
|
695
|
-
"name": "Dana Reyes",
|
|
696
|
-
"address1": "501 Congress Ave",
|
|
697
|
-
"city": "Austin",
|
|
698
|
-
"province_code": "TX",
|
|
699
|
-
"zip": "78701",
|
|
700
|
-
"country_code": "US",
|
|
701
|
-
"phone": "+15125550142"
|
|
702
|
-
}
|
|
703
|
-
},
|
|
704
|
-
"match": "orders/updated",
|
|
705
|
-
"headers": {
|
|
706
|
-
"x-shopify-topic": "orders/updated",
|
|
707
|
-
"x-shopify-webhook-id": "b54557e4-order-updated",
|
|
708
|
-
"x-shopify-shop-domain": "acme.myshopify.com"
|
|
709
|
-
}
|
|
710
|
-
},
|
|
711
|
-
"customer.created": {
|
|
712
|
-
"delivery": "webhook",
|
|
713
|
-
"subscribe": "webhook.create",
|
|
714
|
-
"description": "Shopify topic customers/create. The payload is the resource itself.",
|
|
715
|
-
"object": "customer",
|
|
716
|
-
"payload": {
|
|
717
|
-
"id": 7012345678901,
|
|
718
|
-
"email": "dana.reyes@example.com",
|
|
719
|
-
"first_name": "Dana",
|
|
720
|
-
"last_name": "Reyes",
|
|
721
|
-
"phone": "+15125550142",
|
|
722
|
-
"tags": "wholesale, vip",
|
|
723
|
-
"note": null,
|
|
724
|
-
"orders_count": 7,
|
|
725
|
-
"total_spent": "1240.55",
|
|
726
|
-
"created_at": "2025-03-02T11:20:00-05:00",
|
|
727
|
-
"updated_at": "2026-10-18T09:14:23-05:00",
|
|
728
|
-
"email_marketing_consent": {
|
|
729
|
-
"state": "subscribed",
|
|
730
|
-
"opt_in_level": "confirmed_opt_in",
|
|
731
|
-
"consent_updated_at": "2025-03-02T11:20:00-05:00"
|
|
732
|
-
},
|
|
733
|
-
"default_address": {
|
|
734
|
-
"company": "Reyes Coffee Co",
|
|
735
|
-
"address1": "501 Congress Ave",
|
|
736
|
-
"city": "Austin",
|
|
737
|
-
"province_code": "TX",
|
|
738
|
-
"zip": "78701",
|
|
739
|
-
"country_code": "US"
|
|
740
|
-
}
|
|
741
|
-
},
|
|
742
|
-
"match": "customers/create",
|
|
743
|
-
"headers": {
|
|
744
|
-
"x-shopify-topic": "customers/create",
|
|
745
|
-
"x-shopify-webhook-id": "b54557e4-customer-created",
|
|
746
|
-
"x-shopify-shop-domain": "acme.myshopify.com"
|
|
747
|
-
}
|
|
748
|
-
},
|
|
749
|
-
"customer.updated": {
|
|
750
|
-
"delivery": "webhook",
|
|
751
|
-
"subscribe": "webhook.create",
|
|
752
|
-
"description": "Shopify topic customers/update. The payload is the resource itself.",
|
|
753
|
-
"object": "customer",
|
|
754
|
-
"payload": {
|
|
755
|
-
"id": 7012345678901,
|
|
756
|
-
"email": "dana.reyes@example.com",
|
|
757
|
-
"first_name": "Dana",
|
|
758
|
-
"last_name": "Reyes",
|
|
759
|
-
"phone": "+15125550142",
|
|
760
|
-
"tags": "wholesale, vip, net30",
|
|
761
|
-
"note": null,
|
|
762
|
-
"orders_count": 7,
|
|
763
|
-
"total_spent": "1240.55",
|
|
764
|
-
"created_at": "2025-03-02T11:20:00-05:00",
|
|
765
|
-
"updated_at": "2026-10-18T09:14:23-05:00",
|
|
766
|
-
"email_marketing_consent": {
|
|
767
|
-
"state": "subscribed",
|
|
768
|
-
"opt_in_level": "confirmed_opt_in",
|
|
769
|
-
"consent_updated_at": "2025-03-02T11:20:00-05:00"
|
|
770
|
-
},
|
|
771
|
-
"default_address": {
|
|
772
|
-
"company": "Reyes Coffee Co",
|
|
773
|
-
"address1": "501 Congress Ave",
|
|
774
|
-
"city": "Austin",
|
|
775
|
-
"province_code": "TX",
|
|
776
|
-
"zip": "78701",
|
|
777
|
-
"country_code": "US"
|
|
778
|
-
}
|
|
779
|
-
},
|
|
780
|
-
"match": "customers/update",
|
|
781
|
-
"headers": {
|
|
782
|
-
"x-shopify-topic": "customers/update",
|
|
783
|
-
"x-shopify-webhook-id": "b54557e4-customer-updated",
|
|
784
|
-
"x-shopify-shop-domain": "acme.myshopify.com"
|
|
785
|
-
}
|
|
786
|
-
},
|
|
787
|
-
"fulfillment.created": {
|
|
788
|
-
"delivery": "webhook",
|
|
789
|
-
"subscribe": "webhook.create",
|
|
790
|
-
"description": "Shopify topic fulfillments/create. The payload is the resource itself.",
|
|
791
|
-
"object": "fulfillment",
|
|
792
|
-
"payload": {
|
|
793
|
-
"id": 4987654321098,
|
|
794
|
-
"order_id": 5612789014562,
|
|
795
|
-
"status": "success",
|
|
796
|
-
"tracking_company": "UPS",
|
|
797
|
-
"tracking_number": "1Z999AA10123456784",
|
|
798
|
-
"tracking_url": "https://www.ups.com/track?tracknum=1Z999AA10123456784",
|
|
799
|
-
"created_at": "2026-10-19T14:02:00-05:00",
|
|
800
|
-
"line_items": [
|
|
801
|
-
{
|
|
802
|
-
"id": 13579246801,
|
|
803
|
-
"quantity": 2
|
|
804
|
-
}
|
|
805
|
-
]
|
|
806
|
-
},
|
|
807
|
-
"match": "fulfillments/create",
|
|
808
|
-
"headers": {
|
|
809
|
-
"x-shopify-topic": "fulfillments/create",
|
|
810
|
-
"x-shopify-webhook-id": "b54557e4-fulfillment-created",
|
|
811
|
-
"x-shopify-shop-domain": "acme.myshopify.com"
|
|
812
|
-
}
|
|
813
|
-
},
|
|
814
|
-
"refund.created": {
|
|
815
|
-
"delivery": "webhook",
|
|
816
|
-
"subscribe": "webhook.create",
|
|
817
|
-
"description": "Shopify topic refunds/create. The payload is the resource itself.",
|
|
818
|
-
"object": "refund",
|
|
819
|
-
"payload": {
|
|
820
|
-
"id": 929361462,
|
|
821
|
-
"order_id": 5612789014562,
|
|
822
|
-
"created_at": "2026-10-21T10:30:00-05:00",
|
|
823
|
-
"note": "Mug arrived chipped",
|
|
824
|
-
"refund_line_items": [
|
|
825
|
-
{
|
|
826
|
-
"id": 104689539,
|
|
827
|
-
"line_item_id": 13579246801,
|
|
828
|
-
"quantity": 1,
|
|
829
|
-
"restock_type": "return",
|
|
830
|
-
"subtotal": 28.8,
|
|
831
|
-
"total_tax": 2.38,
|
|
832
|
-
"line_item": {
|
|
833
|
-
"sku": "TW-MUG-12",
|
|
834
|
-
"title": "Acme Mug"
|
|
835
|
-
}
|
|
836
|
-
}
|
|
837
|
-
],
|
|
838
|
-
"transactions": [
|
|
839
|
-
{
|
|
840
|
-
"id": 389404469,
|
|
841
|
-
"kind": "refund",
|
|
842
|
-
"gateway": "shopify_payments",
|
|
843
|
-
"status": "success",
|
|
844
|
-
"amount": "31.18",
|
|
845
|
-
"currency": "USD"
|
|
846
|
-
}
|
|
847
|
-
]
|
|
848
|
-
},
|
|
849
|
-
"match": "refunds/create",
|
|
850
|
-
"headers": {
|
|
851
|
-
"x-shopify-topic": "refunds/create",
|
|
852
|
-
"x-shopify-webhook-id": "b54557e4-refund-created",
|
|
853
|
-
"x-shopify-shop-domain": "acme.myshopify.com"
|
|
854
|
-
}
|
|
855
|
-
},
|
|
856
|
-
"inventory.updated": {
|
|
857
|
-
"delivery": "webhook",
|
|
858
|
-
"subscribe": "webhook.create",
|
|
859
|
-
"description": "Shopify topic inventory_levels/update. The payload is the resource itself.",
|
|
860
|
-
"object": "inventoryLevel",
|
|
861
|
-
"payload": {
|
|
862
|
-
"inventory_item_id": 46012345678,
|
|
863
|
-
"location_id": 61234567890,
|
|
864
|
-
"available": 3,
|
|
865
|
-
"updated_at": "2026-10-18T09:14:23-05:00",
|
|
866
|
-
"admin_graphql_api_id": "gid://shopify/InventoryLevel/61234567890?inventory_item_id=46012345678"
|
|
867
|
-
},
|
|
868
|
-
"match": "inventory_levels/update",
|
|
869
|
-
"headers": {
|
|
870
|
-
"x-shopify-topic": "inventory_levels/update",
|
|
871
|
-
"x-shopify-webhook-id": "b54557e4-inventory-updated",
|
|
872
|
-
"x-shopify-shop-domain": "acme.myshopify.com"
|
|
873
|
-
}
|
|
874
|
-
},
|
|
875
|
-
"checkout.abandoned": {
|
|
876
|
-
"delivery": "poll",
|
|
877
|
-
"object": "checkout",
|
|
878
|
-
"description": "Polled from GET /checkouts.json. Shopify sends no webhook when a checkout is abandoned; a checkout with an email and no completed_at after an hour counts as abandoned.",
|
|
879
|
-
"payload": {
|
|
880
|
-
"id": 35112233445566,
|
|
881
|
-
"token": "example-checkout-token",
|
|
882
|
-
"email": "dana.reyes@example.com",
|
|
883
|
-
"abandoned_checkout_url": "https://acme-goods.myshopify.com/58912/checkouts/b1946ac9/recover?key=7c2f",
|
|
884
|
-
"total_price": "64.00",
|
|
885
|
-
"currency": "USD",
|
|
886
|
-
"customer": {
|
|
887
|
-
"id": 7012345678901
|
|
888
|
-
},
|
|
889
|
-
"line_items": [
|
|
890
|
-
{
|
|
891
|
-
"variant_id": 44012345690,
|
|
892
|
-
"sku": "TW-PRESS-01",
|
|
893
|
-
"title": "Pour-over Press",
|
|
894
|
-
"quantity": 1,
|
|
895
|
-
"price": "64.00"
|
|
896
|
-
}
|
|
897
|
-
],
|
|
898
|
-
"created_at": "2026-10-18T20:41:00-05:00",
|
|
899
|
-
"completed_at": null
|
|
900
|
-
}
|
|
901
|
-
}
|
|
902
|
-
},
|
|
903
|
-
"webhook": {
|
|
904
|
-
"scope": "installation",
|
|
905
|
-
"topic": "{{headers.x-shopify-topic}}",
|
|
906
|
-
"eventId": "{{headers.x-shopify-webhook-id}}",
|
|
907
|
-
"verify": "verifyWebhookSignature"
|
|
908
|
-
},
|
|
909
|
-
"capabilities": {
|
|
910
|
-
"order.get": {
|
|
911
|
-
"kind": "read",
|
|
912
|
-
"method": "getOrder",
|
|
913
|
-
"input": {
|
|
914
|
-
"id": {
|
|
915
|
-
"type": "string",
|
|
916
|
-
"required": true
|
|
917
|
-
},
|
|
918
|
-
"fields": {
|
|
919
|
-
"type": "string"
|
|
920
|
-
}
|
|
921
|
-
},
|
|
922
|
-
"output": "order"
|
|
923
|
-
},
|
|
924
|
-
"order.list": {
|
|
925
|
-
"kind": "read",
|
|
926
|
-
"method": "listOrders",
|
|
927
|
-
"input": {
|
|
928
|
-
"status": {
|
|
929
|
-
"type": "string"
|
|
930
|
-
},
|
|
931
|
-
"created_at_min": {
|
|
932
|
-
"type": "string"
|
|
933
|
-
},
|
|
934
|
-
"updated_at_min": {
|
|
935
|
-
"type": "string"
|
|
936
|
-
},
|
|
937
|
-
"limit": {
|
|
938
|
-
"type": "number"
|
|
939
|
-
},
|
|
940
|
-
"page_info": {
|
|
941
|
-
"type": "string"
|
|
942
|
-
}
|
|
943
|
-
},
|
|
944
|
-
"output": "page<order>"
|
|
945
|
-
},
|
|
946
|
-
"order.update": {
|
|
947
|
-
"kind": "write",
|
|
948
|
-
"method": "updateOrder",
|
|
949
|
-
"input": {
|
|
950
|
-
"id": {
|
|
951
|
-
"type": "string",
|
|
952
|
-
"required": true
|
|
953
|
-
},
|
|
954
|
-
"order": {
|
|
955
|
-
"type": "object",
|
|
956
|
-
"required": true
|
|
957
|
-
}
|
|
958
|
-
},
|
|
959
|
-
"output": "order"
|
|
960
|
-
},
|
|
961
|
-
"order.fulfillmentOrders": {
|
|
962
|
-
"kind": "read",
|
|
963
|
-
"method": "listFulfillmentOrders",
|
|
964
|
-
"input": {
|
|
965
|
-
"orderId": {
|
|
966
|
-
"type": "string",
|
|
967
|
-
"required": true
|
|
968
|
-
}
|
|
969
|
-
},
|
|
970
|
-
"output": "fulfillmentOrder[]"
|
|
971
|
-
},
|
|
972
|
-
"fulfillment.create": {
|
|
973
|
-
"kind": "write",
|
|
974
|
-
"method": "createFulfillment",
|
|
975
|
-
"input": {
|
|
976
|
-
"fulfillmentOrderId": {
|
|
977
|
-
"type": "string",
|
|
978
|
-
"required": true
|
|
979
|
-
},
|
|
980
|
-
"trackingInfo": {
|
|
981
|
-
"type": "object"
|
|
982
|
-
},
|
|
983
|
-
"notifyCustomer": {
|
|
984
|
-
"type": "boolean"
|
|
985
|
-
}
|
|
986
|
-
},
|
|
987
|
-
"output": "fulfillment"
|
|
988
|
-
},
|
|
989
|
-
"customer.get": {
|
|
990
|
-
"kind": "read",
|
|
991
|
-
"method": "getCustomer",
|
|
992
|
-
"input": {
|
|
993
|
-
"id": {
|
|
994
|
-
"type": "string",
|
|
995
|
-
"required": true
|
|
996
|
-
}
|
|
997
|
-
},
|
|
998
|
-
"output": "customer"
|
|
999
|
-
},
|
|
1000
|
-
"customer.list": {
|
|
1001
|
-
"kind": "read",
|
|
1002
|
-
"method": "listCustomers",
|
|
1003
|
-
"input": {
|
|
1004
|
-
"updated_at_min": {
|
|
1005
|
-
"type": "string"
|
|
1006
|
-
},
|
|
1007
|
-
"limit": {
|
|
1008
|
-
"type": "number"
|
|
1009
|
-
},
|
|
1010
|
-
"page_info": {
|
|
1011
|
-
"type": "string"
|
|
1012
|
-
}
|
|
1013
|
-
},
|
|
1014
|
-
"output": "page<customer>"
|
|
1015
|
-
},
|
|
1016
|
-
"customer.search": {
|
|
1017
|
-
"kind": "search",
|
|
1018
|
-
"method": "searchCustomers",
|
|
1019
|
-
"input": {
|
|
1020
|
-
"query": {
|
|
1021
|
-
"type": "string",
|
|
1022
|
-
"required": true
|
|
1023
|
-
}
|
|
1024
|
-
},
|
|
1025
|
-
"output": "customer[]"
|
|
1026
|
-
},
|
|
1027
|
-
"customer.create": {
|
|
1028
|
-
"kind": "write",
|
|
1029
|
-
"method": "createCustomer",
|
|
1030
|
-
"input": {
|
|
1031
|
-
"customer": {
|
|
1032
|
-
"type": "object",
|
|
1033
|
-
"required": true
|
|
1034
|
-
}
|
|
1035
|
-
},
|
|
1036
|
-
"output": "customer"
|
|
1037
|
-
},
|
|
1038
|
-
"customer.update": {
|
|
1039
|
-
"kind": "write",
|
|
1040
|
-
"method": "updateCustomer",
|
|
1041
|
-
"input": {
|
|
1042
|
-
"id": {
|
|
1043
|
-
"type": "string",
|
|
1044
|
-
"required": true
|
|
1045
|
-
},
|
|
1046
|
-
"customer": {
|
|
1047
|
-
"type": "object",
|
|
1048
|
-
"required": true
|
|
1049
|
-
}
|
|
1050
|
-
},
|
|
1051
|
-
"output": "customer"
|
|
1052
|
-
},
|
|
1053
|
-
"checkout.list": {
|
|
1054
|
-
"kind": "read",
|
|
1055
|
-
"method": "listAbandonedCheckouts",
|
|
1056
|
-
"input": {
|
|
1057
|
-
"created_at_min": {
|
|
1058
|
-
"type": "string"
|
|
1059
|
-
},
|
|
1060
|
-
"limit": {
|
|
1061
|
-
"type": "number"
|
|
1062
|
-
}
|
|
1063
|
-
},
|
|
1064
|
-
"output": "checkout[]"
|
|
1065
|
-
},
|
|
1066
|
-
"variant.byInventoryItem": {
|
|
1067
|
-
"kind": "read",
|
|
1068
|
-
"method": "getVariantByInventoryItemId",
|
|
1069
|
-
"input": {
|
|
1070
|
-
"inventoryItemId": {
|
|
1071
|
-
"type": "string",
|
|
1072
|
-
"required": true
|
|
1073
|
-
}
|
|
1074
|
-
},
|
|
1075
|
-
"output": "variant"
|
|
1076
|
-
},
|
|
1077
|
-
"location.list": {
|
|
1078
|
-
"kind": "read",
|
|
1079
|
-
"method": "listLocations",
|
|
1080
|
-
"input": {},
|
|
1081
|
-
"output": "location[]"
|
|
1082
|
-
},
|
|
1083
|
-
"webhook.create": {
|
|
1084
|
-
"kind": "subscribe",
|
|
1085
|
-
"method": "createWebhook",
|
|
1086
|
-
"input": {
|
|
1087
|
-
"topic": {
|
|
1088
|
-
"type": "string",
|
|
1089
|
-
"required": true
|
|
1090
|
-
},
|
|
1091
|
-
"address": {
|
|
1092
|
-
"type": "string",
|
|
1093
|
-
"required": true
|
|
1094
|
-
},
|
|
1095
|
-
"format": {
|
|
1096
|
-
"type": "string"
|
|
1097
|
-
}
|
|
1098
|
-
},
|
|
1099
|
-
"output": "webhook"
|
|
1100
|
-
},
|
|
1101
|
-
"webhook.delete": {
|
|
1102
|
-
"kind": "delete",
|
|
1103
|
-
"method": "deleteWebhook",
|
|
1104
|
-
"input": {
|
|
1105
|
-
"id": {
|
|
1106
|
-
"type": "string",
|
|
1107
|
-
"required": true
|
|
1108
|
-
}
|
|
1109
|
-
},
|
|
1110
|
-
"output": "void"
|
|
1111
|
-
}
|
|
1112
|
-
},
|
|
1113
|
-
"options": {
|
|
1114
|
-
"location": {
|
|
1115
|
-
"capability": "location.list",
|
|
1116
|
-
"label": "{{item.name}}",
|
|
1117
|
-
"value": "$.item.id"
|
|
1118
|
-
}
|
|
1119
|
-
},
|
|
1120
|
-
"ui": {
|
|
1121
|
-
"placements": [
|
|
1122
|
-
"admin.customer-details.block",
|
|
1123
|
-
"admin.order-details.block",
|
|
1124
|
-
"admin.product-details.block"
|
|
1125
|
-
],
|
|
1126
|
-
"renderer": "frigg-shopify-admin-extension"
|
|
1127
|
-
}
|
|
1128
|
-
}
|