diff --git a/models/email_templates/_all.yml b/models/email_templates/_all.yml index fb37bee75..026499682 100644 --- a/models/email_templates/_all.yml +++ b/models/email_templates/_all.yml @@ -1583,7 +1583,7 @@ properties: example: "Boutique" Order Notification: title: Order Notification Email Template - description: Order notification email triggers when a merchant or store admin adds a message to an order. + description: Order notification email triggers when a retailer or store admin adds a message to an order. type: object properties: notification: diff --git a/models/email_templates/data/order_message_notification.json b/models/email_templates/data/order_message_notification.json index f687de208..24a284031 100644 --- a/models/email_templates/data/order_message_notification.json +++ b/models/email_templates/data/order_message_notification.json @@ -1,6 +1,6 @@ { "notification": { - "message": "Message from the merchant", + "message": "Message from the retailer", "link": "https://my-dev-store-97434969.store.bcdev/account.php?action=inbox" }, "store": { @@ -40,4 +40,4 @@ "go_shopping": "Go shopping" } } -} \ No newline at end of file +} diff --git a/models/email_templates/order_message_notification.yml b/models/email_templates/order_message_notification.yml index 9a07ff89c..e5d544d7b 100644 --- a/models/email_templates/order_message_notification.yml +++ b/models/email_templates/order_message_notification.yml @@ -1,6 +1,6 @@ Order Notification: title: Order Notification Email Template - description: Order notification email triggers when a merchant or store admin adds a message to an order. + description: Order notification email triggers when a retailer or store admin adds a message to an order. type: object properties: notification: @@ -90,7 +90,7 @@ Order Notification: type: string examples: notification: - message: Message from the merchant + message: Message from the retailer link: 'https://my-dev-store-97434969.store.bcdev/account.php?action=inbox' store: name: My Dev Store 97434969 diff --git a/reference/abandoned_carts.v3.yml b/reference/abandoned_carts.v3.yml index 96fbecec9..1d0f30c5d 100644 --- a/reference/abandoned_carts.v3.yml +++ b/reference/abandoned_carts.v3.yml @@ -403,23 +403,23 @@ components: description: Indicates whether or not a customer should receive abandoned cart emails based on their consent. By default customers will not receive emails. type: boolean email_merchant_when_cart_is_converted: - description: Indicates whether or not a merchant should receive a notification email when a cart is converted into an order + description: Indicates whether or not a retailer should receive a notification email when a cart is converted into an order type: boolean email_merchant_when_cart_is_abandoned: - description: Indicates whether or not a merchant should receive a notification email when a cart is abandoned + description: Indicates whether or not a retailer should receive a notification email when a cart is abandoned type: boolean - merchant_email_address: - description: The email address for receiving merchant notifications + retailer_email_address: + description: The email address for receiving retailer notifications type: string format: email - merchant_abandoned_cart_email_frequency_type: + retailer_abandoned_cart_email_frequency_type: description: 'Indicates whether to send an email for every abandoned cart, or to send a digest email after X number of abandoned carts' type: string enum: - digest - individual - merchant_abandoned_cart_digest_email_frequency: - description: The number of abandoned carts to accumulate before a digest email is sent to a merchant + retailer_abandoned_cart_digest_email_frequency: + description: The number of abandoned carts to accumulate before a digest email is sent to a retailer type: integer minimum: 2 maximum: 1000 @@ -442,27 +442,27 @@ components: type: boolean nullable: true email_merchant_when_cart_is_converted: - description: 'Indicates whether or not a merchant should receive a notification email when a cart is converted into an order. If it is null, it means there is no override for the specified channel.' + description: 'Indicates whether or not a retailer should receive a notification email when a cart is converted into an order. If it is null, it means there is no override for the specified channel.' type: boolean nullable: true email_merchant_when_cart_is_abandoned: - description: 'Indicates whether or not a merchant should receive a notification email when a cart is abandoned. If it is null, it means there is no override for the specified channel.' + description: 'Indicates whether or not a retailer should receive a notification email when a cart is abandoned. If it is null, it means there is no override for the specified channel.' type: boolean nullable: true - merchant_email_address: - description: 'The email address for receiving merchant notifications. If it is null, it means there is no override for the specified channel.' + retailer_email_address: + description: 'The email address for receiving retailer notifications. If it is null, it means there is no override for the specified channel.' type: string format: email nullable: true - merchant_abandoned_cart_email_frequency_type: + retailer_abandoned_cart_email_frequency_type: description: 'Indicates whether to send an email for every abandoned cart or to send a digest email after X number of abandoned carts. If it is null, it means there is no override for the specified channel.' type: string enum: - digest - individual nullable: true - merchant_abandoned_cart_digest_email_frequency: - description: 'The number of abandoned carts to accumulate before a digest email is sent to a merchant. If it is null, it means there is no override for the specified channel.' + retailer_abandoned_cart_digest_email_frequency: + description: 'The number of abandoned carts to accumulate before a digest email is sent to a retailer. If it is null, it means there is no override for the specified channel.' type: integer minimum: 2 maximum: 1000 @@ -493,9 +493,9 @@ components: - marketing_emails_require_customer_consent - email_merchant_when_cart_is_converted - email_merchant_when_cart_is_abandoned - - merchant_email_address - - merchant_abandoned_cart_email_frequency_type - - merchant_abandoned_cart_digest_email_frequency + - retailer_email_address + - retailer_abandoned_cart_email_frequency_type + - retailer_abandoned_cart_digest_email_frequency x-tags: - Models GlobalAbandonedCartSettingsResponse: diff --git a/reference/catalog/product-modifiers_catalog.v3.yml b/reference/catalog/product-modifiers_catalog.v3.yml index f86def38e..8d18ef32c 100644 --- a/reference/catalog/product-modifiers_catalog.v3.yml +++ b/reference/catalog/product-modifiers_catalog.v3.yml @@ -4,7 +4,7 @@ info: description: |- > The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the [Catalog Overview](/api-docs/store-management/catalog/products-overview). - Product Modifiers represent choices that the shopper can make to change how the merchant customizes or adds on to the product. Examples include shipping insurance, monograms, custom inseam length, and a color selection for an unfinished product. + Product Modifiers represent choices that the shopper can make to change how the retailer customizes or adds on to the product. Examples include shipping insurance, monograms, custom inseam length, and a color selection for an unfinished product. Modifier values do not change which item is picked in a warehouse, but they change what happens to that item between the warehouse shelf and the shopper taking possession of their order. diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml index 9fcb84746..01de0a7f6 100644 --- a/reference/catalog/products_catalog.v3.yml +++ b/reference/catalog/products_catalog.v3.yml @@ -276,12 +276,12 @@ paths: type: string - name: keyword_context in: query - description: Set context used by the search algorithm to return results targeted towards the specified group. Use `merchant` to help merchants search their own catalog. Use `shopper` to return shopper-facing search results. + description: Set context used by the search algorithm to return results targeted towards the specified group. Use `retailer` to help retailers search their own catalog. Use `shopper` to return shopper-facing search results. schema: type: string enum: - shopper - - merchant + - retailer - name: status in: query description: | @@ -2645,7 +2645,7 @@ paths: sort_order: 2 title: BigCommerce Company Values description: |- - These are the core principles upon which BigCommerce was built, guiding what we do and how we do it. Each employee learns them, loves them and lives them. Our merchants benefit from them every time they use our product or get help from our support team. + These are the core principles upon which BigCommerce was built, guiding what we do and how we do it. Each employee learns them, loves them and lives them. Our retailers benefit from them every time they use our product or get help from our support team. Join the BigCommerce team and help us build software that changes lives! @@ -8135,7 +8135,7 @@ components: minLength: 0 type: string description: | - Tax Codes, such as AvaTax System Tax Codes, identify products and services that fall into special sales-tax categories. By using these codes, merchants who subscribe to a tax provider integration, such as BigCommerce's Avalara Premium, can calculate sales taxes more accurately. Stores without a tax provider will ignore the code when calculating sales tax. Do not pass more than one code. The codes are case-sensitive. For details, please see the tax provider's documentation. + Tax Codes, such as AvaTax System Tax Codes, identify products and services that fall into special sales-tax categories. By using these codes, retailers who subscribe to a tax provider integration, such as BigCommerce's Avalara Premium, can calculate sales taxes more accurately. Stores without a tax provider will ignore the code when calculating sales tax. Do not pass more than one code. The codes are case-sensitive. For details, please see the tax provider's documentation. categories: type: array description: | diff --git a/reference/channels.v3.yml b/reference/channels.v3.yml index 801be2bae..fd7aecec3 100644 --- a/reference/channels.v3.yml +++ b/reference/channels.v3.yml @@ -12,7 +12,7 @@ info: ## Channels - A [channel](/docs/rest-management/channels) is anywhere a merchant sells their products. This encompasses headless storefronts, marketplaces, POS systems, and marketing platforms. + A [channel](/docs/rest-management/channels) is anywhere a retailer sells their products. This encompasses headless storefronts, marketplaces, POS systems, and marketing platforms. ### Platform @@ -2173,7 +2173,7 @@ components: example-1: true IsVisible: type: boolean - description: 'Indicates if a channel is visible within the BigCommerce merchant admin UI (control panel). If `false`, the channel will not show in Channel Manager nor in any channels dropdown throughout the UI. Default value for this field is `true` if not specified on create.' + description: 'Indicates if a channel is visible within the BigCommerce retailer admin UI (control panel). If `false`, the channel will not show in Channel Manager nor in any channels dropdown throughout the UI. Default value for this field is `true` if not specified on create.' x-internal: false ChannelStatus: type: string @@ -2193,7 +2193,7 @@ components: example-1: active ChannelName: type: string - description: Name of the channel as it will appear to merchants in the control panel. + description: Name of the channel as it will appear to retailers in the control panel. x-internal: false x-examples: example-1: string @@ -2667,7 +2667,7 @@ components: properties: title: type: string - description: Text displayed to the merchant. + description: Text displayed to the retailer. query_path: type: string description: Value used in the `section` query param. diff --git a/reference/checkouts.sf.yml b/reference/checkouts.sf.yml index 2d2744bb0..7ccb00848 100644 --- a/reference/checkouts.sf.yml +++ b/reference/checkouts.sf.yml @@ -2765,7 +2765,7 @@ components: properties: name: type: string - description: The name provided by the merchant. + description: The name provided by the retailer. discountedAmount: type: number description: The discounted amount applied within a given context. @@ -2829,7 +2829,7 @@ components: properties: name: type: string - description: The name provided by the merchant. + description: The name provided by the retailer. discountedAmount: type: number description: The discounted amount applied within a given context. @@ -2944,7 +2944,7 @@ components: properties: name: type: string - description: The name provided by the merchant. + description: The name provided by the retailer. discountedAmount: type: number description: The discounted amount applied within a given context. @@ -3716,7 +3716,7 @@ components: properties: name: type: string - description: The name provided by the merchant. + description: The name provided by the retailer. discountedAmount: type: number description: The discounted amount applied within a given context. @@ -3780,7 +3780,7 @@ components: properties: name: type: string - description: The name provided by the merchant. + description: The name provided by the retailer. discountedAmount: type: number description: The discounted amount applied within a given context. @@ -3892,7 +3892,7 @@ components: properties: name: type: string - description: The name provided by the merchant. + description: The name provided by the retailer. discountedAmount: type: number description: The discounted amount applied within a given context. diff --git a/reference/consent.sf.yml b/reference/consent.sf.yml index 010aa62dc..7e85ed1f1 100644 --- a/reference/consent.sf.yml +++ b/reference/consent.sf.yml @@ -48,7 +48,7 @@ paths: 2. Analytics — These cookies provide statistical information on site usage so the store owner can improve the website over time. 3. Functional — These cookies enable enhanced functionality, such as videos and live chat. If a shopper does not allow these, then some or all of these functions may not work properly. - 4. Targeting; Advertising — These cookies allow merchants to create profiles or personalize content to enhance users' shopping experience. + 4. Targeting; Advertising — These cookies allow retailers to create profiles or personalize content to enhance users' shopping experience. This endpoint only works if the cookie consent feature is enabled. It is assumed the shopper has not consented to anything until a value is explicitly set. The request body must be populated with a complete set of allowed and denied categories. diff --git a/reference/currencies.v2.yml b/reference/currencies.v2.yml index 2d1fffcde..46ce80498 100644 --- a/reference/currencies.v2.yml +++ b/reference/currencies.v2.yml @@ -11,12 +11,12 @@ info: | Default Currency | Storeʼs default currency is the one from which any auto-conversion of pricing (product, tax, shipping, promotions) will happen.| | Display Currency | Currency that is displayed on the storefront. This might or might not mean that shopper can actually transact in that currency. Display currency is also often called "presentment currency" in the payments industry. | | Transactional Currency | Transactional currency is what currency and amount BigCommerce passes to the payment provider and the currency/amount that the shopper will be charged to their bank account. If thereʼs a discrepancy between the storefront display currency and the transactional currency, a shopper has to pay a conversion fee and the conversion rate that will be used will be outside of BigCommerceʼs purview. | - | Settlement Currency | This is the currency in which the merchant gets paid out to their bank account. If thereʼs a discrepancy between the currency that shopper transacts in and the currency in which merchant settles, merchant has to pay a conversion fee and the conversion rate used will be outside of BigCommerceʼs purview. Merchant is able to set their settlement currency through their payment provider. | + | Settlement Currency | This is the currency in which the retailer gets paid out to their bank account. If thereʼs a discrepancy between the currency that shopper transacts in and the currency in which retailer settles, retailer has to pay a conversion fee and the conversion rate used will be outside of BigCommerceʼs purview. Retailer is able to set their settlement currency through their payment provider. | |BigCommerce Conversion Rate | Any conversion rate set on BigCommerce used to convert product’s default currency pricing into a new non-default currency. Conversion rate could be static or dynamic. | - | Static Conversion Rate | One of the two auto-converted pricing options. If a merchant manually enters a static conversion rate, then the conversion rate will remain the same until/unless merchant updates their currency settings to use a different conversion rate. The advantage of using this method is to avoid constantly fluctuating price in non-default currencies. | - | Dynamic Conversion Rate | One of the two auto-converted pricing options. If a merchant selects a dynamic conversion rate, theyʼve tied themselves to a currency conversion service, which will update the conversion rate at a certain frequency. This helps shopper-facing pricing remain most aligned to the storeʼs default currency and keeps non-default currency conversion rate at market rate. Merchant can either use BigCommerce Currency Service provided in the Currency setup page, or they can use API to automatically update the exchange rate from their trusted source. | - | Bank Conversion Rate | Conversion rate used by merchant’s or shopper’s payment or credit card provider when auto-converting from store’s transactional currency. This rate might not align with the BigCommerce conversion rate and BigCommerce has no visibility into it. | - | Multi Currency Pricing | Rather than opting for auto-converting product pricing from default currency using BigCommerce conversion rate, merchant has a choice to set price per product per currency. This will be implemented through price lists. | + | Static Conversion Rate | One of the two auto-converted pricing options. If a retailer manually enters a static conversion rate, then the conversion rate will remain the same until/unless retailer updates their currency settings to use a different conversion rate. The advantage of using this method is to avoid constantly fluctuating price in non-default currencies. | + | Dynamic Conversion Rate | One of the two auto-converted pricing options. If a retailer selects a dynamic conversion rate, theyʼve tied themselves to a currency conversion service, which will update the conversion rate at a certain frequency. This helps shopper-facing pricing remain most aligned to the storeʼs default currency and keeps non-default currency conversion rate at market rate. Retailer can either use BigCommerce Currency Service provided in the Currency setup page, or they can use API to automatically update the exchange rate from their trusted source. | + | Bank Conversion Rate | Conversion rate used by retailer’s or shopper’s payment or credit card provider when auto-converting from store’s transactional currency. This rate might not align with the BigCommerce conversion rate and BigCommerce has no visibility into it. | + | Multi Currency Pricing | Rather than opting for auto-converting product pricing from default currency using BigCommerce conversion rate, retailer has a choice to set price per product per currency. This will be implemented through price lists. | ## FAQ diff --git a/reference/orders.v2.oas2.yml b/reference/orders.v2.oas2.yml index 1d15b7b6a..9af36d6a8 100644 --- a/reference/orders.v2.oas2.yml +++ b/reference/orders.v2.oas2.yml @@ -7,7 +7,7 @@ info: ## Order - The Order object contains a record of the purchase agreement between a shopper and a merchant. To learn more about creating orders, see [Orders API Guide](/api-docs/orders/orders-api-overview). + The Order object contains a record of the purchase agreement between a shopper and a retailer. To learn more about creating orders, see [Orders API Guide](/api-docs/orders/orders-api-overview). ### Currency Fields @@ -2248,7 +2248,7 @@ components: order_address_id: 127 date_created: 'Mon, 11 Mar 2019 17:22:08 +0000' tracking_number: EJ958083578US - merchant_shipping_cost: '0.0000' + retailer_shipping_cost: '0.0000' shipping_method: None comments: Ready to go... shipping_provider: usps @@ -2291,7 +2291,7 @@ components: order_address_id: 128 date_created: 'Mon, 11 Mar 2019 17:22:31 +0000' tracking_number: EJ958083578UK - merchant_shipping_cost: '0.0000' + retailer_shipping_cost: '0.0000' shipping_method: None comments: Janes Order shipping_provider: usps @@ -2343,7 +2343,7 @@ components: order_address_id: 131 date_created: 'Wed, 13 Mar 2019 16:35:37 +0000' tracking_number: EJ958083578US - merchant_shipping_cost: '0.0000' + retailer_shipping_cost: '0.0000' shipping_method: None comments: Ready to go... shipping_provider: usps @@ -2947,7 +2947,7 @@ components: name_merchant: type: string example: Towel Type 1 - description: The product name that is shown to merchant in Control Panel. + description: The product name that is shown to retailer in Control Panel. gift_certificate_id: type: integer example: 52 @@ -3358,7 +3358,7 @@ components: display_name_merchant: type: string example: color - description: The product option name that is shown to merchant in Control Panel. + description: The product option name that is shown to retailer in Control Panel. display_value_customer: type: string example: bleu @@ -3366,7 +3366,7 @@ components: display_value_merchant: type: string example: blue - description: The product option value that is shown to merchant in Control Panel. + description: The product option value that is shown to retailer in Control Panel. x-internal: false formFields: title: formFields @@ -3722,7 +3722,7 @@ components: nullable: true readOnly: true 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. + description: The retailer 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 type: string nullable: true @@ -4125,7 +4125,7 @@ components: name_merchant: type: string example: Towel Type 1 - description: The product name that is shown to merchant in control panel. + description: The product name that is shown to retailer in control panel. quantity: type: integer price_ex_tax: @@ -4230,7 +4230,7 @@ components: name_merchant: type: string example: Towel Type 1 - description: The product name that is shown to merchant in control panel. + description: The product name that is shown to retailer in control panel. product_options: type: array description: List of product variant options and modifiers. `product_options` are required when adding a product with variants and not specifying the `variant_id`, or when products have mandatory modifiers. @@ -4266,7 +4266,7 @@ components: display_name_merchant: type: string example: color - description: The product option name that is shown to merchant in Control Panel. + description: The product option name that is shown to retailer in Control Panel. display_value: type: string example: bleu @@ -4275,7 +4275,7 @@ components: display_value_merchant: type: string example: blue - description: The product option value that is shown to merchant in Control Panel. + description: The product option value that is shown to retailer in Control Panel. minLength: 1 display_value_customer: type: string @@ -4338,7 +4338,7 @@ components: name_merchant: type: string example: Towel Type 1 - description: The product name that is shown to merchant in control panel. + description: The product name that is shown to retailer in control panel. quantity: type: integer price_inc_tax: @@ -4407,7 +4407,7 @@ components: nullable: true readOnly: true 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. + description: The retailer 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 type: string nullable: true diff --git a/reference/orders.v3.yml b/reference/orders.v3.yml index 86b9eca81..7cb497795 100644 --- a/reference/orders.v3.yml +++ b/reference/orders.v3.yml @@ -252,7 +252,7 @@ paths: - provider_id: storecredit amount: 37.89 offline: false - merchant_calculated_override: + retailer_calculated_override: - total_amount: 45.00 total_tax: Tax Exempt (Order Level): @@ -280,14 +280,14 @@ paths: - provider_id: storecredit amount: 232.75 offline: false - Merchant Calculated Override: + Retailer Calculated Override: order_id: 1234 items: - item_type: ORDER item_id: 1234 amount: 10 reason: overcharged - merchant_calculated_override: + retailer_calculated_override: total_amount: 10 tax_amount: 0 payments: @@ -924,7 +924,7 @@ components: items: $ref: '#/components/schemas/CreateReturnRequestItem' comment: - description: A comment provided to the merchant for review. + description: A comment provided to the retailer for review. type: string title: CreateReturnRequest x-internal: false @@ -977,7 +977,7 @@ components: format: email comment: type: string - description: A comment provided to the merchant for review. + description: A comment provided to the retailer for review. status: $ref: '#/components/schemas/Status_Full' date_modified: @@ -1026,22 +1026,22 @@ components: properties: received_quantity: type: integer - description: The quantity of items marked as received by the merchant. + description: The quantity of items marked as received by the retailer. pending_quantity: type: integer - description: The quantity of items pending receipt by the merchant. + description: The quantity of items pending receipt by the retailer. review_state: type: object properties: approved_quantity: type: integer - description: The quantity of items approved for return by the merchant. + description: The quantity of items approved for return by the retailer. pending_quantity: type: integer - description: The quantity of items pending receipt by the merchant. + description: The quantity of items pending receipt by the retailer. rejected_quantity: type: integer - description: The quantity of items rejected by the merchant. + description: The quantity of items rejected by the retailer. x-internal: false StatusUpdate_Full: type: object @@ -2179,7 +2179,7 @@ components: } ``` - In this case there are three refund methods available to the merchant: + In this case there are three refund methods available to the retailer: 1. Refund up to the entire order amount to store credit. 2. Mark an amount up to the full order amount as refunded externally, through a provider or means not represented directly in BC ("custom"). 3. Refund the amount paid by store credit to store credit, and the amount paid by bank deposit with a manual refund, which will be recorded as being refunded against the bank deposit. @@ -2199,8 +2199,8 @@ components: type: array items: $ref: '#/components/schemas/PaymentRequest' - merchant_calculated_override: - $ref: '#/components/schemas/MerchantOverride' + retailer_calculated_override: + $ref: '#/components/schemas/RetailerOverride' required: - items - payments @@ -2268,7 +2268,7 @@ components: uses_merchant_override_values: type: boolean description: | - Whether refund amount and tax are provided explicitly by merchant override. + Whether refund amount and tax are provided explicitly by retailer override. payments: type: array items: @@ -2494,15 +2494,15 @@ components: minLength: 0 maxLength: 1000 example: Customer requested refund - MerchantOverride: + RetailerOverride: type: object - title: Merchant Calculated Override + title: Retailer Calculated Override description: |- - Merchant explicitly provided override based on their own calculation. + Retailer explicitly provided override based on their own calculation. - This override gives merchants the flexibility to - - bypass any tax correction due to tax rate/providers changes between when a customer places an order and a merchant initiates a refund - - use explicit values calculated by external systems (e.g., merchants' own Extended Producer Responsibility or Order Management System) + This override gives retailers the flexibility to + - bypass any tax correction due to tax rate/providers changes between when a customer places an order and a retailer initiates a refund + - use explicit values calculated by external systems (e.g., retailers' own Extended Producer Responsibility or Order Management System) Note: when using the override, BC internal tax based refund calculation is skipped and therefore order/taxes records are not updated. properties: @@ -2545,7 +2545,7 @@ components: description: 'Total tax amount refunded back to the shopper. Note: `order_level_amount` does not affect tax liability. This can be a negative amount indicating we have collected tax by refunding less to the customer.' uses_merchant_override_values: type: boolean - description: Whether refund amount and tax are provided explicitly by merchant override. + description: Whether refund amount and tax are provided explicitly by retailer override. items: type: array description: Array of items refunded. diff --git a/reference/pages.v3.yml b/reference/pages.v3.yml index bcf6a2943..aa1753b96 100644 --- a/reference/pages.v3.yml +++ b/reference/pages.v3.yml @@ -1233,7 +1233,7 @@ components: default: false is_customers_only: type: boolean - description: 'When `true`, this page is not visible to merchant users who are signed in to the store control panel.' + description: 'When `true`, this page is not visible to retailer users who are signed in to the store control panel.' default: false url: type: string @@ -1396,7 +1396,7 @@ components: default: false is_customers_only: type: boolean - description: 'When `true`, this page is not visible to merchant users who are signed in to the store control panel.' + description: 'When `true`, this page is not visible to retailer users who are signed in to the store control panel.' default: false required: - name diff --git a/reference/pricing.sf.yml b/reference/pricing.sf.yml index d9ded49a7..0ccbf2a28 100644 --- a/reference/pricing.sf.yml +++ b/reference/pricing.sf.yml @@ -124,7 +124,7 @@ paths: properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. entered_inclusive: type: boolean description: Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. @@ -140,7 +140,7 @@ paths: properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. entered_inclusive: type: boolean description: Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. @@ -150,13 +150,13 @@ paths: tax_inclusive: type: number description: The estimated tax inclusive price for this product based on the provided customer group. - description: The merchant-entered sale price for a product overwrites the default price. The sale_price is optional. + description: The retailer-entered sale price for a product overwrites the default price. The sale_price is optional. minimum_advertised_price: type: object properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. entered_inclusive: type: boolean description: Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. @@ -166,13 +166,13 @@ paths: tax_inclusive: type: number description: The estimated tax inclusive price for this product based on the provided customer group. - description: The minimum advertised price (MAP) allowed to be shown on a storefront. A value supplied by the merchant and used for display purposes. + description: The minimum advertised price (MAP) allowed to be shown on a storefront. A value supplied by the retailer and used for display purposes. price: type: object properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. entered_inclusive: type: boolean description: Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. @@ -182,13 +182,13 @@ paths: tax_inclusive: type: number description: The estimated tax inclusive price for this product based on the provided customer group. - description: The merchant-entered price for a product could be including or excluding tax. Price must be defined when creating a product and serves as the default price. + description: The retailer-entered price for a product could be including or excluding tax. Price must be defined when creating a product and serves as the default price. calculated_price: type: object properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. entered_inclusive: type: boolean description: Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. @@ -207,7 +207,7 @@ paths: properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. entered_inclusive: type: boolean description: Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. @@ -223,7 +223,7 @@ paths: properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. entered_inclusive: type: boolean description: Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. @@ -243,7 +243,7 @@ paths: properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. entered_inclusive: type: boolean description: Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. @@ -259,7 +259,7 @@ paths: properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. entered_inclusive: type: boolean description: Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. @@ -372,7 +372,7 @@ components: properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. tax_inclusive: type: number description: The estimated tax inclusive price for this product based on the provided customer group. @@ -414,7 +414,7 @@ components: properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. entered_inclusive: type: boolean description: Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. @@ -430,7 +430,7 @@ components: properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. entered_inclusive: type: boolean description: Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. @@ -446,7 +446,7 @@ components: properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. entered_inclusive: type: boolean description: Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. @@ -462,7 +462,7 @@ components: properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. entered_inclusive: type: boolean description: Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. @@ -478,7 +478,7 @@ components: properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. entered_inclusive: type: boolean description: Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. @@ -497,7 +497,7 @@ components: properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. entered_inclusive: type: boolean description: Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. @@ -513,7 +513,7 @@ components: properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. entered_inclusive: type: boolean description: Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. @@ -533,7 +533,7 @@ components: properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. entered_inclusive: type: boolean description: Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. @@ -549,7 +549,7 @@ components: properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. entered_inclusive: type: boolean description: Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. @@ -574,14 +574,14 @@ components: description: The maximum quantity (or 0 for unlimited) to trigger this bulk pricing discount. discount_amount: type: number - description: The price reduction set by the merchant for this bulk pricing discount. + description: The price reduction set by the retailer for this bulk pricing discount. discount_type: type: string enum: - price - percent - fixed - description: The format of the price reduction set by the merchant for this bulk pricing discount. + description: The format of the price reduction set by the retailer for this bulk pricing discount. tax_discount_amount: type: array description: Formats the `bulk_pricing.discount_amount` into the tax price amounts. @@ -590,7 +590,7 @@ components: properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. tax_inclusive: type: number description: The estimated tax inclusive price for this product based on the provided customer group. @@ -614,7 +614,7 @@ components: properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. entered_inclusive: type: boolean description: Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. @@ -630,7 +630,7 @@ components: properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. entered_inclusive: type: boolean description: Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. @@ -648,7 +648,7 @@ components: properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. entered_inclusive: type: boolean description: Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. @@ -687,7 +687,7 @@ components: properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. entered_inclusive: type: boolean description: Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. @@ -703,7 +703,7 @@ components: properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. entered_inclusive: type: boolean description: Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. @@ -719,7 +719,7 @@ components: properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. entered_inclusive: type: boolean description: Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. @@ -735,7 +735,7 @@ components: properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. entered_inclusive: type: boolean description: Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. @@ -751,7 +751,7 @@ components: properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. entered_inclusive: type: boolean description: Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. @@ -770,7 +770,7 @@ components: properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. entered_inclusive: type: boolean description: Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. @@ -786,7 +786,7 @@ components: properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. entered_inclusive: type: boolean description: Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax. jurisdiction @@ -806,7 +806,7 @@ components: properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. entered_inclusive: type: boolean description: Whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. @@ -822,7 +822,7 @@ components: properties: as_entered: type: number - description: The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. + description: The price provided by the retailer as entered in their catalog/price list; may include or exclude tax. entered_inclusive: type: boolean description: Whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. diff --git a/reference/shipping_provider.yml b/reference/shipping_provider.yml index ef8b188c3..50f68b591 100644 --- a/reference/shipping_provider.yml +++ b/reference/shipping_provider.yml @@ -362,7 +362,7 @@ paths: /check_connection_options: post: description: |- - Validate connection options. BigCommerce sends a request to the shipping provider URL to check a merchantʼs connection credentials. The shipping provider sends a response indicating whether a merchant has valid credentials. + Validate connection options. BigCommerce sends a request to the shipping provider URL to check a retailerʼs connection credentials. The shipping provider sends a response indicating whether a retailer has valid credentials. > #### Note > * Substitute the host and path specific to the shipping provider for `your_app.example.com` and `check_connection_options`. @@ -706,12 +706,12 @@ components: x-internal: false ZoneOptionsInstance: type: object - description: Any zone-specific request options declared by the carrier and configured by the merchant to retrieve rates. Optional. + description: Any zone-specific request options declared by the carrier and configured by the retailer to retrieve rates. Optional. title: Zone Options Instance x-internal: false ConnectionOptionsInstance: type: object - description: Any global request options declared by the carrier and configured by the merchant to retrieve rates. Optional. + description: Any global request options declared by the carrier and configured by the retailer to retrieve rates. Optional. title: Connection Options Instance x-internal: false RateOptionsInstance: @@ -853,7 +853,7 @@ components: type: string maxLength: 50 discounted_cost: - description: Value object for a money amount. Optional field; merchants may request features. + description: Value object for a money amount. Optional field; retailers may request features. type: object properties: currency: @@ -869,7 +869,7 @@ components: dispatch_date: type: string format: date - description: Date at which carrier dispatches to the shipping destination. Optional field; merchants may request features. + description: Date at which carrier dispatches to the shipping destination. Optional field; retailers may request features. transit_time: type: object properties: @@ -973,7 +973,7 @@ components: type: string maxLength: 50 discounted_cost: - description: Value object for a money amount. Optional field; merchants may request features. + description: Value object for a money amount. Optional field; retailers may request features. type: object properties: currency: @@ -989,7 +989,7 @@ components: dispatch_date: type: string format: date - description: Date at which carrier dispatches to the shipping destination. Optional field; merchants may request features. + description: Date at which carrier dispatches to the shipping destination. Optional field; retailers may request features. transit_time: type: object properties: @@ -1254,7 +1254,7 @@ components: type: string maxLength: 50 discounted_cost: - description: Value object for a money amount. Optional field; merchants may request features. + description: Value object for a money amount. Optional field; retailers may request features. type: object properties: currency: @@ -1270,7 +1270,7 @@ components: dispatch_date: type: string format: date - description: Date at which carrier dispatches to the shipping destination. Optional field; merchants may request features. + description: Date at which carrier dispatches to the shipping destination. Optional field; retailers may request features. transit_time: type: object properties: diff --git a/reference/tax.v3.yml b/reference/tax.v3.yml index bd2c0e9e9..35b5fe5a1 100644 --- a/reference/tax.v3.yml +++ b/reference/tax.v3.yml @@ -2,7 +2,7 @@ openapi: '3.0.0' info: title: Tax Provider Connection version: '3' - description: 'Manage the connection between a merchantʼs BigCommerce store and a third party tax provider. For more information, see [Tax Provider API Overview](/api-docs/providers/tax).' + description: 'Manage the connection between a retailerʼs BigCommerce store and a third party tax provider. For more information, see [Tax Provider API Overview](/api-docs/providers/tax).' termsOfService: 'https://www.bigcommerce.com/terms' contact: name: BigCommerce @@ -91,7 +91,7 @@ paths: '422': description: 'Unprocessable Entity, will include a specific error message referencing the issue.' description: |- - Set authentication information associated with a merchant's account on the tax provider's infrastructure: + Set authentication information associated with a retailer's account on the tax provider's infrastructure: - [HTTP Basic Authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) (developer.mozilla.org) credentials - (optional) Tax provider profile used in customized endpoint urls for tax provider calls. This is only available for tax providers that support this feature. @@ -123,14 +123,14 @@ paths: profile: type: string example: your_app_name - description: Optional field that allows merchants to customize Tax Provider API endpoint URLs. Only available for supporting providers. + description: Optional field that allows retailers to customize Tax Provider API endpoint URLs. Only available for supporting providers. examples: Example: value: username: MyTaxProviderAccount password: h6eSgKLN72q7jYTW profile: test-profile - description: Basic authentication information, associated with a merchant account on the third-party tax providerʼs infrastructure. + description: Basic authentication information, associated with a retailer account on the third-party tax providerʼs infrastructure. parameters: - $ref: '#/components/parameters/Accept' - name: provider_id @@ -206,5 +206,5 @@ components: description: |- Describes whether the stored credentials are considered complete and configured, ready to be used for Tax Provider API requests. - Merchants may enable any **configured** tax provider for storefront tax quotation. + Retailers may enable any **configured** tax provider for storefront tax quotation. x-internal: false diff --git a/reference/tax_properties.v3.yml b/reference/tax_properties.v3.yml index a2bff3fd8..92ab3dca7 100644 --- a/reference/tax_properties.v3.yml +++ b/reference/tax_properties.v3.yml @@ -292,7 +292,7 @@ components: code: type: string description: The unique string programmatically references this unique tax - property by the tax provider. Merchants should liaise with their tax + property by the tax provider. Retailers should liaise with their tax provider to explore supported values and functions. example: A-123456789 display_name: @@ -303,7 +303,7 @@ components: description: type: string description: Optional. Additional detail about this tax property may help guide - merchants. This string will be displayed on the Products screen as a + retailers. This string will be displayed on the Products screen as a tooltip associated with the relevant field. example: Food Industry created_at: @@ -324,7 +324,7 @@ components: code: type: string description: The unique string programmatically references this unique tax - property by the tax provider. Merchants should liaise with their tax + property by the tax provider. Retailers should liaise with their tax provider to explore supported values and functions. example: A-123456789 display_name: @@ -334,7 +334,7 @@ components: example: Example Tax Property 1 description: type: string - description: Additional detail about this tax property may help guide merchants. + description: Additional detail about this tax property may help guide retailers. This string will be displayed on the Products screen as a tooltip associated with the relevant field. example: Food Industry @@ -351,7 +351,7 @@ components: code: type: string description: The unique string programmatically references this unique tax - property by the tax provider. Merchants should liaise with their tax + property by the tax provider. Retailers should liaise with their tax provider to explore supported values and functions. example: A-123456789 display_name: @@ -362,7 +362,7 @@ components: description: type: string description: Optional. Additional detail about this tax property may help guide - merchants. This string will be displayed on the Products screen as a + retailers. This string will be displayed on the Products screen as a tooltip associated with the relevant field. example: Food Industry required: diff --git a/reference/tax_provider.yml b/reference/tax_provider.yml index c56b07893..58578b449 100644 --- a/reference/tax_provider.yml +++ b/reference/tax_provider.yml @@ -29,7 +29,7 @@ paths: > - For supporting tax providers, the server URL contains the tax provider's profile field; for example, `your_profile.example.com`. > - The Try it feature is not currently supported for this endpoint. - The following actions can trigger tax estimate requests multiple times during a standard checkout on a BigCommerce storefront, depending on the BigCommerce merchant’s settings. + The following actions can trigger tax estimate requests multiple times during a standard checkout on a BigCommerce storefront, depending on the BigCommerce retailer’s settings. - After selecting a Shipping Method during the “Estimate Shipping & Tax” facility on the Cart page. - After specifying a Shipping Address during a Checkout. @@ -303,7 +303,7 @@ paths: '400': description: Fallback Tax will be used for this transaction. General response that points to an issue with the incoming request that means a valid response is unable to be returned. '401': - description: Response to indicate that the merchant’s authentication credentials are invalid. The merchant will receive an update in their Store Logs. + description: Response to indicate that the retailer’s authentication credentials are invalid. The retailer will receive an update in their Store Logs. '500': description: Fallback Tax will be used for this transaction. General response that points to an error on the tax provider side. These types of errors should be promptly resolved by the tax provider. /void: @@ -331,7 +331,7 @@ paths: '400': description: General response that points to an issue with the incoming request that means a valid response is unable to be returned. '401': - description: Response to indicate that the merchant’s authentication credentials are invalid. The merchant will receive an update in their Store Logs. + description: Response to indicate that the retailer’s authentication credentials are invalid. The retailer will receive an update in their Store Logs. '500': description: General response that points to an error on the tax provider side. These types of errors should be promptly resolved by the tax provider. tags: @@ -601,7 +601,7 @@ paths: '400': description: General response that points to an issue with the incoming request that means a valid response is unable to be returned. '401': - description: Response to indicate that the merchant’s authentication credentials are invalid. The merchant will receive an update in their Store Logs. + description: Response to indicate that the retailer’s authentication credentials are invalid. The retailer will receive an update in their Store Logs. '500': description: General response that points to an error on the tax provider side. These types of errors should be promptly resolved by the tax provider. tags: @@ -724,7 +724,7 @@ paths: '400': description: General response that points to an issue with the incoming request that means a valid response is unable to be returned. '401': - description: Response to indicate that the merchant’s authentication credentials are invalid. The merchant will receive an update in their Store Logs. + description: Response to indicate that the retailer’s authentication credentials are invalid. The retailer will receive an update in their Store Logs. '500': description: General response that points to an error on the tax provider side. These types of errors should be promptly resolved by the tax provider. content: @@ -897,7 +897,7 @@ components: description: A display name for this item. price: type: object - description: 'The final sale price (after discounts, bulk pricing, price lists, etc.) prior to having taxes calculated. If the merchant lists prices inclusive of tax, this price will already be tax inclusive, and so the tax provider will instead calculate the amount of tax that was already included in this price. For multiple quantities, this price includes that multiplication.' + description: 'The final sale price (after discounts, bulk pricing, price lists, etc.) prior to having taxes calculated. If the retailer lists prices inclusive of tax, this price will already be tax inclusive, and so the tax provider will instead calculate the amount of tax that was already included in this price. For multiple quantities, this price includes that multiplication.' required: - amount - tax_inclusive @@ -922,7 +922,7 @@ components: default: false tax_properties: type: array - description: Merchants may opt to include additional properties that a tax provider can choose to support, factoring these values into tax calculation. + description: Retailers may opt to include additional properties that a tax provider can choose to support, factoring these values into tax calculation. items: $ref: '#/components/schemas/request-item-tax-property' required: @@ -931,7 +931,7 @@ components: - quantity request-item-tax-property: type: object - description: A simple key value pairing allowing merchants to provide an additional input into a tax providerʼs tax calculation. + description: A simple key value pairing allowing retailers to provide an additional input into a tax providerʼs tax calculation. title: TaxProperty properties: code: @@ -1027,7 +1027,7 @@ components: description: ISO 4217 3 character currency code that all prices on this request are in. customer: type: object - description: 'If the shopper is a registered customer in the merchant’s store, basic details for that customer.' + description: 'If the shopper is a registered customer in the retailer’s store, basic details for that customer.' required: - customer_id - customer_group_id @@ -1118,13 +1118,13 @@ components: properties: code: type: string - description: 'The provider-specific tax code for this item. Items can be classified with tax codes relevant to each Tax Provider, configured by the merchant, and assigned to their products within BigCommerce. A tax code is intended to apply to multiple products. This code should match the tax codes provided by the third-party integration.' + description: 'The provider-specific tax code for this item. Items can be classified with tax codes relevant to each Tax Provider, configured by the retailer, and assigned to their products within BigCommerce. A tax code is intended to apply to multiple products. This code should match the tax codes provided by the third-party integration.' class_id: type: string - description: The ID of the tax class defined in the merchant’s BigCommerce store. May have a UUID value. + description: The ID of the tax class defined in the retailer’s BigCommerce store. May have a UUID value. name: type: string - description: The human-readable name of this tax class in the merchant’s BigCommerce store. + description: The human-readable name of this tax class in the retailer’s BigCommerce store. required: - code - class_id diff --git a/reference/tax_rates_zones.v3.yml b/reference/tax_rates_zones.v3.yml index dbd18f6c0..c9ebffcf5 100644 --- a/reference/tax_rates_zones.v3.yml +++ b/reference/tax_rates_zones.v3.yml @@ -435,7 +435,7 @@ components: description: 'Tax Zone ID. Internal identifier used to get, update, or delete a specific tax zone.' name: type: string - description: The human-readable name for this tax zone. The name displays on the merchant's control panel. + description: The human-readable name for this tax zone. The name displays on the retailer's control panel. example: Australia enabled: type: boolean @@ -496,7 +496,7 @@ components: description: 'Tax Zone ID. Internal identifier used to get, update, or delete a specific tax zone.' name: type: string - description: The human-readable name for this tax zone. The name displays on the merchant's control panel. + description: The human-readable name for this tax zone. The name displays on the retailer's control panel. example: Australia enabled: type: boolean @@ -556,7 +556,7 @@ components: properties: name: type: string - description: The human-readable name for this tax zone. The name displays on the merchant's control panel. + description: The human-readable name for this tax zone. The name displays on the retailer's control panel. example: Australia enabled: type: boolean @@ -644,7 +644,7 @@ components: example: 3 name: type: string - description: 'The human-readable name for this tax zone. The name displays on the merchant control panel and to shoppers, depending on store tax settings.' + description: 'The human-readable name for this tax zone. The name displays on the retailer control panel and to shoppers, depending on store tax settings.' example: Sales Tax priority: type: integer @@ -682,7 +682,7 @@ components: example: 3 name: type: string - description: 'The human-readable name for this tax zone. The name displays on the merchant control panel and to shoppers, depending on store tax settings.' + description: 'The human-readable name for this tax zone. The name displays on the retailer control panel and to shoppers, depending on store tax settings.' example: Sales Tax priority: type: integer @@ -720,7 +720,7 @@ components: default: true name: type: string - description: 'The human-readable name for this tax zone. The name displays on the merchant control panel and to shoppers, depending on store tax settings.' + description: 'The human-readable name for this tax zone. The name displays on the retailer control panel and to shoppers, depending on store tax settings.' example: Sales Tax priority: type: integer diff --git a/reference/tax_settings.v3.yml b/reference/tax_settings.v3.yml index a5c30a07d..90bca2fe4 100644 --- a/reference/tax_settings.v3.yml +++ b/reference/tax_settings.v3.yml @@ -137,7 +137,7 @@ components: - EXCLUSIVE fallback_strategy: type: string - description: 'Describes the fallback behavior that applies when a tax provider produces an error. A merchant may decide to use a flat 10% fallback tax rate, their basic tax settings, or to block the transaction until they achieve a successful result.' + description: 'Describes the fallback behavior that applies when a tax provider produces an error. A retailer may decide to use a flat 10% fallback tax rate, their basic tax settings, or to block the transaction until they achieve a successful result.' default: FIXED enum: - FIXED @@ -146,7 +146,7 @@ components: should_subtract_store_tax: default: true type: boolean - description: This setting applies only if a merchant enters tax-inclusive prices. When enabled, the store subtracts the itemʼs store tax rate before calculating tax using the shopperʼs tax zone. The tax-exclusive amount will be the same across all tax zones. When disabled, the tax-inclusive price remains the same across all tax zones; only the tax amount will vary based on the shopperʼs location. The tax-exclusive amount may vary among tax zones. These calculations are relevant for tax pricing and tax quotations that use basic tax. + description: This setting applies only if a retailer enters tax-inclusive prices. When enabled, the store subtracts the itemʼs store tax rate before calculating tax using the shopperʼs tax zone. The tax-exclusive amount will be the same across all tax zones. When disabled, the tax-inclusive price remains the same across all tax zones; only the tax amount will vary based on the shopperʼs location. The tax-exclusive amount may vary among tax zones. These calculations are relevant for tax pricing and tax quotations that use basic tax. Tax_Settings_Req: type: object properties: @@ -169,7 +169,7 @@ components: - EXCLUSIVE fallback_strategy: type: string - description: 'Decribes the fallback behaviour that applies when a tax provider produces an error. A merchant may decide to use a flat 10% fallback tax rate, their basic tax settings, or to block the transaction until a successful result can be achieved.' + description: 'Decribes the fallback behaviour that applies when a tax provider produces an error. A retailer may decide to use a flat 10% fallback tax rate, their basic tax settings, or to block the transaction until a successful result can be achieved.' enum: - FIXED - BASIC @@ -177,7 +177,7 @@ components: should_subtract_store_tax: default: true type: boolean - description: This setting applies only if a merchant enters tax-inclusive prices. When enabled, the store subtracts the itemʼs store tax rate before calculating tax using the shopperʼs tax zone. The tax-exclusive amount will be the same across all tax zones. When disabled, the tax-inclusive price remains the same across all tax zones; only the tax amount will vary based on the shopperʼs location. The tax-exclusive amount may vary among tax zones. These calculations are relevant for tax pricing and tax quotations that use basic tax. + description: This setting applies only if a retailer enters tax-inclusive prices. When enabled, the store subtracts the itemʼs store tax rate before calculating tax using the shopperʼs tax zone. The tax-exclusive amount will be the same across all tax zones. When disabled, the tax-inclusive price remains the same across all tax zones; only the tax amount will vary based on the shopperʼs location. The tax-exclusive amount may vary among tax zones. These calculations are relevant for tax pricing and tax quotations that use basic tax. MetaOpen: title: Response meta type: object diff --git a/reference/widgets.v3.yml b/reference/widgets.v3.yml index 5e2ea9db2..a076dbf30 100644 --- a/reference/widgets.v3.yml +++ b/reference/widgets.v3.yml @@ -1932,7 +1932,7 @@ components: x-internal: false widgetSchema: type: array - description: 'The schema for the widget’s merchant-facing UI. For more information on the available schema settings, see [Widget UI Schema](/stencil-docs/page-builder/widget-ui-schema). ' + description: 'The schema for the widget’s retailer-facing UI. For more information on the available schema settings, see [Widget UI Schema](/stencil-docs/page-builder/widget-ui-schema). ' title: '' items: anyOf: