diff --git a/packages/app-elements/src/mocks/data/core_resources.ts b/packages/app-elements/src/mocks/data/core_resources.ts index b56260b97..d409d436a 100644 --- a/packages/app-elements/src/mocks/data/core_resources.ts +++ b/packages/app-elements/src/mocks/data/core_resources.ts @@ -10,9 +10,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -369,6 +369,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -451,6 +452,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -458,9 +460,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -601,6 +603,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -636,6 +639,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -643,9 +647,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -786,8 +790,21 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, + _check: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to check the credentials against the payment gateway's APIs.", + required: "optional", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, merchant_account: { type: "string", desc: "The gateway merchant account.", @@ -972,6 +989,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "payment_gateway", }, }, { @@ -979,9 +997,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -1113,6 +1131,18 @@ const corePublicResources = http.get( example: "2018-01-02T12:00:00.000Z", format: "datetime", }, + closed_at: { + type: "string", + desc: "The date/time when the Adyen order was closed, meaning all partial payments have been completed (valid for partial payments only).", + delegate: "order_closed_at", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: "2018-01-02T12:00:00.000Z", + format: "datetime", + }, id: { format: "id", type: "string", @@ -1191,6 +1221,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -1243,11 +1274,14 @@ const corePublicResources = http.get( "ids", "expires_at_from", "expires_at_to", + "closed_at_from", + "closed_at_to", "created_at_from", "created_at_to", "updated_at_from", "updated_at_to", ], + parent_resource: "payment_source", }, }, { @@ -1255,9 +1289,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: true, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["retrieve"], examples: {}, filter_scopes: [], @@ -1433,11 +1467,13 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, relationships: {}, filters: ["id"], + parent_resource: null, }, }, { @@ -1445,9 +1481,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -1553,6 +1589,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -1571,14 +1608,15 @@ const corePublicResources = http.get( parent_resource: "Api::AttachmentResource", class_name: "Attachable", enum: [ - "geocoders", - "price_lists", - "payment_methods", "markets", + "price_lists", "customer_groups", "promotions", + "geocoders", + "payment_methods", "orders", "transactions", + "payment_sessions", "tax_calculators", "tax_categories", "skus", @@ -1592,6 +1630,7 @@ const corePublicResources = http.get( "carrier_accounts", "coupon_recipients", "customers", + "payment_wallets", "delivery_lead_times", "shipping_methods", "shipments", @@ -1605,6 +1644,8 @@ const corePublicResources = http.get( "merchants", "subscription_models", "payment_options", + "payment_transactions", + "payment_links", "packages", "prices", "price_tiers", @@ -1642,6 +1683,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -1649,9 +1691,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08"], actions: ["list", "retrieve", "update"], examples: { updatable: { @@ -1803,6 +1845,18 @@ const corePublicResources = http.get( sortable: false, example: "xxxx-yyyy-zzzz", }, + additional_data: { + type: "object", + desc: "The additional data returned by the payment gateway, if any.", + required: "optional", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + exportable: false, + example: { foo: "bar" }, + }, _forward: { type: "boolean", trigger: true, @@ -1881,6 +1935,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, cvv_code: { @@ -2183,6 +2238,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "transaction", }, }, { @@ -2190,9 +2246,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -2294,6 +2350,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, username: { @@ -2419,6 +2476,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "tax_calculator", }, }, { @@ -2426,9 +2484,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -2569,6 +2627,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, login: { @@ -2662,6 +2721,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "payment_gateway", }, }, { @@ -2669,9 +2729,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -2846,6 +2906,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -2901,6 +2962,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "payment_source", }, }, { @@ -2908,9 +2970,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: true, addon: false, hidden: false, + versions: ["2017-08"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -2994,6 +3056,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -3049,6 +3112,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "order_validation_rule", }, }, { @@ -3056,9 +3120,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -3153,6 +3217,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, key: { @@ -3220,6 +3285,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "geocoder", }, }, { @@ -3227,9 +3293,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -3370,8 +3436,21 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, + _check: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to check the credentials against the payment gateway's APIs.", + required: "optional", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, merchant_account_id: { type: "string", desc: "The gateway merchant account ID.", @@ -3519,6 +3598,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "payment_gateway", }, }, { @@ -3526,9 +3606,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -3666,6 +3746,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -3721,6 +3802,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "payment_source", }, }, { @@ -3728,9 +3810,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -3999,6 +4081,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -4101,6 +4184,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -4108,9 +4192,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [ @@ -4410,6 +4494,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, x: { @@ -4473,7 +4558,7 @@ const corePublicResources = http.get( order_amount_promotion_rule: { type: "has_one", desc: "The associated order amount promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -4483,7 +4568,7 @@ const corePublicResources = http.get( sku_list_promotion_rule: { type: "has_one", desc: "The associated SKU list promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -4493,7 +4578,7 @@ const corePublicResources = http.get( coupon_codes_promotion_rule: { type: "has_one", desc: "The associated coupon codes promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -4503,7 +4588,7 @@ const corePublicResources = http.get( custom_promotion_rule: { type: "has_one", desc: "The associated custom promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -4625,6 +4710,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "promotion", }, }, { @@ -4632,9 +4718,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08"], actions: ["list", "retrieve", "update"], examples: { updatable: { @@ -4786,6 +4872,18 @@ const corePublicResources = http.get( sortable: false, example: "xxxx-yyyy-zzzz", }, + additional_data: { + type: "object", + desc: "The additional data returned by the payment gateway, if any.", + required: "optional", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + exportable: false, + example: { foo: "bar" }, + }, _forward: { type: "boolean", trigger: true, @@ -4864,6 +4962,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, _refund: { @@ -5092,6 +5191,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "transaction", }, }, { @@ -5099,9 +5199,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -5217,6 +5317,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -5272,6 +5373,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -5279,9 +5381,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -5422,8 +5524,21 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, + _check: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to check the credentials against the payment gateway's APIs.", + required: "optional", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, secret_key: { type: "string", desc: "The gateway secret key.", @@ -5480,6 +5595,30 @@ const corePublicResources = http.get( example: "https://core.commercelayer.co/webhook_callbacks/checkout_com_gateways/xxxxx", }, + _update_webhooks: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to sync the gateway webhook endpoint subscribed event topics.", + required: "optional", + creatable: false, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + _refresh_webhook_secrets: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to refresh the gateway webhook endpoint secret.", + required: "optional", + creatable: false, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, }, relationships: { payment_methods: { @@ -5536,6 +5675,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "payment_gateway", }, }, { @@ -5543,9 +5683,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -5679,8 +5819,8 @@ const corePublicResources = http.get( fetchable: false, filterable: false, sortable: false, - deprecated: true, example: "true", + versions: ["2017-08"], }, _details: { type: "boolean", @@ -5782,6 +5922,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -5837,6 +5978,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "payment_source", }, }, { @@ -5844,16 +5986,16 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], fields: { resource_type: { type: "string", - desc: "The type of resource being cleaned.", + desc: "The type of resource being cleaned. One of 'promotions', 'skus', 'bundles', 'sku_lists', 'stock_items', 'coupons', 'gift_cards', 'sku_options', or 'prices'.", required: "required", creatable: true, updatable: false, @@ -5861,6 +6003,17 @@ const corePublicResources = http.get( filterable: true, sortable: true, example: "skus", + enum: [ + "promotions", + "skus", + "bundles", + "sku_lists", + "stock_items", + "coupons", + "gift_cards", + "sku_options", + "prices", + ], }, status: { type: "string", @@ -5957,6 +6110,17 @@ const corePublicResources = http.get( sortable: false, example: { ABC: { name: ["has already been taken"] } }, }, + dry_run: { + type: "boolean", + default: false, + desc: "When true, evaluates filters and populates records_count without performing any deletion.", + creatable: true, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: "false", + }, id: { format: "id", type: "string", @@ -6035,6 +6199,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -6091,6 +6256,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -6098,9 +6264,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -6258,6 +6424,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -6343,6 +6510,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -6350,9 +6518,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -6441,6 +6609,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -6509,6 +6678,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "promotion_rule", }, }, { @@ -6516,9 +6686,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -6623,6 +6793,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -6679,6 +6850,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "email_recipient", }, }, { @@ -6686,9 +6858,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: { creatable: { fields: ["filters"] }, @@ -6780,6 +6952,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, filters: { @@ -6851,6 +7024,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "promotion_rule", }, }, { @@ -6858,9 +7032,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -7053,6 +7227,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, _request_anonymization: { @@ -7214,6 +7389,7 @@ const corePublicResources = http.get( sortable: false, parent_resource: "Api::CustomerResource", class_name: "CustomerPaymentSource", + versions: ["2017-08"], }, customer_subscriptions: { type: "has_many", @@ -7236,6 +7412,7 @@ const corePublicResources = http.get( sortable: false, parent_resource: "Api::CustomerResource", class_name: "OrderSubscription", + versions: ["2017-08", "2026-05"], }, returns: { type: "has_many", @@ -7244,6 +7421,7 @@ const corePublicResources = http.get( sortable: false, parent_resource: "Api::CustomerResource", class_name: "Return", + versions: ["2017-08"], }, sku_lists: { type: "has_many", @@ -7253,6 +7431,24 @@ const corePublicResources = http.get( parent_resource: "Api::CustomerResource", class_name: "SkuList", }, + payment_sessions: { + type: "has_many", + desc: "The associated payment sessions.", + filterable: true, + sortable: false, + parent_resource: "Api::CustomerResource", + class_name: "PaymentSession", + versions: ["2026-05"], + }, + payment_wallets: { + type: "has_many", + desc: "The customer's payment wallets.", + filterable: true, + sortable: false, + parent_resource: "Api::CustomerResource", + class_name: "PaymentWallet", + versions: ["2026-05"], + }, attachments: { type: "has_many", desc: "The associated attachments.", @@ -7341,6 +7537,8 @@ const corePublicResources = http.get( "order_subscriptions_id", "returns_id", "sku_lists_id", + "payment_sessions_id", + "payment_wallets_id", "attachments_id", "events_id", "tags_id", @@ -7350,6 +7548,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -7357,9 +7556,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -7453,6 +7652,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -7519,6 +7719,7 @@ const corePublicResources = http.get( "updated_at_to", "country_code", ], + parent_resource: null, }, }, { @@ -7526,9 +7727,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -7622,6 +7823,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -7677,6 +7879,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -7684,9 +7887,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: { updatable: { @@ -7817,6 +8020,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -7873,6 +8077,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -7880,9 +8085,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -7984,6 +8189,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -8068,6 +8274,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -8075,9 +8282,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -8160,6 +8367,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -8213,6 +8421,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -8220,9 +8429,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -8336,6 +8545,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -8405,6 +8615,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -8412,9 +8623,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: true, hidden: true, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve"], examples: {}, filter_scopes: [], @@ -8454,152 +8665,17 @@ const corePublicResources = http.get( sortable: false, example: true, }, - id: { - format: "id", - type: "string", - desc: "Unique identifier for the resource (hash).", - required: "required", - creatable: false, - updatable: false, - fetchable: true, - filterable: true, - sortable: true, - example: "XAyRWNUzyN", - }, - created_at: { - type: "string", - desc: "Time at which the resource was created.", - required: "required", - creatable: false, - updatable: false, - fetchable: true, - filterable: true, - sortable: true, - example: "2018-01-01T12:00:00.000Z", - format: "datetime", - }, - updated_at: { - type: "string", - desc: "Time at which the resource was last updated.", - required: "required", - creatable: false, - updatable: false, - fetchable: true, - filterable: true, - sortable: true, - example: "2018-01-01T12:00:00.000Z", - format: "datetime", - }, - reference: { - type: "string", - desc: "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", - required: "optional", - creatable: true, - updatable: true, - fetchable: true, - filterable: true, - sortable: true, - example: "ANY-EXTERNAL-REFEFERNCE", - }, - reference_origin: { - type: "string", - desc: "Any identifier of the third party system that defines the reference code.", - required: "optional", - creatable: true, - updatable: true, - fetchable: true, - filterable: true, - sortable: true, - example: "ANY-EXTERNAL-REFEFERNCE-ORIGIN", - }, - metadata: { + options: { type: "object", - desc: "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", - required: "optional", + desc: "A hash of additional options passed through to the discount engine's API requests (e.g. Talon.One's `storeIntegrationId`).", + required: "optional, default is '{}'", + default: {}, creatable: true, updatable: true, fetchable: true, - filterable: true, - sortable: false, - example: { foo: "bar" }, - }, - }, - relationships: { - markets: { - type: "has_many", - desc: "The associated markets.", - parent_resource: "Api::TalonOneAccountResource", - class_name: "Market", - }, - discount_engine_items: { - type: "has_many", - desc: "The associated discount engine items.", - parent_resource: "Api::TalonOneAccountResource", - class_name: "DiscountEngineItem", - }, - attachments: { - type: "has_many", - desc: "The associated attachments.", - filterable: true, - sortable: false, - parent_resource: "Api::DiscountEngineResource", - class_name: "Attachment", - }, - event_stores: { - type: "has_many", - desc: "The associated event stores.", - class_name: "EventStore", - creatable: false, - updatable: false, filterable: false, sortable: false, - virtual: true, - exportable: false, - includable: false, - parent_resource: "Api::DiscountEngineResource", - }, - }, - filters: [ - "id", - "name", - "type", - "created_at", - "updated_at", - "reference", - "reference_origin", - "metadata", - "q", - "attachments_id", - "ids", - "created_at_from", - "created_at_to", - "updated_at_from", - "updated_at_to", - ], - }, - }, - { - id: "discount_engine_item", - type: "resources", - attributes: { - singleton: false, - deprecated: false, - addon: false, - hidden: true, - actions: ["list", "retrieve"], - examples: {}, - filter_scopes: [], - fields: { - body: { - type: "object", - desc: "The body of the external discount engine response.", - required: "required", - creatable: false, - updatable: false, - fetchable: true, - filterable: true, - sortable: false, - example: { foo: "bar" }, + example: { storeIntegrationId: "STORE-001" }, }, id: { format: "id", @@ -8668,6 +8744,156 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, + example: { foo: "bar" }, + }, + }, + relationships: { + markets: { + type: "has_many", + desc: "The associated markets.", + parent_resource: "Api::TalonOneAccountResource", + class_name: "Market", + }, + discount_engine_items: { + type: "has_many", + desc: "The associated discount engine items.", + parent_resource: "Api::TalonOneAccountResource", + class_name: "DiscountEngineItem", + }, + attachments: { + type: "has_many", + desc: "The associated attachments.", + filterable: true, + sortable: false, + parent_resource: "Api::DiscountEngineResource", + class_name: "Attachment", + }, + event_stores: { + type: "has_many", + desc: "The associated event stores.", + class_name: "EventStore", + creatable: false, + updatable: false, + filterable: false, + sortable: false, + virtual: true, + exportable: false, + includable: false, + parent_resource: "Api::DiscountEngineResource", + }, + }, + filters: [ + "id", + "name", + "type", + "created_at", + "updated_at", + "reference", + "reference_origin", + "metadata", + "q", + "attachments_id", + "ids", + "created_at_from", + "created_at_to", + "updated_at_from", + "updated_at_to", + ], + parent_resource: null, + }, + }, + { + id: "discount_engine_item", + type: "resources", + attributes: { + singleton: false, + addon: false, + hidden: true, + versions: ["2017-08", "2026-05"], + actions: ["list", "retrieve"], + examples: {}, + filter_scopes: [], + fields: { + body: { + type: "object", + desc: "The body of the external discount engine response.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: { foo: "bar" }, + }, + id: { + format: "id", + type: "string", + desc: "Unique identifier for the resource (hash).", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "XAyRWNUzyN", + }, + created_at: { + type: "string", + desc: "Time at which the resource was created.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + updated_at: { + type: "string", + desc: "Time at which the resource was last updated.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + reference: { + type: "string", + desc: "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE", + }, + reference_origin: { + type: "string", + desc: "Any identifier of the third party system that defines the reference code.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE-ORIGIN", + }, + metadata: { + type: "object", + desc: "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -8725,6 +8951,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -8732,9 +8959,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -8840,6 +9067,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, selected_rate_id: { @@ -9013,6 +9241,7 @@ const corePublicResources = http.get( "purchase_completed_at_from", "purchase_completed_at_to", ], + parent_resource: "pickup", }, }, { @@ -9020,9 +9249,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "update"], examples: {}, filter_scopes: [], @@ -9117,6 +9346,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -9166,6 +9396,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -9173,9 +9404,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve"], examples: {}, filter_scopes: [], @@ -9301,6 +9532,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -9348,6 +9580,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -9355,9 +9588,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["retrieve"], examples: {}, filter_scopes: [], @@ -9376,7 +9609,7 @@ const corePublicResources = http.get( }, resource_type: { type: "string", - desc: "The type of the affected resource.", + desc: "The type of the affected resource. One of 'applications', 'event_stores', 'business_rules', 'markets', 'price_lists', 'customer_groups', 'line_items', 'discount_engine_items', 'promotions', 'addresses', 'geocoders', 'events', 'tags', 'adjustments', 'payment_gateways', 'payment_methods', 'adyen_payments', 'orders', 'transactions', 'payment_sessions', 'payment_settings', 'order_factories', 'attachments', 'tax_calculators', 'tax_categories', 'skus', 'shipping_categories', 'axerve_payments', 'order_validation_rules', 'braintree_payments', 'bundles', 'sku_lists', 'sku_list_items', 'stock_items', 'stock_locations', 'promotion_rules', 'coupons', 'returns', 'carrier_accounts', 'checkout_com_payments', 'customers', 'customer_addresses', 'customer_payment_sources', 'customer_subscriptions', 'order_subscriptions', 'payment_wallets', 'customer_password_resets', 'delivery_lead_times', 'shipping_methods', 'shipments', 'discount_engines', 'pickups', 'parcels', 'webhooks', 'event_callbacks', 'external_payments', 'gift_cards', 'in_stock_subscriptions', 'inventory_models', 'inventory_stock_locations', 'inventory_return_locations', 'klarna_payments', 'line_item_options', 'return_line_items', 'stock_line_items', 'stock_reservations', 'stock_transfers', 'notifications', 'sku_options', 'links', 'tax_rules', 'merchants', 'subscription_models', 'stores', 'price_list_schedulers', 'order_subscription_items', 'resource_errors', 'payment_options', 'payment_transactions', 'payment_links', 'paypal_payments', 'packages', 'parcel_line_items', 'prices', 'price_tiers', 'reserved_stocks', 'satispay_payments', 'shipping_method_tiers', 'shipping_zones', 'stripe_payments', or 'wire_transfers'.", creatable: false, updatable: false, fetchable: true, @@ -9384,6 +9617,99 @@ const corePublicResources = http.get( filter_operators: ["eq", "in"], sortable: false, example: "orders", + enum: [ + "applications", + "event_stores", + "business_rules", + "markets", + "price_lists", + "customer_groups", + "line_items", + "discount_engine_items", + "promotions", + "addresses", + "geocoders", + "events", + "tags", + "adjustments", + "payment_gateways", + "payment_methods", + "adyen_payments", + "orders", + "transactions", + "payment_sessions", + "payment_settings", + "order_factories", + "attachments", + "tax_calculators", + "tax_categories", + "skus", + "shipping_categories", + "axerve_payments", + "order_validation_rules", + "braintree_payments", + "bundles", + "sku_lists", + "sku_list_items", + "stock_items", + "stock_locations", + "promotion_rules", + "coupons", + "returns", + "carrier_accounts", + "checkout_com_payments", + "customers", + "customer_addresses", + "customer_payment_sources", + "customer_subscriptions", + "order_subscriptions", + "payment_wallets", + "customer_password_resets", + "delivery_lead_times", + "shipping_methods", + "shipments", + "discount_engines", + "pickups", + "parcels", + "webhooks", + "event_callbacks", + "external_payments", + "gift_cards", + "in_stock_subscriptions", + "inventory_models", + "inventory_stock_locations", + "inventory_return_locations", + "klarna_payments", + "line_item_options", + "return_line_items", + "stock_line_items", + "stock_reservations", + "stock_transfers", + "notifications", + "sku_options", + "links", + "tax_rules", + "merchants", + "subscription_models", + "stores", + "price_list_schedulers", + "order_subscription_items", + "resource_errors", + "payment_options", + "payment_transactions", + "payment_links", + "paypal_payments", + "packages", + "parcel_line_items", + "prices", + "price_tiers", + "reserved_stocks", + "satispay_payments", + "shipping_method_tiers", + "shipping_zones", + "stripe_payments", + "wire_transfers", + ], }, resource_id: { type: "string", @@ -9397,13 +9723,23 @@ const corePublicResources = http.get( }, event: { type: "string", - desc: "The type of change (one of create or update).", + desc: "The type of change. One of 'create', 'update', 'destroy', 'anonymization_request', 'anonymization_started', 'anonymization_completed', 'anonymization_failed', or 'anonymization_cancel'.", creatable: false, updatable: false, fetchable: true, filterable: false, sortable: false, example: "update", + enum: [ + "create", + "update", + "destroy", + "anonymization_request", + "anonymization_started", + "anonymization_completed", + "anonymization_failed", + "anonymization_cancel", + ], }, ip_address: { type: "string", @@ -9511,11 +9847,13 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, relationships: {}, filters: ["id"], + parent_resource: null, }, }, { @@ -9523,16 +9861,16 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], fields: { resource_type: { type: "string", - desc: "The type of resource being exported.", + desc: "The type of resource being exported. One of 'applications', 'event_stores', 'business_rules', 'markets', 'price_lists', 'customer_groups', 'line_items', 'discount_engine_items', 'promotions', 'addresses', 'geocoders', 'events', 'tags', 'adjustments', 'payment_gateways', 'payment_methods', 'adyen_payments', 'orders', 'transactions', 'payment_sessions', 'payment_settings', 'order_factories', 'attachments', 'tax_calculators', 'tax_categories', 'skus', 'shipping_categories', 'axerve_payments', 'order_validation_rules', 'braintree_payments', 'bundles', 'sku_lists', 'sku_list_items', 'stock_items', 'stock_locations', 'promotion_rules', 'coupons', 'returns', 'carrier_accounts', 'checkout_com_payments', 'customers', 'customer_addresses', 'customer_payment_sources', 'customer_subscriptions', 'order_subscriptions', 'payment_wallets', 'customer_password_resets', 'delivery_lead_times', 'shipping_methods', 'shipments', 'discount_engines', 'pickups', 'parcels', 'webhooks', 'event_callbacks', 'external_payments', 'gift_cards', 'in_stock_subscriptions', 'inventory_models', 'inventory_stock_locations', 'inventory_return_locations', 'klarna_payments', 'line_item_options', 'return_line_items', 'stock_line_items', 'stock_reservations', 'stock_transfers', 'notifications', 'sku_options', 'links', 'tax_rules', 'merchants', 'subscription_models', 'stores', 'price_list_schedulers', 'order_subscription_items', 'resource_errors', 'payment_options', 'payment_transactions', 'payment_links', 'paypal_payments', 'packages', 'parcel_line_items', 'prices', 'price_tiers', 'reserved_stocks', 'satispay_payments', 'shipping_method_tiers', 'shipping_zones', 'stripe_payments', or 'wire_transfers'.", required: "required", creatable: true, updatable: false, @@ -9540,17 +9878,112 @@ const corePublicResources = http.get( filterable: true, sortable: true, example: "skus", + enum: [ + "applications", + "event_stores", + "business_rules", + "markets", + "price_lists", + "customer_groups", + "line_items", + "discount_engine_items", + "promotions", + "addresses", + "geocoders", + "events", + "tags", + "adjustments", + "payment_gateways", + "payment_methods", + "adyen_payments", + "orders", + "transactions", + "payment_sessions", + "payment_settings", + "order_factories", + "attachments", + "tax_calculators", + "tax_categories", + "skus", + "shipping_categories", + "axerve_payments", + "order_validation_rules", + "braintree_payments", + "bundles", + "sku_lists", + "sku_list_items", + "stock_items", + "stock_locations", + "promotion_rules", + "coupons", + "returns", + "carrier_accounts", + "checkout_com_payments", + "customers", + "customer_addresses", + "customer_payment_sources", + "customer_subscriptions", + "order_subscriptions", + "payment_wallets", + "customer_password_resets", + "delivery_lead_times", + "shipping_methods", + "shipments", + "discount_engines", + "pickups", + "parcels", + "webhooks", + "event_callbacks", + "external_payments", + "gift_cards", + "in_stock_subscriptions", + "inventory_models", + "inventory_stock_locations", + "inventory_return_locations", + "klarna_payments", + "line_item_options", + "return_line_items", + "stock_line_items", + "stock_reservations", + "stock_transfers", + "notifications", + "sku_options", + "links", + "tax_rules", + "merchants", + "subscription_models", + "stores", + "price_list_schedulers", + "order_subscription_items", + "resource_errors", + "payment_options", + "payment_transactions", + "payment_links", + "paypal_payments", + "packages", + "parcel_line_items", + "prices", + "price_tiers", + "reserved_stocks", + "satispay_payments", + "shipping_method_tiers", + "shipping_zones", + "stripe_payments", + "wire_transfers", + ], }, format: { type: "string", - desc: "The format of the export one of 'json' (default) or 'csv'.", - required: "optional", + desc: "The format of the export. One of 'csv', or 'json' (default).", + default: "json", + required: 'optional, default is "json"', creatable: true, updatable: false, fetchable: true, filterable: true, sortable: true, example: "json", + enum: ["csv", "json"], }, status: { type: "string", @@ -9671,7 +10104,7 @@ const corePublicResources = http.get( }, records_count: { type: "integer", - desc: "Indicates the number of records to be exported.", + desc: "Indicates the number of records to be exported. While the export is in progress this value may be an estimate; it is set to the exact count when the export completes.", creatable: false, updatable: false, fetchable: true, @@ -9808,6 +10241,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -9867,6 +10301,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -9874,9 +10309,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -10017,63 +10452,9 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, - authorize_url: { - type: "string", - desc: "The endpoint used by the external gateway to authorize payments.", - required: "optional", - creatable: true, - updatable: true, - fetchable: true, - filterable: false, - sortable: false, - example: "https://external_gateway.com/authorize", - }, - capture_url: { - type: "string", - desc: "The endpoint used by the external gateway to capture payments.", - required: "optional", - creatable: true, - updatable: true, - fetchable: true, - filterable: false, - sortable: false, - example: "https://external_gateway.com/capture", - }, - void_url: { - type: "string", - desc: "The endpoint used by the external gateway to void payments.", - required: "optional", - creatable: true, - updatable: true, - fetchable: true, - filterable: false, - sortable: false, - example: "https://external_gateway.com/void", - }, - refund_url: { - type: "string", - desc: "The endpoint used by the external gateway to refund payments.", - required: "optional", - creatable: true, - updatable: true, - fetchable: true, - filterable: false, - sortable: false, - example: "https://external_gateway.com/refund", - }, - token_url: { - type: "string", - desc: "The endpoint used by the external gateway to create a customer payment token.", - required: "optional", - creatable: true, - updatable: true, - fetchable: true, - filterable: false, - sortable: false, - example: "https://external_gateway.com/token", - }, circuit_state: { type: "string", desc: "The circuit breaker state, by default it is 'closed'. It can become 'open' once the number of consecutive failures overlaps the specified threshold, in such case no further calls to the failing callback are made.", @@ -10130,8 +10511,8 @@ const corePublicResources = http.get( fetchable: false, filterable: false, sortable: false, - deprecated: true, example: "true", + versions: ["2017-08"], }, external_includes: { type: "array", @@ -10146,6 +10527,61 @@ const corePublicResources = http.get( exportable: false, example: ["order.line_item_options"], }, + authorize_url: { + type: "string", + desc: "The endpoint used by the external gateway to authorize payments.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "https://external_gateway.com/authorize", + }, + capture_url: { + type: "string", + desc: "The endpoint used by the external gateway to capture payments.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "https://external_gateway.com/capture", + }, + void_url: { + type: "string", + desc: "The endpoint used by the external gateway to void payments.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "https://external_gateway.com/void", + }, + refund_url: { + type: "string", + desc: "The endpoint used by the external gateway to refund payments.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "https://external_gateway.com/refund", + }, + token_url: { + type: "string", + desc: "The endpoint used by the external gateway to create a customer payment token.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "https://external_gateway.com/token", + }, }, relationships: { payment_methods: { @@ -10204,6 +10640,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "payment_gateway", }, }, { @@ -10211,9 +10648,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -10319,6 +10756,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -10383,6 +10821,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "payment_source", }, }, { @@ -10390,9 +10829,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [ @@ -10692,19 +11131,9 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, - promotion_url: { - type: "string", - desc: "The URL to the service that will compute the discount.", - required: "required", - creatable: true, - updatable: true, - fetchable: true, - filterable: false, - sortable: false, - example: "https://external_promotion.yourbrand.com", - }, circuit_state: { type: "string", desc: "The circuit breaker state, by default it is 'closed'. It can become 'open' once the number of consecutive failures overlaps the specified threshold, in such case no further calls to the failing callback are made.", @@ -10761,8 +11190,8 @@ const corePublicResources = http.get( fetchable: false, filterable: false, sortable: false, - deprecated: true, example: "true", + versions: ["2017-08"], }, external_includes: { type: "array", @@ -10777,6 +11206,17 @@ const corePublicResources = http.get( exportable: false, example: ["order.line_item_options"], }, + promotion_url: { + type: "string", + desc: "The URL to the service that will compute the discount.", + required: "required", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "https://external_promotion.yourbrand.com", + }, }, relationships: { market: { @@ -10805,7 +11245,7 @@ const corePublicResources = http.get( order_amount_promotion_rule: { type: "has_one", desc: "The associated order amount promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -10815,7 +11255,7 @@ const corePublicResources = http.get( sku_list_promotion_rule: { type: "has_one", desc: "The associated SKU list promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -10825,7 +11265,7 @@ const corePublicResources = http.get( coupon_codes_promotion_rule: { type: "has_one", desc: "The associated coupon codes promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -10835,7 +11275,7 @@ const corePublicResources = http.get( custom_promotion_rule: { type: "has_one", desc: "The associated custom promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -10957,6 +11397,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "promotion", }, }, { @@ -10964,9 +11405,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -10991,7 +11432,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: true, - example: "avalara_accounts", + example: "external_tax_calculators", enum: [ "avalara_accounts", "stripe_tax_accounts", @@ -11068,19 +11509,9 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, - tax_calculator_url: { - type: "string", - desc: "The URL to the service that will compute the taxes.", - required: "required", - creatable: true, - updatable: true, - fetchable: true, - filterable: false, - sortable: false, - example: "https://external_calculator.yourbrand.com", - }, circuit_state: { type: "string", desc: "The circuit breaker state, by default it is 'closed'. It can become 'open' once the number of consecutive failures overlaps the specified threshold, in such case no further calls to the failing callback are made.", @@ -11137,8 +11568,8 @@ const corePublicResources = http.get( fetchable: false, filterable: false, sortable: false, - deprecated: true, example: "true", + versions: ["2017-08"], }, external_includes: { type: "array", @@ -11153,6 +11584,17 @@ const corePublicResources = http.get( exportable: false, example: ["order.line_item_options"], }, + tax_calculator_url: { + type: "string", + desc: "The URL to the service that will compute the taxes.", + required: "required", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "https://external_calculator.yourbrand.com", + }, }, relationships: { markets: { @@ -11211,6 +11653,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "tax_calculator", }, }, { @@ -11218,9 +11661,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [ @@ -11520,6 +11963,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, fixed_amount_cents: { @@ -11583,7 +12027,7 @@ const corePublicResources = http.get( order_amount_promotion_rule: { type: "has_one", desc: "The associated order amount promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -11593,7 +12037,7 @@ const corePublicResources = http.get( sku_list_promotion_rule: { type: "has_one", desc: "The associated SKU list promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -11603,7 +12047,7 @@ const corePublicResources = http.get( coupon_codes_promotion_rule: { type: "has_one", desc: "The associated coupon codes promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -11613,7 +12057,7 @@ const corePublicResources = http.get( custom_promotion_rule: { type: "has_one", desc: "The associated custom promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -11733,6 +12177,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "promotion", }, }, { @@ -11740,9 +12185,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [ @@ -12042,6 +12487,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, fixed_amount_cents: { @@ -12105,7 +12551,7 @@ const corePublicResources = http.get( order_amount_promotion_rule: { type: "has_one", desc: "The associated order amount promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -12115,7 +12561,7 @@ const corePublicResources = http.get( sku_list_promotion_rule: { type: "has_one", desc: "The associated SKU list promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -12125,7 +12571,7 @@ const corePublicResources = http.get( coupon_codes_promotion_rule: { type: "has_one", desc: "The associated coupon codes promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -12135,7 +12581,7 @@ const corePublicResources = http.get( custom_promotion_rule: { type: "has_one", desc: "The associated custom promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -12255,6 +12701,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "promotion", }, }, { @@ -12262,9 +12709,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: ["active", "expired", "with_status"], @@ -12549,6 +12996,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -12556,7 +13004,7 @@ const corePublicResources = http.get( coupon_codes_promotion_rule: { type: "has_one", desc: "The associated coupon codes promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -12650,6 +13098,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "promotion", }, }, { @@ -12657,9 +13106,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [ @@ -12959,6 +13408,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, max_quantity: { @@ -13001,7 +13451,7 @@ const corePublicResources = http.get( order_amount_promotion_rule: { type: "has_one", desc: "The associated order amount promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -13011,7 +13461,7 @@ const corePublicResources = http.get( sku_list_promotion_rule: { type: "has_one", desc: "The associated SKU list promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -13021,7 +13471,7 @@ const corePublicResources = http.get( coupon_codes_promotion_rule: { type: "has_one", desc: "The associated coupon codes promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -13031,7 +13481,7 @@ const corePublicResources = http.get( custom_promotion_rule: { type: "has_one", desc: "The associated custom promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -13151,6 +13601,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "promotion", }, }, { @@ -13158,9 +13609,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [ @@ -13460,6 +13911,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -13490,7 +13942,7 @@ const corePublicResources = http.get( order_amount_promotion_rule: { type: "has_one", desc: "The associated order amount promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -13500,7 +13952,7 @@ const corePublicResources = http.get( sku_list_promotion_rule: { type: "has_one", desc: "The associated SKU list promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -13510,7 +13962,7 @@ const corePublicResources = http.get( coupon_codes_promotion_rule: { type: "has_one", desc: "The associated coupon codes promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -13520,7 +13972,7 @@ const corePublicResources = http.get( custom_promotion_rule: { type: "has_one", desc: "The associated custom promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -13632,6 +14084,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "promotion", }, }, { @@ -13639,9 +14092,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve"], examples: {}, filter_scopes: [], @@ -13736,6 +14189,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -13791,6 +14245,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -13798,9 +14253,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: ["with_status"], @@ -13952,6 +14407,7 @@ const corePublicResources = http.get( fetchable: true, filterable: false, sortable: false, + monitored: true, example: [ { datetime: "2019-12-23T12:00:00.000Z", @@ -13972,6 +14428,7 @@ const corePublicResources = http.get( fetchable: true, filterable: false, sortable: false, + monitored: true, example: { eNoKkhmbNp: [ { @@ -14182,6 +14639,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -14279,6 +14737,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -14286,9 +14745,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -14393,6 +14852,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -14449,6 +14909,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "email_recipient", }, }, { @@ -14456,9 +14917,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -14553,6 +15014,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, api_key: { @@ -14620,6 +15082,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "geocoder", }, }, { @@ -14627,16 +15090,16 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], fields: { resource_type: { type: "string", - desc: "The type of resource being imported.", + desc: "The type of resource being imported. One of 'price_lists', 'line_items', 'addresses', 'tags', 'orders', 'tax_categories', 'skus', 'shipping_categories', 'bundles', 'sku_lists', 'sku_list_items', 'stock_items', 'stock_locations', 'coupons', 'customers', 'customer_addresses', 'customer_payment_sources', 'customer_subscriptions', 'gift_cards', 'line_item_options', 'stock_transfers', 'sku_options', 'prices', or 'price_tiers'.", required: "required", creatable: true, updatable: false, @@ -14644,17 +15107,45 @@ const corePublicResources = http.get( filterable: true, sortable: true, example: "skus", + enum: [ + "price_lists", + "line_items", + "addresses", + "tags", + "orders", + "tax_categories", + "skus", + "shipping_categories", + "bundles", + "sku_lists", + "sku_list_items", + "stock_items", + "stock_locations", + "coupons", + "customers", + "customer_addresses", + "customer_payment_sources", + "customer_subscriptions", + "gift_cards", + "line_item_options", + "stock_transfers", + "sku_options", + "prices", + "price_tiers", + ], }, format: { type: "string", - desc: "The format of the import inputs one of 'json' (default) or 'csv'.", - required: "optional", + desc: "The format of the import. One of 'csv', or 'json' (default).", + default: "json", + required: 'optional, default is "json"', creatable: true, updatable: false, fetchable: true, filterable: true, sortable: true, example: "json", + enum: ["csv", "json"], }, parent_resource_id: { type: "string", @@ -14765,8 +15256,8 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: true, - deprecated: true, example: "99", + versions: ["2017-08"], }, processed_count: { type: "integer", @@ -14806,8 +15297,8 @@ const corePublicResources = http.get( fetchable: true, filterable: false, sortable: false, - deprecated: true, example: "true", + versions: ["2017-08"], }, skip_errors: { type: "boolean", @@ -14908,6 +15399,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -14970,6 +15462,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -14977,9 +15470,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -15118,6 +15611,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -15197,6 +15691,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -15204,9 +15699,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -15344,6 +15839,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -15407,6 +15903,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -15414,9 +15911,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -15499,6 +15996,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -15556,6 +16054,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -15563,9 +16062,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -15659,6 +16158,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -15717,6 +16217,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -15724,9 +16225,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -15867,6 +16368,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, country_code: { @@ -15960,6 +16462,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "payment_gateway", }, }, { @@ -15967,9 +16470,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -16116,6 +16619,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -16172,6 +16676,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "payment_source", }, }, { @@ -16179,9 +16684,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: { creatable: { @@ -16737,6 +17242,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -16859,6 +17365,7 @@ const corePublicResources = http.get( eager_load_on_include: false, parent_resource: "Api::LineItemResource", class_name: "PaymentMethod", + versions: ["2017-08"], }, line_item_options: { type: "has_many", @@ -16875,13 +17382,14 @@ const corePublicResources = http.get( sortable: false, parent_resource: "Api::LineItemResource", class_name: "ReturnLineItem", + versions: ["2017-08"], }, shipment_line_items: { type: "has_many", desc: "The associated shipment line items.", - deprecated: true, parent_resource: "Api::LineItemResource", class_name: "ShipmentLineItem", + versions: ["2017-08"], }, stock_reservations: { type: "has_many", @@ -16992,6 +17500,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -16999,9 +17508,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -17222,6 +17731,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -17306,6 +17816,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -17313,9 +17824,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -17443,6 +17954,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { param1: "ABC", param2: "XYZ" }, }, id: { @@ -17548,6 +18060,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -17617,6 +18130,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -17624,9 +18138,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -17767,6 +18281,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -17814,6 +18329,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "payment_gateway", }, }, { @@ -17821,9 +18337,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -17848,7 +18364,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: true, - example: "avalara_accounts", + example: "manual_tax_calculators", enum: [ "avalara_accounts", "stripe_tax_accounts", @@ -17925,6 +18441,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -17994,6 +18511,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "tax_calculator", }, }, { @@ -18001,9 +18519,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -18040,6 +18558,18 @@ const corePublicResources = http.get( sortable: true, example: "europe1", }, + payment_setting_ids: { + type: "array", + desc: "The list of available payment setting ids.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: ["1", "2", "34"], + versions: ["2026-05"], + }, facebook_pixel_id: { type: "string", desc: "The Facebook Pixed ID.", @@ -18177,8 +18707,8 @@ const corePublicResources = http.get( fetchable: false, filterable: false, sortable: false, - deprecated: true, example: "true", + versions: ["2017-08"], }, external_includes: { type: "array", @@ -18248,6 +18778,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -18303,6 +18834,7 @@ const corePublicResources = http.get( sortable: true, parent_resource: "Api::MarketResource", class_name: "SubscriptionModel", + versions: ["2017-08"], }, discount_engine: { type: "has_one", @@ -18379,6 +18911,7 @@ const corePublicResources = http.get( filterable: true, sortable: true, parent_resource: "Api::MarketResource", + versions: ["2017-08"], }, stores: { type: "has_many", @@ -18403,9 +18936,20 @@ const corePublicResources = http.get( sortable: false, polymorphic: true, sti: true, - deprecated: true, parent_resource: "Api::MarketResource", class_name: "OrderValidationRule", + versions: ["2017-08"], + }, + payment_rules: { + type: "has_many", + desc: "The associated payment rules.", + class_name: "PaymentRule", + creatable: false, + updatable: false, + filterable: true, + sortable: false, + parent_resource: "Api::MarketResource", + versions: ["2026-05"], }, attachments: { type: "has_many", @@ -18453,6 +18997,7 @@ const corePublicResources = http.get( "stores_id", "price_list_schedulers_id", "order_validation_rules_id", + "payment_rules_id", "attachments_id", "ids", "disabled_at_from", @@ -18462,6 +19007,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -18469,9 +19015,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -18554,6 +19100,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -18608,6 +19155,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -18615,9 +19163,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -18722,6 +19270,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -18771,6 +19320,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -18778,9 +19328,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: { creatable: { fields: ["language_code"], relationships: [] }, @@ -19014,6 +19564,7 @@ const corePublicResources = http.get( filterable: false, sortable: false, example: "true", + versions: ["2017-08"], }, adjustment_taxable: { type: "boolean", @@ -19091,6 +19642,7 @@ const corePublicResources = http.get( filterable: true, sortable: true, example: "cc92c23e-967e-48b2-a323-59add603301f", + versions: ["2017-08"], }, gift_card_or_coupon_code: { type: "string", @@ -19101,8 +19653,8 @@ const corePublicResources = http.get( fetchable: true, filterable: false, sortable: false, - deprecated: true, example: "cc92c23e-967e-48b2-a323-59add603301f", + versions: ["2017-08"], }, subtotal_amount_cents: { type: "integer", @@ -19177,6 +19729,7 @@ const corePublicResources = http.get( filterable: true, sortable: true, example: "0", + versions: ["2017-08"], }, payment_method_amount_float: { type: "float", @@ -19188,6 +19741,7 @@ const corePublicResources = http.get( sortable: false, monetizable: true, example: "0.0", + versions: ["2017-08"], }, formatted_payment_method_amount: { type: "string", @@ -19199,6 +19753,7 @@ const corePublicResources = http.get( sortable: false, monetizable: true, example: "€0,00", + versions: ["2017-08"], }, discount_amount_cents: { type: "integer", @@ -19232,6 +19787,38 @@ const corePublicResources = http.get( monetizable: true, example: "-€5,00", }, + subtotal_after_discount_cents: { + type: "integer", + desc: "The order's subtotal amount with the discounts applied without considering shipment, in cents.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: "4500", + }, + subtotal_after_discount_float: { + type: "integer", + desc: "The order's subtotal amount with the discounts applied without considering shipment, float.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + monetizable: true, + example: "45.0", + }, + formatted_subtotal_after_discount: { + type: "string", + desc: "The order's subtotal amount with the discounts applied without considering shipment, formatted.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + monetizable: true, + example: "€45,00", + }, adjustment_amount_cents: { type: "integer", desc: "The sum of all the adjustments applied to the order, in cents.", @@ -19273,6 +19860,7 @@ const corePublicResources = http.get( filterable: true, sortable: true, example: "1500", + versions: ["2017-08"], }, gift_card_amount_float: { type: "float", @@ -19284,6 +19872,7 @@ const corePublicResources = http.get( sortable: false, monetizable: true, example: "15.0", + versions: ["2017-08"], }, formatted_gift_card_amount: { type: "string", @@ -19295,6 +19884,7 @@ const corePublicResources = http.get( sortable: false, monetizable: true, example: "€15,00", + versions: ["2017-08"], }, total_tax_amount_cents: { type: "integer", @@ -19401,6 +19991,7 @@ const corePublicResources = http.get( filterable: false, sortable: false, example: "0", + versions: ["2017-08"], }, payment_method_tax_amount_float: { type: "float", @@ -19412,6 +20003,7 @@ const corePublicResources = http.get( sortable: false, monetizable: true, example: "0.0", + versions: ["2017-08"], }, formatted_payment_method_tax_amount: { type: "string", @@ -19423,6 +20015,7 @@ const corePublicResources = http.get( sortable: false, monetizable: true, example: "€0,00", + versions: ["2017-08"], }, adjustment_tax_amount_cents: { type: "integer", @@ -19593,6 +20186,7 @@ const corePublicResources = http.get( filterable: false, sortable: false, example: "0", + versions: ["2017-08"], }, payment_method_taxable_amount_float: { type: "float", @@ -19604,6 +20198,7 @@ const corePublicResources = http.get( sortable: false, monetizable: true, example: "0.0", + versions: ["2017-08"], }, formatted_payment_method_taxable_amount: { type: "string", @@ -19615,6 +20210,7 @@ const corePublicResources = http.get( sortable: false, monetizable: true, example: "€0,00", + versions: ["2017-08"], }, adjustment_taxable_amount_cents: { type: "integer", @@ -19680,6 +20276,44 @@ const corePublicResources = http.get( monetizable: true, example: "€57,00", }, + session_amount_cents: { + type: "integer", + desc: "The maximum amount available for use in the next payment session, expressed in cents.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + exportable: false, + example: "5700", + versions: ["2026-05"], + }, + session_amount_float: { + type: "float", + desc: "The maximum amount available for use in the next payment session, float.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + monetizable: true, + exportable: false, + example: "57.00", + versions: ["2026-05"], + }, + formatted_session_amount: { + type: "string", + desc: "The maximum amount available for use in the next payment session, formatted.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + monetizable: true, + exportable: false, + example: "€57,00", + versions: ["2026-05"], + }, fees_amount_cents: { type: "integer", desc: "The fees amount that is applied by Commerce Layer, in cents.", @@ -19809,6 +20443,20 @@ const corePublicResources = http.get( sortable: false, example: "1", }, + payment_taken_sessions_count: { + type: "integer", + desc: "The total number of payment sessions in a payment-taken state (authorized, paid or partially paid) associated with the order. Available only for the new payments version.", + default: 0, + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + exportable: false, + example: "1", + actions: ["internal"], + versions: ["2026-05"], + }, tax_calculations_count: { type: "integer", desc: "The total number of tax calculations. This can be useful to monitor external tax service usage.", @@ -19851,6 +20499,7 @@ const corePublicResources = http.get( filterable: true, sortable: false, example: { foo: "bar" }, + versions: ["2017-08"], }, token: { type: "string", @@ -19963,6 +20612,30 @@ const corePublicResources = http.get( sortable: false, example: "true", }, + _placeable: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to check if the order is placeable.", + idempotent: true, + creatable: false, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + placeable: { + type: "boolean", + desc: "Indicates if the order is placeable.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + transient: true, + sortable: false, + example: "true", + actions: ["update"], + }, _cancel: { type: "boolean", trigger: true, @@ -19997,6 +20670,7 @@ const corePublicResources = http.get( filterable: false, sortable: false, example: "true", + versions: ["2017-08"], }, _authorize: { type: "boolean", @@ -20009,6 +20683,7 @@ const corePublicResources = http.get( filterable: false, sortable: false, example: "true", + versions: ["2017-08"], }, _authorization_amount_cents: { type: "integer", @@ -20020,6 +20695,7 @@ const corePublicResources = http.get( filterable: false, sortable: false, example: "500", + versions: ["2017-08"], }, _capture: { type: "boolean", @@ -20032,6 +20708,7 @@ const corePublicResources = http.get( filterable: false, sortable: false, example: "true", + versions: ["2017-08"], }, _refund: { type: "boolean", @@ -20044,6 +20721,7 @@ const corePublicResources = http.get( filterable: false, sortable: false, example: "true", + versions: ["2017-08"], }, _fulfill: { type: "boolean", @@ -20078,6 +20756,7 @@ const corePublicResources = http.get( filterable: false, sortable: false, example: "false", + versions: ["2017-08"], }, _fix_payment_source: { type: "boolean", @@ -20090,6 +20769,7 @@ const corePublicResources = http.get( filterable: false, sortable: false, example: "true", + versions: ["2017-08"], }, _billing_address_clone_id: { type: "string", @@ -20121,6 +20801,7 @@ const corePublicResources = http.get( filterable: false, sortable: false, example: "1234", + versions: ["2017-08"], }, _shipping_address_same_as_billing: { type: "boolean", @@ -20181,6 +20862,7 @@ const corePublicResources = http.get( filterable: false, sortable: false, example: "true", + versions: ["2017-08"], }, _save_shipping_address_to_customer_address_book: { type: "boolean", @@ -20254,6 +20936,7 @@ const corePublicResources = http.get( filterable: false, sortable: false, example: "true", + versions: ["2017-08", "2026-05"], }, _start_editing: { type: "boolean", @@ -20522,6 +21205,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -20596,6 +21280,18 @@ const corePublicResources = http.get( eager_load_on_include: false, virtual: true, parent_resource: "Api::OrderResource", + versions: ["2017-08"], + }, + available_payment_settings: { + type: "has_many", + desc: "The available payment settings for the order. Useful to present the customer with a list of choices during the checkout.", + class_name: "PaymentSetting", + eager_load_on_include: false, + virtual: true, + polymorphic: true, + sti: true, + parent_resource: "Api::OrderResource", + versions: ["2026-05"], }, available_payment_methods: { type: "has_many", @@ -20604,6 +21300,7 @@ const corePublicResources = http.get( eager_load_on_include: false, virtual: true, parent_resource: "Api::OrderResource", + versions: ["2017-08"], }, available_customer_payment_sources: { type: "has_many", @@ -20612,6 +21309,7 @@ const corePublicResources = http.get( eager_load_on_include: false, virtual: true, parent_resource: "Api::OrderResource", + versions: ["2017-08"], }, available_free_skus: { type: "has_many", @@ -20639,6 +21337,7 @@ const corePublicResources = http.get( sortable: false, parent_resource: "Api::OrderResource", class_name: "PaymentMethod", + versions: ["2017-08"], }, payment_source: { type: "has_one", @@ -20653,6 +21352,7 @@ const corePublicResources = http.get( eager_load_on_include: false, parent_resource: "Api::OrderResource", class_name: "PaymentSource", + versions: ["2017-08"], enum: [ "adyen_payments", "axerve_payments", @@ -20693,6 +21393,15 @@ const corePublicResources = http.get( parent_resource: "Api::OrderResource", class_name: "LineItemOption", }, + payment_sessions: { + type: "has_many", + desc: "The associated payment sessions.", + filterable: true, + sortable: false, + parent_resource: "Api::OrderResource", + class_name: "PaymentSession", + versions: ["2026-05"], + }, stock_reservations: { type: "has_many", desc: "The associated stock reservations.", @@ -20732,6 +21441,54 @@ const corePublicResources = http.get( sortable: false, parent_resource: "Api::OrderResource", class_name: "PaymentOption", + versions: ["2017-08"], + }, + payment_transactions: { + type: "has_many", + desc: "The associated payment transactions.", + filterable: true, + sortable: false, + polymorphic: true, + sti: true, + parent_resource: "Api::OrderResource", + class_name: "PaymentTransaction", + versions: ["2026-05"], + }, + payment_authorizations: { + type: "has_many", + desc: "The associated payment authorizations.", + filterable: true, + sortable: false, + parent_resource: "Api::OrderResource", + class_name: "PaymentAuthorization", + versions: ["2026-05"], + }, + payment_captures: { + type: "has_many", + desc: "The associated payment captures.", + filterable: true, + sortable: false, + parent_resource: "Api::OrderResource", + class_name: "PaymentCapture", + versions: ["2026-05"], + }, + payment_voids: { + type: "has_many", + desc: "The associated payment voids.", + filterable: true, + sortable: false, + parent_resource: "Api::OrderResource", + class_name: "PaymentVoid", + versions: ["2026-05"], + }, + payment_refunds: { + type: "has_many", + desc: "The associated payment refunds.", + filterable: true, + sortable: false, + parent_resource: "Api::OrderResource", + class_name: "PaymentRefund", + versions: ["2026-05"], }, transactions: { type: "has_many", @@ -20742,6 +21499,7 @@ const corePublicResources = http.get( sti: true, parent_resource: "Api::OrderResource", class_name: "Transaction", + versions: ["2017-08"], enum: ["authorizations", "voids", "captures", "refunds"], }, authorizations: { @@ -20751,6 +21509,7 @@ const corePublicResources = http.get( sortable: false, parent_resource: "Api::OrderResource", class_name: "Authorization", + versions: ["2017-08"], }, captures: { type: "has_many", @@ -20759,6 +21518,7 @@ const corePublicResources = http.get( sortable: false, parent_resource: "Api::OrderResource", class_name: "Capture", + versions: ["2017-08"], }, voids: { type: "has_many", @@ -20767,6 +21527,7 @@ const corePublicResources = http.get( sortable: false, parent_resource: "Api::OrderResource", class_name: "Void", + versions: ["2017-08"], }, refunds: { type: "has_many", @@ -20775,6 +21536,7 @@ const corePublicResources = http.get( sortable: false, parent_resource: "Api::OrderResource", class_name: "Refund", + versions: ["2017-08"], }, returns: { type: "has_many", @@ -20783,6 +21545,7 @@ const corePublicResources = http.get( sortable: false, parent_resource: "Api::OrderResource", class_name: "Return", + versions: ["2017-08"], }, order_subscription: { type: "has_one", @@ -20949,11 +21712,17 @@ const corePublicResources = http.get( "discount_engine_item_id", "line_items_id", "line_item_options_id", + "payment_sessions_id", "stock_reservations_id", "stock_line_items_id", "stock_transfers_id", "shipments_id", "payment_options_id", + "payment_transactions_id", + "payment_authorizations_id", + "payment_captures_id", + "payment_voids_id", + "payment_refunds_id", "transactions_id", "authorizations_id", "captures_id", @@ -20994,6 +21763,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -21001,9 +21771,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -21092,6 +21862,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, order_amount_cents: { @@ -21193,6 +21964,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "promotion_rule", }, }, { @@ -21200,9 +21972,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -21311,6 +22083,7 @@ const corePublicResources = http.get( filterable: false, sortable: false, example: "true", + versions: ["2017-08"], }, id: { format: "id", @@ -21379,6 +22152,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, cancel_source_order: { @@ -21481,6 +22255,7 @@ const corePublicResources = http.get( sortable: true, parent_resource: "Api::OrderCopyResource", class_name: "OrderSubscription", + versions: ["2017-08"], }, }, filters: [ @@ -21512,6 +22287,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "order_factory", }, }, { @@ -21519,9 +22295,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve"], examples: {}, filter_scopes: [], @@ -21630,6 +22406,7 @@ const corePublicResources = http.get( filterable: false, sortable: false, example: "true", + versions: ["2017-08"], }, id: { format: "id", @@ -21698,6 +22475,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -21774,6 +22552,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -21781,9 +22560,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: ["active", "expired", "runnable"], @@ -21800,7 +22579,7 @@ const corePublicResources = http.get( }, status: { type: "string", - desc: "The subscription status. One of 'draft' (default), 'inactive', 'active', 'running', or 'cancelled'.", + desc: "The subscription status. One of 'draft' (default), 'pending', 'inactive', 'active', 'running', or 'cancelled'.", creatable: false, updatable: false, fetchable: true, @@ -21808,7 +22587,14 @@ const corePublicResources = http.get( sortable: true, example: "draft", aasm: true, - enum: ["draft", "inactive", "active", "running", "cancelled"], + enum: [ + "draft", + "pending", + "inactive", + "active", + "running", + "cancelled", + ], }, frequency: { type: "string", @@ -21952,8 +22738,21 @@ const corePublicResources = http.get( fetchable: true, filterable: false, sortable: false, - deprecated: true, example: { place_target_order: false }, + versions: ["2017-08"], + }, + gift_card_code: { + type: "string", + desc: "The gift card code used to pay the subscription renewals, in conjunction with a gift card payment setting.", + required: + "optional, required when the associated payment setting is a gift card one", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + example: "cc92c23e-967e-48b2-a323-59add603301f", + versions: ["2026-05"], }, _activate: { type: "boolean", @@ -22090,6 +22889,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -22108,7 +22908,7 @@ const corePublicResources = http.get( subscription_model: { type: "has_one", desc: "The subscription model associated to the market.", - required: "optional", + required: "required, unless deprecated payments workflow", through: true, creatable: false, updatable: false, @@ -22147,6 +22947,29 @@ const corePublicResources = http.get( sortable: true, parent_resource: "Api::OrderSubscriptionResource", class_name: "CustomerPaymentSource", + versions: ["2017-08"], + }, + payment_wallet: { + type: "has_one", + desc: "The associated payment_wallet.", + creatable: true, + updatable: true, + filterable: true, + sortable: true, + parent_resource: "Api::OrderSubscriptionResource", + class_name: "PaymentWallet", + versions: ["2026-05"], + }, + payment_setting: { + type: "has_one", + desc: "The associated payment_setting, used when no payment_wallet is available. When it is a gift card one the subscription renewals are paid with the associated gift_card_code.", + creatable: true, + updatable: true, + filterable: true, + sortable: true, + parent_resource: "Api::OrderSubscriptionResource", + class_name: "PaymentSetting", + versions: ["2026-05"], }, order_subscription_items: { type: "has_many", @@ -22163,7 +22986,6 @@ const corePublicResources = http.get( order_copies: { type: "has_many", desc: "The associated order copies.", - deprecated: true, parent_resource: "Api::OrderSubscriptionResource", class_name: "OrderCopy", }, @@ -22179,6 +23001,14 @@ const corePublicResources = http.get( parent_resource: "Api::OrderSubscriptionResource", class_name: "Order", }, + resource_errors: { + type: "has_many", + desc: "The associated resource errors.", + filterable: true, + sortable: false, + parent_resource: "Api::OrderSubscriptionResource", + class_name: "ResourceError", + }, events: { type: "has_many", desc: "The associated events.", @@ -22226,6 +23056,7 @@ const corePublicResources = http.get( "occurrencies", "errors_count", "succeeded_on_last_run", + "gift_card_code", "created_at", "updated_at", "reference", @@ -22237,6 +23068,9 @@ const corePublicResources = http.get( "source_order_id", "customer_id", "customer_payment_source_id", + "payment_wallet_id", + "payment_setting_id", + "resource_errors_id", "events_id", "tags_id", "ids", @@ -22253,6 +23087,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -22260,9 +23095,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -22433,6 +23268,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -22547,6 +23383,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -22554,9 +23391,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: true, addon: false, hidden: false, + versions: ["2017-08"], actions: ["list", "retrieve"], examples: {}, filter_scopes: [], @@ -22640,6 +23477,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -22695,6 +23533,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -22702,9 +23541,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: true, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["retrieve"], examples: {}, filter_scopes: [], @@ -22890,6 +23729,17 @@ const corePublicResources = http.get( sortable: false, example: "true", }, + api_fragment_caching_enabled: { + type: "boolean", + default: false, + desc: "Enables fragment caching for resources with related directive.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: "false", + }, api_rules_engine: { type: "boolean", default: false, @@ -23165,6 +24015,17 @@ const corePublicResources = http.get( sortable: false, example: "40", }, + gift_cards_auto_restore: { + type: "boolean", + default: true, + desc: "Enables automatic restoration of the gift card balance when an order is cancelled or reopened for editing, default is true.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: "true", + }, cleanups_max_concurrent_count: { type: "integer", default: 10, @@ -23375,171 +24236,38 @@ const corePublicResources = http.get( sortable: false, example: "true", }, - id: { - format: "id", - type: "string", - desc: "Unique identifier for the resource (hash).", - required: "required", - creatable: false, - updatable: false, - fetchable: true, - filterable: true, - sortable: true, - example: "XAyRWNUzyN", - }, - created_at: { - type: "string", - desc: "Time at which the resource was created.", - required: "required", + skus_discovery: { + type: "boolean", + default: false, + desc: "Enables the Sku discovery by similarity search.", creatable: false, updatable: false, fetchable: true, - filterable: true, - sortable: true, - example: "2018-01-01T12:00:00.000Z", - format: "datetime", + filterable: false, + sortable: false, + example: "false", }, - updated_at: { - type: "string", - desc: "Time at which the resource was last updated.", - required: "required", + payment_gateways_transaction_on_event: { + type: "boolean", + default: false, + desc: "Enables the creation of the authorization when the gateway event is received, even if there is no reference on Commerce Layer.", creatable: false, updatable: false, fetchable: true, - filterable: true, - sortable: true, - example: "2018-01-01T12:00:00.000Z", - format: "datetime", - }, - reference: { - type: "string", - desc: "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", - required: "optional", - creatable: true, - updatable: true, - fetchable: true, - filterable: true, - sortable: true, - example: "ANY-EXTERNAL-REFEFERNCE", - }, - reference_origin: { - type: "string", - desc: "Any identifier of the third party system that defines the reference code.", - required: "optional", - creatable: true, - updatable: true, - fetchable: true, - filterable: true, - sortable: true, - example: "ANY-EXTERNAL-REFEFERNCE-ORIGIN", - }, - metadata: { - type: "object", - desc: "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", - required: "optional", - creatable: true, - updatable: true, - fetchable: true, - filterable: true, + filterable: false, sortable: false, - example: { foo: "bar" }, + example: "false", }, - }, - relationships: { - event_stores: { - type: "has_many", - desc: "The associated event stores.", - class_name: "EventStore", + refunds_check_for_pending: { + type: "boolean", + default: false, + desc: "Enables blocking a new refund (or compensation) on a capture while an earlier async refund on the same capture is still unresolved.", creatable: false, updatable: false, + fetchable: true, filterable: false, sortable: false, - virtual: true, - exportable: false, - includable: false, - parent_resource: "Api::OrganizationResource", - }, - }, - filters: ["id"], - }, - }, - { - id: "package", - type: "resources", - attributes: { - singleton: false, - deprecated: false, - addon: false, - hidden: false, - actions: ["list", "retrieve", "create", "update", "delete"], - examples: {}, - filter_scopes: [], - fields: { - name: { - type: "string", - desc: "Unique name for the package.", - required: "required", - creatable: true, - updatable: true, - fetchable: true, - filterable: true, - sortable: true, - example: "Large (60x40x30)", - }, - code: { - type: "string", - desc: "The package identifying code.", - required: "optional", - creatable: true, - updatable: true, - fetchable: true, - filterable: true, - sortable: true, - example: "YYYY 2000", - }, - length: { - type: "float", - desc: "The package length, used to automatically calculate the tax rates from the available carrier accounts.", - required: "required", - creatable: true, - updatable: true, - fetchable: true, - filterable: true, - sortable: true, - example: "40.0", - }, - width: { - type: "float", - desc: "The package width, used to automatically calculate the tax rates from the available carrier accounts.", - required: "required", - creatable: true, - updatable: true, - fetchable: true, - filterable: true, - sortable: true, - example: "40.0", - }, - height: { - type: "float", - desc: "The package height, used to automatically calculate the tax rates from the available carrier accounts.", - required: "required", - creatable: true, - updatable: true, - fetchable: true, - filterable: true, - sortable: true, - example: "25.0", - }, - unit_of_length: { - type: "string", - desc: "The unit of length. Can be one of 'cm', or 'in'.", - required: "required", - creatable: true, - updatable: true, - fetchable: true, - filterable: true, - sortable: true, - example: "gr", + example: "false", }, id: { format: "id", @@ -23608,6 +24336,175 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, + example: { foo: "bar" }, + }, + }, + relationships: { + event_stores: { + type: "has_many", + desc: "The associated event stores.", + class_name: "EventStore", + creatable: false, + updatable: false, + filterable: false, + sortable: false, + virtual: true, + exportable: false, + includable: false, + parent_resource: "Api::OrganizationResource", + }, + }, + filters: ["id"], + parent_resource: null, + }, + }, + { + id: "package", + type: "resources", + attributes: { + singleton: false, + addon: false, + hidden: false, + versions: ["2017-08", "2026-05"], + actions: ["list", "retrieve", "create", "update", "delete"], + examples: {}, + filter_scopes: [], + fields: { + name: { + type: "string", + desc: "Unique name for the package.", + required: "required", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "Large (60x40x30)", + }, + code: { + type: "string", + desc: "The package identifying code.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "YYYY 2000", + }, + length: { + type: "float", + desc: "The package length, used to automatically calculate the tax rates from the available carrier accounts.", + required: "required", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "40.0", + }, + width: { + type: "float", + desc: "The package width, used to automatically calculate the tax rates from the available carrier accounts.", + required: "required", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "40.0", + }, + height: { + type: "float", + desc: "The package height, used to automatically calculate the tax rates from the available carrier accounts.", + required: "required", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "25.0", + }, + unit_of_length: { + type: "string", + desc: "The unit of length. Can be one of 'cm', or 'in'.", + required: "required", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "gr", + }, + id: { + format: "id", + type: "string", + desc: "Unique identifier for the resource (hash).", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "XAyRWNUzyN", + }, + created_at: { + type: "string", + desc: "Time at which the resource was created.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + updated_at: { + type: "string", + desc: "Time at which the resource was last updated.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + reference: { + type: "string", + desc: "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE", + }, + reference_origin: { + type: "string", + desc: "Any identifier of the third party system that defines the reference code.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE-ORIGIN", + }, + metadata: { + type: "object", + desc: "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -23677,6 +24574,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -23684,9 +24582,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -24043,6 +24941,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -24142,6 +25041,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -24149,9 +25049,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -24276,6 +25176,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -24311,9 +25212,9 @@ const corePublicResources = http.get( filterable: false, sortable: false, foreign_key: "stock_line_item_id", - deprecated: true, parent_resource: "Api::ParcelLineItemResource", class_name: "ShipmentLineItem", + versions: ["2017-08"], }, event_stores: { type: "has_many", @@ -24346,93 +25247,191 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { - id: "payment_gateway", + id: "payment_authorization", type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, - actions: ["list", "retrieve"], + versions: ["2026-05"], + actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], fields: { - name: { + type: { type: "string", - desc: "The payment gateway's internal name.", + desc: "The transaction type (authorization, capture, void, refund).", required: "required", - creatable: true, - updatable: true, + creatable: false, + updatable: false, fetchable: true, filterable: true, sortable: true, - example: "US payment gateway", + example: "payment_authorization", + enum: [ + "payment_authorizations", + "payment_voids", + "payment_captures", + "payment_refunds", + ], }, - force_payments: { - type: "boolean", - desc: "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", - required: "optional, default is 'false'", - default: false, - creatable: true, - updatable: true, + status: { + type: "string", + desc: "The transaction status. One of 'pending' (default), 'requires_action', 'processing', 'succeeded', 'declined', 'failed', 'canceled', or 'expired'.", + required: "required", + creatable: false, + updatable: false, fetchable: true, + filterable: true, + sortable: true, + example: "draft", + aasm: true, + enum: [ + "pending", + "requires_action", + "processing", + "succeeded", + "declined", + "failed", + "canceled", + "expired", + ], + }, + payment_type: { + type: "string", + desc: "The payment type inherited by the payment session. One of 'ADYEN', 'BRAINTREE', 'CHECKOUT_COM', 'EXTERNAL', 'GIFT_CARD', 'MANUAL', 'PAYPAL', or 'STRIPE'.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "MANUAL", + enum: [ + "ADYEN", + "BRAINTREE", + "CHECKOUT_COM", + "EXTERNAL", + "GIFT_CARD", + "MANUAL", + "PAYPAL", + "STRIPE", + ], + }, + _internal_version: { + type: "string", + trigger: true, + desc: "Send this attribute if you want to force a specific supported internal payload version for this request, overriding the payment setting's configured default. Only usable when the payment setting is internal_versionable.", + creatable: true, + updatable: false, + fetchable: false, filterable: false, sortable: false, - example: "true", + example: "V72", }, - credential_keys: { - type: "object", - desc: "The payment gateway's API credential keys last digits.", + token: { + type: "string", + desc: "The token identifying the transaction, returned by the payment session interaction.", creatable: false, updatable: false, fetchable: true, - filterable: false, + filterable: true, sortable: false, - example: { api_key: "********BW989" }, + example: "xxxx-yyyy-zzzz", }, - id: { - format: "id", + currency_code: { type: "string", - desc: "Unique identifier for the resource (hash).", - required: "required", + desc: "The international 3-letter currency code as defined by the ISO 4217 standard.", + required: "optional, default to payment session currency code", creatable: false, updatable: false, fetchable: true, filterable: true, sortable: true, - example: "XAyRWNUzyN", + example: "EUR", }, - _disable: { - type: "boolean", - trigger: true, - desc: "Send this attribute if you want to mark this resource as disabled.", - required: "optional", - creatable: true, - updatable: true, - fetchable: false, + amount_cents: { + type: "integer", + desc: "The payment transacion amount cents collected.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: 1000, + }, + amount_float: { + type: "float", + desc: "The payment transaction amount, float.", + creatable: false, + updatable: false, + fetchable: true, filterable: false, sortable: false, - example: "true", + monetizable: true, + example: 10.0, }, - _enable: { - type: "boolean", - trigger: true, - desc: "Send this attribute if you want to mark this resource as enabled.", - required: "optional", - creatable: true, - updatable: true, - fetchable: false, + formatted_amount: { + type: "string", + desc: "The payment transaction amount, formatted.", + creatable: false, + updatable: false, + fetchable: true, filterable: false, sortable: false, - example: "true", + monetizable: true, + example: "€10,00", }, - disabled_at: { + request_data: { + type: "object", + desc: "The data of the request sent to the payment gateway.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: "{}", + }, + response_data: { + type: "object", + desc: "The payment gateway response data, specific to this transaction. Cannot be passed by sales channels.", + prohibited: true, + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: "{}", + }, + options: { + type: "object", + desc: "Options to use for the transaction, the passed values will be used to communicate with the payment gateway. Cannot be passed by sales channels.", + prohibited: true, + creatable: true, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: { cancellation_reason: "fraudulent" }, + }, + requires_action_at: { type: "string", - desc: "Time at which this resource was disabled.", - required: "optional", + desc: "Time at which the transaction is marked as requires_action.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + processing_at: { + type: "string", + desc: "Time at which the transaction has been processed.", creatable: false, updatable: false, fetchable: true, @@ -24441,6 +25440,73 @@ const corePublicResources = http.get( example: "2018-01-01T12:00:00.000Z", format: "datetime", }, + succeeded_at: { + type: "string", + desc: "Time at which the transaction is marked as succeeded.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + declined_at: { + type: "string", + desc: "Time at which the transaction is marked as declined.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + failed_at: { + type: "string", + desc: "Time at which the transaction is marked as failed.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + canceled_at: { + type: "string", + desc: "Time at which the transaction has been cancelled.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + expired_at: { + type: "string", + desc: "Time at which the transaction has been expired.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + id: { + format: "id", + type: "string", + desc: "Unique identifier for the resource (hash).", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "XAyRWNUzyN", + }, created_at: { type: "string", desc: "Time at which the resource was created.", @@ -24496,19 +25562,155 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, + capture_balance_cents: { + type: "integer", + desc: "The balance to be captured, in cents.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: "1000", + }, + capture_balance_float: { + type: "float", + desc: "The balance to be captured, float.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + monetizable: true, + example: "10.0", + }, + formatted_capture_balance: { + type: "string", + desc: "The balance to be captured, formatted.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + monetizable: true, + example: "€10,00", + }, + void_balance_cents: { + type: "integer", + desc: "The balance to be voided, in cents.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: "1500", + }, + void_balance_float: { + type: "float", + desc: "The balance to be voided, float.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + monetizable: true, + example: "15.0", + }, + formatted_void_balance: { + type: "string", + desc: "The balance to be voided, formatted.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + monetizable: true, + example: "€15,00", + }, + _payment_details: { + type: "object", + trigger: true, + desc: "Send this attribute if you want to send additional details for the payment collected by client, such as 3DS authentication result.", + creatable: false, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: { foo: "bar" }, + }, + next_action_type: { + type: "string", + desc: "The type of action the client must perform to continue the payment. One of 'redirect', 'challenge', 'fingerprint', or 'present'.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: "challenge", + enum: ["redirect", "challenge", "fingerprint", "present"], + }, + next_action_data: { + type: "object", + desc: "The data needed by the client to perform next_action_type.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: "{}", + }, }, relationships: { - payment_methods: { - type: "has_many", - desc: "The associated payment methods.", + payment_session: { + type: "has_one", + desc: "The associated payment session.", + required: "required", + creatable: true, + updatable: false, + filterable: true, + sortable: true, + parent_resource: "Api::PaymentTransactionResource", + class_name: "PaymentSession", + }, + order: { + type: "has_one", + desc: "The associated order.", creatable: false, updatable: false, filterable: true, sortable: false, - parent_resource: "Api::StripeGatewayResource", - class_name: "PaymentMethod", + parent_resource: "Api::PaymentTransactionResource", + class_name: "Order", + }, + payment_setting: { + type: "has_one", + desc: "The associated payment setting.", + creatable: false, + updatable: false, + filterable: true, + sortable: false, + polymorphic: true, + sti: true, + parent_resource: "Api::PaymentTransactionResource", + class_name: "PaymentSetting", + }, + attachments: { + type: "has_many", + desc: "The associated attachments.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentAuthorizationResource", + class_name: "Attachment", + }, + events: { + type: "has_many", + desc: "The associated events.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentAuthorizationResource", + class_name: "Event", }, event_stores: { type: "has_many", @@ -24521,196 +25723,323 @@ const corePublicResources = http.get( virtual: true, exportable: false, includable: false, - parent_resource: "Api::ManualGatewayResource", + parent_resource: "Api::PaymentAuthorizationResource", + }, + payment_void: { + type: "has_one", + desc: "The associated void.", + creatable: false, + updatable: false, + filterable: true, + sortable: false, + parent_resource: "Api::PaymentAuthorizationResource", + class_name: "PaymentVoid", + }, + payment_captures: { + type: "has_many", + desc: "The associated captures.", + filterable: false, + sortable: false, + parent_resource: "Api::PaymentAuthorizationResource", + class_name: "PaymentCapture", }, }, filters: [ "id", - "name", - "disabled_at", + "type", + "status", + "payment_type", + "token", + "currency_code", + "amount_cents", + "options", + "requires_action_at", + "processing_at", + "succeeded_at", + "declined_at", + "failed_at", + "canceled_at", + "expired_at", "created_at", "updated_at", "reference", "reference_origin", "metadata", + "next_action_type", "q", - "payment_methods_id", + "payment_session_id", + "order_id", + "payment_setting_id", + "attachments_id", + "events_id", + "payment_void_id", "ids", - "disabled_at_from", - "disabled_at_to", + "requires_action_at_from", + "requires_action_at_to", + "processing_at_from", + "processing_at_to", + "succeeded_at_from", + "succeeded_at_to", + "declined_at_from", + "declined_at_to", + "failed_at_from", + "failed_at_to", + "canceled_at_from", + "canceled_at_to", + "expired_at_from", + "expired_at_to", "created_at_from", "created_at_to", "updated_at_from", "updated_at_to", ], + parent_resource: "payment_transaction", }, }, { - id: "payment_method", + id: "payment_capture", type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], fields: { - name: { + type: { type: "string", - desc: "The payment method's internal name.", - required: "optional, default to titleized payment source type", - creatable: true, - updatable: true, + desc: "The transaction type (authorization, capture, void, refund).", + required: "required", + creatable: false, + updatable: false, fetchable: true, filterable: true, sortable: true, - example: "Stripe Payment", + example: "payment_authorization", + enum: [ + "payment_authorizations", + "payment_voids", + "payment_captures", + "payment_refunds", + ], }, - payment_source_type: { + status: { type: "string", - desc: "The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'external_payments', 'klarna_payments', 'paypal_payments', 'satispay_payments', 'stripe_payments', or 'wire_transfers'.", + desc: "The transaction status. One of 'pending' (default), 'requires_action', 'processing', 'succeeded', 'declined', 'failed', 'canceled', or 'expired'.", required: "required", - creatable: true, - updatable: true, + creatable: false, + updatable: false, fetchable: true, filterable: true, sortable: true, - example: "stripe_payments", + example: "draft", + aasm: true, enum: [ - "adyen_payments", - "axerve_payments", - "braintree_payments", - "checkout_com_payments", - "external_payments", - "klarna_payments", - "paypal_payments", - "satispay_payments", - "stripe_payments", - "wire_transfers", + "pending", + "requires_action", + "processing", + "succeeded", + "declined", + "failed", + "canceled", + "expired", ], }, - currency_code: { + payment_type: { type: "string", - desc: "The international 3-letter currency code as defined by the ISO 4217 standard.", - required: "required, unless inherited by market", - creatable: true, - updatable: true, + desc: "The payment type inherited by the payment session. One of 'ADYEN', 'BRAINTREE', 'CHECKOUT_COM', 'EXTERNAL', 'GIFT_CARD', 'MANUAL', 'PAYPAL', or 'STRIPE'.", + required: "required", + creatable: false, + updatable: false, fetchable: true, filterable: true, sortable: true, - example: "EUR", - }, - moto: { - type: "boolean", - desc: "Send this attribute if you want to mark the payment as MOTO, must be supported by payment gateway.", - required: "optional, default is 'false'", - creatable: true, - updatable: true, - fetchable: true, - filterable: false, - sortable: false, - example: "false", + example: "MANUAL", + enum: [ + "ADYEN", + "BRAINTREE", + "CHECKOUT_COM", + "EXTERNAL", + "GIFT_CARD", + "MANUAL", + "PAYPAL", + "STRIPE", + ], }, - require_capture: { - type: "boolean", - desc: "Send this attribute if you want to require the payment capture before fulfillment.", - required: "optional, deafult is 'true'", + _internal_version: { + type: "string", + trigger: true, + desc: "Send this attribute if you want to force a specific supported internal payload version for this request, overriding the payment setting's configured default. Only usable when the payment setting is internal_versionable.", creatable: true, - updatable: true, - fetchable: true, + updatable: false, + fetchable: false, filterable: false, sortable: false, - example: "true", + example: "V72", }, - auto_place: { - type: "boolean", - desc: "Send this attribute if you want to automatically place the order upon authorization performed asynchronously.", - required: "optional, default is 'false'", - creatable: true, - updatable: true, + token: { + type: "string", + desc: "The token identifying the transaction, returned by the payment session interaction.", + creatable: false, + updatable: false, fetchable: true, - filterable: false, + filterable: true, sortable: false, - example: "true", + example: "xxxx-yyyy-zzzz", }, - auto_capture: { - type: "boolean", - desc: "Send this attribute if you want to automatically capture the payment upon authorization.", - required: "optional, default is 'false'", - creatable: true, - updatable: true, + currency_code: { + type: "string", + desc: "The international 3-letter currency code as defined by the ISO 4217 standard.", + required: "optional, default to payment session currency code", + creatable: false, + updatable: false, fetchable: true, - filterable: false, - sortable: false, - example: "false", + filterable: true, + sortable: true, + example: "EUR", }, - price_amount_cents: { + amount_cents: { type: "integer", - desc: "The payment method's price, in cents.", - required: "required", + desc: "The payment transacion amount cents collected.", creatable: true, - updatable: true, + updatable: false, fetchable: true, filterable: true, sortable: true, - example: "0", + example: 1000, }, - price_amount_float: { + amount_float: { type: "float", - desc: "The payment method's price, float.", + desc: "The payment transaction amount, float.", creatable: false, updatable: false, fetchable: true, filterable: false, sortable: false, monetizable: true, - example: "0.0", + example: 10.0, }, - formatted_price_amount: { + formatted_amount: { type: "string", - desc: "The payment method's price, formatted.", + desc: "The payment transaction amount, formatted.", creatable: false, updatable: false, fetchable: true, filterable: false, sortable: false, monetizable: true, - example: "€0,00", + example: "€10,00", }, - auto_capture_max_amount_cents: { - type: "integer", - desc: "Send this attribute if you want to limit automatic capture to orders for which the total amount is equal or less than the specified value, in cents.", - required: "optional", - creatable: true, - updatable: true, + request_data: { + type: "object", + desc: "The data of the request sent to the payment gateway.", + creatable: false, + updatable: false, fetchable: true, filterable: false, sortable: false, - example: "0", + example: "{}", }, - auto_capture_max_amount_float: { - type: "float", - desc: "The automatic capture max amount, float.", + response_data: { + type: "object", + desc: "The payment gateway response data, specific to this transaction. Cannot be passed by sales channels.", + prohibited: true, creatable: false, updatable: false, fetchable: true, filterable: false, sortable: false, - monetizable: true, - example: "0.0", + example: "{}", }, - formatted_auto_capture_max_amount: { + options: { + type: "object", + desc: "Options to use for the transaction, the passed values will be used to communicate with the payment gateway. Cannot be passed by sales channels.", + prohibited: true, + creatable: true, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: { cancellation_reason: "fraudulent" }, + }, + requires_action_at: { type: "string", - desc: "The automatic capture max amount, formatted.", + desc: "Time at which the transaction is marked as requires_action.", creatable: false, updatable: false, fetchable: true, - filterable: false, - sortable: false, - monetizable: true, - example: "€0,00", + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + processing_at: { + type: "string", + desc: "Time at which the transaction has been processed.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + succeeded_at: { + type: "string", + desc: "Time at which the transaction is marked as succeeded.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + declined_at: { + type: "string", + desc: "Time at which the transaction is marked as declined.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + failed_at: { + type: "string", + desc: "Time at which the transaction is marked as failed.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + canceled_at: { + type: "string", + desc: "Time at which the transaction has been cancelled.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + expired_at: { + type: "string", + desc: "Time at which the transaction has been expired.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", }, id: { format: "id", @@ -24724,41 +26053,6875 @@ const corePublicResources = http.get( sortable: true, example: "XAyRWNUzyN", }, - _disable: { - type: "boolean", - trigger: true, - desc: "Send this attribute if you want to mark this resource as disabled.", + created_at: { + type: "string", + desc: "Time at which the resource was created.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + updated_at: { + type: "string", + desc: "Time at which the resource was last updated.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + reference: { + type: "string", + desc: "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", required: "optional", creatable: true, updatable: true, - fetchable: false, - filterable: false, - sortable: false, - example: "true", + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE", }, - _enable: { - type: "boolean", - trigger: true, - desc: "Send this attribute if you want to mark this resource as enabled.", + reference_origin: { + type: "string", + desc: "Any identifier of the third party system that defines the reference code.", required: "optional", creatable: true, updatable: true, - fetchable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE-ORIGIN", + }, + metadata: { + type: "object", + desc: "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + monitored: true, + example: { foo: "bar" }, + }, + refund_balance_cents: { + type: "integer", + desc: "The balance to be refunded, in cents.", + creatable: false, + updatable: false, + fetchable: true, filterable: false, sortable: false, - example: "true", + example: "1000", }, - disabled_at: { + refund_balance_float: { + type: "float", + desc: "The balance to be refunded, float.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + monetizable: true, + example: "10.0", + }, + formatted_refund_balance: { type: "string", - desc: "Time at which this resource was disabled.", - required: "optional", + desc: "The balance to be refunded, formatted.", creatable: false, updatable: false, fetchable: true, + filterable: false, + sortable: false, + monetizable: true, + example: "€10,00", + }, + }, + relationships: { + payment_session: { + type: "has_one", + desc: "The associated payment session.", + required: "required", + creatable: true, + updatable: false, filterable: true, sortable: true, - example: "2018-01-01T12:00:00.000Z", - format: "datetime", + parent_resource: "Api::PaymentTransactionResource", + class_name: "PaymentSession", + }, + order: { + type: "has_one", + desc: "The associated order.", + creatable: false, + updatable: false, + filterable: true, + sortable: false, + parent_resource: "Api::PaymentTransactionResource", + class_name: "Order", + }, + payment_setting: { + type: "has_one", + desc: "The associated payment setting.", + creatable: false, + updatable: false, + filterable: true, + sortable: false, + polymorphic: true, + sti: true, + parent_resource: "Api::PaymentTransactionResource", + class_name: "PaymentSetting", + }, + attachments: { + type: "has_many", + desc: "The associated attachments.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentCaptureResource", + class_name: "Attachment", + }, + events: { + type: "has_many", + desc: "The associated events.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentCaptureResource", + class_name: "Event", + }, + event_stores: { + type: "has_many", + desc: "The associated event stores.", + class_name: "EventStore", + creatable: false, + updatable: false, + filterable: false, + sortable: false, + virtual: true, + exportable: false, + includable: false, + parent_resource: "Api::PaymentCaptureResource", + }, + payment_authorization: { + type: "has_one", + desc: "The associated payment authorization.", + required: "required", + foreign_key: "reference_transaction_id", + creatable: true, + updatable: false, + filterable: true, + sortable: false, + parent_resource: "Api::PaymentCaptureResource", + class_name: "PaymentAuthorization", + }, + payment_refunds: { + type: "has_many", + desc: "The associated refunds.", + filterable: false, + sortable: false, + parent_resource: "Api::PaymentCaptureResource", + class_name: "PaymentRefund", + }, + }, + filters: [ + "id", + "type", + "status", + "payment_type", + "token", + "currency_code", + "amount_cents", + "options", + "requires_action_at", + "processing_at", + "succeeded_at", + "declined_at", + "failed_at", + "canceled_at", + "expired_at", + "created_at", + "updated_at", + "reference", + "reference_origin", + "metadata", + "q", + "payment_session_id", + "order_id", + "payment_setting_id", + "attachments_id", + "events_id", + "payment_authorization_id", + "ids", + "requires_action_at_from", + "requires_action_at_to", + "processing_at_from", + "processing_at_to", + "succeeded_at_from", + "succeeded_at_to", + "declined_at_from", + "declined_at_to", + "failed_at_from", + "failed_at_to", + "canceled_at_from", + "canceled_at_to", + "expired_at_from", + "expired_at_to", + "created_at_from", + "created_at_to", + "updated_at_from", + "updated_at_to", + ], + parent_resource: "payment_transaction", + }, + }, + { + id: "payment_gateway", + type: "resources", + attributes: { + singleton: false, + addon: false, + hidden: false, + versions: ["2017-08"], + actions: ["list", "retrieve"], + examples: {}, + filter_scopes: [], + fields: { + name: { + type: "string", + desc: "The payment gateway's internal name.", + required: "required", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "US payment gateway", + }, + force_payments: { + type: "boolean", + desc: "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", + required: "optional, default is 'false'", + default: false, + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "true", + }, + credential_keys: { + type: "object", + desc: "The payment gateway's API credential keys last digits.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: { api_key: "********BW989" }, + }, + id: { + format: "id", + type: "string", + desc: "Unique identifier for the resource (hash).", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "XAyRWNUzyN", + }, + _disable: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to mark this resource as disabled.", + required: "optional", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + _enable: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to mark this resource as enabled.", + required: "optional", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + disabled_at: { + type: "string", + desc: "Time at which this resource was disabled.", + required: "optional", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + created_at: { + type: "string", + desc: "Time at which the resource was created.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + updated_at: { + type: "string", + desc: "Time at which the resource was last updated.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + reference: { + type: "string", + desc: "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE", + }, + reference_origin: { + type: "string", + desc: "Any identifier of the third party system that defines the reference code.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE-ORIGIN", + }, + metadata: { + type: "object", + desc: "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + monitored: true, + example: { foo: "bar" }, + }, + }, + relationships: { + payment_methods: { + type: "has_many", + desc: "The associated payment methods.", + creatable: false, + updatable: false, + filterable: true, + sortable: false, + parent_resource: "Api::StripeGatewayResource", + class_name: "PaymentMethod", + }, + event_stores: { + type: "has_many", + desc: "The associated event stores.", + class_name: "EventStore", + creatable: false, + updatable: false, + filterable: false, + sortable: false, + virtual: true, + exportable: false, + includable: false, + parent_resource: "Api::ManualGatewayResource", + }, + }, + filters: [ + "id", + "name", + "disabled_at", + "created_at", + "updated_at", + "reference", + "reference_origin", + "metadata", + "q", + "payment_methods_id", + "ids", + "disabled_at_from", + "disabled_at_to", + "created_at_from", + "created_at_to", + "updated_at_from", + "updated_at_to", + ], + parent_resource: null, + }, + }, + { + id: "payment_link", + type: "resources", + attributes: { + singleton: false, + addon: false, + hidden: false, + versions: ["2026-05"], + actions: ["list", "retrieve", "create", "update", "delete"], + examples: {}, + filter_scopes: [], + fields: { + status: { + type: "string", + desc: "The payment link status. One of 'open' (default), 'expired', or 'completed'.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "succeeded", + aasm: true, + enum: ["open", "expired", "completed"], + }, + amount_cents: { + type: "integer", + desc: "The payment link amount to collect, in cents. Defaults to the associated payment session amount, or to the order outstanding amount when no session is present. Not updatable once the payment link is created.", + required: + "optional, default to the payment session or order amount", + creatable: true, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: 1000, + }, + amount_float: { + type: "float", + desc: "The payment link amount, float.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + monetizable: true, + example: 10.0, + }, + formatted_amount: { + type: "string", + desc: "The payment link amount, formatted.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + monetizable: true, + example: "€10,00", + }, + currency_code: { + type: "string", + desc: "The international 3-letter currency code as defined by the ISO 4217 standard. Defaults to the associated payment session or order currency code.", + required: + "optional, default to the payment session or order currency code", + creatable: true, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "EUR", + }, + name: { + type: "string", + desc: "An optional name for the payment link, shown on the gateway's hosted page when supported. Not updatable once the payment link is created.", + required: "optional", + creatable: true, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "Invoice #1234 balance due", + }, + token: { + type: "string", + desc: "The unique token identifying the payment link.", + required: "optional", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: "xxxx-yyyy-zzzz", + }, + url: { + type: "string", + desc: "The URL for this payment link returned by the gateway.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "https://checkout.yourbrand.com/:order_id", + }, + return_url: { + type: "string", + desc: "The URL to redirect your customer upon payment is completed. When omitted, the customer stays on the gateway's hosted page once the payment is completed.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "http://commercelayer.dev/payment_link/process", + }, + options: { + type: "object", + desc: "Options to use for the payment link, the passed values will be used to communicate with the payment gateway. Cannot be passed by sales channels.", + prohibited: true, + creatable: true, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: { usage: "on_session" }, + }, + request_data: { + type: "object", + desc: "The data of the request sent to the payment gateway.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: "{}", + }, + response_data: { + type: "object", + desc: "The payment gateway response data, used by successive payment workflows.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: "{}", + }, + _internal_version: { + type: "string", + trigger: true, + desc: "Send this attribute if you want to force a specific supported internal payload version for this request, overriding the payment setting's configured default. Only usable when the payment setting is internal_versionable.", + creatable: true, + updatable: false, + fetchable: false, + filterable: false, + sortable: false, + example: "V72", + }, + _refresh: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to sync the payment link status with the payment gateway.", + creatable: false, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + _cancel: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to cancel this payment link. Cannot be passed by sales channels.", + required: "optional", + prohibited: true, + creatable: false, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + completed_at: { + type: "string", + desc: "Time at which the payment link has been expired.", + required: "optional, default is 'null'", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + expired_at: { + type: "string", + desc: "Time at which the payment link has been expired.", + required: "optional, default is 'null'", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + id: { + format: "id", + type: "string", + desc: "Unique identifier for the resource (hash).", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "XAyRWNUzyN", + }, + created_at: { + type: "string", + desc: "Time at which the resource was created.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + updated_at: { + type: "string", + desc: "Time at which the resource was last updated.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + reference: { + type: "string", + desc: "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE", + }, + reference_origin: { + type: "string", + desc: "Any identifier of the third party system that defines the reference code.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE-ORIGIN", + }, + metadata: { + type: "object", + desc: "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + monitored: true, + example: { foo: "bar" }, + }, + }, + relationships: { + order: { + type: "has_one", + desc: "The associated order.", + required: "optional", + creatable: true, + updatable: false, + filterable: true, + sortable: false, + parent_resource: "Api::PaymentLinkResource", + class_name: "Order", + }, + billing_address: { + type: "has_one", + desc: "The associated billing address. Inherited from the associated order's own billing address when not specified. Required by Checkout.com.", + class_name: "Address", + required: "optional", + creatable: true, + updatable: false, + filterable: true, + sortable: false, + parent_resource: "Api::PaymentLinkResource", + }, + payment_setting: { + type: "has_one", + desc: "The associated payment setting.", + required: "required", + creatable: true, + updatable: false, + filterable: true, + sortable: false, + parent_resource: "Api::PaymentLinkResource", + class_name: "PaymentSetting", + }, + payment_session: { + type: "has_one", + desc: "The associated payment session. Required by the payment settings that need a session token to build the link, optional otherwise.", + required: "optional", + creatable: true, + updatable: false, + filterable: true, + sortable: false, + parent_resource: "Api::PaymentLinkResource", + class_name: "PaymentSession", + }, + attachments: { + type: "has_many", + desc: "The associated attachments.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentLinkResource", + class_name: "Attachment", + }, + events: { + type: "has_many", + desc: "The associated events.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentLinkResource", + class_name: "Event", + }, + event_stores: { + type: "has_many", + desc: "The associated event stores.", + class_name: "EventStore", + creatable: false, + updatable: false, + filterable: false, + sortable: false, + virtual: true, + exportable: false, + includable: false, + parent_resource: "Api::PaymentLinkResource", + }, + }, + filters: [ + "id", + "status", + "amount_cents", + "currency_code", + "name", + "token", + "url", + "return_url", + "completed_at", + "expired_at", + "created_at", + "updated_at", + "reference", + "reference_origin", + "metadata", + "q", + "order_id", + "billing_address_id", + "payment_setting_id", + "payment_session_id", + "attachments_id", + "events_id", + "ids", + "completed_at_from", + "completed_at_to", + "expired_at_from", + "expired_at_to", + "created_at_from", + "created_at_to", + "updated_at_from", + "updated_at_to", + ], + parent_resource: null, + }, + }, + { + id: "payment_method", + type: "resources", + attributes: { + singleton: false, + addon: false, + hidden: false, + versions: ["2017-08"], + actions: ["list", "retrieve", "create", "update", "delete"], + examples: {}, + filter_scopes: [], + fields: { + name: { + type: "string", + desc: "The payment method's internal name.", + required: "optional, default to titleized payment source type", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "Stripe Payment", + }, + payment_source_type: { + type: "string", + desc: "The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'external_payments', 'klarna_payments', 'paypal_payments', 'satispay_payments', 'stripe_payments', or 'wire_transfers'.", + required: "required", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "stripe_payments", + enum: [ + "adyen_payments", + "axerve_payments", + "braintree_payments", + "checkout_com_payments", + "external_payments", + "klarna_payments", + "paypal_payments", + "satispay_payments", + "stripe_payments", + "wire_transfers", + ], + }, + currency_code: { + type: "string", + desc: "The international 3-letter currency code as defined by the ISO 4217 standard.", + required: "required, unless inherited by market", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "EUR", + }, + moto: { + type: "boolean", + desc: "Send this attribute if you want to mark the payment as MOTO, must be supported by payment gateway.", + required: "optional, default is 'false'", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "false", + }, + require_capture: { + type: "boolean", + desc: "Send this attribute if you want to require the payment capture before fulfillment.", + required: "optional, deafult is 'true'", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "true", + }, + auto_place: { + type: "boolean", + desc: "Send this attribute if you want to automatically place the order upon authorization performed asynchronously.", + required: "optional, default is 'false'", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "true", + }, + auto_capture: { + type: "boolean", + desc: "Send this attribute if you want to automatically capture the payment upon authorization.", + required: "optional, default is 'false'", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "false", + }, + price_amount_cents: { + type: "integer", + desc: "The payment method's price, in cents.", + required: "required", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "0", + }, + price_amount_float: { + type: "float", + desc: "The payment method's price, float.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + monetizable: true, + example: "0.0", + }, + formatted_price_amount: { + type: "string", + desc: "The payment method's price, formatted.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + monetizable: true, + example: "€0,00", + }, + auto_capture_max_amount_cents: { + type: "integer", + desc: "Send this attribute if you want to limit automatic capture to orders for which the total amount is equal or less than the specified value, in cents.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "0", + }, + auto_capture_max_amount_float: { + type: "float", + desc: "The automatic capture max amount, float.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + monetizable: true, + example: "0.0", + }, + formatted_auto_capture_max_amount: { + type: "string", + desc: "The automatic capture max amount, formatted.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + monetizable: true, + example: "€0,00", + }, + id: { + format: "id", + type: "string", + desc: "Unique identifier for the resource (hash).", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "XAyRWNUzyN", + }, + _disable: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to mark this resource as disabled.", + required: "optional", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + _enable: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to mark this resource as enabled.", + required: "optional", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + disabled_at: { + type: "string", + desc: "Time at which this resource was disabled.", + required: "optional", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + created_at: { + type: "string", + desc: "Time at which the resource was created.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + updated_at: { + type: "string", + desc: "Time at which the resource was last updated.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + reference: { + type: "string", + desc: "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE", + }, + reference_origin: { + type: "string", + desc: "Any identifier of the third party system that defines the reference code.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE-ORIGIN", + }, + metadata: { + type: "object", + desc: "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + monitored: true, + example: { foo: "bar" }, + }, + }, + relationships: { + market: { + type: "has_one", + desc: "The associated market.", + required: "optional", + creatable: true, + updatable: true, + filterable: true, + sortable: true, + parent_resource: "Api::PaymentMethodResource", + class_name: "Market", + }, + payment_gateway: { + type: "has_one", + desc: "The associated payment gateway.", + required: "required", + creatable: true, + updatable: true, + filterable: true, + sortable: false, + parent_resource: "Api::PaymentMethodResource", + class_name: "PaymentGateway", + }, + store: { + type: "has_one", + desc: "The associated store.", + required: "optional", + creatable: true, + updatable: true, + filterable: true, + sortable: true, + parent_resource: "Api::PaymentMethodResource", + class_name: "Store", + }, + attachments: { + type: "has_many", + desc: "The associated attachments.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentMethodResource", + class_name: "Attachment", + }, + event_stores: { + type: "has_many", + desc: "The associated event stores.", + class_name: "EventStore", + creatable: false, + updatable: false, + filterable: false, + sortable: false, + virtual: true, + exportable: false, + includable: false, + parent_resource: "Api::PaymentMethodResource", + }, + }, + filters: [ + "id", + "name", + "payment_source_type", + "currency_code", + "price_amount_cents", + "disabled_at", + "created_at", + "updated_at", + "reference", + "reference_origin", + "metadata", + "q", + "market_id", + "payment_gateway_id", + "store_id", + "attachments_id", + "ids", + "disabled_at_from", + "disabled_at_to", + "created_at_from", + "created_at_to", + "updated_at_from", + "updated_at_to", + ], + parent_resource: null, + }, + }, + { + id: "payment_option", + type: "resources", + attributes: { + singleton: false, + addon: false, + hidden: false, + versions: ["2017-08"], + actions: ["list", "retrieve", "create", "update", "delete"], + examples: {}, + filter_scopes: [], + fields: { + name: { + type: "string", + desc: "The payment option's name. Wehn blank is inherited by payment source type.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "Stripe Payment Option", + }, + payment_source_type: { + type: "string", + desc: "The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'external_payments', 'klarna_payments', 'paypal_payments', 'satispay_payments', 'stripe_payments', or 'wire_transfers'.", + required: "required", + creatable: true, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "stripe_payments", + enum: [ + "adyen_payments", + "axerve_payments", + "braintree_payments", + "checkout_com_payments", + "external_payments", + "klarna_payments", + "paypal_payments", + "satispay_payments", + "stripe_payments", + "wire_transfers", + ], + }, + data: { + type: "object", + desc: "The payment options data to be added to the payment source payload. Check payment specific API for more details.", + required: "required", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + example: { + application_fee_amount: 1000, + on_behalf_of: "pm_xxx", + }, + }, + id: { + format: "id", + type: "string", + desc: "Unique identifier for the resource (hash).", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "XAyRWNUzyN", + }, + created_at: { + type: "string", + desc: "Time at which the resource was created.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + updated_at: { + type: "string", + desc: "Time at which the resource was last updated.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + reference: { + type: "string", + desc: "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE", + }, + reference_origin: { + type: "string", + desc: "Any identifier of the third party system that defines the reference code.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE-ORIGIN", + }, + metadata: { + type: "object", + desc: "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + monitored: true, + example: { foo: "bar" }, + }, + }, + relationships: { + order: { + type: "has_one", + desc: "The order associated to the payment options.", + required: "required", + creatable: true, + updatable: true, + filterable: true, + sortable: true, + parent_resource: "Api::PaymentOptionResource", + class_name: "Order", + }, + attachments: { + type: "has_many", + desc: "The associated attachments.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentOptionResource", + class_name: "Attachment", + }, + event_stores: { + type: "has_many", + desc: "The associated event stores.", + class_name: "EventStore", + creatable: false, + updatable: false, + filterable: false, + sortable: false, + virtual: true, + exportable: false, + includable: false, + parent_resource: "Api::PaymentOptionResource", + }, + }, + filters: [ + "id", + "name", + "payment_source_type", + "data", + "created_at", + "updated_at", + "reference", + "reference_origin", + "metadata", + "q", + "order_id", + "attachments_id", + "ids", + "created_at_from", + "created_at_to", + "updated_at_from", + "updated_at_to", + ], + parent_resource: null, + }, + }, + { + id: "payment_refund", + type: "resources", + attributes: { + singleton: false, + addon: false, + hidden: false, + versions: ["2026-05"], + actions: ["list", "retrieve", "create", "update", "delete"], + examples: {}, + filter_scopes: [], + fields: { + type: { + type: "string", + desc: "The transaction type (authorization, capture, void, refund).", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "payment_authorization", + enum: [ + "payment_authorizations", + "payment_voids", + "payment_captures", + "payment_refunds", + ], + }, + status: { + type: "string", + desc: "The transaction status. One of 'pending' (default), 'requires_action', 'processing', 'succeeded', 'declined', 'failed', 'canceled', or 'expired'.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "draft", + aasm: true, + enum: [ + "pending", + "requires_action", + "processing", + "succeeded", + "declined", + "failed", + "canceled", + "expired", + ], + }, + payment_type: { + type: "string", + desc: "The payment type inherited by the payment session. One of 'ADYEN', 'BRAINTREE', 'CHECKOUT_COM', 'EXTERNAL', 'GIFT_CARD', 'MANUAL', 'PAYPAL', or 'STRIPE'.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "MANUAL", + enum: [ + "ADYEN", + "BRAINTREE", + "CHECKOUT_COM", + "EXTERNAL", + "GIFT_CARD", + "MANUAL", + "PAYPAL", + "STRIPE", + ], + }, + _internal_version: { + type: "string", + trigger: true, + desc: "Send this attribute if you want to force a specific supported internal payload version for this request, overriding the payment setting's configured default. Only usable when the payment setting is internal_versionable.", + creatable: true, + updatable: false, + fetchable: false, + filterable: false, + sortable: false, + example: "V72", + }, + token: { + type: "string", + desc: "The token identifying the transaction, returned by the payment session interaction.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: "xxxx-yyyy-zzzz", + }, + currency_code: { + type: "string", + desc: "The international 3-letter currency code as defined by the ISO 4217 standard.", + required: "optional, default to payment session currency code", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "EUR", + }, + amount_cents: { + type: "integer", + desc: "The payment transacion amount cents collected.", + creatable: true, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: 1000, + }, + amount_float: { + type: "float", + desc: "The payment transaction amount, float.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + monetizable: true, + example: 10.0, + }, + formatted_amount: { + type: "string", + desc: "The payment transaction amount, formatted.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + monetizable: true, + example: "€10,00", + }, + request_data: { + type: "object", + desc: "The data of the request sent to the payment gateway.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: "{}", + }, + response_data: { + type: "object", + desc: "The payment gateway response data, specific to this transaction. Cannot be passed by sales channels.", + prohibited: true, + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: "{}", + }, + options: { + type: "object", + desc: "Options to use for the transaction, the passed values will be used to communicate with the payment gateway. Cannot be passed by sales channels.", + prohibited: true, + creatable: true, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: { cancellation_reason: "fraudulent" }, + }, + requires_action_at: { + type: "string", + desc: "Time at which the transaction is marked as requires_action.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + processing_at: { + type: "string", + desc: "Time at which the transaction has been processed.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + succeeded_at: { + type: "string", + desc: "Time at which the transaction is marked as succeeded.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + declined_at: { + type: "string", + desc: "Time at which the transaction is marked as declined.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + failed_at: { + type: "string", + desc: "Time at which the transaction is marked as failed.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + canceled_at: { + type: "string", + desc: "Time at which the transaction has been cancelled.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + expired_at: { + type: "string", + desc: "Time at which the transaction has been expired.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + id: { + format: "id", + type: "string", + desc: "Unique identifier for the resource (hash).", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "XAyRWNUzyN", + }, + created_at: { + type: "string", + desc: "Time at which the resource was created.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + updated_at: { + type: "string", + desc: "Time at which the resource was last updated.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + reference: { + type: "string", + desc: "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE", + }, + reference_origin: { + type: "string", + desc: "Any identifier of the third party system that defines the reference code.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE-ORIGIN", + }, + metadata: { + type: "object", + desc: "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + monitored: true, + example: { foo: "bar" }, + }, + }, + relationships: { + payment_session: { + type: "has_one", + desc: "The associated payment session.", + required: "required", + creatable: true, + updatable: false, + filterable: true, + sortable: true, + parent_resource: "Api::PaymentTransactionResource", + class_name: "PaymentSession", + }, + order: { + type: "has_one", + desc: "The associated order.", + creatable: false, + updatable: false, + filterable: true, + sortable: false, + parent_resource: "Api::PaymentTransactionResource", + class_name: "Order", + }, + payment_setting: { + type: "has_one", + desc: "The associated payment setting.", + creatable: false, + updatable: false, + filterable: true, + sortable: false, + polymorphic: true, + sti: true, + parent_resource: "Api::PaymentTransactionResource", + class_name: "PaymentSetting", + }, + attachments: { + type: "has_many", + desc: "The associated attachments.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentRefundResource", + class_name: "Attachment", + }, + events: { + type: "has_many", + desc: "The associated events.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentRefundResource", + class_name: "Event", + }, + event_stores: { + type: "has_many", + desc: "The associated event stores.", + class_name: "EventStore", + creatable: false, + updatable: false, + filterable: false, + sortable: false, + virtual: true, + exportable: false, + includable: false, + parent_resource: "Api::PaymentRefundResource", + }, + payment_capture: { + type: "has_one", + desc: "The associated payment capture.", + required: "required", + foreign_key: "reference_transaction_id", + creatable: true, + updatable: false, + filterable: true, + sortable: false, + parent_resource: "Api::PaymentRefundResource", + class_name: "PaymentCapture", + }, + return: { + type: "has_one", + desc: "The associated return.", + required: "optional", + creatable: true, + updatable: false, + filterable: true, + sortable: false, + parent_resource: "Api::PaymentRefundResource", + class_name: "Return", + }, + }, + filters: [ + "id", + "type", + "status", + "payment_type", + "token", + "currency_code", + "amount_cents", + "options", + "requires_action_at", + "processing_at", + "succeeded_at", + "declined_at", + "failed_at", + "canceled_at", + "expired_at", + "created_at", + "updated_at", + "reference", + "reference_origin", + "metadata", + "q", + "payment_session_id", + "order_id", + "payment_setting_id", + "attachments_id", + "events_id", + "payment_capture_id", + "return_id", + "ids", + "requires_action_at_from", + "requires_action_at_to", + "processing_at_from", + "processing_at_to", + "succeeded_at_from", + "succeeded_at_to", + "declined_at_from", + "declined_at_to", + "failed_at_from", + "failed_at_to", + "canceled_at_from", + "canceled_at_to", + "expired_at_from", + "expired_at_to", + "created_at_from", + "created_at_to", + "updated_at_from", + "updated_at_to", + ], + parent_resource: "payment_transaction", + }, + }, + { + id: "payment_rule", + type: "resources", + attributes: { + singleton: false, + addon: false, + hidden: false, + versions: ["2026-05"], + actions: ["list", "retrieve", "create", "update", "delete"], + examples: {}, + filter_scopes: [], + fields: { + template_id: { + type: "string", + desc: "The identifier of the template to be used (UUID).", + required: "required", + creatable: true, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "351af371-4090-43cf-af58-762244e19f9c", + }, + template_settings: { + type: "object", + desc: "The settings for the template used.", + required: "required", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: {}, + }, + expires_at: { + type: "string", + desc: "The expiration date/time of this payment rule.", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "2018-01-02T12:00:00.000Z", + format: "datetime", + }, + id: { + format: "id", + type: "string", + desc: "Unique identifier for the resource (hash).", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "XAyRWNUzyN", + }, + _disable: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to mark this resource as disabled.", + required: "optional", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + _enable: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to mark this resource as enabled.", + required: "optional", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + disabled_at: { + type: "string", + desc: "Time at which this resource was disabled.", + required: "optional", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + created_at: { + type: "string", + desc: "Time at which the resource was created.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + updated_at: { + type: "string", + desc: "Time at which the resource was last updated.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + reference: { + type: "string", + desc: "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE", + }, + reference_origin: { + type: "string", + desc: "Any identifier of the third party system that defines the reference code.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE-ORIGIN", + }, + metadata: { + type: "object", + desc: "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + monitored: true, + example: { foo: "bar" }, + }, + }, + relationships: { + ruleable: { + type: "has_one", + desc: "The polymorphic ruleable resource associated to the rule.", + required: "required", + creatable: true, + updatable: false, + filterable: false, + sortable: false, + polymorphic: true, + eager_load_on_include: false, + parent_resource: "Api::PaymentRuleResource", + class_name: "Ruleable", + enum: ["markets"], + }, + event_stores: { + type: "has_many", + desc: "The associated event stores.", + class_name: "EventStore", + creatable: false, + updatable: false, + filterable: false, + sortable: false, + virtual: true, + exportable: false, + includable: false, + parent_resource: "Api::PaymentRuleResource", + }, + }, + filters: [ + "id", + "template_id", + "disabled_at", + "created_at", + "updated_at", + "reference", + "reference_origin", + "metadata", + "q", + "ids", + "expires_at_from", + "expires_at_to", + "disabled_at_from", + "disabled_at_to", + "created_at_from", + "created_at_to", + "updated_at_from", + "updated_at_to", + ], + parent_resource: "business_rule", + }, + }, + { + id: "payment_session", + type: "resources", + attributes: { + singleton: false, + addon: false, + hidden: false, + versions: ["2026-05"], + actions: ["list", "retrieve", "create", "update", "delete"], + examples: {}, + filter_scopes: [], + fields: { + status: { + type: "string", + desc: "The payment session status. One of 'unpaid' (default), 'authorized', 'voided', 'invalidated', 'paid', 'partially_paid', 'refunded', or 'partially_refunded'.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "unpaid", + aasm: true, + enum: [ + "unpaid", + "authorized", + "voided", + "invalidated", + "paid", + "partially_paid", + "refunded", + "partially_refunded", + ], + }, + amount_cents: { + type: "integer", + desc: "The payment session amount cents to collect, not updatable once the session is created.", + required: + "optional, default to the payment link amount or the order outstanding amount", + creatable: true, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: 1000, + }, + amount_float: { + type: "float", + desc: "The payment session amount, float.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + monetizable: true, + example: 10.0, + }, + formatted_amount: { + type: "string", + desc: "The payment session amount, formatted.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + monetizable: true, + example: "€10,00", + }, + capture_balance_cents: { + type: "integer", + desc: "The payment session amount cents still to be captured.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: 1000, + }, + capture_balance_float: { + type: "float", + desc: "The payment session capture balance, float.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + monetizable: true, + example: 10.0, + }, + formatted_capture_balance: { + type: "string", + desc: "The payment session capture balance, formatted.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + monetizable: true, + example: "€10,00", + }, + refund_balance_cents: { + type: "integer", + desc: "The payment session amount cents still to be refunded.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: 1000, + }, + refund_balance_float: { + type: "float", + desc: "The payment session refund balance, float.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + monetizable: true, + example: 10.0, + }, + formatted_refund_balance: { + type: "string", + desc: "The payment session refund balance, formatted.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + monetizable: true, + example: "€10,00", + }, + percentage_amount_cents: { + type: "float", + desc: "The percentage of the order total (with taxes) covered by this payment session amount.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: 50.0, + }, + currency_code: { + type: "string", + desc: "The currency code for transactions.", + required: + "optional, default to the payment link or order currency code", + creatable: true, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "USD", + }, + gift_card_code: { + type: "string", + desc: "The gift card code to be used in conjunction with a payment setting gift card.", + required: + "optional, but when linked to a PaymentSettingGiftCard", + creatable: true, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "cc92c23e-967e-48b2-a323-59add603301f", + }, + token: { + type: "string", + desc: "The unique token identifying the payment session. Can be specified for some payment gateway. Cannot be passed by sales channels.", + prohibited: true, + required: "optional", + creatable: true, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: "my-order-ref-123", + }, + options: { + type: "object", + desc: "Options to use for the payment session, the passed values will be used to communicate with the payment gateway. Cannot be passed by sales channels.", + prohibited: true, + creatable: true, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: { statement_descriptor: "MY SHOP" }, + }, + vaulting: { + type: "boolean", + desc: "Indicates that the payment instrument used for this session must be stored for future payments. Supported by Adyen, Checkout.com, PayPal, Stripe and external gateways with a token URL.", + required: "optional, default is 'false'", + creatable: true, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: "true", + }, + client_data: { + type: "object", + desc: "The data collected by the client mandatory to complete the payment process.", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "{}", + }, + request_data: { + type: "object", + desc: "The data of the request sent to the payment gateway.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: "{}", + }, + response_data: { + type: "object", + desc: "The payment gateway response data, used by client.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: "{}", + }, + additional_request_data: { + type: "object", + desc: "The data of the request sent to fetch extra information for the payment.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: "{}", + }, + additional_response_data: { + type: "object", + desc: "The response containing the extra information for the payment.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: "{}", + }, + payment_instrument: { + type: "object", + desc: "Information about the payment instrument used in this session.", + required: "optional", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: { issuer: "cl bank", card_type: "visa" }, + }, + _additional_data: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to request additional data for the payment.", + creatable: false, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + _refresh: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to update the payment session with fresh data from the payment gateway.", + creatable: false, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + _internal_version: { + type: "string", + trigger: true, + desc: "Send this attribute if you want to force a specific supported internal payload version for this request, overriding the payment setting's configured default. Only usable when the payment setting is internal_versionable.", + creatable: true, + updatable: false, + fetchable: false, + filterable: false, + sortable: false, + example: "V72", + }, + expires_at: { + type: "string", + desc: "Time at which this payment session will expire. Set automatically from the payment setting's own expiration window when not provided, and left blank only by the settings that have no gateway behind them.", + required: "optional, default depends on the payment setting", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + balance_exceeded_at: { + type: "string", + desc: "Time at which this payment session's authorization was detected to have exceeded the order's remaining balance, if it ever did.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + id: { + format: "id", + type: "string", + desc: "Unique identifier for the resource (hash).", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "XAyRWNUzyN", + }, + created_at: { + type: "string", + desc: "Time at which the resource was created.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + updated_at: { + type: "string", + desc: "Time at which the resource was last updated.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + reference: { + type: "string", + desc: "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE", + }, + reference_origin: { + type: "string", + desc: "Any identifier of the third party system that defines the reference code.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE-ORIGIN", + }, + metadata: { + type: "object", + desc: "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + monitored: true, + example: { foo: "bar" }, + }, + }, + relationships: { + order: { + type: "has_one", + desc: "The associated order.", + creatable: true, + updatable: false, + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSessionResource", + class_name: "Order", + }, + payment_setting: { + type: "has_one", + desc: "The associated payment setting.", + creatable: true, + required: "required", + updatable: false, + filterable: true, + sortable: false, + polymorphic: true, + sti: true, + parent_resource: "Api::PaymentSessionResource", + class_name: "PaymentSetting", + }, + payment_wallet: { + type: "has_one", + desc: "The associated payment wallet.", + creatable: true, + updatable: true, + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSessionResource", + class_name: "PaymentWallet", + }, + payment_transactions: { + type: "has_many", + desc: "The associated payment transactions.", + creatable: false, + updatable: false, + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSessionResource", + class_name: "PaymentTransaction", + }, + payment_authorization: { + type: "has_one", + desc: "The associated payment authorization.", + creatable: false, + updatable: false, + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSessionResource", + class_name: "PaymentAuthorization", + }, + payment_void: { + type: "has_one", + desc: "The associated payment void.", + creatable: false, + updatable: false, + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSessionResource", + class_name: "PaymentVoid", + }, + payment_captures: { + type: "has_many", + desc: "The associated payment captures.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSessionResource", + class_name: "PaymentCapture", + }, + payment_refunds: { + type: "has_many", + desc: "The associated payment refunds.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSessionResource", + class_name: "PaymentRefund", + }, + attachments: { + type: "has_many", + desc: "The associated attachments.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSessionResource", + class_name: "Attachment", + }, + events: { + type: "has_many", + desc: "The associated events.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSessionResource", + class_name: "Event", + }, + event_stores: { + type: "has_many", + desc: "The associated event stores.", + class_name: "EventStore", + creatable: false, + updatable: false, + filterable: false, + sortable: false, + virtual: true, + exportable: false, + includable: false, + parent_resource: "Api::PaymentSessionResource", + }, + }, + filters: [ + "id", + "status", + "amount_cents", + "currency_code", + "gift_card_code", + "token", + "vaulting", + "expires_at", + "balance_exceeded_at", + "created_at", + "updated_at", + "reference", + "reference_origin", + "metadata", + "q", + "order_id", + "payment_setting_id", + "payment_wallet_id", + "payment_transactions_id", + "payment_authorization_id", + "payment_void_id", + "payment_captures_id", + "payment_refunds_id", + "attachments_id", + "events_id", + "ids", + "expires_at_from", + "expires_at_to", + "balance_exceeded_at_from", + "balance_exceeded_at_to", + "created_at_from", + "created_at_to", + "updated_at_from", + "updated_at_to", + ], + parent_resource: null, + }, + }, + { + id: "payment_setting", + type: "resources", + attributes: { + singleton: false, + addon: false, + hidden: false, + versions: ["2026-05"], + actions: ["list", "retrieve"], + examples: {}, + filter_scopes: [], + fields: { + type: { + type: "string", + desc: "The type of payment setting.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: "payment_setting_stripes", + enum: [ + "payment_setting_adyens", + "payment_setting_braintrees", + "payment_setting_checkout_coms", + "payment_setting_externals", + "payment_setting_gift_cards", + "payment_setting_manuals", + "payment_setting_paypals", + "payment_setting_stripes", + ], + }, + gateway_version: { + type: "string", + desc: "The gateway version of the payment setting (external API version).", + required: "optional, default to the last available version", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + example: "2025-09-30.clover", + }, + idempotency_window_mins: { + type: "integer", + desc: "The minutes within which a repeated payment operation is deduplicated by the gateway idempotency key. Later attempts get a fresh key.", + required: "optional, default is one hour (60 minutes)", + default: 60, + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "60", + }, + internal_versions: { + type: "object", + desc: "The internal versions of the payment setting for payload changes.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: { payment_intent: "V1", setup_intent: "V3" }, + }, + internal_versionable: { + type: "boolean", + delegate: "internal_versionable?", + desc: "Indicates whether this payment setting's gateway supports internal payload versioning (see internal_versions).", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: "true", + }, + auto_capture: { + type: "boolean", + desc: "Send this attribute if you want the payment to be automatically captured when authorized.", + default: false, + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + example: "false", + }, + auto_place: { + type: "boolean", + desc: "Send this attribute if you want the order to be automatically placed when a payment session using this payment setting is authorized.", + default: false, + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + example: "false", + }, + name: { + type: "string", + desc: "The name of the payment setting.", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "Stripe", + }, + id: { + format: "id", + type: "string", + desc: "Unique identifier for the resource (hash).", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "XAyRWNUzyN", + }, + _disable: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to mark this resource as disabled.", + required: "optional", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + _enable: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to mark this resource as enabled.", + required: "optional", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + disabled_at: { + type: "string", + desc: "Time at which this resource was disabled.", + required: "optional", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + created_at: { + type: "string", + desc: "Time at which the resource was created.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + updated_at: { + type: "string", + desc: "Time at which the resource was last updated.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + reference: { + type: "string", + desc: "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE", + }, + reference_origin: { + type: "string", + desc: "Any identifier of the third party system that defines the reference code.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE-ORIGIN", + }, + metadata: { + type: "object", + desc: "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + monitored: true, + example: { foo: "bar" }, + }, + }, + relationships: { + payment_links: { + type: "has_many", + desc: "The associated payment links.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentLink", + }, + payment_sessions: { + type: "has_many", + desc: "The associated payment sessions.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentSession", + }, + payment_transactions: { + type: "has_many", + desc: "The payment transactions associated to available sessions.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentTransaction", + }, + payment_wallets: { + type: "has_many", + desc: "The associated payment wallets.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentWallet", + }, + order_subscriptions: { + type: "has_many", + desc: "The associated order subscriptions.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "OrderSubscription", + }, + event_stores: { + type: "has_many", + desc: "The associated event stores.", + class_name: "EventStore", + creatable: false, + updatable: false, + filterable: false, + sortable: false, + virtual: true, + exportable: false, + includable: false, + parent_resource: "Api::PaymentSettingManualResource", + }, + }, + filters: [ + "id", + "type", + "gateway_version", + "internal_versionable", + "auto_capture", + "auto_place", + "name", + "disabled_at", + "created_at", + "updated_at", + "reference", + "reference_origin", + "metadata", + "q", + "payment_links_id", + "payment_sessions_id", + "payment_transactions_id", + "payment_wallets_id", + "order_subscriptions_id", + "ids", + "disabled_at_from", + "disabled_at_to", + "created_at_from", + "created_at_to", + "updated_at_from", + "updated_at_to", + ], + parent_resource: null, + }, + }, + { + id: "payment_setting_adyen", + type: "resources", + attributes: { + singleton: false, + addon: false, + hidden: false, + versions: ["2026-05"], + actions: ["list", "retrieve", "create", "update", "delete"], + examples: {}, + filter_scopes: [], + fields: { + type: { + type: "string", + desc: "The type of payment setting.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: "payment_setting_stripes", + enum: [ + "payment_setting_adyens", + "payment_setting_braintrees", + "payment_setting_checkout_coms", + "payment_setting_externals", + "payment_setting_gift_cards", + "payment_setting_manuals", + "payment_setting_paypals", + "payment_setting_stripes", + ], + }, + gateway_version: { + type: "string", + desc: "The gateway version of the payment setting (external API version).", + required: "optional, default to the last available version", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + example: "2025-09-30.clover", + }, + idempotency_window_mins: { + type: "integer", + desc: "The minutes within which a repeated payment operation is deduplicated by the gateway idempotency key. Later attempts get a fresh key.", + required: "optional, default is one hour (60 minutes)", + default: 60, + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "60", + }, + internal_versions: { + type: "object", + desc: "The internal versions of the payment setting for payload changes.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: { payment_intent: "V1", setup_intent: "V3" }, + }, + internal_versionable: { + type: "boolean", + delegate: "internal_versionable?", + desc: "Indicates whether this payment setting's gateway supports internal payload versioning (see internal_versions).", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: "true", + }, + auto_capture: { + type: "boolean", + desc: "Send this attribute if you want the payment to be automatically captured when authorized.", + default: false, + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + example: "false", + }, + auto_place: { + type: "boolean", + desc: "Send this attribute if you want the order to be automatically placed when a payment session using this payment setting is authorized.", + default: false, + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + example: "false", + }, + name: { + type: "string", + desc: "The name of the payment setting.", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "Stripe", + }, + id: { + format: "id", + type: "string", + desc: "Unique identifier for the resource (hash).", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "XAyRWNUzyN", + }, + _disable: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to mark this resource as disabled.", + required: "optional", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + _enable: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to mark this resource as enabled.", + required: "optional", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + disabled_at: { + type: "string", + desc: "Time at which this resource was disabled.", + required: "optional", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + created_at: { + type: "string", + desc: "Time at which the resource was created.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + updated_at: { + type: "string", + desc: "Time at which the resource was last updated.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + reference: { + type: "string", + desc: "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE", + }, + reference_origin: { + type: "string", + desc: "Any identifier of the third party system that defines the reference code.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE-ORIGIN", + }, + metadata: { + type: "object", + desc: "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + monitored: true, + example: { foo: "bar" }, + }, + _check: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to validate the payment gateway credentials using the gateway’s own APIs.", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + merchant_account: { + type: "string", + desc: "The gateway merchant account.", + required: "required", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: true, + exportable: false, + example: "xxxx-yyyy-zzzz", + }, + api_key: { + type: "string", + desc: "The gateway API key.", + required: "required", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + exportable: false, + example: "xxxx-yyyy-zzzz", + }, + public_key: { + type: "string", + desc: "The public key linked to your API credential.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "xxxx-yyyy-zzzz", + }, + live_url_prefix: { + type: "string", + desc: "The prefix of the endpoint used for live transactions.", + required: "optional, required for production", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "1797a841fbb37ca7-AdyenDemo", + }, + webhook_endpoint_secret: { + type: "string", + desc: "The gateway webhook endpoint secret, generated by Adyen customer area.", + required: "required", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + confidential: true, + example: "xxxx-yyyy-zzzz", + }, + webhook_endpoint_url: { + type: "string", + desc: "The gateway webhook URL, generated automatically.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: + "https://core.commercelayer.co/webhook_callbacks/adyen_gateways/xxxxx", + }, + token_webhook_endpoint_secret: { + type: "string", + desc: "The gateway tokenization webhook endpoint secret, generated by Adyen customer area.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + confidential: true, + example: "xxxx-yyyy-zzzz", + }, + }, + relationships: { + payment_links: { + type: "has_many", + desc: "The associated payment links.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentLink", + }, + payment_sessions: { + type: "has_many", + desc: "The associated payment sessions.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentSession", + }, + payment_transactions: { + type: "has_many", + desc: "The payment transactions associated to available sessions.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentTransaction", + }, + payment_wallets: { + type: "has_many", + desc: "The associated payment wallets.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentWallet", + }, + order_subscriptions: { + type: "has_many", + desc: "The associated order subscriptions.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "OrderSubscription", + }, + event_stores: { + type: "has_many", + desc: "The associated event stores.", + class_name: "EventStore", + creatable: false, + updatable: false, + filterable: false, + sortable: false, + virtual: true, + exportable: false, + includable: false, + parent_resource: "Api::PaymentSettingAdyenResource", + }, + }, + filters: [ + "id", + "type", + "gateway_version", + "internal_versionable", + "auto_capture", + "auto_place", + "name", + "disabled_at", + "created_at", + "updated_at", + "reference", + "reference_origin", + "metadata", + "q", + "payment_links_id", + "payment_sessions_id", + "payment_transactions_id", + "payment_wallets_id", + "order_subscriptions_id", + "ids", + "disabled_at_from", + "disabled_at_to", + "created_at_from", + "created_at_to", + "updated_at_from", + "updated_at_to", + ], + parent_resource: "payment_setting", + }, + }, + { + id: "payment_setting_braintree", + type: "resources", + attributes: { + singleton: false, + addon: false, + hidden: false, + versions: ["2026-05"], + actions: ["list", "retrieve", "create", "update", "delete"], + examples: {}, + filter_scopes: [], + fields: { + type: { + type: "string", + desc: "The type of payment setting.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: "payment_setting_stripes", + enum: [ + "payment_setting_adyens", + "payment_setting_braintrees", + "payment_setting_checkout_coms", + "payment_setting_externals", + "payment_setting_gift_cards", + "payment_setting_manuals", + "payment_setting_paypals", + "payment_setting_stripes", + ], + }, + gateway_version: { + type: "string", + desc: "The gateway version of the payment setting (external API version).", + required: "optional, default to the last available version", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + example: "2025-09-30.clover", + }, + idempotency_window_mins: { + type: "integer", + desc: "The minutes within which a repeated payment operation is deduplicated by the gateway idempotency key. Later attempts get a fresh key.", + required: "optional, default is one hour (60 minutes)", + default: 60, + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "60", + }, + internal_versions: { + type: "object", + desc: "The internal versions of the payment setting for payload changes.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: { payment_intent: "V1", setup_intent: "V3" }, + }, + internal_versionable: { + type: "boolean", + delegate: "internal_versionable?", + desc: "Indicates whether this payment setting's gateway supports internal payload versioning (see internal_versions).", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: "true", + }, + auto_capture: { + type: "boolean", + desc: "Send this attribute if you want the payment to be automatically captured when authorized.", + default: false, + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + example: "false", + }, + auto_place: { + type: "boolean", + desc: "Send this attribute if you want the order to be automatically placed when a payment session using this payment setting is authorized.", + default: false, + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + example: "false", + }, + name: { + type: "string", + desc: "The name of the payment setting.", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "Stripe", + }, + id: { + format: "id", + type: "string", + desc: "Unique identifier for the resource (hash).", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "XAyRWNUzyN", + }, + _disable: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to mark this resource as disabled.", + required: "optional", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + _enable: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to mark this resource as enabled.", + required: "optional", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + disabled_at: { + type: "string", + desc: "Time at which this resource was disabled.", + required: "optional", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + created_at: { + type: "string", + desc: "Time at which the resource was created.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + updated_at: { + type: "string", + desc: "Time at which the resource was last updated.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + reference: { + type: "string", + desc: "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE", + }, + reference_origin: { + type: "string", + desc: "Any identifier of the third party system that defines the reference code.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE-ORIGIN", + }, + metadata: { + type: "object", + desc: "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + monitored: true, + example: { foo: "bar" }, + }, + _check: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to validate the payment gateway credentials using the gateway’s own APIs.", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + merchant_id: { + type: "string", + desc: "The gateway merchant ID.", + required: "required", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + exportable: false, + example: "xxxx-yyyy-zzzz", + }, + public_key: { + type: "string", + desc: "The gateway public key.", + required: "required", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + exportable: false, + example: "xxxx-yyyy-zzzz", + }, + private_key: { + type: "string", + desc: "The gateway private key.", + required: "required", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + exportable: false, + example: "xxxx-yyyy-zzzz", + }, + merchant_account_id: { + type: "string", + desc: "The gateway merchant account ID, used to route transactions to the correct sub-account.", + required: "required", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + exportable: false, + example: "xxxx-yyyy-zzzz", + }, + webhook_endpoint_url: { + type: "string", + desc: "The gateway webhook URL to configure manually in the Braintree Control Panel.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: + "https://core.commercelayer.co/webhook_callbacks/payment_setting_braintrees/xxxxx", + }, + }, + relationships: { + payment_links: { + type: "has_many", + desc: "The associated payment links.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentLink", + }, + payment_sessions: { + type: "has_many", + desc: "The associated payment sessions.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentSession", + }, + payment_transactions: { + type: "has_many", + desc: "The payment transactions associated to available sessions.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentTransaction", + }, + payment_wallets: { + type: "has_many", + desc: "The associated payment wallets.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentWallet", + }, + order_subscriptions: { + type: "has_many", + desc: "The associated order subscriptions.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "OrderSubscription", + }, + event_stores: { + type: "has_many", + desc: "The associated event stores.", + class_name: "EventStore", + creatable: false, + updatable: false, + filterable: false, + sortable: false, + virtual: true, + exportable: false, + includable: false, + parent_resource: "Api::PaymentSettingBraintreeResource", + }, + }, + filters: [ + "id", + "type", + "gateway_version", + "internal_versionable", + "auto_capture", + "auto_place", + "name", + "disabled_at", + "created_at", + "updated_at", + "reference", + "reference_origin", + "metadata", + "q", + "payment_links_id", + "payment_sessions_id", + "payment_transactions_id", + "payment_wallets_id", + "order_subscriptions_id", + "ids", + "disabled_at_from", + "disabled_at_to", + "created_at_from", + "created_at_to", + "updated_at_from", + "updated_at_to", + ], + parent_resource: "payment_setting", + }, + }, + { + id: "payment_setting_checkout_com", + type: "resources", + attributes: { + singleton: false, + addon: false, + hidden: false, + versions: ["2026-05"], + actions: ["list", "retrieve", "create", "update", "delete"], + examples: {}, + filter_scopes: [], + fields: { + type: { + type: "string", + desc: "The type of payment setting.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: "payment_setting_stripes", + enum: [ + "payment_setting_adyens", + "payment_setting_braintrees", + "payment_setting_checkout_coms", + "payment_setting_externals", + "payment_setting_gift_cards", + "payment_setting_manuals", + "payment_setting_paypals", + "payment_setting_stripes", + ], + }, + gateway_version: { + type: "string", + desc: "The gateway version of the payment setting (external API version).", + required: "optional, default to the last available version", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + example: "2025-09-30.clover", + }, + idempotency_window_mins: { + type: "integer", + desc: "The minutes within which a repeated payment operation is deduplicated by the gateway idempotency key. Later attempts get a fresh key.", + required: "optional, default is one hour (60 minutes)", + default: 60, + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "60", + }, + internal_versions: { + type: "object", + desc: "The internal versions of the payment setting for payload changes.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: { payment_intent: "V1", setup_intent: "V3" }, + }, + internal_versionable: { + type: "boolean", + delegate: "internal_versionable?", + desc: "Indicates whether this payment setting's gateway supports internal payload versioning (see internal_versions).", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: "true", + }, + auto_capture: { + type: "boolean", + desc: "Send this attribute if you want the payment to be automatically captured when authorized.", + default: false, + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + example: "false", + }, + auto_place: { + type: "boolean", + desc: "Send this attribute if you want the order to be automatically placed when a payment session using this payment setting is authorized.", + default: false, + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + example: "false", + }, + name: { + type: "string", + desc: "The name of the payment setting.", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "Stripe", + }, + id: { + format: "id", + type: "string", + desc: "Unique identifier for the resource (hash).", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "XAyRWNUzyN", + }, + _disable: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to mark this resource as disabled.", + required: "optional", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + _enable: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to mark this resource as enabled.", + required: "optional", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + disabled_at: { + type: "string", + desc: "Time at which this resource was disabled.", + required: "optional", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + created_at: { + type: "string", + desc: "Time at which the resource was created.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + updated_at: { + type: "string", + desc: "Time at which the resource was last updated.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + reference: { + type: "string", + desc: "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE", + }, + reference_origin: { + type: "string", + desc: "Any identifier of the third party system that defines the reference code.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE-ORIGIN", + }, + metadata: { + type: "object", + desc: "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + monitored: true, + example: { foo: "bar" }, + }, + _check: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to validate the payment gateway credentials using the gateway’s own APIs.", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + secret_key: { + type: "string", + desc: "The gateway secret key.", + required: "required", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + exportable: false, + confidential: true, + example: "sk_xxxxxxxx", + }, + public_key: { + type: "string", + desc: "The gateway public key.", + required: "required", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + exportable: false, + example: "pk_xxxxxxxx", + }, + webhook_endpoint_id: { + type: "string", + desc: "The gateway webhook (workflow) ID, generated automatically.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: "wf_xxxxxxxx", + }, + webhook_endpoint_secret: { + type: "string", + desc: "The gateway webhook signing secret, generated automatically.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + exportable: false, + confidential: true, + example: "xxxxxxxxxxxxxxxx", + }, + webhook_endpoint_url: { + type: "string", + desc: "The gateway webhook URL, generated automatically.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: + "https://core.commercelayer.co/webhook_callbacks/payment_setting_checkout_coms/xxxxx", + }, + }, + relationships: { + payment_links: { + type: "has_many", + desc: "The associated payment links.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentLink", + }, + payment_sessions: { + type: "has_many", + desc: "The associated payment sessions.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentSession", + }, + payment_transactions: { + type: "has_many", + desc: "The payment transactions associated to available sessions.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentTransaction", + }, + payment_wallets: { + type: "has_many", + desc: "The associated payment wallets.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentWallet", + }, + order_subscriptions: { + type: "has_many", + desc: "The associated order subscriptions.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "OrderSubscription", + }, + event_stores: { + type: "has_many", + desc: "The associated event stores.", + class_name: "EventStore", + creatable: false, + updatable: false, + filterable: false, + sortable: false, + virtual: true, + exportable: false, + includable: false, + parent_resource: "Api::PaymentSettingCheckoutComResource", + }, + }, + filters: [ + "id", + "type", + "gateway_version", + "internal_versionable", + "auto_capture", + "auto_place", + "name", + "disabled_at", + "created_at", + "updated_at", + "reference", + "reference_origin", + "metadata", + "q", + "payment_links_id", + "payment_sessions_id", + "payment_transactions_id", + "payment_wallets_id", + "order_subscriptions_id", + "ids", + "disabled_at_from", + "disabled_at_to", + "created_at_from", + "created_at_to", + "updated_at_from", + "updated_at_to", + ], + parent_resource: "payment_setting", + }, + }, + { + id: "payment_setting_external", + type: "resources", + attributes: { + singleton: false, + addon: false, + hidden: false, + versions: ["2026-05"], + actions: ["list", "retrieve", "create", "update", "delete"], + examples: {}, + filter_scopes: [], + fields: { + type: { + type: "string", + desc: "The type of payment setting.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: "payment_setting_stripes", + enum: [ + "payment_setting_adyens", + "payment_setting_braintrees", + "payment_setting_checkout_coms", + "payment_setting_externals", + "payment_setting_gift_cards", + "payment_setting_manuals", + "payment_setting_paypals", + "payment_setting_stripes", + ], + }, + gateway_version: { + type: "string", + desc: "The gateway version of the payment setting (external API version).", + required: "optional, default to the last available version", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + example: "2025-09-30.clover", + }, + idempotency_window_mins: { + type: "integer", + desc: "The minutes within which a repeated payment operation is deduplicated by the gateway idempotency key. Later attempts get a fresh key.", + required: "optional, default is one hour (60 minutes)", + default: 60, + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "60", + }, + internal_versions: { + type: "object", + desc: "The internal versions of the payment setting for payload changes.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: { payment_intent: "V1", setup_intent: "V3" }, + }, + internal_versionable: { + type: "boolean", + delegate: "internal_versionable?", + desc: "Indicates whether this payment setting's gateway supports internal payload versioning (see internal_versions).", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: "true", + }, + auto_capture: { + type: "boolean", + desc: "Send this attribute if you want the payment to be automatically captured when authorized.", + default: false, + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + example: "false", + }, + auto_place: { + type: "boolean", + desc: "Send this attribute if you want the order to be automatically placed when a payment session using this payment setting is authorized.", + default: false, + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + example: "false", + }, + name: { + type: "string", + desc: "The name of the payment setting.", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "Stripe", + }, + id: { + format: "id", + type: "string", + desc: "Unique identifier for the resource (hash).", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "XAyRWNUzyN", + }, + _disable: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to mark this resource as disabled.", + required: "optional", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + _enable: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to mark this resource as enabled.", + required: "optional", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + disabled_at: { + type: "string", + desc: "Time at which this resource was disabled.", + required: "optional", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + created_at: { + type: "string", + desc: "Time at which the resource was created.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + updated_at: { + type: "string", + desc: "Time at which the resource was last updated.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + reference: { + type: "string", + desc: "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE", + }, + reference_origin: { + type: "string", + desc: "Any identifier of the third party system that defines the reference code.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE-ORIGIN", + }, + metadata: { + type: "object", + desc: "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + monitored: true, + example: { foo: "bar" }, + }, + circuit_state: { + type: "string", + desc: "The circuit breaker state, by default it is 'closed'. It can become 'open' once the number of consecutive failures overlaps the specified threshold, in such case no further calls to the failing callback are made.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + transient: true, + example: "closed", + }, + circuit_failure_count: { + type: "integer", + desc: "The number of consecutive failures recorded by the circuit breaker associated to this resource, will be reset on first successful call to callback.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + transient: true, + example: "5", + }, + _reset_circuit: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels.", + prohibited: true, + creatable: false, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + shared_secret: { + type: "string", + desc: "The shared secret used to sign the external request payload.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + exportable: false, + confidential: true, + example: "1c0994cc4e996e8c6ee56a2198f66f3c", + }, + _regenerate_shared_secret: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to regenerate the shared secret.", + creatable: false, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + versions: ["2017-08"], + }, + external_includes: { + type: "array", + desc: "List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.", + required: "optional, default to resource specific list", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + visibility: "skip_example", + sortable: false, + exportable: false, + example: ["order.line_item_options"], + }, + session_url: { + type: "string", + desc: "The endpoint used by the external gateway to create a payment session.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "https://external_gateway.com/session", + }, + authorization_url: { + type: "string", + desc: "The endpoint used by the external gateway to authorize payments. The response data can include a payment_instrument object (issuer, issuer_type, card_type, card_last_digits, card_expiry_month, card_expiry_year, card_holder_name, card_fingerprint, account_id, account_email, account_status) to populate the payment session's payment instrument; other keys are ignored.", + required: "required", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "https://external_gateway.com/authorization", + }, + capture_url: { + type: "string", + desc: "The endpoint used by the external gateway to capture payments.", + required: "required", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "https://external_gateway.com/capture", + }, + void_url: { + type: "string", + desc: "The endpoint used by the external gateway to void payments.", + required: "required", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "https://external_gateway.com/void", + }, + refund_url: { + type: "string", + desc: "The endpoint used by the external gateway to refund payments.", + required: "required", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "https://external_gateway.com/refund", + }, + token_url: { + type: "string", + desc: "The endpoint used by the external gateway to create a customer payment token.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "https://external_gateway.com/token", + }, + webhook_endpoint_url: { + type: "string", + desc: "The gateway webhook URL, generated automatically.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: + "https://core.commercelayer.io/webhook_callbacks/payment_setting_externals/xxxxx", + }, + }, + relationships: { + payment_links: { + type: "has_many", + desc: "The associated payment links.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentLink", + }, + payment_sessions: { + type: "has_many", + desc: "The associated payment sessions.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentSession", + }, + payment_transactions: { + type: "has_many", + desc: "The payment transactions associated to available sessions.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentTransaction", + }, + payment_wallets: { + type: "has_many", + desc: "The associated payment wallets.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentWallet", + }, + order_subscriptions: { + type: "has_many", + desc: "The associated order subscriptions.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "OrderSubscription", + }, + event_stores: { + type: "has_many", + desc: "The associated event stores.", + class_name: "EventStore", + creatable: false, + updatable: false, + filterable: false, + sortable: false, + virtual: true, + exportable: false, + includable: false, + parent_resource: "Api::PaymentSettingExternalResource", + }, + }, + filters: [ + "id", + "type", + "gateway_version", + "internal_versionable", + "auto_capture", + "auto_place", + "name", + "disabled_at", + "created_at", + "updated_at", + "reference", + "reference_origin", + "metadata", + "circuit_state", + "circuit_failure_count", + "q", + "payment_links_id", + "payment_sessions_id", + "payment_transactions_id", + "payment_wallets_id", + "order_subscriptions_id", + "ids", + "disabled_at_from", + "disabled_at_to", + "created_at_from", + "created_at_to", + "updated_at_from", + "updated_at_to", + ], + parent_resource: "payment_setting", + }, + }, + { + id: "payment_setting_gift_card", + type: "resources", + attributes: { + singleton: false, + addon: false, + hidden: false, + versions: ["2026-05"], + actions: ["list", "retrieve", "create", "update", "delete"], + examples: {}, + filter_scopes: [], + fields: { + type: { + type: "string", + desc: "The type of payment setting.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: "payment_setting_stripes", + enum: [ + "payment_setting_adyens", + "payment_setting_braintrees", + "payment_setting_checkout_coms", + "payment_setting_externals", + "payment_setting_gift_cards", + "payment_setting_manuals", + "payment_setting_paypals", + "payment_setting_stripes", + ], + }, + gateway_version: { + type: "string", + desc: "The gateway version of the payment setting (external API version).", + required: "optional, default to the last available version", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + example: "2025-09-30.clover", + }, + idempotency_window_mins: { + type: "integer", + desc: "The minutes within which a repeated payment operation is deduplicated by the gateway idempotency key. Later attempts get a fresh key.", + required: "optional, default is one hour (60 minutes)", + default: 60, + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "60", + }, + internal_versions: { + type: "object", + desc: "The internal versions of the payment setting for payload changes.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: { payment_intent: "V1", setup_intent: "V3" }, + }, + internal_versionable: { + type: "boolean", + delegate: "internal_versionable?", + desc: "Indicates whether this payment setting's gateway supports internal payload versioning (see internal_versions).", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: "true", + }, + auto_capture: { + type: "boolean", + desc: "Send this attribute if you want the payment to be automatically captured when authorized.", + default: false, + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + example: "false", + }, + auto_place: { + type: "boolean", + desc: "Send this attribute if you want the order to be automatically placed when a payment session using this payment setting is authorized.", + default: false, + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + example: "false", + }, + name: { + type: "string", + desc: "The name of the payment setting.", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "Stripe", + }, + id: { + format: "id", + type: "string", + desc: "Unique identifier for the resource (hash).", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "XAyRWNUzyN", + }, + _disable: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to mark this resource as disabled.", + required: "optional", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + _enable: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to mark this resource as enabled.", + required: "optional", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + disabled_at: { + type: "string", + desc: "Time at which this resource was disabled.", + required: "optional", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + created_at: { + type: "string", + desc: "Time at which the resource was created.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + updated_at: { + type: "string", + desc: "Time at which the resource was last updated.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + reference: { + type: "string", + desc: "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE", + }, + reference_origin: { + type: "string", + desc: "Any identifier of the third party system that defines the reference code.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE-ORIGIN", + }, + metadata: { + type: "object", + desc: "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + monitored: true, + example: { foo: "bar" }, + }, + }, + relationships: { + payment_links: { + type: "has_many", + desc: "The associated payment links.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentLink", + }, + payment_sessions: { + type: "has_many", + desc: "The associated payment sessions.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentSession", + }, + payment_transactions: { + type: "has_many", + desc: "The payment transactions associated to available sessions.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentTransaction", + }, + payment_wallets: { + type: "has_many", + desc: "The associated payment wallets.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentWallet", + }, + order_subscriptions: { + type: "has_many", + desc: "The associated order subscriptions.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "OrderSubscription", + }, + event_stores: { + type: "has_many", + desc: "The associated event stores.", + class_name: "EventStore", + creatable: false, + updatable: false, + filterable: false, + sortable: false, + virtual: true, + exportable: false, + includable: false, + parent_resource: "Api::PaymentSettingManualResource", + }, + }, + filters: [ + "id", + "type", + "gateway_version", + "internal_versionable", + "auto_capture", + "auto_place", + "name", + "disabled_at", + "created_at", + "updated_at", + "reference", + "reference_origin", + "metadata", + "q", + "payment_links_id", + "payment_sessions_id", + "payment_transactions_id", + "payment_wallets_id", + "order_subscriptions_id", + "ids", + "disabled_at_from", + "disabled_at_to", + "created_at_from", + "created_at_to", + "updated_at_from", + "updated_at_to", + ], + parent_resource: "payment_setting", + }, + }, + { + id: "payment_setting_manual", + type: "resources", + attributes: { + singleton: false, + addon: false, + hidden: false, + versions: ["2026-05"], + actions: ["list", "retrieve", "create", "update", "delete"], + examples: {}, + filter_scopes: [], + fields: { + type: { + type: "string", + desc: "The type of payment setting.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: "payment_setting_stripes", + enum: [ + "payment_setting_adyens", + "payment_setting_braintrees", + "payment_setting_checkout_coms", + "payment_setting_externals", + "payment_setting_gift_cards", + "payment_setting_manuals", + "payment_setting_paypals", + "payment_setting_stripes", + ], + }, + gateway_version: { + type: "string", + desc: "The gateway version of the payment setting (external API version).", + required: "optional, default to the last available version", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + example: "2025-09-30.clover", + }, + idempotency_window_mins: { + type: "integer", + desc: "The minutes within which a repeated payment operation is deduplicated by the gateway idempotency key. Later attempts get a fresh key.", + required: "optional, default is one hour (60 minutes)", + default: 60, + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "60", + }, + internal_versions: { + type: "object", + desc: "The internal versions of the payment setting for payload changes.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: { payment_intent: "V1", setup_intent: "V3" }, + }, + internal_versionable: { + type: "boolean", + delegate: "internal_versionable?", + desc: "Indicates whether this payment setting's gateway supports internal payload versioning (see internal_versions).", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: "true", + }, + auto_capture: { + type: "boolean", + desc: "Send this attribute if you want the payment to be automatically captured when authorized.", + default: false, + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + example: "false", + }, + auto_place: { + type: "boolean", + desc: "Send this attribute if you want the order to be automatically placed when a payment session using this payment setting is authorized.", + default: false, + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + example: "false", + }, + name: { + type: "string", + desc: "The name of the payment setting.", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "Stripe", + }, + id: { + format: "id", + type: "string", + desc: "Unique identifier for the resource (hash).", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "XAyRWNUzyN", + }, + _disable: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to mark this resource as disabled.", + required: "optional", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + _enable: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to mark this resource as enabled.", + required: "optional", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + disabled_at: { + type: "string", + desc: "Time at which this resource was disabled.", + required: "optional", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + created_at: { + type: "string", + desc: "Time at which the resource was created.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + updated_at: { + type: "string", + desc: "Time at which the resource was last updated.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + reference: { + type: "string", + desc: "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE", + }, + reference_origin: { + type: "string", + desc: "Any identifier of the third party system that defines the reference code.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE-ORIGIN", + }, + metadata: { + type: "object", + desc: "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + monitored: true, + example: { foo: "bar" }, + }, + }, + relationships: { + payment_links: { + type: "has_many", + desc: "The associated payment links.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentLink", + }, + payment_sessions: { + type: "has_many", + desc: "The associated payment sessions.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentSession", + }, + payment_transactions: { + type: "has_many", + desc: "The payment transactions associated to available sessions.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentTransaction", + }, + payment_wallets: { + type: "has_many", + desc: "The associated payment wallets.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentWallet", + }, + order_subscriptions: { + type: "has_many", + desc: "The associated order subscriptions.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "OrderSubscription", + }, + event_stores: { + type: "has_many", + desc: "The associated event stores.", + class_name: "EventStore", + creatable: false, + updatable: false, + filterable: false, + sortable: false, + virtual: true, + exportable: false, + includable: false, + parent_resource: "Api::PaymentSettingManualResource", + }, + }, + filters: [ + "id", + "type", + "gateway_version", + "internal_versionable", + "auto_capture", + "auto_place", + "name", + "disabled_at", + "created_at", + "updated_at", + "reference", + "reference_origin", + "metadata", + "q", + "payment_links_id", + "payment_sessions_id", + "payment_transactions_id", + "payment_wallets_id", + "order_subscriptions_id", + "ids", + "disabled_at_from", + "disabled_at_to", + "created_at_from", + "created_at_to", + "updated_at_from", + "updated_at_to", + ], + parent_resource: "payment_setting", + }, + }, + { + id: "payment_setting_paypal", + type: "resources", + attributes: { + singleton: false, + addon: false, + hidden: false, + versions: ["2026-05"], + actions: ["list", "retrieve", "create", "update", "delete"], + examples: {}, + filter_scopes: [], + fields: { + type: { + type: "string", + desc: "The type of payment setting.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: "payment_setting_stripes", + enum: [ + "payment_setting_adyens", + "payment_setting_braintrees", + "payment_setting_checkout_coms", + "payment_setting_externals", + "payment_setting_gift_cards", + "payment_setting_manuals", + "payment_setting_paypals", + "payment_setting_stripes", + ], + }, + gateway_version: { + type: "string", + desc: "The gateway version of the payment setting (external API version).", + required: "optional, default to the last available version", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + example: "2025-09-30.clover", + }, + idempotency_window_mins: { + type: "integer", + desc: "The minutes within which a repeated payment operation is deduplicated by the gateway idempotency key. Later attempts get a fresh key.", + required: "optional, default is one hour (60 minutes)", + default: 60, + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "60", + }, + internal_versions: { + type: "object", + desc: "The internal versions of the payment setting for payload changes.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: { payment_intent: "V1", setup_intent: "V3" }, + }, + internal_versionable: { + type: "boolean", + delegate: "internal_versionable?", + desc: "Indicates whether this payment setting's gateway supports internal payload versioning (see internal_versions).", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: "true", + }, + auto_capture: { + type: "boolean", + desc: "Send this attribute if you want the payment to be automatically captured when authorized.", + default: false, + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + example: "false", + }, + auto_place: { + type: "boolean", + desc: "Send this attribute if you want the order to be automatically placed when a payment session using this payment setting is authorized.", + default: false, + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + example: "false", + }, + name: { + type: "string", + desc: "The name of the payment setting.", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "Stripe", + }, + id: { + format: "id", + type: "string", + desc: "Unique identifier for the resource (hash).", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "XAyRWNUzyN", + }, + _disable: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to mark this resource as disabled.", + required: "optional", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + _enable: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to mark this resource as enabled.", + required: "optional", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + disabled_at: { + type: "string", + desc: "Time at which this resource was disabled.", + required: "optional", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + created_at: { + type: "string", + desc: "Time at which the resource was created.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + updated_at: { + type: "string", + desc: "Time at which the resource was last updated.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + reference: { + type: "string", + desc: "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE", + }, + reference_origin: { + type: "string", + desc: "Any identifier of the third party system that defines the reference code.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE-ORIGIN", + }, + metadata: { + type: "object", + desc: "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + monitored: true, + example: { foo: "bar" }, + }, + _check: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to validate the payment gateway credentials using the gateway’s own APIs.", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + client_id: { + type: "string", + desc: "The gateway client ID.", + required: "required", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + exportable: false, + example: "xxxx-yyyy-zzzz", + }, + client_secret: { + type: "string", + desc: "The gateway client secret.", + required: "required", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + exportable: false, + confidential: true, + example: "xxxx-yyyy-zzzz", + }, + webhook_id: { + type: "string", + desc: "The gateway webhook ID, generated automatically.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: "xxxx-yyyy-zzzz", + }, + webhook_endpoint_url: { + type: "string", + desc: "The gateway webhook URL, generated automatically.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: + "https://core.commercelayer.co/webhook_callbacks/payment_setting_paypals/xxxxx", + }, + }, + relationships: { + payment_links: { + type: "has_many", + desc: "The associated payment links.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentLink", + }, + payment_sessions: { + type: "has_many", + desc: "The associated payment sessions.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentSession", + }, + payment_transactions: { + type: "has_many", + desc: "The payment transactions associated to available sessions.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentTransaction", + }, + payment_wallets: { + type: "has_many", + desc: "The associated payment wallets.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentWallet", + }, + order_subscriptions: { + type: "has_many", + desc: "The associated order subscriptions.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "OrderSubscription", + }, + event_stores: { + type: "has_many", + desc: "The associated event stores.", + class_name: "EventStore", + creatable: false, + updatable: false, + filterable: false, + sortable: false, + virtual: true, + exportable: false, + includable: false, + parent_resource: "Api::PaymentSettingPaypalResource", + }, + }, + filters: [ + "id", + "type", + "gateway_version", + "internal_versionable", + "auto_capture", + "auto_place", + "name", + "disabled_at", + "created_at", + "updated_at", + "reference", + "reference_origin", + "metadata", + "q", + "payment_links_id", + "payment_sessions_id", + "payment_transactions_id", + "payment_wallets_id", + "order_subscriptions_id", + "ids", + "disabled_at_from", + "disabled_at_to", + "created_at_from", + "created_at_to", + "updated_at_from", + "updated_at_to", + ], + parent_resource: "payment_setting", + }, + }, + { + id: "payment_setting_stripe", + type: "resources", + attributes: { + singleton: false, + addon: false, + hidden: false, + versions: ["2026-05"], + actions: ["list", "retrieve", "create", "update", "delete"], + examples: {}, + filter_scopes: [], + fields: { + type: { + type: "string", + desc: "The type of payment setting.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: "payment_setting_stripes", + enum: [ + "payment_setting_adyens", + "payment_setting_braintrees", + "payment_setting_checkout_coms", + "payment_setting_externals", + "payment_setting_gift_cards", + "payment_setting_manuals", + "payment_setting_paypals", + "payment_setting_stripes", + ], + }, + gateway_version: { + type: "string", + desc: "The gateway version of the payment setting (external API version).", + required: "optional, default to the last available version", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + example: "2025-09-30.clover", + }, + idempotency_window_mins: { + type: "integer", + desc: "The minutes within which a repeated payment operation is deduplicated by the gateway idempotency key. Later attempts get a fresh key.", + required: "optional, default is one hour (60 minutes)", + default: 60, + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "60", + }, + internal_versions: { + type: "object", + desc: "The internal versions of the payment setting for payload changes.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: { payment_intent: "V1", setup_intent: "V3" }, + }, + internal_versionable: { + type: "boolean", + delegate: "internal_versionable?", + desc: "Indicates whether this payment setting's gateway supports internal payload versioning (see internal_versions).", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: "true", + }, + auto_capture: { + type: "boolean", + desc: "Send this attribute if you want the payment to be automatically captured when authorized.", + default: false, + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + example: "false", + }, + auto_place: { + type: "boolean", + desc: "Send this attribute if you want the order to be automatically placed when a payment session using this payment setting is authorized.", + default: false, + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + example: "false", + }, + name: { + type: "string", + desc: "The name of the payment setting.", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "Stripe", + }, + id: { + format: "id", + type: "string", + desc: "Unique identifier for the resource (hash).", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "XAyRWNUzyN", + }, + _disable: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to mark this resource as disabled.", + required: "optional", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + _enable: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to mark this resource as enabled.", + required: "optional", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + disabled_at: { + type: "string", + desc: "Time at which this resource was disabled.", + required: "optional", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + created_at: { + type: "string", + desc: "Time at which the resource was created.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + updated_at: { + type: "string", + desc: "Time at which the resource was last updated.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + reference: { + type: "string", + desc: "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE", + }, + reference_origin: { + type: "string", + desc: "Any identifier of the third party system that defines the reference code.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE-ORIGIN", + }, + metadata: { + type: "object", + desc: "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + monitored: true, + example: { foo: "bar" }, + }, + _check: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to validate the payment gateway credentials using the gateway’s own APIs.", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + api_key: { + type: "string", + desc: "The gateway secure API key.", + required: "required", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + exportable: false, + example: "sk_live_xxxx-yyyy-zzzz", + }, + public_key: { + type: "string", + desc: "The gateway public API key.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "pk_live_xxxx-yyyy-zzzz", + }, + connected_account: { + type: "string", + desc: "The account (if any) for which the funds of the PaymentIntent are intended.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "acct_xxxx-yyyy-zzzz", + }, + webhook_endpoint_id: { + type: "string", + desc: "The gateway webhook endpoint ID, generated automatically.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: "xxxx-yyyy-zzzz", + }, + webhook_endpoint_secret: { + type: "string", + desc: "The gateway webhook endpoint secret, generated automatically.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + confidential: true, + exportable: false, + example: "xxxx-yyyy-zzzz", + }, + webhook_endpoint_url: { + type: "string", + desc: "The gateway webhook URL, generated automatically.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: + "https://core.commercelayer.co/webhook_callbacks/payment_setting_stripes/xxxxx", + }, + }, + relationships: { + payment_links: { + type: "has_many", + desc: "The associated payment links.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentLink", + }, + payment_sessions: { + type: "has_many", + desc: "The associated payment sessions.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentSession", + }, + payment_transactions: { + type: "has_many", + desc: "The payment transactions associated to available sessions.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentTransaction", + }, + payment_wallets: { + type: "has_many", + desc: "The associated payment wallets.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "PaymentWallet", + }, + order_subscriptions: { + type: "has_many", + desc: "The associated order subscriptions.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentSettingStripeResource", + class_name: "OrderSubscription", + }, + event_stores: { + type: "has_many", + desc: "The associated event stores.", + class_name: "EventStore", + creatable: false, + updatable: false, + filterable: false, + sortable: false, + virtual: true, + exportable: false, + includable: false, + parent_resource: "Api::PaymentSettingStripeResource", + }, + }, + filters: [ + "id", + "type", + "gateway_version", + "internal_versionable", + "auto_capture", + "auto_place", + "name", + "disabled_at", + "created_at", + "updated_at", + "reference", + "reference_origin", + "metadata", + "q", + "payment_links_id", + "payment_sessions_id", + "payment_transactions_id", + "payment_wallets_id", + "order_subscriptions_id", + "ids", + "disabled_at_from", + "disabled_at_to", + "created_at_from", + "created_at_to", + "updated_at_from", + "updated_at_to", + ], + parent_resource: "payment_setting", + }, + }, + { + id: "payment_transaction", + type: "resources", + attributes: { + singleton: false, + addon: false, + hidden: false, + versions: ["2026-05"], + actions: ["list", "retrieve"], + examples: {}, + filter_scopes: [], + fields: { + type: { + type: "string", + desc: "The transaction type (authorization, capture, void, refund).", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "payment_authorization", + enum: [ + "payment_authorizations", + "payment_voids", + "payment_captures", + "payment_refunds", + ], + }, + status: { + type: "string", + desc: "The transaction status. One of 'pending' (default), 'requires_action', 'processing', 'succeeded', 'declined', 'failed', 'canceled', or 'expired'.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "draft", + aasm: true, + enum: [ + "pending", + "requires_action", + "processing", + "succeeded", + "declined", + "failed", + "canceled", + "expired", + ], + }, + payment_type: { + type: "string", + desc: "The payment type inherited by the payment session. One of 'ADYEN', 'BRAINTREE', 'CHECKOUT_COM', 'EXTERNAL', 'GIFT_CARD', 'MANUAL', 'PAYPAL', or 'STRIPE'.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "MANUAL", + enum: [ + "ADYEN", + "BRAINTREE", + "CHECKOUT_COM", + "EXTERNAL", + "GIFT_CARD", + "MANUAL", + "PAYPAL", + "STRIPE", + ], + }, + _internal_version: { + type: "string", + trigger: true, + desc: "Send this attribute if you want to force a specific supported internal payload version for this request, overriding the payment setting's configured default. Only usable when the payment setting is internal_versionable.", + creatable: true, + updatable: false, + fetchable: false, + filterable: false, + sortable: false, + example: "V72", + }, + token: { + type: "string", + desc: "The token identifying the transaction, returned by the payment session interaction.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: "xxxx-yyyy-zzzz", + }, + currency_code: { + type: "string", + desc: "The international 3-letter currency code as defined by the ISO 4217 standard.", + required: "optional, default to payment session currency code", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "EUR", + }, + amount_cents: { + type: "integer", + desc: "The payment transacion amount cents collected.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: 1000, + }, + amount_float: { + type: "float", + desc: "The payment transaction amount, float.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + monetizable: true, + example: 10.0, + }, + formatted_amount: { + type: "string", + desc: "The payment transaction amount, formatted.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + monetizable: true, + example: "€10,00", + }, + request_data: { + type: "object", + desc: "The data of the request sent to the payment gateway.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: "{}", + }, + response_data: { + type: "object", + desc: "The payment gateway response data, specific to this transaction. Cannot be passed by sales channels.", + prohibited: true, + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: "{}", + }, + options: { + type: "object", + desc: "Options to use for the transaction, the passed values will be used to communicate with the payment gateway. Cannot be passed by sales channels.", + prohibited: true, + creatable: true, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: { cancellation_reason: "fraudulent" }, + }, + requires_action_at: { + type: "string", + desc: "Time at which the transaction is marked as requires_action.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + processing_at: { + type: "string", + desc: "Time at which the transaction has been processed.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + succeeded_at: { + type: "string", + desc: "Time at which the transaction is marked as succeeded.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + declined_at: { + type: "string", + desc: "Time at which the transaction is marked as declined.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + failed_at: { + type: "string", + desc: "Time at which the transaction is marked as failed.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + canceled_at: { + type: "string", + desc: "Time at which the transaction has been cancelled.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + expired_at: { + type: "string", + desc: "Time at which the transaction has been expired.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + id: { + format: "id", + type: "string", + desc: "Unique identifier for the resource (hash).", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "XAyRWNUzyN", + }, + created_at: { + type: "string", + desc: "Time at which the resource was created.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + updated_at: { + type: "string", + desc: "Time at which the resource was last updated.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + reference: { + type: "string", + desc: "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE", + }, + reference_origin: { + type: "string", + desc: "Any identifier of the third party system that defines the reference code.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE-ORIGIN", + }, + metadata: { + type: "object", + desc: "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + monitored: true, + example: { foo: "bar" }, + }, + }, + relationships: { + payment_session: { + type: "has_one", + desc: "The associated payment session.", + required: "required", + creatable: true, + updatable: false, + filterable: true, + sortable: true, + parent_resource: "Api::PaymentTransactionResource", + class_name: "PaymentSession", + }, + order: { + type: "has_one", + desc: "The associated order.", + creatable: false, + updatable: false, + filterable: true, + sortable: false, + parent_resource: "Api::PaymentTransactionResource", + class_name: "Order", + }, + payment_setting: { + type: "has_one", + desc: "The associated payment setting.", + creatable: false, + updatable: false, + filterable: true, + sortable: false, + polymorphic: true, + sti: true, + parent_resource: "Api::PaymentTransactionResource", + class_name: "PaymentSetting", + }, + attachments: { + type: "has_many", + desc: "The associated attachments.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentTransactionResource", + class_name: "Attachment", + }, + events: { + type: "has_many", + desc: "The associated events.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentTransactionResource", + class_name: "Event", + }, + event_stores: { + type: "has_many", + desc: "The associated event stores.", + class_name: "EventStore", + creatable: false, + updatable: false, + filterable: false, + sortable: false, + virtual: true, + exportable: false, + includable: false, + parent_resource: "Api::PaymentTransactionResource", + }, + }, + filters: [ + "id", + "type", + "status", + "payment_type", + "token", + "currency_code", + "amount_cents", + "options", + "requires_action_at", + "processing_at", + "succeeded_at", + "declined_at", + "failed_at", + "canceled_at", + "expired_at", + "created_at", + "updated_at", + "reference", + "reference_origin", + "metadata", + "q", + "payment_session_id", + "order_id", + "payment_setting_id", + "attachments_id", + "events_id", + "ids", + "requires_action_at_from", + "requires_action_at_to", + "processing_at_from", + "processing_at_to", + "succeeded_at_from", + "succeeded_at_to", + "declined_at_from", + "declined_at_to", + "failed_at_from", + "failed_at_to", + "canceled_at_from", + "canceled_at_to", + "expired_at_from", + "expired_at_to", + "created_at_from", + "created_at_to", + "updated_at_from", + "updated_at_to", + ], + parent_resource: null, + }, + }, + { + id: "payment_void", + type: "resources", + attributes: { + singleton: false, + addon: false, + hidden: false, + versions: ["2026-05"], + actions: ["list", "retrieve", "create", "update", "delete"], + examples: {}, + filter_scopes: [], + fields: { + type: { + type: "string", + desc: "The transaction type (authorization, capture, void, refund).", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "payment_authorization", + enum: [ + "payment_authorizations", + "payment_voids", + "payment_captures", + "payment_refunds", + ], + }, + status: { + type: "string", + desc: "The transaction status. One of 'pending' (default), 'requires_action', 'processing', 'succeeded', 'declined', 'failed', 'canceled', or 'expired'.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "draft", + aasm: true, + enum: [ + "pending", + "requires_action", + "processing", + "succeeded", + "declined", + "failed", + "canceled", + "expired", + ], + }, + payment_type: { + type: "string", + desc: "The payment type inherited by the payment session. One of 'ADYEN', 'BRAINTREE', 'CHECKOUT_COM', 'EXTERNAL', 'GIFT_CARD', 'MANUAL', 'PAYPAL', or 'STRIPE'.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "MANUAL", + enum: [ + "ADYEN", + "BRAINTREE", + "CHECKOUT_COM", + "EXTERNAL", + "GIFT_CARD", + "MANUAL", + "PAYPAL", + "STRIPE", + ], + }, + _internal_version: { + type: "string", + trigger: true, + desc: "Send this attribute if you want to force a specific supported internal payload version for this request, overriding the payment setting's configured default. Only usable when the payment setting is internal_versionable.", + creatable: true, + updatable: false, + fetchable: false, + filterable: false, + sortable: false, + example: "V72", + }, + token: { + type: "string", + desc: "The token identifying the transaction, returned by the payment session interaction.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: "xxxx-yyyy-zzzz", + }, + currency_code: { + type: "string", + desc: "The international 3-letter currency code as defined by the ISO 4217 standard.", + required: "optional, default to payment session currency code", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "EUR", + }, + amount_cents: { + type: "integer", + desc: "The payment transacion amount cents collected.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: 1000, + }, + amount_float: { + type: "float", + desc: "The payment transaction amount, float.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + monetizable: true, + example: 10.0, + }, + formatted_amount: { + type: "string", + desc: "The payment transaction amount, formatted.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + monetizable: true, + example: "€10,00", + }, + request_data: { + type: "object", + desc: "The data of the request sent to the payment gateway.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: "{}", + }, + response_data: { + type: "object", + desc: "The payment gateway response data, specific to this transaction. Cannot be passed by sales channels.", + prohibited: true, + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: "{}", + }, + options: { + type: "object", + desc: "Options to use for the transaction, the passed values will be used to communicate with the payment gateway. Cannot be passed by sales channels.", + prohibited: true, + creatable: true, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: { cancellation_reason: "fraudulent" }, + }, + requires_action_at: { + type: "string", + desc: "Time at which the transaction is marked as requires_action.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + processing_at: { + type: "string", + desc: "Time at which the transaction has been processed.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + succeeded_at: { + type: "string", + desc: "Time at which the transaction is marked as succeeded.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + declined_at: { + type: "string", + desc: "Time at which the transaction is marked as declined.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + failed_at: { + type: "string", + desc: "Time at which the transaction is marked as failed.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + canceled_at: { + type: "string", + desc: "Time at which the transaction has been cancelled.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + expired_at: { + type: "string", + desc: "Time at which the transaction has been expired.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + id: { + format: "id", + type: "string", + desc: "Unique identifier for the resource (hash).", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "XAyRWNUzyN", + }, + created_at: { + type: "string", + desc: "Time at which the resource was created.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + updated_at: { + type: "string", + desc: "Time at which the resource was last updated.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + reference: { + type: "string", + desc: "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE", + }, + reference_origin: { + type: "string", + desc: "Any identifier of the third party system that defines the reference code.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE-ORIGIN", + }, + metadata: { + type: "object", + desc: "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + monitored: true, + example: { foo: "bar" }, + }, + }, + relationships: { + payment_session: { + type: "has_one", + desc: "The associated payment session.", + required: "required", + creatable: true, + updatable: false, + filterable: true, + sortable: true, + parent_resource: "Api::PaymentTransactionResource", + class_name: "PaymentSession", + }, + order: { + type: "has_one", + desc: "The associated order.", + creatable: false, + updatable: false, + filterable: true, + sortable: false, + parent_resource: "Api::PaymentTransactionResource", + class_name: "Order", + }, + payment_setting: { + type: "has_one", + desc: "The associated payment setting.", + creatable: false, + updatable: false, + filterable: true, + sortable: false, + polymorphic: true, + sti: true, + parent_resource: "Api::PaymentTransactionResource", + class_name: "PaymentSetting", + }, + attachments: { + type: "has_many", + desc: "The associated attachments.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentVoidResource", + class_name: "Attachment", + }, + events: { + type: "has_many", + desc: "The associated events.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentVoidResource", + class_name: "Event", + }, + event_stores: { + type: "has_many", + desc: "The associated event stores.", + class_name: "EventStore", + creatable: false, + updatable: false, + filterable: false, + sortable: false, + virtual: true, + exportable: false, + includable: false, + parent_resource: "Api::PaymentVoidResource", + }, + payment_authorization: { + type: "has_one", + desc: "The associated payment authorization.", + required: "required", + foreign_key: "reference_transaction_id", + creatable: true, + updatable: false, + filterable: true, + sortable: false, + parent_resource: "Api::PaymentVoidResource", + class_name: "PaymentAuthorization", + }, + }, + filters: [ + "id", + "type", + "status", + "payment_type", + "token", + "currency_code", + "amount_cents", + "options", + "requires_action_at", + "processing_at", + "succeeded_at", + "declined_at", + "failed_at", + "canceled_at", + "expired_at", + "created_at", + "updated_at", + "reference", + "reference_origin", + "metadata", + "q", + "payment_session_id", + "order_id", + "payment_setting_id", + "attachments_id", + "events_id", + "payment_authorization_id", + "ids", + "requires_action_at_from", + "requires_action_at_to", + "processing_at_from", + "processing_at_to", + "succeeded_at_from", + "succeeded_at_to", + "declined_at_from", + "declined_at_to", + "failed_at_from", + "failed_at_to", + "canceled_at_from", + "canceled_at_to", + "expired_at_from", + "expired_at_to", + "created_at_from", + "created_at_to", + "updated_at_from", + "updated_at_to", + ], + parent_resource: "payment_transaction", + }, + }, + { + id: "payment_wallet", + type: "resources", + attributes: { + singleton: false, + addon: false, + hidden: false, + versions: ["2026-05"], + actions: ["list", "retrieve", "create", "update", "delete"], + examples: {}, + filter_scopes: [], + fields: { + status: { + type: "string", + desc: "The payment wallet status. One of 'pending' (default), 'requires_action', 'processing', 'succeeded', or 'canceled'.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "succeeded", + aasm: true, + enum: [ + "pending", + "requires_action", + "processing", + "succeeded", + "canceled", + ], + }, + _payment_details: { + type: "object", + trigger: true, + desc: "Send this attribute on create if you want to send details for the payment to be stored.", + creatable: true, + updatable: false, + fetchable: false, + filterable: false, + sortable: false, + example: { foo: "bar" }, + }, + _internal_version: { + type: "string", + trigger: true, + desc: "Send this attribute if you want to force a specific supported internal payload version for this request, overriding the payment setting's configured default. Only usable when the payment setting is internal_versionable.", + creatable: true, + updatable: false, + fetchable: false, + filterable: false, + sortable: false, + example: "V72", + }, + token: { + type: "string", + desc: "The unique token identifying the payment wallet.", + required: "optional", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: false, + example: "xxxx-yyyy-zzzz", + }, + customer_token: { + type: "string", + desc: "The token identifying the customer on the gateway.", + required: + "required, a tentative to generate it on the gateway is made", + creatable: true, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "cus_xxxyyyzzz", + }, + payment_token: { + type: "string", + desc: "The token identifying the payment method on the gateway.", + required: + "required, a tentative to generate it on the gateway is made", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + example: "pm_xxxyyyzzz", + }, + options: { + type: "object", + desc: "Options to use for the payment wallet, the passed values will be used to communicate with the payment gateway. Cannot be passed by sales channels.", + prohibited: true, + creatable: true, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: { usage: "on_session" }, + }, + payment_data: { + type: "object", + desc: "The data of the payment method related to this wallet.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: "{}", + }, + request_data: { + type: "object", + desc: "The data of the request sent to the payment gateway.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: "{}", + }, + response_data: { + type: "object", + desc: "The payment gateway response data, used by successive payment workflows.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: "{}", + }, + _refresh: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to update the payment wallet with fresh data from the payment gateway.", + creatable: false, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + _cancel: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to cancel this payment wallet.", + required: "optional", + creatable: false, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + requires_action_at: { + type: "string", + desc: "Time at which the payment wallet is marked as requires_action.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + processing_at: { + type: "string", + desc: "Time at which the payment wallet has been processed.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + succeeded_at: { + type: "string", + desc: "Time at which the payment wallet is marked as succeeded.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + canceled_at: { + type: "string", + desc: "Time at which the payment wallet has been cancelled.", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + expires_at: { + type: "string", + desc: "Time at which this payment wallet will expire.", + required: "optional, default is fetched by gateway", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + id: { + format: "id", + type: "string", + desc: "Unique identifier for the resource (hash).", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "XAyRWNUzyN", }, created_at: { type: "string", @@ -24815,242 +32978,65 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, relationships: { - market: { - type: "has_one", - desc: "The associated market.", - required: "optional", - creatable: true, - updatable: true, - filterable: true, - sortable: true, - parent_resource: "Api::PaymentMethodResource", - class_name: "Market", - }, - payment_gateway: { + customer: { type: "has_one", - desc: "The associated payment gateway.", + desc: "The associated customer.", required: "required", creatable: true, - updatable: true, + updatable: false, filterable: true, sortable: false, - parent_resource: "Api::PaymentMethodResource", - class_name: "PaymentGateway", + parent_resource: "Api::PaymentWalletResource", + class_name: "Customer", }, - store: { + payment_setting: { type: "has_one", - desc: "The associated store.", - required: "optional", - creatable: true, - updatable: true, - filterable: true, - sortable: true, - parent_resource: "Api::PaymentMethodResource", - class_name: "Store", - }, - attachments: { - type: "has_many", - desc: "The associated attachments.", - filterable: true, - sortable: false, - parent_resource: "Api::PaymentMethodResource", - class_name: "Attachment", - }, - event_stores: { - type: "has_many", - desc: "The associated event stores.", - class_name: "EventStore", - creatable: false, - updatable: false, - filterable: false, - sortable: false, - virtual: true, - exportable: false, - includable: false, - parent_resource: "Api::PaymentMethodResource", - }, - }, - filters: [ - "id", - "name", - "payment_source_type", - "currency_code", - "price_amount_cents", - "disabled_at", - "created_at", - "updated_at", - "reference", - "reference_origin", - "metadata", - "q", - "market_id", - "payment_gateway_id", - "store_id", - "attachments_id", - "ids", - "disabled_at_from", - "disabled_at_to", - "created_at_from", - "created_at_to", - "updated_at_from", - "updated_at_to", - ], - }, - }, - { - id: "payment_option", - type: "resources", - attributes: { - singleton: false, - deprecated: false, - addon: false, - hidden: false, - actions: ["list", "retrieve", "create", "update", "delete"], - examples: {}, - filter_scopes: [], - fields: { - name: { - type: "string", - desc: "The payment option's name. Wehn blank is inherited by payment source type.", - required: "optional", - creatable: true, - updatable: true, - fetchable: true, - filterable: true, - sortable: true, - example: "Stripe Payment Option", - }, - payment_source_type: { - type: "string", - desc: "The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'external_payments', 'klarna_payments', 'paypal_payments', 'satispay_payments', 'stripe_payments', or 'wire_transfers'.", + desc: "The associated payment setting.", required: "required", creatable: true, updatable: false, - fetchable: true, - filterable: true, - sortable: true, - example: "stripe_payments", - enum: [ - "adyen_payments", - "axerve_payments", - "braintree_payments", - "checkout_com_payments", - "external_payments", - "klarna_payments", - "paypal_payments", - "satispay_payments", - "stripe_payments", - "wire_transfers", - ], - }, - data: { - type: "object", - desc: "The payment options data to be added to the payment source payload. Check payment specific API for more details.", - required: "required", - creatable: true, - updatable: true, - fetchable: true, filterable: true, sortable: false, - example: { - application_fee_amount: 1000, - on_behalf_of: "pm_xxx", - }, - }, - id: { - format: "id", - type: "string", - desc: "Unique identifier for the resource (hash).", - required: "required", - creatable: false, - updatable: false, - fetchable: true, - filterable: true, - sortable: true, - example: "XAyRWNUzyN", + parent_resource: "Api::PaymentWalletResource", + class_name: "PaymentSetting", }, - created_at: { - type: "string", - desc: "Time at which the resource was created.", - required: "required", - creatable: false, - updatable: false, - fetchable: true, - filterable: true, - sortable: true, - example: "2018-01-01T12:00:00.000Z", - format: "datetime", - }, - updated_at: { - type: "string", - desc: "Time at which the resource was last updated.", - required: "required", - creatable: false, - updatable: false, - fetchable: true, - filterable: true, - sortable: true, - example: "2018-01-01T12:00:00.000Z", - format: "datetime", - }, - reference: { - type: "string", - desc: "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", - required: "optional", - creatable: true, - updatable: true, - fetchable: true, - filterable: true, - sortable: true, - example: "ANY-EXTERNAL-REFEFERNCE", - }, - reference_origin: { - type: "string", - desc: "Any identifier of the third party system that defines the reference code.", - required: "optional", - creatable: true, - updatable: true, - fetchable: true, - filterable: true, - sortable: true, - example: "ANY-EXTERNAL-REFEFERNCE-ORIGIN", - }, - metadata: { - type: "object", - desc: "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", - required: "optional", - creatable: true, - updatable: true, - fetchable: true, + payment_sessions: { + type: "has_many", + desc: "The associated payment sessions.", filterable: true, sortable: false, - example: { foo: "bar" }, + parent_resource: "Api::PaymentWalletResource", + class_name: "PaymentSession", }, - }, - relationships: { - order: { - type: "has_one", - desc: "The order associated to the payment options.", - required: "required", - creatable: true, - updatable: true, + order_subscriptions: { + type: "has_many", + desc: "The associated order subscriptions.", filterable: true, - sortable: true, - parent_resource: "Api::PaymentOptionResource", - class_name: "Order", + sortable: false, + parent_resource: "Api::PaymentWalletResource", + class_name: "OrderSubscription", }, attachments: { type: "has_many", desc: "The associated attachments.", filterable: true, sortable: false, - parent_resource: "Api::PaymentOptionResource", + parent_resource: "Api::PaymentWalletResource", class_name: "Attachment", }, + events: { + type: "has_many", + desc: "The associated events.", + filterable: true, + sortable: false, + parent_resource: "Api::PaymentWalletResource", + class_name: "Event", + }, event_stores: { type: "has_many", desc: "The associated event stores.", @@ -25062,28 +33048,49 @@ const corePublicResources = http.get( virtual: true, exportable: false, includable: false, - parent_resource: "Api::PaymentOptionResource", + parent_resource: "Api::PaymentWalletResource", }, }, filters: [ "id", - "name", - "payment_source_type", - "data", + "status", + "token", + "customer_token", + "payment_token", + "requires_action_at", + "processing_at", + "succeeded_at", + "canceled_at", + "expires_at", "created_at", "updated_at", "reference", "reference_origin", "metadata", "q", - "order_id", + "customer_id", + "payment_setting_id", + "payment_sessions_id", + "order_subscriptions_id", "attachments_id", + "events_id", "ids", + "requires_action_at_from", + "requires_action_at_to", + "processing_at_from", + "processing_at_to", + "succeeded_at_from", + "succeeded_at_to", + "canceled_at_from", + "canceled_at_to", + "expires_at_from", + "expires_at_to", "created_at_from", "created_at_to", "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -25091,9 +33098,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -25234,8 +33241,21 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, + _check: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to check the credentials against the payment gateway's APIs.", + required: "optional", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, client_id: { type: "string", desc: "The gateway client ID.", @@ -25316,6 +33336,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "payment_gateway", }, }, { @@ -25323,9 +33344,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -25426,6 +33447,17 @@ const corePublicResources = http.get( sortable: false, example: "false", }, + _refresh: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to refresh the payment's pending transactions and reconcile their status with PayPal.", + creatable: false, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, id: { format: "id", type: "string", @@ -25504,6 +33536,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -25560,6 +33593,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "payment_source", }, }, { @@ -25567,9 +33601,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [ @@ -25869,6 +33903,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, percentage: { @@ -25910,7 +33945,7 @@ const corePublicResources = http.get( order_amount_promotion_rule: { type: "has_one", desc: "The associated order amount promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -25920,7 +33955,7 @@ const corePublicResources = http.get( sku_list_promotion_rule: { type: "has_one", desc: "The associated SKU list promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -25930,7 +33965,7 @@ const corePublicResources = http.get( coupon_codes_promotion_rule: { type: "has_one", desc: "The associated coupon codes promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -25940,7 +33975,7 @@ const corePublicResources = http.get( custom_promotion_rule: { type: "has_one", desc: "The associated custom promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -26060,6 +34095,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "promotion", }, }, { @@ -26067,9 +34103,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve"], examples: {}, filter_scopes: [], @@ -26175,6 +34211,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -26239,6 +34276,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -26246,9 +34284,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -26488,6 +34526,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -26615,6 +34654,7 @@ const corePublicResources = http.get( "sku_codes", "sku_ids", ], + parent_resource: null, }, }, { @@ -26622,9 +34662,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -26763,6 +34803,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -26829,6 +34870,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "price_tier", }, }, { @@ -26836,9 +34878,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -26990,6 +35032,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -27054,6 +35097,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -27061,9 +35105,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -27228,6 +35272,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -27303,6 +35348,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -27310,9 +35356,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve"], examples: {}, filter_scopes: [], @@ -27451,6 +35497,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -27508,6 +35555,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -27515,9 +35563,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -27656,6 +35704,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -27722,6 +35771,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "price_tier", }, }, { @@ -27729,9 +35779,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve"], examples: {}, filter_scopes: [ @@ -28031,6 +36081,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -28061,7 +36112,7 @@ const corePublicResources = http.get( order_amount_promotion_rule: { type: "has_one", desc: "The associated order amount promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -28071,7 +36122,7 @@ const corePublicResources = http.get( sku_list_promotion_rule: { type: "has_one", desc: "The associated SKU list promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -28081,7 +36132,7 @@ const corePublicResources = http.get( coupon_codes_promotion_rule: { type: "has_one", desc: "The associated coupon codes promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -28091,7 +36142,7 @@ const corePublicResources = http.get( custom_promotion_rule: { type: "has_one", desc: "The associated custom promotion rule.", - creatable: true, + creatable: false, updatable: true, filterable: true, sortable: false, @@ -28203,6 +36254,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -28210,9 +36262,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve"], examples: {}, filter_scopes: [], @@ -28301,6 +36353,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -28358,6 +36411,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -28365,9 +36419,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -28476,6 +36530,7 @@ const corePublicResources = http.get( filterable: false, sortable: false, example: "true", + versions: ["2017-08"], }, id: { format: "id", @@ -28544,6 +36599,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -28632,6 +36688,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "order_factory", }, }, { @@ -28639,9 +36696,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08"], actions: ["list", "retrieve", "update"], examples: {}, filter_scopes: ["succeeded"], @@ -28788,6 +36845,18 @@ const corePublicResources = http.get( sortable: false, example: "xxxx-yyyy-zzzz", }, + additional_data: { + type: "object", + desc: "The additional data returned by the payment gateway, if any.", + required: "optional", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + exportable: false, + example: { foo: "bar" }, + }, _forward: { type: "boolean", trigger: true, @@ -28866,6 +36935,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -28992,6 +37062,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "transaction", }, }, { @@ -28999,9 +37070,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve"], examples: {}, filter_scopes: [], @@ -29084,6 +37155,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -29148,6 +37220,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -29155,9 +37228,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve"], examples: {}, filter_scopes: [], @@ -29262,6 +37335,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -29279,7 +37353,7 @@ const corePublicResources = http.get( eager_load_on_include: false, parent_resource: "Api::ResourceErrorResource", class_name: "Resource", - enum: ["orders", "returns"], + enum: ["orders", "returns", "order_subscriptions"], }, event_stores: { type: "has_many", @@ -29312,6 +37386,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -29319,9 +37394,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -29571,6 +37646,7 @@ const corePublicResources = http.get( filterable: false, sortable: false, example: "true", + versions: ["2017-08"], }, _refund_amount_cents: { type: "integer", @@ -29582,6 +37658,7 @@ const corePublicResources = http.get( filterable: false, sortable: false, example: "500", + versions: ["2017-08"], }, estimated_refund_amount_cents: { type: "integer", @@ -29702,6 +37779,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -29767,6 +37845,7 @@ const corePublicResources = http.get( filterable: true, sortable: true, parent_resource: "Api::ReturnResource", + versions: ["2017-08"], }, reference_refund: { type: "has_one", @@ -29777,6 +37856,7 @@ const corePublicResources = http.get( filterable: true, sortable: true, parent_resource: "Api::ReturnResource", + versions: ["2017-08"], }, return_line_items: { type: "has_many", @@ -29786,6 +37866,15 @@ const corePublicResources = http.get( parent_resource: "Api::ReturnResource", class_name: "ReturnLineItem", }, + payment_refunds: { + type: "has_many", + desc: "The payment refunds associated to the return.", + filterable: true, + sortable: false, + parent_resource: "Api::ReturnResource", + class_name: "PaymentRefund", + versions: ["2026-05"], + }, attachments: { type: "has_many", desc: "The associated attachments.", @@ -29862,6 +37951,7 @@ const corePublicResources = http.get( "reference_capture_id", "reference_refund_id", "return_line_items_id", + "payment_refunds_id", "attachments_id", "resource_errors_id", "events_id", @@ -29886,6 +37976,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -29893,9 +37984,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -30087,6 +38178,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -30151,6 +38243,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -30158,9 +38251,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -30301,6 +38394,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, token: { @@ -30418,6 +38512,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "payment_gateway", }, }, { @@ -30425,9 +38520,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -30588,6 +38683,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -30647,6 +38743,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "payment_source", }, }, { @@ -30654,9 +38751,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -31183,6 +39280,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -31277,9 +39375,9 @@ const corePublicResources = http.get( shipment_line_items: { type: "has_many", desc: "The order line items assigned to the shipment.", - deprecated: true, parent_resource: "Api::ShipmentResource", class_name: "ShipmentLineItem", + versions: ["2017-08"], }, stock_line_items: { type: "has_many", @@ -31435,6 +39533,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -31442,9 +39541,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: true, addon: false, hidden: false, + versions: ["2017-08"], actions: ["list", "retrieve"], examples: {}, filter_scopes: [], @@ -31608,6 +39707,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -31702,6 +39802,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "stock_line_item", }, }, { @@ -31709,9 +39810,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -31805,6 +39906,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -31857,6 +39959,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -31864,9 +39967,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -32178,8 +40281,8 @@ const corePublicResources = http.get( fetchable: false, filterable: false, sortable: false, - deprecated: true, example: "true", + versions: ["2017-08"], }, external_includes: { type: "array", @@ -32269,6 +40372,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -32428,6 +40532,7 @@ const corePublicResources = http.get( "updated_at_to", "shipment_id", ], + parent_resource: null, }, }, { @@ -32435,9 +40540,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve"], examples: {}, filter_scopes: [], @@ -32576,6 +40681,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -32633,6 +40739,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -32640,9 +40747,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -32781,6 +40888,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -32817,6 +40925,14 @@ const corePublicResources = http.get( includable: false, parent_resource: "Api::ShippingWeightTierResource", }, + events: { + type: "has_many", + desc: "The associated events.", + filterable: true, + sortable: false, + parent_resource: "Api::ShippingWeightTierResource", + class_name: "Event", + }, }, filters: [ "id", @@ -32832,12 +40948,14 @@ const corePublicResources = http.get( "q", "shipping_method_id", "attachments_id", + "events_id", "ids", "created_at_from", "created_at_to", "updated_at_from", "updated_at_to", ], + parent_resource: "shipping_method_tier", }, }, { @@ -32845,9 +40963,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -32996,6 +41114,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -33038,6 +41157,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -33045,9 +41165,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -33334,6 +41454,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -33514,6 +41635,7 @@ const corePublicResources = http.get( "updated_at_to", "codes", ], + parent_resource: null, }, }, { @@ -33521,9 +41643,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [ @@ -33668,6 +41790,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -33758,6 +41881,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -33765,9 +41889,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -33872,6 +41996,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -33930,6 +42055,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -33937,9 +42063,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -34028,6 +42154,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, all_skus: { @@ -34126,6 +42253,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "promotion_rule", }, }, { @@ -34133,9 +42261,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -34326,6 +42454,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -34407,6 +42536,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -34414,9 +42544,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -34443,6 +42573,17 @@ const corePublicResources = http.get( sortable: true, example: "100", }, + low_quantity: { + type: "integer", + desc: "The stock item quantity level below which it is considered low on stock (based on available quantity, i.e. quantity minus reserved stock). When set, the item can be filtered with the `low_stock` scope.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "10", + }, _validate: { type: "boolean", trigger: true, @@ -34523,6 +42664,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -34593,6 +42735,7 @@ const corePublicResources = http.get( filters: [ "id", "quantity", + "low_quantity", "created_at", "updated_at", "reference", @@ -34612,6 +42755,7 @@ const corePublicResources = http.get( "sku_codes", "sku_ids", ], + parent_resource: null, }, }, { @@ -34619,9 +42763,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -34785,6 +42929,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -34879,6 +43024,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -34886,9 +43032,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -35014,6 +43160,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -35111,6 +43258,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -35118,9 +43266,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -35239,6 +43387,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -35362,6 +43511,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -35369,9 +43519,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -35623,6 +43773,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -35763,6 +43914,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -35770,9 +43922,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -35799,6 +43951,239 @@ const corePublicResources = http.get( sortable: true, example: "europe1", }, + payment_setting_ids: { + type: "array", + desc: "The list of available payment setting ids.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: ["1", "2", "34"], + versions: ["2026-05"], + }, + union_payment_settings: { + type: "boolean", + desc: "Indicates if the store's payment settings should be merged with the market's ones (true) or completely override them (false).", + required: "optional, default is 'false'", + default: false, + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "false", + versions: ["2026-05"], + }, + id: { + format: "id", + type: "string", + desc: "Unique identifier for the resource (hash).", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "XAyRWNUzyN", + }, + created_at: { + type: "string", + desc: "Time at which the resource was created.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + updated_at: { + type: "string", + desc: "Time at which the resource was last updated.", + required: "required", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, + reference: { + type: "string", + desc: "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE", + }, + reference_origin: { + type: "string", + desc: "Any identifier of the third party system that defines the reference code.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "ANY-EXTERNAL-REFEFERNCE-ORIGIN", + }, + metadata: { + type: "object", + desc: "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: false, + monitored: true, + example: { foo: "bar" }, + }, + }, + relationships: { + market: { + type: "has_one", + desc: "The associated market.", + required: "required", + creatable: true, + updatable: true, + filterable: true, + sortable: true, + parent_resource: "Api::StoreResource", + class_name: "Market", + }, + merchant: { + type: "has_one", + desc: "The associated merchant.", + required: "optional", + creatable: true, + updatable: true, + filterable: true, + sortable: false, + parent_resource: "Api::StoreResource", + class_name: "Merchant", + }, + stock_location: { + type: "has_one", + desc: "The associated stock location.", + required: "optional", + creatable: true, + updatable: true, + filterable: true, + sortable: true, + parent_resource: "Api::StoreResource", + class_name: "StockLocation", + }, + orders: { + type: "has_many", + desc: "The associated orders.", + parent_resource: "Api::StoreResource", + class_name: "Order", + }, + payment_methods: { + type: "has_many", + desc: "The associated payment methods.", + parent_resource: "Api::StoreResource", + class_name: "PaymentMethod", + versions: ["2017-08"], + }, + events: { + type: "has_many", + desc: "The associated events.", + filterable: true, + sortable: false, + parent_resource: "Api::StoreResource", + class_name: "Event", + }, + event_stores: { + type: "has_many", + desc: "The associated event stores.", + class_name: "EventStore", + creatable: false, + updatable: false, + filterable: false, + sortable: false, + virtual: true, + exportable: false, + includable: false, + parent_resource: "Api::StoreResource", + }, + }, + filters: [ + "id", + "name", + "code", + "created_at", + "updated_at", + "reference", + "reference_origin", + "metadata", + "q", + "market_id", + "merchant_id", + "stock_location_id", + "events_id", + "ids", + "created_at_from", + "created_at_to", + "updated_at_from", + "updated_at_to", + ], + parent_resource: null, + }, + }, + { + id: "stripe_gateway", + type: "resources", + attributes: { + singleton: false, + addon: false, + hidden: false, + versions: ["2017-08"], + actions: ["list", "retrieve", "create", "update", "delete"], + examples: {}, + filter_scopes: [], + fields: { + name: { + type: "string", + desc: "The payment gateway's internal name.", + required: "required", + creatable: true, + updatable: true, + fetchable: true, + filterable: true, + sortable: true, + example: "US payment gateway", + }, + force_payments: { + type: "boolean", + desc: "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", + required: "optional, default is 'true'", + default: true, + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "true", + }, + credential_keys: { + type: "object", + desc: "The payment gateway's API credential keys last digits.", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + example: { api_key: "********BW989" }, + }, id: { format: "id", type: "string", @@ -35811,6 +44196,42 @@ const corePublicResources = http.get( sortable: true, example: "XAyRWNUzyN", }, + _disable: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to mark this resource as disabled.", + required: "optional", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + _enable: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to mark this resource as enabled.", + required: "optional", + creatable: true, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + disabled_at: { + type: "string", + desc: "Time at which this resource was disabled.", + required: "optional", + creatable: false, + updatable: false, + fetchable: true, + filterable: true, + sortable: true, + example: "2018-01-01T12:00:00.000Z", + format: "datetime", + }, created_at: { type: "string", desc: "Time at which the resource was created.", @@ -35866,170 +44287,13 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, - }, - relationships: { - market: { - type: "has_one", - desc: "The associated market.", - required: "required", - creatable: true, - updatable: true, - filterable: true, - sortable: true, - parent_resource: "Api::StoreResource", - class_name: "Market", - }, - merchant: { - type: "has_one", - desc: "The associated merchant.", - required: "optional", - creatable: true, - updatable: true, - filterable: true, - sortable: false, - parent_resource: "Api::StoreResource", - class_name: "Merchant", - }, - stock_location: { - type: "has_one", - desc: "The associated stock location.", - required: "optional", - creatable: true, - updatable: true, - filterable: true, - sortable: true, - parent_resource: "Api::StoreResource", - class_name: "StockLocation", - }, - orders: { - type: "has_many", - desc: "The associated orders.", - parent_resource: "Api::StoreResource", - class_name: "Order", - }, - payment_methods: { - type: "has_many", - desc: "The associated payment methods.", - parent_resource: "Api::StoreResource", - class_name: "PaymentMethod", - }, - events: { - type: "has_many", - desc: "The associated events.", - filterable: true, - sortable: false, - parent_resource: "Api::StoreResource", - class_name: "Event", - }, - event_stores: { - type: "has_many", - desc: "The associated event stores.", - class_name: "EventStore", - creatable: false, - updatable: false, - filterable: false, - sortable: false, - virtual: true, - exportable: false, - includable: false, - parent_resource: "Api::StoreResource", - }, - }, - filters: [ - "id", - "name", - "code", - "created_at", - "updated_at", - "reference", - "reference_origin", - "metadata", - "q", - "market_id", - "merchant_id", - "stock_location_id", - "events_id", - "ids", - "created_at_from", - "created_at_to", - "updated_at_from", - "updated_at_to", - ], - }, - }, - { - id: "stripe_gateway", - type: "resources", - attributes: { - singleton: false, - deprecated: false, - addon: false, - hidden: false, - actions: ["list", "retrieve", "create", "update", "delete"], - examples: {}, - filter_scopes: [], - fields: { - name: { - type: "string", - desc: "The payment gateway's internal name.", - required: "required", - creatable: true, - updatable: true, - fetchable: true, - filterable: true, - sortable: true, - example: "US payment gateway", - }, - force_payments: { - type: "boolean", - required: "optional, default is 'true'", - default: true, - creatable: true, - updatable: true, - fetchable: true, - filterable: false, - sortable: false, - }, - credential_keys: { - type: "object", - desc: "The payment gateway's API credential keys last digits.", - creatable: false, - updatable: false, - fetchable: true, - filterable: false, - sortable: false, - example: { api_key: "********BW989" }, - }, - id: { - format: "id", - type: "string", - desc: "Unique identifier for the resource (hash).", - required: "required", - creatable: false, - updatable: false, - fetchable: true, - filterable: true, - sortable: true, - example: "XAyRWNUzyN", - }, - _disable: { - type: "boolean", - trigger: true, - desc: "Send this attribute if you want to mark this resource as disabled.", - required: "optional", - creatable: true, - updatable: true, - fetchable: false, - filterable: false, - sortable: false, - example: "true", - }, - _enable: { + _check: { type: "boolean", trigger: true, - desc: "Send this attribute if you want to mark this resource as enabled.", + desc: "Send this attribute if you want to check the credentials against the payment gateway's APIs.", required: "optional", creatable: true, updatable: true, @@ -36038,75 +44302,6 @@ const corePublicResources = http.get( sortable: false, example: "true", }, - disabled_at: { - type: "string", - desc: "Time at which this resource was disabled.", - required: "optional", - creatable: false, - updatable: false, - fetchable: true, - filterable: true, - sortable: true, - example: "2018-01-01T12:00:00.000Z", - format: "datetime", - }, - created_at: { - type: "string", - desc: "Time at which the resource was created.", - required: "required", - creatable: false, - updatable: false, - fetchable: true, - filterable: true, - sortable: true, - example: "2018-01-01T12:00:00.000Z", - format: "datetime", - }, - updated_at: { - type: "string", - desc: "Time at which the resource was last updated.", - required: "required", - creatable: false, - updatable: false, - fetchable: true, - filterable: true, - sortable: true, - example: "2018-01-01T12:00:00.000Z", - format: "datetime", - }, - reference: { - type: "string", - desc: "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", - required: "optional", - creatable: true, - updatable: true, - fetchable: true, - filterable: true, - sortable: true, - example: "ANY-EXTERNAL-REFEFERNCE", - }, - reference_origin: { - type: "string", - desc: "Any identifier of the third party system that defines the reference code.", - required: "optional", - creatable: true, - updatable: true, - fetchable: true, - filterable: true, - sortable: true, - example: "ANY-EXTERNAL-REFEFERNCE-ORIGIN", - }, - metadata: { - type: "object", - desc: "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", - required: "optional", - creatable: true, - updatable: true, - fetchable: true, - filterable: true, - sortable: false, - example: { foo: "bar" }, - }, login: { type: "string", desc: "The gateway login.", @@ -36185,6 +44380,30 @@ const corePublicResources = http.get( example: "https://core.commercelayer.co/webhook_callbacks/stripe_gateways/xxxxx", }, + _refresh_webhook_secrets: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to refresh the gateway webhook endpoint ID and secret.", + required: "optional", + creatable: false, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, + _update_webhooks: { + type: "boolean", + trigger: true, + desc: "Send this attribute if you want to sync the gateway webhook endpoint subscribed event topics.", + required: "optional", + creatable: false, + updatable: true, + fetchable: false, + filterable: false, + sortable: false, + example: "true", + }, }, relationships: { payment_methods: { @@ -36240,6 +44459,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "payment_gateway", }, }, { @@ -36247,9 +44467,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -36485,6 +44705,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -36539,6 +44760,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "payment_source", }, }, { @@ -36546,9 +44768,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -36573,7 +44795,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: true, - example: "avalara_accounts", + example: "stripe_tax_accounts", enum: [ "avalara_accounts", "stripe_tax_accounts", @@ -36650,6 +44872,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, api_key: { @@ -36739,6 +44962,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "tax_calculator", }, }, { @@ -36746,9 +44970,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -36881,6 +45105,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -36938,6 +45163,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -36945,9 +45171,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -37030,6 +45256,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -37063,6 +45290,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -37070,9 +45298,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: true, hidden: true, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -37112,6 +45340,18 @@ const corePublicResources = http.get( sortable: false, example: true, }, + options: { + type: "object", + desc: "A hash of additional options passed through to the discount engine's API requests (e.g. Talon.One's `storeIntegrationId`).", + required: "optional, default is '{}'", + default: {}, + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: { storeIntegrationId: "STORE-001" }, + }, id: { format: "id", type: "string", @@ -37179,6 +45419,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, api_key: { @@ -37266,6 +45507,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "discount_engine", }, }, { @@ -37273,9 +45515,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve"], examples: {}, filter_scopes: [], @@ -37377,6 +45619,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -37435,6 +45678,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -37442,9 +45686,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -37538,6 +45782,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -37614,6 +45859,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -37621,9 +45867,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -37671,6 +45917,7 @@ const corePublicResources = http.get( filterable: true, sortable: false, example: "false", + versions: ["2017-08"], }, gift_card_taxable: { type: "boolean", @@ -37837,6 +46084,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -37888,6 +46136,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -37895,9 +46144,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -37922,7 +46171,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: true, - example: "avalara_accounts", + example: "taxjar_accounts", enum: [ "avalara_accounts", "stripe_tax_accounts", @@ -37999,6 +46248,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, api_key: { @@ -38078,6 +46328,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "tax_calculator", }, }, { @@ -38085,9 +46336,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08"], actions: ["list", "retrieve"], examples: {}, filter_scopes: ["succeeded"], @@ -38234,6 +46485,18 @@ const corePublicResources = http.get( sortable: false, example: "xxxx-yyyy-zzzz", }, + additional_data: { + type: "object", + desc: "The additional data returned by the payment gateway, if any.", + required: "optional", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + exportable: false, + example: { foo: "bar" }, + }, _forward: { type: "boolean", trigger: true, @@ -38312,6 +46575,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -38412,6 +46676,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -38419,9 +46684,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -38446,7 +46711,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: true, - example: "avalara_accounts", + example: "vertex_accounts", enum: [ "avalara_accounts", "stripe_tax_accounts", @@ -38523,11 +46788,12 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, kind: { type: "string", - desc: "The Vertex account kind. One of 'cloud', 'on_demand', or 'on_premise'.", + desc: "The Vertex account kind. One of 'cloud' (default), 'on_demand', or 'on_premise'.", required: "optional, default is 'cloud'", default: "cloud", creatable: true, @@ -38549,6 +46815,17 @@ const corePublicResources = http.get( sortable: false, example: "yourbaseurl", }, + audience: { + type: "string", + desc: "The OAuth audience sent with the token request. Defaults to 'verx://migration-api' for 'cloud' kind unless set explicitly.", + required: "optional", + creatable: true, + updatable: true, + fetchable: true, + filterable: false, + sortable: false, + example: "verx://xyz", + }, client_id: { type: "string", desc: "The Vertex account client ID.", @@ -38672,6 +46949,7 @@ const corePublicResources = http.get( "token_expires_at_from", "token_expires_at_to", ], + parent_resource: "tax_calculator", }, }, { @@ -38679,9 +46957,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08"], actions: ["list", "retrieve", "update"], examples: {}, filter_scopes: ["succeeded"], @@ -38828,6 +47106,18 @@ const corePublicResources = http.get( sortable: false, example: "xxxx-yyyy-zzzz", }, + additional_data: { + type: "object", + desc: "The additional data returned by the payment gateway, if any.", + required: "optional", + creatable: false, + updatable: false, + fetchable: true, + filterable: false, + sortable: false, + exportable: false, + example: { foo: "bar" }, + }, _forward: { type: "boolean", trigger: true, @@ -38906,6 +47196,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -39019,6 +47310,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "transaction", }, }, { @@ -39026,9 +47318,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08", "2026-05"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -39181,8 +47473,8 @@ const corePublicResources = http.get( fetchable: false, filterable: false, sortable: false, - deprecated: true, example: "true", + versions: ["2017-08"], }, created_at: { type: "string", @@ -39239,6 +47531,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -39286,6 +47579,7 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: null, }, }, { @@ -39293,9 +47587,9 @@ const corePublicResources = http.get( type: "resources", attributes: { singleton: false, - deprecated: false, addon: false, hidden: false, + versions: ["2017-08"], actions: ["list", "retrieve", "create", "update", "delete"], examples: {}, filter_scopes: [], @@ -39378,6 +47672,7 @@ const corePublicResources = http.get( fetchable: true, filterable: true, sortable: false, + monitored: true, example: { foo: "bar" }, }, }, @@ -39421,10 +47716,11 @@ const corePublicResources = http.get( "updated_at_from", "updated_at_to", ], + parent_resource: "payment_source", }, }, ], - meta: { record_count: 134, page_count: 1, version: "release-v3.12.3" }, + meta: { record_count: 152, page_count: 1, version: "release-v4.0.0" }, }) }, ) diff --git a/packages/app-elements/src/ui/forms/CodeEditor/fetchCoreResourcesSuggestions.test.ts b/packages/app-elements/src/ui/forms/CodeEditor/fetchCoreResourcesSuggestions.test.ts index 92be27b99..02adee01e 100644 --- a/packages/app-elements/src/ui/forms/CodeEditor/fetchCoreResourcesSuggestions.test.ts +++ b/packages/app-elements/src/ui/forms/CodeEditor/fetchCoreResourcesSuggestions.test.ts @@ -789,6 +789,18 @@ const orderSuggestionsSnapshot = ` "type": "field", "value": "order.formatted_total_amount_with_taxes", }, + { + "type": "field", + "value": "order.session_amount_cents", + }, + { + "type": "field", + "value": "order.session_amount_float", + }, + { + "type": "field", + "value": "order.formatted_session_amount", + }, { "type": "field", "value": "order.fees_amount_cents", @@ -837,6 +849,10 @@ const orderSuggestionsSnapshot = ` "type": "field", "value": "order.shipments_count", }, + { + "type": "field", + "value": "order.payment_taken_sessions_count", + }, { "type": "field", "value": "order.tax_calculations_count", @@ -877,6 +893,10 @@ const orderSuggestionsSnapshot = ` "type": "field", "value": "order.checkout_url", }, + { + "type": "field", + "value": "order.placeable", + }, { "type": "field", "value": "order.placed_at", @@ -977,6 +997,10 @@ const orderSuggestionsSnapshot = ` "type": "relationship", "value": "order.default_payment_method", }, + { + "type": "relationship", + "value": "order.available_payment_settings", + }, { "type": "relationship", "value": "order.available_payment_methods", @@ -1009,6 +1033,10 @@ const orderSuggestionsSnapshot = ` "type": "relationship", "value": "order.line_item_options", }, + { + "type": "relationship", + "value": "order.payment_sessions", + }, { "type": "relationship", "value": "order.stock_reservations", @@ -1029,6 +1057,26 @@ const orderSuggestionsSnapshot = ` "type": "relationship", "value": "order.payment_options", }, + { + "type": "relationship", + "value": "order.payment_transactions", + }, + { + "type": "relationship", + "value": "order.payment_authorizations", + }, + { + "type": "relationship", + "value": "order.payment_captures", + }, + { + "type": "relationship", + "value": "order.payment_voids", + }, + { + "type": "relationship", + "value": "order.payment_refunds", + }, { "type": "relationship", "value": "order.transactions",