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/catalog/brands_catalog.v3.yml b/reference/catalog/brands_catalog.v3.yml index 54d8369d5..6c56cea55 100644 --- a/reference/catalog/brands_catalog.v3.yml +++ b/reference/catalog/brands_catalog.v3.yml @@ -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 diff --git a/reference/catalog/category-trees_catalog.v3.yml b/reference/catalog/category-trees_catalog.v3.yml index 50126723b..6fa10f42b 100644 --- a/reference/catalog/category-trees_catalog.v3.yml +++ b/reference/catalog/category-trees_catalog.v3.yml @@ -403,7 +403,7 @@ paths: example: - id: 0 name: string - channel_ids: + channels: - 0 responses: '200': @@ -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 @@ -844,7 +844,7 @@ components: type: string minLength: 1 maxLength: 255 - channel_ids: + channels: type: array items: type: integer diff --git a/reference/checkouts.sf.yml b/reference/checkouts.sf.yml index ab4838cec..2d2744bb0 100644 --- a/reference/checkouts.sf.yml +++ b/reference/checkouts.sf.yml @@ -2845,6 +2845,9 @@ components: type: number description: The total value of all coupons applied to this item. format: double + originalPrice: + type: number + description: The item’s original price is the same as the product’s default price. listPrice: type: number description: The item’s list price, as quoted by the manufacturer or distributor. @@ -2954,6 +2957,9 @@ components: type: number description: The total value of all coupons applied to this item. format: double + originalPrice: + type: number + description: The item’s original price is the same as the product’s default price. listPrice: type: number description: The item’s list price, as quoted by the manufacturer or distributor. diff --git a/reference/checkouts.v3.yml b/reference/checkouts.v3.yml index 038299a73..dd397f98c 100644 --- a/reference/checkouts.v3.yml +++ b/reference/checkouts.v3.yml @@ -4730,13 +4730,16 @@ paths: - Checkout Consignments summary: Update Checkout Consignment description: |- - Updates an existing consignment. The address, line item IDs, and the shipping option ID can be updated using this endpoint. + Updates an existing consignment. The address, line item IDs, and shipping option ID can be updated using this endpoint. + + Use a separate `PUT` request to update the shipping option IDs if you also want to update the address and line item IDs. - To add a new address and shipping options with line items, complete the following steps. + To add new shipping options, complete the following steps: + * Use the [Add Consignment to Checkout](/docs/rest-management/checkouts/checkout-consignments#add-consignment-to-checkout) endpoint to add a new [consignment] to a checkout. + * 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. - 1. Add a new [consignment](/docs/rest-management/checkouts/checkout-consignments#add-consignment-to-checkout) to a checkout. + To update an existing address and line item IDs, assign a new address and line item IDs by sending a `PUT` request. - 2. 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 Step One. operationId: CheckoutsConsignmentsByCheckoutIdAndConsignmentIdPut parameters: - $ref: '#/components/parameters/Content-Type' @@ -8703,10 +8706,8 @@ components: x-internal: false UpdateConsignmentRequest: title: Update Consignment Request - type: array - items: - type: object - properties: + type: object + properties: address: title: Address Properties required: diff --git a/reference/orders.sf.yml b/reference/orders.sf.yml index c7a4f2ef4..174d2cfb6 100644 --- a/reference/orders.sf.yml +++ b/reference/orders.sf.yml @@ -44,6 +44,19 @@ 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. + schema: + 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 60851e5f8..1d15b7b6a 100644 --- a/reference/orders.v2.oas2.yml +++ b/reference/orders.v2.oas2.yml @@ -156,8 +156,8 @@ paths: - product_id: 123 quantity: 5 product_options: - id: 56 - value: 12 + - id: 56 + value: 12 price_inc_tax: 12.45 price_ex_tax: 10.12 Adding a new product to order: @@ -175,8 +175,8 @@ paths: product_id: 123 quantity: 1 product_options: - id: 56 - value: 12 + - id: 56 + value: 12 price_inc_tax: 12.45 price_ex_tax: 10.12 required: true @@ -290,7 +290,7 @@ paths: street_1: 123 Main Street city: Austin state: Texas - zip: 78751 + zip: '78751' country: United States country_iso2: US email: janedoe@example.com @@ -698,7 +698,7 @@ paths: value: tracking_number: EJ958083578US order_address_id: 1 - shipping_provider: '' + shipping_provider: fedex items: - order_product_id: 15 quantity: 2 @@ -992,22 +992,22 @@ paths: timestamp: 'Fri, 24 Jun 2022 03:52:03 +0000' shipping_provider_id: bcrealtime shipping_provider_quote: - rate: - value: '107.32' - unit: USD - transitTime: '1' - name: Priority Overnight - signatureConfirmationFee: {} - carrierName: '' - carrierCode: {} - code: {} - deliveryMessage: '' - labelSizes: [] - insuredMailFee: {} - dates: [] - rateId: {} - description: '' - additionalInfo: {} + - rate: + value: '107.32' + unit: USD + transitTime: '1' + name: Priority Overnight + signatureConfirmationFee: {} + carrierName: '' + carrierCode: {} + code: {} + deliveryMessage: '' + labelSizes: [] + insuredMailFee: {} + dates: [] + rateId: {} + description: '' + additionalInfo: {} provider_code: fedex carrier_code: '' rate_code: '' @@ -1464,7 +1464,7 @@ components: url: 'https://api.bigcommerce.com/stores/{store_hash}/v2/orders/100/coupons' resource: /orders/100/coupons external_id: null - external_merchant_id: {} + external_merchant_id: null tax_provider_id: BasicTaxProvider store_default_currency_code: '' store_default_to_transactional_exchange_rate: '1.0000000000' @@ -1658,10 +1658,10 @@ components: street_2: '' city: Austin state: Texas - zip: 78108 + zip: '78108' country: United States country_iso2: US - phone: 1234567890 + phone: '1234567890' email: janedoe@example.com form_fields: - name: Delivery Instructions @@ -1697,51 +1697,51 @@ components: date_shipped: '' status_id: 11 status: Awaiting Fulfillment - subtotal_ex_tax: 924.47 - subtotal_inc_tax: 1000.74 - subtotal_tax: 76.27 - base_shipping_cost: 8 - shipping_cost_ex_tax: 7.39 - shipping_cost_inc_tax: 8 - shipping_cost_tax: 0.61 + subtotal_ex_tax: '924.47' + subtotal_inc_tax: '1000.74' + subtotal_tax: '76.27' + base_shipping_cost: '8' + shipping_cost_ex_tax: '7.39' + shipping_cost_inc_tax: '8' + shipping_cost_tax: '0.61' shipping_cost_tax_class_id: 0 - base_handling_cost: 0 - handling_cost_ex_tax: 0 - handling_cost_inc_tax: 0 - handling_cost_tax: 0 + base_handling_cost: '0' + handling_cost_ex_tax: '0' + handling_cost_inc_tax: '0' + handling_cost_tax: '0' handling_cost_tax_class_id: 0 - base_wrapping_cost: 0 - wrapping_cost_ex_tax: 0 - wrapping_cost_inc_tax: 0 - wrapping_cost_tax: 0 + base_wrapping_cost: '0' + wrapping_cost_ex_tax: '0' + wrapping_cost_inc_tax: '0' + wrapping_cost_tax: '0' wrapping_cost_tax_class_id: 0 - total_ex_tax: 931.86 - total_inc_tax: 1008.74 + total_ex_tax: '931.86' + total_inc_tax: '1008.74' total_tax: 76.88 items_total: 11 items_shipped: 0 payment_method: Test Payment Gateway payment_provider_id: '' payment_status: captured - refunded_amount: 0 + refunded_amount: '0' order_is_digital: false - store_credit_amount: 0 - gift_certificate_amount: 0 + store_credit_amount: '0' + gift_certificate_amount: '0' ip_address: 70.112.53.67 geoip_country: United States geoip_country_iso2: US currency_id: 1 currency_code": USD - currency_exchange_rate: 1 + currency_exchange_rate: '1' default_currency_id: 1 default_currency_code: USD staff_notes: BIN-45 customer_message: Custom Journal Added - discount_amount: 0 + discount_amount: '0' coupon_discount": 0 shipping_address_count: 1 is_deleted: false - ebay_order_id: 0 + ebay_order_id: '0' cart_id: 8b84f622-faf1-4c10-887b-f5dff2f9eaf4 billing_address: first_name: Jane @@ -1757,13 +1757,13 @@ components: phone: '1234567890' email: janedoe@email.com form_fields: - name: Delivery Instructions - value: Leave in backyard + - name: Delivery Instructions + value: Leave in backyard is_email_opt_in: false credit_card_type: {} order_source: manual channel_id: 1 - external_source: {} + external_source: '' products: url: 'https://api.bigcommerce.com/stores/{store_hash}/v2/orders/247/products' resource: /orders/247/products @@ -1773,11 +1773,11 @@ components: coupons: url: 'https://api.bigcommerce.com/stores/{store_hash}/v2/orders/247/coupons' resource: /orders/247/coupons - external_id: {} - external_merchant_id: {} + external_id: null + external_merchant_id: null tax_provider_id: BasicTaxProvider store_default_currency_code: USD - store_default_to_transactional_exchange_rate: 1 + store_default_to_transactional_exchange_rate: '1' custom_status: Awaiting Fulfillment customer_locale: en external_order_id: external-order-id @@ -2051,7 +2051,7 @@ components: discounted_total_inc_tax: '37.2300' Product with file upload: value: - - id: 35 + id: 35 order_id: 125 product_id: 127 variant_id: 99 @@ -2091,7 +2091,7 @@ components: wrapping_message: '' quantity_shipped: 0 event_name: null - event_date: '' + event_date: null fixed_shipping_cost: '0.0000' ebay_item_id: '' ebay_transaction_id: '' @@ -2115,7 +2115,7 @@ components: display_value_customer: BigCommerceLogo.jpeg display_value_merchant: BigCommerceLogo.jpeg value: "{\"originalName\":\"BigCommerceLogo.jpeg\",\"temporaryPath\":\"121_fbfb71dfc5a5d911f62d8e35dedd6e45.jpeg\",\"path\":\"f606efcae7e179970b19c3658142c5d0.jpeg\"}" - type: File upload field + type: File Upload name: Custom Logo Engraving display_style: "" configurable_fields: [] @@ -2162,7 +2162,7 @@ components: wrapping_message: '' quantity_shipped: 0 event_name: null - event_date: '' + event_date: null fixed_shipping_cost: '0.0000' ebay_item_id: '' ebay_transaction_id: '' @@ -2218,137 +2218,19 @@ components: wrapping_cost_tax: '0.0000' wrapping_message: '' quantity_shipped: 0 - event_name: {} - event_date: '' + event_name: null + event_date: null fixed_shipping_cost: '0.0000' ebay_item_id: '' ebay_transaction_id: '' option_set_id: 68 - parent_order_product_id: {} + parent_order_product_id: null is_bundled_product: false bin_picking_number: '' - external_id: {} + external_id: null fulfillment_source: '' brand: BigCommerce applied_discounts: [] - Product with custom message: - value: - - id: 143 - option_id: 96 - order_product_id: 240 - product_option_id: 242 - display_name: Color - display_name_customer: Color - display_name_merchant: Color - display_value: Red - display_value_customer: Red - display_value_merchant: Red - value: '211' - type: Swatch - name: Color1549572910-201 - display_style: '' - - id: 144 - option_id: 114 - order_product_id: 240 - product_option_id: 263 - display_name: PickList PriceList - display_name_customer: PickList PriceList - display_name_merchant: PickList PriceList - display_value: Able Brewing System - display_value_customer: Able Brewing System - display_value_merchant: Able Brewing System - value: '237' - type: Product Pick List - name: PickList-PriceList1549572910-201 - display_style: Pick list with photos - - id: 145 - option_id: 97 - order_product_id: 240 - product_option_id: 243 - display_name: T-Shirt Size - display_name_customer: T-Shirt Size - display_name_merchant: T-Shirt Size - display_value: Small T-Shirt - display_value_customer: Small T-Shirt - display_value_merchant: Small T-Shirt - value: '214' - type: Multiple choice - name: T-Shirt-Size1545071633-201 - display_style: Rectangle - - id: 146 - option_id: 105 - order_product_id: 240 - product_option_id: 254 - display_name: Custom Message - display_name_customer: Custom Message - display_name_merchant: Custom Message - display_value: BigCommerce - display_value_customer: BigCommerce - display_value_merchant: BigCommerce - value: BigCommerce - type: Text field - name: Custom-Message1549572912-201 - display_style: '' - configurable_fields: - product_options: - value: - - id: 143 - option_id: 96 - order_product_id: 240 - product_option_id: 242 - display_name: Color - display_name_customer: Color - display_name_merchant: Color - display_value: Red - display_value_customer: Red - display_value_merchant: Red - value: '211' - type: Swatch - name: Color1549572910-201 - display_style: '' - - id: 144 - option_id: 114 - order_product_id: 240 - product_option_id: 263 - display_name: PickList PriceList - display_name_customer: PickList PriceList - display_name_merchant: PickList PriceList - display_value: Able Brewing System - display_value_customer: Able Brewing System - display_value_merchant: Able Brewing System - value: '237' - type: Product Pick List - name: PickList-PriceList1549572910-201 - display_style: Pick list with photos - - id: 145 - option_id: 97 - order_product_id: 240 - product_option_id: 243 - display_name: T-Shirt Size - display_name_customer: T-Shirt Size - display_name_merchant: T-Shirt Size - display_value: Small T-Shirt - display_value_customer: Small T-Shirt - display_value_merchant: Small T-Shirt - value: '214' - type: Multiple choice - name: T-Shirt-Size1545071633-201 - display_style: Rectangle - - id: 146 - option_id: 105 - order_product_id: 240 - product_option_id: 254 - display_name: Custom Message - display_name_customer: Custom Message - display_name_merchant: Custom Message - display_value: BigCommerce - display_value_customer: BigCommerce - display_value_merchant: BigCommerce - value: BigCommerce - type: Text field - name: Custom-Message1549572912-201 - display_style: '' - configurable_fields: [] orderShipmentCollection_Resp: description: '' content: @@ -2711,438 +2593,6 @@ components: priority: 0 priority_amount: '4.4000' line_amount: '4.4000' - actual-order-response: - description: '' - content: - application/json: - schema: - title: Order - example: - id: 113 - customer_id: 1 - date_created: 'Wed, 17 Jan 2018 20:11:21 +0000' - date_modified: 'Wed, 25 Apr 2018 20:20:25 +0000' - date_shipped: '' - status_id: 7 - status: Awaiting Payment - subtotal_ex_tax: '143.9500' - subtotal_inc_tax: '143.9500' - subtotal_tax: '0.0000' - base_shipping_cost: '0.0000' - shipping_cost_ex_tax: '0.0000' - shipping_cost_inc_tax: '0.0000' - shipping_cost_tax: '0.0000' - shipping_cost_tax_class_id: 2 - base_handling_cost: '0.0000' - handling_cost_ex_tax: '0.0000' - handling_cost_inc_tax: '0.0000' - handling_cost_tax: '0.0000' - handling_cost_tax_class_id: 2 - base_wrapping_cost: '0.0000' - wrapping_cost_ex_tax: '0.0000' - wrapping_cost_inc_tax: '0.0000' - wrapping_cost_tax: '0.0000' - wrapping_cost_tax_class_id: 3 - total_ex_tax: '138.9500' - total_inc_tax: '138.9500' - total_tax: '0.0000' - items_total: 2 - items_shipped: 0 - payment_method: Cash on Delivery - payment_provider_id: null - payment_status: '' - refunded_amount: '0.0000' - order_is_digital: false - store_credit_amount: '0.0000' - gift_certificate_amount: '0.0000' - ip_address: 64.183.182.114 - geoip_country: United States - geoip_country_iso2: US - currency_id: 1 - currency_code: USD - currency_exchange_rate: '1.0000000000' - default_currency_id: 1 - default_currency_code: USD - staff_notes: '' - customer_message: '' - discount_amount: '0.0000' - coupon_discount: '5.0000' - shipping_address_count: 1 - is_deleted: false - ebay_order_id: '0' - cart_id: 1cf3da59-1c90-42a9-82fb-2a954743a390 - billing_address: - first_name: Jane - last_name: Does - company: '' - street_1: 123 MainStreet - street_2: '' - city: Austin - state: Texas - zip: '78751' - country: United States - country_iso2: US - phone: '' - email: jane@example.com - form_fields: [] - is_email_opt_in: false - credit_card_type: null - order_source: www - external_source: null - products: - url: 'https://api.bigcommerce.com/stores/{store_hash}/v2/orders/113/products' - resource: /orders/113/products - shipping_addresses: - url: 'https://api.bigcommerce.com/stores/{store_hash}/v2/orders/113/shippingaddresses' - resource: /orders/113/shippingaddresses - coupons: - url: 'https://api.bigcommerce.com/stores/{store_hash}/v2/orders/113/coupons' - resource: /orders/113/coupons - external_id: null - external_merchant_id: null - custom_status: Awaiting Payment - external_order_id: external-order-id - type: object - properties: - id: - description: The ID of the order, a read-only value. Do not pass in PUT or POST request. - example: 118 - type: integer - customer_id: - description: The ID of the customer placing the order; or 0 if it was a guest order. - example: 6 - type: number - date_created: - type: string - description: The date the order was created, formatted in the RFC-2822 standard. You set this attribute on Order creation (POST request) 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` - date_modified: - type: string - description: A read-only value representing the last modification of the order. Do not attempt to modify or set this value in a POST or PUT request. RFC-2822 - date_shipped: - type: string - description: A read-only value representing the date of shipment. Do not attempt to modify or set this value in a POST or PUT request. RFC-2822 - status_id: - description: The status ID of the order. - example: 11 - type: integer - cart_id: - description: The cart ID from which this order originated, if applicable. Correlates with the Cart API. This is a read-only field; do not set or modify its value in a POST or PUT request. - example: a8458391-ef68-4fe5-9ec1-442e6a767364 - type: string - status: - description: The status will include one of the (string, optional) - values defined under Order Statuses. This is a read-only value. Do not attempt to modify or set this value in a POST or PUT request. - example: Awaiting Fulfillment - type: string - custom_status: - description: Contains the same (string, optional) - value as the `custom_label` property of the Order Statuses object. - example: Awaiting Fulfillment - type: string - subtotal_ex_tax: - description: Override value for subtotal excluding tax. If specified, the field `subtotal_inc_tax` is also required. (Float, Float-As-String, Integer) - example: '225.0000' - type: string - subtotal_inc_tax: - description: Override value for subtotal including tax. If specified, the field `subtotal_ex_tax` is also required. (Float, Float-As-String, Integer) - example: '225.0000' - type: string - subtotal_tax: - description: A read-only value. Do not attempt to set or modify this value in a POST or PUT request. (Float, Float-As-String, Integer) - example: '0.0000' - type: string - base_shipping_cost: - description: The value of the base shipping cost. (Float, Float-As-String, Integer) - example: '0.0000' - type: string - shipping_cost_ex_tax: - description: The value of shipping cost, excluding tax. (Float, Float-As-String, Integer) - example: '0.0000' - type: string - shipping_cost_inc_tax: - description: The value of shipping cost, including tax. (Float, Float-As-String, Integer) - example: '0.0000' - type: string - shipping_cost_tax: - description: A read-only value. Do not attempt to modify or set this value in a POST or PUT request. (Float, Float-As-String, Integer) - example: '0.0000' - type: string - shipping_cost_tax_class_id: - description: |- - Shipping-cost tax class. A read-only value. Do not attempt to modify or set this value in a POST or PUT request. (NOTE: Value ignored if automatic tax is enabled on the store.) - example: 2 - type: integer - base_handling_cost: - description: The value of the base handling cost. (Float, Float-As-String, Integer) - example: '0.0000' - type: string - handling_cost_ex_tax: - description: The value of the handling cost, excluding tax. (Float, Float-As-String, Integer) - example: '0.0000' - type: string - handling_cost_inc_tax: - description: The value of the handling cost, including tax. (Float, Float-As-String, Integer) - oneOf: - - type: number - - type: string - handling_cost_tax: - description: A read-only value. Do not attempt to modify or set this value in a POST or PUT request. (Float, Float-As-String, Integer) - example: '0.0000' - type: string - handling_cost_tax_class_id: - description: |- - A read-only value. Do not attempt to set or modify this value in a POST or PUT request. (NOTE: Value ignored if automatic tax is enabled on the store.) - example: 2 - type: integer - base_wrapping_cost: - description: The value of the base wrapping cost. - example: 0 - oneOf: - - type: string - - type: number - wrapping_cost_ex_tax: - description: The value of the wrapping cost, excluding tax. (Float, Float-As-String, Integer) - example: '0.0000' - type: string - wrapping_cost_inc_tax: - description: The value of the wrapping cost, including tax. (Float, Float-As-String, Integer) - example: '0.0000' - type: string - wrapping_cost_tax: - description: A read-only value. Do not attempt to modify or set this value in a POST or PUT request. (Float, Float-As-String, Integer) - example: '0.0000' - type: string - wrapping_cost_tax_class_id: - description: |- - A read-only value. Do not attempt to set or modify this value in a POST or PUT request. (NOTE: Value ignored if automatic tax is enabled on the store.) - example: 3 - type: integer - total_ex_tax: - description: Override value for the total, excluding tax. If specified, the field `total_inc_tax` is also required. (Float, Float-As-String, Integer) - example: '225.0000' - type: string - total_inc_tax: - description: Override value for the total, including tax. If specified, the field `total_ex_tax` is also required. (Float, Float-As-String, Integer) - example: '225.0000' - type: string - total_tax: - description: A read-only value. Do not attempt to set or modify this value in a POST or PUT request. (Float, Float-As-String, Integer) - example: '0.0000' - type: string - items_total: - description: The total number of items in the order. - example: 1 - type: number - items_shipped: - description: The number of items that have been shipped. - example: 0 - type: number - payment_method: - description: The display name of the payment method for this order. - example: Cash on Delivery - type: string - payment_provider_id: - description: The external Transaction ID/Payment ID within this order’s payment provider (if a payment provider was used). - example: null - type: string - nullable: true - payment_status: - description: A read-only value. Do not attempt to set or modify this value in a POST or PUT request. - type: string - refunded_amount: - description: The amount refunded from this transaction; always returns `0`. (Float, Float-As-String, Integer) - example: '0.0000' - type: string - order_is_digital: - description: Whether this is an order for digital products. - example: false - type: boolean - store_credit_amount: - description: Represents the store credit that the shopper has redeemed on this individual order. This is a read-only value. Do not pass in a POST or PUT request. (Float, Float-As-String, Integer) - example: '0.0000' - type: string - gift_certificate_amount: - description: A read-only value. Do not pass in a POST or PUT request. (Float, Float-As-String, Integer) - example: '0.0000' - type: string - ip_address: - description: IP Address of the customer, if known. - example: 12.345.678.910 - type: string - geoip_country: - description: The full name of the country where the customer made the purchase, based on the IP. - example: United States - type: string - geoip_country_iso2: - description: The country where the customer made the purchase, in ISO2 format, based on the IP. - example: US - type: string - currency_id: - description: The display currency ID. May be different from transactional currency. A read-only value. Do not pass in a POST or PUT request. - example: 1 - type: integer - currency_code: - description: The currency code of the display currency used to present prices on the storefront. May be different from transactional currency. A read-only value. Do not pass in a POST or PUT request. - example: USD - type: string - currency_exchange_rate: - description: A read-only value. Do not pass in a POST or PUT request. (Float, Float-As-String, Integer) - example: '1.0000000000' - type: string - default_currency_id: - description: The transactional currency ID. A read-only value. Do not pass in a POST or PUT request. - example: 1 - type: integer - default_currency_code: - description: The currency code of the transactional currency the shopper pays in. A read-only value. Do not pass in a POST or PUT request. - type: string - example: USD - staff_notes: - type: string - description: Any additional notes for staff. - example: Send Saturday - maxLength: 65535 - customer_message: - description: Message that the customer entered (number, optional) -o the `Order Comments` box during checkout. - example: Thank you - type: string - discount_amount: - description: Amount of discount for this transaction. (Float, Float-As-String, Integer) - example: '0.0000' - type: string - coupon_discount: - description: A read-only value. Do not pass in a POST or PUT request. (Float, Float-As-String, Integer) - example: '5.0000' - type: string - shipping_address_count: - type: number - description: The number of shipping addresses associated with this transaction. A read-only value. Do not pass in a POST or PUT request. - is_deleted: - description: Boolean value indicates whether the order was deleted (archived). Set to to true to archive an order. - example: false - type: boolean - is_email_opt_in: - description: Boolean value indicates whether the shopper has selected an opt-in check box (on the checkout page) to receive emails. A read-only value. Do not pass in a POST or PUT request. - example: false - type: boolean - credit_card_type: - description: Credit card type - example: 0 - type: integer - nullable: true - ebay_order_id: - description: If the order was placed through eBay, the eBay order number will be included. Otherwise, the value will be `0`. - example: '0' - type: string - billing_address: - title: Billing Address - type: object - description: Required to create an order. - properties: - first_name: - description: '' - example: Jane - type: string - last_name: - description: '' - example: Doe - type: string - company: - description: '' - type: string - street_1: - description: '' - example: 123 Main Street - type: string - street_2: - description: '' - type: string - city: - description: '' - example: Austin - type: string - state: - description: '' - example: TX - type: string - zip: - description: '' - example: '12345' - type: number - country: - description: '' - example: United States - type: string - country_iso2: - description: '' - example: US - type: string - phone: - description: '' - type: string - email: - description: '' - example: janedoe@example.com - type: string - form_fields: - description: '' - type: array - items: - title: Form Fields - type: object - description: Read-Only. If you have required address form fields they will need to be set as optional before creating an order with the API. - properties: - name: - description: Name of the form field. - type: string - example: License Id - readOnly: true - value: - description: Value of the form field. - type: string - example: 123BAF - readOnly: true - readOnly: true - order_source: - description: Orders submitted from the store's website will include a `www` value. Orders submitted with the Checkout API will be set to `checkout_api`. - example: www, iPhone, Android, mobile, manual - type: string - external_source: - description: |- - This value identifies an external system that generated the order and submitted it to BigCommerce using the Orders API. - * When supplying the value, we recommend combining the type of system and vendor, e.g., ERP (Acumatica) or POS (Square). - * If you are migrating historical orders processed on another eCommerce platform to BigCommerce, supply the following code as the value: M-MIG. This code will exclude historical orders from the store’s GMV/order count, which factors into pricing. - * If you do not provide a value, then it will default to null.. - example: null - nullable: true - type: string - products: - $ref: '#/components/schemas/products_Resource' - shipping_addresses: - $ref: '#/components/schemas/shippingAddresses_Resource' - coupons: - $ref: '#/components/schemas/coupons_Resource' - external_id: - description: (Read-only) ID of the order in another system. For example, the Amazon order ID if this is an Amazon order. - example: null - type: string - nullable: true - readOnly: true - external_merchant_id: - description: ID of the merchant. - example: null - type: string - nullable: true - channel_id: - type: integer - example: 1 - description: Shows where the order originated. The channel_id will default to 1. Read-Only. - tax_provider_id: - type: string - description: | - BasicTaxProvider - Tax is set to manual and order is created in the store. - - AvaTaxProvider - Tax is set to automatic and order is created in the store. Used for Avalara. - - "" (empty string) - The order is created with the API, or the tax provider is unknown. 404_Resp: description: Not Found content: @@ -3230,12 +2680,12 @@ components: nullable: true type: string amount: - description: Amount of the discount. This information is returned as in integer. Dollar and percentage discounts will return the same. For example, $3 returns as ''3'' while 5% will return as 5. Check the discount type to see what type of discount is available. - example: 5 - oneOf: + description: Amount of the discount. This information is returned as in integer. Dollar and percentage discounts will return the same. For example, $3 returns as `3` while 5% will return as `5`. Check the discount type to see what type of discount is available. + anyOf: - type: string - type: number - type: integer + example: 5 format: float type: type: integer @@ -3308,7 +2758,7 @@ components: example: '54.0000' type: string price_ex_tax: - description: 'The product’s price excluding tax. (Float, Float-As-String, Integer)' + description: The product’s price excluding tax. (Float, Float-As-String, Integer) example: '54.0000' type: string price_inc_tax: @@ -3403,6 +2853,7 @@ components: description: Name of gift-wrapping option. example: null type: string + nullable: true base_wrapping_cost: description: The value of the base wrapping cost. (Float, Float-As-String, Integer) example: '0.0000' @@ -3464,6 +2915,14 @@ components: bin_picking_number: description: Bin picking number for the physical product. type: string + external_id: + description: (Read-only) ID of the order in another system. For example, the Amazon order ID if this is an Amazon order. + type: string + nullable: true + readOnly: true + brand: + description: The productʼs brand. + type: string applied_discounts: description: Array of objects containing discounts applied to the product. type: array @@ -3474,11 +2933,6 @@ components: type: array items: $ref: '#/components/schemas/orderProductOptions' - external_id: - description: (Read-only) ID of the order in another system. For example, the Amazon order ID if this is an Amazon order. - type: string - nullable: true - readOnly: true upc: type: string maxLength: 255 @@ -3874,7 +3328,7 @@ components: example: S type: string value: - description: For file-upload type, it's a unique string describing the properties of the file upload. For other types, it's the value of the property. + description: For file-upload type, itʼs a unique string describing the properties of the file upload. For other types, itʼs the value of the property. example: "{\"originalName\":\"BigCommerceLogo.jpeg\",\"temporaryPath\":\"121_fbfb71dfc5a5d911f62d8e35dedd6e45.jpeg\",\"path\":\"f606efcae7e179970b19c3658142c5d0.jpeg\"}" type: string type: @@ -4041,7 +3495,6 @@ components: timestamp: type: string description: Time the order was created in RFC 2822 format. - format: date-time shipping_provider_id: type: string example: bcstatic @@ -4271,8 +3724,7 @@ components: external_merchant_id: description: The merchant ID represents an upstream order from an external system. It is the source of truth for orders. After setting it, you cannot write to or update the `external_merchant_id`. For example, you can update the Facebook by Meta page ID in a POST request, but a PUT request to update the order will return a 400 error. Please remove it from your request before trying again. example: null - oneOf: - - type: string + type: string nullable: true external_source: description: |- @@ -4602,11 +4054,11 @@ components: example: EUR type: string store_default_currency_code: - description: The currency code of the store's default currency. + description: The currency code of the storeʼs default currency. example: USD type: string store_default_to_transactional_exchange_rate: - description: The exchange rate between the store's default currency and the transactional currency used in the order. + description: The exchange rate between the storeʼs default currency and the transactional currency used in the order. example: '100.0000000000' type: string coupon_discount: @@ -4621,7 +4073,7 @@ components: example: false type: boolean order_source: - description: Orders submitted from the store's website will include a `www` value. Orders submitted with the Checkout API will be set to `checkout_api`. + description: Orders submitted from the storeʼs website will include a `www` value. Orders submitted with the Checkout API will be set to `checkout_api`. example: www, iPhone, Android, mobile, manual type: string consignments: @@ -4939,6 +4391,7 @@ components: 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. type: string + readOnly: true discount_amount: description: Amount of discount for this transaction. (Float, Float-As-String, Integer) example: '0.0000' @@ -4956,8 +4409,7 @@ components: external_merchant_id: description: The merchant ID represents an upstream order from an external system. It is the source of truth for orders. After setting it, you cannot write to or update the `external_merchant_id`. For example, you can update the Facebook by Meta page ID in a POST request, but a PUT request to update the order will return a 400 error. Please remove it from your request before trying again. example: null - oneOf: - - type: string + type: string nullable: true external_source: description: |- @@ -5021,7 +4473,6 @@ components: description: 'The payment method for this order. Can be one of the following: `Manual`, `Credit Card`, `Cash`,`Test Payment Gateway`, etc.' payment_provider_id: description: The external Transaction ID/Payment ID within this order’s payment provider (if a payment provider was used). - example: '' oneOf: - type: string - type: number @@ -5050,12 +4501,14 @@ components: example: Send Saturday maxLength: 65535 shipping_addresses: - allOf: - - type: object - properties: - id: - type: integer - - $ref: '#/components/schemas/shippingAddress_Put' + type: array + items: + allOf: + - type: object + properties: + id: + type: integer + - $ref: '#/components/schemas/shippingAddress_Put' status_id: description: The status ID of the order. type: integer @@ -5085,6 +4538,7 @@ components: description: The customer’s locale. external_order_id: type: string + nullable: true example: external-order-id description: The order ID in another system, such as the Amazon Order ID if this is an Amazon order. After setting it, you can update this field using a POST or PUT request. total_ex_tax: @@ -5310,12 +4764,12 @@ components: description: 2-letter ISO Alpha-2 code for the country. email: type: string - description: Pickup location's email address. + description: Pickup locationʼs email address. maxLength: 255 example: location1@example.com phone: type: string - description: Pickup location's phone number. + description: Pickup locationʼs phone number. maxLength: 125 example: +1 111-111-1111 x-examples: {} diff --git a/reference/price_lists.v3.yml b/reference/price_lists.v3.yml index ad815e6f7..ed27d9cc5 100644 --- a/reference/price_lists.v3.yml +++ b/reference/price_lists.v3.yml @@ -1904,7 +1904,7 @@ paths: description: |- Returns a *Price List Record* using the currency code. You can use optional parameters. **Notes** - * Supports up to 40 simultaneous GET requests. Running more than the allowed number of requests concurrently on the same store will result in a `429` status error, and your additional requests will fail. + * Supports up to 50 simultaneous GET requests. Running more than the allowed number of requests concurrently on the same store will result in a `429` status error, and your additional requests will fail. operationId: getPriceListRecord parameters: - name: price_list_id @@ -2458,7 +2458,10 @@ paths: tags: - Price Lists Records summary: Delete a Price Record by Currency Code - description: Deletes a *Price List Record* using the currency code. + description: |- + Deletes a *Price List Record* using the currency code. + **Note:** + * Supports up to 25 simultaneous DELETE requests. Running more than the allowed number of requests concurrently on the same store will result in a `429` status error, and your additional requests will fail. operationId: deletePriceListRecord parameters: - name: price_list_id @@ -2620,7 +2623,10 @@ paths: put: tags: - Price Lists Assignments - description: Upsert a single `Price List Assignment` for a `Price List`. + description: |- + Upsert a single `Price List Assignment` for a `Price List`. + **Note:** + * Supports up to 25 simultaneous PUT requests. Running more than the allowed number of requests concurrently on the same store will result in a `429` status error and your additional requests will fail. summary: Upsert Price List Assignment operationId: upsertPriceListAssignment parameters: diff --git a/reference/redirects.v3.yml b/reference/redirects.v3.yml index 601432832..743614f9f 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`.' diff --git a/reference/settings.v3.yml b/reference/settings.v3.yml index 4942958d6..ab4a8eb4f 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: @@ -781,11 +782,12 @@ paths: tags: - Search Filters '/settings/store/locale': - parameters: - - $ref: '#/components/parameters/Accept' get: summary: Get Locale Settings description: Returns global locale settings. + parameters: + - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/ChannelIdParam' responses: '200': description: '' @@ -810,9 +812,14 @@ paths: - Store Locale put: summary: Update Locale Settings - description: Updates global locale settings. + description: |- + Updates global locale settings. + + Set a channel override by using the `channel_id` query parameter. To remove a channel override, set `null` for a field. The field then inherits the global value. parameters: + - $ref: '#/components/parameters/Accept' - $ref: '#/components/parameters/ContentType' + - $ref: '#/components/parameters/ChannelIdParam' requestBody: content: application/json: @@ -1428,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: @@ -1627,8 +1694,8 @@ components: default: relevance enum: - relevance - - atoz - - ztoa + - alphaasc + - alphadesc title: ContentSortEnumValues x-internal: false DetailedErrors: @@ -2085,11 +2152,12 @@ components: - featured - bestselling - newest - - atoz - - ztoa - - highestprice - - lowestprice - - bestreviewed + - alphaasc + - alphadesc + - pricedesc + - priceasc + - avgcustomerreview + - relevance title: ProductSortEnumValues x-internal: false RobotsTxtSettings: @@ -2239,6 +2307,11 @@ components: type: boolean search_suggest: type: boolean + required: + - content_product_sort + - default_product_sort + - product_filtering_enabled + - search_suggest x-internal: false StorefrontSecuritySettings: type: object @@ -2290,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 @@ -2318,7 +2425,7 @@ components: properties: '': type: string - example: 'Incorrect value [current__only], it should match one of: current_category_only,child_categories_if_category_empty,child_categories; Incorrect value [besling], it should match one of: featured,newest,bestselling,atoz,ztoa,bestreviewed,lowestprice,highestprice' + example: 'Incorrect value [current__only], it should match one of: current_category_only,child_categories_if_category_empty,child_categories; Incorrect value [besling], it should match one of: featured, newest, bestselling, alphaasc, alphadesc, avgcustomerreview, priceasc, pricedesc, relevance' minLength: 1 status: type: number @@ -2334,7 +2441,7 @@ components: x-examples: example-1: errors: - '': 'Incorrect value [], it should match one of: current_category_only,child_categories_if_category_empty,child_categories; Incorrect value [], it should match one of: featured,newest,bestselling,atoz,ztoa,bestreviewed,lowestprice,highestprice' + '': 'Incorrect value [], it should match one of: current_category_only,child_categories_if_category_empty,child_categories; Incorrect value [], it should match one of: featured, newest, bestselling, alphaasc, alphadesc, avgcustomerreview, priceasc, pricedesc, relevance' status: 422 title: JSON data is missing or invalid type: 'https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes' diff --git a/reference/themes.v3.yml b/reference/themes.v3.yml index 61b0475c0..fea62d197 100644 --- a/reference/themes.v3.yml +++ b/reference/themes.v3.yml @@ -694,7 +694,7 @@ components: items: $ref: '#/components/schemas/themeConfiguration_Full' meta: - $ref: '#/components/schemas/CollectionMeta' + $ref: '#/components/schemas/ThemesCollectionMeta' examples: response: value: @@ -712,10 +712,6 @@ components: per_page: 50 current_page: 1 total_pages: 1 - links: - previous: nostrud in - current: '?page=1&limit=50' - next: in securitySchemes: X-Auth-Token: name: X-Auth-Token @@ -796,6 +792,42 @@ components: Link to the next page returned in the response. title: Collection Meta x-internal: false + ThemesCollectionMeta: + type: object + description: 'Data about the response, including pagination and collection totals.' + properties: + pagination: + type: object + description: 'Data about the response, including pagination and collection totals.' + title: Pagination + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 36 + count: + type: integer + description: | + Total number of items in the collection response. + example: 36 + per_page: + type: integer + description: | + The amount of items returned in the collection per page, controlled by the limit parameter. + example: 50 + current_page: + type: integer + description: | + The page you are currently on within the collection. + example: 1 + total_pages: + type: integer + description: | + The total number of pages in the collection. + example: 1 + title: Themes Collection Meta + x-internal: false Pagination: type: object description: 'Data about the response, including pagination and collection totals.' diff --git a/reference/webhooks.v3.yml b/reference/webhooks.v3.yml index e5a7d3eef..0dc0b9bed 100644 --- a/reference/webhooks.v3.yml +++ b/reference/webhooks.v3.yml @@ -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 @@ -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. @@ -1419,7 +1426,7 @@ 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 @@ -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