diff --git a/models/email_templates/combined/README.md b/models/email_templates/combined/README.md new file mode 100644 index 000000000..3d6690d38 --- /dev/null +++ b/models/email_templates/combined/README.md @@ -0,0 +1,32 @@ +# Email Template Objects + +Object schemas for handlebars email templates. + +## Directory structure + +```shell +. +├── data # json data for generating and updating yaml schema +├── _all.yml # Groups models together for docs +├── account_details_changed_email.yml # Individual email template models +├── ... +``` + +## Updating models + +To generate a new model from json data and overwrite the existing schema file: + +1. Copy and paste template `data-*.json` from [localization-tools](https://github.com/bigcommerce/localization-tools/blob/master/email-check/modules/email-templates/types/abandoned_cart_email/data-0.json) to `models/_json/email_templates`. +2. Use `models/json2schema.py` to convert the json data to a yaml schema. + +Example: + +```bash +cat data.json | python json2schema.py > schema.yml +``` + +Bash for overwriting all email template models: + +```bash +for f in models/email_templates/data/*.json; do cat $f | python models/json2schema.py > ${f%.*}.yml; mv ${f%.*}.yml models/email_templates/; done +``` \ No newline at end of file diff --git a/models/email_templates/combined/abandoned_cart_email.yml b/models/email_templates/combined/abandoned_cart_email.yml new file mode 100644 index 000000000..3c283fec8 --- /dev/null +++ b/models/email_templates/combined/abandoned_cart_email.yml @@ -0,0 +1,169 @@ +title: Abandoned Cart Email Template +description: Abandoned cart email triggers when a shopper doesnʼt complete an order. +type: object +properties: + notification: + type: array + items: + type: object + properties: + unsubscribe_link: + type: string + checkout_link: + type: string + coupon: + type: array + items: + type: object + properties: + code: + type: string + type: + type: array + items: + type: object + properties: + value: + type: string + formatted: + type: string + amount: + type: array + items: + type: object + properties: + value: + type: number + format: float + formatted: + type: string + cart: + type: array + items: + type: object + properties: + products: + type: array + items: + type: object + properties: + type: array + items: + type: object + properties: + id: + type: number + url: + type: string + name: + type: string + quantity: + type: integer + sku: + type: string + thumbnail: + type: string + attributes: + type: array + items: + type: object + properties: + type: array + items: + type: object + properties: + name: + type: string + value: + type: string + price: + type: array + items: + type: object + properties: + value: + type: number + format: float + formatted: + type: string + type: + type: array + items: + type: object + properties: + value: + type: integer + formatted: + type: string + store: + type: array + items: + type: object + properties: + name: + type: string + domain_name: + type: string + logo: + type: array + items: + type: object + properties: + title: + type: string + name: + type: string + url: + type: string + ssl_path: + type: string + cdn_path: + type: string + image_directory: + type: string + img_path: + type: string + path_normal: + type: string + path: + type: string + address: + type: string + phone_number: + type: string + language: + type: array + items: + type: object + properties: + code: + type: string + direction: + type: string + customer: + type: array + items: + type: object + properties: + first_name: + type: string + full_name: + type: string + email: + type: string + group: + type: array + items: + type: object + properties: + id: + type: number + name: + type: string + misc: + type: array + items: + type: object + properties: + year: + type: integer diff --git a/models/email_templates/combined/abandoned_cart_email_deprecated.yml b/models/email_templates/combined/abandoned_cart_email_deprecated.yml new file mode 100644 index 000000000..1cd67fbd6 --- /dev/null +++ b/models/email_templates/combined/abandoned_cart_email_deprecated.yml @@ -0,0 +1,119 @@ +title: Abandoned Cart Email Template (Deprecated) +description: Abandoned cart email triggers when a shopper doesnʼt complete an order. +type: object +deprecated: true +properties: + abandoned_cart: + type: object + title: deprecated + deprecated: true + properties: + body: + type: string + unsubscribe_link: + type: string + store: + type: object + deprecated: true + properties: + name: + type: string + domain_name: + type: string + logo: + type: object + deprecated: true + properties: + title: + type: string + name: + type: string + url: + type: string + ssl_path: + type: string + cdn_path: + type: string + image_directory: + type: string + img_path: + type: string + path_normal: + type: string + description: 'Path to the store (i.e., domain + protocol)' + path: + type: string + address: + type: string + language: + type: object + properties: + code: + type: string + direction: + type: string + description: 'Left to right or right to left, depending on the language' + customer: + type: object + deprecated: true + properties: + first_name: + type: string + full_name: + type: string + email: + type: string + group: + type: array + items: + type: object + properties: + name: + type: string + misc: + type: object + deprecated: true + properties: + year: + type: integer + translations: + type: object + deprecated: true + properties: + en: + type: object + properties: + unsubscribe: + type: string +examples: + Abandoned Cart example (deprecated): + value: + abandoned_cart: + body: You recently visited our online store and we noticed that you didnʼt complete your order.\n
To complete your order right now, just click on the link below:\n Complete your order + unsubscribe_link: 'example.com/unsubscribe' + store: + name: My Dev Store 97434969 + domain_name: my-dev-store-97434969.store.bcdev + logo: + title: [= My Dev Store 97434969 =] + name: avatar-2020_1612860757__16350.jpeg + url: 'https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96/product_images/avatar-2020_1612860757__16350.jpeg' + ssl_path: 'https://my-dev-store-97434969.store.bcdev' + cdn_path: 'https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96' + image_directory: product_images + img_path: 'https://valeryderived-cloud-dev-vm.store.bcdev/r08d84bb67d250c7624502ed76d8e0bafb1a5cacf/g-themes/ClassicNext/images' + path_normal: 'https://my-dev-store-97434969.store.bcdev' + path: 'https://my-dev-store-97434969.store.bcdev' + address: '123 Fake St, Dallas, TX 75225' + language: + code: en + direction: ltr + customer: + first_name: John + full_name: John Jr + email: 'john.f@example.com' + misc: + year: 2021 + translations: + en: + unsubscribe: 'Unsubscribe from future emails like this.' diff --git a/models/email_templates/combined/account_details_changed_email.yml b/models/email_templates/combined/account_details_changed_email.yml new file mode 100644 index 000000000..2bce30060 --- /dev/null +++ b/models/email_templates/combined/account_details_changed_email.yml @@ -0,0 +1,128 @@ +title: Account Settings Edited Email Template +description: Account settings email triggers when the store admin or a customer edits account settings. +type: object +properties: + details_changed: + type: object + properties: + fields: + type: array + items: + type: string + store: + type: object + properties: + name: + type: string + domain_name: + type: string + logo: + type: object + properties: + title: + type: string + name: + type: string + url: + type: string + ssl_path: + type: string + cdn_path: + type: string + image_directory: + type: string + img_path: + type: string + path_normal: + type: string + description: 'Path to the store (i.e., domain + protocol)' + path: + type: string + address: + type: string + language: + type: object + properties: + code: + type: string + direction: + type: string + description: 'Left to right or right to left, depending on the language' + customer: + type: object + properties: + first_name: + type: string + full_name: + type: string + email: + type: string + group: + type: array + items: + type: object + properties: + name: + type: string + misc: + type: object + properties: + year: + type: integer + translations: + type: object + properties: + en: + type: object + properties: + title: + type: string + hello: + type: string + message: + type: string + warning: + type: string + thanks: + type: string + security: + type: string + go_shopping: + type: string +example: + details_changed: + fields: + - Email + - Password + store: + name: My Dev Store 97434969 + domain_name: 'my-dev-store-97434969.store.bcdev' + logo: + title: '[= My Dev Store 97434969 =]' + name: avatar-2020_1612860757__16350.jpeg + url: 'https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96/product_images/avatar-2020_1612860757__16350.jpeg' + ssl_path: 'https://my-dev-store-97434969.store.bcdev' + cdn_path: 'https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96' + image_directory: product_images + img_path: 'https://valeryderived-cloud-dev-vm.store.bcdev/r08d84bb67d250c7624502ed76d8e0bafb1a5cacf/g-themes/ClassicNext/images' + path_normal: 'https://my-dev-store-97434969.store.bcdev' + path: 'https://my-dev-store-97434969.store.bcdev' + address: + language: + code: en + direction: ltr + customer: + first_name: John + full_name: John Jr + email: 'john.f@example.com' + misc: + year: 2021 + translations: + en: + title: Your {{name}} account details have changed + hello: Hello {{name}}, + message: 'We wanted to let you know that the following details have been changed on your {{name}} account:' + warning: 'If you made the changes yourself, please disregard this email. If not, please contact the store immediately through their website: {{domain}}.' + thanks: Thanks, + security: The BigCommerce Security Team + go_shopping: Go shopping diff --git a/models/email_templates/combined/account_reset_password_email.yml b/models/email_templates/combined/account_reset_password_email.yml new file mode 100644 index 000000000..5e60b6431 --- /dev/null +++ b/models/email_templates/combined/account_reset_password_email.yml @@ -0,0 +1,112 @@ +title: Password Reset Email Template +description: Password reset email triggers when a customer resets their account password on the customer details page. +type: object +properties: + reset_password: + type: object + properties: + link: + type: string + store: + type: object + properties: + name: + type: string + domain_name: + type: string + logo: + type: object + properties: + title: + type: string + name: + type: string + url: + type: string + ssl_path: + type: string + cdn_path: + type: string + image_directory: + type: string + img_path: + type: string + path_normal: + type: string + description: 'Path to the store (i.e., domain + protocol)' + path: + type: string + address: + type: string + language: + type: object + properties: + code: + type: string + direction: + type: string + description: 'Left to right or right to left, depending on the language' + customer: + type: object + properties: + first_name: + type: string + full_name: + type: string + email: + type: string + group: + type: array + items: + type: object + properties: + name: + type: string + misc: + type: object + properties: + year: + type: integer + translations: + type: object + properties: + en: + type: object + properties: + title: + type: string + message: + type: string + go_shopping: + type: string +example: + reset_password: + link: #reset-password-link + store: + name: My Dev Store 97434969 + domain_name: my-dev-store-97434969.store.bcdev + logo: + title: [= My Dev Store 97434969 =] + name: avatar-2020_1612860757__16350.jpeg + url: 'https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96/product_images/avatar-2020_1612860757__16350.jpeg' + ssl_path: 'https://my-dev-store-97434969.store.bcdev' + cdn_path: 'https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96' + image_directory: product_images + img_path: 'https://valeryderived-cloud-dev-vm.store.bcdev/r08d84bb67d250c7624502ed76d8e0bafb1a5cacf/g-themes/ClassicNext/images' + path_normal: 'https://my-dev-store-97434969.store.bcdev' + path: 'https://my-dev-store-97434969.store.bcdev' + address: '123 Fake St, Dallas, TX 75225' + language: + code: en + direction: ltr + customer: + first_name: John, + full_name: John Jr, + email: 'john.f@example.com' + misc: + year: 2021 + translations: + en: + title: Change your password for {{name}} + message: 'To change your customer account password at {{store}} please click this link or copy and paste it into your browser:' + go_shopping: Go shopping diff --git a/models/email_templates/combined/combined_order_status_email.yml b/models/email_templates/combined/combined_order_status_email.yml new file mode 100644 index 000000000..bc64b12a9 --- /dev/null +++ b/models/email_templates/combined/combined_order_status_email.yml @@ -0,0 +1,260 @@ +title: Order Status Update Email Template +description: Order status update email triggers when the status of an order changes. +type: object +properties: + order: + type: object + properties: + id: + type: integer + new_status: + type: string + example: 'Incomplete, Pending, Shipped, Partially Shipped, Refunded, Cancelled, Declined, Awaiting Payment, Awaiting Pickup, Awaiting Shipment, Completed, Awaiting Fulfillment, Manual Verification Required, Disputed, Partially Refunded' + new_formatted_status: + type: string + example: 'Shipment123, PendingOrder345, Cancelled0223222, Awaiting Payment in Store' + total: + type: object + properties: + value: + type: float + formatted: + type: string + refund: + type: object + properties: + value: + type: float + formatted: + type: string + date_placed: + type: object + properties: + value: + type: integer + formatted: + type: string + payment_method: + type: string + link: + type: string + customer_name: + type: string + downloadable_products: + type: array + items: + type: object + properties: + name: + type: string + options: + type: string + quantity: + type: integer + link: + type: string + thumbnail: + type: string + products: + type: array + items: + type: object + properties: + name: + type: string + sku: + type: string + price: + type: string + quantity: + type: integer + thumbnail: + type: string + brand: + type: string + tracking: + type: array + items: + type: object + properties: + id: + type: string + shipping_method: + type: string + link: + type: string + store: + type: object + properties: + name: + type: string + domain_name: + type: string + logo: + type: object + properties: + title: + type: string + name: + type: string + url: + type: string + ssl_path: + type: string + cdn_path: + type: string + image_directory: + type: string + img_path: + type: string + path_normal: + type: string + description: 'Path to the store (i.e., domain + protocol)' + path: + type: string + address: + type: string + language: + type: object + properties: + code: + type: string + direction: + type: string + description: 'Left to right or right to left, depending on the language' + customer: + type: object + properties: + first_name: + type: string + full_name: + type: string + email: + type: string + group: + type: array + items: + type: object + properties: + name: + type: string + misc: + type: object + properties: + year: + type: integer + translations: + type: object + properties: + en: + type: object + properties: + title: + type: string + hello: + type: string + message: + type: string + details_title: + type: string + order_total: + type: string + date_placed: + type: string + payment_method: + type: string + total_refund: + type: string + products_shipped: + type: string + products_to_be_shipped: + type: string + tracking_title: + type: string + downloadable_items_title: + type: string + quantity: + type: string + download: + type: string + tracking_label: + type: string + no_tracking_numbers: + type: string + check_status: + type: string + go_shopping: + type: string +example: + order: + id: 1 + new_status: Awaiting Fulfillment + total: + value: 10 + formatted: $10.00 USD + refund: + value: 0 + formatted: + date_placed: + value: 1614615796 + formatted: 03/01/2121 + payment_method: Store Credit + link: '#status-link' + customer_name: John Cena + downloadable_products: + name: Journal + options: + quantity: 1 + link: '#downloadable-link' + products: + name: Test product + sku: FA44 + quantity: 11 + tracking: + id: 123BC + shipping_method: DHL + link: '#example.com' + store: + name: My Dev Store 97434969 + domain_name: 'my-dev-store-97434969.store.bcdev' + logo: + title: '= My Dev Store 97434969 =' + name: 'avatar-2020_1612860757__16350.jpeg' + url: 'https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96/product_images/avatar-2020_1612860757__16350.jpeg' + ssl_path: 'https://my-dev-store-97434969.store.bcdev' + cdn_path: 'https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96' + image_directory: product_images + img_path: 'https://valeryderived-cloud-dev-vm.store.bcdev/r08d84bb67d250c7624502ed76d8e0bafb1a5cacf/g-themes/ClassicNext/images' + path_normal: 'https://my-dev-store-97434969.store.bcdev' + path: 'https://my-dev-store-97434969.store.bcdev' + address: + language: + code: en + direction: ltr + customer: + first_name: John + full_name: John Jr + email: 'john.f@example.com' + misc: + year: 2023 + translations: + en: + title: Order status changed + hello: Hi + message: 'The status of your order #id has changed to {{status}}.' + details_title: Order details + order_total: 'Order total:' + date_placed: 'Date placed:' + payment_method: 'Payment method:' + total_refund: 'Total refunded:' + products_shipped: Products shipped + products_to_be_shipped: Products to be shipped + tracking_title: Tracking information + downloadable_items_title: Downloadable items + quantity: 'Qty:' + download: Download file + tracking_label: Tracking Link + no_tracking_numbers: No tracking numbers are assigned to your order yet + check_status: Check order status + go_shopping: Go shopping + diff --git a/models/email_templates/combined/create_account_email.yml b/models/email_templates/combined/create_account_email.yml new file mode 100644 index 000000000..92cd78317 --- /dev/null +++ b/models/email_templates/combined/create_account_email.yml @@ -0,0 +1,128 @@ +title: Account Created Email Template +description: Account created email triggers when a customer or store admin creates their account. +type: object +properties: + store: + type: object + properties: + name: + type: string + domain_name: + type: string + logo: + type: object + properties: + title: + type: string + name: + type: string + url: + type: string + ssl_path: + type: string + cdn_path: + type: string + image_directory: + type: string + img_path: + type: string + path_normal: + type: string + description: 'Path to the store (i.e., domain + protocol)' + path: + type: string + address: + type: string + language: + type: object + properties: + code: + type: string + direction: + type: string + description: 'Left to right or right to left, depending on the language' + customer: + type: object + properties: + first_name: + type: string + full_name: + type: string + email: + type: string + group: + type: array + items: + type: object + properties: + name: + type: string + misc: + type: object + properties: + year: + type: integer + translations: + type: object + properties: + en: + type: object + properties: + title: + type: string + hello: + type: string + message: + type: string + details_title: + type: string + email_label: + type: string + password_label: + type: string + password_placeholder: + type: string + sign_in: + type: string + help: + type: string + go_shopping: + type: string +example: + store: + name: My Dev Store 97434969 + domain_name: my-dev-store-97434969.store.bcdev + logo: + title: [= My Dev Store 97434969 =] + name: avatar-2020_1612860757__16350.jpeg + url: 'https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96/product_images/avatar-2020_1612860757__16350.jpeg' + ssl_path: 'https://my-dev-store-97434969.store.bcdev' + cdn_path: 'https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96' + image_directory: product_images + img_path: 'https://valeryderived-cloud-dev-vm.store.bcdev/r08d84bb67d250c7624502ed76d8e0bafb1a5cacf/g-themes/ClassicNext/images' + path_normal: 'https://my-dev-store-97434969.store.bcdev' + path: 'https://my-dev-store-97434969.store.bcdev' + address: '123 Fake St, Dallas, TX 75225' + language: + code: en + direction: ltr + customer: + first_name: John + full_name: John Jr + email: john.f@example.com + misc: + year: 2021 + translations: + en: + title: Thanks for registering at {{store}} + hello: Hello {{name}}. + message: Thank you for creating your account at {{name}}. + details_title: Account details + email_label: 'Email Address:' + password_label: 'Password:' + password_placeholder: [The password you specified] + sign_in: Sign in to account + help: If you have any questions regarding your account, click 'Reply' in your email client and we'll be only too happy to help. + go_shopping: Go shopping + + diff --git a/models/email_templates/combined/create_guest_account_email.yml b/models/email_templates/combined/create_guest_account_email.yml new file mode 100644 index 000000000..486291670 --- /dev/null +++ b/models/email_templates/combined/create_guest_account_email.yml @@ -0,0 +1,114 @@ +title: Create Guest Account Email Template +description: Guest account created email triggers when a customer or store admin creates a guest account. +type: object +properties: + guest_account: + type: object + properties: + link: + type: string + store: + type: object + properties: + name: + type: string + domain_name: + type: string + logo: + type: object + properties: + title: + type: string + name: + type: string + url: + type: string + ssl_path: + type: string + cdn_path: + type: string + image_directory: + type: string + img_path: + type: string + path_normal: + type: string + description: 'Path to the store (i.e., domain + protocol)' + path: + type: string + address: + type: string + language: + type: object + properties: + code: + type: string + direction: + type: string + description: 'Left to right or right to left, depending on the language' + customer: + type: object + properties: + first_name: + type: string + full_name: + type: string + email: + type: string + misc: + type: object + properties: + year: + type: integer + translations: + type: object + properties: + en: + type: object + properties: + title: + type: string + hello: + type: string + message: + type: string + instruction: + type: string + help: + type: string + go_shopping: + type: string +examples: + guest_account: + link: 'https://example.com/reset-password' + store: + name: My Dev Store 97434969 + domain_name: my-dev-store-97434969.store.bcdev + logo: + title: [= My Dev Store 97434969 =] + name: avatar-2020_1612860757__16350.jpeg + url: 'https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96/product_images/avatar-2020_1612860757__16350.jpeg' + ssl_path: 'https://my-dev-store-97434969.store.bcdev' + cdn_path: 'https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96' + image_directory: product_images + img_path: 'https://valeryderived-cloud-dev-vm.store.bcdev/r08d84bb67d250c7624502ed76d8e0bafb1a5cacf/g-themes/ClassicNext/images' + path_normal: 'https://my-dev-store-97434969.store.bcdev' + path: 'https://my-dev-store-97434969.store.bcdev' + address: '123 Fake St, Dallas, TX 75225' + language: + code: en + direction: ltr + customer: + first_name: John + full_name: John Jr + email: 'john.f@example.com' + misc: + year: 2021 + translations: + en: + title: Welcome to {{name}} + hello: Hello {{name}}, + message: For your convenience, we've created you an account on {{store}} so you can check the status of your order and checkout quicker in the future. + instruction: 'To login you will need to follow the link below to nominate your password:' + help: If you have any questions regarding your account, click 'Reply' in your email client and we'll be only too happy to help. + go_shopping: Go shopping diff --git a/models/email_templates/combined/gift_certificate_email.yml b/models/email_templates/combined/gift_certificate_email.yml new file mode 100644 index 000000000..e77e2361f --- /dev/null +++ b/models/email_templates/combined/gift_certificate_email.yml @@ -0,0 +1,155 @@ +title: Gift Certificate Email Template +description: Gift certificate recipient email triggers when a customer purchases a gift certificate. +type: object +properties: + certificate: + type: object + properties: + code: + type: string + to_name: + type: string + to_email: + type: string + from_name: + type: string + from_email: + type: string + amount: + type: string + redeem_link: + type: string + expiry_date: + type: object + properties: + formatted: + type: string + value: + type: integer + store: + type: object + properties: + name: + type: string + domain_name: + type: string + logo: + type: object + properties: + title: + type: string + name: + type: string + url: + type: string + ssl_path: + type: string + cdn_path: + type: string + image_directory: + type: string + img_path: + type: string + path_normal: + type: string + description: 'Path to the store (i.e., domain + protocol)' + path: + type: string + address: + type: string + language: + type: object + properties: + code: + type: string + direction: + type: string + description: 'Left to right or right to left, depending on the language' + customer: + type: object + properties: + first_name: + type: string + full_name: + type: string + email: + type: string + group: + type: array + items: + type: object + properties: + name: + type: string + misc: + type: object + properties: + year: + type: integer + translations: + type: object + properties: + en: + type: object + properties: + title: + type: string + hello: + type: string + message: + type: string + expiry_info: + type: string + instruction: + type: string + attached: + type: string + warning: + type: string + go_shopping: + type: string +example: + certificate: + code: FA-21465 + to_name: John + to_email: 'john.f@example.com' + from_name: John Wick + from_email: 'johnwick@example.com' + amount: '12.34' + redeem_link: '#redeem-link' + expiry_date: + formatted: 03/01/2121 + value: 1614615821 + store: + name: My Dev Store 97434969 + domain_name: my-dev-store-97434969.store.bcdev + logo: + title: [= My Dev Store 97434969 =] + name: avatar-2020_1612860757__16350.jpeg + url: 'https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96/product_images/avatar-2020_1612860757__16350.jpeg' + ssl_path: 'https://my-dev-store-97434969.store.bcdev' + cdn_path: 'https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96' + image_directory: product_images + img_path: 'https://valeryderived-cloud-dev-vm.store.bcdev/r08d84bb67d250c7624502ed76d8e0bafb1a5cacf/g-themes/ClassicNext/images' + path_normal: 'https://my-dev-store-97434969.store.bcdev' + path: 'https://my-dev-store-97434969.store.bcdev' + address: '123 Fake St, Dallas, TX 75225 USA' + language: + code: en + direction: ltr + customer: + first_name: John + full_name: John Jr + email: 'john.f@example.com' + misc: + year: 2021 + translations: + en: + title: You have received a Gift Certificate for {{name}} + hello: Dear {{name}}, + message: '{{from_name}} ({{from_email}}) has sent you a {{amount}} gift certificate for {{name]}.' + expiry_info: You have until {{date}} to use this gift certificate before it expires. + instruction: 'For instructions on how to redeem your gift certificate please click here.' + attached: Your gift certificate is attached to this email. + warning: Please download or print a copy of your gift certificate for safe keeping as gift certificates are non-transferable. + go_shopping: Go shopping diff --git a/models/email_templates/combined/global.yml b/models/email_templates/combined/global.yml new file mode 100644 index 000000000..16140df2d --- /dev/null +++ b/models/email_templates/combined/global.yml @@ -0,0 +1,88 @@ +title: Global Email Template Object +description: Data objects across all email templates. +type: object +properties: + store: + type: object + properties: + name: + type: string + domain_name: + type: string + logo: + type: object + properties: + title: + type: string + name: + type: string + url: + type: string + ssl_path: + type: string + cdn_path: + type: string + image_directory: + type: string + img_path: + type: string + path_normal: + type: string + description: 'Path to the store (i.e., domain + protocol)' + path: + type: string + address: + type: string + language: + type: object + properties: + code: + type: string + direction: + type: string + description: 'Left to right or right to left, depending on the language' + customer: + type: object + properties: + first_name: + type: string + full_name: + type: string + email: + type: string + group: + type: array + items: + type: object + properties: + name: + type: string + misc: + type: object + properties: + year: + type: integer +example: + store: + name: string, + domain_name: string + logo: + title: string + name: string + url: string + ssl_path: string + cdn_path: string + image_directory: string + img_path: string + path_normal: string + path: string + address: string + language: + code: string + direction: string + customer: + first_name: string + full_name: string + email: string + misc: + year: int diff --git a/models/email_templates/combined/invoice_email.yml b/models/email_templates/combined/invoice_email.yml new file mode 100644 index 000000000..4c2113a9c --- /dev/null +++ b/models/email_templates/combined/invoice_email.yml @@ -0,0 +1,523 @@ +title: Order Email Template +description: Order email triggers when a customer or store admin creates an order. +type: object +properties: + order: + type: object + properties: + id: + type: integer + customer_message: + type: string + customer_id: + type: integer + date_placed: + type: object + properties: + formatted: + type: string + value: + type: integer + account_order_status_url: + type: string + shipping: + type: object + properties: + methods: + type: array + items: + type: object + properties: + address: + type: object + properties: + email: + type: string + phone: + type: string + first_name: + type: string + last_name: + type: string + company: + type: string + country: + type: string + city: + type: string + state: + type: string + zip: + type: string + address_lines: + type: array + items: + type: object + properties: + custom_fields: + type: array + items: + type: object + properties: + products: + type: array + items: + type: object + properties: + name: + type: string + quantity: + type: integer + sku: + type: string + address_lines: + type: array + items: + type: object + properties: + address_id: + type: integer + options: + type: object + properties: + Size: + type: string + download_url: + type: string + thumbnail: + type: string + brand: + type: string + event: + type: object + properties: + name: + type: string + date: + type: object + properties: + value: + type: integer + formatted: + type: string + price: + type: object + properties: + value: + type: float + formatted: + type: string + total: + type: object + properties: + value: + type: float + formatted: + type: string + preorder: + type: object + properties: + is_preorder: + type: boolean + message: + type: string + date: + type: object + properties: + value: + type: integer + formatted: + type: string + attribute_lines: + type: array + description: A list of strings that represents product variant options. + items: + type: object + properties: + configurable_fields: + type: array + description: Object array with properties name and value. + items: + type: object + properties: + payment: + type: object + properties: + is_test: + type: boolean + provider_name: + type: string + offline_payment_message: + type: string + gateway_amount: + type: object + description: Price value. Provided only if the payment method is offline. + properties: + formatted: + type: string + value: + type: float + billing: + type: object + properties: + is_managed_by_amazon: + type: boolean + address: + type: object + properties: + email: + type: string + phone: + type: string + first_name: + type: string + last_name: + type: string + company: + type: string + country: + type: string + city: + type: string + state: + type: string + zip: + type: string + address_lines: + type: array + items: + type: object + properties: + custom_fields: + type: array + items: + type: object + properties: + total_rows: + type: array + items: + type: object + properties: + label: + type: string + price: + type: object + properties: + value: + type: float + formatted: + type: string + shipping_discounts: + type: array + items: + type: object + properties: + total_cost: + type: object + properties: + formatted: + type: string + value: + type: float + meta: + type: object + properties: + mandate_url: + type: string + description: Link to the confirmation page in Stripe + mandate_tag: + type: string + description: Short name of the payment document + shipping_addresses_num: + type: integer + show_immediate_download: + type: boolean + store: + type: object + properties: + name: + type: string + domain_name: + type: string + logo: + type: object + properties: + title: + type: string + name: + type: string + url: + type: string + ssl_path: + type: string + cdn_path: + type: string + image_directory: + type: string + img_path: + type: string + path_normal: + type: string + description: 'Path to the store (i.e., domain + protocol)' + path: + type: string + address: + type: string + language: + type: object + properties: + code: + type: string + direction: + type: string + description: 'Left to right or right to left, depending on the language' + customer: + type: object + properties: + first_name: + type: string + full_name: + type: string + email: + type: string + group: + type: array + items: + type: object + properties: + name: + type: string + misc: + type: object + properties: + year: + type: integer + translations: + type: object + properties: + en: + type: object + properties: + comment_label: + type: string + order_id_line: + type: string + view_summary: + type: string + sepa: + type: string + description: A link to SEPA mandate and also receive this link embedded on email confirmation. + shipment_to_multiple_addresses: + type: string + shipping_immediate_download: + type: string + shipping_address_label: + type: string + immediate_download: + type: string + email: + type: string + billing_address_managed_by_amazon: + type: string + billing_address_label: + type: string + pending_payment: + type: string + how_to_pay: + type: string + pay_for_order_help: + type: string + order_total: + type: string + cart_items: + type: string + sku: + type: string + quantity: + type: string + item_price: + type: string + item_total: + type: string + payment_method: + type: string + no_payment_taken_in_test_mode: + type: string + download_files: + type: string + preorder: + type: string + download_available_after_payment: + type: string + shipped_to: + type: string + shipping_discount: + type: string + thanks_for_your_order: + type: string + your_order_contains: + type: string + shipping_method: + type: string + shipping_to_address: + type: string + your_order_will_be_shipped_by: + type: string + total_cost: + type: string + items: + type: string + total: + type: string + price: + type: string + email_address: + type: string +examples: + order: + id: 1 + customer_message: Order custom message + customer_id: 11 + date_placed: + formatted: 11th Feb 2021 + value: 1613060604 + account_order_status_url: #url + shipping: + methods: + address: + email: 'test@gmail.com' + phone: +112233445566 + first_name: John + last_name: Wick + company: MyCompany + country: + city: + state: + zip: 1622 + address_lines: + custom_fields: + products: + - name: Test product name + quantity: 2 + sku: SF42 + address_lines: + address_id: 0 + options: + Size: XL + download_url: + thumbnail_url: /test.jpg + event: + name: + date: + value: 0 + formatted: + price: + value: 250.1 + formatted: 250.1 + total: + value: 250.1, + formatted: 250.1 + preorder: + is_preorder: false + message: + date: + value: 0 + formatted: + attribute_lines: + configurable_fields: + payment: + is_test: false + provider_name: PaymentMethod + offline_payment_message: + gateway_amount: + formatted: + value: 0 + billing: + is_managed_by_amazon: false + address: + email: 'test@gmail.com' + phone: +112233445566 + first_name: John + last_name: Wick + company: MyCompany + country: + city: + state: + zip: 1622 + address_lines: + custom_fields: + total_rows: + - label: Total, + price: + value: 250.1, + formatted: 250.1 + shipping_discounts: + total_cost: + formatted: 100.0$, + value: 100 + meta: + mandate_url: + shipping_addresses_num: 1 + show_immediate_download: false + store: + name: My Dev Store 97434969 + domain_name: 'my-dev-store-97434969.store.bcdev' + logo: + title: [= My Dev Store 97434969 =] + name: 'avatar-2020_1612860757__16350.jpeg' + url: 'https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96/product_images/avatar-2020_1612860757__16350.jpeg' + ssl_path: 'https://my-dev-store-97434969.store.bcdev' + cdn_path: 'https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96' + image_directory: product_images + img_path: 'https://valeryderived-cloud-dev-vm.store.bcdev/r08d84bb67d250c7624502ed76d8e0bafb1a5cacf/g-themes/ClassicNext/images' + path_normal: 'https://my-dev-store-97434969.store.bcdev' + path: 'https://my-dev-store-97434969.store.bcdev' + address: '123 Fake St, Dallas, TX 75225' + language: + code: en + direction: ltr + customer: + first_name: John, + full_name: John Jr + email: 'john.f@example.com' + misc: + year: 2021 + translations: + en: + comment_label: Order Instructions/Comments + order_id_line: Your order ID is #{{id}}. + view_summary: A summary of your order is shown below. To view the status of your order click here. + sepa: 'SEPA Direct Debit Mandate' + shipment_to_multiple_addresses: (Order will be shipped to multiple addresses) + shipping_immediate_download: Immediate download after completion of payment. + shipping_address_label: Shipping Address + immediate_download: Immediate Download + email: Email + billing_address_managed_by_amazon: Managed by Amazon + billing_address_label: Billing Address + pending_payment: Your order requires payment before it can be finalized. Details on how to pay are shown below. + how_to_pay: Your order requires payment before it can be finalized. Details on how to pay are shown below. + pay_for_order_help: Once you've provided payment your order will be completed. + order_total: The outstanding balance of your order is amount + cart_items: Cart Items + sku: SKU + quantity: Qty + item_price: Item Price + item_total: Item Total + payment_method: Payment Method + no_payment_taken_in_test_mode: 'Please Note: No money was taken for this order, because the payment provider is in test mode.' + download_files: Download Files + preorder: This product is available for pre-order only + download_available_after_payment: Items available for immediate download after completion of payment + shipped_to: Items shipped to address + shipping_discount: price off using code Coupon Code + thanks_for_your_order: Thanks for Your Order + your_order_contains: Your Order Contains... + shipping_method: Shipping Method + shipping_to_address: Shipping to Address + your_order_will_be_shipped_by: Your Order Will Be Shipped By... + total_cost: Total Cost + items: Items + total: Total + price: Price + email_address: Email Address diff --git a/models/email_templates/combined/order_message_notification.yml b/models/email_templates/combined/order_message_notification.yml new file mode 100644 index 000000000..9c9c987af --- /dev/null +++ b/models/email_templates/combined/order_message_notification.yml @@ -0,0 +1,123 @@ +title: Order Notification Email Template +description: Order notification email triggers when a retailer or store admin adds a message to an order. +type: object +properties: + notification: + type: object + properties: + message: + type: string + link: + type: string + subject: + type: string + store: + type: object + properties: + name: + type: string + domain_name: + type: string + logo: + type: object + properties: + title: + type: string + name: + type: string + url: + type: string + ssl_path: + type: string + cdn_path: + type: string + image_directory: + type: string + img_path: + type: string + path_normal: + type: string + description: 'Path to the store (i.e., domain + protocol)' + path: + type: string + address: + type: string + language: + type: object + properties: + code: + type: string + direction: + type: string + description: 'Left to right or right to left, depending on the language' + customer: + type: object + properties: + first_name: + type: string + full_name: + type: string + email: + type: string + group: + type: array + items: + type: object + properties: + name: + type: string + misc: + type: object + properties: + year: + type: integer + translations: + type: object + properties: + en: + type: object + properties: + title: + type: string + hello: + type: string + message: + type: string + reply: + type: string + go_shopping: + type: string +example: + notification: + message: Message from the retailer + link: 'https://my-dev-store-97434969.store.bcdev/account.php?action=inbox' + store: + name: My Dev Store 97434969 + domain_name: my-dev-store-97434969.store.bcdev + logo: + title: [= My Dev Store 97434969 =] + name: avatar-2020_1612860757__16350.jpeg + url: 'https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96/product_images/avatar-2020_1612860757__16350.jpeg' + ssl_path: 'https://my-dev-store-97434969.store.bcdev' + cdn_path: 'https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96' + image_directory: product_images + img_path: 'https://valeryderived-cloud-dev-vm.store.bcdev/r08d84bb67d250c7624502ed76d8e0bafb1a5cacf/g-themes/ClassicNext/images' + path_normal: 'https://my-dev-store-97434969.store.bcdev' + path: 'https://my-dev-store-97434969.store.bcdev' + address: '123 Fake St, Dallas, TX 75225' + language: + code: en + direction: ltr + customer: + first_name: John + full_name: John Jr + email: 'john.f@example.com' + misc: + year: 2021 + translations: + en: + title: New Reply to your Order Message + hello: Hello {{name}}. + message: '{{name}} has sent you a message about your order.' + reply: Reply + go_shopping: Go shopping diff --git a/models/email_templates/combined/passwordless_login_email.yml b/models/email_templates/combined/passwordless_login_email.yml new file mode 100644 index 000000000..30db28ba8 --- /dev/null +++ b/models/email_templates/combined/passwordless_login_email.yml @@ -0,0 +1,120 @@ +title: Sign in Link Request Email Template +description: Sign-in request email triggers when an existing customer requests passwordless login while checking out. +type: object +properties: + passwordless_login: + type: object + properties: + link: + type: string + store: + type: object + properties: + name: + type: string + domain_name: + type: string + logo: + type: object + properties: + title: + type: string + name: + type: string + url: + type: string + ssl_path: + type: string + cdn_path: + type: string + image_directory: + type: string + img_path: + type: string + path_normal: + type: string + description: 'Path to the store (i.e., domain + protocol)' + path: + type: string + address: + type: string + language: + type: object + properties: + code: + type: string + direction: + type: string + description: 'Left to right or right to left, depending on the language' + customer: + type: object + properties: + first_name: + type: string + full_name: + type: string + email: + type: string + group: + type: array + items: + type: object + properties: + name: + type: string + misc: + type: object + properties: + year: + type: integer + translations: + type: object + properties: + en: + type: object + properties: + title: + type: string + message: + type: string + alternatively: + type: string + login_request: + type: string + secure: + type: string + go_shopping: + type: string +example: + passwordless_login: '"link": "#sign-in-link"' + store: + name: My Dev Store 97434969 + domain_name: 'my-dev-store-97434969.store.bcdev' + logo: + title: [= My Dev Store 97434969 =] + name: avatar-2020_1612860757__16350.jpeg + url: 'https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96/product_images/avatar-2020_1612860757__16350.jpeg' + ssl_path: 'https://my-dev-store-97434969.store.bcdev' + cdn_path: 'https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96' + image_directory: product_images + img_path: 'https://valeryderived-cloud-dev-vm.store.bcdev/r08d84bb67d250c7624502ed76d8e0bafb1a5cacf/g-themes/ClassicNext/images' + path_normal: 'https://my-dev-store-97434969.store.bcdev' + path: 'https://my-dev-store-97434969.store.bcdev' + address: '123 Fake St, Dallas, TX 75225' + language: + code: en + direction: ltr + customer: + first_name: John + full_name: John Jr + email: 'john.f@example.com' + misc: + year: 2021 + translations: + en: + title: Please click the link below to sign in to your account with {{name}} + message: 'You have requested a sign-in link. Please click here to sign in and continue.' + alternatively: 'Alternatively, paste the following link in your browser:' + login_request: This login is for {{name}} if you did not request this link, please ignore this email. + secure: Your account is still secure. + go_shopping: Go shopping diff --git a/models/email_templates/combined/product_review_email.yml b/models/email_templates/combined/product_review_email.yml new file mode 100644 index 000000000..ad5eea723 --- /dev/null +++ b/models/email_templates/combined/product_review_email.yml @@ -0,0 +1,143 @@ +title: Product Review Email Template +description: Product review request email triggers after a customer purchases a product. +type: object +properties: + review: + type: object + properties: + products: + type: array + items: + type: object + properties: + name: + type: string + sku: + type: string + link: + type: string + price: + type: string + thumbnail: + type: string + unsubscribe_link: + type: string + store: + type: object + properties: + name: + type: string + domain_name: + type: string + logo: + type: object + properties: + title: + type: string + name: + type: string + url: + type: string + ssl_path: + type: string + cdn_path: + type: string + image_directory: + type: string + img_path: + type: string + path_normal: + type: string + description: 'Path to the store (i.e., domain + protocol)' + path: + type: string + address: + type: string + language: + type: object + properties: + code: + type: string + direction: + type: string + description: 'Left to right or right to left, depending on the language' + customer: + type: object + properties: + first_name: + type: string + full_name: + type: string + email: + type: string + group: + type: array + items: + type: object + properties: + name: + type: string + misc: + type: object + properties: + year: + type: integer + translations: + type: object + properties: + en: + type: object + properties: + title: + type: string + hello: + type: string + message: + type: string + instruction: + type: string + review_text: + type: string + thanks: + type: string + go_shopping: + type: string +examples: + review: + products: + - name: Name of Product + sku: FA44 + link: '#review-link' + unsubscribe_link: '#unsubscribe-link' + store: + name: My Dev Store 97434969 + domain_name: my-dev-store-97434969.store.bcdev + logo: + title: [= My Dev Store 97434969 =] + name: avatar-2020_1612860757__16350.jpeg + url: 'https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96/product_images/avatar-2020_1612860757__16350.jpeg' + ssl_path: 'https://my-dev-store-97434969.store.bcdev' + cdn_path: 'https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96' + image_directory: product_images + img_path: 'https://valeryderived-cloud-dev-vm.store.bcdev/r08d84bb67d250c7624502ed76d8e0bafb1a5cacf/g-themes/ClassicNext/images' + path_normal: 'https://my-dev-store-97434969.store.bcdev' + path: 'https://my-dev-store-97434969.store.bcdev' + address: '123 Fake St, Dallas, TX 75225' + language: + code: en + direction: ltr + customer: + first_name: John + full_name: John Jr + email: 'john.f@example.com' + misc: + year: 2021 + translations: + en: + title: Review products you've recently purchased + hello: Hello {{name}}, + message: Thanks for your recent order with us!, + instruction: If you have a few minutes, we'd like to invite you to review the products you ordered. Just click on the link below to write a review and share your opinion with other shoppers. + review_text: Review product + thanks: Thanks in advance for taking the time to review the products you purchased! + go_shopping: Go shopping diff --git a/models/email_templates/combined/return_confirmation_email.yml b/models/email_templates/combined/return_confirmation_email.yml new file mode 100644 index 000000000..108a0977b --- /dev/null +++ b/models/email_templates/combined/return_confirmation_email.yml @@ -0,0 +1,163 @@ +title: Return Requested Email Template +description: 'Return requested email triggers after a customer’s return is approved.' +type: object +properties: + return: + type: object + properties: + return_id: + type: string + reason: + type: string + action: + type: string + comments: + type: string + products: + type: array + items: + type: object + properties: + name: + type: string + quantity: + type: integer + price: + type: string + sku: + type: string + thumbnail: + type: string + order: + type: object + properties: + id: + type: integer + store: + type: object + properties: + name: + type: string + domain_name: + type: string + logo: + type: object + properties: + title: + type: string + name: + type: string + url: + type: string + ssl_path: + type: string + cdn_path: + type: string + image_directory: + type: string + img_path: + type: string + path_normal: + type: string + description: 'Path to the store (i.e., domain + protocol)' + path: + type: string + address: + type: string + language: + type: object + properties: + code: + type: string + direction: + type: string + description: 'Left to right or right to left, depending on the language' + customer: + type: object + properties: + first_name: + type: string + full_name: + type: string + email: + type: string + group: + type: array + items: + type: object + properties: + name: + type: string + misc: + type: object + properties: + year: + type: integer + translations: + type: object + properties: + en: + type: object + properties: + confirmation: + type: string + summary: + type: string + clickHere: + type: string + reason: + type: string + action: + type: string + comments: + type: string + contains: + type: string + items: + type: string + quantity: + type: string +example: + return: + return_id: 123 + reason: reason of return + action: action + comments: sample comment + order_id: 321 + products: + - name: Shower Gel + quantity: 3 + store: + name: My Dev Store 97434969 + domain_name: 'my-dev-store-97434969.store.bcdev' + logo: + title: '[= My Dev Store 97434969 =]' + name: avatar-2020_1612860757__16350.jpeg + url: 'https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96/product_images/avatar-2020_1612860757__16350.jpeg' + ssl_path: 'https://my-dev-store-97434969.store.bcdev' + cdn_path: 'https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96' + image_directory: product_images + img_path: 'https://valeryderived-cloud-dev-vm.store.bcdev/r08d84bb67d250c7624502ed76d8e0bafb1a5cacf/g-themes/ClassicNext/images' + path_normal: 'https://my-dev-store-97434969.store.bcdev' + path: 'https://my-dev-store-97434969.store.bcdev' + address: '123 Fake St, Dallas, TX 75225' + language: + code: en + direction: ltr + customer: + first_name: John + full_name: John Jr + email: 'john.f@example.com' + misc: + year: 2021 + translations: + en: + confirmation: Confirmation for Return Request for Order ID + summary: A summary of your return is shown below. To view the status of this return + clickHere: click here + reason: Return Reason + action: Return Action + comments: Your Comments + contains: Your Return Request Contains the Following Items... + items: Return Items + quantity: Qty diff --git a/models/email_templates/combined/return_status_change_email.yml b/models/email_templates/combined/return_status_change_email.yml new file mode 100644 index 000000000..7b712671b --- /dev/null +++ b/models/email_templates/combined/return_status_change_email.yml @@ -0,0 +1,201 @@ +description: Return status change email triggers after a customer returnʼs status has changed. +type: object +title: Return Status Change Email Template +properties: + return: + type: object + properties: + id: + type: integer + reason: + type: string + action: + type: string + comments: + type: string + product: + type: object + properties: + name: + type: string + quantity: + type: integer + price: + type: string + sku: + type: string + thumbnail: + type: string + status: + type: object + properties: + value: + type: integer + formatted: + type: string + store_credit: + type: object + properties: + value: + type: float + formatted: + type: string + link: + type: string + instructions: + type: string + order: + type: object + properties: + id: + type: integer + store: + type: object + properties: + name: + type: string + domain_name: + type: string + logo: + type: object + properties: + title: + type: string + name: + type: string + url: + type: string + ssl_path: + type: string + cdn_path: + type: string + image_directory: + type: string + img_path: + type: string + path_normal: + type: string + description: 'Path to the store (i.e., domain + protocol)' + path: + type: string + address: + type: string + language: + type: object + properties: + code: + type: string + direction: + type: string + description: 'Left to right or right to left, depending on the language' + customer: + type: object + properties: + first_name: + type: string + full_name: + type: string + email: + type: string + group: + type: array + items: + type: object + properties: + name: + type: string + misc: + type: object + properties: + year: + type: integer + translations: + type: object + properties: + en: + type: object + properties: + title: + type: string + hello: + type: string + message: + type: string + received_credit: + type: string + details_title: + type: string + return_reason: + type: string + return_action: + type: string + return_comments: + type: string + check_status: + type: string + products_title: + type: string + quantity: + type: string + instructions_title: + type: string + go_shopping: + type: string +example: + return: + id: 1 + reason: reason of return + action: action + comments: sample comment + product: + name: ProductName + quantity: 2 + thumbnail_url: '' + status: + value: 1 + formatted: Pending + store_credit: + value: 10.1 + formatted: '$10.1 USD' + link: 'https://my-dev-store-97434969.store.bcdev/account.php?action=view_returns' + instructions: + order: + id: 1 + store: + name: My Dev Store 97434969 + domain_name: my-dev-store-97434969.store.bcdev + logo: + title: '[= My Dev Store 97434969 =]' + name: avatar-2020_1612860757__16350.jpeg + url: 'https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96/product_images/avatar-2020_1612860757__16350.jpeg' + ssl_path: 'https://my-dev-store-97434969.store.bcdev' + cdn_path: 'https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96' + image_directory: product_images + img_path: 'https://valeryderived-cloud-dev-vm.store.bcdev/r08d84bb67d250c7624502ed76d8e0bafb1a5cacf/g-themes/ClassicNext/images' + path_normal: 'https://my-dev-store-97434969.store.bcdev' + path: 'https://my-dev-store-97434969.store.bcdev' + address: '123 Fake St, Dallas, TX 75225' + language: + code: en + direction: ltr + customer: + first_name: John + full_name: John Jr + email: 'john.f@example.com' + misc: + year: 2021 + translations: + en: + title: 'Return request status changed' + hello: 'Hello {{name}}' + message: 'The status of your return request for order #{{id}} has changed to {{status}}.' + received_credit: 'You have received a store credit of {{credits}} To use it simply place your order and you will be able to choose store credit as the payment method when it comes time to pay for your order.' + details_title: Return details + return_reason: 'Return reason:' + return_action: 'Return action:' + return_comments: 'Your comments:' + check_status: Check return status + products_title: Return items + quantity: 'Qty:' + instructions_title: 'Return Instructions:' + go_shopping: Go shopping diff --git a/reference/abandoned_cart_emails.v3.yaml b/reference/abandoned_cart_emails.v3.yaml index eb8a5efc4..7674f9067 100644 --- a/reference/abandoned_cart_emails.v3.yaml +++ b/reference/abandoned_cart_emails.v3.yaml @@ -506,15 +506,15 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/abandoned_carts.v3.yml b/reference/abandoned_carts.v3.yml index 96fbecec9..b53d3f156 100644 --- a/reference/abandoned_carts.v3.yml +++ b/reference/abandoned_carts.v3.yml @@ -87,13 +87,6 @@ paths: operationId: getChannelAbandonedCartSettings tags: - Abandoned Carts Settings - parameters: - - name: channel_id - description: The channel ID of the settings overrides - in: path - required: true - schema: - type: integer responses: '200': description: OK @@ -120,12 +113,6 @@ paths: tags: - Abandoned Carts Settings parameters: - - name: channel_id - description: The channel ID of the settings overrides - in: path - required: true - schema: - type: integer - $ref: '#/components/parameters/ContentType' requestBody: required: true @@ -154,13 +141,13 @@ paths: $ref: '#/components/schemas/ErrorResponse' security: [] parameters: - - $ref: '#/components/parameters/Accept' - - schema: - type: string - name: channel_id + - name: channel_id + description: The channel ID of the settings overrides in: path required: true + schema: + type: integer '/abandoned-carts/{token}': get: responses: @@ -336,15 +323,15 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header schemas: @@ -385,7 +372,7 @@ components: properties: cart_id: type: string - description: The `cart_id` of the abandoned cart. Can be used to display the abandoned cart to the customer using storefront cart or + description: The `cart_id` of the abandoned cart. Can be used to display the abandoned cart to the customer using storefront cart or server-to-server cart APIs. x-internal: false AbandonedCartSettings: description: Represents all settings related to the abandoned cart functionality of a store diff --git a/reference/carts.sf.yml b/reference/carts.sf.yml index 47bbf9a4b..7b0adb56f 100644 --- a/reference/carts.sf.yml +++ b/reference/carts.sf.yml @@ -5,9 +5,14 @@ info: description: |- Manage cart operations and data using frontend JavaScript on BigCommerce Stencil-powered storefronts. - For info about API accounts, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). + For info about API accounts, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). - For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#same-origin-cors-authentication). + For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#same-origin-cors-authentication). + termsOfService: 'https://www.bigcommerce.com/terms' + contact: + name: BigCommerce + url: 'https://www.bigcommerce.com' + email: support@bigcommerce.com servers: - url: 'https://{store_domain}/api/storefront' variables: @@ -66,6 +71,20 @@ paths: - optionId: 10 optionValue: Some Text Value locale: en + With Gift Wrapping: + value: + lineItems: + - quantity: 2 + productId: 230 + optionSelections: + - optionId: 10 + optionValue: Some Text Value + giftWrapping: + wrapTogether: true + wrapDetails: + - id: 1 + message: "Happy Birthday" + locale: en required: true responses: '200': @@ -104,10 +123,10 @@ paths: description: |- Adds a line items to the *Cart*. - - > #### Note + > #### Notes > * Substitute your storefront domain for `yourstore.example.com`. > * The Send a Test Request feature is not currently supported for this endpoint. + > * Please note that this API endpoint is not concurrent safe, meaning multiple simultaneous requests could result in unexpected and inconsistent results. operationId: addCartLineItem parameters: @@ -155,6 +174,17 @@ paths: optionValue: 117 - optionId: 11 optionValue: 125 + With Gift Wrapping: + value: + lineItems: + - quantity: 2 + productId: 230 + variantId: 124 + giftWrapping: + wrapTogether: true + wrapDetails: + - id: 1 + message: "Happy Birthday" description: '' '/carts/{cartId}/items/{itemId}': put: @@ -164,12 +194,13 @@ paths: description: |- Updates a *Cart* line item. Updates an existing, single line item quantity and the price of custom items in a cart. - If a modified product or variant needs to be changed or updated, you can remove and re-add the product to the cart with the correct variants using the [Delete Cart Line Item](/docs/rest-storefront/carts/cart-items#delete-cart-line-item) and the [Add Cart Line Items](/docs/rest-storefront/carts/cart-items#add-cart-line-items) endpoints. You can also use carts mutations that are part of the [GraphQL Storefront API](/api-docs/storefront/graphql/carts-and-checkout). + If a modified product or variant needs to be changed or updated, you can remove and re-add the product to the cart with the correct variants using the [Delete Cart Line Item](/docs/rest-storefront/carts/cart-items#delete-cart-line-item) and the [Add Cart Line Items](/docs/rest-storefront/carts/cart-items#add-cart-line-items) endpoints. You can also use carts mutations that are part of the [GraphQL Storefront API](/docs/storefront/cart-checkout/guide/graphql-storefront). - > #### Note + > #### Notes > * Substitute your storefront domain for `yourstore.example.com`. - > * The Send a Test Request feature is not currently supported for this endpoint. + > * The Send a Test Request feature is not currently supported for this endpoint. + > * Please note that this API endpoint is not concurrent safe, meaning multiple simultaneous requests could result in unexpected and inconsistent results. operationId: updateCartLineItem parameters: @@ -227,6 +258,24 @@ paths: - optionId: 125 optionValue: 127 locale: en + With Gift Wrapping: + value: + lineItem: + quantity: 2 + productId: 230 + variantId: 124 + giftWrapping: + wrapTogether: true + wrapDetails: + - id: 1 + message: "Happy Birthday" + With null Gift Wrapping (will delete current gift wrapping): + value: + lineItem: + quantity: 2 + productId: 230 + variantId: 124 + giftWrapping: null required: true responses: '200': @@ -504,6 +553,39 @@ components: type: string description: 'Currently supports `Birthday`, `Boy`, `Celebration`, `Christmas`, `General`, and `Girl`.' x-internal: false + requestPostOrPutGiftWrapping: + title: Gift Wrapping Request Data + required: + - wrapTogether + - wrapDetails + type: object + nullable: true + description: if passing null, it will remove the current gift wrapping for the item + properties: + wrapTogether: + type: boolean + description: Boolean value that specifies whether items whether items should be wrapped together or wrapped individually. + example: true + wrapDetails: + type: array + description: |- + Details for the gift wrapping option selected. This can be specified for each line item or together based on wrapTogether value. + If wrapTogether is false, each element in the wrapDetails array determines each item's specific wrapping. + (e.g if this line item has 6 quantity, you can pass at maximum 6 elements for the array to spefified each one's wrapping) + If wrapTogether is true, we will only use 1st element in the wrapDetails array to determine what to be wrapped + items: + type: object + required: + - id + properties: + id: + type: integer + description: Identifier of the gift wrapping option selected. + example: 0 + message: + type: string + description: Custom gift message. + example: Happy Birthday LineItemsRequest: title: requestLineItems oneOf: @@ -605,7 +687,7 @@ components: readOnly: true id: type: string - description: Id of the custom item + description: ID of the custom item readOnly: true example: f1f3a531-fbcf-439b-bac1-40d5ae5c2bff listPrice: @@ -919,6 +1001,8 @@ components: quantity: type: number description: Quantity of this item. + giftWrapping: + $ref: '#/components/schemas/requestPostOrPutGiftWrapping' required: - productId - quantity @@ -933,6 +1017,8 @@ components: variantId: type: number description: ID of the variant. + giftWrapping: + $ref: '#/components/schemas/requestPostOrPutGiftWrapping' required: - productId - quantity @@ -996,13 +1082,7 @@ components: - discountedAmount: 0 id: string lineItems: - customItems: - - extendedListPrice: 0 - id: f1f3a531-fbcf-439b-bac1-40d5ae5c2bff - listPrice: 10 - name: Custom Item Name - quantity: 1 - sku: SM-456 + customItems: [] digitalItems: - options: - name: string @@ -1105,13 +1185,7 @@ components: - discountedAmount: 0 id: string lineItems: - customItems: - - extendedListPrice: 0 - id: f1f3a531-fbcf-439b-bac1-40d5ae5c2bff - listPrice: 10 - name: Custom Item Name - quantity: 1 - sku: SM-456 + customItems: [] digitalItems: - options: - name: string @@ -1214,13 +1288,7 @@ components: - discountedAmount: 0 id: string lineItems: - customItems: - - extendedListPrice: 0 - id: f1f3a531-fbcf-439b-bac1-40d5ae5c2bff - listPrice: 10 - name: Custom Item Name - quantity: 1 - sku: SM-456 + customItems: [] digitalItems: - options: - name: string @@ -1383,119 +1451,7 @@ components: - discountedAmount: 0 id: string lineItems: - customItems: - - extendedListPrice: 0 - id: f1f3a531-fbcf-439b-bac1-40d5ae5c2bff - listPrice: 10 - name: Custom Item Name - quantity: 1 - sku: SM-456 - digitalItems: - - options: - - name: string - nameId: 0 - value: string - valueId: 0 - brand: string - couponAmount: 0 - discountAmount: 0 - discounts: - - discountedAmount: 0 - id: 0 - extendedListPrice: 0 - extendedSalePrice: 0 - id: '4' - imageUrl: 'http://example.com' - isTaxable: true - originalPrice: 0 - listPrice: 0 - name: string - parentId: '6' - productId: 0 - quantity: 0 - salePrice: 0 - sku: string - url: 'http://example.com' - variantId: 7 - giftCertificates: - - amount: 0 - id: string - isTaxable: true - message: string - name: string - recipient: - email: user@example.com - name: string - sender: - email: user@example.com - name: string - theme: string - physicalItems: - - options: - - name: string - nameId: 0 - value: string - valueId: 0 - brand: string - couponAmount: 0 - discountAmount: 0 - discounts: - - discountedAmount: 0 - id: string - extendedListPrice: 0 - extendedSalePrice: 0 - id: '4' - imageUrl: 'http://example.com' - isTaxable: true - originalPrice: 0 - listPrice: 0 - name: string - parentId: 6 - productId: 0 - quantity: 0 - salePrice: 0 - sku: string - url: 'http://example.com' - variantId: 7 - giftWrapping: null - isShippingRequired: true - createdTime: string - updatedTime: string - locale: string - deleteCarts: - description: '' - content: - application/json: - schema: - $ref: '#/components/schemas/responseCart' - examples: - example-1: - value: - id: string - customerId: 0 - email: string - currency: - code: string - isTaxIncluded: true - baseAmount: 0 - discountAmount: 0 - cartAmount: 0 - coupons: - - code: string - couponType: 0 - discountedAmount: 0 - id: string - discounts: - - discountedAmount: 0 - id: string - lineItems: - customItems: - - extendedListPrice: 0 - id: f1f3a531-fbcf-439b-bac1-40d5ae5c2bff - listPrice: 10 - name: Custom Item Name - quantity: 1 - sku: SM-456 + customItems: [] digitalItems: - options: - name: string @@ -1579,5 +1535,4 @@ components: - lineItems.physicalItems.options - lineItems.digitalItems.options - 'lineItems.digitalItems.options,lineItems.physicalItems.options' - examples: {} diff --git a/reference/carts.v3.yml b/reference/carts.v3.yml index 9b92b187a..2ad220064 100644 --- a/reference/carts.v3.yml +++ b/reference/carts.v3.yml @@ -133,15 +133,15 @@ paths: product_id: 118 list_price: 30 name: shirt - options: - - name: Size - nameId: 125 - value: Large - valueId: 127 + option_selections: + - name: Color + value: Red + option_id: 133 + option_value: 149 - name: Add a $5 Donation - nameId: 126 - value: 'No' - valueId: 129 + value: No + option_id: 126 + option_value: 129 channel_id: 1 currency: code: AUD @@ -163,7 +163,7 @@ paths: message: Happy Birthday gift_certificates: - name: Tobi Day - theme: Birthday + theme: birthday.html amount: 1 quantity: 1 sender: @@ -288,6 +288,8 @@ paths: Overriding a product’s `list_price` will make that item ineligible for V3 product level promotions. If a product has modifiers, omit the `variant_id` and instead use the `option_selections` array to describe both the **variant** and the **modifier** selections. + + Please note that this API endpoint is not concurrent safe, meaning multiple simultaneous requests could result in unexpected and inconsistent results. parameters: - name: include in: query @@ -320,7 +322,7 @@ paths: option_value: 'Yes' gift_certificates: - name: Happy Birthday - theme: Birthday + theme: birthday.html amount: 50 quantity: 1 sender: @@ -395,6 +397,8 @@ paths: `custom_items` cannot be updated via the API at this time. To update your cart, add a new updated custom item and delete the outdated one. If your cart contains only one line item, perform the add operation before the delete operation. Deleting all line items from the cart will invalidate the cart. + + Please note that this API endpoint is not concurrent safe, meaning multiple simultaneous requests could result in unexpected and inconsistent results. parameters: - name: include in: query @@ -507,7 +511,7 @@ paths: gift_certificates: - id: 6e38bbc2-8873-472c-a452-8bd4aaea5d3a name: Happy Birthday - theme: Birthday + theme: birthday.html amount: 50 quantity: 1 taxable: false @@ -530,7 +534,7 @@ paths: - $ref: '#/components/parameters/Accept' - $ref: '#/components/parameters/cartId' get: - description: Returns a storeʼs *Cart*. + description: Returns a store's *Cart*. parameters: - name: include in: query @@ -557,7 +561,7 @@ paths: operationId: getACart put: description: |- - Updates a *Cartʼs* `customer_id`. + Updates a *Cart's* `customer_id`. **Notes** @@ -792,7 +796,7 @@ paths: $ref: '#/components/schemas/MetafieldResponse' '409': description: | - The `Metafield` conflicts with another `Metafield`. This can be the result of duplicate unique key combinations of the appʼs client id, namespace, key, resource_type, and resource_id. + The `Metafield` conflicts with another `Metafield`. This can be the result of duplicate unique key combinations of the app's client id, namespace, key, resource_type, and resource_id. content: application/json: schema: @@ -819,8 +823,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetafieldPost' - examples: {} + $ref: '#/components/schemas/MetafieldPost' + example: + { + "permission_set": app_only, + "namespace": Sales Department, + "key": Staff Name, + "value": Sam, + "description": Name of staff member + } description: '' required: true responses: @@ -831,7 +842,19 @@ paths: application/json: schema: $ref: '#/components/schemas/MetaFieldCollectionResponse' - examples: {} + example: + data: + "id": 24 + "key": Staff Name + "value": Sam + "namespace": Sales Department + "permission_set": app_only + "resource_type": cart + "resource_id": b810114d-9926-45b7-bba5-7633b251154b + "description": Name of staff member + "date_created": 2023-11-15T15:16:35+00:00 + "date_modified": 2023-11-15T15:16:35+00:00 + meta: {} '404': description: | The resource was not found. @@ -862,7 +885,7 @@ paths: $ref: '#/components/schemas/MetafieldResponse' '409': description: | - The `Metafield` conflicts with another `Metafield`. This can be the result of duplicate unique key combinations of the appʼs client id, namespace, key, resource_type, and resource_id. + The `Metafield` conflicts with another `Metafield`. This can be the result of duplicate unique key combinations of the app's client id, namespace, key, resource_type, and resource_id. content: application/json: schema: @@ -991,12 +1014,12 @@ components: type: string description: The theme of the gift certificate. enum: - - Birthday - - Boy - - Celebration - - Christmas - - General - - Girl + - birthday.html + - boy.html + - celebration.html + - christmas.html + - general.html + - girl.html amount: type: number minimum: 1 @@ -1055,12 +1078,12 @@ components: type: string description: The theme of the gift certificate. enum: - - Birthday - - Boy - - Celebration - - Christmas - - General - - Girl + - birthday.html + - boy.html + - celebration.html + - christmas.html + - general.html + - girl.html amount: type: number minimum: 1 @@ -1158,12 +1181,12 @@ components: type: string description: The theme of the gift certificate. enum: - - Birthday - - Boy - - Celebration - - Christmas - - General - - Girl + - birthday.html + - boy.html + - celebration.html + - christmas.html + - general.html + - girl.html amount: type: number minimum: 1 @@ -1263,12 +1286,12 @@ components: type: string description: The theme of the gift certificate. enum: - - Birthday - - Boy - - Celebration - - Christmas - - General - - Girl + - birthday.html + - boy.html + - celebration.html + - christmas.html + - general.html + - girl.html amount: type: number minimum: 1 @@ -1461,12 +1484,12 @@ components: type: string description: The theme of the gift certificate. enum: - - Birthday - - Boy - - Celebration - - Christmas - - General - - Girl + - birthday.html + - boy.html + - celebration.html + - christmas.html + - general.html + - girl.html amount: type: number description: 'Value must be between 1.00 and 1,000.00 in the store’s default currency.' @@ -1505,7 +1528,7 @@ components: description: Name provided for the gift certificate that will appear in the control panel. theme: type: string - description: 'The theme of the gift certificate. The following options are available:`Birthday`, `Boy`, `Celebration`, `Christmas`, `General`, and `Girl`.' + description: 'The theme of the gift certificate. The following options are available:`birthday.html`, `boy.html`, `celebration.html`, `christmas.html`, `general.html`, and `girl.html`.' amount: type: number description: 'Value must be between 1.00 and 1,000.00 in the store’s default currency.' @@ -2103,7 +2126,7 @@ components: description: SKU of the variant. name: type: string - description: The item’s product name. + description: The item's product name. example: T-Shirt url: description: The product URL. @@ -2350,7 +2373,7 @@ components: type: object title: Item Custom description: |- - Add a custom item to the shopperʼs cart. + Add a custom item to the shopper's cart. * Custom items are not added to the catalog. * The price should be set to match the store settings for taxes. @@ -2374,7 +2397,7 @@ components: type: object title: Item Custom description: |- - Add a custom item to the shopperʼs cart. + Add a custom item to the shopper's cart. * Custom items are not added to the catalog. * The price should be set to match the store settings for taxes. @@ -2523,12 +2546,12 @@ components: type: string description: The theme of the gift certificate. enum: - - Birthday - - Boy - - Celebration - - Christmas - - General - - Girl + - birthday.html + - boy.html + - celebration.html + - christmas.html + - general.html + - girl.html amount: type: number minimum: 1 @@ -2590,12 +2613,12 @@ components: type: string description: The theme of the gift certificate. enum: - - Birthday - - Boy - - Celebration - - Christmas - - General - - Girl + - birthday.html + - boy.html + - celebration.html + - christmas.html + - general.html + - girl.html amount: type: number minimum: 1 @@ -2915,15 +2938,20 @@ components: type: string description: 'The product option name; for example, Color or Size.' nameId: - type: number + type: number + example: 151 description: The product option identifier. value: type: string description: 'The product option value; for example, Red or Medium.' valueId: - type: number + oneOf: + - type: number + example: 128 + - type: string + example: "1259" description: The product option value identifier in number format. - example: 128 + gift_wrapping: description: The gift wrapping details for this item. type: object @@ -2985,7 +3013,7 @@ components: date_created: type: string format: date-time - description: Date and time of the metafieldʼs creation. + description: Date and time of the metafield's creation. example: '2022-06-16T18:39:00+00:00' date_modified: type: string @@ -3131,9 +3159,7 @@ components: Response payload for the BigCommerce API. properties: data: - type: array - items: - $ref: '#/components/schemas/Metafield' + $ref: '#/components/schemas/Metafield' meta: $ref: '#/components/schemas/CollectionMeta' x-internal: false @@ -3304,14 +3330,14 @@ components: MetafieldKeyParam: name: key in: query - description: Filter based on a metafieldʼs key. + description: Filter based on a metafield's key. required: false schema: type: string MetafieldNamespaceParam: name: namespace in: query - description: Filter based on a metafieldʼs key. + description: Filter based on a metafield's key. required: false schema: type: string @@ -3349,14 +3375,14 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/catalog/brands_catalog.v3.yml b/reference/catalog/brands_catalog.v3.yml index 54d8369d5..6cdf70696 100644 --- a/reference/catalog/brands_catalog.v3.yml +++ b/reference/catalog/brands_catalog.v3.yml @@ -2,7 +2,7 @@ openapi: '3.0.3' info: title: Catalog - Brands description: |- - > The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the [Catalog Overview](/api-docs/store-management/catalog/products-overview). + > The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the [Catalog Overview](/docs/store-operations/catalog). Our Catalog Brands endpoints let you [create individual brands](/docs/rest-catalog/brands#create-a-brand) and [modify the brands](/docs/rest-catalog/brands#update-a-brand) associated with a store's products, along with [deleting brands](/docs/rest-catalog/brands#delete-a-brand). @@ -15,7 +15,7 @@ info: ## Resources ### Webhooks - * [Category](/api-docs/store-management/webhooks/events#category) + * [Category](/docs/integrations/webhooks/events#category) ### Additional Catalog endpoints * [Categories](/docs/rest-catalog/categories) @@ -591,7 +591,12 @@ paths: tags: - Brands summary: Delete Brands - description: 'By default, it deletes all *Brand* objects. A filter should be added to avoid deleting all *Brand* objects in a store.' + description: |- + To delete brand objects, you must include a filter. + + **Required Fields** + - name + operationId: deleteBrands parameters: - name: name @@ -600,6 +605,8 @@ paths: Filter items by name. schema: type: string + required: + true - name: page_title in: query description: | @@ -1897,14 +1904,14 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/catalog/categories_catalog.v3.yml b/reference/catalog/categories_catalog.v3.yml index cf1b78b3e..43996ff1b 100644 --- a/reference/catalog/categories_catalog.v3.yml +++ b/reference/catalog/categories_catalog.v3.yml @@ -2,7 +2,7 @@ openapi: '3.0.3' info: title: Catalog - Categories description: |- - > The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the [Catalog Overview](/api-docs/store-management/catalog/products-overview). + > The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the [Catalog Overview](/docs/store-operations/catalog). Our Catalog Categories endpoints let you [create individual categories](/docs/rest-catalog/categories#create-a-category) and [modify categories](/docs/rest-catalog/categories#update-a-category) that organize a store's products, as well as [delete categories](/docs/rest-catalog/categories#delete-a-category). @@ -12,14 +12,14 @@ info: This API family also contains endpoints to [update product sort order](/docs/rest-catalog/categories/sort-order#update-product-sort-order) within a category. - These endpoints are primarily useful in applications for single storefront stores. To work with categories for an [MSF-enabled store](/api-docs/multi-storefront/overview), see [Category Trees](/docs/rest-catalog/category-trees). + These endpoints are primarily useful in applications for single storefront stores. To work with categories for an [MSF-enabled store](/docs/storefront/multi-storefront), see [Category Trees](/docs/rest-catalog/category-trees). > To learn more about authenticating Catalog endpoints, locate the **Authentication** section at the top of each endpoint, then click **Show Details**. ## Resources ### Webhooks - Learn more about [Category webhook events](/api-docs/store-management/webhooks/events#category). + Learn more about [Category webhook events](/docs/integrations/webhooks/events#category). ### Additional Catalog endpoints * [Brands](/docs/rest-catalog/brands) @@ -55,13 +55,17 @@ paths: tags: - Categories summary: Get All Categories - description: Returns a list of *Categories*. Optional filter parameters can be passed in. + description: |- + Returns a list of *Categories*. Optional filter parameters can be passed in. + + **Note:** + The default rate limit for this endpoint is 40 concurrent requests. operationId: getCategories parameters: - name: id in: query description: | - Filter items by id. + Filter items by ID. schema: type: integer - name: 'id:in' @@ -365,7 +369,7 @@ paths: tags: - Categories summary: Create a Category - description: "Creates a *Category*.\n\nUse this endpoint when an API only works with categories of a default BigCommerce storefront (`channel_id=1`). \n\nUse the [Create Categories](/docs/rest-catalog/category-trees/categories#create-categories) endpoint when an API works with categories across different category trees that belong to different storefront channels.\n\n**Required Fields**:\n- `parent_id`: \n\t- To create a child category, set the `parent_id` to the parent category.\n\t- To create a top level category, set the `parent_id` to `0`.\n- `name`\n\n**Read-Only Fields**:\n- `id`\n\n**Limits**:\n- 16,000 categories per store limit.\n- 1,000 categories per product limit.\n- 50 characters category name length.\n- 8 levels of category depth limit.\n- 65,642 characters category description length limit." + description: "Creates a *Category*.\n\nUse this endpoint when an API only works with categories of a default BigCommerce storefront (`channel_id=1`). \n\nUse the [Create Categories](/docs/rest-catalog/category-trees/categories#create-categories) endpoint when an API works with categories across different category trees that belong to different storefront channels.\n\n**Required Fields**:\n- `parent_id`: \n\t- To create a child category, set the `parent_id` to the parent category.\n\t- To create a top level category, set the `parent_id` to `0`.\n- `name`\n\n**Read-Only Fields**:\n- `id`\n\n**Limits**:\n- 16,000 categories per store limit.\n- 1,000 categories per product limit.\n- 50 characters category name length.\n- 8 levels of category depth limit.\n- 65,642 characters category description length limit.\n\n **Note:**\n The default rate limit for this endpoint is 40 concurrent requests.\n" operationId: createCategory parameters: - $ref: '#/components/parameters/ContentType' @@ -442,7 +446,7 @@ paths: minLength: 0 type: string description: | - A valid layout file. (Please refer to [this article](https://support.bigcommerce.com/articles/Public/Creating-Custom-Template-Files/) on creating category files.) This field is writable only for stores with a Blueprint theme applied. For stores with a Stencil theme applied, see [Custom Template Associations](/docs/rest-content/custom-template-associations). + A valid layout file. Please refer to [the article on creating category files (Help Center)](https://support.bigcommerce.com/articles/Public/Creating-Custom-Template-Files/). This field is writable only for stores with a Blueprint theme applied. For stores with a Stencil theme applied, see [Custom Template Associations](/docs/rest-content/custom-template-associations). example: category.html is_visible: type: boolean @@ -465,7 +469,7 @@ paths: image_url: type: string description: | - Image URL used for this category on the storefront. Images can be uploaded via form file post to `/categories/{categoryId}/image`, or by providing a publicly accessible URL in this field. An image extension like .jpg or .png is required. + Image URL used for this category on the storefront. Images can be uploaded using form file post to `/categories/{categoryId}/image`, or by providing a publicly accessible URL in this field. An image extension like .jpg or .png is required. example: 'https://cdn8.bigcommerce.com/s-123456/product_images/d/fakeimage.png' x-url: true custom_url: @@ -509,7 +513,7 @@ paths: meta: $ref: '#/components/schemas/metaEmpty_Full' '207': - description: 'Multiple operations have taken place and the status for each operation can be viewed in the body of the response. Typically indicates that a partial failure has occured, such as when a `POST` or `PUT` request is successful, but saving the URL has failed.' + description: 'Multiple operations have taken place and the status for each operation can be viewed in the body of the response. Typically indicates that a partial failure has occurred, such as when a `POST` or `PUT` request is successful, but saving the URL has failed.' content: application/json: schema: @@ -582,7 +586,7 @@ paths: parameters: - name: id in: query - description: Filter items by id. + description: Filter items by ID. schema: type: integer - name: 'id:in' @@ -727,7 +731,11 @@ paths: tags: - Categories summary: Get a Category - description: Returns a single *Category*. Optional parameters can be passed in. + description: |- + Returns a single *Category*. Optional parameters can be passed in. + + **Note:** + The default rate limit for this endpoint is 40 concurrent requests. operationId: getCategoryById parameters: - name: include_fields @@ -786,6 +794,9 @@ paths: **Read-Only Fields** - id + + **Note:** + The default rate limit for this endpoint is 40 concurrent requests. operationId: updateCategory parameters: - $ref: '#/components/parameters/ContentType' @@ -868,7 +879,7 @@ paths: minLength: 0 type: string description: | - A valid layout file. (Please refer to [this article](https://support.bigcommerce.com/articles/Public/Creating-Custom-Template-Files/) on creating category files.) This field is writable only for stores with a Blueprint theme applied. For stores with a Stencil theme applied, see [Custom Template Associations](/docs/rest-content/custom-template-associations). + A valid layout file. Please refer to [the article on creating category files (Help Center)](https://support.bigcommerce.com/articles/Public/Creating-Custom-Template-Files/). This field is writable only for stores with a Blueprint theme applied. For stores with a Stencil theme applied, see [Custom Template Associations](/docs/rest-content/custom-template-associations). example: category.html is_visible: type: boolean @@ -891,7 +902,7 @@ paths: image_url: type: string description: | - Image URL used for this category on the storefront. Images can be uploaded via form file post to `/categories/{categoryId}/image`, or by providing a publicly accessible URL in this field. An image extension like .jpg or .png is required. + Image URL used for this category on the storefront. Images can be uploaded using form file post to `/categories/{categoryId}/image`, or by providing a publicly accessible URL in this field. An image extension like .jpg or .png is required. example: 'https://cdn8.bigcommerce.com/s-123456/product_images/d/fakeimage.png' x-url: true custom_url: @@ -1006,7 +1017,7 @@ paths: minLength: 0 type: string description: | - A valid layout file. (Please refer to [this article](https://support.bigcommerce.com/articles/Public/Creating-Custom-Template-Files/) on creating category files.) This field is writable only for stores with a Blueprint theme applied. For stores with a Stencil theme applied, see [Custom Template Associations](/docs/rest-content/custom-template-associations). + A valid layout file. Please refer to [the article on creating category files (Help Center)](https://support.bigcommerce.com/articles/Public/Creating-Custom-Template-Files/). This field is writable only for stores with a Blueprint theme applied. For stores with a Stencil theme applied, see [Custom Template Associations](/docs/rest-content/custom-template-associations). example: category.html is_visible: type: boolean @@ -1029,7 +1040,7 @@ paths: image_url: type: string description: | - Image URL used for this category on the storefront. Images can be uploaded via form file post to `/categories/{categoryId}/image`, or by providing a publicly accessible URL in this field. An image extension like .jpg or .png is required. + Image URL used for this category on the storefront. Images can be uploaded using form file post to `/categories/{categoryId}/image`, or by providing a publicly accessible URL in this field. An image extension like .jpg or .png is required. example: 'https://cdn8.bigcommerce.com/s-123456/product_images/d/fakeimage.png' x-url: true custom_url: @@ -1139,7 +1150,11 @@ paths: tags: - Categories summary: Delete a Category - description: Deletes a *Category*. + description: |- + Deletes a *Category*. + + **Note:** + The default rate limit for this endpoint is 40 concurrent requests. operationId: deleteCategoryById responses: '204': @@ -1159,7 +1174,7 @@ paths: - name: id in: query description: | - Filter items by id. + Filter items by ID. schema: type: integer - name: 'id:in' @@ -1324,7 +1339,7 @@ paths: **Read-Only Fields** - id - **Note:** The maxiumum number of metafields allowed on each order, product, category, variant, or brand is 250 per client ID. For more information, see [Platform Limits](https://support.bigcommerce.com/s/article/Platform-Limits) in the Help Center. + **Note:** The maximum number of metafields allowed on each order, product, category, variant, or brand is 250 per client ID. For more information, see [Platform Limits (Help Center)](https://support.bigcommerce.com/s/article/Platform-Limits) in the Help Center. operationId: createCategoryMetafield parameters: - $ref: '#/components/parameters/ContentType' @@ -1659,7 +1674,7 @@ paths: tags: - Images summary: Delete a Category Image - description: Deletes a *Cateogory Image*. + description: Deletes a *Category Image*. operationId: deleteCategoryImage responses: '204': @@ -1830,7 +1845,7 @@ components: minLength: 0 type: string description: | - A valid layout file. (Please refer to [this article](https://support.bigcommerce.com/articles/Public/Creating-Custom-Template-Files/) on creating category files.) This field is writable only for stores with a Blueprint theme applied. For stores with a Stencil theme applied, see [Custom Template Associations](/docs/rest-content/custom-template-associations). + A valid layout file. Please refer to [the article on creating category files (Help Center)](https://support.bigcommerce.com/articles/Public/Creating-Custom-Template-Files/). This field is writable only for stores with a Blueprint theme applied. For stores with a Stencil theme applied, see [Custom Template Associations](/docs/rest-content/custom-template-associations). example: category.html is_visible: type: boolean @@ -1853,7 +1868,7 @@ components: image_url: type: string description: | - Image URL used for this category on the storefront. Images can be uploaded via form file post to `/categories/{categoryId}/image`, or by providing a publicly accessible URL in this field. An image extension like .jpg or .png is required. + Image URL used for this category on the storefront. Images can be uploaded using form file post to `/categories/{categoryId}/image`, or by providing a publicly accessible URL in this field. An image extension like .jpg or .png is required. example: 'https://cdn8.bigcommerce.com/s-123456/product_images/d/fakeimage.png' x-url: true custom_url: @@ -1864,7 +1879,7 @@ components: metafield_Base: title: metafield_Base type: object - description: 'Metafield for products, categories, variants, and brands; the max number of metafields allowed on each is 50. For more information, see [Platform Limits](https://support.bigcommerce.com/s/article/Platform-Limits) in the Help Center.' + description: 'Metafield for products, categories, variants, and brands; the max number of metafields allowed on each is 50. For more information, see [Platform Limits (Help Center)](https://support.bigcommerce.com/s/article/Platform-Limits) in the Help Center.' x-internal: false properties: key: @@ -2222,7 +2237,7 @@ components: minLength: 0 type: string description: | - A valid layout file. (Please refer to [this article](https://support.bigcommerce.com/articles/Public/Creating-Custom-Template-Files/) on creating category files.) This field is writable only for stores with a Blueprint theme applied. + A valid layout file. Please refer to [the article on creating category files (Help Center)](https://support.bigcommerce.com/articles/Public/Creating-Custom-Template-Files/). This field is writable only for stores with a Blueprint theme applied. For stores with a Stencil theme applied, see [Custom Template Associations](/docs/rest-content/custom-template-associations). example: category.html is_visible: title: is_visible @@ -2239,7 +2254,7 @@ components: image_url: type: string description: | - Image URL used for this category on the storefront. Images can be uploaded via form file post to `/categories/{categoryId}/image`, or by providing a publicly accessible URL in this field. An image extension like .jpg or .png is required. + Image URL used for this category on the storefront. Images can be uploaded using form file post to `/categories/{categoryId}/image`, or by providing a publicly accessible URL in this field. An image extension like .jpg or .png is required. example: 'https://cdn8.bigcommerce.com/s-123456/product_images/d/fakeimage.png' x-url: true meta_description: @@ -2327,14 +2342,14 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/catalog/category-trees_catalog.v3.yml b/reference/catalog/category-trees_catalog.v3.yml index 121663e88..3ccc45690 100644 --- a/reference/catalog/category-trees_catalog.v3.yml +++ b/reference/catalog/category-trees_catalog.v3.yml @@ -2,7 +2,7 @@ openapi: '3.0.3' info: title: Catalog - Category Trees description: |- - > The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the [Catalog Overview](/api-docs/store-management/catalog/products-overview). + > The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the [Catalog Overview](/docs/store-operations/catalog). Our Catalog Category Trees endpoints are the more modern and performant counterparts to the [Categories endpoints](/docs/rest-catalog/categories). Although the Category Trees endpoints and objects are designed to center an MSF-compatible, [multi-tenant category tree architecture](#categories), the endpoints work just as well in a single storefront context. @@ -15,7 +15,7 @@ info: ## Resources ### Webhooks - Learn more about [Category Tree webhook events](/api-docs/channels/guide/webhooks#category-trees). + Learn more about [Category Tree webhook events](/docs/integrations/webhooks/events/channels#category-trees). ### Additional Catalog endpoints * [Brands](/docs/rest-catalog/brands) @@ -580,7 +580,7 @@ components: - $ref: '#/components/schemas/default_product_sort' - type: object properties: - custom_url: + url: $ref: '#/components/schemas/Url' x-examples: {} CategoryUuidData: @@ -661,7 +661,7 @@ components: type: boolean image_url: type: string - custom_url: + url: $ref: '#/components/schemas/Url' CategoryDataPUT: allOf: @@ -677,7 +677,7 @@ components: Url: type: object properties: - url: + path: type: string is_customized: type: boolean @@ -1119,14 +1119,14 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/catalog/product-modifiers_catalog.v3.yml b/reference/catalog/product-modifiers_catalog.v3.yml index f86def38e..d3978eb96 100644 --- a/reference/catalog/product-modifiers_catalog.v3.yml +++ b/reference/catalog/product-modifiers_catalog.v3.yml @@ -2,7 +2,7 @@ openapi: '3.0.3' info: title: Catalog - Product Modifiers description: |- - > The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the [Catalog Overview](/api-docs/store-management/catalog/products-overview). + > The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the [Catalog Overview](/docs/store-operations/catalog). Product Modifiers represent choices that the shopper can make to change how the merchant customizes or adds on to the product. Examples include shipping insurance, monograms, custom inseam length, and a color selection for an unfinished product. @@ -17,7 +17,7 @@ info: ## Resources ### Webhooks - Learn more about [Product webhook events](/api-docs/store-management/webhooks/webhook-events#products). + Learn more about [Product webhook events](/docs/integrations/webhooks/events#products). ### Additional Catalog endpoints * [Brands](/docs/rest-catalog/brands) @@ -2825,14 +2825,14 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/catalog/product-variant-options_catalog.v3.yml b/reference/catalog/product-variant-options_catalog.v3.yml index 0c366ac94..92c1b79fe 100644 --- a/reference/catalog/product-variant-options_catalog.v3.yml +++ b/reference/catalog/product-variant-options_catalog.v3.yml @@ -2,7 +2,7 @@ openapi: '3.0.3' info: title: Catalog - Product Variant Options description: |- - > The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the [Catalog Overview](/api-docs/store-management/catalog/products-overview). + > The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the [Catalog Overview](/docs/store-operations/catalog). Product Variant Options represent the different facets of a product. For example, size, color, fabric. Variant Option values are the actual sizes, colors, fabrics, that are available. [Product Variants]() consist of combinations of Variant Option values. @@ -24,7 +24,7 @@ info: ## Resources ### Webhooks - Learn more about [Product webhook events](/api-docs/store-management/webhooks/webhook-events#products). + Learn more about [Product webhook events](/docs/integrations/webhooks/events#products). ### Additional Catalog endpoints * [Brands](/docs/rest-catalog/brands) @@ -2456,14 +2456,14 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/catalog/product-variants_catalog.v3.yml b/reference/catalog/product-variants_catalog.v3.yml index ae22eae88..a6d88e506 100644 --- a/reference/catalog/product-variants_catalog.v3.yml +++ b/reference/catalog/product-variants_catalog.v3.yml @@ -2,7 +2,7 @@ openapi: '3.0.3' info: title: Catalog - Product Variants description: |- - > The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the [Catalog Overview](/api-docs/store-management/catalog/products-overview). + > The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the [Catalog Overview](/docs/store-operations/catalog). A Product Variant is a version of a product that has its own SKU. For example, a catalog might model a particular style of high-top sneakers that come in both red and blue as one product - high-tops - with two variants - red and blue. From a storefront point of view, Product Variants are often what shoppers seek. They are also the object that maps to SKUs and tracks inventory. A Product with one only Variant is a _base variant_. @@ -21,7 +21,7 @@ info: ## Resources ### Webhooks - Learn more about [Product webhook events](/api-docs/store-management/webhooks/webhook-events#products). + Learn more about [Product webhook events](/docs/integrations/webhooks/events#products). ### Additional Catalog endpoints * [Brands](/docs/rest-catalog/brands) @@ -1111,7 +1111,8 @@ paths: type: string - name: product_id in: query - description: 'A comma-separated list of IDs of products whose variants were requested. For example:`?product_id=:id``?product_id:in=77,80,81`' + description: |- + A comma-separated list of IDs of products whose variants were requested. For example:`?product_id:in=77,80,81` schema: type: string responses: @@ -1214,7 +1215,7 @@ paths: If you exceed the limit, the store sets the variant inventory to the limit if no other variant inventories are set. If other variant inventories are set, the store does not save the variant inventory rather than setting the variant inventory to the remaining limit. - The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/buy-online-pick-up-in-store/inventory#limit-handling-in-inventory-versus-catalog-api). + The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). x-nullable: true maximum: 2147483647 inventory_warning_level: @@ -1432,7 +1433,7 @@ paths: If you exceed the limit, the store sets the variant inventory to the limit if no other variant inventories are set. If other variant inventories are set, the store does not save the variant inventory rather than setting the variant inventory to the remaining limit. - The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/buy-online-pick-up-in-store/inventory#limit-handling-in-inventory-versus-catalog-api). + The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). x-nullable: true maximum: 2147483647 example: 21474 @@ -1557,7 +1558,7 @@ paths: If you exceed the limit, the store sets the variant inventory to the limit if no other variant inventories are set. If other variant inventories are set, the store does not save the variant inventory rather than setting the variant inventory to the remaining limit. - The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/buy-online-pick-up-in-store/inventory#limit-handling-in-inventory-versus-catalog-api). + The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). x-nullable: true maximum: 2147483647 inventory_warning_level: @@ -1863,7 +1864,7 @@ components: If you exceed the limit, the store sets the variant inventory to the limit if no other variant inventories are set. If other variant inventories are set, the store does not save the variant inventory rather than setting the variant inventory to the remaining limit. - The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/buy-online-pick-up-in-store/inventory#limit-handling-in-inventory-versus-catalog-api). + The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). nullable: true maximum: 2147483647 inventory_warning_level: @@ -2057,7 +2058,7 @@ components: If you exceed the limit, the store sets the variant inventory to the limit if no other variant inventories are set. If other variant inventories are set, the store does not save the variant inventory rather than setting the variant inventory to the remaining limit. - The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/buy-online-pick-up-in-store/inventory#limit-handling-in-inventory-versus-catalog-api). + The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). nullable: true maximum: 2147483647 inventory_warning_level: @@ -2364,7 +2365,7 @@ components: name: product_id in: path description: | - The ID of the `Product` to which the resource belongs. + The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. required: true schema: type: integer @@ -2415,14 +2416,14 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml index 9fcb84746..d40fd8f66 100644 --- a/reference/catalog/products_catalog.v3.yml +++ b/reference/catalog/products_catalog.v3.yml @@ -2,11 +2,11 @@ openapi: '3.0.3' info: title: Catalog - Products description: |- - > The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the [Catalog Overview](/api-docs/store-management/catalog/products-overview). + > The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the [Catalog Overview](/docs/store-operations/catalog). Our Catalog Products endpoints let you [create products](/docs/rest-catalog/products#create-a-product), perform [batch operations on existing products](/docs/rest-catalog/products#update-products-batch) and work with [reviews](/docs/rest-catalog/products/reviews), [images](/docs/rest-catalog/products/images), and [videos](/docs/rest-catalog/products/videos). Note that after a product is created initially, you can manage the nuances of its variations using the [Product Modifier](/docs/rest-catalog/product-modifiers), [Product Variant](/docs/rest-catalog/product-variants), and [Product Variant Options](/docs/rest-catalog/product-variant-options) endpoints. - Other core product endpoints focus on [bulk pricing](/docs/rest-catalog/products/bulk-pricing-rules), [complex rules](/docs/rest-catalog/products/complex-rules), [custom fields](/docs/rest-catalog/products/custom-fields), and [metafields](/docs/rest-catalog/products/metafields). Product Variant objects also contain [their own metafields](/docs/rest-catalog/product-variants/metafields). For [MSF-enabled](/api-docs/multi-storefront/overview) stores, the product object also contains product [channel assignments](/docs/rest-catalog/products/channel-assignments) and [category assignments](/docs/rest-catalog/products/category-assignments); read more about [products in the MSF context](/api-docs/multi-storefront/api-guide#products). + Other core product endpoints focus on [bulk pricing](/docs/rest-catalog/products/bulk-pricing-rules), [complex rules](/docs/rest-catalog/products/complex-rules), [custom fields](/docs/rest-catalog/products/custom-fields), and [metafields](/docs/rest-catalog/products/metafields). Product Variant objects also contain [their own metafields](/docs/rest-catalog/product-variants/metafields). For [MSF-enabled](/docs/storefront/multi-storefront) stores, the product object also contains product [channel assignments](/docs/rest-catalog/products/channel-assignments) and [category assignments](/docs/rest-catalog/products/category-assignments); read more about [products in the MSF context](/docs/storefront/multi-storefront/guide#products). This API family also contains an endpoint to [Get a catalog summary](/docs/rest-catalog/products/summary). @@ -15,8 +15,8 @@ info: ## Resources ### Webhooks - * [Product webhook events](/api-docs/store-management/webhooks/webhook-events#products) - * [Product assignment webhook events](/api-docs/channels/guide/webhooks#product-assignments) + * [Product webhook events](/docs/integrations/webhooks/events#products) + * [Product assignment webhook events](/docs/integrations/webhooks/events/channels#product-assignments) ### Additional Catalog endpoints * [Brands](/docs/rest-catalog/brands) @@ -302,17 +302,20 @@ paths: * modifiers * options * videos + explode: false schema: - type: string - enum: - - variants - - images - - custom_fields - - bulk_pricing_rules - - primary_image - - modifiers - - options - - videos + type: array + items: + type: string + enum: + - variants + - images + - custom_fields + - bulk_pricing_rules + - primary_image + - modifiers + - options + - videos - name: include_fields in: query description: 'Fields to include, in a comma-separated list. The ID and the specified fields will be returned.' @@ -340,7 +343,7 @@ paths: type: integer - name: limit in: query - description: Controls the number of items per page in a limited (paginated) list of products. + description: Controls the number of items per page in a limited (paginated) list of products. The default product limit is 50 with a maximum limit of 250. schema: type: integer - name: direction @@ -844,7 +847,7 @@ paths: example: errors: {} status: 413 - title: The request payload is too large. The maximum items allowed in the array is 50 + title: The request payload is too large. The maximum items allowed in the array is 10. type: /api-docs/getting-started/api-status-codes '422': description: '`Product` was not valid. This is the result of missing required fields or invalid data. See the response for more details.' @@ -1348,17 +1351,20 @@ paths: - name: include in: query description: 'Sub-resources to include on a product, in a comma-separated list. If `options` or `modifiers` is used, results are limited to 10 per page.' + explode: false schema: - type: string - enum: - - variants - - images - - custom_fields - - bulk_pricing_rules - - primary_image - - modifiers - - options - - videos + type: array + items: + type: string + enum: + - variants + - images + - custom_fields + - bulk_pricing_rules + - primary_image + - modifiers + - options + - videos - name: include_fields in: query description: 'Fields to include, in a comma-separated list. The ID and the specified fields will be returned.' @@ -4040,7 +4046,11 @@ paths: tags: - Custom Fields summary: Get Custom Fields - description: Returns a list of product *Custom Fields*. Optional parameters can be passed in. + description: |- + Returns a list of product *Custom Fields*. Optional parameters can be passed in. + + **Note:** + The default rate limit for this endpoint is 40 concurrent requests. operationId: getCustomFields parameters: - name: include_fields @@ -4138,9 +4148,8 @@ paths: **Read-Only:** - id - **Limits** - - 200 custom fields per product limit. - - 255 characters per custom field limit. + **Note:** + The default rate limit for this endpoint is 40 concurrent requests. operationId: createCustomField parameters: - $ref: '#/components/parameters/ContentType' @@ -4484,7 +4493,11 @@ paths: tags: - Custom Fields summary: Delete a Custom Field - description: Deletes a product *Custom Field*. + description: |- + Deletes a product *Custom Field*. + + **Note:** + The default rate limit for this endpoint is 40 concurrent requests. operationId: deleteCustomFieldById responses: '204': @@ -6528,7 +6541,7 @@ components: If you exceed the limit, the store sets the variant inventory to the limit if no other variant inventories are set. If other variant inventories are set, the store does not save the variant inventory rather than setting the variant inventory to the remaining limit. - The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/buy-online-pick-up-in-store/inventory#limit-handling-in-inventory-versus-catalog-api). + The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). nullable: true maximum: 2147483647 inventory_warning_level: @@ -6714,7 +6727,7 @@ components: If you exceed the limit, the store sets the variant inventory to the limit if no other variant inventories are set. If other variant inventories are set, the store does not save the variant inventory rather than setting the variant inventory to the remaining limit. - The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/buy-online-pick-up-in-store/inventory#limit-handling-in-inventory-versus-catalog-api). + The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). nullable: true maximum: 2147483647 inventory_warning_level: @@ -8165,7 +8178,7 @@ components: The inventory for a product cannot exceed 2,147,483,647 in the catalog. If you exceed the limit, the store sets the inventory level to the limit. - The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/buy-online-pick-up-in-store/inventory#limit-handling-in-inventory-versus-catalog-api). + The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). inventory_warning_level: maximum: 2147483647 minimum: 0 @@ -8252,6 +8265,8 @@ components: type: string description: | Type of gift-wrapping options. Values: `any` - allow any gift-wrapping options in the store; `none` - disallow gift-wrapping on the product; `list` – provide a list of IDs in the `gift_wrapping_options_list` field. + + Always included in the response body; not applicable for the `include_fields` and `exclude_fields` query parameters. enum: - any - none @@ -8260,6 +8275,8 @@ components: type: array description: | A list of gift-wrapping option IDs. + + Always included in the response body; not applicable for the `include_fields` and `exclude_fields` query parameters. items: type: integer sort_order: @@ -8318,6 +8335,7 @@ components: type: integer description: | The number of times the product has been viewed. + deprecated: true preorder_release_date: type: string description: | @@ -8407,7 +8425,7 @@ components: type: array minimum: 0 maximum: 255 - description: 200 maximum custom fields per product. 255 maximum characters per custom field. + description: 200 maximum custom fields per product. 255 maximum characters per custom field. The default rate limit for this endpoint is 40 concurrent requests. items: $ref: '#/components/schemas/productCustomField_Put' bulk_pricing_rules: @@ -8709,14 +8727,14 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/channels.v3.yml b/reference/channels.v3.yml index 801be2bae..8e5b6ff44 100644 --- a/reference/channels.v3.yml +++ b/reference/channels.v3.yml @@ -8,7 +8,7 @@ info: email: support@bigcommerce.com title: Channels description: |- - Create and manage sales [channels](/api-docs/channels/overview), their [sites](/docs/rest-management/channels/channel-site), and their [product listings](/docs/rest-management/channels/channel-listings). + Create and manage sales [channels](/docs/integrations/channels), their [sites](/docs/rest-management/channels/channel-site), and their [product listings](/docs/rest-management/channels/channel-listings). ## Channels @@ -81,9 +81,9 @@ info: ## Resources * [Sites and Routes API Reference](/docs/rest-management/sites) - * [Building Channels Overview](/api-docs/channels/overview) - * [Building Channel Apps](/api-docs/channels/building-channel-apps) - * [Channels Toolkit Reference](/api-docs/channels/channels-toolkit-reference) + * [Building Channels Overview](/docs/integrations/channels) + * [Building Channel Apps](/docs/integrations/channels/guide) + * [Channels Toolkit Reference](/docs/integrations/channels/toolkit-reference) servers: - url: 'https://api.bigcommerce.com/stores/{store_hash}/v3' variables: @@ -2022,15 +2022,15 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header schemas: @@ -2309,11 +2309,11 @@ components: properties: app: type: object - description: 'A [channel app](/api-docs/channels/overview#channel-apps) config object for optionally configuring the channelʼs user interface in the control panel.' + description: 'A [channel app](/docs/integrations/channels#channel-apps) config object for optionally configuring the channelʼs user interface in the control panel.' properties: id: type: integer - description: 'The unique `id` given to an app registered in [DevTools](https://devtools.bigcommerce.com/); used to create links to the app in channel manager. `app.id` is optional; however, if youʼre building an app that creates or manages a channel, we recommend including it to ensure the user interface in the control panel works properly. Select partners who are promoted in the Channel Manager must build an app, and include the app ID in the create channel request. [Learn how to find an Appʼs ID](/api-docs/apps/tutorials/id).' + description: 'The unique `id` given to an app registered in [DevTools](https://devtools.bigcommerce.com/); used to create links to the app in channel manager. `app.id` is optional; however, if youʼre building an app that creates or manages a channel, we recommend including it to ensure the user interface in the control panel works properly. Select partners who are promoted in the Channel Manager must build an app, and include the app ID in the create channel request. [Learn how to find an Appʼs ID](/docs/integrations/apps/guide/id).' sections: type: array description: 'Sections are now deprecated under config_meta. The new /channel-menus endpoints should be used instead. If set, when the app is loaded within the control panel, the navigation `sections` will be directly embedded in the control panel navigation.' @@ -2643,7 +2643,7 @@ components: x-internal: false BigCommerceProtectedAppSections: type: array - description: 'List of channel-specific control panel menu navigation items and corresponding settings pages an app developer can choose to enable for the subject channel. Protected settings override any settings set in those UI sections at the storewide level. Learn more in the [Building Storefront Channels](/api-docs/channels/tutorials/storefront#protected-ui-sections) tutorial.' + description: 'List of channel-specific control panel menu navigation items and corresponding settings pages an app developer can choose to enable for the subject channel. Protected settings override any settings set in those UI sections at the storewide level. Learn more in the [Building Storefront Channels](/docs/integrations/channels/guide/storefronts#protected-ui-sections) tutorial.' items: type: string enum: diff --git a/reference/checkouts.sf.yml b/reference/checkouts.sf.yml index 2d2744bb0..2d72c25b2 100644 --- a/reference/checkouts.sf.yml +++ b/reference/checkouts.sf.yml @@ -5,9 +5,9 @@ info: Manage checkout operations and data using front-end JavaScript on BigCommerce Stencil-powered storefronts. - For info about API accounts, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). + For info about API accounts, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). - For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#same-origin-cors-authentication). + For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#same-origin-cors-authentication). version: '' termsOfService: 'https://www.bigcommerce.com/terms' contact: @@ -373,11 +373,12 @@ paths: description: |- Updates a *Checkout Line Item*. Updates an existing, single line item in the cart. - If a variant needs to be changed or updated, the product will need to be removed and re-added to the cart with the correct variants using the [Add Cart Line Items](/docs/rest-storefront/carts/cart-items#add-cart-line-items) endpoint or the [GraphQL Storefront API](/api-docs/storefront/graphql/carts-and-checkout). + If a variant needs to be changed or updated, the product will need to be removed and re-added to the cart with the correct variants using the [Add Cart Line Items](/docs/rest-storefront/carts/cart-items#add-cart-line-items) endpoint or the [GraphQL Storefront API](/docs/storefront/cart-checkout/guide/graphql-storefront). - > #### Note + > #### Notes > * Substitute your storefront domain for `yourstore.example.com`. - > * The Send a Test Request feature is not currently supported for this endpoint. + > * The Send a Test Request feature is not currently supported for this endpoint. + > * Please note that this API endpoint is not concurrent safe, meaning multiple simultaneous requests could result in unexpected and inconsistent results. operationId: CheckoutsCartsItemsItemIdByCheckoutIdAndCartIdPut parameters: - name: checkoutId @@ -1201,7 +1202,7 @@ paths: * Required Fields: * `shipping_address` (deprecated) or `address` * `lineItems` - 2. Update the Consignment with Shipping Options using the [REST Storefront API](/checkouts/checkout-consignments#update-a-consignment), the [REST Management API](/docs/rest-management/checkouts/checkout-consignments#update-checkout-consignment) or the [GraphQL Storefront API](/api-docs/storefront/graphql/carts-and-checkout). + 2. Update the Consignment with Shipping Options using the [REST Storefront API](/checkouts/checkout-consignments#update-a-consignment), the [REST Management API](/docs/rest-management/checkouts/checkout-consignments#update-checkout-consignment) or the [GraphQL Storefront API](/docs/storefront/cart-checkout/guide/graphql-storefront). ### For **pickup** consignments: 1. Create a new consignment object. @@ -1211,11 +1212,12 @@ paths: * `pickupOption` * `lineItems` - To learn more about creating a Checkout Consignment, see the [Carts and Checkouts Tutorial](/api-docs/storefront/tutorials/carts). + To learn more about creating a Checkout Consignment, see the [Carts and Checkouts Tutorial](/docs/storefront/cart-checkout/guide/rest-storefront). - > #### Note + > #### Notes > * Substitute your storefront domain for `yourstore.example.com`. - > * The Send a Test Request feature is not currently supported for this endpoint. + > * The Send a Test Request feature is not currently supported for this endpoint. + > * Please note that this API endpoint is not concurrent safe, meaning multiple simultaneous requests could result in unexpected and inconsistent results. operationId: CheckoutsConsignmentsByCheckoutIdPost parameters: - name: checkoutId @@ -1379,12 +1381,13 @@ paths: * `shippingOptionId` or `pickupOptionId` * `lineItems` - To learn more about creating a Checkout Consignment see [Checkout Consignment API](/api-docs/checkouts/checkout-consignment). + To learn more about creating a Checkout Consignment see [Checkout Consignment API](/docs/storefront/cart-checkout/guide/consignments). - > #### Note + > #### Notes > * You cannot pass both an `address` and a `shippingOptionId` because the shipping option may not be available for the new address > * Substitute your storefront domain for `yourstore.example.com`. - > * The Send a Test Request feature is not currently supported for this endpoint. + > * The Send a Test Request feature is not currently supported for this endpoint. + > * Please note that this API endpoint is not concurrent safe, meaning multiple simultaneous requests could result in unexpected and inconsistent results. operationId: CheckoutsConsignmentsByCheckoutIdAndConsignmentIdPut parameters: - name: checkoutId @@ -3426,6 +3429,8 @@ components: type: number description: '' format: double + giftWrapping: + $ref: '#/components/schemas/cartLineItemGiftWrapping_Put' x-internal: false cartLineItemGiftCertificate_Put: title: cartLineItemGiftCertificate_Put @@ -3458,6 +3463,39 @@ components: description: '' format: double x-internal: false + cartLineItemGiftWrapping_Put: + title: Gift Wrapping Request Data + required: + - wrapTogether + - wrapDetails + type: object + nullable: true + description: if passing null, it will remove the current gift wrapping for the item + properties: + wrapTogether: + type: boolean + description: Boolean value that specifies whether items whether items should be wrapped together or wrapped individually. + example: true + wrapDetails: + type: array + description: |- + Details for the gift wrapping option selected. This can be specified for each line item or together based on wrapTogether value. + If wrapTogether is false, each element in the wrapDetails array determines each item's specific wrapping. + (e.g if this line item has 6 quantity, you can pass at maximum 6 elements for the array to spefified each one's wrapping) + If wrapTogether is true, we will only use 1st element in the wrapDetails array to determine what to be wrapped + items: + type: object + required: + - id + properties: + id: + type: integer + description: Identifier of the gift wrapping option selected. + example: 0 + message: + type: string + description: Custom gift message. + example: Happy Birthday CreateConsignmentRequest: title: Create Consignment Request type: object diff --git a/reference/checkouts.v3.yml b/reference/checkouts.v3.yml index dd397f98c..a15e535ea 100644 --- a/reference/checkouts.v3.yml +++ b/reference/checkouts.v3.yml @@ -2,7 +2,7 @@ openapi: '3.0.3' info: title: Checkouts description: |- - For more information on authenticating BigCommerce APIs, see [Authentication](/api-docs/getting-started/authentication). + For more information on authenticating BigCommerce APIs, see [Authentication](/docs/start/authentication). Create and manage checkouts from existing carts using BigCommerce checkout logic. version: '3.0' @@ -1598,7 +1598,6 @@ paths: AllowDynamicQueryParameters: false AllowDynamicFormParameters: false IsMultiContentStreaming: false - x-codegen-request-body-name: body '/checkouts/{checkoutId}/discounts': post: tags: @@ -2383,7 +2382,6 @@ paths: - homepage - cartpage text: Some text - x-codegen-request-body-name: body '/checkouts/{checkoutId}/billing-address': post: tags: @@ -3154,7 +3152,6 @@ paths: AllowDynamicQueryParameters: false AllowDynamicFormParameters: false IsMultiContentStreaming: false - x-codegen-request-body-name: body '/checkouts/{checkoutId}/billing-address/{addressId}': put: tags: @@ -3925,7 +3922,6 @@ paths: AllowDynamicQueryParameters: false AllowDynamicFormParameters: false IsMultiContentStreaming: false - x-codegen-request-body-name: body '/checkouts/{checkoutId}/consignments': post: tags: @@ -3934,7 +3930,10 @@ paths: description: |- Adds a new consignment to a checkout. - For more information about working with consignments, see [Checkout consignment](/api-docs/checkouts/checkout-consignment). + + Please note that this API endpoint is not concurrent safe, meaning multiple simultaneous requests could result in unexpected and inconsistent results. + + For more information about working with consignments, see [Checkout consignment](/docs/storefront/cart-checkout/guide/consignments). Though the only required `address` properties to create a consignment are `email` and `country_code`, to successfully [create an order](/docs/rest-management/checkouts/checkout-orders#create-an-order) the `address` requires the following properties: * `first_name` @@ -3964,8 +3963,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CreateConsignmentRequest' - required: true + $ref: '#/components/schemas/CreateConsignmentRequest' + examples: + Shipping Consignment: + value: + - address: + first_name: "Jane" + last_name: "Doe" + email: "Jane.Doe@email.com" + company: "BigCommerce" + address1: "100 Main Street" + address2: "string" + city: "Austin" + state_or_province: "Texas" + state_or_province_code: "string" + country_code: "US" + postal_code: "78701" + phone: "555-555-5555" + custom_fields: + - field_id: "string" + field_value: "string" + line_items: + item_id: "118f8774-387c-485e-a095-6ef76d5f1bbd" + quantity: 1 + Pickup Consignment: + value: + - line_items: + - item_id: "118f8774-387c-485e-a095-6ef76d5f1bbd" + quantity: 1 + pickup_option: + pickup_method_id: 1 responses: '200': description: '' @@ -4714,7 +4741,6 @@ paths: AllowDynamicQueryParameters: false AllowDynamicFormParameters: false IsMultiContentStreaming: false - x-codegen-request-body-name: body '/checkouts/{checkoutId}/consignments/{consignmentId}': parameters: @@ -4739,6 +4765,8 @@ paths: * Assign a shipping option to the new consignment by sending a `PUT` request to update the consignment's `shipping_option_id` with a returned value from `data.consignments[N].available_shipping_option[N].id` obtained in the [Add Consignment to Checkout](/docs/rest-management/checkouts/checkout-consignments#add-consignment-to-checkout) endpoint. To update an existing address and line item IDs, assign a new address and line item IDs by sending a `PUT` request. + + Please note that this API endpoint is not concurrent safe, meaning multiple simultaneous requests could result in unexpected and inconsistent results. operationId: CheckoutsConsignmentsByCheckoutIdAndConsignmentIdPut parameters: @@ -5504,7 +5532,6 @@ paths: - homepage - cartpage text: Some text - x-codegen-request-body-name: body delete: tags: - Checkout Consignments @@ -7028,7 +7055,6 @@ paths: AllowDynamicQueryParameters: false AllowDynamicFormParameters: false IsMultiContentStreaming: false - x-codegen-request-body-name: body '/checkouts/{checkoutId}/coupons/{couponCode}': delete: tags: @@ -8699,6 +8725,7 @@ components: format: int32 pickup_option: type: object + description: 'Assigns a pickup consignment. Note: You cannot assign a shipping method with a pickup consignment.' properties: pickup_method_id: type: integer @@ -9700,14 +9727,14 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/consent.sf.yml b/reference/consent.sf.yml index 010aa62dc..a026f8030 100644 --- a/reference/consent.sf.yml +++ b/reference/consent.sf.yml @@ -10,9 +10,9 @@ info: description: |- Specify shopper cookie consent preferences. - For info about API accounts, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). + For info about API accounts, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). - For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#same-origin-cors-authentication). + For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#same-origin-cors-authentication). version: Storefront tags: - name: Consent @@ -73,7 +73,7 @@ components: 3 - Analytics 4 - Targeting; Advertising - For further definition of these categories, see [Scripts API](/api-docs/store-management/scripts). + For further definition of these categories, see [Scripts API](/docs/integrations/scripts). properties: allow: type: array diff --git a/reference/currencies.v2.yml b/reference/currencies.v2.yml index 2d1fffcde..83063f2bf 100644 --- a/reference/currencies.v2.yml +++ b/reference/currencies.v2.yml @@ -26,7 +26,7 @@ info: ## Resources - - [How Currencies Work](/api-docs/multi-currency/guide/how-currencies-work) + - [How Currencies Work](/docs/store-operations/currencies/guide) - [Price List API Reference](/docs/rest-management/price-lists) - [Using Price Lists (Help Center)](https://support.bigcommerce.com/s/article/Price-Lists) - [Managing Currencies (Help Center)](https://support.bigcommerce.com/s/article/Managing-Currencies-Beta) @@ -390,14 +390,14 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/current_customer.yml b/reference/current_customer.yml index 4f36e79be..a91f0fe60 100644 --- a/reference/current_customer.yml +++ b/reference/current_customer.yml @@ -4,11 +4,11 @@ info: description: |- Identify logged-in customers securely via JavaScript. - [Learn more about the current customer API](/api-docs/customers/current-customer-api). + [Learn more about the current customer API](/docs/start/authentication/current-customer). - For info about API accounts, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). + For info about API accounts, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). - For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#client-id). + For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#client-id). > #### Note > * Substitute your storefront domain for `yourstore.example.com`. diff --git a/reference/custom-template-associations.v3.yml b/reference/custom-template-associations.v3.yml index d44236052..96c1d33ea 100644 --- a/reference/custom-template-associations.v3.yml +++ b/reference/custom-template-associations.v3.yml @@ -109,7 +109,7 @@ info: * [Get Channel Active Theme](/docs/rest-management/channels/channel-active-theme#get-a-channel-active-theme) * [Get Available Custom Templates](/docs/rest-content/themes/theme-custom-templates#get-custom-templates) - * [Catalog API](/docs/rest-management/catalog) + * [Catalog API](/docs/rest-catalog) * [Pages API](/docs/rest-content/pages) * [Channels API](/docs/rest-management/channels) termsOfService: 'https://www.bigcommerce.com/terms' @@ -477,14 +477,14 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/customer_login.yml b/reference/customer_login.yml index de2d3cc73..e147e457b 100644 --- a/reference/customer_login.yml +++ b/reference/customer_login.yml @@ -4,11 +4,11 @@ info: description: |- Enable single sign-on for shoppers on BigCommerce hosted storefronts. - [Learn more about the customer login API](/api-docs/customers/customer-login-api). + [Learn more about the customer login API](/docs/start/authentication/customer-login). - For info about API accounts, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). + For info about API accounts, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). - For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#user-generated-jwts). + For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#user-generated-jwts). termsOfService: 'https://www.bigcommerce.com/terms' contact: name: BigCommerce @@ -32,7 +32,7 @@ paths: description: |- The customer login access point URL. - [Learn more about the Customer Login API](/api-docs/customers/customer-login-api). + [Learn more about the Customer Login API](/docs/start/authentication/customer-login). ## Example diff --git a/reference/customers.sf.yml b/reference/customers.sf.yml index 190877e28..a4b53ddf2 100644 --- a/reference/customers.sf.yml +++ b/reference/customers.sf.yml @@ -5,9 +5,9 @@ info: description: |- Manage customers and data via front-end JavaScript on BigCommerce Stencil-powered storefronts. - For info about API accounts, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). + For info about API accounts, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). - For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#same-origin-cors-authentication). + For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#same-origin-cors-authentication). servers: - url: 'https://{store_domain}/api/storefront' variables: diff --git a/reference/customers.v2.yml b/reference/customers.v2.yml index d5b5d7a17..9eb01a4eb 100644 --- a/reference/customers.v2.yml +++ b/reference/customers.v2.yml @@ -2,7 +2,7 @@ openapi: '3.0.1' info: title: Customers V2 description: |- - Create and Manage Customers, Customer Addresses, and Customer Groups. Additionally, validate customer passwords. To learn more about Customers see [here](/api-docs/customers/customers-subscribers-overview). + Create and Manage Customers, Customer Addresses, and Customer Groups. Additionally, validate customer passwords. To learn more about Customers see [here](/docs/store-operations/customers/customers-subscribers-overview). ## Available Endpoints | Resource / Endpoint | Description | @@ -22,12 +22,12 @@ info: * A customer and a subscriber can be the same. If a shopper checks out on the storefront, creates an account and opts into the newsletter, they are a customer and a subscriber. ## Resources ### Related APIs / Endpoints - - [Customer Login API](/api-docs/customers/customer-login-api) - - [Current Customer API](/api-docs/customers/current-customer-api) + - [Customer Login API](/docs/start/authentication/customer-login) + - [Current Customer API](/docs/start/authentication/current-customer) - [Customers API (v3)](/docs/rest-management/customers) - [Subscribers API](/docs/rest-management/subscribers) ### Webhooks - - [Customers](/api-docs/store-management/webhooks/webhook-events#customer) + - [Customers](/docs/integrations/webhooks/events#customer) termsOfService: 'https://www.bigcommerce.com/terms' contact: name: BigCommerce @@ -840,7 +840,11 @@ paths: tags: - Customer Groups summary: Get All Customer Groups - description: Returns a list of *Customer Groups*. Default sorting is by customer-group ID, from lowest to highest. + description: |- + Returns a list of *Customer Groups*. Default sorting is by customer-group ID, from lowest to highest. + + **Note:** + The default rate limit for this endpoint is 40 concurrent requests. operationId: getAllCustomerGroups parameters: - name: page @@ -930,6 +934,9 @@ paths: **Required Fields** * name + + **Note:** + The default rate limit for this endpoint is 40 concurrent requests. operationId: createACustomerGroup parameters: - $ref: '#/components/parameters/ContentType' @@ -1105,7 +1112,8 @@ paths: Deletes a *Customer Group*. **Notes** - All existing customers are unassigned from the group when it is deleted. + - All existing customers are unassigned from the group when it is deleted. + - The default rate limit for this endpoint is 40 concurrent requests. operationId: deleteACustomerGroup responses: '204': @@ -1737,15 +1745,15 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/customers.v3.yml b/reference/customers.v3.yml index 6162c5490..7362cdd31 100644 --- a/reference/customers.v3.yml +++ b/reference/customers.v3.yml @@ -6,7 +6,7 @@ info: Create and manage customers. ## Resources - * [Customer and Subscribers Overview](/api-docs/store-management/customers). + * [Customer and Subscribers Overview](/docs/store-operations/customers/customers-subscribers-overview). termsOfService: 'https://www.bigcommerce.com/terms' contact: name: BigCommerce @@ -171,13 +171,18 @@ paths: * `segment_ids`- segments the customer belongs to (Beta) `include=addresses,storecredit,attributes,formfields,shopper_profile_id,segment_ids` + explode: false schema: - type: string - enum: - - addresses - - storecredit - - attributes - - formfields + type: array + items: + type: string + enum: + - addresses + - storecredit + - attributes + - formfields + - shopper_profile_id + - segment_ids - in: query name: sort description: 'Sort items by date_created, date_modified, or last_name:* `date_created:asc` - date created, ascending* `date_created:desc` - date created, descending* `last_name:asc` - last name, ascending* `last_name:desc` - last name, descending * `date_modified:asc` - date modified, ascending* `date_modified:desc`- date modified, descending Example: `sort=last_name:asc`' @@ -506,6 +511,7 @@ paths: * **state_or_province** * **postal_code** * An attempt to create an address that already exists will result in no change to the address or custom form field values, an HTTP 200 return code, and the address will be absent from the response body. + * The default rate limit for this endpoint is 10 concurrent requests. summary: Create a Customer Address operationId: CustomersAddressesPost deprecated: false @@ -2487,15 +2493,15 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header schemas: diff --git a/reference/email_templates.v3.yml b/reference/email_templates.v3.yml index a1d216c8a..95b83b424 100644 --- a/reference/email_templates.v3.yml +++ b/reference/email_templates.v3.yml @@ -341,15 +341,15 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/form_fields.sf.yml b/reference/form_fields.sf.yml index e01e77a24..b0eef355b 100644 --- a/reference/form_fields.sf.yml +++ b/reference/form_fields.sf.yml @@ -4,9 +4,9 @@ info: description: |- Read form fields on a BigCommerce hosted storefront. - For info about API accounts, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). + For info about API accounts, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). - For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#same-origin-cors-authentication). + For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#same-origin-cors-authentication). > #### Warning > Breaking changes may be introduced to this endpoint while in beta. diff --git a/reference/geography.v2.yml b/reference/geography.v2.yml index 4ae54b6dd..64cf350a9 100644 --- a/reference/geography.v2.yml +++ b/reference/geography.v2.yml @@ -275,7 +275,7 @@ paths: responses: '200': $ref: '#/components/responses/countResponse' - summary: 'Get a Count of Country’s States ' + summary: 'Get a Count of Country’s States' tags: - States description: Returns a count of a country's states. @@ -379,15 +379,15 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header schemas: diff --git a/reference/marketing.v2.yml b/reference/marketing.v2.yml index 106871a60..47a422434 100644 --- a/reference/marketing.v2.yml +++ b/reference/marketing.v2.yml @@ -637,7 +637,7 @@ paths: amount: "10" balance: "0" status: active - template: "Birthday" + template: "birthday.html" message: Happy Birthday! purchase_date: "Tue, 20 Jan 1970 08:45:38 CST" expiry_date: "Mon, 2 Jan 2023 08:45:38 CST" @@ -679,7 +679,7 @@ paths: amount: "10" balance: "0" status: active - template: "Birthday" + template: "birthday.html" message: Happy Birthday! purchase_date: "Tue, 20 Jan 1970 08:45:38 CST" expiry_date: "Mon, 2 Jan 2023 08:45:38 CST" @@ -766,7 +766,7 @@ paths: balance: "500.0000" to_name: Alyss order_id: 1281 - template: "Celebration" + template: "celebration.html" message: "Celebrate" to_email: test@test.com from_name: Noland @@ -782,7 +782,7 @@ paths: balance: "700.0000" to_name: Alyss order_id: 0 - template: "General" + template: "general.html" message: "Test" to_email: test@test.com from_name: Noland @@ -798,7 +798,7 @@ paths: balance: "50.0000" to_name: Lyss order_id: 0 - template: "Celebration" + template: "celebration.html" message: "Celebrate" to_email: test5@test.com from_name: Somethingelse @@ -857,7 +857,7 @@ paths: amount: "10" balance: "0" status: active - template: "Birthday" + template: "birthday.html" message: Happy Birthday! purchase_date: "Tue, 20 Jan 1970 08:45:38 CST" expiry_date: "Mon, 2 Jan 2023 08:45:38 CST" @@ -1016,7 +1016,7 @@ components: type: array description: This is a list of shipping-method names. A shipping method must be enabled on the store to use it with a coupon. To check which shipping - methods are enabled, please use the [List Shipping Methods](/api/v2#list-shipping-methods) + methods are enabled, please use the [List Shipping Methods](/archive/store-operations/v2-catalog-products/v2-products#list-shipping-methods) endpoint. items: type: string @@ -1191,14 +1191,14 @@ components: template: type: string description: The email theme to use in the message sent to the recipient. - example: Celebration + example: celebration.html enum: - - Birthday - - Girl - - Boy - - Celebration - - Christmas - - General + - birthday.html + - girl.html + - boy.html + - celebration.html + - christmas.html + - general.html message: type: string description: Text that will be sent to the recipient, such as “Congratulations.” @@ -1253,14 +1253,14 @@ components: template: type: string description: The email theme to use in the message sent to the recipient. - example: Celebration + example: celebration.html enum: - - Birthday - - Boy - - Girl - - Celebration - - Christmas - - General + - birthday.html + - boy.html + - girl.html + - celebration.html + - christmas.html + - general.html message: type: string description: Text that will be sent to the recipient, such as “Congratulations.” @@ -1316,14 +1316,14 @@ components: template: type: string description: The email theme to use in the message sent to the recipient. - example: Celebration + example: celebration.html enum: - - Birthday - - Boy - - Girl - - Celebration - - Christmas - - General + - birthday.html + - boy.html + - girl.html + - celebration.html + - christmas.html + - general.html message: maxLength: 250 type: string @@ -1502,7 +1502,7 @@ components: balance: "500.0000" to_name: Alyss order_id: 1281 - template: "Girl" + template: "girl.html" to_email: test@test.com from_name: Noland from_email: test1@test.com @@ -1516,7 +1516,7 @@ components: balance: "700.0000" to_name: Alyss order_id: 0 - template: "Boy" + template: "boy.html" to_email: test@test.com from_name: Noland from_email: test1@test.com @@ -1530,7 +1530,7 @@ components: balance: "50.0000" to_name: Lyss order_id: 0 - template: "Christmas" + template: "christmas.html" to_email: test5@test.com from_name: Somethingelse from_email: test15@test.com @@ -1555,7 +1555,7 @@ components: amount: "10" balance: "0" status: active - template: "Birthday" + template: "birthday.html" message: Happy Birthday! purchase_date: "Tue, 20 Jan 1970 08:45:38 CST" expiry_date: "Mon, 2 Jan 2023 08:45:38 CST" @@ -1574,15 +1574,15 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/orders.sf.yml b/reference/orders.sf.yml index c7a4f2ef4..99f339cae 100644 --- a/reference/orders.sf.yml +++ b/reference/orders.sf.yml @@ -4,9 +4,9 @@ info: description: |- Get order data immediately after an order is placed on the storefront. - For info about API accounts, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). + For info about API accounts, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). - For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#same-origin-cors-authentication). + For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#same-origin-cors-authentication). version: '' termsOfService: 'https://www.bigcommerce.com/terms' contact: @@ -44,6 +44,22 @@ paths: exclusiveMinimum: false type: integer format: int32 + - name: include + in: query + description: Sub-resources to include in an Order, in a comma-separated list. The ID and the specified fields will be returned. + explode: false + schema: + type: array + items: + type: string + enum: + - lineItems + - billingAddress + - coupons + - currency + - taxes + - payments + - consignments responses: '200': description: '' diff --git a/reference/orders.v2.oas2.yml b/reference/orders.v2.oas2.yml index 1d15b7b6a..22bdc2e3a 100644 --- a/reference/orders.v2.oas2.yml +++ b/reference/orders.v2.oas2.yml @@ -7,7 +7,7 @@ info: ## Order - The Order object contains a record of the purchase agreement between a shopper and a merchant. To learn more about creating orders, see [Orders API Guide](/api-docs/orders/orders-api-overview). + The Order object contains a record of the purchase agreement between a shopper and a merchant. To learn more about creating orders, see [Orders API Guide](/docs/store-operations/orders). ### Currency Fields @@ -72,7 +72,7 @@ paths: - $ref: '#/components/parameters/Accept' - $ref: '#/components/parameters/order_id_path' get: - description: Gets an *Order*. To learn more about creating or updating orders, see [Orders Overview](/api-docs/orders/orders-api-overview). + description: Gets an *Order*. To learn more about creating or updating orders, see [Orders Overview](/docs/store-operations/orders). summary: Get an Order tags: - Orders @@ -97,7 +97,7 @@ paths: To remove a product from an order, set that product’s `quantity` to `0`. - To learn more about creating or updating orders, see [Orders Overview](/api-docs/orders/orders-api-overview). + To learn more about creating or updating orders, see [Orders Overview](/docs/store-operations/orders). summary: Update an Order tags: - Orders @@ -246,7 +246,7 @@ paths: operationId: getAllOrders post: description: |- - Creates an *Order*. To learn more about creating or updating orders, see [Orders Overview](/api-docs/orders/orders-api-overview). + Creates an *Order*. To learn more about creating or updating orders, see [Orders Overview](/docs/store-operations/orders). Create an order with an existing catalog product or a custom product. @@ -612,7 +612,7 @@ paths: operationId: getAllOrderShipments post: description: | - Creates an *Order Shipment*. For more details, see [Shipping an Order](/api-docs/orders/orders-api-overview#creating-order-shipments). + Creates an *Order Shipment*. For more details, see [Shipping an Order](/docs/store-operations/orders#creating-order-shipments). **Required Fields** * order_address_id @@ -628,7 +628,7 @@ paths: 3. Supply a custom `tracking_link`: By providing a value for the `tracking_link` property, you can use your own tracking link within the BigCommerce control panel and in customer-facing emails. The API response will return your supplied tracking link as part of the `tracking_link` property in the response. In situations when there isn't a `generated_tracking_link`, the property in the API response will remain empty. - Acceptable values for `shipping_provider` include an empty string (`""`), `auspost`, `carrier_{your_carrier_id}` (only used if the carrier is a [third-party Shipping Provider](/api-docs/providers/shipping)), `canadapost`, `endicia`, `usps`, `fedex`, `royalmail`, `ups`, `upsready`, `upsonline`, or `shipperhq`. + Acceptable values for `shipping_provider` include an empty string (`""`), `auspost`, `carrier_{your_carrier_id}` (only used if the carrier is a [third-party Shipping Provider](/docs/integrations/shipping)), `canadapost`, `endicia`, `usps`, `fedex`, `royalmail`, `ups`, `upsready`, `upsonline`, or `shipperhq`. Acceptable values for `tracking_carrier` include an empty string (`""`) or one of the valid [tracking-carrier values](https://github.com/bigcommerce/dev-docs/blob/master/assets/csv/tracking_carrier_values.csv). summary: Create Order Shipment @@ -2284,6 +2284,7 @@ components: - order_product_id: 188 product_id: 0 quantity: 1 + shipping_provider_display_name: USPS generated_tracking_link: http://trkcnfrm1.smi.usps.com/PTSInternetWeb/InterLabelInquiry.do?strOrigTrackNum=EJ958083578US - id: 7 order_id: 225 @@ -2327,6 +2328,7 @@ components: - order_product_id: 189 product_id: 0 quantity: 1 + shipping_provider_display_name: USPS generated_tracking_link: http://trkcnfrm1.smi.usps.com/PTSInternetWeb/InterLabelInquiry.do?strOrigTrackNum=EJ958083578US orderShipment_Resp: description: '' @@ -2382,6 +2384,7 @@ components: - order_product_id: 195 product_id: 0 quantity: 1 + shipping_provider_display_name: USPS generated_tracking_link: http://trkcnfrm1.smi.usps.com/PTSInternetWeb/InterLabelInquiry.do?strOrigTrackNum=EJ958083578US orderCount_Resp: description: '' @@ -2626,15 +2629,15 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header schemas: @@ -3155,7 +3158,7 @@ components: enum: - auspost - canadapost - - carrier_{your_carrier_id} (only used if the carrier is a [third-party Shipping Provider](/api-docs/providers/shipping)) + - carrier_{your_carrier_id} (only used if the carrier is a [third-party Shipping Provider](/docs/integrations/shipping)) - endicia - usps - fedex @@ -3197,6 +3200,10 @@ components: quantity: type: integer example: 2 + shipping_provider_display_name: + type: string + description: The human-readable name for the `shipping_provider`. + readOnly: true generated_tracking_link: type: string description: The tracking link that is generated using the combination of either the `tracking_number` and `shipping_provider` or `tracking_number` and `tracking_carrier`. This will be empty if the custom `tracking_link` value is provided. @@ -3551,7 +3558,7 @@ components: enum: - auspost - canadapost - - carrier_{your_carrier_id} (only used if the carrier is a [third-party Shipping Provider](/api-docs/providers/shipping)) + - carrier_{your_carrier_id} (only used if the carrier is a [third-party Shipping Provider](/docs/integrations/shipping)) - endicia - usps - fedex @@ -3606,7 +3613,7 @@ components: enum: - auspost - canadapost - - carrier_{your_carrier_id} (only used if the carrier is a [third-party Shipping Provider](/api-docs/providers/shipping)) + - carrier_{your_carrier_id} (only used if the carrier is a [third-party Shipping Provider](/docs/integrations/shipping)) - endicia - usps - fedex @@ -4389,7 +4396,7 @@ components: description: The date the order was created, formatted in the RFC-2822 standard. You set this attribute on Order creation (POST) to support the migration of historical orders. If you do not provide a value, then it will default to the current date/time. e.g., `Tue, 20 Nov 2012 00:00:00 +0000`. type: string default_currency_code: - description: A read-only field displays the currency code of the [transactional currency](/api-docs/multi-currency/guide/introduction#display-vs-transactional) the shopper uses. + description: A read-only field displays the currency code of the [transactional currency](/docs/store-operations/currencies#display-vs-transactional) the shopper uses. type: string readOnly: true discount_amount: diff --git a/reference/orders.v3.yml b/reference/orders.v3.yml index 86b9eca81..bff39ebe4 100644 --- a/reference/orders.v3.yml +++ b/reference/orders.v3.yml @@ -3427,15 +3427,15 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header examples: diff --git a/reference/pages.v3.yml b/reference/pages.v3.yml index bcf6a2943..853d3354c 100644 --- a/reference/pages.v3.yml +++ b/reference/pages.v3.yml @@ -632,7 +632,7 @@ components: Include a header parameter called `X-Auth-Token` and pass it the `access_token` provided with your store API account or generated with your app's `/auth` callback. - ```http title="Security header example" + ```http filename="Security header example" X-Auth-Token: example_access_token ``` diff --git a/reference/payments/accepted-methods_payments.v3.yml b/reference/payments/accepted-methods_payments.v3.yml index 95e4e43a9..3cb37ccca 100644 --- a/reference/payments/accepted-methods_payments.v3.yml +++ b/reference/payments/accepted-methods_payments.v3.yml @@ -3,22 +3,22 @@ info: version: '' title: Accepted Payment Methods description: | - > The Payments API processes payments using payment instruments such as credit cards or PayPal accounts. To learn more about Payments, see the [Payments Overview](/api-docs/store-management/payments-api-overview). + > The Payments API processes payments using payment instruments such as credit cards or PayPal accounts. To learn more about Payments, see the [Payments Overview](/docs/store-operations/payments). The [Get accepted payment methods](/docs/rest-payments/methods#get-accepted-payment-methods) endpoint returns information about the payment methods each configured payment gateway accepts. This information optimizes your implementation's likelihood of making successful payments requests that return errors solely when payment methods fail, without making API calls to the gateway prior to running the payment. - For a list of compatible payment gateways, as well as a guide through the API call sequence needed to make charges, see the [Payments Overview](/api-docs/store-management/payments-api-overview#compatible-payment-gateways). + For a list of compatible payment gateways, as well as a guide through the API call sequence needed to make charges, see the [Payments Overview](/docs/store-operations/payments#compatible-payment-gateways). - This endpoint uses the X-Auth-Token header to authenticate. For an X-Auth-Token example request, see the related section in our [Authentication article](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + This endpoint uses the X-Auth-Token header to authenticate. For an X-Auth-Token example request, see the related section in our [Authentication article](/docs/start/authentication#x-auth-token-header-example-requests). > To learn more about authenticating Payments endpoints, locate the **Authentication** section at the top of each endpoint, then click **Show Details**. ## Resources - * [Payments Overview](/api-docs/store-management/payments-api-overview) - * [Process payments authentication example request](/api-docs/getting-started/authentication#bigcommerce-generated-jwts) - * [Orders Overview](/api-docs/store-management/orders-api-overview) + * [Payments Overview](/docs/store-operations/payments) + * [Process payments authentication example request](/docs/start/authentication#bigcommerce-generated-jwts) + * [Orders Overview](/docs/store-operations/orders) ### Webhooks @@ -482,15 +482,15 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/payments/access-tokens_payments.v3.yml b/reference/payments/access-tokens_payments.v3.yml index 03e3f6561..25211c673 100644 --- a/reference/payments/access-tokens_payments.v3.yml +++ b/reference/payments/access-tokens_payments.v3.yml @@ -3,23 +3,23 @@ info: version: '' title: Payment Access Token description: | - > The Payments API processes payments using payment instruments such as credit cards or PayPal accounts. To learn more about Payments, see the [Payments Overview](/api-docs/store-management/payments-api-overview). + > The Payments API processes payments using payment instruments such as credit cards or PayPal accounts. To learn more about Payments, see the [Payments Overview](/docs/store-operations/payments). BigCommerce payments requests require a Payment Access Token, or _PAT_, which is a single use BigCommerce-generated JWT that's tied to the particular **order** for which the shopper authorizes BigCommerce to submit a payment. - To get a valid PAT, submit the order number to the [Create a Payment Access Token](/docs/rest-payments/tokens#create-payment-access-token) endpoint. Authenticate using an [API account access token](/api-docs/getting-started/api-accounts#api-accounts) with the [Create payments](/api-docs/getting-started/api-accounts#token-creation-scopes) scope as the value of the X-Auth-Token header. + To get a valid PAT, submit the order number to the [Create a Payment Access Token](/docs/rest-payments/tokens#create-payment-access-token) endpoint. Authenticate using an [API account access token](/docs/start/authentication/api-accounts#api-accounts) with the [Create payments](/docs/start/authentication/api-accounts#token-creation-scopes) scope as the value of the X-Auth-Token header. - You can also generate a PAT during checkout by using the `completeCheckout` mutation in the [GraphQL Storefront API](/api-docs/storefront/graphql/carts-and-checkout#handling-payments). + You can also generate a PAT during checkout by using the `completeCheckout` mutation in the [GraphQL Storefront API](/docs/storefront/cart-checkout/guide/graphql-storefront#handling-payments). - For a guide through the API call sequence needed to create a PAT and make charges, see the [Payments Overview](/api-docs/store-management/payments-api-overview#compatible-payment-gateways). + For a guide through the API call sequence needed to create a PAT and make charges, see the [Payments Overview](/docs/store-operations/payments#compatible-payment-gateways). > To learn more about authenticating Payments endpoints, locate the **Authentication** section at the top of each endpoint, then click **Show Details**. ## Resources - * [Payments Overview](/api-docs/store-management/payments-api-overview) - * [Process payments authentication example request](/api-docs/getting-started/authentication#bigcommerce-generated-jwts) - * [Orders Overview](/api-docs/store-management/orders-api-overview) + * [Payments Overview](/docs/store-operations/payments) + * [Process payments authentication example request](/docs/start/authentication#bigcommerce-generated-jwts) + * [Orders Overview](/docs/store-operations/orders) ### Webhooks @@ -57,7 +57,7 @@ paths: description: |- Use this endpoint to create a payment access token. A payment access token is required to process payments with the BigCommerce API. - You can also generate a payment access token during checkout by using the `completeCheckout` mutation in the [GraphQL Storefront API](/api-docs/storefront/graphql/carts-and-checkout#handling-payments). + You can also generate a payment access token during checkout by using the `completeCheckout` mutation in the [GraphQL Storefront API](/docs/storefront/cart-checkout/guide/graphql-storefront#handling-payments). After the token is created, use the token to [Process a payment](/docs/rest-payments/processing#process-payment). @@ -380,15 +380,15 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/payments/methods_payments.v2.yml b/reference/payments/methods_payments.v2.yml index 5a2b5e66f..614f50ff6 100644 --- a/reference/payments/methods_payments.v2.yml +++ b/reference/payments/methods_payments.v2.yml @@ -2,7 +2,7 @@ openapi: '3.0.1' info: title: Payment Methods (Deprecated) description: | - > The Payments API processes payments using payment instruments such as credit cards or PayPal accounts. To learn more about Payments, see the [Payments Overview](/api-docs/store-management/payments-api-overview). + > The Payments API processes payments using payment instruments such as credit cards or PayPal accounts. To learn more about Payments, see the [Payments Overview](/docs/store-operations/payments). This endpoint is deprecated. Use [Get accepted payment methods](/docs/rest-payments/methods#get-accepted-payment-methods) instead. @@ -12,9 +12,9 @@ info: ## Resources - * [Payments Overview](/api-docs/store-management/payments-api-overview) - * [Process payments authentication example request](/api-docs/getting-started/authentication#bigcommerce-generated-jwts) - * [Orders Overview](/api-docs/store-management/orders-api-overview) + * [Payments Overview](/docs/store-operations/payments) + * [Process payments authentication example request](/docs/start/authentication#bigcommerce-generated-jwts) + * [Orders Overview](/docs/store-operations/orders) ### Webhooks @@ -140,14 +140,14 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/payments/process_payments.yml b/reference/payments/process_payments.yml index fc0a11b8b..30da26157 100644 --- a/reference/payments/process_payments.yml +++ b/reference/payments/process_payments.yml @@ -3,11 +3,11 @@ info: version: '' title: Payment Processing description: | - > The Payments API processes payments using payment instruments such as credit cards or PayPal accounts. To learn more about Payments, see the [Payments Overview](/api-docs/store-management/payments-api-overview). + > The Payments API processes payments using payment instruments such as credit cards or PayPal accounts. To learn more about Payments, see the [Payments Overview](/docs/store-operations/payments). - The Payment Processing API uses BigCommerce's PCI-compliant payments server and a supported payment gateway to charge customers. The payment portal you choose may support charging stored instruments and/or making refund transactions. For a list of compatible payment gateways, as well as a guide through the API call sequence needed to make charges, see the [Payments Overview](/api-docs/store-management/payments-api-overview#compatible-payment-gateways). + The Payment Processing API uses BigCommerce's PCI-compliant payments server and a supported payment gateway to charge customers. The payment portal you choose may support charging stored instruments and/or making refund transactions. For a list of compatible payment gateways, as well as a guide through the API call sequence needed to make charges, see the [Payments Overview](/docs/store-operations/payments#compatible-payment-gateways). - A Payment Access Token (_PAT_) is required to authorize payment processing requests. The X-Auth-Token header is not required in requests to the payment processing endpoint. To generate a PAT, use the [Create a Payment Access Token](/docs/rest-payments/tokens#create-payment-access-token) endpoint or the `completeCheckout` mutation in the [GraphQL Storefront API](/api-docs/storefront/graphql/carts-and-checkout#handling-payments). For a payment processing authentication example request, see the related section in our [Authentication article](/api-docs/getting-started/authentication#bigcommerce-generated-jwts). + A Payment Access Token (_PAT_) is required to authorize payment processing requests. The X-Auth-Token header is not required in requests to the payment processing endpoint. To generate a PAT, use the [Create a Payment Access Token](/docs/rest-payments/tokens#create-payment-access-token) endpoint or the `completeCheckout` mutation in the [GraphQL Storefront API](/docs/storefront/cart-checkout/guide/graphql-storefront#handling-payments). For a payment processing authentication example request, see the related section in our [Authentication article](/docs/start/authentication#bigcommerce-generated-jwts). Also note that payment processing requests use the BigCommerce Payments Gateway, which uses a different server than our other REST APIs. Please see the server URL for the payment processing endpoint. @@ -15,9 +15,9 @@ info: ## Resources - * [Payments Overview](/api-docs/store-management/payments-api-overview) - * [Process payments authentication example request](/api-docs/getting-started/authentication#bigcommerce-generated-jwts) - * [Orders Overview](/api-docs/store-management/orders-api-overview) + * [Payments Overview](/docs/store-operations/payments) + * [Process payments authentication example request](/docs/start/authentication#bigcommerce-generated-jwts) + * [Orders Overview](/docs/store-operations/orders) ### Webhooks @@ -55,7 +55,7 @@ paths: tags: - Processing operationId: PaymentsPost - description: 'Process payments for an order. See [Payment Processing](/api-docs/store-management/payments-api-overview) for more information.' + description: 'Process payments for an order. See [Payment Processing](/docs/store-operations/payments) for more information.' parameters: - $ref: '#/components/parameters/AcceptPaymentResponse' - $ref: '#/components/parameters/ContentType' @@ -552,9 +552,9 @@ components: ### Further reading - For an outline of the Process Payment API call flow and more information about authenticating, see [Authentication and Example Requests](/api-docs/getting-started/authentication#bigcommerce-generated-jwts). + For an outline of the Process Payment API call flow and more information about authenticating, see [Authentication and Example Requests](/docs/start/authentication#bigcommerce-generated-jwts). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: http scheme: bearer bearerFormat: 'PAT {{PAYMENT_ACCESS_TOKEN}}' diff --git a/reference/price_lists.v3.yml b/reference/price_lists.v3.yml index ed27d9cc5..38832d3aa 100644 --- a/reference/price_lists.v3.yml +++ b/reference/price_lists.v3.yml @@ -10,9 +10,9 @@ info: You can create [Price List Assignments](/docs/rest-management/price-lists/price-lists-assignments#create-price-list-assignments) to assign Price Lists to a specific [channel](/docs/rest-management/channels/channel-listings). Price Lists assigned to a channel apply to all shoppers on that channel, unless there are more specific assignments or customer group discounts set up for the shopper's customer group. If an active Price List does not contain prices for a variant, the catalog pricing will be used. - Price Lists provide overridden price values to the Stencil storefront. You can further customize the final price display using Stencil's [handlebars objects](/theme-objects). + Price Lists provide overridden price values to the Stencil storefront. You can further customize the final price display using Stencil's [handlebars objects](/docs/storefront/stencil/themes/context/object-reference/config). - To learn more about Price Lists, see [Price Lists API](/api-docs/store-management/price-list-overview). + To learn more about Price Lists, see [Price Lists API](/docs/store-operations/pricing/price-lists). ## Price Lists Assignments @@ -45,9 +45,9 @@ info: ### Webhooks - * [Price list assignments](/api-docs/channels/guide/webhooks#price-list-assignments) - * [Products](/api-docs/store-management/webhooks/events#products) - * [SKU](/api-docs/store-management/webhooks/events#sku) + * [Price list assignments](/docs/integrations/webhooks/events/channels#price-list-assignments) + * [Products](/docs/integrations/webhooks/events#products) + * [SKU](/docs/integrations/webhooks/events#sku) ### Related endpoints * [Get All Price Lists](/docs/rest-management/price-lists#get-all-price-lists) termsOfService: 'https://www.bigcommerce.com/terms' @@ -849,11 +849,14 @@ paths: in: query description: | Sub-resources to include on a price record, in a comma-separated list. Valid expansions currently include `bulk_pricing_tiers` and `sku`. Other values will be ignored. + explode: false schema: - type: string - enum: - - bulk_pricing_tiers - - sku + type: array + items: + type: string + enum: + - bulk_pricing_tiers + - sku - name: price in: query description: | @@ -1437,13 +1440,6 @@ paths: required: true schema: type: integer - - name: X-Strict-Mode - in: header - description: | - Header that determines whether the Batch API operates in strict mode or not. Strict mode will reject the entire request if any item in the batch has an error. - schema: - type: integer - default: 0 - $ref: '#/components/parameters/ContentType' requestBody: content: @@ -1934,11 +1930,14 @@ paths: description: | Sub-resources to include on a price record, in a comma-separated list. Valid expansions currently include `bulk_pricing_tiers` and `sku`. Other values will be ignored. Sub-resources to include on a price record, in a comma-separated list. Valid expansions currently include `bulk_pricing_tiers` and `sku`. Other values will be ignored. + explode: false schema: - type: string - enum: - - bulk_pricing_tiers - - sku + type: array + items: + type: string + enum: + - bulk_pricing_tiers + - sku responses: '200': description: '' @@ -2793,7 +2792,7 @@ components: description: The price list with which the price record is associated. Either `variant_id` or `sku` is required. sku: type: string - description: The SKU for the variant with which this price record is associated. Either `sku`` or `variant_id is required. + description: The SKU for the variant with which this price record is associated. Either `sku` or `variant_id` is required. currency: type: string description: The 3-letter country code with which this price record is associated. @@ -2870,10 +2869,10 @@ components: description: The Price List with which this price record is associated. variant_id: type: integer - description: The variant with which this price record is associated. Either `variant_id`` or `sku` is required. + description: The variant with which this price record is associated. Either `variant_id` or `sku` is required. sku: type: string - description: The variant with which this price record is associated. Either `sku`` or `variant_id`` is required. + description: The variant with which this price record is associated. Either `sku` or `variant_id` is required. currency: type: string description: The 3-letter currency code with which this price set is associated. @@ -3046,14 +3045,14 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/pricing.sf.yml b/reference/pricing.sf.yml index d9ded49a7..4b20d2f21 100644 --- a/reference/pricing.sf.yml +++ b/reference/pricing.sf.yml @@ -925,14 +925,14 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/redirects.v3.yml b/reference/redirects.v3.yml index 601432832..f5ae6e6a8 100644 --- a/reference/redirects.v3.yml +++ b/reference/redirects.v3.yml @@ -66,6 +66,7 @@ paths: - from_path - type - site_id + - id - name: direction in: query description: 'Sort direction. Acceptable values are `asc`, `desc`.' @@ -240,6 +241,10 @@ paths: type: integer default: [] description: A list of the redirect IDs you wish to export. If no redirect IDs are provided, the request exports all redirects for the given site selection. + include_dynamic_target_urls: + type: boolean + default: false + description: If true, the exported CSV will contain an additional read-only column containing the target URL for dynamic redirects. description: Data necessary to create a new 301 Redirects export job. required: true responses: @@ -280,13 +285,13 @@ paths: The headers must be defined as follows: - `Domain,Old Path,New URL/Path,Target Type,Target ID` + `Domain,Old Path,Manual URL/Path,Dynamic Target Type,Dynamic Target ID` Not every line will have a value for every column. type: string format: binary example: |- - Domain,Old Path,New URL/Path,Target Type,Target ID + Domain,Old Path,Manual URL/Path,Dynamic Target Type,Dynamic Target ID store.example.com,/old-path,/new-manual-path,, store.example.com,/old-product,,Product,12 store.example.com,/old-brand,,Brand,34 @@ -373,7 +378,7 @@ paths: type: string format: binary example: | - Domain,Old Path,New URL/Path,Target Type,Target ID + Domain,Old Path,Manual URL/Path,Dynamic Target Type,Dynamic Target ID store.example.com,/old-path,/redirect-target,, '404': description: The requested export download does not exist. @@ -642,15 +647,15 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/scripts.v3.yml b/reference/scripts.v3.yml index a63bb89ef..2c1795db6 100644 --- a/reference/scripts.v3.yml +++ b/reference/scripts.v3.yml @@ -3,7 +3,7 @@ info: title: Scripts version: '' description: |- - Add client-side code to a BigCommerce storefront page or associate a script with a channel. To learn more about scripts, see the [Scripts API](/api-docs/store-management/scripts) article. + Add client-side code to a BigCommerce storefront page or associate a script with a channel. To learn more about scripts, see the [Scripts API](/docs/integrations/scripts) article. termsOfService: 'https://www.bigcommerce.com/terms' contact: name: BigCommerce @@ -122,7 +122,7 @@ paths: * Specify the `html` property. * Do not specify the `src` field. * Each app can have 10 scripts installed. - * Multiple scripts can be created [per call](/api-docs/store-management/scripts#notes). + * Multiple scripts can be created [per call](/docs/integrations/scripts#notes). get: summary: Get All Scripts operationId: getScripts @@ -619,15 +619,15 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header schemas: @@ -880,7 +880,7 @@ components: script_Response: type: object title: script_Response - description: 'For a list of all locations visit [Scripts Visibility](/api-docs/store-management/scripts#script-visibility-locations).' + description: 'For a list of all locations visit [Scripts Visibility](/docs/integrations/scripts#script-visibility-locations).' properties: data: $ref: '#/components/schemas/script_Full' @@ -890,7 +890,7 @@ components: script_responseCollection: type: object title: script_responseCollection - description: 'For a list of all locations visit [Scripts Visibility](/api-docs/store-management/scripts#script-visibility-locations).' + description: 'For a list of all locations visit [Scripts Visibility](/docs/integrations/scripts#script-visibility-locations).' properties: data: type: array @@ -933,7 +933,7 @@ components: - footer visibility: type: string - description: "Which set of pages the script should load on. \n\nPlease note that you need to have `Checkout content` scope to use `all_pages` and `checkout`.\n\n- The current visibility options are `storefront`, `checkout`, `all_pages` and `order_confirmation`.\n\n `storefront`: All pages that are not `checkout` or `order_confirmation`.\n\n\t\t \nFor a list of all locations visit [Scripts Visibility](/api-docs/store-management/scripts#script-visibility-locations)." + description: "Which set of pages the script should load on. \n\nPlease note that you need to have `Checkout content` scope to use `all_pages` and `checkout`.\n\n- The current visibility options are `storefront`, `checkout`, `all_pages` and `order_confirmation`.\n\n `storefront`: All pages that are not `checkout` or `order_confirmation`.\n\n\t\t \nFor a list of all locations visit [Scripts Visibility](/docs/integrations/scripts#script-visibility-locations)." enum: - storefront - all_pages diff --git a/reference/settings.v3.yml b/reference/settings.v3.yml index a84392f90..fb2b89139 100644 --- a/reference/settings.v3.yml +++ b/reference/settings.v3.yml @@ -37,6 +37,7 @@ tags: - name: Favicon Image - name: Store Profile - name: Storefront Product + - name: Units of Measurement paths: '/settings/analytics': parameters: @@ -1434,6 +1435,66 @@ paths: tags: - Inventory description: Update inventory settings + /settings/store/units-of-measurement: + get: + summary: Get Units of Measurement Settings + description: |- + Get settings for [units of measurements](https://support.bigcommerce.com/s/article/Store-Settings?language=en_US#physical). + tags: + - Units of Measurement + responses: + '200': + description: 'OK. When you request channel-level settings, `null` indicates that a channel does not have overrides.' + content: + application/json: + schema: + type: object + properties: + data: + $ref: '#/components/schemas/MeasurementUnitsSettings' + meta: + type: object + '422': + description: The provided settings could not be applied. See detailed errors in the response. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + parameters: + - $ref: '#/components/parameters/ChannelIdParam' + put: + summary: Update Units of Measurement Settings + description: |- + Update settings for [units of measurements](https://support.bigcommerce.com/s/article/Store-Settings?language=en_US#physical). + + The endpoint does not support partial updates. Provide all fields to update global or channel-level settings. + + Create channel-level settings, or overrides for a channel, using the `channel_id` query parameter. + + To delete overrides for a channel, supply `null` as a value for all fields. A channel then inherits global values. + + The endpoint does not support 'null' as a value for global-level settings. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MeasurementUnitsSettings' + responses: + '200': + description: 'OK. When you request channel-level settings, `null` indicates that a channel does not have overrides.' + content: + application/json: + schema: + type: object + properties: + data: + $ref: '#/components/schemas/MeasurementUnitsSettings' + meta: + type: object + parameters: + - $ref: '#/components/parameters/ChannelIdParam' + tags: + - Units of Measurement components: parameters: Accept: @@ -1950,19 +2011,19 @@ components: description: |- Describes when stock levels are updated. - Global settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including [product](/api-docs/store-management/webhooks/webhook-events#products), [SKU](/api-docs/store-management/webhooks/webhook-events#skus), and [inventory](/buy-online-pick-up-in-store/webhooks#inventory) webhooks. + Global settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including [product](/docs/integrations/webhooks/events#products), [SKU](/docs/integrations/webhooks/events#skus), and [inventory](/docs/integrations/webhooks/events/inventory-location#inventory) webhooks. edit_order_stock_adjustment: type: boolean description: |- Describes whether stock levels automatically adjust when you edit an order. - Global settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including [product](/api-docs/store-management/webhooks/webhook-events#products), [SKU](/api-docs/store-management/webhooks/webhook-events#skus), and [inventory](/buy-online-pick-up-in-store/webhooks#inventory) webhooks. + Global settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including [product](/docs/integrations/webhooks/events#products), [SKU](/docs/integrations/webhooks/events#skus), and [inventory](/docs/integrations/webhooks/events/inventory-location#inventory) webhooks. refund_order_stock_adjustment: type: boolean description: |- Describes whether stock levels automatically adjust when you refund or cancel an order. - Global settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including [product](/api-docs/store-management/webhooks/webhook-events#products), [SKU](/api-docs/store-management/webhooks/webhook-events#skus), and [inventory](/buy-online-pick-up-in-store/webhooks#inventory) webhooks. + Global settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including [product](/docs/integrations/webhooks/events#products), [SKU](/docs/integrations/webhooks/events#skus), and [inventory](/docs/integrations/webhooks/events/inventory-location#inventory) webhooks. stock_level_display: type: string enum: @@ -2302,6 +2363,40 @@ components: type: string title: '' x-internal: false + MeasurementUnitsSettings: + type: object + properties: + weight_measurement: + type: string + example: Ounces + enum: + - LBS + - Ounces + - KGS + - Grams + - Tonnes + length_measurement: + type: string + example: Inches + enum: + - Inches + - Centimeters + decimal_token: + type: string + example: '.' + thousands_token: + type: string + example: ',' + decimal_places: + type: integer + example: 2 + factoring_dimension: + type: string + example: depth + enum: + - depth + - height + - width responses: 200-storefront-product-settings: description: OK. `null` indicates that a particular field has not been overridden on a channel level when channel level settings are requested @@ -2365,14 +2460,14 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/shipping.v2.yml b/reference/shipping.v2.yml index cc1109d59..cf585cd16 100644 --- a/reference/shipping.v2.yml +++ b/reference/shipping.v2.yml @@ -2080,15 +2080,15 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header schemas: @@ -2111,7 +2111,6 @@ components: title: Shipping Provider type: string enum: - - '``' - fedex - auspost - canadapost diff --git a/reference/shipping.v3.yml b/reference/shipping.v3.yml index f7dbb125f..3158f23a4 100644 --- a/reference/shipping.v3.yml +++ b/reference/shipping.v3.yml @@ -54,7 +54,7 @@ paths: parameters: - in: query name: 'product_id:in' - description: 'A comma-separated list of product IDs. For more information, see [Filtering](/api-docs/getting-started/filtering).' + description: 'A comma-separated list of product IDs. For more information, see [Filtering](/docs/start/about/common-query-params).' style: form explode: false schema: @@ -273,7 +273,7 @@ components: schema: $ref: '#/components/schemas/error_Full' 429_Too_Many_Requests: - description: 'When an OAuth client exceeds the [rate limit](/api-docs/getting-started/best-practices#api-rate-limits) for API requests to a store.' + description: 'When an OAuth client exceeds the [rate limit](/docs/start/best-practices#api-rate-limits) for API requests to a store.' content: application/json: schema: @@ -305,15 +305,15 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header schemas: diff --git a/reference/shipping_provider.yml b/reference/shipping_provider.yml index ef8b188c3..2b2190c06 100644 --- a/reference/shipping_provider.yml +++ b/reference/shipping_provider.yml @@ -3,13 +3,13 @@ info: version: '' title: Shipping Providers description: |- - Implement endpoints consumed by BigCommerce for custom shipping integrations. To learn more, see [Shipping Provider API Overview](/api-docs/store-management/shipping/shipping-provider-api). + Implement endpoints consumed by BigCommerce for custom shipping integrations. To learn more, see [Shipping Provider API Overview](/docs/integrations/shipping). ## Authentication This specification file describes API requests BigCommerce will make to a registered shipping carrierʼs server to check connection options and retrieve rates. As such, the method of authentication is determined by the carrier server. - For more, see [developer-configured authentication](/api-docs/getting-started/authentication#developer-configured-authentication) for provider APIs. + For more, see [developer-configured authentication](/docs/start/authentication#developer-configured-authentication) for provider APIs. ## Subresources @@ -22,10 +22,10 @@ info: ## Additional Information ### Webhooks - - [Shipment](/api-docs/store-management/webhooks/webhook-events#shipment) + - [Shipments](/docs/integrations/webhooks/events#shipments) ### Related API Resources - - [Shipping Provider](/docs/apps-api/shipping) + - [Shipping Provider](/docs/rest-contracts/shipping) - [Shipping V2 API](/docs/rest-management/shipping-v2) termsOfService: 'https://www.bigcommerce.com/terms' contact: @@ -1918,4 +1918,4 @@ components: type: string description: The value of a [shipping address](/docs/rest-management/orders/order-shipping-addresses#get-a-shipping-address) form field. Depending on the form field, this could be a user-defined value or the value of a hidden input. title: Form Field Value - \ No newline at end of file + diff --git a/reference/sites.v3.yml b/reference/sites.v3.yml index 4e2730f30..0037a7f4f 100644 --- a/reference/sites.v3.yml +++ b/reference/sites.v3.yml @@ -7,7 +7,7 @@ info: ## [Sites](/docs/rest-management/sites) - Sites link [headless storefronts](/api-docs/storefronts/developers-guide-headless) to sales [channels](/docs/rest-management/channels). To [create a site](/docs/rest-management/sites#create-a-site), send a `POST` request to `/stores/{{STORE_HASH}}/v3/sites`. + Sites link [headless storefronts](/docs/storefront/headless) to sales [channels](/docs/rest-management/channels). To [create a site](/docs/rest-management/sites#create-a-site), send a `POST` request to `/stores/{{STORE_HASH}}/v3/sites`. ```http POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/sites @@ -43,7 +43,7 @@ info: ## Site routes - [Site routes](/docs/rest-management/sites/site-routes) tell BigCommerce how to link to pages on a [headless storefront](/api-docs/storefronts/developers-guide-headless). To [create a route](/docs/rest-management/sites/site-routes#create-a-site-route) for a [site](#sites), send a `POST` request to `/stores/{{STORE_HASH}}/v3/sites/{site_id}/routes`. + [Site routes](/docs/rest-management/sites/site-routes) tell BigCommerce how to link to pages on a [headless storefront](/docs/storefront/headless). To [create a route](/docs/rest-management/sites/site-routes#create-a-site-route) for a [site](#sites), send a `POST` request to `/stores/{{STORE_HASH}}/v3/sites/{site_id}/routes`. ```http POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/sites/{site_id}/routes @@ -111,8 +111,8 @@ info: ### Related resources * [Channels and Listings Reference](/docs/rest-management/channels) - * [Channels Overview](/api-docs/channels/overview) - * [Building Headless Storefronts Guide](/api-docs/storefronts/developers-guide-headless) + * [Channels Overview](/docs/integrations/channels) + * [Building Headless Storefronts Guide](/docs/storefront/headless) termsOfService: 'https://www.bigcommerce.com/terms' contact: name: BigCommerce @@ -166,13 +166,13 @@ paths: $ref: '#/components/responses/504_GatewayTimeout' tags: - Sites - description: 'Create a site that links a [headless storefront](/api-docs/storefronts/developers-guide-headless) to a sales [channel](/docs/rest-management/channels).' + description: 'Create a site that links a [headless storefront](/docs/storefront/headless) to a sales [channel](/docs/rest-management/channels).' get: responses: '200': $ref: '#/components/responses/site_RespCollection' summary: Get Sites - description: 'Get sites linked to a [headless storefront](/api-docs/storefronts/developers-guide-headless) sales channels.' + description: 'Get sites linked to a [headless storefront](/docs/storefront/headless) sales channels.' tags: - Sites parameters: @@ -332,7 +332,7 @@ paths: tags: - Site Routes description: |- - Create routes that tell BigCommerce how to link to pages on a [headless storefront](/api-docs/storefronts/developers-guide-headless). + Create routes that tell BigCommerce how to link to pages on a [headless storefront](/docs/storefront/headless). ## Usage Notes * For a list of supported route types, see [Route types](/docs/rest-management/sites#route-types). @@ -1260,15 +1260,15 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header parameters: diff --git a/reference/store_content.v2.yml b/reference/store_content.v2.yml index b25af3b56..93be79c3b 100644 --- a/reference/store_content.v2.yml +++ b/reference/store_content.v2.yml @@ -1654,14 +1654,14 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/store_information.v2.yml b/reference/store_information.v2.yml index d75c6d8a0..985533056 100644 --- a/reference/store_information.v2.yml +++ b/reference/store_information.v2.yml @@ -197,15 +197,15 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header schemas: diff --git a/reference/store_logs.v3.yml b/reference/store_logs.v3.yml index f27bf4f25..5dd8675b4 100644 --- a/reference/store_logs.v3.yml +++ b/reference/store_logs.v3.yml @@ -220,15 +220,15 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header tags: diff --git a/reference/storefront_tokens.v3.yml b/reference/storefront_tokens.v3.yml index 4376fe532..c26f34cbc 100644 --- a/reference/storefront_tokens.v3.yml +++ b/reference/storefront_tokens.v3.yml @@ -2,11 +2,11 @@ openapi: '3.0.1' info: title: Storefront Token description: |- - Get and manage tokens used to authenticate cross-origin requests to the [GraphQL Storefront API](/api-docs/storefront/graphql/graphql-storefront-api-overview). + Get and manage tokens used to authenticate cross-origin requests to the [GraphQL Storefront API](/docs/storefront/graphql). - ## [API tokens](/docs/storefront-auth/tokens#create-a-token) + ## [API tokens](/docs/rest-authentication/tokens#create-a-token) - Generate tokens (JWT) for authenticating cross-origin requests to the [GraphQL Storefront API](/api-docs/storefront/graphql/graphql-storefront-api-overview). To [create a token](/docs/storefront-auth/tokens#create-a-token), send a `POST` request to `/stores/{{STORE_HASH}}/v3/storefront/api-token`. + Generate tokens (JWT) for authenticating cross-origin requests to the [GraphQL Storefront API](/docs/storefront/graphql). To [create a token](/docs/rest-authentication/tokens#create-a-token), send a `POST` request to `/stores/{{STORE_HASH}}/v3/storefront/api-token`. ```http POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/storefront/api-token @@ -29,7 +29,7 @@ info: |`expires_at`|int| Unix timestamp in seconds (required). Does not support milliseconds, microseconds, or nanoseconds. | |`allowed_cors_origins`|array[str]| Allowed origins for cross origin requests (required) | - [**Response:**](/docs/storefront-auth/tokens#create-a-token) + [**Response:**](/docs/rest-authentication/tokens#create-a-token) ```json { @@ -42,9 +42,9 @@ info: - ## [Customer impersonation tokens](/docs/storefront-auth/tokens/customer-impersonation-token#create-a-token) + ## [Customer impersonation tokens](/docs/rest-authentication/tokens/customer-impersonation-token#create-a-token) - Generate tokens that can make queries from the perspective of a particular customer in headless or server-side code using the [GraphQL Storefront API](/api-docs/storefront/graphql/graphql-storefront-api-overview#customer-impersonation-tokens). To [create a customer impersonation token](/docs/storefront-auth/tokens/customer-impersonation-token#create-a-token), send a `POST` request to `/v3/storefront/api-token-customer-impersonation`. + Generate tokens that can make queries from the perspective of a particular customer in headless or server-side code using the [GraphQL Storefront API](/docs/storefront/graphql#customer-impersonation-tokens). To [create a customer impersonation token](/docs/rest-authentication/tokens/customer-impersonation-token#create-a-token), send a `POST` request to `/v3/storefront/api-token-customer-impersonation`. ```http POST https://api.bigcommerce.com/stores/{STORE_HASH}/v3/storefront/api-token-customer-impersonation @@ -53,7 +53,7 @@ info: Content-Type: application/json ``` - [**Response:**](/docs/storefront-auth/tokens/customer-impersonation-token#create-a-token) + [**Response:**](/docs/rest-authentication/tokens/customer-impersonation-token#create-a-token) ```json { @@ -65,7 +65,7 @@ info: } ``` - Customer impersonation token authenticated requests made to the GraphQL API receive store information from the perspective of the customer with the ID specified in the `X-Bc-Customer-Id` header sent with the GraphQL `POST` request. Pricing, product availability, customer account, and customer details will be reflected. Consider this sample request using a [customer impersonation token](/docs/storefront-auth/tokens/customer-impersonation-token#create-a-token) to run a request in the context of customer ID `123`. + Customer impersonation token authenticated requests made to the GraphQL API receive store information from the perspective of the customer with the ID specified in the `X-Bc-Customer-Id` header sent with the GraphQL `POST` request. Pricing, product availability, customer account, and customer details will be reflected. Consider this sample request using a [customer impersonation token](/docs/rest-authentication/tokens/customer-impersonation-token#create-a-token) to run a request in the context of customer ID `123`. ```http POST https://store.example.com/graphql @@ -85,7 +85,7 @@ info: ## Revoking tokens - To [revoke a token](/docs/storefront-auth/tokens#revoke-a-token), send a `DELETE` request to `/v3/storefront/api-token`. + To [revoke a token](/docs/rest-authentication/tokens#revoke-a-token), send a `DELETE` request to `/v3/storefront/api-token`. ```http DELETE /stores/{{STORE_HASH}}/v3/storefront/api-token-customer-impersonation @@ -96,7 +96,7 @@ info: ## Additional information - * [GraphQL API Overview](/api-docs/storefront/graphql/graphql-storefront-api-overview) + * [GraphQL API Overview](/docs/storefront/graphql) termsOfService: 'https://www.bigcommerce.com/terms' contact: name: BigCommerce @@ -190,7 +190,7 @@ paths: - Customer Impersonation Token summary: Create a Token description: |- - Returns a Storefront API token that allows your application to impersonate customers when making GraphQL `POST` requests. For more information on how to use the returned token, see [customer impersonation tokens](/docs/storefront-auth/tokens/customer-impersonation-token#create-a-token). + Returns a Storefront API token that allows your application to impersonate customers when making GraphQL `POST` requests. For more information on how to use the returned token, see [customer impersonation tokens](/docs/rest-authentication/tokens/customer-impersonation-token#create-a-token). **Required Scopes** * `Manage` `Storefront API Customer Impersonation Tokens` @@ -342,15 +342,15 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). name: X-Auth-Token in: header diff --git a/reference/subscribers.v3.yml b/reference/subscribers.v3.yml index f0611f1d2..715f53778 100644 --- a/reference/subscribers.v3.yml +++ b/reference/subscribers.v3.yml @@ -905,15 +905,15 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/subscriptions.sf.yml b/reference/subscriptions.sf.yml index d5c1b3202..e5eb799e0 100644 --- a/reference/subscriptions.sf.yml +++ b/reference/subscriptions.sf.yml @@ -4,15 +4,15 @@ info: description: |- Manage newsletter and marketing email subscriptions on the storefront. - For info about API accounts, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). + For info about API accounts, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). - For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#same-origin-cors-authentication). + For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#same-origin-cors-authentication). ## Additional Information * [Collecting Newsletter Subscriptions](https://support.bigcommerce.com/s/article/Collecting-Newsletter-Subscriptions) (support.bigcommerce.com) - * [Customers Overview](/api-docs/customers/customers-subscribers-overview) - * [Working with Storefront APIs](/api-docs/cart-and-checkout/working-sf-apis) + * [Customers Overview](/docs/store-operations/customers/customers-subscribers-overview) + * [Working with Storefront APIs](/docs/storefront/cart-checkout/guide/rest-storefront) termsOfService: 'https://www.bigcommerce.com/terms' contact: name: BigCommerce diff --git a/reference/tax.v3.yml b/reference/tax.v3.yml index bd2c0e9e9..58e9ee964 100644 --- a/reference/tax.v3.yml +++ b/reference/tax.v3.yml @@ -2,7 +2,7 @@ openapi: '3.0.0' info: title: Tax Provider Connection version: '3' - description: 'Manage the connection between a merchantʼs BigCommerce store and a third party tax provider. For more information, see [Tax Provider API Overview](/api-docs/providers/tax).' + description: 'Manage the connection between a merchantʼs BigCommerce store and a third party tax provider. For more information, see [Tax Provider API Overview](/docs/integrations/tax).' termsOfService: 'https://www.bigcommerce.com/terms' contact: name: BigCommerce @@ -49,11 +49,11 @@ paths: delete: summary: Delete a Connection description: | - Remove any previously set basic connection credentials for the specified provider. If the specified provider is the active tax provider on the store, the store's active tax provider will be reset to BigCommerce Manual Tax. It is suggested to call this endpoint during a single-click app [uninstall callback](/api-docs/apps/guide/callbacks#uninstall-callback). + Remove any previously set basic connection credentials for the specified provider. If the specified provider is the active tax provider on the store, the store's active tax provider will be reset to BigCommerce Manual Tax. It is suggested to call this endpoint during a single-click app [uninstall callback](/docs/integrations/apps/guide/callbacks#uninstall-callback). > #### Note > * This operation will be logged in [Store Logs](https://support.bigcommerce.com/s/article/Using-Store-Logs) under **Staff Actions**. - > * Requires **write** permissions on the **Information and Settings** [scope](/api-docs/getting-started/api-accounts#oauth-scopes). + > * Requires **write** permissions on the **Information and Settings** [scope](/docs/start/authentication/api-accounts#oauth-scopes). operationId: provider-connection-delete responses: '200': @@ -96,11 +96,11 @@ paths: - (optional) Tax provider profile used in customized endpoint urls for tax provider calls. This is only available for tax providers that support this feature. The configured `username`, `password`, and `profile` (if available) is used to authenticate each API request to the Tax Provider from the associated store. - The tax provider's `profile` will be included in the url for [Tax Provider API](/docs/apps-api/tax) endpoints. + The tax provider's `profile` will be included in the url for [Tax Provider API](/docs/rest-contracts/tax) endpoints. > #### Note > * This operation will be logged in [Store Logs](https://support.bigcommerce.com/s/article/Using-Store-Logs) under **Staff Actions**. - > * Requires **write** permissions on the **Information and Settings** [scope](/api-docs/getting-started/api-accounts#oauth-scopes). + > * Requires **write** permissions on the **Information and Settings** [scope](/docs/start/authentication/api-accounts#oauth-scopes). summary: Update a Connection parameters: - $ref: '#/components/parameters/ContentType' @@ -138,7 +138,7 @@ paths: required: true schema: type: string - description: 'The Tax Providerʼs `provider_id` provided by BigCommerce after the provider [shares their provider details](/api-docs/providers/tax#sharing-provider-details-with-bigcommerce).' + description: 'The Tax Providerʼs `provider_id` provided by BigCommerce after the provider [shares their provider details](/docs/integrations/tax#sharing-provider-details-with-bigcommerce).' components: parameters: Accept: @@ -179,15 +179,15 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header schemas: diff --git a/reference/tax_classes.v2.yml b/reference/tax_classes.v2.yml index cc42d906e..cb821f28e 100644 --- a/reference/tax_classes.v2.yml +++ b/reference/tax_classes.v2.yml @@ -174,15 +174,15 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/tax_properties.v3.yml b/reference/tax_properties.v3.yml index a2bff3fd8..e0c292f0c 100644 --- a/reference/tax_properties.v3.yml +++ b/reference/tax_properties.v3.yml @@ -269,15 +269,15 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header schemas: diff --git a/reference/tax_provider.yml b/reference/tax_provider.yml index c56b07893..5856f225e 100644 --- a/reference/tax_provider.yml +++ b/reference/tax_provider.yml @@ -2,7 +2,7 @@ openapi: '3.0.3' info: title: Tax Provider API version: '1.0' - description: 'Use BigCommerce’s platform-to-platform Tax Provider API to integrate a tax calculation engine into the BigCommerce storefront and control panel. Supports [estimate](/docs/apps-api/tax#estimate-taxes), [adjust](/docs/apps-api/tax#adjust-tax-quote), [commit](/docs/apps-api/tax#commit-tax-quote), and [void](/docs/apps-api/tax#void-tax-quote) operations. For more information, see [Tax Provider API Overview](/api-docs/providers/tax).' + description: 'Use BigCommerce’s platform-to-platform Tax Provider API to integrate a tax calculation engine into the BigCommerce storefront and control panel. Supports [estimate](/docs/rest-contracts/tax#estimate-taxes), [adjust](/docs/rest-contracts/tax#adjust-tax-quote), [commit](/docs/rest-contracts/tax#commit-tax-quote), and [void](/docs/rest-contracts/tax#void-tax-quote) operations. For more information, see [Tax Provider API Overview](/docs/integrations/tax).' termsOfService: 'https://www.bigcommerce.com/terms' contact: name: BigCommerce @@ -1317,9 +1317,9 @@ components: type: http scheme: basic description: |- - The [HTTP Basic Authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) (developer.mozilla.org) credentials used to authenticate each API request to the Tax Provider from the associated store; set and update `username`, `password`, and optionally `profile`, using the [Update a Connection](/docs/apps-api/tax-app-connection#update-a-connection) request. `profile` is an optional field and will be used with supporting providers only. + The [HTTP Basic Authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) (developer.mozilla.org) credentials used to authenticate each API request to the Tax Provider from the associated store; set and update `username`, `password`, and optionally `profile`, using the [Update a Connection](/docs/rest-contracts/tax-app-connection#update-a-connection) request. `profile` is an optional field and will be used with supporting providers only. - For more, see [developer-configured authentication](/api-docs/getting-started/authentication#developer-configured-authentication) for Provider APIs. + For more, see [developer-configured authentication](/docs/start/authentication#developer-configured-authentication) for Provider APIs. security: - Authorization: [] diff --git a/reference/tax_rates_zones.v3.yml b/reference/tax_rates_zones.v3.yml index dbd18f6c0..ffbb892a5 100644 --- a/reference/tax_rates_zones.v3.yml +++ b/reference/tax_rates_zones.v3.yml @@ -416,15 +416,15 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). schemas: Tax_Zone: type: object diff --git a/reference/tax_settings.v3.yml b/reference/tax_settings.v3.yml index a5c30a07d..bf2e88bf0 100644 --- a/reference/tax_settings.v3.yml +++ b/reference/tax_settings.v3.yml @@ -51,7 +51,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Tax_Settings_Req' + $ref: '#/components/schemas/Tax_Settings' required: true responses: '200': @@ -102,15 +102,15 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header schemas: @@ -143,41 +143,22 @@ components: - FIXED - BASIC - DISABLE - should_subtract_store_tax: - default: true - type: boolean - description: This setting applies only if a merchant enters tax-inclusive prices. When enabled, the store subtracts the itemʼs store tax rate before calculating tax using the shopperʼs tax zone. The tax-exclusive amount will be the same across all tax zones. When disabled, the tax-inclusive price remains the same across all tax zones; only the tax amount will vary based on the shopperʼs location. The tax-exclusive amount may vary among tax zones. These calculations are relevant for tax pricing and tax quotations that use basic tax. - Tax_Settings_Req: - type: object - properties: - tax_entered_with_prices: - type: boolean - description: Whether prices entered on this store include a tax component or not. - price_display_settings: - type: object - description: Settings that describe how prices display at the global level. - properties: - show_inclusive_in_control_panel: - type: boolean - description: Whether to show prices as tax inclusive or tax exclusive in the BigCommerce control panel. - invoice_price_display_strategy: - type: string - description: 'Whether to show prices as tax inclusive or tax exclusive across all invoices, or use the shopperʼs tax zone for price display on invoices.' - enum: - - ZONE - - INCLUSIVE - - EXCLUSIVE - fallback_strategy: - type: string - description: 'Decribes the fallback behaviour that applies when a tax provider produces an error. A merchant may decide to use a flat 10% fallback tax rate, their basic tax settings, or to block the transaction until a successful result can be achieved.' - enum: - - FIXED - - BASIC - - DISABLE should_subtract_store_tax: default: true type: boolean description: This setting applies only if a merchant enters tax-inclusive prices. When enabled, the store subtracts the itemʼs store tax rate before calculating tax using the shopperʼs tax zone. The tax-exclusive amount will be the same across all tax zones. When disabled, the tax-inclusive price remains the same across all tax zones; only the tax amount will vary based on the shopperʼs location. The tax-exclusive amount may vary among tax zones. These calculations are relevant for tax pricing and tax quotations that use basic tax. + should_use_geolocation_to_determine_guest_shopper_tax_zone: + default: false + type: boolean + description: This setting determines which tax zone a store uses to estimate tax for guest shoppers. When enabled, the store identifies a country-level tax zone based on the geolocation of a guest shopper. The store then applies the corresponding tax zone to estimate taxes. When disabled, the store identifies the zone using the provided `guest_shopper_tax_zone_id` field instead. Only the tax zones you configure can be matched to the guest shopper's geolocation. + guest_shopper_tax_zone_id: + default: 1 + type: integer + description: ID for the tax zone a store uses when estimating tax for guest shoppers. The store uses this zone if you disable `should_use_geolocation_to_determine_guest_shopper_tax_zone`. The store also uses this zone if there is no matching country-level tax zone for the geolocation. + store_tax_zone_id: + default: 1 + type: integer + description: ID for the tax zone a store uses when subtracting store tax. This setting applies only if a merchant enters tax-inclusive prices and subtracts store tax before tax calculation. MetaOpen: title: Response meta type: object diff --git a/reference/themes.v3.yml b/reference/themes.v3.yml index fea62d197..fdb47f8c9 100644 --- a/reference/themes.v3.yml +++ b/reference/themes.v3.yml @@ -726,15 +726,15 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header schemas: diff --git a/reference/webhooks.v3.yml b/reference/webhooks.v3.yml index e5a7d3eef..7b3465e18 100644 --- a/reference/webhooks.v3.yml +++ b/reference/webhooks.v3.yml @@ -2,7 +2,7 @@ openapi: '3.0.3' info: title: Webhooks v3 version: '' - description: 'Get notified when specific events occur on a BigCommerce store. For more information, see [Webhooks Overview](/api-docs/store-management/webhooks/overview).' + description: 'Get notified when specific events occur on a BigCommerce store. For more information, see [Webhooks Overview](/docs/integrations/webhooks).' termsOfService: 'https://www.bigcommerce.com/terms' contact: email: support@bigcommerce.com @@ -227,7 +227,7 @@ paths: description: You can pass in any number of custom headers to validate webhooks being returned. is_active: type: boolean - description: If webhook is active or not + description: If the webhook is active or not. A webhook subscription becomes deactivated after 90 days of inactivity. default: true created_at: type: integer @@ -235,6 +235,13 @@ paths: updated_at: type: integer description: Updated time + status: + type: string + description: The webhook status. + enum: + - inactive + - active + - deactivated blocked_domains: description: List of domains (destinations) that are currently on the denylist and are not being sent webhooks. type: array @@ -358,7 +365,7 @@ components: name: is_active in: query description: | - Enables user to filter for webhooks that are active or not. + Enables user to filter for webhooks that are active or not. A webhook subscription becomes deactivated after 90 days of inactivity. schema: type: boolean example: true @@ -653,15 +660,15 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header schemas: @@ -685,11 +692,11 @@ components: This webhook fires on new cart creation when any of the following occur: * a storefront shopper adds their first product to a cart during a new session * an application makes a successful `POST` request to `/carts` using either the [REST Storefront](/docs/rest-storefront/carts#create-a-cart) API or the [REST Management](/docs/rest-management/carts/carts-single#create-a-cart) API - * a storefront makes a successful call to create a cart using the [GraphQL Storefront API](/api-docs/storefront/graphql/carts-and-checkout) + * a storefront makes a successful call to create a cart using the [GraphQL Storefront API](/docs/storefront/cart-checkout/guide/graphql-storefront) Cart creation also fires the `store/cart/updated` webhook. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -732,8 +739,8 @@ components: title: store/cart/updated description: |- Fires when one of the following occurs: - * A cartʼs line items are modified by adding a new item to a cart, updating an existing itemʼs quantity, or deleting an item. - * A shopper enters or changes their email address during guest checkout. This includes signing in to a customer account after creating a guest cart, which associates the accountʼs email address with the cart. + * A cart's line items are modified by adding a new item to a cart, updating an existing item's quantity, or deleting an item. + * A shopper enters or changes their email address during guest checkout. This includes signing in to a customer account after creating a guest cart, which associates the account's email address with the cart. The `store/cart/created` webhook firing also triggers this webhook because adding a product to an empty cart is considered an update. @@ -741,7 +748,7 @@ components: * Quantity * Item Price - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -782,7 +789,7 @@ components: Fires when a cart is deleted. Carts are deleted in two ways; when all items are removed from a cart, and when an API consumer explicitly removes the cart using a `DELETE` request. Cart deletion ends the cart lifecycle. The `store/cart/updated` webhook also fires when the last item is removed. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -822,7 +829,7 @@ components: description: |- Fires when a new coupon code is applied to a cart. The webhook request body includes the ID of the coupon code. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -868,7 +875,7 @@ components: This webhook fires after a cart is abandoned. BigCommerce considers a cart abandoned when it has no activity for at least one hour. This webhook is available for all store plans, regardless of whether the Abandoned Cart Saver feature is enabled. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -912,7 +919,7 @@ components: Fires when a cart/checkout is converted into an order, which is typically after the checkout payment step on the storefront. At this point, the cart is automatically deleted and no longer accessible. This webhook returns both the cart/checkout ID and order ID for correlation purposes. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -957,7 +964,7 @@ components: description: |- This webhook subscribes to all cart line item events. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -998,7 +1005,7 @@ components: description: |- Fires when a new item is added to the cart. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1047,7 +1054,7 @@ components: * Quantity * Item Price - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1092,7 +1099,7 @@ components: description: |- Fires when an item is deleted from the cart. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1147,7 +1154,7 @@ components: description: |- Fires when a category is created. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1191,7 +1198,7 @@ components: * Enable Google Shopping - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1230,7 +1237,7 @@ components: description: |- Fires when a category is deleted. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1277,7 +1284,7 @@ components: description: |- Fires when a channel is created in the control panel or by API. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1328,7 +1335,7 @@ components: * config_meta - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1379,7 +1386,7 @@ components: description: |- Fires when a new customer is created. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1419,10 +1426,10 @@ components: store_customer_updated: title: store/customer/updated description: |- - This webhook is triggered when a customer is updated. In addition, this webhook is triggered when a shopper initially enters custom form field values within the account sign-up form. Please note that neither changing existing data in customer form fields nor changing a customerʼs address will trigger the webhook. + This webhook is triggered when a customer is updated. In addition, this webhook is triggered when a shopper initially enters custom form field values within the account sign-up form. Please note that neither changing existing data in customer form fields nor changing a customer's address will trigger the webhook. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1464,7 +1471,7 @@ components: description: |- This webhook is triggered when a customer is deleted. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1505,7 +1512,7 @@ components: description: |- Fires when a customer address is updated. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1555,7 +1562,7 @@ components: description: |- Fires when a customer address is created. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1605,7 +1612,7 @@ components: description: |- Fires when a customer address is deleted. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1655,7 +1662,7 @@ components: description: |- Fires when a customer default payment instrument is updated. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1701,7 +1708,7 @@ components: description: |- This webhook is triggered when an order is created in the control panel, using an app, or by API. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1762,7 +1769,7 @@ components: * Release Date * Remove pre-order status on this date - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1803,7 +1810,7 @@ components: description: |- Fires when an order is archived. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1843,7 +1850,7 @@ components: description: |- This webhook is triggered when an order status changes; for example, from `Pending` to `Awaiting Payment`. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1898,7 +1905,7 @@ components: description: |- This webhook is triggered when an order message is created by a customer or in the control panel. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1948,7 +1955,7 @@ components: description: |- This webhook is triggered when a refund is submitted against an order. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2003,7 +2010,7 @@ components: description: |- This webhook is triggered when a product is deleted. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2044,7 +2051,7 @@ components: description: |- Fires when a new product is created. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2137,7 +2144,7 @@ components: * Product Files * Customs Information - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2186,7 +2193,7 @@ components: * Inventory Low Stock - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2254,7 +2261,7 @@ components: Changes to the following fields trigger this event: * Quantity - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2324,7 +2331,7 @@ components: description: |- Fires when a shipment is created. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2372,7 +2379,7 @@ components: Changes to the following fields trigger this event: * Shipping Tracking Number - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2417,7 +2424,7 @@ components: description: |- This webhook is triggered when a shipment is deleted. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2467,7 +2474,7 @@ components: description: |- This webhook is triggered when a new SKU is created. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2522,7 +2529,7 @@ components: description: |- Fires when a SKU is updated. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2577,7 +2584,7 @@ components: description: |- Fires when a SKU is deleted. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2632,7 +2639,7 @@ components: description: |- Fires when a SKU is updated. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2705,7 +2712,7 @@ components: Changes to the following fields trigger this event: * Quantity - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2775,7 +2782,7 @@ components: description: |- Fires when a client store is canceled and uninstalled from the platform. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2818,7 +2825,7 @@ components: * Email * Phone - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2858,7 +2865,7 @@ components: description: |- Fires when a subscriber is created. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2898,7 +2905,7 @@ components: description: |- The webhook fires when a subscriber is updated. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2938,7 +2945,7 @@ components: description: |- This webhook is triggered when a subscriber is deleted. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -3023,7 +3030,7 @@ components: is_active: type: boolean example: true - description: Boolean value that indicates whether the webhook is active or not. + description: Boolean value that indicates whether the webhook is active or not. A webhook subscription becomes deactivated after 90 days of inactivity. events_history_enabled: type: boolean example: true diff --git a/reference/widgets.v3.yml b/reference/widgets.v3.yml index b75ca6b5a..3dc19e234 100644 --- a/reference/widgets.v3.yml +++ b/reference/widgets.v3.yml @@ -8,7 +8,7 @@ info: ## Subresources ### Widget templates - [Widget templates](/rest-content/widgets/widget-template) are reusable Handlebars-enabled HTML templates that define the structure of the widget on a page. + [Widget templates](/docs/rest-content/widgets/widget-template) are reusable Handlebars-enabled HTML templates that define the structure of the widget on a page. ### Widgets [Widgets](/docs/rest-content/widgets/widget) are units of content placed on specific pages in a Stencil theme. Widgets consist of a widget configuration and a widget template UUID and render as part of the storefront’s HTML. @@ -21,9 +21,9 @@ info: ## Additional Information - * [Widgets API Overview](/api-docs/store-management/widgets/overview) - * [Widget UI Schema](/stencil-docs/page-builder/widget-ui-schema) - * [Widget UI Input Types](/stencil-docs/page-builder/schema-settings) + * [Widgets API Overview](/docs/storefront/widgets) + * [Widget UI Schema](/docs/storefront/widgets/input-reference/schema) + * [Widget UI Input Types](/docs/storefront/widgets/input-reference/settings) termsOfService: 'https://www.bigcommerce.com/terms' contact: name: BigCommerce @@ -443,7 +443,7 @@ paths: **Template Files** - To view the list of values accepted by the `template_file` property, including **custom** templates, see [Placements](/api-docs/store-management/widgets/overview#placements). + To view the list of values accepted by the `template_file` property, including **custom** templates, see [Placements](/docs/storefront/widgets#placements). get: tags: - Placement @@ -1294,15 +1294,15 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header schemas: @@ -1750,18 +1750,18 @@ components: example: Product settings: type: array - description: 'For examples of schema settings, see [Widget UI Input Types](/stencil-docs/page-builder/schema-settings).' + description: 'For examples of schema settings, see [Widget UI Input Types](/docs/storefront/widgets/input-reference/settings).' items: type: object title: widgetSchemaSetting_Base - description: 'For examples of each type of setting, see [Page Builder > Schema Settings](/stencil-docs/page-builder/schema-settings/alignment) in Theme Docs.' + description: 'For examples of each type of setting, see [Page Builder > Schema Settings](/docs/storefront/widgets/input-reference/settings#alignment) in Theme Docs.' properties: type: type: string description: |- The type of setting component to display. You can view the list of elements below to discover which are available to use. - For examples of each type of setting, see [Page Builder > Schema Settings](/stencil-docs/page-builder/schema-settings/alignment) in Theme Docs. + For examples of each type of setting, see [Page Builder > Schema Settings](/docs/storefront/widgets/input-reference/settings#alignment) in Theme Docs. enum: - alignment - boolean @@ -1835,7 +1835,7 @@ components: type: string settings: type: array - description: 'For examples of each type of setting, see [Page Builder > Schema Settings](/stencil-docs/page-builder/schema-settings/alignment) in Theme Docs.' + description: 'For examples of each type of setting, see [Page Builder > Schema Settings](/docs/storefront/widgets/input-reference/settings#alignment) in Theme Docs.' items: $ref: '#/components/schemas/widgetSchemaSetting_Base' x-internal: false @@ -1879,14 +1879,14 @@ components: widgetSchemaSetting_Base: type: object title: widgetSchemaSetting_Base - description: 'For examples of each type of setting, see [Page Builder > Schema Settings](/stencil-docs/page-builder/schema-settings/alignment) in Theme Docs.' + description: 'For examples of each type of setting, see [Page Builder > Schema Settings](/docs/storefront/widgets/input-reference/settings#alignment) in Theme Docs.' properties: type: type: string description: |- The type of setting component to display. You can view the list of elements below to discover which are available to use. - For examples of each type of setting, see [Page Builder > Schema Settings](/stencil-docs/page-builder/schema-settings/alignment) in Theme Docs. + For examples of each type of setting, see [Page Builder > Schema Settings](/docs/storefront/widgets/input-reference/settings#alignment) in Theme Docs. enum: - alignment - boolean @@ -1932,7 +1932,7 @@ components: x-internal: false widgetSchema: type: array - description: 'The schema for the widget’s merchant-facing UI. For more information on the available schema settings, see [Widget UI Schema](/stencil-docs/page-builder/widget-ui-schema). ' + description: 'The schema for the widget’s merchant-facing UI. For more information on the available schema settings, see [Widget UI Schema](/docs/storefront/widgets/input-reference/schema). ' title: '' items: anyOf: @@ -1956,14 +1956,14 @@ components: items: type: object title: widgetSchemaSetting_Base - description: 'For examples of each type of setting, see [Page Builder > Schema Settings](/stencil-docs/page-builder/schema-settings/alignment) in Theme Docs.' + description: 'For examples of each type of setting, see [Page Builder > Schema Settings](/docs/storefront/widgets/input-reference/settings#alignment) in Theme Docs.' properties: type: type: string description: |- The type of setting component to display. You can view the list of elements below to discover which are available to use. - For examples of each type of setting, see [Page Builder > Schema Settings](/stencil-docs/page-builder/schema-settings/alignment) in Theme Docs. + For examples of each type of setting, see [Page Builder > Schema Settings](/docs/storefront/widgets/input-reference/settings#alignment) in Theme Docs. enum: - alignment - boolean diff --git a/reference/wishlists.v3.yml b/reference/wishlists.v3.yml index 3faa8c029..13988d961 100644 --- a/reference/wishlists.v3.yml +++ b/reference/wishlists.v3.yml @@ -2,10 +2,11 @@ openapi: '3.0.1' info: title: Wishlist description: |- - Create and manage customer [wishlists](https://support.bigcommerce.com/s/article/Wishlists). + Create and manage customer wishlists and wishlist items. ## Additional Information - * [Wishlists](https://support.bigcommerce.com/s/article/Wishlists) + + * [Wishlists (Help Center)](https://support.bigcommerce.com/s/article/Wishlists) version: '' termsOfService: 'https://www.bigcommerce.com/terms' contact: @@ -23,7 +24,6 @@ security: - X-Auth-Token: [] tags: - name: Wishlists - description: '' - name: Wishlists Items paths: '/wishlists': @@ -241,23 +241,22 @@ paths: type: string type: type: string - x-codegen-request-body-name: body '/wishlists/{wishlist_id}/items/{item_id}': + parameters: + - $ref: '#/components/parameters/WishlistID' + - $ref: '#/components/parameters/Accept' + - name: item_id + in: path + required: true + schema: + type: integer + format: int32 delete: tags: - Wishlists Items summary: Delete Wishlist Item description: Deletes a wishlist item. operationId: WishlistsItemsByIdDelete - parameters: - - $ref: '#/components/parameters/WishlistID' - - $ref: '#/components/parameters/Accept' - - name: item_id - in: path - required: true - schema: - type: integer - format: int32 responses: '200': description: '' @@ -334,15 +333,15 @@ paths: type: type: string '/wishlists/{wishlist_id}': + parameters: + - $ref: '#/components/parameters/WishlistID' + - $ref: '#/components/parameters/Accept' get: tags: - Wishlists summary: Get a Wishlist description: Returns a single wishlist. operationId: WishlistsByIdGet - parameters: - - $ref: '#/components/parameters/WishlistID' - - $ref: '#/components/parameters/Accept' responses: '200': description: '' @@ -425,11 +424,9 @@ paths: description: |- Updates a wishlist. - Use this endpoint to update existing wishlist items, change the wishlist's name and whether the wishlist is available publicly. To add or delete a wishlist item, see [Wishlist Items](/docs/rest-management/wishlists/wishlists-items). + Use this endpoint to update existing wishlist items, change the wishlistʼs name and whether the wishlist is available publicly. To add or delete a wishlist item, see [Wishlist Items](/docs/rest-management/wishlists/wishlists-items). operationId: WishlistsByIdPut parameters: - - $ref: '#/components/parameters/WishlistID' - - $ref: '#/components/parameters/Accept' - $ref: '#/components/parameters/ContentType' requestBody: content: @@ -506,16 +503,12 @@ paths: type: string type: type: string - x-codegen-request-body-name: body delete: tags: - Wishlists summary: Delete a Wishlist description: Deletes a wishlist. operationId: WishlistsByIdDelete - parameters: - - $ref: '#/components/parameters/WishlistID' - - $ref: '#/components/parameters/Accept' responses: '204': description: '' @@ -551,6 +544,9 @@ paths: type: type: string '/wishlists/{wishlist_id}/items': + parameters: + - $ref: '#/components/parameters/WishlistID' + - $ref: '#/components/parameters/Accept' post: tags: - Wishlists Items @@ -558,8 +554,6 @@ paths: description: Adds a wishlist item. More than one item can be added at a time. operationId: WishlistsItemsByIdPost parameters: - - $ref: '#/components/parameters/WishlistID' - - $ref: '#/components/parameters/Accept' - $ref: '#/components/parameters/ContentType' requestBody: content: @@ -627,7 +621,6 @@ paths: '500': description: Internal server error. content: {} - x-codegen-request-body-name: body components: schemas: wishlist_Post: @@ -806,18 +799,6 @@ components: format: int32 description: 'Data about the response, including pagination and collection totals.' x-internal: false - error: - title: error - type: object - properties: - status: - type: integer - format: int32 - title: - type: string - type: - type: string - x-internal: false metaCollection: title: metaCollection type: object @@ -825,150 +806,7 @@ components: pagination: $ref: '#/components/schemas/pagination' x-internal: false - responses: - Unauthorized: - description: Authentication information is missing or invalid. - content: - application/json: - schema: - title: Error - type: object - properties: - status: - type: integer - format: int32 - title: - type: string - type: - type: string - Wishlist_Resp: - description: '' - content: - application/json: - schema: - type: object - properties: - data: - $ref: '#/components/schemas/wishlist_Full' - meta: - type: object - properties: {} - additionalProperties: true - description: Response metadata. - example: - data: - id: 30 - customer_id: 10 - name: Christmas List - is_public: true - token: d2d55481-13eb-4d1e-9d79-9062b518570d - items: - - id: 44 - product_id: 77 - variant_id: 1 - - id: 45 - product_id: 80 - variant_id: 1 - - id: 46 - product_id: 81 - variant_id: 1 - - id: 47 - product_id: 86 - variant_id: 1 - - id: 48 - product_id: 88 - variant_id: 1 - meta: {} - wishlist_Resp_Collection: - description: '' - content: - application/json: - schema: - type: object - properties: - data: - type: array - items: - $ref: '#/components/schemas/wishlist_Full' - meta: - $ref: '#/components/schemas/metaCollection' - example: - data: - - id: 1 - customer_id: 4 - name: My Wish List - is_public: false - token: 02d55481-13eb-4d1e-9d79-9062b518570d - items: [] - - id: 2 - customer_id: 11 - name: Christmas - is_public: false - token: 02d55481-13eb-4d1e-9d79-9062b518570e - items: - - id: 1 - product_id: 167 - - id: 2 - product_id: 174 - - id: 3 - product_id: 184 - - id: 3 - customer_id: 20 - name: Birthday - is_public: false - token: 02d55481-13eb-4d1e-9d79-9062b518570f - items: - - id: 4 - product_id: 184 - - id: 5 - product_id: 183 - - id: 4 - customer_id: 20 - name: Christmas - is_public: false - token: 02d55481-13eb-4d1e-9d79-9062b518570f - items: - - id: 6 - product_id: 201 - - id: 5 - customer_id: 19 - name: Wish List - is_public: false - token: 02d55481-13eb-4d1e-9d79-9062b518570f - items: - - id: 7 - product_id: 173 - - id: 8 - product_id: 176 - meta: - pagination: - total: 0 - count: 5 - per_page: 50 - current_page: 1 - total_pages: 0 parameters: - FilterCustomerID: - name: customer_id - in: query - description: All wishlists relating to the customer. - schema: - type: integer - format: int32 - FilterPage: - name: page - in: query - description: The page number of results per page. 1 is the default and starts from record 0. - schema: - type: integer - format: int32 - FilterLimit: - name: limit - in: query - description: The numbers of items to return per page. Default is 50 and maximum is 250. - schema: - type: integer - format: int32 WishlistID: name: wishlist_id in: path @@ -1008,15 +846,15 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header