@fluentcommerce/fc-connect-sdk 0.1.54 → 0.1.55
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 +12 -0
- package/dist/cjs/clients/fluent-client.js +13 -6
- package/dist/cjs/utils/pagination-helpers.js +38 -2
- package/dist/cjs/versori/fluent-versori-client.js +11 -5
- package/dist/esm/clients/fluent-client.js +13 -6
- package/dist/esm/utils/pagination-helpers.js +38 -2
- package/dist/esm/versori/fluent-versori-client.js +11 -5
- package/dist/tsconfig.esm.tsbuildinfo +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/dist/tsconfig.types.tsbuildinfo +1 -1
- package/docs/00-START-HERE/EXPORT-VALIDATION.md +158 -158
- package/docs/00-START-HERE/cli-analyze-source-structure-guide.md +655 -655
- package/docs/00-START-HERE/cli-documentation-index.md +202 -202
- package/docs/00-START-HERE/cli-quick-reference.md +252 -252
- package/docs/00-START-HERE/decision-tree.md +552 -552
- package/docs/00-START-HERE/getting-started.md +1070 -1070
- package/docs/00-START-HERE/mapper-quick-decision-guide.md +235 -235
- package/docs/00-START-HERE/readme.md +237 -237
- package/docs/00-START-HERE/retailerid-configuration.md +404 -404
- package/docs/00-START-HERE/sdk-philosophy.md +794 -794
- package/docs/00-START-HERE/troubleshooting-quick-reference.md +1086 -1086
- package/docs/01-TEMPLATES/faq.md +686 -686
- package/docs/01-TEMPLATES/patterns/pattern-templates-guide.md +68 -68
- package/docs/01-TEMPLATES/patterns/patterns-csv-schema-validation-and-rejection-report.md +233 -233
- package/docs/01-TEMPLATES/patterns/patterns-custom-resolvers.md +407 -407
- package/docs/01-TEMPLATES/patterns/patterns-error-handling-retry.md +511 -511
- package/docs/01-TEMPLATES/patterns/patterns-field-mapping-universal.md +701 -701
- package/docs/01-TEMPLATES/patterns/patterns-large-file-splitting.md +1430 -1430
- package/docs/01-TEMPLATES/patterns/patterns-master-data-etl.md +2399 -2399
- package/docs/01-TEMPLATES/patterns/patterns-pagination-streaming.md +447 -447
- package/docs/01-TEMPLATES/patterns/patterns-state-duplicate-prevention.md +385 -385
- package/docs/01-TEMPLATES/readme.md +957 -957
- package/docs/01-TEMPLATES/standalone/standalone-asn-inbound-processing.md +1209 -1209
- package/docs/01-TEMPLATES/standalone/standalone-graphql-query-export.md +1140 -1140
- package/docs/01-TEMPLATES/standalone/standalone-graphql-to-parquet-partitioned-s3.md +432 -432
- package/docs/01-TEMPLATES/standalone/standalone-multi-channel-inventory-sync.md +1185 -1185
- package/docs/01-TEMPLATES/standalone/standalone-multi-source-aggregation.md +1462 -1462
- package/docs/01-TEMPLATES/standalone/standalone-s3-csv-batch-api.md +1390 -1390
- package/docs/01-TEMPLATES/standalone/standalone-s3-csv-inventory-to-batch.md +330 -330
- package/docs/01-TEMPLATES/standalone/standalone-scripts-guide.md +87 -87
- package/docs/01-TEMPLATES/standalone/standalone-sftp-xml-graphql.md +1444 -1444
- package/docs/01-TEMPLATES/standalone/standalone-webhook-payload-processing.md +688 -688
- package/docs/01-TEMPLATES/versori/business-examples/business-examples-dropship-order-routing.md +193 -193
- package/docs/01-TEMPLATES/versori/business-examples/business-examples-graphql-parquet-extraction.md +518 -518
- package/docs/01-TEMPLATES/versori/business-examples/business-examples-inter-location-transfers.md +2162 -2162
- package/docs/01-TEMPLATES/versori/business-examples/business-examples-pre-order-allocation.md +2226 -2226
- package/docs/01-TEMPLATES/versori/business-examples/business-scenarios-guide.md +87 -87
- package/docs/01-TEMPLATES/versori/patterns/versori-patterns-connection-validation-pattern.md +656 -656
- package/docs/01-TEMPLATES/versori/patterns/versori-patterns-dual-workflow-connector.md +835 -835
- package/docs/01-TEMPLATES/versori/patterns/versori-patterns-guide.md +108 -108
- package/docs/01-TEMPLATES/versori/patterns/versori-patterns-kv-state-management.md +1533 -1533
- package/docs/01-TEMPLATES/versori/patterns/versori-patterns-xml-response-patterns.md +1160 -1160
- package/docs/01-TEMPLATES/versori/versori-platform-guide.md +201 -201
- package/docs/01-TEMPLATES/versori/webhooks/template-webhook-asn-purchase-order.md +1906 -1906
- package/docs/01-TEMPLATES/versori/webhooks/template-webhook-dropship-routing.md +1074 -1074
- package/docs/01-TEMPLATES/versori/webhooks/template-webhook-flash-sale-reserve.md +1395 -1395
- package/docs/01-TEMPLATES/versori/webhooks/template-webhook-generic-xml-order.md +888 -888
- package/docs/01-TEMPLATES/versori/webhooks/template-webhook-payment-gateway-integration.md +2478 -2478
- package/docs/01-TEMPLATES/versori/webhooks/template-webhook-rma-returns-comprehensive.md +2240 -2240
- package/docs/01-TEMPLATES/versori/webhooks/template-webhook-xml-order-ingestion.md +2029 -2029
- package/docs/01-TEMPLATES/versori/webhooks/webhook-templates-guide.md +140 -140
- package/docs/01-TEMPLATES/versori/workflows/_examples/sample-data/inventory-mapping.json +20 -20
- package/docs/01-TEMPLATES/versori/workflows/_examples/sample-data/products_2025-01-22.csv +11 -11
- package/docs/01-TEMPLATES/versori/workflows/_examples/sample-data/sample-data-guide.md +34 -34
- package/docs/01-TEMPLATES/versori/workflows/_examples/workflow-examples-guide.md +36 -36
- package/docs/01-TEMPLATES/versori/workflows/extraction/extraction-modes-guide.md +1038 -1038
- package/docs/01-TEMPLATES/versori/workflows/extraction/extraction-workflows-guide.md +138 -138
- package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/graphql-extraction-guide.md +63 -63
- package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-fulfillments-to-sftp-csv.md +2062 -2062
- package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-fulfillments-to-sftp-xml.md +2294 -2294
- package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-inventory-positions-to-s3-csv.md +2461 -2461
- package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-inventory-positions-to-sftp-xml.md +2529 -2529
- package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-inventory-quantities-to-s3-csv.md +2464 -2464
- package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-inventory-quantities-to-s3-json.md +1959 -1959
- package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-orders-to-s3-csv.md +1953 -1953
- package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-orders-to-sftp-xml.md +2541 -2541
- package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-products-to-s3-json.md +2384 -2384
- package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-products-to-sftp-xml.md +2445 -2445
- package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-virtual-positions-to-s3-csv.md +2355 -2355
- package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-virtual-positions-to-s3-json.md +2042 -2042
- package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-virtual-positions-to-sftp-xml.md +2726 -2726
- package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/batch-api-guide.md +206 -206
- package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-cycle-count-reconciliation.md +2030 -2030
- package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-multi-channel-inventory-sync.md +1882 -1882
- package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-s3-csv-inventory-batch.md +2827 -2827
- package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-s3-json-inventory-batch.md +1952 -1952
- package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-s3-xml-inventory-batch.md +3289 -3289
- package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-sftp-csv-inventory-batch.md +3064 -3064
- package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-sftp-json-inventory-batch.md +3238 -3238
- package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-sftp-xml-inventory-batch.md +2977 -2977
- package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/event-api-guide.md +321 -321
- package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-payload-json-order-cancel-event.md +959 -959
- package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-payload-xml-order-cancel-event.md +1170 -1170
- package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-s3-csv-product-event.md +2312 -2312
- package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-s3-json-product-event.md +2999 -2999
- package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-s3-parquet-product-event.md +2836 -2836
- package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-s3-xml-product-event.md +2395 -2395
- package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-sftp-csv-product-event.md +2295 -2295
- package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-sftp-json-product-event.md +2602 -2602
- package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-sftp-parquet-product-event.md +2589 -2589
- package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-sftp-xml-product-event.md +3578 -3578
- package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/graphql-mutations-guide.md +93 -93
- package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-payload-json-order-update-graphql.md +1260 -1260
- package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-payload-xml-order-update-graphql.md +1472 -1472
- package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-s3-csv-control-graphql.md +2417 -2417
- package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-s3-csv-location-graphql.md +2811 -2811
- package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-s3-csv-price-graphql.md +2619 -2619
- package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-s3-json-location-graphql.md +2807 -2807
- package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-s3-xml-location-graphql.md +2373 -2373
- package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-sftp-csv-control-graphql.md +2740 -2740
- package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-sftp-csv-location-graphql.md +2760 -2760
- package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-sftp-json-location-graphql.md +1710 -1710
- package/docs/01-TEMPLATES/versori/workflows/ingestion/ingestion-workflows-guide.md +136 -136
- package/docs/01-TEMPLATES/versori/workflows/rubix-webhooks/rubix-webhooks-guide.md +520 -520
- package/docs/01-TEMPLATES/versori/workflows/rubix-webhooks/template-webhook-rubix-fulfilment-to-sftp-xml-inline.md +1418 -1418
- package/docs/01-TEMPLATES/versori/workflows/rubix-webhooks/template-webhook-rubix-fulfilment-to-sftp-xml-universal-mapper.md +1785 -1785
- package/docs/01-TEMPLATES/versori/workflows/rubix-webhooks/template-webhook-rubix-order-attribute-update.md +824 -824
- package/docs/01-TEMPLATES/versori/workflows/workflows-overview-guide.md +646 -646
- package/docs/02-CORE-GUIDES/advanced-services/advanced-services-batch-archival.md +724 -724
- package/docs/02-CORE-GUIDES/advanced-services/advanced-services-job-tracker.md +627 -627
- package/docs/02-CORE-GUIDES/advanced-services/advanced-services-partial-batch-recovery.md +561 -561
- package/docs/02-CORE-GUIDES/advanced-services/advanced-services-quick-reference.md +367 -367
- package/docs/02-CORE-GUIDES/advanced-services/advanced-services-readme.md +407 -407
- package/docs/02-CORE-GUIDES/advanced-services/readme.md +49 -49
- package/docs/02-CORE-GUIDES/api-reference/api-reference-quick-reference.md +548 -548
- package/docs/02-CORE-GUIDES/api-reference/event-api-input-output-reference.md +702 -1171
- package/docs/02-CORE-GUIDES/api-reference/examples/client-initialization.ts +286 -286
- package/docs/02-CORE-GUIDES/api-reference/graphql-error-classification.md +337 -337
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-01-client-api.md +399 -520
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-03-authentication.md +199 -199
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-04-graphql-mapping.md +925 -925
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-05-services.md +1198 -1198
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-06-data-sources.md +1083 -1083
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-07-parsers.md +1097 -1097
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-08-pagination.md +513 -513
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-08-types.md +545 -597
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-09-error-handling.md +527 -527
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-09-webhook-validation.md +514 -514
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-10-extraction.md +557 -557
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-10-utilities.md +412 -412
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-11-cli-tools.md +423 -423
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-11-error-handling.md +716 -716
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-12-analyze-source-structure.md +518 -518
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-12-partial-responses.md +212 -212
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-12-testing.md +300 -300
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-13-resolver-builder.md +322 -322
- package/docs/02-CORE-GUIDES/api-reference/readme.md +279 -279
- package/docs/02-CORE-GUIDES/auto-pagination/auto-pagination-quick-reference.md +351 -351
- package/docs/02-CORE-GUIDES/auto-pagination/auto-pagination-readme.md +277 -277
- package/docs/02-CORE-GUIDES/auto-pagination/examples/auto-pagination-readme.md +178 -178
- package/docs/02-CORE-GUIDES/auto-pagination/examples/common-patterns.ts +351 -351
- package/docs/02-CORE-GUIDES/auto-pagination/examples/paginate-products.ts +384 -384
- package/docs/02-CORE-GUIDES/auto-pagination/examples/paginate-virtual-positions.ts +308 -308
- package/docs/02-CORE-GUIDES/auto-pagination/modules/auto-pagination-01-foundations.md +470 -470
- package/docs/02-CORE-GUIDES/auto-pagination/modules/auto-pagination-02-quick-start.md +713 -713
- package/docs/02-CORE-GUIDES/auto-pagination/modules/auto-pagination-03-configuration.md +754 -754
- package/docs/02-CORE-GUIDES/auto-pagination/modules/auto-pagination-04-advanced-patterns.md +732 -732
- package/docs/02-CORE-GUIDES/auto-pagination/modules/auto-pagination-05-sdk-integration.md +847 -847
- package/docs/02-CORE-GUIDES/auto-pagination/modules/auto-pagination-06-troubleshooting.md +359 -359
- package/docs/02-CORE-GUIDES/auto-pagination/modules/auto-pagination-07-api-reference.md +462 -462
- package/docs/02-CORE-GUIDES/auto-pagination/readme.md +54 -54
- package/docs/02-CORE-GUIDES/data-sources/data-sources-file-operations-error-handling.md +1487 -1487
- package/docs/02-CORE-GUIDES/data-sources/data-sources-quick-reference.md +836 -836
- package/docs/02-CORE-GUIDES/data-sources/data-sources-readme.md +276 -276
- package/docs/02-CORE-GUIDES/data-sources/data-sources-sftp-credential-access-security.md +553 -553
- package/docs/02-CORE-GUIDES/data-sources/examples/common-patterns.ts +409 -409
- package/docs/02-CORE-GUIDES/data-sources/examples/data-sources-readme.md +178 -178
- package/docs/02-CORE-GUIDES/data-sources/examples/s3-operations.ts +308 -308
- package/docs/02-CORE-GUIDES/data-sources/examples/sftp-operations.ts +371 -371
- package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-01-foundations.md +735 -735
- package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-02-s3-operations.md +1302 -1302
- package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-03-sftp-operations.md +1379 -1379
- package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-04-file-patterns.md +941 -941
- package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-05-advanced-topics.md +813 -813
- package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-06-integration-patterns.md +486 -486
- package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-07-troubleshooting.md +387 -387
- package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-08-api-reference.md +417 -417
- package/docs/02-CORE-GUIDES/data-sources/readme.md +77 -77
- package/docs/02-CORE-GUIDES/error-handling-guide.md +936 -936
- package/docs/02-CORE-GUIDES/extraction/examples/02-core-guides-extraction-readme.md +116 -116
- package/docs/02-CORE-GUIDES/extraction/examples/common-patterns.ts +428 -428
- package/docs/02-CORE-GUIDES/extraction/examples/extract-inventory-basic.ts +187 -187
- package/docs/02-CORE-GUIDES/extraction/extraction-quick-reference.md +596 -596
- package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-01-foundations.md +514 -514
- package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-02-basic-extraction.md +823 -823
- package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-03-parquet-processing.md +507 -507
- package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-04-data-enrichment.md +546 -546
- package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-05-transformation.md +494 -494
- package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-06-export-formats.md +458 -458
- package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-06-performance.md +138 -138
- package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-07-api-reference.md +148 -148
- package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-07-optimization.md +692 -692
- package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-08-extraction-orchestrator.md +1008 -1008
- package/docs/02-CORE-GUIDES/extraction/readme.md +151 -151
- package/docs/02-CORE-GUIDES/ingestion/examples/_simple-kv-store.ts +40 -40
- package/docs/02-CORE-GUIDES/ingestion/examples/error-recovery.ts +728 -728
- package/docs/02-CORE-GUIDES/ingestion/examples/event-driven.ts +501 -501
- package/docs/02-CORE-GUIDES/ingestion/examples/local-file-ingestion.ts +88 -88
- package/docs/02-CORE-GUIDES/ingestion/examples/parquet-ingestion.ts +117 -117
- package/docs/02-CORE-GUIDES/ingestion/examples/performance-optimized.ts +647 -647
- package/docs/02-CORE-GUIDES/ingestion/examples/s3-csv-ingestion.ts +169 -169
- package/docs/02-CORE-GUIDES/ingestion/examples/sftp-csv-ingestion.ts +134 -134
- package/docs/02-CORE-GUIDES/ingestion/ingestion-quick-reference.md +546 -546
- package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-01-introduction.md +626 -626
- package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-02-quick-start.md +658 -658
- package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-03-data-sources.md +1052 -1052
- package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-04-field-mapping.md +763 -763
- package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-05-advanced-parsers.md +676 -676
- package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-06-batch-api.md +1295 -1295
- package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-07-api-reference.md +138 -138
- package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-07-state-management.md +1037 -1037
- package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-08-performance-optimization.md +1349 -1349
- package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-09-best-practices.md +1893 -1893
- package/docs/02-CORE-GUIDES/ingestion/readme.md +160 -160
- package/docs/02-CORE-GUIDES/logging-guide.md +585 -585
- package/docs/02-CORE-GUIDES/mapping/error-handling-patterns.md +401 -401
- package/docs/02-CORE-GUIDES/mapping/examples/02-core-guides-mapping-readme.md +128 -128
- package/docs/02-CORE-GUIDES/mapping/examples/common-patterns.ts +273 -273
- package/docs/02-CORE-GUIDES/mapping/examples/csv-location-ingestion.json +36 -36
- package/docs/02-CORE-GUIDES/mapping/examples/csv-mapping.ts +242 -242
- package/docs/02-CORE-GUIDES/mapping/examples/graphql-to-parquet-extraction.json +36 -36
- package/docs/02-CORE-GUIDES/mapping/examples/json-mapping.ts +213 -213
- package/docs/02-CORE-GUIDES/mapping/examples/json-product-to-mutation.json +48 -48
- package/docs/02-CORE-GUIDES/mapping/examples/xml-mapping.ts +291 -291
- package/docs/02-CORE-GUIDES/mapping/examples/xml-order-to-mutation.json +45 -45
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/graphql-mutation-mapping-quick-reference.md +463 -463
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/graphql-mutation-mapping-readme.md +227 -227
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-01-introduction.md +222 -222
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-02-quick-start.md +351 -351
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-03-schema-validation.md +569 -569
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-04-mapping-patterns.md +471 -471
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-05-configuration-reference.md +611 -611
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-06-advanced-xpath.md +148 -148
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-06-path-syntax.md +464 -464
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-07-api-reference.md +94 -94
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-07-array-handling.md +307 -307
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-08-custom-resolvers.md +544 -544
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-09-advanced-patterns.md +427 -427
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-10-hooks-and-variables.md +336 -336
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-11-error-handling.md +488 -488
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-12-arguments-vs-nodes.md +383 -383
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-13-best-practices.md +477 -477
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/readme.md +62 -62
- package/docs/02-CORE-GUIDES/mapping/mapping-format-decision-tree.md +480 -480
- package/docs/02-CORE-GUIDES/mapping/mapping-graphql-alias-batching-guide.md +820 -820
- package/docs/02-CORE-GUIDES/mapping/mapping-javascript-objects.md +2369 -2369
- package/docs/02-CORE-GUIDES/mapping/mapping-mapper-comparison-guide.md +682 -682
- package/docs/02-CORE-GUIDES/mapping/modules/02-core-guides-mapping-07-api-reference.md +1327 -1327
- package/docs/02-CORE-GUIDES/mapping/modules/02-core-guides-mapping-08-error-handling.md +1142 -1142
- package/docs/02-CORE-GUIDES/mapping/modules/mapping-04-use-cases.md +891 -891
- package/docs/02-CORE-GUIDES/mapping/modules/mapping-06-helpers-resolvers.md +1126 -1126
- package/docs/02-CORE-GUIDES/mapping/modules/mapping-06-sdk-resolvers.md +199 -199
- package/docs/02-CORE-GUIDES/mapping/modules/mapping-07-api-reference.md +1319 -1319
- package/docs/02-CORE-GUIDES/mapping/readme.md +178 -178
- package/docs/02-CORE-GUIDES/mapping/resolver-registration.md +410 -410
- package/docs/02-CORE-GUIDES/mapping/resolvers/examples/common-patterns.ts +226 -226
- package/docs/02-CORE-GUIDES/mapping/resolvers/examples/custom-resolvers.ts +227 -227
- package/docs/02-CORE-GUIDES/mapping/resolvers/examples/sdk-resolvers-usage.ts +203 -203
- package/docs/02-CORE-GUIDES/mapping/resolvers/mapping-resolvers-readme.md +274 -274
- package/docs/02-CORE-GUIDES/mapping/resolvers/mapping-resolvers-resolver-api-reference.md +679 -679
- package/docs/02-CORE-GUIDES/mapping/resolvers/mapping-resolvers-resolver-cookbook.md +826 -826
- package/docs/02-CORE-GUIDES/mapping/resolvers/mapping-resolvers-resolver-guide.md +1330 -1330
- package/docs/02-CORE-GUIDES/mapping/resolvers/mapping-resolvers-resolver-helpers-reference.md +1437 -1437
- package/docs/02-CORE-GUIDES/mapping/resolvers/mapping-resolvers-resolver-parameters-reference.md +553 -553
- package/docs/02-CORE-GUIDES/mapping/resolvers/mapping-resolvers-resolver-troubleshooting.md +854 -854
- package/docs/02-CORE-GUIDES/mapping/resolvers/readme.md +75 -75
- package/docs/02-CORE-GUIDES/parsers/examples/02-core-guides-parsers-readme.md +161 -161
- package/docs/02-CORE-GUIDES/parsers/examples/csv-parser-examples.ts +110 -110
- package/docs/02-CORE-GUIDES/parsers/examples/json-parser-examples.ts +33 -33
- package/docs/02-CORE-GUIDES/parsers/examples/parquet-parser-examples.ts +47 -47
- package/docs/02-CORE-GUIDES/parsers/examples/xml-parser-examples.ts +38 -38
- package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-01-foundations.md +355 -355
- package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-02-csv-parser.md +772 -772
- package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-03-json-parser.md +789 -789
- package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-04-xml-parser.md +857 -857
- package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-05-parquet-parser.md +603 -603
- package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-06-integration-patterns.md +702 -702
- package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-06-streaming.md +121 -121
- package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-07-api-reference.md +89 -89
- package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-07-troubleshooting.md +727 -727
- package/docs/02-CORE-GUIDES/parsers/parsers-quick-reference.md +482 -482
- package/docs/02-CORE-GUIDES/parsers/parsers-readme.md +258 -258
- package/docs/02-CORE-GUIDES/parsers/readme.md +65 -65
- package/docs/02-CORE-GUIDES/readme.md +194 -194
- package/docs/02-CORE-GUIDES/webhook-validation/examples/basic-validation.ts +108 -108
- package/docs/02-CORE-GUIDES/webhook-validation/examples/common-patterns.ts +316 -316
- package/docs/02-CORE-GUIDES/webhook-validation/examples/webhook-validation-readme.md +61 -61
- package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-01-foundations.md +440 -440
- package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-02-quick-start.md +525 -525
- package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-03-versori-integration.md +741 -741
- package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-04-platform-integration.md +629 -629
- package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-05-configuration.md +535 -535
- package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-06-error-handling.md +611 -611
- package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-06-troubleshooting.md +124 -124
- package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-07-api-reference.md +511 -511
- package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-08-rubix-webhooks.md +590 -590
- package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-09-rubix-event-vs-http-call.md +432 -432
- package/docs/02-CORE-GUIDES/webhook-validation/readme.md +239 -239
- package/docs/02-CORE-GUIDES/webhook-validation/webhook-validation-quick-reference.md +392 -392
- package/docs/03-PATTERN-GUIDES/connector-scenarios/connector-scenarios-quick-reference.md +498 -498
- package/docs/03-PATTERN-GUIDES/connector-scenarios/connector-scenarios-readme.md +313 -313
- package/docs/03-PATTERN-GUIDES/connector-scenarios/examples/common-patterns.ts +612 -612
- package/docs/03-PATTERN-GUIDES/connector-scenarios/examples/connector-scenarios-readme.md +253 -253
- package/docs/03-PATTERN-GUIDES/connector-scenarios/modules/connector-scenarios-01-foundations.md +452 -452
- package/docs/03-PATTERN-GUIDES/connector-scenarios/modules/connector-scenarios-02-simple-scenarios.md +681 -681
- package/docs/03-PATTERN-GUIDES/connector-scenarios/modules/connector-scenarios-03-intermediate-scenarios.md +637 -637
- package/docs/03-PATTERN-GUIDES/connector-scenarios/modules/connector-scenarios-04-advanced-scenarios.md +650 -650
- package/docs/03-PATTERN-GUIDES/connector-scenarios/modules/connector-scenarios-05-bidirectional-sync.md +233 -233
- package/docs/03-PATTERN-GUIDES/connector-scenarios/modules/connector-scenarios-06-production-patterns.md +442 -442
- package/docs/03-PATTERN-GUIDES/connector-scenarios/modules/connector-scenarios-07-reference.md +445 -445
- package/docs/03-PATTERN-GUIDES/connector-scenarios/readme.md +31 -31
- package/docs/03-PATTERN-GUIDES/enterprise-integration-patterns.md +1528 -1528
- package/docs/03-PATTERN-GUIDES/error-handling/comprehensive-error-handling-guide.md +1437 -1437
- package/docs/03-PATTERN-GUIDES/error-handling/error-handling-quick-reference.md +390 -390
- package/docs/03-PATTERN-GUIDES/error-handling/examples/common-patterns.ts +438 -438
- package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-01-foundations.md +362 -362
- package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-02-error-types.md +850 -850
- package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-03-utf8-handling.md +456 -456
- package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-04-error-scenarios.md +658 -658
- package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-05-calling-patterns.md +671 -671
- package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-06-retry-strategies.md +1034 -1034
- package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-07-monitoring.md +653 -653
- package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-08-api-reference.md +847 -847
- package/docs/03-PATTERN-GUIDES/error-handling/readme.md +36 -36
- package/docs/03-PATTERN-GUIDES/examples/__tests__/readme.md +40 -40
- package/docs/03-PATTERN-GUIDES/examples/__tests__/resolver-examples.test.js +282 -282
- package/docs/03-PATTERN-GUIDES/examples/test-data/03-pattern-guides-readme.md +110 -110
- package/docs/03-PATTERN-GUIDES/examples/test-data/canonical-inventory.json +123 -123
- package/docs/03-PATTERN-GUIDES/examples/test-data/canonical-order.json +171 -171
- package/docs/03-PATTERN-GUIDES/examples/test-data/readme.md +28 -28
- package/docs/03-PATTERN-GUIDES/extraction/extraction-readme.md +15 -15
- package/docs/03-PATTERN-GUIDES/extraction/readme.md +25 -25
- package/docs/03-PATTERN-GUIDES/file-operations/examples/common-patterns.ts +407 -407
- package/docs/03-PATTERN-GUIDES/file-operations/examples/file-operations-readme.md +142 -142
- package/docs/03-PATTERN-GUIDES/file-operations/file-operations-quick-reference.md +462 -462
- package/docs/03-PATTERN-GUIDES/file-operations/file-operations-readme.md +379 -379
- package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-01-foundations.md +430 -430
- package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-02-quick-start.md +484 -484
- package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-03-s3-operations.md +507 -507
- package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-04-sftp-operations.md +963 -963
- package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-05-streaming-performance.md +503 -503
- package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-06-archive-patterns.md +386 -386
- package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-06-error-handling.md +117 -117
- package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-07-api-reference.md +78 -78
- package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-07-testing-troubleshooting.md +567 -567
- package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-08-api-reference.md +1055 -1055
- package/docs/03-PATTERN-GUIDES/file-operations/readme.md +32 -32
- package/docs/03-PATTERN-GUIDES/ingestion/ingestion-readme.md +15 -15
- package/docs/03-PATTERN-GUIDES/ingestion/readme.md +25 -25
- package/docs/03-PATTERN-GUIDES/integration-patterns/examples/batch-processing.ts +130 -130
- package/docs/03-PATTERN-GUIDES/integration-patterns/examples/common-patterns.ts +360 -360
- package/docs/03-PATTERN-GUIDES/integration-patterns/examples/delta-sync.ts +130 -130
- package/docs/03-PATTERN-GUIDES/integration-patterns/examples/integration-patterns-readme.md +100 -100
- package/docs/03-PATTERN-GUIDES/integration-patterns/examples/real-time-webhook.ts +398 -398
- package/docs/03-PATTERN-GUIDES/integration-patterns/integration-patterns-quick-reference.md +962 -962
- package/docs/03-PATTERN-GUIDES/integration-patterns/integration-patterns-readme.md +134 -134
- package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-01-real-time-processing.md +991 -991
- package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-02-batch-processing.md +1547 -1547
- package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-03-delta-sync.md +1108 -1108
- package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-04-webhook-patterns.md +1181 -1181
- package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-05-error-handling.md +1061 -1061
- package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-06-advanced-integration-services.md +1547 -1547
- package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-06-performance.md +109 -109
- package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-07-api-reference.md +34 -34
- package/docs/03-PATTERN-GUIDES/integration-patterns/readme.md +30 -30
- package/docs/03-PATTERN-GUIDES/logging-minimal-mode.md +128 -128
- package/docs/03-PATTERN-GUIDES/multiple-connections/examples/common-patterns.ts +380 -380
- package/docs/03-PATTERN-GUIDES/multiple-connections/examples/multiple-connections-readme.md +139 -139
- package/docs/03-PATTERN-GUIDES/multiple-connections/examples/parallel-root-connections.ts +149 -149
- package/docs/03-PATTERN-GUIDES/multiple-connections/examples/real-world-scenarios.ts +405 -405
- package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-01-foundations.md +378 -378
- package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-02-quick-start.md +566 -566
- package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-03-targeting-connections.md +659 -659
- package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-04-parallel-queries.md +656 -656
- package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-05-best-practices.md +624 -624
- package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-06-api-reference.md +824 -824
- package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-06-versori.md +119 -119
- package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-07-api-reference.md +87 -87
- package/docs/03-PATTERN-GUIDES/multiple-connections/multiple-connections-quick-reference.md +353 -353
- package/docs/03-PATTERN-GUIDES/multiple-connections/multiple-connections-readme.md +270 -270
- package/docs/03-PATTERN-GUIDES/multiple-connections/readme.md +30 -30
- package/docs/03-PATTERN-GUIDES/pagination/pagination-readme.md +14 -14
- package/docs/03-PATTERN-GUIDES/pagination/readme.md +24 -24
- package/docs/03-PATTERN-GUIDES/parquet/examples/common-patterns.ts +180 -180
- package/docs/03-PATTERN-GUIDES/parquet/examples/read-parquet.ts +48 -48
- package/docs/03-PATTERN-GUIDES/parquet/examples/write-parquet.ts +65 -65
- package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-01-introduction.md +393 -393
- package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-02-quick-start.md +572 -572
- package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-03-reading-parquet.md +525 -525
- package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-04-writing-parquet.md +554 -554
- package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-05-graphql-extraction.md +405 -405
- package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-06-performance.md +104 -104
- package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-06-s3-integration.md +511 -511
- package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-07-api-reference.md +90 -90
- package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-07-performance-optimization.md +525 -525
- package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-08-best-practices.md +712 -712
- package/docs/03-PATTERN-GUIDES/parquet/parquet-quick-reference.md +683 -683
- package/docs/03-PATTERN-GUIDES/parquet/parquet-readme.md +248 -248
- package/docs/03-PATTERN-GUIDES/parquet/readme.md +32 -32
- package/docs/03-PATTERN-GUIDES/parsers/parsers-readme.md +12 -12
- package/docs/03-PATTERN-GUIDES/parsers/readme.md +24 -24
- package/docs/03-PATTERN-GUIDES/readme.md +159 -159
- package/docs/03-PATTERN-GUIDES/webhooks/readme.md +24 -24
- package/docs/03-PATTERN-GUIDES/webhooks/webhooks-readme.md +8 -8
- package/docs/04-REFERENCE/architecture/architecture-01-overview.md +427 -427
- package/docs/04-REFERENCE/architecture/architecture-02-client-architecture.md +424 -424
- package/docs/04-REFERENCE/architecture/architecture-03-data-flow.md +690 -690
- package/docs/04-REFERENCE/architecture/architecture-04-service-layer.md +834 -834
- package/docs/04-REFERENCE/architecture/architecture-05-integration-architecture.md +655 -655
- package/docs/04-REFERENCE/architecture/architecture-06-state-management.md +653 -653
- package/docs/04-REFERENCE/architecture/architecture-adding-new-data-sources.md +686 -686
- package/docs/04-REFERENCE/architecture/readme.md +279 -279
- package/docs/04-REFERENCE/platforms/deno/readme.md +117 -117
- package/docs/04-REFERENCE/platforms/nodejs/readme.md +146 -146
- package/docs/04-REFERENCE/platforms/readme.md +135 -135
- package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-01-introduction.md +398 -398
- package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-02-quick-start.md +560 -560
- package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-03-authentication.md +757 -757
- package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-04-workflows.md +2476 -2476
- package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-05-connections.md +1167 -1167
- package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-06-kv-storage.md +990 -990
- package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-06-state-management.md +121 -121
- package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-07-api-reference.md +68 -68
- package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-07-deployment.md +731 -731
- package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-08-best-practices.md +1111 -1111
- package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-09-signature-reference.md +766 -766
- package/docs/04-REFERENCE/platforms/versori/platforms-versori-readme.md +299 -299
- package/docs/04-REFERENCE/platforms/versori/platforms-versori-s3-sftp-configuration-guide.md +1425 -1425
- package/docs/04-REFERENCE/platforms/versori/platforms-versori-webhook-api-key-security.md +816 -816
- package/docs/04-REFERENCE/platforms/versori/platforms-versori-webhook-connection-security.md +681 -681
- package/docs/04-REFERENCE/platforms/versori/platforms-versori-workflow-task-types.md +708 -708
- package/docs/04-REFERENCE/platforms/versori/readme.md +108 -108
- package/docs/04-REFERENCE/readme.md +148 -148
- package/docs/04-REFERENCE/resolver-signature/examples/advanced-resolvers.ts +482 -482
- package/docs/04-REFERENCE/resolver-signature/examples/async-resolvers.ts +496 -496
- package/docs/04-REFERENCE/resolver-signature/examples/basic-resolvers.ts +343 -343
- package/docs/04-REFERENCE/resolver-signature/examples/resolver-signature-readme.md +188 -188
- package/docs/04-REFERENCE/resolver-signature/examples/testing-resolvers.ts +463 -463
- package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-01-foundations.md +286 -286
- package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-02-parameter-reference.md +643 -643
- package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-03-basic-examples.md +521 -521
- package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-04-advanced-patterns.md +739 -739
- package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-05-sdk-resolvers.md +531 -531
- package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-06-migration-guide.md +650 -650
- package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-06-testing.md +125 -125
- package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-07-api-reference.md +794 -794
- package/docs/04-REFERENCE/resolver-signature/readme.md +64 -64
- package/docs/04-REFERENCE/resolver-signature/resolver-signature-quick-reference.md +270 -270
- package/docs/04-REFERENCE/resolver-signature/resolver-signature-readme.md +351 -351
- package/docs/04-REFERENCE/schema/fluent-commerce-schema.json +764 -764
- package/docs/04-REFERENCE/schema/readme.md +141 -141
- package/docs/04-REFERENCE/testing/examples/04-reference-testing-readme.md +158 -158
- package/docs/04-REFERENCE/testing/examples/fluent-testing.ts +62 -62
- package/docs/04-REFERENCE/testing/examples/health-check.ts +155 -155
- package/docs/04-REFERENCE/testing/examples/integration-test.ts +119 -119
- package/docs/04-REFERENCE/testing/examples/performance-test.ts +183 -183
- package/docs/04-REFERENCE/testing/examples/s3-testing.ts +127 -127
- package/docs/04-REFERENCE/testing/modules/04-reference-testing-01-foundations.md +267 -267
- package/docs/04-REFERENCE/testing/modules/04-reference-testing-02-s3-testing.md +599 -599
- package/docs/04-REFERENCE/testing/modules/04-reference-testing-03-fluent-testing.md +589 -589
- package/docs/04-REFERENCE/testing/modules/04-reference-testing-04-integration-testing.md +699 -699
- package/docs/04-REFERENCE/testing/modules/04-reference-testing-05-debugging.md +478 -478
- package/docs/04-REFERENCE/testing/modules/04-reference-testing-06-cicd-integration.md +463 -463
- package/docs/04-REFERENCE/testing/modules/04-reference-testing-06-preflight-validation.md +131 -131
- package/docs/04-REFERENCE/testing/modules/04-reference-testing-07-best-practices.md +499 -499
- package/docs/04-REFERENCE/testing/modules/04-reference-testing-07-coverage-ci.md +165 -165
- package/docs/04-REFERENCE/testing/modules/04-reference-testing-08-api-reference.md +634 -634
- package/docs/04-REFERENCE/testing/readme.md +86 -86
- package/docs/04-REFERENCE/testing/testing-quick-reference.md +667 -667
- package/docs/04-REFERENCE/testing/testing-readme.md +286 -286
- package/docs/04-REFERENCE/troubleshooting/readme.md +144 -144
- package/docs/04-REFERENCE/troubleshooting/troubleshooting-deno-sftp-compatibility.md +392 -392
- package/docs/template-loading-matrix.md +242 -242
- package/package.json +5 -3
- package/docs/02-CORE-GUIDES/api-reference/cli-profile-integration.md +0 -377
|
@@ -1,764 +1,764 @@
|
|
|
1
|
-
{
|
|
2
|
-
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
-
"title": "Fluent Commerce GraphQL Schema",
|
|
4
|
-
"description": "Representative GraphQL schema for Fluent Commerce API - Generated for fc-connect-sdk documentation validation",
|
|
5
|
-
"version": "2025.1",
|
|
6
|
-
"generatedOn": "2025-01-19",
|
|
7
|
-
"note": "This schema represents common Fluent Commerce API patterns based on SDK connectors and documentation. Always validate against your specific Fluent Commerce environment using: npx @fluentcommerce/fc-connect-sdk introspect-schema --url YOUR_FLUENT_URL",
|
|
8
|
-
|
|
9
|
-
"types": {
|
|
10
|
-
"Query": {
|
|
11
|
-
"kind": "OBJECT",
|
|
12
|
-
"description": "Root query type for retrieving data from Fluent Commerce",
|
|
13
|
-
"fields": {
|
|
14
|
-
"inventoryPositions": {
|
|
15
|
-
"description": "Query inventory positions with pagination",
|
|
16
|
-
"type": "InventoryPositionConnection!",
|
|
17
|
-
"args": {
|
|
18
|
-
"first": { "type": "Int", "description": "Number of records to return" },
|
|
19
|
-
"after": { "type": "String", "description": "Cursor for pagination" },
|
|
20
|
-
"filter": { "type": "JSON", "description": "Filter criteria" },
|
|
21
|
-
"updatedOn": { "type": "DateTimeRange", "description": "Filter by update time range" }
|
|
22
|
-
}
|
|
23
|
-
},
|
|
24
|
-
"products": {
|
|
25
|
-
"description": "Query products with pagination",
|
|
26
|
-
"type": "ProductConnection!",
|
|
27
|
-
"args": {
|
|
28
|
-
"first": { "type": "Int" },
|
|
29
|
-
"after": { "type": "String" },
|
|
30
|
-
"filter": { "type": "JSON" },
|
|
31
|
-
"ref": { "type": "String" }
|
|
32
|
-
}
|
|
33
|
-
},
|
|
34
|
-
"product": {
|
|
35
|
-
"description": "Get single product by ref",
|
|
36
|
-
"type": "Product",
|
|
37
|
-
"args": {
|
|
38
|
-
"ref": { "type": "String!" }
|
|
39
|
-
}
|
|
40
|
-
},
|
|
41
|
-
"orders": {
|
|
42
|
-
"description": "Query orders with pagination",
|
|
43
|
-
"type": "OrderConnection!",
|
|
44
|
-
"args": {
|
|
45
|
-
"first": { "type": "Int" },
|
|
46
|
-
"after": { "type": "String" },
|
|
47
|
-
"filter": { "type": "JSON" },
|
|
48
|
-
"createdOn": { "type": "DateTimeRange" },
|
|
49
|
-
"updatedOn": { "type": "DateTimeRange" }
|
|
50
|
-
}
|
|
51
|
-
},
|
|
52
|
-
"order": {
|
|
53
|
-
"description": "Get single order by ref",
|
|
54
|
-
"type": "Order",
|
|
55
|
-
"args": {
|
|
56
|
-
"ref": { "type": "String!" }
|
|
57
|
-
}
|
|
58
|
-
},
|
|
59
|
-
"locations": {
|
|
60
|
-
"description": "Query locations with pagination",
|
|
61
|
-
"type": "LocationConnection!",
|
|
62
|
-
"args": {
|
|
63
|
-
"first": { "type": "Int" },
|
|
64
|
-
"after": { "type": "String" }
|
|
65
|
-
}
|
|
66
|
-
},
|
|
67
|
-
"customers": {
|
|
68
|
-
"description": "Query customers",
|
|
69
|
-
"type": "CustomerConnection!",
|
|
70
|
-
"args": {
|
|
71
|
-
"email": { "type": "String" },
|
|
72
|
-
"first": { "type": "Int" },
|
|
73
|
-
"after": { "type": "String" }
|
|
74
|
-
}
|
|
75
|
-
}
|
|
76
|
-
}
|
|
77
|
-
},
|
|
78
|
-
|
|
79
|
-
"Mutation": {
|
|
80
|
-
"kind": "OBJECT",
|
|
81
|
-
"description": "Root mutation type for modifying data in Fluent Commerce",
|
|
82
|
-
"fields": {
|
|
83
|
-
"createOrder": {
|
|
84
|
-
"description": "Create a new order",
|
|
85
|
-
"type": "Order!",
|
|
86
|
-
"args": {
|
|
87
|
-
"input": { "type": "CreateOrderInput!" }
|
|
88
|
-
}
|
|
89
|
-
},
|
|
90
|
-
"updateInventoryPositions": {
|
|
91
|
-
"description": "Update inventory positions (use batch API instead for better performance)",
|
|
92
|
-
"type": "UpdateInventoryPositionsPayload",
|
|
93
|
-
"args": {
|
|
94
|
-
"input": { "type": "[UpdateInventoryPositionInput]!" }
|
|
95
|
-
}
|
|
96
|
-
},
|
|
97
|
-
"upsertInventoryPosition": {
|
|
98
|
-
"description": "Upsert single inventory position",
|
|
99
|
-
"type": "InventoryPosition",
|
|
100
|
-
"args": {
|
|
101
|
-
"input": { "type": "UpsertInventoryPositionInput!" }
|
|
102
|
-
}
|
|
103
|
-
},
|
|
104
|
-
"sendBatch": {
|
|
105
|
-
"description": "Send batch of entities for processing (Batch API - INVENTORY_POSITION only)",
|
|
106
|
-
"type": "Batch!",
|
|
107
|
-
"args": {
|
|
108
|
-
"input": { "type": "BatchInput!" }
|
|
109
|
-
}
|
|
110
|
-
},
|
|
111
|
-
"createJob": {
|
|
112
|
-
"description": "Create a job for batch processing",
|
|
113
|
-
"type": "Job!",
|
|
114
|
-
"args": {
|
|
115
|
-
"input": { "type": "CreateJobInput!" }
|
|
116
|
-
}
|
|
117
|
-
},
|
|
118
|
-
"createCustomer": {
|
|
119
|
-
"description": "Create a customer",
|
|
120
|
-
"type": "Customer!",
|
|
121
|
-
"args": {
|
|
122
|
-
"input": { "type": "CreateCustomerInput!" }
|
|
123
|
-
}
|
|
124
|
-
}
|
|
125
|
-
}
|
|
126
|
-
},
|
|
127
|
-
|
|
128
|
-
"InventoryPosition": {
|
|
129
|
-
"kind": "OBJECT",
|
|
130
|
-
"description": "Represents an inventory position at a specific location",
|
|
131
|
-
"fields": {
|
|
132
|
-
"id": { "type": "ID!", "description": "Unique identifier" },
|
|
133
|
-
"ref": { "type": "String!", "description": "Reference code" },
|
|
134
|
-
"productRef": { "type": "String!", "description": "Product reference" },
|
|
135
|
-
"locationRef": { "type": "String!", "description": "Location reference" },
|
|
136
|
-
"qty": { "type": "Int!", "description": "Quantity available" },
|
|
137
|
-
"status": { "type": "String", "description": "Position status (e.g., AVAILABLE, RESERVED)" },
|
|
138
|
-
"createdOn": { "type": "DateTime", "description": "Creation timestamp" },
|
|
139
|
-
"updatedOn": { "type": "DateTime", "description": "Last update timestamp" },
|
|
140
|
-
"product": { "type": "Product", "description": "Associated product" },
|
|
141
|
-
"location": { "type": "Location", "description": "Associated location" },
|
|
142
|
-
"quantities": { "type": "QuantityConnection", "description": "Quantity breakdown" }
|
|
143
|
-
}
|
|
144
|
-
},
|
|
145
|
-
|
|
146
|
-
"Product": {
|
|
147
|
-
"kind": "OBJECT",
|
|
148
|
-
"description": "Represents a product in the catalog",
|
|
149
|
-
"fields": {
|
|
150
|
-
"id": { "type": "ID!", "description": "Unique identifier" },
|
|
151
|
-
"ref": { "type": "String!", "description": "Product reference/SKU" },
|
|
152
|
-
"name": { "type": "String", "description": "Product name" },
|
|
153
|
-
"gtin": { "type": "String", "description": "Global Trade Item Number" },
|
|
154
|
-
"description": { "type": "String", "description": "Product description" },
|
|
155
|
-
"catalogue": { "type": "Catalogue", "description": "Product catalogue" },
|
|
156
|
-
"categories": { "type": "CategoryConnection", "description": "Product categories" },
|
|
157
|
-
"attributes": { "type": "[Attribute]", "description": "Product attributes" },
|
|
158
|
-
"inventoryPositions": { "type": "InventoryPositionConnection", "description": "Inventory positions" },
|
|
159
|
-
"createdOn": { "type": "DateTime" },
|
|
160
|
-
"updatedOn": { "type": "DateTime" }
|
|
161
|
-
}
|
|
162
|
-
},
|
|
163
|
-
|
|
164
|
-
"Order": {
|
|
165
|
-
"kind": "OBJECT",
|
|
166
|
-
"description": "Represents a customer order",
|
|
167
|
-
"fields": {
|
|
168
|
-
"id": { "type": "ID!", "description": "Unique identifier" },
|
|
169
|
-
"ref": { "type": "String!", "description": "Order reference number" },
|
|
170
|
-
"type": { "type": "OrderType!", "description": "Order type (e.g., STANDARD, CC)" },
|
|
171
|
-
"status": { "type": "String", "description": "Order status" },
|
|
172
|
-
"totalPrice": { "type": "Float!", "description": "Total price" },
|
|
173
|
-
"totalTaxPrice": { "type": "Float", "description": "Total tax amount" },
|
|
174
|
-
"currency": { "type": "String!", "description": "Currency code (e.g., USD)" },
|
|
175
|
-
"customer": { "type": "Customer", "description": "Customer information" },
|
|
176
|
-
"billingAddress": { "type": "Address", "description": "Billing address" },
|
|
177
|
-
"items": { "type": "OrderItemConnection!", "description": "Order items" },
|
|
178
|
-
"fulfilments": { "type": "FulfilmentConnection", "description": "Order fulfilments" },
|
|
179
|
-
"financialTransactions": { "type": "[FinancialTransaction]", "description": "Payment transactions" },
|
|
180
|
-
"attributes": { "type": "[Attribute]", "description": "Custom attributes" },
|
|
181
|
-
"createdOn": { "type": "DateTime!", "description": "Creation timestamp" },
|
|
182
|
-
"updatedOn": { "type": "DateTime", "description": "Last update timestamp" },
|
|
183
|
-
"retailer": { "type": "Retailer!", "description": "Retailer" }
|
|
184
|
-
}
|
|
185
|
-
},
|
|
186
|
-
|
|
187
|
-
"OrderItem": {
|
|
188
|
-
"kind": "OBJECT",
|
|
189
|
-
"description": "Represents an item in an order",
|
|
190
|
-
"fields": {
|
|
191
|
-
"ref": { "type": "String!", "description": "Item reference" },
|
|
192
|
-
"productRef": { "type": "String!", "description": "Product reference/SKU" },
|
|
193
|
-
"productCatalogueRef": { "type": "String", "description": "Product catalogue reference" },
|
|
194
|
-
"quantity": { "type": "Int!", "description": "Quantity ordered" },
|
|
195
|
-
"price": { "type": "Float!", "description": "Unit price" },
|
|
196
|
-
"paidPrice": { "type": "Float", "description": "Price after discounts" },
|
|
197
|
-
"totalPrice": { "type": "Float!", "description": "Total price for this item" },
|
|
198
|
-
"taxPrice": { "type": "Float", "description": "Tax amount" },
|
|
199
|
-
"totalTaxPrice": { "type": "Float", "description": "Total tax" },
|
|
200
|
-
"currency": { "type": "String!", "description": "Currency code" },
|
|
201
|
-
"fulfilmentChoiceRef": { "type": "String", "description": "Fulfilment choice reference" },
|
|
202
|
-
"attributes": { "type": "[Attribute]", "description": "Item attributes" }
|
|
203
|
-
}
|
|
204
|
-
},
|
|
205
|
-
|
|
206
|
-
"Customer": {
|
|
207
|
-
"kind": "OBJECT",
|
|
208
|
-
"description": "Represents a customer",
|
|
209
|
-
"fields": {
|
|
210
|
-
"id": { "type": "ID!", "description": "Unique identifier" },
|
|
211
|
-
"ref": { "type": "String!", "description": "Customer reference" },
|
|
212
|
-
"email": { "type": "String", "description": "Email address" },
|
|
213
|
-
"firstName": { "type": "String", "description": "First name" },
|
|
214
|
-
"lastName": { "type": "String", "description": "Last name" },
|
|
215
|
-
"phone": { "type": "String", "description": "Phone number" },
|
|
216
|
-
"addresses": { "type": "[Address]", "description": "Customer addresses" }
|
|
217
|
-
}
|
|
218
|
-
},
|
|
219
|
-
|
|
220
|
-
"Location": {
|
|
221
|
-
"kind": "OBJECT",
|
|
222
|
-
"description": "Represents a physical location (warehouse, store, etc.)",
|
|
223
|
-
"fields": {
|
|
224
|
-
"id": { "type": "ID!", "description": "Unique identifier" },
|
|
225
|
-
"ref": { "type": "String!", "description": "Location reference code" },
|
|
226
|
-
"name": { "type": "String!", "description": "Location name" },
|
|
227
|
-
"type": { "type": "String", "description": "Location type (WAREHOUSE, STORE, etc.)" },
|
|
228
|
-
"address": { "type": "Address", "description": "Location address" },
|
|
229
|
-
"attributes": { "type": "[Attribute]", "description": "Location attributes" }
|
|
230
|
-
}
|
|
231
|
-
},
|
|
232
|
-
|
|
233
|
-
"Catalogue": {
|
|
234
|
-
"kind": "OBJECT",
|
|
235
|
-
"description": "Represents a product catalogue",
|
|
236
|
-
"fields": {
|
|
237
|
-
"ref": { "type": "String!", "description": "Catalogue reference" },
|
|
238
|
-
"name": { "type": "String", "description": "Catalogue name" }
|
|
239
|
-
}
|
|
240
|
-
},
|
|
241
|
-
|
|
242
|
-
"Address": {
|
|
243
|
-
"kind": "OBJECT",
|
|
244
|
-
"description": "Represents a physical address",
|
|
245
|
-
"fields": {
|
|
246
|
-
"street": { "type": "String", "description": "Street address" },
|
|
247
|
-
"street2": { "type": "String", "description": "Additional address line" },
|
|
248
|
-
"city": { "type": "String", "description": "City" },
|
|
249
|
-
"state": { "type": "String", "description": "State/province code" },
|
|
250
|
-
"postcode": { "type": "String", "description": "Postal/ZIP code" },
|
|
251
|
-
"country": { "type": "String", "description": "Country code" },
|
|
252
|
-
"phone": { "type": "String", "description": "Contact phone" }
|
|
253
|
-
}
|
|
254
|
-
},
|
|
255
|
-
|
|
256
|
-
"Attribute": {
|
|
257
|
-
"kind": "OBJECT",
|
|
258
|
-
"description": "Custom attribute key-value pair",
|
|
259
|
-
"fields": {
|
|
260
|
-
"name": { "type": "String!", "description": "Attribute name" },
|
|
261
|
-
"value": { "type": "String!", "description": "Attribute value" },
|
|
262
|
-
"type": { "type": "String", "description": "Attribute type" }
|
|
263
|
-
}
|
|
264
|
-
},
|
|
265
|
-
|
|
266
|
-
"Fulfilment": {
|
|
267
|
-
"kind": "OBJECT",
|
|
268
|
-
"description": "Represents an order fulfilment",
|
|
269
|
-
"fields": {
|
|
270
|
-
"id": { "type": "ID!" },
|
|
271
|
-
"ref": { "type": "String!" },
|
|
272
|
-
"status": { "type": "String" },
|
|
273
|
-
"type": { "type": "String" },
|
|
274
|
-
"deliveryType": { "type": "String" },
|
|
275
|
-
"items": { "type": "FulfilmentItemConnection" }
|
|
276
|
-
}
|
|
277
|
-
},
|
|
278
|
-
|
|
279
|
-
"FinancialTransaction": {
|
|
280
|
-
"kind": "OBJECT",
|
|
281
|
-
"description": "Represents a financial transaction/payment",
|
|
282
|
-
"fields": {
|
|
283
|
-
"ref": { "type": "String!", "description": "Transaction reference" },
|
|
284
|
-
"type": { "type": "String!", "description": "Transaction type (AUTHORIZATION, CAPTURE, etc.)" },
|
|
285
|
-
"amount": { "type": "Float!", "description": "Transaction amount" },
|
|
286
|
-
"currency": { "type": "String!", "description": "Currency code" },
|
|
287
|
-
"cardType": { "type": "String", "description": "Card type (Visa, MasterCard, etc.)" },
|
|
288
|
-
"paymentMethod": { "type": "String!", "description": "Payment method" },
|
|
289
|
-
"externalTransactionCode": { "type": "String", "description": "External auth code" },
|
|
290
|
-
"externalTransactionId": { "type": "String", "description": "External transaction ID" },
|
|
291
|
-
"attributes": { "type": "[Attribute]", "description": "Transaction attributes" }
|
|
292
|
-
}
|
|
293
|
-
},
|
|
294
|
-
|
|
295
|
-
"Retailer": {
|
|
296
|
-
"kind": "OBJECT",
|
|
297
|
-
"description": "Represents a retailer",
|
|
298
|
-
"fields": {
|
|
299
|
-
"id": { "type": "ID!", "description": "Retailer ID" },
|
|
300
|
-
"ref": { "type": "String", "description": "Retailer reference" }
|
|
301
|
-
}
|
|
302
|
-
},
|
|
303
|
-
|
|
304
|
-
"Job": {
|
|
305
|
-
"kind": "OBJECT",
|
|
306
|
-
"description": "Represents a batch processing job",
|
|
307
|
-
"fields": {
|
|
308
|
-
"id": { "type": "ID!", "description": "Job ID" },
|
|
309
|
-
"name": { "type": "String", "description": "Job name" },
|
|
310
|
-
"status": { "type": "JobStatus", "description": "Job status" },
|
|
311
|
-
"progress": { "type": "Float", "description": "Progress percentage" }
|
|
312
|
-
}
|
|
313
|
-
},
|
|
314
|
-
|
|
315
|
-
"Batch": {
|
|
316
|
-
"kind": "OBJECT",
|
|
317
|
-
"description": "Represents a batch submission",
|
|
318
|
-
"fields": {
|
|
319
|
-
"id": { "type": "ID!", "description": "Batch ID" },
|
|
320
|
-
"status": { "type": "BatchStatus", "description": "Batch status" }
|
|
321
|
-
}
|
|
322
|
-
}
|
|
323
|
-
},
|
|
324
|
-
|
|
325
|
-
"inputs": {
|
|
326
|
-
"CreateOrderInput": {
|
|
327
|
-
"kind": "INPUT_OBJECT",
|
|
328
|
-
"description": "Input for creating an order",
|
|
329
|
-
"fields": {
|
|
330
|
-
"ref": { "type": "String!", "description": "Order reference (Required)" },
|
|
331
|
-
"type": { "type": "OrderType!", "description": "Order type (Required)" },
|
|
332
|
-
"retailer": { "type": "RetailerInput!", "description": "Retailer information (Required)" },
|
|
333
|
-
"totalPrice": { "type": "Float!", "description": "Total price (Required)" },
|
|
334
|
-
"totalTaxPrice": { "type": "Float", "description": "Total tax amount" },
|
|
335
|
-
"currency": { "type": "String!", "description": "Currency code (Required)" },
|
|
336
|
-
"customer": { "type": "CustomerInput!", "description": "Customer information (Required)" },
|
|
337
|
-
"billingAddress": { "type": "AddressInput", "description": "Billing address" },
|
|
338
|
-
"items": { "type": "[OrderItemInput]!", "description": "Order items (Required)" },
|
|
339
|
-
"fulfilmentChoices": { "type": "[FulfilmentChoiceInput]", "description": "Fulfilment choices" },
|
|
340
|
-
"financialTransactions": { "type": "[FinancialTransactionInput]", "description": "Payment transactions" },
|
|
341
|
-
"attributes": { "type": "[AttributeInput]", "description": "Custom attributes" }
|
|
342
|
-
}
|
|
343
|
-
},
|
|
344
|
-
|
|
345
|
-
"OrderItemInput": {
|
|
346
|
-
"kind": "INPUT_OBJECT",
|
|
347
|
-
"description": "Input for order item",
|
|
348
|
-
"fields": {
|
|
349
|
-
"ref": { "type": "String!", "description": "Item reference (Required)" },
|
|
350
|
-
"productRef": { "type": "String!", "description": "Product reference (Required)" },
|
|
351
|
-
"productCatalogueRef": { "type": "String", "description": "Product catalogue reference" },
|
|
352
|
-
"quantity": { "type": "Int!", "description": "Quantity (Required)" },
|
|
353
|
-
"price": { "type": "Float!", "description": "Unit price (Required)" },
|
|
354
|
-
"paidPrice": { "type": "Float", "description": "Price after discounts" },
|
|
355
|
-
"totalPrice": { "type": "Float!", "description": "Total price (Required)" },
|
|
356
|
-
"taxPrice": { "type": "Float", "description": "Tax amount" },
|
|
357
|
-
"totalTaxPrice": { "type": "Float", "description": "Total tax" },
|
|
358
|
-
"currency": { "type": "String!", "description": "Currency code (Required)" },
|
|
359
|
-
"fulfilmentChoiceRef": { "type": "String", "description": "Fulfilment choice reference" },
|
|
360
|
-
"attributes": { "type": "[AttributeInput]", "description": "Item attributes" }
|
|
361
|
-
}
|
|
362
|
-
},
|
|
363
|
-
|
|
364
|
-
"CustomerInput": {
|
|
365
|
-
"kind": "INPUT_OBJECT",
|
|
366
|
-
"description": "Input for customer",
|
|
367
|
-
"fields": {
|
|
368
|
-
"id": { "type": "ID", "description": "Customer ID (for existing customer)" },
|
|
369
|
-
"ref": { "type": "String", "description": "Customer reference" },
|
|
370
|
-
"email": { "type": "String", "description": "Email address" },
|
|
371
|
-
"firstName": { "type": "String", "description": "First name" },
|
|
372
|
-
"lastName": { "type": "String", "description": "Last name" }
|
|
373
|
-
}
|
|
374
|
-
},
|
|
375
|
-
|
|
376
|
-
"RetailerInput": {
|
|
377
|
-
"kind": "INPUT_OBJECT",
|
|
378
|
-
"description": "Input for retailer",
|
|
379
|
-
"fields": {
|
|
380
|
-
"id": { "type": "ID!", "description": "Retailer ID (Required)" }
|
|
381
|
-
}
|
|
382
|
-
},
|
|
383
|
-
|
|
384
|
-
"AddressInput": {
|
|
385
|
-
"kind": "INPUT_OBJECT",
|
|
386
|
-
"description": "Input for address",
|
|
387
|
-
"fields": {
|
|
388
|
-
"street": { "type": "String" },
|
|
389
|
-
"street2": { "type": "String" },
|
|
390
|
-
"city": { "type": "String" },
|
|
391
|
-
"state": { "type": "String" },
|
|
392
|
-
"postcode": { "type": "String" },
|
|
393
|
-
"country": { "type": "String" },
|
|
394
|
-
"phone": { "type": "String" }
|
|
395
|
-
}
|
|
396
|
-
},
|
|
397
|
-
|
|
398
|
-
"FulfilmentChoiceInput": {
|
|
399
|
-
"kind": "INPUT_OBJECT",
|
|
400
|
-
"description": "Input for fulfilment choice",
|
|
401
|
-
"fields": {
|
|
402
|
-
"ref": { "type": "String!", "description": "Fulfilment choice reference" },
|
|
403
|
-
"deliveryType": { "type": "String", "description": "Delivery type" },
|
|
404
|
-
"deliveryAddress": { "type": "AddressInput", "description": "Delivery address" }
|
|
405
|
-
}
|
|
406
|
-
},
|
|
407
|
-
|
|
408
|
-
"FinancialTransactionInput": {
|
|
409
|
-
"kind": "INPUT_OBJECT",
|
|
410
|
-
"description": "Input for financial transaction",
|
|
411
|
-
"fields": {
|
|
412
|
-
"ref": { "type": "String!", "description": "Transaction reference (Required)" },
|
|
413
|
-
"type": { "type": "String!", "description": "Transaction type (Required)" },
|
|
414
|
-
"amount": { "type": "Float!", "description": "Amount (Required)" },
|
|
415
|
-
"currency": { "type": "String!", "description": "Currency (Required)" },
|
|
416
|
-
"cardType": { "type": "String" },
|
|
417
|
-
"paymentMethod": { "type": "String!" },
|
|
418
|
-
"externalTransactionCode": { "type": "String" },
|
|
419
|
-
"externalTransactionId": { "type": "String" },
|
|
420
|
-
"attributes": { "type": "[AttributeInput]" }
|
|
421
|
-
}
|
|
422
|
-
},
|
|
423
|
-
|
|
424
|
-
"AttributeInput": {
|
|
425
|
-
"kind": "INPUT_OBJECT",
|
|
426
|
-
"description": "Input for attribute",
|
|
427
|
-
"fields": {
|
|
428
|
-
"name": { "type": "String!", "description": "Attribute name (Required)" },
|
|
429
|
-
"value": { "type": "String!", "description": "Attribute value (Required)" },
|
|
430
|
-
"type": { "type": "String", "description": "Attribute type" }
|
|
431
|
-
}
|
|
432
|
-
},
|
|
433
|
-
|
|
434
|
-
"UpsertInventoryPositionInput": {
|
|
435
|
-
"kind": "INPUT_OBJECT",
|
|
436
|
-
"description": "Input for upserting inventory position",
|
|
437
|
-
"fields": {
|
|
438
|
-
"ref": { "type": "String!", "description": "Position reference (Required)" },
|
|
439
|
-
"productRef": { "type": "String!", "description": "Product reference (Required)" },
|
|
440
|
-
"locationRef": { "type": "String!", "description": "Location reference (Required)" },
|
|
441
|
-
"qty": { "type": "Int!", "description": "Quantity (Required)" },
|
|
442
|
-
"status": { "type": "String", "description": "Status (e.g., AVAILABLE, RESERVED)" },
|
|
443
|
-
"type": { "type": "String", "description": "Position type" }
|
|
444
|
-
}
|
|
445
|
-
},
|
|
446
|
-
|
|
447
|
-
"UpdateInventoryPositionInput": {
|
|
448
|
-
"kind": "INPUT_OBJECT",
|
|
449
|
-
"description": "Input for updating inventory position (use batch API for better performance)",
|
|
450
|
-
"fields": {
|
|
451
|
-
"ref": { "type": "String!", "description": "Position reference" },
|
|
452
|
-
"productRef": { "type": "String", "description": "Product reference" },
|
|
453
|
-
"locationRef": { "type": "String", "description": "Location reference" },
|
|
454
|
-
"qty": { "type": "Int", "description": "Quantity adjustment" },
|
|
455
|
-
"status": { "type": "String", "description": "Status" }
|
|
456
|
-
}
|
|
457
|
-
},
|
|
458
|
-
|
|
459
|
-
"BatchInput": {
|
|
460
|
-
"kind": "INPUT_OBJECT",
|
|
461
|
-
"description": "Input for batch submission (Batch API - INVENTORY_POSITION only)",
|
|
462
|
-
"fields": {
|
|
463
|
-
"action": { "type": "BatchAction!", "description": "Batch action (UPSERT only)" },
|
|
464
|
-
"entityType": { "type": "EntityType!", "description": "Entity type (INVENTORY_POSITION only)" },
|
|
465
|
-
"retailerId": { "type": "ID!", "description": "Retailer ID (Required)" },
|
|
466
|
-
"entities": { "type": "[InventoryPositionInput]!", "description": "Entities to process (Required)" }
|
|
467
|
-
}
|
|
468
|
-
},
|
|
469
|
-
|
|
470
|
-
"InventoryPositionInput": {
|
|
471
|
-
"kind": "INPUT_OBJECT",
|
|
472
|
-
"description": "Input for inventory position in batch",
|
|
473
|
-
"fields": {
|
|
474
|
-
"ref": { "type": "String!", "description": "Position reference (Required)" },
|
|
475
|
-
"productRef": { "type": "String!", "description": "Product reference (Required)" },
|
|
476
|
-
"locationRef": { "type": "String!", "description": "Location reference (Required)" },
|
|
477
|
-
"qty": { "type": "Int!", "description": "Quantity (Required)" },
|
|
478
|
-
"status": { "type": "String", "description": "Status" }
|
|
479
|
-
}
|
|
480
|
-
},
|
|
481
|
-
|
|
482
|
-
"CreateJobInput": {
|
|
483
|
-
"kind": "INPUT_OBJECT",
|
|
484
|
-
"description": "Input for creating a job",
|
|
485
|
-
"fields": {
|
|
486
|
-
"name": { "type": "String!", "description": "Job name (Required)" },
|
|
487
|
-
"retailerId": { "type": "ID!", "description": "Retailer ID (Required)" },
|
|
488
|
-
"metadata": { "type": "JSON", "description": "Job metadata" }
|
|
489
|
-
}
|
|
490
|
-
},
|
|
491
|
-
|
|
492
|
-
"CreateCustomerInput": {
|
|
493
|
-
"kind": "INPUT_OBJECT",
|
|
494
|
-
"description": "Input for creating a customer",
|
|
495
|
-
"fields": {
|
|
496
|
-
"ref": { "type": "String", "description": "Customer reference" },
|
|
497
|
-
"email": { "type": "String", "description": "Email address" },
|
|
498
|
-
"firstName": { "type": "String", "description": "First name" },
|
|
499
|
-
"lastName": { "type": "String", "description": "Last name" }
|
|
500
|
-
}
|
|
501
|
-
},
|
|
502
|
-
|
|
503
|
-
"DateTimeRange": {
|
|
504
|
-
"kind": "INPUT_OBJECT",
|
|
505
|
-
"description": "Date time range filter",
|
|
506
|
-
"fields": {
|
|
507
|
-
"from": { "type": "DateTime", "description": "Start date" },
|
|
508
|
-
"to": { "type": "DateTime", "description": "End date" }
|
|
509
|
-
}
|
|
510
|
-
}
|
|
511
|
-
},
|
|
512
|
-
|
|
513
|
-
"enums": {
|
|
514
|
-
"OrderType": {
|
|
515
|
-
"kind": "ENUM",
|
|
516
|
-
"description": "Order type enumeration",
|
|
517
|
-
"values": ["STANDARD", "HD", "CC", "SALES"]
|
|
518
|
-
},
|
|
519
|
-
|
|
520
|
-
"EntityType": {
|
|
521
|
-
"kind": "ENUM",
|
|
522
|
-
"description": "Entity type for batch operations (Batch API limitation)",
|
|
523
|
-
"values": ["INVENTORY_POSITION"],
|
|
524
|
-
"note": "Batch API ONLY supports INVENTORY_POSITION. For other entities (ORDER, PRODUCT, LOCATION), use GraphQL mutations directly."
|
|
525
|
-
},
|
|
526
|
-
|
|
527
|
-
"BatchAction": {
|
|
528
|
-
"kind": "ENUM",
|
|
529
|
-
"description": "Batch action type",
|
|
530
|
-
"values": ["UPSERT"],
|
|
531
|
-
"note": "Batch API ONLY supports UPSERT action"
|
|
532
|
-
},
|
|
533
|
-
|
|
534
|
-
"JobStatus": {
|
|
535
|
-
"kind": "ENUM",
|
|
536
|
-
"description": "Job status enumeration",
|
|
537
|
-
"values": ["PENDING", "RUNNING", "COMPLETED", "FAILED", "COMPLETED_WITH_ERRORS"]
|
|
538
|
-
},
|
|
539
|
-
|
|
540
|
-
"BatchStatus": {
|
|
541
|
-
"kind": "ENUM",
|
|
542
|
-
"description": "Batch status enumeration",
|
|
543
|
-
"values": ["PENDING", "PROCESSING", "COMPLETED", "FAILED"]
|
|
544
|
-
}
|
|
545
|
-
},
|
|
546
|
-
|
|
547
|
-
"connections": {
|
|
548
|
-
"InventoryPositionConnection": {
|
|
549
|
-
"kind": "OBJECT",
|
|
550
|
-
"description": "Paginated inventory positions",
|
|
551
|
-
"fields": {
|
|
552
|
-
"edges": { "type": "[InventoryPositionEdge]!", "description": "Array of edges" },
|
|
553
|
-
"pageInfo": { "type": "PageInfo!", "description": "Pagination info" }
|
|
554
|
-
}
|
|
555
|
-
},
|
|
556
|
-
|
|
557
|
-
"InventoryPositionEdge": {
|
|
558
|
-
"kind": "OBJECT",
|
|
559
|
-
"description": "Edge for inventory position",
|
|
560
|
-
"fields": {
|
|
561
|
-
"cursor": { "type": "String!", "description": "Cursor for this edge" },
|
|
562
|
-
"node": { "type": "InventoryPosition!", "description": "The inventory position" }
|
|
563
|
-
}
|
|
564
|
-
},
|
|
565
|
-
|
|
566
|
-
"ProductConnection": {
|
|
567
|
-
"kind": "OBJECT",
|
|
568
|
-
"description": "Paginated products",
|
|
569
|
-
"fields": {
|
|
570
|
-
"edges": { "type": "[ProductEdge]!" },
|
|
571
|
-
"pageInfo": { "type": "PageInfo!" }
|
|
572
|
-
}
|
|
573
|
-
},
|
|
574
|
-
|
|
575
|
-
"ProductEdge": {
|
|
576
|
-
"kind": "OBJECT",
|
|
577
|
-
"fields": {
|
|
578
|
-
"cursor": { "type": "String!" },
|
|
579
|
-
"node": { "type": "Product!" }
|
|
580
|
-
}
|
|
581
|
-
},
|
|
582
|
-
|
|
583
|
-
"OrderConnection": {
|
|
584
|
-
"kind": "OBJECT",
|
|
585
|
-
"description": "Paginated orders",
|
|
586
|
-
"fields": {
|
|
587
|
-
"edges": { "type": "[OrderEdge]!" },
|
|
588
|
-
"pageInfo": { "type": "PageInfo!" }
|
|
589
|
-
}
|
|
590
|
-
},
|
|
591
|
-
|
|
592
|
-
"OrderEdge": {
|
|
593
|
-
"kind": "OBJECT",
|
|
594
|
-
"fields": {
|
|
595
|
-
"cursor": { "type": "String!" },
|
|
596
|
-
"node": { "type": "Order!" }
|
|
597
|
-
}
|
|
598
|
-
},
|
|
599
|
-
|
|
600
|
-
"OrderItemConnection": {
|
|
601
|
-
"kind": "OBJECT",
|
|
602
|
-
"description": "Paginated order items",
|
|
603
|
-
"fields": {
|
|
604
|
-
"edges": { "type": "[OrderItemEdge]!" }
|
|
605
|
-
}
|
|
606
|
-
},
|
|
607
|
-
|
|
608
|
-
"OrderItemEdge": {
|
|
609
|
-
"kind": "OBJECT",
|
|
610
|
-
"fields": {
|
|
611
|
-
"node": { "type": "OrderItem!" }
|
|
612
|
-
}
|
|
613
|
-
},
|
|
614
|
-
|
|
615
|
-
"LocationConnection": {
|
|
616
|
-
"kind": "OBJECT",
|
|
617
|
-
"fields": {
|
|
618
|
-
"edges": { "type": "[LocationEdge]!" },
|
|
619
|
-
"pageInfo": { "type": "PageInfo!" }
|
|
620
|
-
}
|
|
621
|
-
},
|
|
622
|
-
|
|
623
|
-
"LocationEdge": {
|
|
624
|
-
"kind": "OBJECT",
|
|
625
|
-
"fields": {
|
|
626
|
-
"cursor": { "type": "String!" },
|
|
627
|
-
"node": { "type": "Location!" }
|
|
628
|
-
}
|
|
629
|
-
},
|
|
630
|
-
|
|
631
|
-
"CustomerConnection": {
|
|
632
|
-
"kind": "OBJECT",
|
|
633
|
-
"fields": {
|
|
634
|
-
"edges": { "type": "[CustomerEdge]!" },
|
|
635
|
-
"pageInfo": { "type": "PageInfo!" }
|
|
636
|
-
}
|
|
637
|
-
},
|
|
638
|
-
|
|
639
|
-
"CustomerEdge": {
|
|
640
|
-
"kind": "OBJECT",
|
|
641
|
-
"fields": {
|
|
642
|
-
"cursor": { "type": "String!" },
|
|
643
|
-
"node": { "type": "Customer!" }
|
|
644
|
-
}
|
|
645
|
-
},
|
|
646
|
-
|
|
647
|
-
"CategoryConnection": {
|
|
648
|
-
"kind": "OBJECT",
|
|
649
|
-
"fields": {
|
|
650
|
-
"edges": { "type": "[CategoryEdge]!" }
|
|
651
|
-
}
|
|
652
|
-
},
|
|
653
|
-
|
|
654
|
-
"CategoryEdge": {
|
|
655
|
-
"kind": "OBJECT",
|
|
656
|
-
"fields": {
|
|
657
|
-
"node": { "type": "Category!" }
|
|
658
|
-
}
|
|
659
|
-
},
|
|
660
|
-
|
|
661
|
-
"FulfilmentConnection": {
|
|
662
|
-
"kind": "OBJECT",
|
|
663
|
-
"fields": {
|
|
664
|
-
"edges": { "type": "[FulfilmentEdge]!" }
|
|
665
|
-
}
|
|
666
|
-
},
|
|
667
|
-
|
|
668
|
-
"FulfilmentEdge": {
|
|
669
|
-
"kind": "OBJECT",
|
|
670
|
-
"fields": {
|
|
671
|
-
"node": { "type": "Fulfilment!" }
|
|
672
|
-
}
|
|
673
|
-
},
|
|
674
|
-
|
|
675
|
-
"FulfilmentItemConnection": {
|
|
676
|
-
"kind": "OBJECT",
|
|
677
|
-
"fields": {
|
|
678
|
-
"edges": { "type": "[FulfilmentItemEdge]!" }
|
|
679
|
-
}
|
|
680
|
-
},
|
|
681
|
-
|
|
682
|
-
"FulfilmentItemEdge": {
|
|
683
|
-
"kind": "OBJECT",
|
|
684
|
-
"fields": {
|
|
685
|
-
"node": { "type": "FulfilmentItem!" }
|
|
686
|
-
}
|
|
687
|
-
},
|
|
688
|
-
|
|
689
|
-
"QuantityConnection": {
|
|
690
|
-
"kind": "OBJECT",
|
|
691
|
-
"fields": {
|
|
692
|
-
"edges": { "type": "[QuantityEdge]!" }
|
|
693
|
-
}
|
|
694
|
-
},
|
|
695
|
-
|
|
696
|
-
"QuantityEdge": {
|
|
697
|
-
"kind": "OBJECT",
|
|
698
|
-
"fields": {
|
|
699
|
-
"node": { "type": "Quantity!" }
|
|
700
|
-
}
|
|
701
|
-
},
|
|
702
|
-
|
|
703
|
-
"PageInfo": {
|
|
704
|
-
"kind": "OBJECT",
|
|
705
|
-
"description": "Pagination information - IMPORTANT: Fluent does NOT return startCursor/endCursor (deviation from Relay spec)",
|
|
706
|
-
"fields": {
|
|
707
|
-
"hasNextPage": { "type": "Boolean!", "description": "Whether more records exist (Required)" },
|
|
708
|
-
"hasPreviousPage": { "type": "Boolean!", "description": "Whether previous records exist (Required)" }
|
|
709
|
-
},
|
|
710
|
-
"notAvailableInFluent": {
|
|
711
|
-
"startCursor": "NOT AVAILABLE - Use edges[0].cursor instead",
|
|
712
|
-
"endCursor": "NOT AVAILABLE - Use edges[edges.length-1].cursor instead"
|
|
713
|
-
},
|
|
714
|
-
"usageNote": "Unlike full Relay spec, Fluent Commerce does NOT return startCursor/endCursor in pageInfo. To get the cursor for the next page, use the cursor from the last edge: edges[edges.length-1].cursor"
|
|
715
|
-
}
|
|
716
|
-
},
|
|
717
|
-
|
|
718
|
-
"scalars": {
|
|
719
|
-
"DateTime": {
|
|
720
|
-
"kind": "SCALAR",
|
|
721
|
-
"description": "ISO8601 date-time string (e.g., '2025-01-14T10:30:00Z')"
|
|
722
|
-
},
|
|
723
|
-
"JSON": {
|
|
724
|
-
"kind": "SCALAR",
|
|
725
|
-
"description": "Arbitrary JSON value"
|
|
726
|
-
}
|
|
727
|
-
},
|
|
728
|
-
|
|
729
|
-
"validationNotes": {
|
|
730
|
-
"batchAPI": {
|
|
731
|
-
"limitation": "The Batch API ONLY supports INVENTORY_POSITION entity type with UPSERT action. For ORDER, PRODUCT, LOCATION, or other entities, use GraphQL mutations directly (e.g., createOrder, updateProduct).",
|
|
732
|
-
"requiredFields": ["retailerId", "action", "entityType", "entities"],
|
|
733
|
-
"example": "See docs/guides/ingestion.md for complete Batch API usage"
|
|
734
|
-
},
|
|
735
|
-
"pagination": {
|
|
736
|
-
"cursorFields": "All connection types provide `edges[].cursor` and `pageInfo.endCursor` for pagination. Use `endCursor` as the `after` parameter for next page.",
|
|
737
|
-
"example": "See docs/guides/auto-pagination/ for auto-pagination implementation"
|
|
738
|
-
},
|
|
739
|
-
"mutations": {
|
|
740
|
-
"createOrder": "Requires all fields marked with '!' in CreateOrderInput. See connectors/versori-sfcc-connector/mappings/sfcc-to-fluent-order-mapping.json for complete example.",
|
|
741
|
-
"upsertInventoryPosition": "Can be used for single position updates. For bulk updates, use Batch API.",
|
|
742
|
-
"validation": "Run 'npx @fluentcommerce/fc-connect-sdk validate-schema --mapping your-mapping.json --schema this-file.json' to validate your mappings"
|
|
743
|
-
}
|
|
744
|
-
},
|
|
745
|
-
|
|
746
|
-
"exampleQueries": {
|
|
747
|
-
"inventoryExtraction": {
|
|
748
|
-
"description": "Extract inventory positions with product and location details",
|
|
749
|
-
"query": "query ExtractInventory($after: String, $first: Int!) {\n inventoryPositions(after: $after, first: $first) {\n pageInfo {\n hasNextPage\n endCursor\n }\n edges {\n cursor\n node {\n id\n ref\n productRef\n locationRef\n qty\n status\n createdOn\n updatedOn\n product {\n ref\n name\n gtin\n catalogue {\n ref\n name\n }\n }\n location {\n ref\n name\n type\n }\n }\n }\n }\n}",
|
|
750
|
-
"variables": {
|
|
751
|
-
"first": 100,
|
|
752
|
-
"after": null
|
|
753
|
-
}
|
|
754
|
-
},
|
|
755
|
-
|
|
756
|
-
"orderDetails": {
|
|
757
|
-
"description": "Get order details with items and fulfilments",
|
|
758
|
-
"query": "query GetOrderDetails($ref: String!) {\n order(ref: $ref) {\n id\n ref\n type\n status\n totalPrice\n totalTaxPrice\n currency\n customer {\n ref\n email\n firstName\n lastName\n }\n items {\n edges {\n node {\n ref\n productRef\n quantity\n price\n totalPrice\n }\n }\n }\n fulfilments {\n edges {\n node {\n ref\n status\n deliveryType\n }\n }\n }\n }\n}",
|
|
759
|
-
"variables": {
|
|
760
|
-
"ref": "ORD-2025-001"
|
|
761
|
-
}
|
|
762
|
-
}
|
|
763
|
-
}
|
|
764
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"title": "Fluent Commerce GraphQL Schema",
|
|
4
|
+
"description": "Representative GraphQL schema for Fluent Commerce API - Generated for fc-connect-sdk documentation validation",
|
|
5
|
+
"version": "2025.1",
|
|
6
|
+
"generatedOn": "2025-01-19",
|
|
7
|
+
"note": "This schema represents common Fluent Commerce API patterns based on SDK connectors and documentation. Always validate against your specific Fluent Commerce environment using: npx @fluentcommerce/fc-connect-sdk introspect-schema --url YOUR_FLUENT_URL",
|
|
8
|
+
|
|
9
|
+
"types": {
|
|
10
|
+
"Query": {
|
|
11
|
+
"kind": "OBJECT",
|
|
12
|
+
"description": "Root query type for retrieving data from Fluent Commerce",
|
|
13
|
+
"fields": {
|
|
14
|
+
"inventoryPositions": {
|
|
15
|
+
"description": "Query inventory positions with pagination",
|
|
16
|
+
"type": "InventoryPositionConnection!",
|
|
17
|
+
"args": {
|
|
18
|
+
"first": { "type": "Int", "description": "Number of records to return" },
|
|
19
|
+
"after": { "type": "String", "description": "Cursor for pagination" },
|
|
20
|
+
"filter": { "type": "JSON", "description": "Filter criteria" },
|
|
21
|
+
"updatedOn": { "type": "DateTimeRange", "description": "Filter by update time range" }
|
|
22
|
+
}
|
|
23
|
+
},
|
|
24
|
+
"products": {
|
|
25
|
+
"description": "Query products with pagination",
|
|
26
|
+
"type": "ProductConnection!",
|
|
27
|
+
"args": {
|
|
28
|
+
"first": { "type": "Int" },
|
|
29
|
+
"after": { "type": "String" },
|
|
30
|
+
"filter": { "type": "JSON" },
|
|
31
|
+
"ref": { "type": "String" }
|
|
32
|
+
}
|
|
33
|
+
},
|
|
34
|
+
"product": {
|
|
35
|
+
"description": "Get single product by ref",
|
|
36
|
+
"type": "Product",
|
|
37
|
+
"args": {
|
|
38
|
+
"ref": { "type": "String!" }
|
|
39
|
+
}
|
|
40
|
+
},
|
|
41
|
+
"orders": {
|
|
42
|
+
"description": "Query orders with pagination",
|
|
43
|
+
"type": "OrderConnection!",
|
|
44
|
+
"args": {
|
|
45
|
+
"first": { "type": "Int" },
|
|
46
|
+
"after": { "type": "String" },
|
|
47
|
+
"filter": { "type": "JSON" },
|
|
48
|
+
"createdOn": { "type": "DateTimeRange" },
|
|
49
|
+
"updatedOn": { "type": "DateTimeRange" }
|
|
50
|
+
}
|
|
51
|
+
},
|
|
52
|
+
"order": {
|
|
53
|
+
"description": "Get single order by ref",
|
|
54
|
+
"type": "Order",
|
|
55
|
+
"args": {
|
|
56
|
+
"ref": { "type": "String!" }
|
|
57
|
+
}
|
|
58
|
+
},
|
|
59
|
+
"locations": {
|
|
60
|
+
"description": "Query locations with pagination",
|
|
61
|
+
"type": "LocationConnection!",
|
|
62
|
+
"args": {
|
|
63
|
+
"first": { "type": "Int" },
|
|
64
|
+
"after": { "type": "String" }
|
|
65
|
+
}
|
|
66
|
+
},
|
|
67
|
+
"customers": {
|
|
68
|
+
"description": "Query customers",
|
|
69
|
+
"type": "CustomerConnection!",
|
|
70
|
+
"args": {
|
|
71
|
+
"email": { "type": "String" },
|
|
72
|
+
"first": { "type": "Int" },
|
|
73
|
+
"after": { "type": "String" }
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
},
|
|
78
|
+
|
|
79
|
+
"Mutation": {
|
|
80
|
+
"kind": "OBJECT",
|
|
81
|
+
"description": "Root mutation type for modifying data in Fluent Commerce",
|
|
82
|
+
"fields": {
|
|
83
|
+
"createOrder": {
|
|
84
|
+
"description": "Create a new order",
|
|
85
|
+
"type": "Order!",
|
|
86
|
+
"args": {
|
|
87
|
+
"input": { "type": "CreateOrderInput!" }
|
|
88
|
+
}
|
|
89
|
+
},
|
|
90
|
+
"updateInventoryPositions": {
|
|
91
|
+
"description": "Update inventory positions (use batch API instead for better performance)",
|
|
92
|
+
"type": "UpdateInventoryPositionsPayload",
|
|
93
|
+
"args": {
|
|
94
|
+
"input": { "type": "[UpdateInventoryPositionInput]!" }
|
|
95
|
+
}
|
|
96
|
+
},
|
|
97
|
+
"upsertInventoryPosition": {
|
|
98
|
+
"description": "Upsert single inventory position",
|
|
99
|
+
"type": "InventoryPosition",
|
|
100
|
+
"args": {
|
|
101
|
+
"input": { "type": "UpsertInventoryPositionInput!" }
|
|
102
|
+
}
|
|
103
|
+
},
|
|
104
|
+
"sendBatch": {
|
|
105
|
+
"description": "Send batch of entities for processing (Batch API - INVENTORY_POSITION only)",
|
|
106
|
+
"type": "Batch!",
|
|
107
|
+
"args": {
|
|
108
|
+
"input": { "type": "BatchInput!" }
|
|
109
|
+
}
|
|
110
|
+
},
|
|
111
|
+
"createJob": {
|
|
112
|
+
"description": "Create a job for batch processing",
|
|
113
|
+
"type": "Job!",
|
|
114
|
+
"args": {
|
|
115
|
+
"input": { "type": "CreateJobInput!" }
|
|
116
|
+
}
|
|
117
|
+
},
|
|
118
|
+
"createCustomer": {
|
|
119
|
+
"description": "Create a customer",
|
|
120
|
+
"type": "Customer!",
|
|
121
|
+
"args": {
|
|
122
|
+
"input": { "type": "CreateCustomerInput!" }
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
}
|
|
126
|
+
},
|
|
127
|
+
|
|
128
|
+
"InventoryPosition": {
|
|
129
|
+
"kind": "OBJECT",
|
|
130
|
+
"description": "Represents an inventory position at a specific location",
|
|
131
|
+
"fields": {
|
|
132
|
+
"id": { "type": "ID!", "description": "Unique identifier" },
|
|
133
|
+
"ref": { "type": "String!", "description": "Reference code" },
|
|
134
|
+
"productRef": { "type": "String!", "description": "Product reference" },
|
|
135
|
+
"locationRef": { "type": "String!", "description": "Location reference" },
|
|
136
|
+
"qty": { "type": "Int!", "description": "Quantity available" },
|
|
137
|
+
"status": { "type": "String", "description": "Position status (e.g., AVAILABLE, RESERVED)" },
|
|
138
|
+
"createdOn": { "type": "DateTime", "description": "Creation timestamp" },
|
|
139
|
+
"updatedOn": { "type": "DateTime", "description": "Last update timestamp" },
|
|
140
|
+
"product": { "type": "Product", "description": "Associated product" },
|
|
141
|
+
"location": { "type": "Location", "description": "Associated location" },
|
|
142
|
+
"quantities": { "type": "QuantityConnection", "description": "Quantity breakdown" }
|
|
143
|
+
}
|
|
144
|
+
},
|
|
145
|
+
|
|
146
|
+
"Product": {
|
|
147
|
+
"kind": "OBJECT",
|
|
148
|
+
"description": "Represents a product in the catalog",
|
|
149
|
+
"fields": {
|
|
150
|
+
"id": { "type": "ID!", "description": "Unique identifier" },
|
|
151
|
+
"ref": { "type": "String!", "description": "Product reference/SKU" },
|
|
152
|
+
"name": { "type": "String", "description": "Product name" },
|
|
153
|
+
"gtin": { "type": "String", "description": "Global Trade Item Number" },
|
|
154
|
+
"description": { "type": "String", "description": "Product description" },
|
|
155
|
+
"catalogue": { "type": "Catalogue", "description": "Product catalogue" },
|
|
156
|
+
"categories": { "type": "CategoryConnection", "description": "Product categories" },
|
|
157
|
+
"attributes": { "type": "[Attribute]", "description": "Product attributes" },
|
|
158
|
+
"inventoryPositions": { "type": "InventoryPositionConnection", "description": "Inventory positions" },
|
|
159
|
+
"createdOn": { "type": "DateTime" },
|
|
160
|
+
"updatedOn": { "type": "DateTime" }
|
|
161
|
+
}
|
|
162
|
+
},
|
|
163
|
+
|
|
164
|
+
"Order": {
|
|
165
|
+
"kind": "OBJECT",
|
|
166
|
+
"description": "Represents a customer order",
|
|
167
|
+
"fields": {
|
|
168
|
+
"id": { "type": "ID!", "description": "Unique identifier" },
|
|
169
|
+
"ref": { "type": "String!", "description": "Order reference number" },
|
|
170
|
+
"type": { "type": "OrderType!", "description": "Order type (e.g., STANDARD, CC)" },
|
|
171
|
+
"status": { "type": "String", "description": "Order status" },
|
|
172
|
+
"totalPrice": { "type": "Float!", "description": "Total price" },
|
|
173
|
+
"totalTaxPrice": { "type": "Float", "description": "Total tax amount" },
|
|
174
|
+
"currency": { "type": "String!", "description": "Currency code (e.g., USD)" },
|
|
175
|
+
"customer": { "type": "Customer", "description": "Customer information" },
|
|
176
|
+
"billingAddress": { "type": "Address", "description": "Billing address" },
|
|
177
|
+
"items": { "type": "OrderItemConnection!", "description": "Order items" },
|
|
178
|
+
"fulfilments": { "type": "FulfilmentConnection", "description": "Order fulfilments" },
|
|
179
|
+
"financialTransactions": { "type": "[FinancialTransaction]", "description": "Payment transactions" },
|
|
180
|
+
"attributes": { "type": "[Attribute]", "description": "Custom attributes" },
|
|
181
|
+
"createdOn": { "type": "DateTime!", "description": "Creation timestamp" },
|
|
182
|
+
"updatedOn": { "type": "DateTime", "description": "Last update timestamp" },
|
|
183
|
+
"retailer": { "type": "Retailer!", "description": "Retailer" }
|
|
184
|
+
}
|
|
185
|
+
},
|
|
186
|
+
|
|
187
|
+
"OrderItem": {
|
|
188
|
+
"kind": "OBJECT",
|
|
189
|
+
"description": "Represents an item in an order",
|
|
190
|
+
"fields": {
|
|
191
|
+
"ref": { "type": "String!", "description": "Item reference" },
|
|
192
|
+
"productRef": { "type": "String!", "description": "Product reference/SKU" },
|
|
193
|
+
"productCatalogueRef": { "type": "String", "description": "Product catalogue reference" },
|
|
194
|
+
"quantity": { "type": "Int!", "description": "Quantity ordered" },
|
|
195
|
+
"price": { "type": "Float!", "description": "Unit price" },
|
|
196
|
+
"paidPrice": { "type": "Float", "description": "Price after discounts" },
|
|
197
|
+
"totalPrice": { "type": "Float!", "description": "Total price for this item" },
|
|
198
|
+
"taxPrice": { "type": "Float", "description": "Tax amount" },
|
|
199
|
+
"totalTaxPrice": { "type": "Float", "description": "Total tax" },
|
|
200
|
+
"currency": { "type": "String!", "description": "Currency code" },
|
|
201
|
+
"fulfilmentChoiceRef": { "type": "String", "description": "Fulfilment choice reference" },
|
|
202
|
+
"attributes": { "type": "[Attribute]", "description": "Item attributes" }
|
|
203
|
+
}
|
|
204
|
+
},
|
|
205
|
+
|
|
206
|
+
"Customer": {
|
|
207
|
+
"kind": "OBJECT",
|
|
208
|
+
"description": "Represents a customer",
|
|
209
|
+
"fields": {
|
|
210
|
+
"id": { "type": "ID!", "description": "Unique identifier" },
|
|
211
|
+
"ref": { "type": "String!", "description": "Customer reference" },
|
|
212
|
+
"email": { "type": "String", "description": "Email address" },
|
|
213
|
+
"firstName": { "type": "String", "description": "First name" },
|
|
214
|
+
"lastName": { "type": "String", "description": "Last name" },
|
|
215
|
+
"phone": { "type": "String", "description": "Phone number" },
|
|
216
|
+
"addresses": { "type": "[Address]", "description": "Customer addresses" }
|
|
217
|
+
}
|
|
218
|
+
},
|
|
219
|
+
|
|
220
|
+
"Location": {
|
|
221
|
+
"kind": "OBJECT",
|
|
222
|
+
"description": "Represents a physical location (warehouse, store, etc.)",
|
|
223
|
+
"fields": {
|
|
224
|
+
"id": { "type": "ID!", "description": "Unique identifier" },
|
|
225
|
+
"ref": { "type": "String!", "description": "Location reference code" },
|
|
226
|
+
"name": { "type": "String!", "description": "Location name" },
|
|
227
|
+
"type": { "type": "String", "description": "Location type (WAREHOUSE, STORE, etc.)" },
|
|
228
|
+
"address": { "type": "Address", "description": "Location address" },
|
|
229
|
+
"attributes": { "type": "[Attribute]", "description": "Location attributes" }
|
|
230
|
+
}
|
|
231
|
+
},
|
|
232
|
+
|
|
233
|
+
"Catalogue": {
|
|
234
|
+
"kind": "OBJECT",
|
|
235
|
+
"description": "Represents a product catalogue",
|
|
236
|
+
"fields": {
|
|
237
|
+
"ref": { "type": "String!", "description": "Catalogue reference" },
|
|
238
|
+
"name": { "type": "String", "description": "Catalogue name" }
|
|
239
|
+
}
|
|
240
|
+
},
|
|
241
|
+
|
|
242
|
+
"Address": {
|
|
243
|
+
"kind": "OBJECT",
|
|
244
|
+
"description": "Represents a physical address",
|
|
245
|
+
"fields": {
|
|
246
|
+
"street": { "type": "String", "description": "Street address" },
|
|
247
|
+
"street2": { "type": "String", "description": "Additional address line" },
|
|
248
|
+
"city": { "type": "String", "description": "City" },
|
|
249
|
+
"state": { "type": "String", "description": "State/province code" },
|
|
250
|
+
"postcode": { "type": "String", "description": "Postal/ZIP code" },
|
|
251
|
+
"country": { "type": "String", "description": "Country code" },
|
|
252
|
+
"phone": { "type": "String", "description": "Contact phone" }
|
|
253
|
+
}
|
|
254
|
+
},
|
|
255
|
+
|
|
256
|
+
"Attribute": {
|
|
257
|
+
"kind": "OBJECT",
|
|
258
|
+
"description": "Custom attribute key-value pair",
|
|
259
|
+
"fields": {
|
|
260
|
+
"name": { "type": "String!", "description": "Attribute name" },
|
|
261
|
+
"value": { "type": "String!", "description": "Attribute value" },
|
|
262
|
+
"type": { "type": "String", "description": "Attribute type" }
|
|
263
|
+
}
|
|
264
|
+
},
|
|
265
|
+
|
|
266
|
+
"Fulfilment": {
|
|
267
|
+
"kind": "OBJECT",
|
|
268
|
+
"description": "Represents an order fulfilment",
|
|
269
|
+
"fields": {
|
|
270
|
+
"id": { "type": "ID!" },
|
|
271
|
+
"ref": { "type": "String!" },
|
|
272
|
+
"status": { "type": "String" },
|
|
273
|
+
"type": { "type": "String" },
|
|
274
|
+
"deliveryType": { "type": "String" },
|
|
275
|
+
"items": { "type": "FulfilmentItemConnection" }
|
|
276
|
+
}
|
|
277
|
+
},
|
|
278
|
+
|
|
279
|
+
"FinancialTransaction": {
|
|
280
|
+
"kind": "OBJECT",
|
|
281
|
+
"description": "Represents a financial transaction/payment",
|
|
282
|
+
"fields": {
|
|
283
|
+
"ref": { "type": "String!", "description": "Transaction reference" },
|
|
284
|
+
"type": { "type": "String!", "description": "Transaction type (AUTHORIZATION, CAPTURE, etc.)" },
|
|
285
|
+
"amount": { "type": "Float!", "description": "Transaction amount" },
|
|
286
|
+
"currency": { "type": "String!", "description": "Currency code" },
|
|
287
|
+
"cardType": { "type": "String", "description": "Card type (Visa, MasterCard, etc.)" },
|
|
288
|
+
"paymentMethod": { "type": "String!", "description": "Payment method" },
|
|
289
|
+
"externalTransactionCode": { "type": "String", "description": "External auth code" },
|
|
290
|
+
"externalTransactionId": { "type": "String", "description": "External transaction ID" },
|
|
291
|
+
"attributes": { "type": "[Attribute]", "description": "Transaction attributes" }
|
|
292
|
+
}
|
|
293
|
+
},
|
|
294
|
+
|
|
295
|
+
"Retailer": {
|
|
296
|
+
"kind": "OBJECT",
|
|
297
|
+
"description": "Represents a retailer",
|
|
298
|
+
"fields": {
|
|
299
|
+
"id": { "type": "ID!", "description": "Retailer ID" },
|
|
300
|
+
"ref": { "type": "String", "description": "Retailer reference" }
|
|
301
|
+
}
|
|
302
|
+
},
|
|
303
|
+
|
|
304
|
+
"Job": {
|
|
305
|
+
"kind": "OBJECT",
|
|
306
|
+
"description": "Represents a batch processing job",
|
|
307
|
+
"fields": {
|
|
308
|
+
"id": { "type": "ID!", "description": "Job ID" },
|
|
309
|
+
"name": { "type": "String", "description": "Job name" },
|
|
310
|
+
"status": { "type": "JobStatus", "description": "Job status" },
|
|
311
|
+
"progress": { "type": "Float", "description": "Progress percentage" }
|
|
312
|
+
}
|
|
313
|
+
},
|
|
314
|
+
|
|
315
|
+
"Batch": {
|
|
316
|
+
"kind": "OBJECT",
|
|
317
|
+
"description": "Represents a batch submission",
|
|
318
|
+
"fields": {
|
|
319
|
+
"id": { "type": "ID!", "description": "Batch ID" },
|
|
320
|
+
"status": { "type": "BatchStatus", "description": "Batch status" }
|
|
321
|
+
}
|
|
322
|
+
}
|
|
323
|
+
},
|
|
324
|
+
|
|
325
|
+
"inputs": {
|
|
326
|
+
"CreateOrderInput": {
|
|
327
|
+
"kind": "INPUT_OBJECT",
|
|
328
|
+
"description": "Input for creating an order",
|
|
329
|
+
"fields": {
|
|
330
|
+
"ref": { "type": "String!", "description": "Order reference (Required)" },
|
|
331
|
+
"type": { "type": "OrderType!", "description": "Order type (Required)" },
|
|
332
|
+
"retailer": { "type": "RetailerInput!", "description": "Retailer information (Required)" },
|
|
333
|
+
"totalPrice": { "type": "Float!", "description": "Total price (Required)" },
|
|
334
|
+
"totalTaxPrice": { "type": "Float", "description": "Total tax amount" },
|
|
335
|
+
"currency": { "type": "String!", "description": "Currency code (Required)" },
|
|
336
|
+
"customer": { "type": "CustomerInput!", "description": "Customer information (Required)" },
|
|
337
|
+
"billingAddress": { "type": "AddressInput", "description": "Billing address" },
|
|
338
|
+
"items": { "type": "[OrderItemInput]!", "description": "Order items (Required)" },
|
|
339
|
+
"fulfilmentChoices": { "type": "[FulfilmentChoiceInput]", "description": "Fulfilment choices" },
|
|
340
|
+
"financialTransactions": { "type": "[FinancialTransactionInput]", "description": "Payment transactions" },
|
|
341
|
+
"attributes": { "type": "[AttributeInput]", "description": "Custom attributes" }
|
|
342
|
+
}
|
|
343
|
+
},
|
|
344
|
+
|
|
345
|
+
"OrderItemInput": {
|
|
346
|
+
"kind": "INPUT_OBJECT",
|
|
347
|
+
"description": "Input for order item",
|
|
348
|
+
"fields": {
|
|
349
|
+
"ref": { "type": "String!", "description": "Item reference (Required)" },
|
|
350
|
+
"productRef": { "type": "String!", "description": "Product reference (Required)" },
|
|
351
|
+
"productCatalogueRef": { "type": "String", "description": "Product catalogue reference" },
|
|
352
|
+
"quantity": { "type": "Int!", "description": "Quantity (Required)" },
|
|
353
|
+
"price": { "type": "Float!", "description": "Unit price (Required)" },
|
|
354
|
+
"paidPrice": { "type": "Float", "description": "Price after discounts" },
|
|
355
|
+
"totalPrice": { "type": "Float!", "description": "Total price (Required)" },
|
|
356
|
+
"taxPrice": { "type": "Float", "description": "Tax amount" },
|
|
357
|
+
"totalTaxPrice": { "type": "Float", "description": "Total tax" },
|
|
358
|
+
"currency": { "type": "String!", "description": "Currency code (Required)" },
|
|
359
|
+
"fulfilmentChoiceRef": { "type": "String", "description": "Fulfilment choice reference" },
|
|
360
|
+
"attributes": { "type": "[AttributeInput]", "description": "Item attributes" }
|
|
361
|
+
}
|
|
362
|
+
},
|
|
363
|
+
|
|
364
|
+
"CustomerInput": {
|
|
365
|
+
"kind": "INPUT_OBJECT",
|
|
366
|
+
"description": "Input for customer",
|
|
367
|
+
"fields": {
|
|
368
|
+
"id": { "type": "ID", "description": "Customer ID (for existing customer)" },
|
|
369
|
+
"ref": { "type": "String", "description": "Customer reference" },
|
|
370
|
+
"email": { "type": "String", "description": "Email address" },
|
|
371
|
+
"firstName": { "type": "String", "description": "First name" },
|
|
372
|
+
"lastName": { "type": "String", "description": "Last name" }
|
|
373
|
+
}
|
|
374
|
+
},
|
|
375
|
+
|
|
376
|
+
"RetailerInput": {
|
|
377
|
+
"kind": "INPUT_OBJECT",
|
|
378
|
+
"description": "Input for retailer",
|
|
379
|
+
"fields": {
|
|
380
|
+
"id": { "type": "ID!", "description": "Retailer ID (Required)" }
|
|
381
|
+
}
|
|
382
|
+
},
|
|
383
|
+
|
|
384
|
+
"AddressInput": {
|
|
385
|
+
"kind": "INPUT_OBJECT",
|
|
386
|
+
"description": "Input for address",
|
|
387
|
+
"fields": {
|
|
388
|
+
"street": { "type": "String" },
|
|
389
|
+
"street2": { "type": "String" },
|
|
390
|
+
"city": { "type": "String" },
|
|
391
|
+
"state": { "type": "String" },
|
|
392
|
+
"postcode": { "type": "String" },
|
|
393
|
+
"country": { "type": "String" },
|
|
394
|
+
"phone": { "type": "String" }
|
|
395
|
+
}
|
|
396
|
+
},
|
|
397
|
+
|
|
398
|
+
"FulfilmentChoiceInput": {
|
|
399
|
+
"kind": "INPUT_OBJECT",
|
|
400
|
+
"description": "Input for fulfilment choice",
|
|
401
|
+
"fields": {
|
|
402
|
+
"ref": { "type": "String!", "description": "Fulfilment choice reference" },
|
|
403
|
+
"deliveryType": { "type": "String", "description": "Delivery type" },
|
|
404
|
+
"deliveryAddress": { "type": "AddressInput", "description": "Delivery address" }
|
|
405
|
+
}
|
|
406
|
+
},
|
|
407
|
+
|
|
408
|
+
"FinancialTransactionInput": {
|
|
409
|
+
"kind": "INPUT_OBJECT",
|
|
410
|
+
"description": "Input for financial transaction",
|
|
411
|
+
"fields": {
|
|
412
|
+
"ref": { "type": "String!", "description": "Transaction reference (Required)" },
|
|
413
|
+
"type": { "type": "String!", "description": "Transaction type (Required)" },
|
|
414
|
+
"amount": { "type": "Float!", "description": "Amount (Required)" },
|
|
415
|
+
"currency": { "type": "String!", "description": "Currency (Required)" },
|
|
416
|
+
"cardType": { "type": "String" },
|
|
417
|
+
"paymentMethod": { "type": "String!" },
|
|
418
|
+
"externalTransactionCode": { "type": "String" },
|
|
419
|
+
"externalTransactionId": { "type": "String" },
|
|
420
|
+
"attributes": { "type": "[AttributeInput]" }
|
|
421
|
+
}
|
|
422
|
+
},
|
|
423
|
+
|
|
424
|
+
"AttributeInput": {
|
|
425
|
+
"kind": "INPUT_OBJECT",
|
|
426
|
+
"description": "Input for attribute",
|
|
427
|
+
"fields": {
|
|
428
|
+
"name": { "type": "String!", "description": "Attribute name (Required)" },
|
|
429
|
+
"value": { "type": "String!", "description": "Attribute value (Required)" },
|
|
430
|
+
"type": { "type": "String", "description": "Attribute type" }
|
|
431
|
+
}
|
|
432
|
+
},
|
|
433
|
+
|
|
434
|
+
"UpsertInventoryPositionInput": {
|
|
435
|
+
"kind": "INPUT_OBJECT",
|
|
436
|
+
"description": "Input for upserting inventory position",
|
|
437
|
+
"fields": {
|
|
438
|
+
"ref": { "type": "String!", "description": "Position reference (Required)" },
|
|
439
|
+
"productRef": { "type": "String!", "description": "Product reference (Required)" },
|
|
440
|
+
"locationRef": { "type": "String!", "description": "Location reference (Required)" },
|
|
441
|
+
"qty": { "type": "Int!", "description": "Quantity (Required)" },
|
|
442
|
+
"status": { "type": "String", "description": "Status (e.g., AVAILABLE, RESERVED)" },
|
|
443
|
+
"type": { "type": "String", "description": "Position type" }
|
|
444
|
+
}
|
|
445
|
+
},
|
|
446
|
+
|
|
447
|
+
"UpdateInventoryPositionInput": {
|
|
448
|
+
"kind": "INPUT_OBJECT",
|
|
449
|
+
"description": "Input for updating inventory position (use batch API for better performance)",
|
|
450
|
+
"fields": {
|
|
451
|
+
"ref": { "type": "String!", "description": "Position reference" },
|
|
452
|
+
"productRef": { "type": "String", "description": "Product reference" },
|
|
453
|
+
"locationRef": { "type": "String", "description": "Location reference" },
|
|
454
|
+
"qty": { "type": "Int", "description": "Quantity adjustment" },
|
|
455
|
+
"status": { "type": "String", "description": "Status" }
|
|
456
|
+
}
|
|
457
|
+
},
|
|
458
|
+
|
|
459
|
+
"BatchInput": {
|
|
460
|
+
"kind": "INPUT_OBJECT",
|
|
461
|
+
"description": "Input for batch submission (Batch API - INVENTORY_POSITION only)",
|
|
462
|
+
"fields": {
|
|
463
|
+
"action": { "type": "BatchAction!", "description": "Batch action (UPSERT only)" },
|
|
464
|
+
"entityType": { "type": "EntityType!", "description": "Entity type (INVENTORY_POSITION only)" },
|
|
465
|
+
"retailerId": { "type": "ID!", "description": "Retailer ID (Required)" },
|
|
466
|
+
"entities": { "type": "[InventoryPositionInput]!", "description": "Entities to process (Required)" }
|
|
467
|
+
}
|
|
468
|
+
},
|
|
469
|
+
|
|
470
|
+
"InventoryPositionInput": {
|
|
471
|
+
"kind": "INPUT_OBJECT",
|
|
472
|
+
"description": "Input for inventory position in batch",
|
|
473
|
+
"fields": {
|
|
474
|
+
"ref": { "type": "String!", "description": "Position reference (Required)" },
|
|
475
|
+
"productRef": { "type": "String!", "description": "Product reference (Required)" },
|
|
476
|
+
"locationRef": { "type": "String!", "description": "Location reference (Required)" },
|
|
477
|
+
"qty": { "type": "Int!", "description": "Quantity (Required)" },
|
|
478
|
+
"status": { "type": "String", "description": "Status" }
|
|
479
|
+
}
|
|
480
|
+
},
|
|
481
|
+
|
|
482
|
+
"CreateJobInput": {
|
|
483
|
+
"kind": "INPUT_OBJECT",
|
|
484
|
+
"description": "Input for creating a job",
|
|
485
|
+
"fields": {
|
|
486
|
+
"name": { "type": "String!", "description": "Job name (Required)" },
|
|
487
|
+
"retailerId": { "type": "ID!", "description": "Retailer ID (Required)" },
|
|
488
|
+
"metadata": { "type": "JSON", "description": "Job metadata" }
|
|
489
|
+
}
|
|
490
|
+
},
|
|
491
|
+
|
|
492
|
+
"CreateCustomerInput": {
|
|
493
|
+
"kind": "INPUT_OBJECT",
|
|
494
|
+
"description": "Input for creating a customer",
|
|
495
|
+
"fields": {
|
|
496
|
+
"ref": { "type": "String", "description": "Customer reference" },
|
|
497
|
+
"email": { "type": "String", "description": "Email address" },
|
|
498
|
+
"firstName": { "type": "String", "description": "First name" },
|
|
499
|
+
"lastName": { "type": "String", "description": "Last name" }
|
|
500
|
+
}
|
|
501
|
+
},
|
|
502
|
+
|
|
503
|
+
"DateTimeRange": {
|
|
504
|
+
"kind": "INPUT_OBJECT",
|
|
505
|
+
"description": "Date time range filter",
|
|
506
|
+
"fields": {
|
|
507
|
+
"from": { "type": "DateTime", "description": "Start date" },
|
|
508
|
+
"to": { "type": "DateTime", "description": "End date" }
|
|
509
|
+
}
|
|
510
|
+
}
|
|
511
|
+
},
|
|
512
|
+
|
|
513
|
+
"enums": {
|
|
514
|
+
"OrderType": {
|
|
515
|
+
"kind": "ENUM",
|
|
516
|
+
"description": "Order type enumeration",
|
|
517
|
+
"values": ["STANDARD", "HD", "CC", "SALES"]
|
|
518
|
+
},
|
|
519
|
+
|
|
520
|
+
"EntityType": {
|
|
521
|
+
"kind": "ENUM",
|
|
522
|
+
"description": "Entity type for batch operations (Batch API limitation)",
|
|
523
|
+
"values": ["INVENTORY_POSITION"],
|
|
524
|
+
"note": "Batch API ONLY supports INVENTORY_POSITION. For other entities (ORDER, PRODUCT, LOCATION), use GraphQL mutations directly."
|
|
525
|
+
},
|
|
526
|
+
|
|
527
|
+
"BatchAction": {
|
|
528
|
+
"kind": "ENUM",
|
|
529
|
+
"description": "Batch action type",
|
|
530
|
+
"values": ["UPSERT"],
|
|
531
|
+
"note": "Batch API ONLY supports UPSERT action"
|
|
532
|
+
},
|
|
533
|
+
|
|
534
|
+
"JobStatus": {
|
|
535
|
+
"kind": "ENUM",
|
|
536
|
+
"description": "Job status enumeration",
|
|
537
|
+
"values": ["PENDING", "RUNNING", "COMPLETED", "FAILED", "COMPLETED_WITH_ERRORS"]
|
|
538
|
+
},
|
|
539
|
+
|
|
540
|
+
"BatchStatus": {
|
|
541
|
+
"kind": "ENUM",
|
|
542
|
+
"description": "Batch status enumeration",
|
|
543
|
+
"values": ["PENDING", "PROCESSING", "COMPLETED", "FAILED"]
|
|
544
|
+
}
|
|
545
|
+
},
|
|
546
|
+
|
|
547
|
+
"connections": {
|
|
548
|
+
"InventoryPositionConnection": {
|
|
549
|
+
"kind": "OBJECT",
|
|
550
|
+
"description": "Paginated inventory positions",
|
|
551
|
+
"fields": {
|
|
552
|
+
"edges": { "type": "[InventoryPositionEdge]!", "description": "Array of edges" },
|
|
553
|
+
"pageInfo": { "type": "PageInfo!", "description": "Pagination info" }
|
|
554
|
+
}
|
|
555
|
+
},
|
|
556
|
+
|
|
557
|
+
"InventoryPositionEdge": {
|
|
558
|
+
"kind": "OBJECT",
|
|
559
|
+
"description": "Edge for inventory position",
|
|
560
|
+
"fields": {
|
|
561
|
+
"cursor": { "type": "String!", "description": "Cursor for this edge" },
|
|
562
|
+
"node": { "type": "InventoryPosition!", "description": "The inventory position" }
|
|
563
|
+
}
|
|
564
|
+
},
|
|
565
|
+
|
|
566
|
+
"ProductConnection": {
|
|
567
|
+
"kind": "OBJECT",
|
|
568
|
+
"description": "Paginated products",
|
|
569
|
+
"fields": {
|
|
570
|
+
"edges": { "type": "[ProductEdge]!" },
|
|
571
|
+
"pageInfo": { "type": "PageInfo!" }
|
|
572
|
+
}
|
|
573
|
+
},
|
|
574
|
+
|
|
575
|
+
"ProductEdge": {
|
|
576
|
+
"kind": "OBJECT",
|
|
577
|
+
"fields": {
|
|
578
|
+
"cursor": { "type": "String!" },
|
|
579
|
+
"node": { "type": "Product!" }
|
|
580
|
+
}
|
|
581
|
+
},
|
|
582
|
+
|
|
583
|
+
"OrderConnection": {
|
|
584
|
+
"kind": "OBJECT",
|
|
585
|
+
"description": "Paginated orders",
|
|
586
|
+
"fields": {
|
|
587
|
+
"edges": { "type": "[OrderEdge]!" },
|
|
588
|
+
"pageInfo": { "type": "PageInfo!" }
|
|
589
|
+
}
|
|
590
|
+
},
|
|
591
|
+
|
|
592
|
+
"OrderEdge": {
|
|
593
|
+
"kind": "OBJECT",
|
|
594
|
+
"fields": {
|
|
595
|
+
"cursor": { "type": "String!" },
|
|
596
|
+
"node": { "type": "Order!" }
|
|
597
|
+
}
|
|
598
|
+
},
|
|
599
|
+
|
|
600
|
+
"OrderItemConnection": {
|
|
601
|
+
"kind": "OBJECT",
|
|
602
|
+
"description": "Paginated order items",
|
|
603
|
+
"fields": {
|
|
604
|
+
"edges": { "type": "[OrderItemEdge]!" }
|
|
605
|
+
}
|
|
606
|
+
},
|
|
607
|
+
|
|
608
|
+
"OrderItemEdge": {
|
|
609
|
+
"kind": "OBJECT",
|
|
610
|
+
"fields": {
|
|
611
|
+
"node": { "type": "OrderItem!" }
|
|
612
|
+
}
|
|
613
|
+
},
|
|
614
|
+
|
|
615
|
+
"LocationConnection": {
|
|
616
|
+
"kind": "OBJECT",
|
|
617
|
+
"fields": {
|
|
618
|
+
"edges": { "type": "[LocationEdge]!" },
|
|
619
|
+
"pageInfo": { "type": "PageInfo!" }
|
|
620
|
+
}
|
|
621
|
+
},
|
|
622
|
+
|
|
623
|
+
"LocationEdge": {
|
|
624
|
+
"kind": "OBJECT",
|
|
625
|
+
"fields": {
|
|
626
|
+
"cursor": { "type": "String!" },
|
|
627
|
+
"node": { "type": "Location!" }
|
|
628
|
+
}
|
|
629
|
+
},
|
|
630
|
+
|
|
631
|
+
"CustomerConnection": {
|
|
632
|
+
"kind": "OBJECT",
|
|
633
|
+
"fields": {
|
|
634
|
+
"edges": { "type": "[CustomerEdge]!" },
|
|
635
|
+
"pageInfo": { "type": "PageInfo!" }
|
|
636
|
+
}
|
|
637
|
+
},
|
|
638
|
+
|
|
639
|
+
"CustomerEdge": {
|
|
640
|
+
"kind": "OBJECT",
|
|
641
|
+
"fields": {
|
|
642
|
+
"cursor": { "type": "String!" },
|
|
643
|
+
"node": { "type": "Customer!" }
|
|
644
|
+
}
|
|
645
|
+
},
|
|
646
|
+
|
|
647
|
+
"CategoryConnection": {
|
|
648
|
+
"kind": "OBJECT",
|
|
649
|
+
"fields": {
|
|
650
|
+
"edges": { "type": "[CategoryEdge]!" }
|
|
651
|
+
}
|
|
652
|
+
},
|
|
653
|
+
|
|
654
|
+
"CategoryEdge": {
|
|
655
|
+
"kind": "OBJECT",
|
|
656
|
+
"fields": {
|
|
657
|
+
"node": { "type": "Category!" }
|
|
658
|
+
}
|
|
659
|
+
},
|
|
660
|
+
|
|
661
|
+
"FulfilmentConnection": {
|
|
662
|
+
"kind": "OBJECT",
|
|
663
|
+
"fields": {
|
|
664
|
+
"edges": { "type": "[FulfilmentEdge]!" }
|
|
665
|
+
}
|
|
666
|
+
},
|
|
667
|
+
|
|
668
|
+
"FulfilmentEdge": {
|
|
669
|
+
"kind": "OBJECT",
|
|
670
|
+
"fields": {
|
|
671
|
+
"node": { "type": "Fulfilment!" }
|
|
672
|
+
}
|
|
673
|
+
},
|
|
674
|
+
|
|
675
|
+
"FulfilmentItemConnection": {
|
|
676
|
+
"kind": "OBJECT",
|
|
677
|
+
"fields": {
|
|
678
|
+
"edges": { "type": "[FulfilmentItemEdge]!" }
|
|
679
|
+
}
|
|
680
|
+
},
|
|
681
|
+
|
|
682
|
+
"FulfilmentItemEdge": {
|
|
683
|
+
"kind": "OBJECT",
|
|
684
|
+
"fields": {
|
|
685
|
+
"node": { "type": "FulfilmentItem!" }
|
|
686
|
+
}
|
|
687
|
+
},
|
|
688
|
+
|
|
689
|
+
"QuantityConnection": {
|
|
690
|
+
"kind": "OBJECT",
|
|
691
|
+
"fields": {
|
|
692
|
+
"edges": { "type": "[QuantityEdge]!" }
|
|
693
|
+
}
|
|
694
|
+
},
|
|
695
|
+
|
|
696
|
+
"QuantityEdge": {
|
|
697
|
+
"kind": "OBJECT",
|
|
698
|
+
"fields": {
|
|
699
|
+
"node": { "type": "Quantity!" }
|
|
700
|
+
}
|
|
701
|
+
},
|
|
702
|
+
|
|
703
|
+
"PageInfo": {
|
|
704
|
+
"kind": "OBJECT",
|
|
705
|
+
"description": "Pagination information - IMPORTANT: Fluent does NOT return startCursor/endCursor (deviation from Relay spec)",
|
|
706
|
+
"fields": {
|
|
707
|
+
"hasNextPage": { "type": "Boolean!", "description": "Whether more records exist (Required)" },
|
|
708
|
+
"hasPreviousPage": { "type": "Boolean!", "description": "Whether previous records exist (Required)" }
|
|
709
|
+
},
|
|
710
|
+
"notAvailableInFluent": {
|
|
711
|
+
"startCursor": "NOT AVAILABLE - Use edges[0].cursor instead",
|
|
712
|
+
"endCursor": "NOT AVAILABLE - Use edges[edges.length-1].cursor instead"
|
|
713
|
+
},
|
|
714
|
+
"usageNote": "Unlike full Relay spec, Fluent Commerce does NOT return startCursor/endCursor in pageInfo. To get the cursor for the next page, use the cursor from the last edge: edges[edges.length-1].cursor"
|
|
715
|
+
}
|
|
716
|
+
},
|
|
717
|
+
|
|
718
|
+
"scalars": {
|
|
719
|
+
"DateTime": {
|
|
720
|
+
"kind": "SCALAR",
|
|
721
|
+
"description": "ISO8601 date-time string (e.g., '2025-01-14T10:30:00Z')"
|
|
722
|
+
},
|
|
723
|
+
"JSON": {
|
|
724
|
+
"kind": "SCALAR",
|
|
725
|
+
"description": "Arbitrary JSON value"
|
|
726
|
+
}
|
|
727
|
+
},
|
|
728
|
+
|
|
729
|
+
"validationNotes": {
|
|
730
|
+
"batchAPI": {
|
|
731
|
+
"limitation": "The Batch API ONLY supports INVENTORY_POSITION entity type with UPSERT action. For ORDER, PRODUCT, LOCATION, or other entities, use GraphQL mutations directly (e.g., createOrder, updateProduct).",
|
|
732
|
+
"requiredFields": ["retailerId", "action", "entityType", "entities"],
|
|
733
|
+
"example": "See docs/guides/ingestion.md for complete Batch API usage"
|
|
734
|
+
},
|
|
735
|
+
"pagination": {
|
|
736
|
+
"cursorFields": "All connection types provide `edges[].cursor` and `pageInfo.endCursor` for pagination. Use `endCursor` as the `after` parameter for next page.",
|
|
737
|
+
"example": "See docs/guides/auto-pagination/ for auto-pagination implementation"
|
|
738
|
+
},
|
|
739
|
+
"mutations": {
|
|
740
|
+
"createOrder": "Requires all fields marked with '!' in CreateOrderInput. See connectors/versori-sfcc-connector/mappings/sfcc-to-fluent-order-mapping.json for complete example.",
|
|
741
|
+
"upsertInventoryPosition": "Can be used for single position updates. For bulk updates, use Batch API.",
|
|
742
|
+
"validation": "Run 'npx @fluentcommerce/fc-connect-sdk validate-schema --mapping your-mapping.json --schema this-file.json' to validate your mappings"
|
|
743
|
+
}
|
|
744
|
+
},
|
|
745
|
+
|
|
746
|
+
"exampleQueries": {
|
|
747
|
+
"inventoryExtraction": {
|
|
748
|
+
"description": "Extract inventory positions with product and location details",
|
|
749
|
+
"query": "query ExtractInventory($after: String, $first: Int!) {\n inventoryPositions(after: $after, first: $first) {\n pageInfo {\n hasNextPage\n endCursor\n }\n edges {\n cursor\n node {\n id\n ref\n productRef\n locationRef\n qty\n status\n createdOn\n updatedOn\n product {\n ref\n name\n gtin\n catalogue {\n ref\n name\n }\n }\n location {\n ref\n name\n type\n }\n }\n }\n }\n}",
|
|
750
|
+
"variables": {
|
|
751
|
+
"first": 100,
|
|
752
|
+
"after": null
|
|
753
|
+
}
|
|
754
|
+
},
|
|
755
|
+
|
|
756
|
+
"orderDetails": {
|
|
757
|
+
"description": "Get order details with items and fulfilments",
|
|
758
|
+
"query": "query GetOrderDetails($ref: String!) {\n order(ref: $ref) {\n id\n ref\n type\n status\n totalPrice\n totalTaxPrice\n currency\n customer {\n ref\n email\n firstName\n lastName\n }\n items {\n edges {\n node {\n ref\n productRef\n quantity\n price\n totalPrice\n }\n }\n }\n fulfilments {\n edges {\n node {\n ref\n status\n deliveryType\n }\n }\n }\n }\n}",
|
|
759
|
+
"variables": {
|
|
760
|
+
"ref": "ORD-2025-001"
|
|
761
|
+
}
|
|
762
|
+
}
|
|
763
|
+
}
|
|
764
|
+
}
|