diff --git a/docs/start/authentication/api-accounts.mdx b/docs/start/authentication/api-accounts.mdx index 5e8bdb56e..2c3f594c0 100644 --- a/docs/start/authentication/api-accounts.mdx +++ b/docs/start/authentication/api-accounts.mdx @@ -204,8 +204,8 @@ All OAuth scopes except `default` provide `read-only` permissions scopes so that | Checkouts | read-only | `store_checkout_read_only` | View checkout content | [Checkouts V3](/docs/rest-storefront/checkouts) | | Checkout Content | modify | `store_content_checkout` | View and modify content on checkout pages | [Scripts V3](/docs/rest-management/scripts#create-a-script) | | Checkout Content | read-only | `store_content_checkout_read_only` | View content on checkout pages | [Scripts V3](/docs/rest-management/scripts#create-a-script) | -| Content | modify | `store_v2_content` | View and modify store content | [Pages V2](/docs/rest-content/store-content/pages#get-all-pages)
[Blog V2](/docs/rest-content/store-content/blog-posts#get-all-blog-posts)
[Redirects V2](/docs/rest-content/store-content/redirects#get-all-redirects)
[Widgets V3](/docs/rest-content/widgets) | -| Content | read-only | `store_v2_content_read_only` | View store content | [Pages V2](/docs/rest-content/store-content/pages#get-all-pages)
[Blog V2](/docs/rest-content/store-content/blog-posts#get-all-blog-posts)
[Redirects V2](/docs/rest-content/store-content/redirects#get-all-redirects)
[Widgets V3](/docs/rest-content/widgets) | +| Content | modify | `store_v2_content` | View and modify store content | [Pages V2 (Deprecated)](/docs/rest-content/store-content/pages#get-all-pages)
[Blog V2](/docs/rest-content/store-content/blog-posts#get-all-blog-posts)
[Widgets V3](/docs/rest-content/widgets) | +| Content | read-only | `store_v2_content_read_only` | View store content | [Pages V2 (Deprecated)](/docs/rest-content/store-content/pages#get-all-pages)
[Blog V2](/docs/rest-content/store-content/blog-posts#get-all-blog-posts)
[Widgets V3](/docs/rest-content/widgets) | | Customers | modify | `store_v2_customers` | View and modify customer information | [Customers V2](/docs/rest-management/customers-v2#get-all-customers)
[Customer Groups V2](/docs/rest-management/customers-v2/customer-groups#get-all-customer-groups)
[Subscribers V3](/docs/rest-management/subscribers#get-subscribers)
[Wishlists V3](/docs/rest-management/wishlists#get-all-wishlists) | | Customers | read-only | `store_v2_customers_read_only` | View customer information | [Customers V2](/docs/rest-management/customers-v2#get-all-customers)
[Customer Groups V2](/docs/rest-management/customers-v2/customer-groups#get-all-customer-groups)
[Subscribers V3](/docs/rest-management/subscribers#get-subscribers)
[Wishlists V3](/docs/rest-management/wishlists#get-all-wishlists) | | Customers Login | modify | `store_v2_customers_login` | Sign customers in to your storefront | [Customer Login API](/docs/start/authentication/customer-login) | diff --git a/reference/store_content.v2.yml b/reference/store_content.v2.yml index faea85401..0799d6c59 100644 --- a/reference/store_content.v2.yml +++ b/reference/store_content.v2.yml @@ -6,7 +6,6 @@ info: > #### Warning > **Deprecations** - > * Redirects V2 are deprecated; use [Redirects V3](/docs/rest-management/redirects) instead. > * Pages V2 are deprecated; use [Pages V3](/docs/rest-content/pages) instead. version: '' termsOfService: 'https://www.bigcommerce.com/terms' @@ -27,7 +26,6 @@ tags: - name: Blog Posts - name: Blog Tags - name: Pages - - name: Redirects paths: '/blog/tags': parameters: @@ -658,266 +656,7 @@ paths: '204': description: '' content: {} - '/redirects': - parameters: - - $ref: '#/components/parameters/Accept' - get: - deprecated: true - tags: - - Redirects - summary: Get All Redirects - description: |- - Returns a list all *Redirect URLs*. - - > #### Warning - > **Deprecated** - > * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version. - > * To get redirect URLs, use Redirects V3ʼs [Get redirects](/docs/rest-management/redirects#get-redirects) endpoint. - operationId: getRedirects - parameters: - - name: page - in: query - description: Filter param. - schema: - exclusiveMaximum: false - exclusiveMinimum: false - type: integer - - name: limit - in: query - description: Filter param. - schema: - exclusiveMaximum: false - exclusiveMinimum: false - type: integer - responses: - '200': - description: '' - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/redirect' - Response Schema: - example: '' - post: - tags: - - Redirects - summary: Create a Redirect - description: |- - Creates a *Redirect URL*. - - **Required Fields** - * path - * forward - - **Read Only** - * url - - - > #### Warning - > **Deprecated** - > * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version. - > * To upsert new redirect data, use Redirects V3ʼs [Upsert redirects](/docs/rest-management/redirects#upsert-redirects) endpoint. - operationId: createRedirect - parameters: - - $ref: '#/components/parameters/ContentType' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/redirect' - required: true - responses: - '200': - description: '' - content: - application/json: - schema: - $ref: '#/components/schemas/redirect' - example: - id: 3 - path: /mens_clothing - forward: - type: category - ref: 3 - url: 'http://store.example.com/mens' - delete: - deprecated: true - tags: - - Redirects - summary: Delete All Redirects - description: |- - By default, it deletes all *Redirect URLs* in a store. - - - > #### Warning - > **Deprecated** - > * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version. - > * To delete redirect URLs, use Redirects V3ʼs [Delete redirects](/docs/rest-management/redirects#delete-redirects) endpoint. - operationId: deleteRedirects - responses: - '204': - description: '' - content: {} - '/redirects/{id}': - parameters: - - $ref: '#/components/parameters/Accept' - - name: id - in: path - description: ID of the redirect URL. - required: true - schema: - exclusiveMaximum: false - exclusiveMinimum: false - type: integer - get: - deprecated: true - tags: - - Redirects - summary: Get a Redirect - description: |- - Returns a single *Redirect URL*. - - > #### Warning - > **Deprecated** - > * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version. - > * To get a redirect URL, use Redirects V3ʼs [Get redirects](/docs/rest-management/redirects#get-redirects) endpoint. - operationId: getRedirect - responses: - '200': - description: '' - content: - application/json: - schema: - $ref: '#/components/schemas/redirect' - example: - id: 1 - path: /smith-journal-13/ - forward: - type: product - ref: 111 - url: 'http://store-store_hash.mybigcommerce.com/towels/bath-towels/hand-towels/' - put: - tags: - - Redirects - summary: Update a Redirect - description: |- - Updates a *Redirect URL*. - - **Required Fields** - * path - * forward - - **Read Only Fields** - * url - - > #### Warning - > **Deprecated** - > * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version. - > * To update redirect data, use Redirects V3ʼs [Upsert redirects](/docs/rest-management/redirects#upsert-redirects) endpoint. - operationId: updateRedirect - parameters: - - $ref: '#/components/parameters/ContentType' - requestBody: - content: - application/json: - schema: - title: Redirect - required: - - forward - - path - type: object - properties: - id: - type: integer - description: Numeric ID of the redirect. - example: 1 - path: - type: string - description: The path from which to redirect. - example: /smith-journal-13/ - forward: - type: object - properties: - type: - type: string - description: | - The type of redirect. If it is a manual redirect then type will always be manual. Dynamic redirects will have the type of the page. Such as product or category. - example: product - ref: - type: string - description: Reference of the redirect. Dynamic redirects will have the category or product number. Manual redirects will have the url that is being directed to. - example: '111' - url: - type: string - description: URL of the redirect. READ-ONLY. - readOnly: true - example: 'http://store-store_hash.mybigcommerce.com/towels/bath-towels/hand-towels/' - example: - id: 1 - path: /smith-journal-13/ - forward: - type: product - ref: '111' - url: 'http://store-store_hash.mybigcommerce.com/towels/bath-towels/hand-towels/' - required: true - responses: - '200': - description: '' - content: - application/json: - schema: - $ref: '#/components/schemas/redirect' - example: - id: 1 - path: /smith-journal-13/ - forward: - type: product - ref: 111 - url: 'http://store-store_hash.mybigcommerce.com/towels/bath-towels/hand-towels/' - delete: - tags: - - Redirects - summary: Delete a Redirect - description: |- - Deletes a *Redirect URL*. - - > #### Warning - > **Deprecated** - > * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version. - > * To delete a redirect URL, use Redirects V3ʼs [Delete redirects](/docs/rest-management/redirects#delete-redirects) endpoint. - operationId: deleteRedirect - responses: - '204': - description: '' - content: {} - '/redirects/count': - parameters: - - $ref: '#/components/parameters/Accept' - get: - deprecated: true - tags: - - Redirects - summary: Get a Count of Redirects - description: |- - Gets a count of *Redirect URLs* in a store. - - > #### Warning - > **Deprecated** - > * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version. - > * To get a count of redirects, use the `meta` object data returned with the Redirects V3ʼs [Get redirects](/docs/rest-management/redirects#get-redirects) endpoint. - operationId: getRedirectsCount - responses: - '200': - description: '' - content: - application/json: - schema: - $ref: '#/components/schemas/count_Response' - example: - count: 27 components: parameters: Accept: @@ -968,32 +707,6 @@ components: meta_keywords: 'BigCommerce, welcome, ecommerce' author: BigCommerce thumbnail_path: string - addresses: - title: addresses - type: object - properties: - url: - type: string - description: Full URL of where the resource is located. - example: 'https://api.bigcommerce.com/stores/{store_hash}/v2/customers/5/addresses' - resource: - type: string - description: Resource being accessed. - example: /customers/5/addresses - x-internal: false - formField: - title: formField - type: object - properties: - name: - type: string - description: Name of the form field - example: License Id - value: - type: string - description: Value of the form field - example: 123BAF - x-internal: false page_Full: title: page_Full allOf: @@ -1006,184 +719,6 @@ components: readOnly: true - $ref: '#/components/schemas/page_Base_Res' x-internal: false - redirect: - title: redirect - required: - - forward - - path - type: object - properties: - id: - type: integer - description: Numeric ID of the redirect. - example: 1 - path: - type: string - description: The path from which to redirect. - example: /smith-journal-13/ - forward: - $ref: '#/components/schemas/forward' - url: - type: string - description: URL of the redirect. READ-ONLY. - readOnly: true - example: 'http://store-store_hash.mybigcommerce.com/towels/bath-towels/hand-towels/' - example: - id: 1 - path: /smith-journal-13/ - forward: - type: product - ref: 111 - url: 'http://store-store_hash.mybigcommerce.com/towels/bath-towels/hand-towels/' - x-internal: false - forward: - title: forward - type: object - x-internal: false - properties: - type: - type: string - description: The type of redirect. If it is a `manual` redirect then type will always be manual. Dynamic redirects will have the type of the page. Such as product or category. - example: product - ref: - type: integer - description: Reference of the redirect. Dynamic redirects will have the category or product number. Manual redirects will have the url that is being directed to. - example: 111 - customer_Full: - title: customer_Full - required: - - email - - first_name - - last_name - type: object - properties: - id: - type: integer - description: Unique numeric ID of this customer. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request. - readOnly: true - example: 1 - _authentication: - type: object - properties: - force_reset: - type: string - password: - type: string - password_confirmation: - type: string - description: 'Not returned in any responses, but accepts up to two fields allowing you to set the customer’s password. If a password is not supplied, it is generated automatically. For further information about using this object, please see the Customers resource documentation.' - company: - type: string - description: The name of the company for which the customer works. - example: BigCommerce - first_name: - type: string - description: First name of the customer. - example: Jane - last_name: - type: string - description: Last name of the customer. - example: Doe - email: - type: string - description: Email address of the customer. - example: janedoe@example.com - phone: - type: string - description: Phone number of the customer. - example: '1234567890' - date_created: - type: string - description: Date on which the customer registered from the storefront or was created in the control panel. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request. - readOnly: true - format: date-time - date_modified: - type: string - description: | - Date on which the customer updated their details in the storefront or was updated in the control panel. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request. - readOnly: true - format: date-time - store_credit: - type: string - description: 'The amount of credit the customer has. (Float, Float as String, Integer)' - example: '0' - registration_ip_address: - type: string - description: The customer’s IP address when they signed up. - example: 12.345.678.910 - customer_group_id: - type: integer - description: The group to which the customer belongs. - example: 2 - notes: - type: string - description: Store-owner notes on the customer. - tax_exempt_category: - type: string - description: If applicable, the tax-exempt category of the shopperʼs customer account. You can apply a tax-exempt category to multiple customers. This code should match the exemption codes provided by the third-party integration. - accepts_marketing: - type: boolean - description: | - Records whether the customer would like to receive marketing content from this store. READ-ONLY.This is a READ-ONLY field; do not set or modify its value in a POST or PUT request. - readOnly: true - example: true - addresses: - $ref: '#/components/schemas/addresses' - form_fields: - type: array - description: Array of custom fields. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request. - readOnly: true - items: - $ref: '#/components/schemas/formField' - reset_pass_on_login: - type: boolean - description: Force a password change on next login. - example: false - x-internal: false - categoryAccessLevel: - title: categoryAccessLevel - type: object - properties: - type: - type: string - description: |- - + `all` - Customers can access all categories - + `specific` - Customers can access a specific list of categories - + `none` - Customers are prevented from viewing any of the categories in this group. - enum: - - all - - specific - - none - categories: - description: A comma-separated list of category IDs. Should be supplied only if `type` is `specific`. - type: array - items: - type: integer - x-internal: false - timeZone: - title: timeZone - type: object - properties: - name: - type: string - description: | - A string identifying the time zone, in the format: `/`. - example: America/Chicago - raw_offset: - type: integer - description: 'A negative or positive number, identifying the offset from UTC/GMT, in seconds, during winter/standard time.' - example: -21600 - dst_offset: - type: integer - description: 'A negative or positive number, identifying the offset from UTC/GMT, in seconds, during summer/daylight saving time.' - example: -18000 - dst_correction: - type: boolean - description: A boolean indicating whether this time zone observes daylight saving time. - example: true - date_format: - $ref: '#/components/schemas/dateFormat' - x-internal: false count_Response: title: count_Response type: object @@ -1195,23 +730,6 @@ components: example: count: 27 x-internal: false - dateFormat: - title: dateFormat - type: object - properties: - display: - type: string - description: 'A string that defines dates’ display formats, in the pattern: M jS Y' - example: M jS Y - export: - type: string - description: 'A string that defines the CSV export format for orders, customers, and products, in the pattern: M jS Y' - example: M jS Y - extended_display: - type: string - description: 'A string that defines dates’ extended-display format, in the pattern: M jS Y @ g:i A.' - example: 'M jS Y @ g:i A' - x-internal: false blogTags: title: blogTags type: array @@ -1293,84 +811,6 @@ components: required: - title - body - blogPost_Base: - title: blogPost_Base - type: object - example: - title: Welcome to BigCommerce - url: /blog/welcome-bigcommerce/ - preview_url: /blog/welcome-bigcommerce/ - body: '

Customize your site, manage shipping and payments, and list your products on Amazon, eBay, and Facebook by Meta with the #1 ecommerce platform.

' - tags: - - string - summary:

We power ecommerce websites for successful retailers all over the world

- is_published: true - published_date: - timezone_type: 1 - date: '2018-05-18T08:26:42Z' - timezone: '+00:00' - published_date_iso8601: '5/18/2018 1:26:42 PM' - meta_description: Welcome Post - meta_keywords: 'BigCommerce, welcome, ecommerce' - author: BigCommerce - thumbnail_path: string - properties: - title: - type: string - description: Title of this blog post. - example: Welcome to BigCommerce - url: - type: string - description: URL for the public blog post. - example: /blog/welcome-bigcommerce/ - preview_url: - type: string - description: URL to preview the blog post. READ-ONLY. - readOnly: true - example: /blog/welcome-bigcommerce/ - body: - type: string - description: Text body of the blog post. - example: '

Customize your site, manage shipping and payments, and list your products on Amazon, eBay, and Facebook by Meta with the #1 ecommerce platform.

' - tags: - type: array - description: Tags to characterize the blog post. - items: - type: string - summary: - type: string - description: Summary of the blog post. READ-ONLY. - readOnly: true - example:

We power ecommerce websites for successful retailers all over the world

- is_published: - type: boolean - description: Whether the blog post is published. If you want the post to be or remain published following the request, you must set the field explicitly to true, even if the blog post was already published prior to the request. - default: false - example: true - published_date: - $ref: '#/components/schemas/publishedDate' - published_date_iso8601: - type: string - description: Published date in `ISO 8601` format. - example: '5/18/2023 1:26:42 PM' - meta_description: - type: string - description: Description text for this blog post’s `` element. - example: Welcome Post - meta_keywords: - type: string - description: Keywords for this blog post’s `` element. - example: 'BigCommerce, welcome, ecommerce' - author: - type: string - description: Name of the blog post’s author. - example: BigCommerce - thumbnail_path: - type: string - description: 'Local path to a thumbnail uploaded to `/product_images/` using [WebDAV](https://support.bigcommerce.com/s/article/File-Access-WebDAV).' - required: - - title - - body blogPost_Base_Res: title: blogPost_Base_Res type: object @@ -1448,17 +888,6 @@ components: timezone: type: string example: '+00:00' - authentication: - type: object - properties: - force_reset: - type: string - password: - type: string - password_confirmation: - type: string - description: 'Not returned in any responses, but accepts up to two fields allowing you to set the customer’s password. If a password is not supplied, it is generated automatically. For further information about using this object, please see the Customers resource documentation.' - x-internal: false page_Base: title: page_Base type: object