Skip to content
This repository has been archived by the owner on Jan 15, 2024. It is now read-only.

(no ticket): [update] Many, change merchant to retailer #1495

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion models/email_templates/_all.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions models/email_templates/data/order_message_notification.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down Expand Up @@ -40,4 +40,4 @@
"go_shopping": "Go shopping"
}
}
}
}
4 changes: 2 additions & 2 deletions models/email_templates/order_message_notification.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down Expand Up @@ -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
Expand Down
34 changes: 17 additions & 17 deletions reference/abandoned_carts.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion reference/catalog/product-modifiers_catalog.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
8 changes: 4 additions & 4 deletions reference/catalog/products_catalog.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down Expand Up @@ -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!

Expand Down Expand Up @@ -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: |
Expand Down
8 changes: 4 additions & 4 deletions reference/channels.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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.
Expand Down
12 changes: 6 additions & 6 deletions reference/checkouts.sf.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion reference/consent.sf.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading
Loading