Skip to content

DEVDOCS-6393 - Channel-specific settings #973

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 82 additions & 0 deletions reference/checkouts.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8072,6 +8072,62 @@ paths:
order_confirmation_use_custom_checkout_script: false
custom_order_confirmation_script_url: 'webdav:vtz-order-confirmation/dist/auto-loader.js'
meta: {}
/checkouts/settings/channels/{channelId}:
parameters:
- name: channelId
in: path
required: true
schema:
type: integer
get:
summary: Get Channel-Specific Checkout Settings
description: Returns the checkout settings for a given channel (storefront) by channelId.
tags:
- Checkout Settings
operationId: get-channel-checkout-settings
responses:
'200':
description: Channel checkout settings retrieved successfully
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/ChannelCheckoutsSettings'
meta:
$ref: '#/components/schemas/MetaOpen'
'422':
description: Invalid channelId or invalid request

put:
summary: Update Channel-Specific Checkout Settings
description: |-
Updates the checkout settings for a given channel (storefront) by channelId.

This endpoint will update all settings included in the request body. Any settings excluded will remain unchanged. All non-boolean
tags:
- Checkout Settings
operationId: put-channel-checkout-settings
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChannelCheckoutsSettings'
responses:
'200':
description: Channel checkout settings updated successfully
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/ChannelCheckoutsSettings'
meta:
$ref: '#/components/schemas/MetaOpen'
'422':
description: Invalid channelId or invalid request
'/checkouts/{checkoutId}/token':
parameters:

Expand Down Expand Up @@ -9427,6 +9483,32 @@ components:
type: string
custom_order_confirmation_sri_hash:
type: string
ChannelCheckoutsSettings:
title: Channel-Specific Checkouts Settings
allOf:
- type: object
properties:
checkout_type:
type: string
guest_checkout_type:
type: string
guest_checkout_for_existing_accounts:
type: string
policy_consent:
type: string
order_confirmation_contact_email:
type: string
is_order_terms_and_conditions_enabled:
type: boolean
order_terms_and_conditions_type:
type: string
order_terms_and_conditions_link:
type: string
order_terms_and_conditions_textarea:
type: string
should_redirect_to_storefront_for_auth:
type: boolean
- $ref: "#/components/schemas/CheckoutsSettings"
CheckoutsSettingsRequest:
title: Checkouts settings request
type: object
Expand Down