From 24ec97492bf1e90e5f66946ee5392399f48fb05d Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Thu, 25 Jan 2024 11:14:22 -0600 Subject: [PATCH 01/41] brands metafields --- reference/catalog/brands_catalog.v3.yml | 621 +++++++++++++++++++++++- 1 file changed, 614 insertions(+), 7 deletions(-) diff --git a/reference/catalog/brands_catalog.v3.yml b/reference/catalog/brands_catalog.v3.yml index d903aeb96..4a1bf4d9f 100644 --- a/reference/catalog/brands_catalog.v3.yml +++ b/reference/catalog/brands_catalog.v3.yml @@ -1587,6 +1587,122 @@ paths: parameters: - $ref: '#/components/parameters/Accept' - $ref: '#/components/parameters/BrandIdParam' + '/catalog/brands/metafields': + get: + summary: Get All Metafields + tags: + - Metafields + description: Get all brand metafields. + operationId: getAllBrandMetafields + responses: + '200': + description: | + List of `Metafield` objects. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '500': + description: Internal Server Error + parameters: + - $ref: '#/components/parameters/PageParam' + - $ref: '#/components/parameters/LimitParam' + - $ref: '#/components/parameters/MetafieldKeyParam' + - $ref: '#/components/parameters/MetafieldKeyInParam' + - $ref: '#/components/parameters/MetafieldNamespaceParam' + - $ref: '#/components/parameters/MetafieldNamespaceInParam' + - $ref: '#/components/parameters/DirectionParam' + post: + summary: Create multiple Metafields + tags: + - Metafields + description: Create multiple metafields. + operationId: createBrandMetafields + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MetafieldPost' + description: '' + responses: + '200': + description: | + List of created `Metafield` objects. # TODO + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' + '422': + description: | + Response object for metafields creation with partial success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '500': + description: Internal Server Error + put: + summary: Update multiple Metafields + tags: + - Metafields + description: Create multiple metafields. + operationId: updateBrandMetafields + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MetafieldPut' + description: '' + responses: + '200': + description: | + List of updated `Metafield` objects. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '422': + description: | + Response object for metafields creation with partial success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '500': + description: Internal Server Error + delete: + summary: Delete All Metafields + tags: + - Metafields + description: Delete all brand metafields. + operationId: deleteBrandMetafields + requestBody: + content: + application/json: + schema: + type: array + items: + type: integer + description: "Metafield's id list" + responses: + '200': + description: | + Response object for metafields deletion with success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionDeleteResponseSuccess' + '422': + description: | + Response object for metafields deletion with partial success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' components: schemas: brand_Full: @@ -1868,13 +1984,434 @@ components: format: date-time example: '2018-05-07T20:14:17+00:00' x-internal: false - responses: - General207Status: - description: 'Multi-status. Multiple operations have taken place and the status for each operation can be viewed in the body of the response. Typically indicates that a partial failure has occured, such as when a `POST` or `PUT` request is successful, but saving the URL or inventory data has failed.' - content: - application/json: - schema: - $ref: '#/components/schemas/error_Base' + Metafield: + type: object + description: | + Common Metafield properties. + x-internal: false + properties: + permission_set: + type: string + description: | + Determines the visibility and writeability of the field by other API consumers. + | Value | Description | + | :--- | :--- | + | `app_only` | Private to the app that owns the field. | + | `read` | Visible to other API consumers. | + | `write` | Open for reading and writing by other API consumers. | + | `read_and_sf_access` | Visible to other API consumers, including on storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + enum: + - app_only + - read + - write + - read_and_sf_access + - write_and_sf_access + namespace: + type: string + description: | + Namespace for the metafield, for organizational purposes. + example: Sales Department + minLength: 1 + maxLength: 64 + key: + type: string + description: | + The name of the field, for example: `location_id`, `color`. + minLength: 1 + maxLength: 64 + example: Staff Name + value: + type: string + description: | + The value of the field, for example: `1`, `blue`. + minLength: 1 + maxLength: 65535 + example: Ronaldo + description: + type: string + description: | + Description for the metafields. + example: order + minLength: 0 + maxLength: 255 + resource_type: + type: string + description: | + The type of resource with which the metafield is associated. + enum: + - brand + - product + - variant + - category + - cart + - channel + - location + - order + - customer + example: cart + resource_id: + type: integer + description: | + The unique identifier for the resource with which the metafield is associated. + example: 424242 + readOnly: true + id: + type: integer + description: The unique identifier for the metafield. + date_created: + type: string + format: date-time + description: Date and time of the metafieldʼs creation. + example: '2022-06-16T18:39:00+00:00' + date_modified: + type: string + format: date-time + description: Date and time when the metafield was last updated. + example: '2022-06-16T18:39:00+00:00' + required: + - namespace + - key + - value + - permission_set + - resource_type + - resource_id + - description + - id + - date_created + - date_modified + MetaFieldCollectionResponse: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + $ref: '#/components/schemas/Metafield' + meta: + $ref: '#/components/schemas/CollectionMeta' + x-internal: false + MetaFieldCollectionDeleteResponsePartialSuccess: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + type: integer + description: | + The unique identifier for the metafield. + example: [ + 123 + ] + errors: + type: array + items: + $ref: '#/components/schemas/Error' + meta: + $ref: '#/components/schemas/WriteCollectionPartialSuccessMeta' + x-internal: false + MetaFieldCollectionDeleteResponseSuccess: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + type: integer + description: | + The unique identifier for the metafield. + example: [ + 123, + 124, + 125 + ] + errors: + type: array + items: + $ref: '#/components/schemas/Error' + example: [] + meta: + $ref: '#/components/schemas/WriteCollectionSuccessMeta' + x-internal: false + WriteCollectionPartialSuccessMeta: + type: object + description: 'Additional data about the response.' + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 3 + success: + type: integer + description: | + Total number of items that were successfully deleted. + example: 1 + failed: + type: integer + description: | + Total number of items that failed to be deleted. + example: 2 + title: Collection Meta + x-internal: false + WriteCollectionSuccessMeta: + type: object + description: 'Additional data about the response.' + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 3 + success: + type: integer + description: | + Total number of items that were successfully deleted. + example: 3 + failed: + type: integer + description: | + Total number of items that failed to be deleted. + example: 0 + title: Collection Meta + x-internal: false + Total: + type: integer + description: | + Total number of items in the result set. + example: 3 + Error: + type: object + description: | + Error response payload for the BigCommerce API. + properties: + status: + type: integer + description: | + The HTTP status code for the error. + example: 422 + title: + type: string + description: | + The error title. + example: Bulk operation has failed + type: + type: string + description: | + The error type. + example: https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes + errors: + $ref: '#/components/schemas/ErrorDetail' + ErrorDetail: + type: object + description: | + Error detail response payload for the BigCommerce API. + example: + { + "1": "Unauthorized to delete", + "2": "Metafield does not exist" + } + CollectionMeta: + type: object + description: 'Data about the response, including pagination and collection totals.' + properties: + pagination: + type: object + description: 'Data about the response, including pagination and collection totals.' + title: Pagination + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 36 + count: + type: integer + description: | + Total number of items in the collection response. + example: 36 + per_page: + type: integer + description: | + The amount of items returned in the collection per page, controlled by the limit parameter. + example: 50 + current_page: + type: integer + description: | + The page you are currently on within the collection. + example: 1 + total_pages: + type: integer + description: | + The total number of pages in the collection. + example: 1 + links: + type: object + description: | + Pagination links for the previous and next parts of the whole collection. + properties: + previous: + type: string + description: | + Link to the previous page returned in the response. + current: + type: string + description: | + Link to the current page returned in the response. + example: '?page=1&limit=50' + next: + type: string + description: | + Link to the next page returned in the response. + additionalProperties: true + title: Collection Meta + x-internal: false + MetafieldBase_Post: + type: object + description: | + Common Metafield properties. + x-internal: false + properties: + permission_set: + type: string + description: | + Determines the visibility and writeability of the field by other API consumers. + | Value | Description | + | :--- | :--- | + | `app_only` | Private to the app that owns the field. | + | `read` | Visible to other API consumers. | + | `write` | Open for reading and writing by other API consumers. | + | `read_and_sf_access` | Visible to other API consumers, including on storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + enum: + - app_only + - read + - write + - read_and_sf_access + - write_and_sf_access + namespace: + type: string + description: | + Namespace for the metafield, for organizational purposes. + example: Sales Department + minLength: 1 + maxLength: 64 + key: + type: string + description: | + The name of the field, for example: `location_id`, `color`. + minLength: 1 + maxLength: 64 + example: Staff Name + value: + type: string + description: | + The value of the field, for example: `1`, `blue`. + minLength: 1 + maxLength: 65535 + example: Ronaldo + description: + type: string + description: | + Description for the metafields. + minLength: 0 + maxLength: 255 + example: Name of Staff Member + required: + - permission_set + - namespace + - key + - value + MetafieldPost: + description: | + The model for a POST to create metafield. + allOf: + - $ref: '#/components/schemas/MetafieldBase_Post' + - type: object + properties: + resource_id: + type: integer + example: 42 + description: | + The ID for the resource with which the metafield is associated. + required: + - resource_id + x-internal: false + MetafieldBase_Put: + type: object + description: | + Common Metafield properties. + x-internal: false + properties: + permission_set: + type: string + description: | + Determines the visibility and writeability of the field by other API consumers. + | Value | Description | + | :--- | :--- | + | `app_only` | Private to the app that owns the field. | + | `read` | Visible to other API consumers. | + | `write` | Open for reading and writing by other API consumers. | + | `read_and_sf_access` | Visible to other API consumers, including on storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + enum: + - app_only + - read + - write + - read_and_sf_access + - write_and_sf_access + namespace: + type: string + description: | + Namespace for the metafield, for organizational purposes. + example: Sales Department + minLength: 1 + maxLength: 64 + key: + type: string + description: | + The name of the field, for example: `location_id`, `color`. + minLength: 1 + maxLength: 64 + example: Staff Name + value: + type: string + description: | + The value of the field, for example: `1`, `blue`. + minLength: 1 + maxLength: 65535 + example: Ronaldo + description: + type: string + description: | + Description for the metafields. + minLength: 0 + maxLength: 255 + example: Name of Staff Member + MetafieldPut: + description: | + The model for a PUT to create metafield. + allOf: + - $ref: '#/components/schemas/MetafieldBase_Put' + - type: object + properties: + id: + type: integer + example: 42 + description: | + The ID of metafield to update. + resource_id: + type: integer + example: 42 + description: | + The ID for the resource with which the metafield is associated. + required: + - id + x-internal: false parameters: BrandIdParam: name: brand_id @@ -1908,6 +2445,76 @@ components: schema: type: string default: 'application/json' + PageParam: + name: page + description: | + Specifies the page number in a limited (paginated) list of products. + required: false + in: query + schema: + type: integer + MetafieldKeyParam: + name: key + in: query + description: Filter based on a metafieldʼs key. + required: false + schema: + type: string + MetafieldKeyInParam: + name: key:in + in: query + description: Filter based on comma separated metafieldʼs keys. Could be used with vanila 'key' query parameter. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + MetafieldNamespaceParam: + name: namespace + in: query + description: Filter based on a metafieldʼs namespaces. + required: false + schema: + type: string + MetafieldNamespaceInParam: + name: namespace:in + in: query + description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanila 'namespace' query parameter. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + LimitParam: + name: limit + description: | + Controls the number of items per page in a limited (paginated) list of products. + required: false + in: query + schema: + type: integer + DirectionParam: + name: direction + description: | + Sort direction. Acceptable values are: `asc`, `desc`. + required: false + in: query + schema: + type: string + enum: + - asc + - desc + responses: + General207Status: + description: 'Multi-status. Multiple operations have taken place and the status for each operation can be viewed in the body of the response. Typically indicates that a partial failure has occured, such as when a `POST` or `PUT` request is successful, but saving the URL or inventory data has failed.' + content: + application/json: + schema: + $ref: '#/components/schemas/error_Base' securitySchemes: X-Auth-Token: name: X-Auth-Token From 41b6b9fa05139eef6aac8d51ec035d662bf4b483 Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Thu, 25 Jan 2024 11:58:59 -0600 Subject: [PATCH 02/41] carts metafields --- reference/carts.v3.yml | 293 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 292 insertions(+), 1 deletion(-) diff --git a/reference/carts.v3.yml b/reference/carts.v3.yml index 4d354bea4..0cbaa8584 100644 --- a/reference/carts.v3.yml +++ b/reference/carts.v3.yml @@ -965,6 +965,122 @@ paths: in: path required: true description: The unique ID of the subject `Metafield`. + '/carts/metafields': + get: + summary: Get All Metafields + tags: + - Metafields + description: Get all cart metafields. + operationId: getCartsMetafields #getAllMetafeilds + responses: + '200': + description: | + List of `Metafield` objects. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '500': + description: Internal Server Error + parameters: + - $ref: '#/components/parameters/PageParam' + - $ref: '#/components/parameters/LimitParam' + - $ref: '#/components/parameters/MetafieldKeyParam' + - $ref: '#/components/parameters/MetafieldKeyInParam' + - $ref: '#/components/parameters/MetafieldNamespaceParam' + - $ref: '#/components/parameters/MetafieldNamespaceInParam' + - $ref: '#/components/parameters/DirectionParam' + post: + summary: Create multiple Metafields + tags: + - Metafields + description: Create multiple metafields. + operationId: createCartsMetafields + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MetafieldPost' + description: '' + responses: + '200': + description: | + List of created `Metafield` objects. # TODO + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '422': + description: | + Response object for metafields creation with partial success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '500': + description: Internal Server Error + put: + summary: Update multiple Metafields + tags: + - Metafields + description: Create multiple metafields. + operationId: updateCartsMetafields + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MetafieldPut' + description: '' + responses: + '200': + description: | + List of updated `Metafield` objects. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '422': + description: | + Response object for metafields creation with partial success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '500': + description: Internal Server Error + delete: + summary: Delete All Metafields + tags: + - Metafields + description: Delete all cart metafields. + operationId: deleteCartMetafields + requestBody: + content: + application/json: + schema: + type: array + items: + type: integer + description: Metafieldʼs ID list. + responses: + '200': + description: | + Response object for metafields deletion with success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionDeleteResponseSuccess' + '422': + description: | + Response object for metafields deletion with partial success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' components: schemas: CartUpdateRequest: @@ -3153,6 +3269,41 @@ components: - namespace - key - value + MetafieldPost_Batch: + description: | + The model for a POST to create metafield. + allOf: + - $ref: '#/components/schemas/MetafieldBase_Post' + - type: object + properties: + resource_id: + type: string + example: "42" + description: | + The id for the cart with which the metafield is associated. + required: + - resource_id + x-internal: false + MetafieldPut: + description: | + The model for a PUT to create metafield. + allOf: + - $ref: '#/components/schemas/MetafieldBase_Post' + - type: object + properties: + resource_id: + type: string + example: "42" + description: | + The id for the cart with which the metafield is associated. + id: + type: string + example: "42" + description: | + The id of metafield to update. + required: + - id + x-internal: false MetaFieldCollectionResponse: type: object description: | @@ -3163,6 +3314,124 @@ components: meta: $ref: '#/components/schemas/CollectionMeta' x-internal: false + MetaFieldCollectionDeleteResponseSuccess: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + type: integer + description: | + The unique identifier for the metafield. + example: [ + 123, + 124, + 125 + ] + errors: + type: array + items: + $ref: '#/components/schemas/Error' + example: [] + meta: + $ref: '#/components/schemas/WriteCollectionSuccessMeta' + x-internal: false + MetaFieldCollectionDeleteResponsePartialSuccess: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + type: integer + description: | + The unique identifier for the metafield. + example: [ + 123 + ] + errors: + type: array + items: + $ref: '#/components/schemas/Error' + meta: + $ref: '#/components/schemas/WriteCollectionPartialSuccessMeta' + x-internal: false + Error: + type: object + description: | + Error response payload for the BigCommerce API. + properties: + status: + type: integer + description: | + The HTTP status code for the error. + example: 422 + title: + type: string + description: | + The error title. + example: Bulk operation has failed + type: + type: string + description: | + The error type. + example: https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes + errors: + $ref: '#/components/schemas/ErrorDetail' + ErrorDetail: + type: object + description: | + Error detail response payload for the BigCommerce API. + example: + { + "1": "Unauthorized to delete", + "2": "Metafield does not exist" + } + WriteCollectionSuccessMeta: + type: object + description: 'Additional data about the response.' + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 3 + success: + type: integer + description: | + Total number of items that were successfully deleted. + example: 3 + failed: + type: integer + description: | + Total number of items that failed to be deleted. + example: 0 + title: Collection Meta + x-internal: false + WriteCollectionPartialSuccessMeta: + type: object + description: 'Additional data about the response.' + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 3 + success: + type: integer + description: | + Total number of items that were successfully deleted. + example: 1 + failed: + type: integer + description: | + Total number of items that failed to be deleted. + example: 2 + title: Collection Meta + x-internal: false CollectionMeta: type: object description: 'Data about the response, including pagination and collection totals.' @@ -3334,13 +3603,35 @@ components: required: false schema: type: string + MetafieldKeyInParam: + name: key:in + in: query + description: Filter based on comma separated metafieldʼs keys. Could be used with vanila 'key' query parameter. + required: false + style: form + explode: false + schema: + type: array + items: + type: string MetafieldNamespaceParam: name: namespace in: query - description: Filter based on a metafield's key. + description: Filter based on a metafield's namespaces. required: false schema: type: string + MetafieldNamespaceInParam: + name: namespace:in + in: query + description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanila 'namespace' query parameter. + required: false + style: form + explode: false + schema: + type: array + items: + type: string LimitParam: name: limit description: | From ba896f805739af2f9ff2daa41579bde658598bef Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Thu, 25 Jan 2024 12:05:23 -0600 Subject: [PATCH 03/41] categories metafields --- reference/catalog/categories_catalog.v3.yml | 618 ++++++++++++++++++++ 1 file changed, 618 insertions(+) diff --git a/reference/catalog/categories_catalog.v3.yml b/reference/catalog/categories_catalog.v3.yml index 96b4cfc81..527c8933c 100644 --- a/reference/catalog/categories_catalog.v3.yml +++ b/reference/catalog/categories_catalog.v3.yml @@ -1783,6 +1783,123 @@ paths: parameters: - $ref: '#/components/parameters/Accept' - $ref: '#/components/parameters/CategoryIdParam' + '/catalog/categories/metafields': + get: + summary: Get All Metafields + tags: + - Metafields + description: Get all category metafields. + operationId: getAllCategoryMetafields + responses: + '200': + description: | + List of `Metafield` objects. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '500': + description: Internal Server Error + parameters: + - $ref: '#/components/parameters/PageParam' + - $ref: '#/components/parameters/LimitParam' + - $ref: '#/components/parameters/MetafieldKeyParam' + - $ref: '#/components/parameters/MetafieldKeyInParam' + - $ref: '#/components/parameters/MetafieldNamespaceParam' + - $ref: '#/components/parameters/MetafieldNamespaceInParam' + - $ref: '#/components/parameters/DirectionParam' + post: + summary: Create multiple Metafields + tags: + - Metafields + description: Create multiple metafields. + operationId: createCategoryMetafields + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MetafieldPost' + description: '' + responses: + '200': + description: | + List of created `Metafield` objects. # TODO + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' + '422': + description: | + Response object for metafields creation with partial success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '500': + description: Internal Server Error + put: + summary: Update multiple Metafields + tags: + - Metafields + description: Create multiple metafields. + operationId: updateCategoryMetafields + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MetafieldPut' + description: '' + required: true + responses: + '200': + description: | + List of updated `Metafield` objects. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '422': + description: | + Response object for metafields creation with partial success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '500': + description: Internal Server Error + delete: + summary: Delete All Metafields + tags: + - Metafields + description: Delete all category metafields. + operationId: deleteCategoryMetafields + requestBody: + content: + application/json: + schema: + type: array + items: + type: integer + description: "Metafield's id list" + responses: + '200': + description: | + Response object for metafields deletion with success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionDeleteResponseSuccess' + '422': + description: | + Response object for metafields deletion with partial success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' components: schemas: category_Full: @@ -2304,6 +2421,444 @@ components: The unique numeric ID of the category's parent. This field controls where the category sits in the tree of categories that organize the catalog. Required in a POST if creating a child category. example: 2 + Metafield: + type: object + description: | + Common Metafield properties. + x-internal: false + properties: + permission_set: + type: string + description: | + Determines the visibility and writeability of the field by other API consumers. + | Value | Description | + | :--- | :--- | + | `app_only` | Private to the app that owns the field. | + | `read` | Visible to other API consumers. | + | `write` | Open for reading and writing by other API consumers. | + | `read_and_sf_access` | Visible to other API consumers, including on storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + enum: + - app_only + - read + - write + - read_and_sf_access + - write_and_sf_access + namespace: + type: string + description: | + Namespace for the metafield, for organizational purposes. + example: Sales Department + minLength: 1 + maxLength: 64 + key: + type: string + description: | + The name of the field, for example: `location_id`, `color`. + minLength: 1 + maxLength: 64 + example: Staff Name + value: + type: string + description: | + The value of the field, for example: `1`, `blue`. + minLength: 1 + maxLength: 65535 + example: Ronaldo + description: + type: string + description: | + Description for the metafields. + example: order + minLength: 0 + maxLength: 255 + resource_type: + type: string + description: | + The type of resource with which the metafield is associated. + enum: + - brand + - product + - variant + - category + - cart + - channel + - location + - order + - customer + example: cart + resource_id: + type: integer + description: | + The unique identifier for the resource with which the metafield is associated. + example: 424242 + readOnly: true + id: + type: integer + description: The unique identifier for the metafield. + date_created: + type: string + format: date-time + description: Date and time of the metafieldʼs creation. + example: '2022-06-16T18:39:00+00:00' + date_modified: + type: string + format: date-time + description: Date and time when the metafield was last updated. + example: '2022-06-16T18:39:00+00:00' + required: + - namespace + - key + - value + - permission_set + - resource_type + - resource_id + - description + - id + - date_created + - date_modified + MetaFieldCollectionResponse: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + $ref: '#/components/schemas/Metafield' + meta: + $ref: '#/components/schemas/CollectionMeta' + x-internal: false + MetaFieldCollectionDeleteResponsePartialSuccess: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + type: integer + description: | + The unique identifier for the metafield. + example: [ + 123 + ] + errors: + type: array + items: + $ref: '#/components/schemas/Error' + meta: + $ref: '#/components/schemas/WriteCollectionPartialSuccessMeta' + x-internal: false + MetaFieldCollectionDeleteResponseSuccess: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + type: integer + description: | + The unique identifier for the metafield. + example: [ + 123, + 124, + 125 + ] + errors: + type: array + items: + $ref: '#/components/schemas/Error' + example: [] + meta: + $ref: '#/components/schemas/WriteCollectionSuccessMeta' + x-internal: false + WriteCollectionPartialSuccessMeta: + type: object + description: 'Additional data about the response.' + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 3 + success: + type: integer + description: | + Total number of items that were successfully deleted. + example: 1 + failed: + type: integer + description: | + Total number of items that failed to be deleted. + example: 2 + title: Collection Meta + x-internal: false + WriteCollectionSuccessMeta: + type: object + description: 'Additional data about the response.' + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 3 + success: + type: integer + description: | + Total number of items that were successfully deleted. + example: 3 + failed: + type: integer + description: | + Total number of items that failed to be deleted. + example: 0 + title: Collection Meta + x-internal: false + Total: + type: integer + description: | + Total number of items in the result set. + example: 3 + Success: + type: integer + description: | + Total number of items that were successfully deleted. + example: 1 + Failed: + type: integer + description: | + Total number of items that failed to be deleted. + example: 2 + Error: + type: object + description: | + Error response payload for the BigCommerce API. + properties: + status: + type: integer + description: | + The HTTP status code for the error. + example: 422 + title: + type: string + description: | + The error title. + example: Bulk operation has failed + type: + type: string + description: | + The error type. + example: https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes + errors: + $ref: '#/components/schemas/ErrorDetail' + ErrorDetail: + type: object + description: | + Error detail response payload for the BigCommerce API. + example: + { + "1": "Unauthorized to delete", + "2": "Metafield does not exist" + } + CollectionMeta: + type: object + description: 'Data about the response, including pagination and collection totals.' + properties: + pagination: + type: object + description: 'Data about the response, including pagination and collection totals.' + title: Pagination + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 36 + count: + type: integer + description: | + Total number of items in the collection response. + example: 36 + per_page: + type: integer + description: | + The amount of items returned in the collection per page, controlled by the limit parameter. + example: 50 + current_page: + type: integer + description: | + The page you are currently on within the collection. + example: 1 + total_pages: + type: integer + description: | + The total number of pages in the collection. + example: 1 + links: + type: object + description: | + Pagination links for the previous and next parts of the whole collection. + properties: + previous: + type: string + description: | + Link to the previous page returned in the response. + current: + type: string + description: | + Link to the current page returned in the response. + example: '?page=1&limit=50' + next: + type: string + description: | + Link to the next page returned in the response. + additionalProperties: true + title: Collection Meta + x-internal: false + MetafieldBase_Post: + type: object + description: | + Common Metafield properties. + x-internal: false + properties: + permission_set: + type: string + description: | + Determines the visibility and writeability of the field by other API consumers. + | Value | Description | + | :--- | :--- | + | `app_only` | Private to the app that owns the field. | + | `read` | Visible to other API consumers. | + | `write` | Open for reading and writing by other API consumers. | + | `read_and_sf_access` | Visible to other API consumers, including on storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + enum: + - app_only + - read + - write + - read_and_sf_access + - write_and_sf_access + namespace: + type: string + description: | + Namespace for the metafield, for organizational purposes. + example: Sales Department + minLength: 1 + maxLength: 64 + key: + type: string + description: | + The name of the field, for example: `location_id`, `color`. + minLength: 1 + maxLength: 64 + example: Staff Name + value: + type: string + description: | + The value of the field, for example: `1`, `blue`. + minLength: 1 + maxLength: 65535 + example: Ronaldo + description: + type: string + description: | + Description for the metafields. + minLength: 0 + maxLength: 255 + example: Name of Staff Member + required: + - permission_set + - namespace + - key + - value + MetafieldPost: + description: | + The model for a POST to create metafield. + allOf: + - $ref: '#/components/schemas/MetafieldBase_Post' + - type: object + properties: + resource_id: + type: integer + example: 42 + description: | + The ID for the resource with which the metafield is associated. + required: + - resource_id + x-internal: false + MetafieldBase_Put: + type: object + description: | + Common Metafield properties. + x-internal: false + properties: + permission_set: + type: string + description: | + Determines the visibility and writeability of the field by other API consumers. + | Value | Description | + | :--- | :--- | + | `app_only` | Private to the app that owns the field. | + | `read` | Visible to other API consumers. | + | `write` | Open for reading and writing by other API consumers. | + | `read_and_sf_access` | Visible to other API consumers, including on storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + enum: + - app_only + - read + - write + - read_and_sf_access + - write_and_sf_access + namespace: + type: string + description: | + Namespace for the metafield, for organizational purposes. + example: Sales Department + minLength: 1 + maxLength: 64 + key: + type: string + description: | + The name of the field, for example: `location_id`, `color`. + minLength: 1 + maxLength: 64 + example: Staff Name + value: + type: string + description: | + The value of the field, for example: `1`, `blue`. + minLength: 1 + maxLength: 65535 + example: Ronaldo + description: + type: string + description: | + Description for the metafields. + minLength: 0 + maxLength: 255 + example: Name of Staff Member + MetafieldPut: + description: | + The model for a PUT to create metafield. + allOf: + - $ref: '#/components/schemas/MetafieldBase_Put' + - type: object + properties: + id: + type: integer + example: 42 + description: | + The ID of metafield to update. + resource_id: + type: integer + example: 42 + description: | + The ID for the resource with which the metafield is associated. + required: + - id + x-internal: false responses: General207Status: description: 'Multi-status. Multiple operations have taken place and the status for each operation can be viewed in the body of the response. Typically indicates that a partial failure has occurred, such as when a `POST` or `PUT` request is successful, but saving the URL or inventory data has failed.' @@ -2344,6 +2899,69 @@ components: schema: type: string default: 'application/json' + PageParam: + name: page + description: | + Specifies the page number in a limited (paginated) list of products. + required: false + in: query + schema: + type: integer + MetafieldKeyParam: + name: key + in: query + description: Filter based on a metafieldʼs key. + required: false + schema: + type: string + MetafieldKeyInParam: + name: key:in + in: query + description: Filter based on comma separated metafieldʼs keys. Could be used with vanila 'key' query parameter. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + MetafieldNamespaceParam: + name: namespace + in: query + description: Filter based on a metafieldʼs namespaces. + required: false + schema: + type: string + MetafieldNamespaceInParam: + name: namespace:in + in: query + description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanila 'namespace' query parameter. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + LimitParam: + name: limit + description: | + Controls the number of items per page in a limited (paginated) list of products. + required: false + in: query + schema: + type: integer + DirectionParam: + name: direction + description: | + Sort direction. Acceptable values are: `asc`, `desc`. + required: false + in: query + schema: + type: string + enum: + - asc + - desc securitySchemes: X-Auth-Token: name: X-Auth-Token From d341ece02f652729be65bdf5d7e467b16279a146 Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Thu, 25 Jan 2024 12:18:42 -0600 Subject: [PATCH 04/41] channel metafields --- reference/channels.v3.yml | 597 ++++++++++++++++++++++++++++++++++++-- 1 file changed, 579 insertions(+), 18 deletions(-) diff --git a/reference/channels.v3.yml b/reference/channels.v3.yml index ae42531a3..ae6fad7d0 100644 --- a/reference/channels.v3.yml +++ b/reference/channels.v3.yml @@ -767,6 +767,122 @@ paths: tags: - Channel Metafields description: Deletes a single channel metafield. + '/channels/metafields': + get: + summary: Get All Metafields + tags: + - Channel Metafields + description: Get all channel metafields. + operationId: getChannelsMetafields #getAllMetafeilds + responses: + '200': + description: | + List of `Metafield` objects. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '500': + description: Internal Server Error + parameters: + - $ref: '#/components/parameters/PageParam' + - $ref: '#/components/parameters/LimitParam' + - $ref: '#/components/parameters/MetafieldKeyParam' + - $ref: '#/components/parameters/MetafieldKeyInParam' + - $ref: '#/components/parameters/MetafieldNamespaceParam' + - $ref: '#/components/parameters/MetafieldNamespaceInParam' + - $ref: '#/components/parameters/DirectionParam' + post: + summary: Create multiple Metafields + tags: + - Channel Metafields + description: Create multiple metafields. + operationId: createChannelMetafields + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MetafieldPost' + description: '' + responses: + '200': + description: | + List of created `Metafield` objects. # TODO + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' + '422': + description: | + Response object for metafields creation with partial success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '500': + description: Internal Server Error + put: + summary: Update multiple Metafields + tags: + - Channel Metafields + description: Create multiple metafields. + operationId: updateChannelMetafields + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MetafieldPut' + description: '' + responses: + '200': + description: | + List of updated `Metafield` objects. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '422': + description: | + Response object for metafields creation with partial success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '500': + description: Internal Server Error + delete: + summary: Delete All Metafields + tags: + - Channel Metafields + description: Delete all channel metafields. + operationId: deleteChannelMetafields + requestBody: + content: + application/json: + schema: + type: array + items: + type: integer + description: "Metafield's id list" + responses: + '200': + description: | + Response object for metafields deletion with success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionDeleteResponseSuccess' + '422': + description: | + Response object for metafields deletion with partial success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' components: parameters: Accept: @@ -809,6 +925,17 @@ components: required: false schema: type: string + MetafieldKeyInParam: + name: key:in + in: query + description: Filter based on comma separated metafieldʼs keys. Could be used with vanila 'key' query parameter. + required: false + style: form + explode: false + schema: + type: array + items: + type: string MetafieldNamespaceParam: name: namespace in: query @@ -816,6 +943,17 @@ components: required: false schema: type: string + MetafieldNamespaceInParam: + name: namespace:in + in: query + description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanila 'namespace' query parameter. + required: false + style: form + explode: false + schema: + type: array + items: + type: string LimitParam: name: limit description: | @@ -826,7 +964,8 @@ components: type: integer DirectionParam: name: direction - description: Sort direction. + description: |- + Sort direction. Acceptable values are: `asc`, `desc`. required: false in: query schema: @@ -2144,6 +2283,445 @@ components: Date and time when the metafield was last updated. Read-Only. format: date-time example: '2018-05-07T20:14:17.000Z' + Metafield: + type: object + description: | + Common Metafield properties. + x-internal: false + properties: + permission_set: + type: string + description: | + Determines the visibility and writeability of the field by other API consumers. + | Value | Description | + | :--- | :--- | + | `app_only` | Private to the app that owns the field. | + | `read` | Visible to other API consumers. | + | `write` | Open for reading and writing by other API consumers. | + | `read_and_sf_access` | Visible to other API consumers, including on storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + enum: + - app_only + - read + - write + - read_and_sf_access + - write_and_sf_access + namespace: + type: string + description: | + Namespace for the metafield, for organizational purposes. + example: Sales Department + minLength: 1 + maxLength: 64 + key: + type: string + description: | + The name of the field, for example: `location_id`, `color`. + minLength: 1 + maxLength: 64 + example: Staff Name + value: + type: string + description: | + The value of the field, for example: `1`, `blue`. + minLength: 1 + maxLength: 65535 + example: Ronaldo + description: + type: string + description: | + Description for the metafields. + example: order + minLength: 0 + maxLength: 255 + resource_type: + type: string + description: | + The type of resource with which the metafield is associated. + enum: + - brand + - product + - variant + - category + - cart + - channel + - location + - order + - customer + example: cart + resource_id: + type: integer + description: | + The unique identifier for the resource with which the metafield is associated. + example: 424242 + readOnly: true + id: + type: integer + description: The unique identifier for the metafield. + date_created: + type: string + format: date-time + description: Date and time of the metafieldʼs creation. + example: '2022-06-16T18:39:00+00:00' + date_modified: + type: string + format: date-time + description: Date and time when the metafield was last updated. + example: '2022-06-16T18:39:00+00:00' + required: + - namespace + - key + - value + - permission_set + - resource_type + - resource_id + - description + - id + - date_created + - date_modified + MetaFieldCollectionResponse: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + $ref: '#/components/schemas/Metafield' + meta: + $ref: '#/components/schemas/CollectionMeta' + x-internal: false + MetaFieldCollectionDeleteResponsePartialSuccess: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + type: integer + description: | + The unique identifier for the metafield. + example: [ + 123 + ] + errors: + type: array + items: + $ref: '#/components/schemas/Error' + meta: + $ref: '#/components/schemas/WriteCollectionPartialSuccessMeta' + x-internal: false + MetaFieldCollectionDeleteResponseSuccess: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + type: integer + description: | + The unique identifier for the metafield. + example: [ + 123, + 124, + 125 + ] + errors: + type: array + items: + $ref: '#/components/schemas/Error' + example: [] + meta: + $ref: '#/components/schemas/WriteCollectionSuccessMeta' + x-internal: false + WriteCollectionPartialSuccessMeta: + type: object + description: 'Additional data about the response.' + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 3 + success: + type: integer + description: | + Total number of items that were successfully deleted. + example: 1 + failed: + type: integer + description: | + Total number of items that failed to be deleted. + example: 2 + title: Collection Meta + x-internal: false + WriteCollectionSuccessMeta: + type: object + description: 'Additional data about the response.' + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 3 + success: + type: integer + description: | + Total number of items that were successfully deleted. + example: 3 + failed: + type: integer + description: | + Total number of items that failed to be deleted. + example: 0 + title: Collection Meta + x-internal: false + Total: + type: integer + description: | + Total number of items in the result set. + example: 3 + Success: + type: integer + description: | + Total number of items that were successfully deleted. + example: 1 + Failed: + type: integer + description: | + Total number of items that failed to be deleted. + example: 2 + Error: + type: object + description: | + Error response payload for the BigCommerce API. + properties: + status: + type: integer + format: int32 + description: | + The HTTP status code for the error. + example: 422 + title: + type: string + description: | + The error title describing the particular error. + example: Bulk operation has failed + type: + type: string + description: | + The error type. + example: https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes + errors: + $ref: '#/components/schemas/ErrorDetail' + ErrorDetail: + type: object + description: | + Error detail response payload for the BigCommerce API. + example: + { + "1": "Unauthorized to delete", + "2": "Metafield does not exist" + } + CollectionMeta: + type: object + description: 'Data about the response, including pagination and collection totals.' + properties: + pagination: + type: object + description: 'Data about the response, including pagination and collection totals.' + title: Pagination + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 36 + count: + type: integer + description: | + Total number of items in the collection response. + example: 36 + per_page: + type: integer + description: | + The amount of items returned in the collection per page, controlled by the limit parameter. + example: 50 + current_page: + type: integer + description: | + The page you are currently on within the collection. + example: 1 + total_pages: + type: integer + description: | + The total number of pages in the collection. + example: 1 + links: + type: object + description: | + Pagination links for the previous and next parts of the whole collection. + properties: + previous: + type: string + description: | + Link to the previous page returned in the response. + current: + type: string + description: | + Link to the current page returned in the response. + example: '?page=1&limit=50' + next: + type: string + description: | + Link to the next page returned in the response. + additionalProperties: true + title: Collection Meta + x-internal: false + MetafieldBase_Post: + type: object + description: | + Common Metafield properties. + x-internal: false + properties: + permission_set: + type: string + description: | + Determines the visibility and writeability of the field by other API consumers. + | Value | Description | + | :--- | :--- | + | `app_only` | Private to the app that owns the field. | + | `read` | Visible to other API consumers. | + | `write` | Open for reading and writing by other API consumers. | + | `read_and_sf_access` | Visible to other API consumers, including on storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + enum: + - app_only + - read + - write + - read_and_sf_access + - write_and_sf_access + namespace: + type: string + description: | + Namespace for the metafield, for organizational purposes. + example: Sales Department + minLength: 1 + maxLength: 64 + key: + type: string + description: | + The name of the field, for example: `location_id`, `color`. + minLength: 1 + maxLength: 64 + example: Staff Name + value: + type: string + description: | + The value of the field, for example: `1`, `blue`. + minLength: 1 + maxLength: 65535 + example: Ronaldo + description: + type: string + description: | + Description for the metafields. + minLength: 0 + maxLength: 255 + example: Name of Staff Member + required: + - permission_set + - namespace + - key + - value + MetafieldPost: + description: | + The model for a POST to create metafield. + allOf: + - $ref: '#/components/schemas/MetafieldBase_Post' + - type: object + properties: + resource_id: + type: integer + example: 42 + description: | + The ID for the resource with which the metafield is associated. + required: + - resource_id + x-internal: false + MetafieldBase_Put: + type: object + description: | + Common Metafield properties. + x-internal: false + properties: + permission_set: + type: string + description: | + Determines the visibility and writeability of the field by other API consumers. + | Value | Description | + | :--- | :--- | + | `app_only` | Private to the app that owns the field. | + | `read` | Visible to other API consumers. | + | `write` | Open for reading and writing by other API consumers. | + | `read_and_sf_access` | Visible to other API consumers, including on storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + enum: + - app_only + - read + - write + - read_and_sf_access + - write_and_sf_access + namespace: + type: string + description: | + Namespace for the metafield, for organizational purposes. + example: Sales Department + minLength: 1 + maxLength: 64 + key: + type: string + description: | + The name of the field, for example: `location_id`, `color`. + minLength: 1 + maxLength: 64 + example: Staff Name + value: + type: string + description: | + The value of the field, for example: `1`, `blue`. + minLength: 1 + maxLength: 65535 + example: Ronaldo + description: + type: string + description: | + Description for the metafields. + minLength: 0 + maxLength: 255 + example: Name of Staff Member + MetafieldPut: + description: | + The model for a PUT to create metafield. + allOf: + - $ref: '#/components/schemas/MetafieldBase_Put' + - type: object + properties: + id: + type: integer + example: 42 + description: | + The ID of metafield to update. + resource_id: + type: integer + example: 42 + description: | + The ID for the resource with which the metafield is associated. + required: + - id + x-internal: false PutCheckoutUrl: type: object properties: @@ -2688,23 +3266,6 @@ components: type: string description: Value used in the `section` query param. x-internal: false - Error: - type: object - properties: - status: - type: integer - format: int32 - description: The HTTP status code. - title: - type: string - description: The error title describing the particular error. - type: - type: string - description: Link to a list of BigCommerce API status codes. - errors: - type: object - description: Provides more details to errors. - x-internal: false MetaWithFullPagination: type: object description: 'Data about the response, including pagination.' From b568bc01acefbed1750507ffe3618e2b13b96e7f Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Thu, 25 Jan 2024 12:26:24 -0600 Subject: [PATCH 05/41] customers metafields --- reference/customers.v3.yml | 794 +++++++++++++++++++++++++++++++++++++ 1 file changed, 794 insertions(+) diff --git a/reference/customers.v3.yml b/reference/customers.v3.yml index ada043c7f..9648485c1 100644 --- a/reference/customers.v3.yml +++ b/reference/customers.v3.yml @@ -34,6 +34,7 @@ tags: - name: Customer Settings - name: Customer Settings Channel - name: Customer Validate Credentials + - name: Customer Metafields paths: '/customers': get: @@ -1621,6 +1622,122 @@ paths: name: customerId in: path required: true + '/customers/metafields': + get: + summary: Get All Metafields + tags: + - Customer Metafields + description: Get all customer metafields. + operationId: getCustomersMetafields + responses: + '200': + description: | + List of `Metafield` objects. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '500': + description: Internal Server Error + parameters: + - $ref: '#/components/parameters/PageParam' + - $ref: '#/components/parameters/LimitParam' + - $ref: '#/components/parameters/MetafieldKeyParam' + - $ref: '#/components/parameters/MetafieldKeyInParam' + - $ref: '#/components/parameters/MetafieldNamespaceParam' + - $ref: '#/components/parameters/MetafieldNamespaceInParam' + - $ref: '#/components/parameters/DirectionParam' + post: + summary: Create multiple Metafields + tags: + - Customer Metafields + description: Create multiple metafields. + operationId: createCustomerMetafields + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MetafieldPost' + description: '' + responses: + '200': + description: | + List of created `Metafield` objects. # TODO + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' + '422': + description: | + Response object for metafields creation with partial success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '500': + description: Internal Server Error + put: + summary: Update multiple Metafields + tags: + - Customer Metafields + description: Create multiple metafields. + operationId: updateCustomerMetafields + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MetafieldPut' + description: '' + responses: + '200': + description: | + List of updated `Metafield` objects. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '422': + description: | + Response object for metafields creation with partial success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '500': + description: Internal Server Error + delete: + summary: Delete All Metafields + tags: + - Customer Metafields + description: Delete all customer metafields. + operationId: deleteCustomerMetafields + requestBody: + content: + application/json: + schema: + type: array + items: + type: integer + description: "Metafield's id list" + responses: + '200': + description: | + Response object for metafields deletion with success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionDeleteResponseSuccess' + '422': + description: | + Response object for metafields deletion with partial success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' components: parameters: customerId: @@ -1630,6 +1747,69 @@ components: description: '' schema: type: string + PageParam: + name: page + description: | + Specifies the page number in a limited (paginated) list of products. + required: false + in: query + schema: + type: integer + MetafieldKeyParam: + name: key + in: query + description: Filter based on a metafieldʼs key. + required: false + schema: + type: string + MetafieldKeyInParam: + name: key:in + in: query + description: Filter based on comma separated metafieldʼs keys. Could be used with vanila 'key' query parameter. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + MetafieldNamespaceParam: + name: namespace + in: query + description: Filter based on a metafieldʼs namespaces. + required: false + schema: + type: string + MetafieldNamespaceInParam: + name: namespace:in + in: query + description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanila 'namespace' query parameter. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + LimitParam: + name: limit + description: | + Controls the number of items per page in a limited (paginated) list of products. + required: false + in: query + schema: + type: integer + DirectionParam: + name: direction + description: | + Sort direction. Acceptable values are: `asc`, `desc`. + required: false + in: query + schema: + type: string + enum: + - asc + - desc responses: CustomerCollectionResponse: description: Customer Collection Response @@ -3830,3 +4010,617 @@ components: type: boolean description: indicates if the provided credentials are valid. x-internal: false + Metafield: + type: object + description: | + Common Metafield properties. + x-internal: false + properties: + permission_set: + type: string + description: | + Determines the visibility and writeability of the field by other API consumers. + | Value | Description | + | :--- | :--- | + | `app_only` | Private to the app that owns the field. | + | `read` | Visible to other API consumers. | + | `write` | Open for reading and writing by other API consumers. | + | `read_and_sf_access` | Visible to other API consumers, including on storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + enum: + - app_only + - read + - write + - read_and_sf_access + - write_and_sf_access + namespace: + type: string + description: | + Namespace for the metafield, for organizational purposes. + example: Sales Department + minLength: 1 + maxLength: 64 + key: + type: string + description: | + The name of the field, for example: `location_id`, `color`. + minLength: 1 + maxLength: 64 + example: Staff Name + value: + type: string + description: | + The value of the field, for example: `1`, `blue`. + minLength: 1 + maxLength: 65535 + example: Ronaldo + description: + type: string + description: | + Description for the metafields. + example: order + minLength: 0 + maxLength: 255 + resource_type: + type: string + description: | + The type of resource with which the metafield is associated. + enum: + - brand + - product + - variant + - category + - cart + - channel + - location + - order + - customer + example: cart + resource_id: + type: integer + description: | + The unique identifier for the resource with which the metafield is associated. + example: 424242 + readOnly: true + id: + type: integer + description: The unique identifier for the metafield. + date_created: + type: string + format: date-time + description: Date and time of the metafieldʼs creation. + example: '2022-06-16T18:39:00+00:00' + date_modified: + type: string + format: date-time + description: Date and time when the metafield was last updated. + example: '2022-06-16T18:39:00+00:00' + required: + - namespace + - key + - value + - permission_set + - resource_type + - resource_id + - description + - id + - date_created + - date_modified + MetaFieldCollectionResponse: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + $ref: '#/components/schemas/Metafield' + meta: + $ref: '#/components/schemas/CollectionMeta' + x-internal: false + MetaFieldCollectionDeleteResponsePartialSuccess: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + type: integer + description: | + The unique identifier for the metafield. + example: [ + 123 + ] + errors: + type: array + items: + $ref: '#/components/schemas/Error' + meta: + $ref: '#/components/schemas/WriteCollectionPartialSuccessMeta' + x-internal: false + MetaFieldCollectionDeleteResponseSuccess: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + type: integer + description: | + The unique identifier for the metafield. + example: [ + 123, + 124, + 125 + ] + errors: + type: array + items: + $ref: '#/components/schemas/Error' + example: [] + meta: + $ref: '#/components/schemas/WriteCollectionSuccessMeta' + x-internal: false + WriteCollectionPartialSuccessMeta: + type: object + description: 'Additional data about the response.' + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 3 + success: + type: integer + description: | + Total number of items that were successfully deleted. + example: 1 + failed: + type: integer + description: | + Total number of items that failed to be deleted. + example: 2 + title: Collection Meta + x-internal: false + WriteCollectionSuccessMeta: + type: object + description: 'Additional data about the response.' + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 3 + success: + type: integer + description: | + Total number of items that were successfully deleted. + example: 3 + failed: + type: integer + description: | + Total number of items that failed to be deleted. + example: 0 + title: Collection Meta + x-internal: false + Total: + type: integer + description: | + Total number of items in the result set. + example: 3 + Success: + type: integer + description: | + Total number of items that were successfully deleted. + example: 1 + Failed: + type: integer + description: | + Total number of items that failed to be deleted. + example: 2 + Error: + type: object + description: | + Error response payload for the BigCommerce API. + properties: + status: + type: integer + description: | + The HTTP status code for the error. + example: 422 + title: + type: string + description: | + The error title. + example: Bulk operation has failed + type: + type: string + description: | + The error type. + example: https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes + errors: + $ref: '#/components/schemas/ErrorDetail' + ErrorDetail: + type: object + description: | + Error detail response payload for the BigCommerce API. + example: + { + "1": "Unauthorized to delete", + "2": "Metafield does not exist" + } + CollectionMeta: + type: object + description: 'Data about the response, including pagination and collection totals.' + properties: + pagination: + type: object + description: 'Data about the response, including pagination and collection totals.' + title: Pagination + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 36 + count: + type: integer + description: | + Total number of items in the collection response. + example: 36 + per_page: + type: integer + description: | + The amount of items returned in the collection per page, controlled by the limit parameter. + example: 50 + current_page: + type: integer + description: | + The page you are currently on within the collection. + example: 1 + total_pages: + type: integer + description: | + The total number of pages in the collection. + example: 1 + links: + type: object + description: | + Pagination links for the previous and next parts of the whole collection. + properties: + previous: + type: string + description: | + Link to the previous page returned in the response. + current: + type: string + description: | + Link to the current page returned in the response. + example: '?page=1&limit=50' + next: + type: string + description: | + Link to the next page returned in the response. + additionalProperties: true + title: Collection Meta + x-internal: false + MetafieldBase_Post: + type: object + description: | + Common Metafield properties. + x-internal: false + properties: + permission_set: + type: string + description: | + Determines the visibility and writeability of the field by other API consumers. + | Value | Description | + | :--- | :--- | + | `app_only` | Private to the app that owns the field. | + | `read` | Visible to other API consumers. | + | `write` | Open for reading and writing by other API consumers. | + | `read_and_sf_access` | Visible to other API consumers, including on storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + enum: + - app_only + - read + - write + - read_and_sf_access + - write_and_sf_access + namespace: + type: string + description: | + Namespace for the metafield, for organizational purposes. + example: Sales Department + minLength: 1 + maxLength: 64 + key: + type: string + description: | + The name of the field, for example: `location_id`, `color`. + minLength: 1 + maxLength: 64 + example: Staff Name + value: + type: string + description: | + The value of the field, for example: `1`, `blue`. + minLength: 1 + maxLength: 65535 + example: Ronaldo + description: + type: string + description: | + Description for the metafields. + minLength: 0 + maxLength: 255 + example: Name of Staff Member + required: + - permission_set + - namespace + - key + - value + MetafieldPost: + description: | + The model for a POST to create metafield. + allOf: + - $ref: '#/components/schemas/MetafieldBase_Post' + - type: object + properties: + resource_id: + type: integer + example: 42 + description: | + The ID for the resource with which the metafield is associated. + required: + - resource_id + x-internal: false + MetafieldBase_Put: + type: object + description: | + Common Metafield properties. + x-internal: false + properties: + permission_set: + type: string + description: | + Determines the visibility and writeability of the field by other API consumers. + | Value | Description | + | :--- | :--- | + | `app_only` | Private to the app that owns the field. | + | `read` | Visible to other API consumers. | + | `write` | Open for reading and writing by other API consumers. | + | `read_and_sf_access` | Visible to other API consumers, including on storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + enum: + - app_only + - read + - write + - read_and_sf_access + - write_and_sf_access + namespace: + type: string + description: | + Namespace for the metafield, for organizational purposes. + example: Sales Department + minLength: 1 + maxLength: 64 + key: + type: string + description: | + The name of the field, for example: `location_id`, `color`. + minLength: 1 + maxLength: 64 + example: Staff Name + value: + type: string + description: | + The value of the field, for example: `1`, `blue`. + minLength: 1 + maxLength: 65535 + example: Ronaldo + description: + type: string + description: | + Description for the metafields. + minLength: 0 + maxLength: 255 + example: Name of Staff Member + MetafieldPut: + description: | + The model for a PUT to create metafield. + allOf: + - $ref: '#/components/schemas/MetafieldBase_Put' + - type: object + properties: + id: + type: integer + example: 42 + description: | + The ID of metafield to update. + resource_id: + type: integer + example: 42 + description: | + The ID for the resource with which the metafield is associated. + required: + - id + x-internal: false + metafield_Full: + title: metafield_Full + allOf: + - type: object + properties: + id: + type: integer + description: Unique ID of the *Metafield*. Read-Only. + readOnly: true + example: 6 + - $ref: '#/components/schemas/metafield_Base' + - type: object + properties: + resource_type: + type: string + description: | + The type of resource with which the metafield is associated. + example: customer + enum: + - category + - brand + - product + - variant + - customer + x-required: + - post + resource_id: + maximum: 10000000000 + minimum: 0 + type: integer + description: | + The ID of the resource with which the metafield is associated. + example: 111 + x-required: + - post + date_created: + type: string + description: | + Date and time of the metafield's creation. Read-Only. + readOnly: true + format: date-time + example: '2018-05-07T20:14:17+00:00' + date_modified: + type: string + description: | + Date and time when the metafield was last updated. Read-Only. + readOnly: true + format: date-time + example: '2018-05-07T20:14:17+00:00' + x-internal: false + metafield_Base: + title: metafield_Base + type: object + description: 'Metafield for products, categories, variants, and brands; the max number of metafields allowed on each is 50. For more information, see [Platform Limits](https://support.bigcommerce.com/s/article/Platform-Limits) in the Help Center.' + x-internal: false + properties: + key: + maxLength: 64 + minLength: 1 + type: string + description: | + The name of the field, for example: `location_id`, `color`. Required for POST. + example: Location + x-required: + - post + value: + maxLength: 65535 + minLength: 1 + type: string + description: | + The value of the field, for example: `1`, `blue`. Required for POST. + example: 4HG + x-required: + - post + namespace: + maxLength: 64 + minLength: 1 + type: string + description: | + Namespace for the metafield, for organizational purposes. This is set by the developer. Required for POST. + example: Warehouse Locations + x-required: + - post + permission_set: + type: string + description: |- + Determines the visibility and writeability of the field by other API consumers. + + |Value|Description + |-|-| + |`app_only`|Private to the app that owns the field| + |`read`|Visible to other API consumers| + |`write`|Open for reading and writing by other API consumers| + |`read_and_sf_access`|Visible to other API consumers, including on storefront| + |`write_and_sf_access`|Open for reading and writing by other API consumers, including on storefront| + enum: + - app_only + - read + - write + - read_and_sf_access + - write_and_sf_access + description: + maxLength: 255 + minLength: 0 + type: string + description: | + Description for the metafields. + example: Location in the warehouse + required: + - permission_set + - namespace + - key + - value + metaEmpty_Full: + type: object + title: Response meta + properties: { } + additionalProperties: true + description: Response metadata. + metaCollection_Full: + title: metaCollection_Full + type: object + properties: + pagination: + $ref: '#/components/schemas/pagination_Full' + description: 'Data about the response, including pagination and collection totals.' + x-internal: false + pagination_Full: + title: pagination_Full + type: object + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 36 + count: + type: integer + description: | + Total number of items in the collection response. + example: 36 + per_page: + type: integer + description: | + The amount of items returned in the collection per page, controlled by the limit parameter. + example: 50 + current_page: + type: integer + description: | + The page you are currently on within the collection. + example: 1 + total_pages: + type: integer + description: | + The total number of pages in the collection. + example: 1 + links: + type: object + properties: + previous: + type: string + description: | + Link to the previous page returned in the response. + current: + type: string + description: | + Link to the current page returned in the response. + example: '?page=1&limit=50' + next: + type: string + description: | + Link to the next page returned in the response. + description: | + Pagination links for the previous and next parts of the whole collection. + description: 'Data about the response, including pagination and collection totals.' + x-internal: false From a572fe6028cb0ff0c679eb24d61caf0d90cb2875 Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Thu, 25 Jan 2024 12:45:20 -0600 Subject: [PATCH 06/41] orders metafields --- reference/orders.v3.yml | 306 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 306 insertions(+) diff --git a/reference/orders.v3.yml b/reference/orders.v3.yml index 125cfffc6..afbf34d5f 100644 --- a/reference/orders.v3.yml +++ b/reference/orders.v3.yml @@ -873,6 +873,122 @@ paths: type: string description: Channel ID required: true + '/orders/metafields': + get: + summary: Get All Metafields + tags: + - Metafields + description: Get all order metafields. + operationId: getOrdersMetafields #getAllMetafeilds + responses: + '200': + description: | + List of `Metafield` objects. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '500': + description: Internal Server Error + parameters: + - $ref: '#/components/parameters/PageParam' + - $ref: '#/components/parameters/LimitParam' + - $ref: '#/components/parameters/MetafieldKeyParam' + - $ref: '#/components/parameters/MetafieldKeyInParam' + - $ref: '#/components/parameters/MetafieldNamespaceParam' + - $ref: '#/components/parameters/MetafieldNamespaceInParam' + - $ref: '#/components/parameters/DirectionParam' + post: + summary: Create multiple Metafields + tags: + - Metafields + description: Create multiple metafields. + operationId: createOrderMetafields + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MetafieldPost' + description: '' + responses: + '200': + description: | + List of created `Metafield` objects. # TODO + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' + '422': + description: | + Response object for metafields creation with partial success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '500': + description: Internal Server Error + put: + summary: Update multiple Metafields + tags: + - Metafields + description: Create multiple metafields. + operationId: updateOrderMetafields + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MetafieldPut' + description: '' + responses: + '200': + description: | + List of updated `Metafield` objects. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '422': + description: | + Response object for metafields creation with partial success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '500': + description: Internal Server Error + delete: + summary: Delete All Metafields + tags: + - Metafields + description: Delete all order metafields. + operationId: deleteOrderMetafields + requestBody: + content: + application/json: + schema: + type: array + items: + type: integer + description: "Metafield's id list" + responses: + '200': + description: | + Response object for metafields deletion with success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionDeleteResponseSuccess' + '422': + description: | + Response object for metafields deletion with partial success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' components: schemas: GetReturnsSettings: @@ -2897,6 +3013,174 @@ components: x-examples: example-1: $ref: '#/components/examples/EnableMultipleOrderNotifications/value' + MetaFieldCollectionDeleteResponsePartialSuccess: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + type: integer + description: | + The unique identifier for the metafield. + example: [ + 123 + ] + errors: + type: array + items: + $ref: '#/components/schemas/Error' + meta: + $ref: '#/components/schemas/WriteCollectionPartialSuccessMeta' + x-internal: false + MetaFieldCollectionDeleteResponseSuccess: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + type: integer + description: | + The unique identifier for the metafield. + example: [ + 123, + 124, + 125 + ] + errors: + type: array + items: + $ref: '#/components/schemas/Error' + example: [] + meta: + $ref: '#/components/schemas/WriteCollectionSuccessMeta' + x-internal: false + WriteCollectionPartialSuccessMeta: + type: object + description: 'Additional data about the response.' + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 3 + success: + type: integer + description: | + Total number of items that were successfully deleted. + example: 1 + failed: + type: integer + description: | + Total number of items that failed to be deleted. + example: 2 + title: Collection Meta + x-internal: false + WriteCollectionSuccessMeta: + type: object + description: 'Additional data about the response.' + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 3 + success: + type: integer + description: | + Total number of items that were successfully deleted. + example: 3 + failed: + type: integer + description: | + Total number of items that failed to be deleted. + example: 0 + title: Collection Meta + x-internal: false + Total: + type: integer + description: | + Total number of items in the result set. + example: 3 + Success: + type: integer + description: | + Total number of items that were successfully deleted. + example: 1 + Failed: + type: integer + description: | + Total number of items that failed to be deleted. + example: 2 + Error: + type: object + description: | + Error response payload for the BigCommerce API. + properties: + status: + type: integer + description: | + The HTTP status code for the error. + example: 422 + title: + type: string + description: | + The error title. + example: Bulk operation has failed + type: + type: string + description: | + The error type. + example: https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes + errors: + $ref: '#/components/schemas/ErrorDetail' + ErrorDetail: + type: object + description: | + Error detail response payload for the BigCommerce API. + example: + { + "1": "Unauthorized to delete", + "2": "Metafield does not exist" + } + MetafieldPost_Batch: + description: | + The model for a POST to create metafield. + allOf: + - $ref: '#/components/schemas/MetafieldBase_Post' + - type: object + properties: + resource_id: + type: integer + example: 42 + description: | + The ID for the resource with which the metafield is associated. + required: + - resource_id + x-internal: false + MetafieldPut_Batch: + description: | + The model for a PUT to create metafield. + allOf: + - $ref: '#/components/schemas/MetafieldBase_Post' + - type: object + properties: + id: + type: integer + example: 42 + description: | + The ID of metafield to update. + resource_id: + type: integer + example: 42 + description: | + The ID for the resource with which the metafield is associated. + required: + - id + x-internal: false ChannelOrderSettings: type: object properties: @@ -3383,6 +3667,17 @@ components: required: false schema: type: string + MetafieldKeyInParam: + name: key:in + in: query + description: Filter based on comma separated metafieldʼs keys. Could be used with vanila 'key' query parameter. + required: false + style: form + explode: false + schema: + type: array + items: + type: string MetafieldNamespaceParam: name: namespace in: query @@ -3391,6 +3686,17 @@ components: required: false schema: type: string + MetafieldNamespaceInParam: + name: namespace:in + in: query + description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanila 'namespace' query parameter. + required: false + style: form + explode: false + schema: + type: array + items: + type: string LimitParam: name: limit description: | From 8b320812198eb42c092ce4ebbd0688df7fb68fe9 Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Sun, 28 Jan 2024 19:12:19 -0600 Subject: [PATCH 07/41] add product variants metafields --- .../catalog/product-variants_catalog.v3.yml | 617 ++++++++++++++++++ 1 file changed, 617 insertions(+) diff --git a/reference/catalog/product-variants_catalog.v3.yml b/reference/catalog/product-variants_catalog.v3.yml index fa421e754..ec08f44c7 100644 --- a/reference/catalog/product-variants_catalog.v3.yml +++ b/reference/catalog/product-variants_catalog.v3.yml @@ -1731,6 +1731,122 @@ paths: x-codegen-request-body-name: body parameters: - $ref: '#/components/parameters/Accept' + '/catalog/variants/metafields': + get: + summary: Get All Metafields + tags: + - Metafields + description: Get all variant metafields. + operationId: getVariantsMetafields + responses: + '200': + description: | + List of `Metafield` objects. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '500': + description: Internal Server Error + parameters: + - $ref: '#/components/parameters/PageParam' + - $ref: '#/components/parameters/LimitParam' + - $ref: '#/components/parameters/MetafieldKeyParam' + - $ref: '#/components/parameters/MetafieldKeyInParam' + - $ref: '#/components/parameters/MetafieldNamespaceParam' + - $ref: '#/components/parameters/MetafieldNamespaceInParam' + - $ref: '#/components/parameters/DirectionParam' + post: + summary: Create multiple Metafields + tags: + - Metafields + description: Create multiple metafields. + operationId: createVariantMetafields + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MetafieldPost' + description: '' + responses: + '200': + description: | + List of created `Metafield` objects. # TODO + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' + '422': + description: | + Response object for metafields creation with partial success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '500': + description: Internal Server Error + put: + summary: Update multiple Metafields + tags: + - Metafields + description: Create multiple metafields. + operationId: updateVariantMetafields + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MetafieldPut' + description: '' + responses: + '200': + description: | + List of updated `Metafield` objects. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '422': + description: | + Response object for metafields creation with partial success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '500': + description: Internal Server Error + delete: + summary: Delete All Metafields + tags: + - Metafields + description: Delete all variant metafields. + operationId: deleteVariantMetafields + requestBody: + content: + application/json: + schema: + type: array + items: + type: integer + description: "Metafield's id list" + responses: + '200': + description: | + Response object for metafields deletion with success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionDeleteResponseSuccess' + '422': + description: | + Response object for metafields deletion with partial success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' components: schemas: categoriesTree_Resp: @@ -2360,6 +2476,444 @@ components: x-required: - post x-internal: false + Metafield: + type: object + description: | + Common Metafield properties. + x-internal: false + properties: + permission_set: + type: string + description: | + Determines the visibility and writeability of the field by other API consumers. + | Value | Description | + | :--- | :--- | + | `app_only` | Private to the app that owns the field. | + | `read` | Visible to other API consumers. | + | `write` | Open for reading and writing by other API consumers. | + | `read_and_sf_access` | Visible to other API consumers, including on storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + enum: + - app_only + - read + - write + - read_and_sf_access + - write_and_sf_access + namespace: + type: string + description: | + Namespace for the metafield, for organizational purposes. + example: Sales Department + minLength: 1 + maxLength: 64 + key: + type: string + description: | + The name of the field, for example: `location_id`, `color`. + minLength: 1 + maxLength: 64 + example: Staff Name + value: + type: string + description: | + The value of the field, for example: `1`, `blue`. + minLength: 1 + maxLength: 65535 + example: Ronaldo + description: + type: string + description: | + Description for the metafields. + example: order + minLength: 0 + maxLength: 255 + resource_type: + type: string + description: | + The type of resource with which the metafield is associated. + enum: + - brand + - product + - variant + - category + - cart + - channel + - location + - order + - customer + example: cart + resource_id: + type: integer + description: | + The unique identifier for the resource with which the metafield is associated. + example: 424242 + readOnly: true + id: + type: integer + description: The unique identifier for the metafield. + date_created: + type: string + format: date-time + description: Date and time of the metafieldʼs creation. + example: '2022-06-16T18:39:00+00:00' + date_modified: + type: string + format: date-time + description: Date and time when the metafield was last updated. + example: '2022-06-16T18:39:00+00:00' + required: + - namespace + - key + - value + - permission_set + - resource_type + - resource_id + - description + - id + - date_created + - date_modified + MetaFieldCollectionResponse: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + $ref: '#/components/schemas/Metafield' + meta: + $ref: '#/components/schemas/CollectionMeta' + x-internal: false + MetaFieldCollectionDeleteResponsePartialSuccess: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + type: integer + description: | + The unique identifier for the metafield. + example: [ + 123 + ] + errors: + type: array + items: + $ref: '#/components/schemas/Error' + meta: + $ref: '#/components/schemas/WriteCollectionPartialSuccessMeta' + x-internal: false + MetaFieldCollectionDeleteResponseSuccess: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + type: integer + description: | + The unique identifier for the metafield. + example: [ + 123, + 124, + 125 + ] + errors: + type: array + items: + $ref: '#/components/schemas/Error' + example: [] + meta: + $ref: '#/components/schemas/WriteCollectionSuccessMeta' + x-internal: false + WriteCollectionPartialSuccessMeta: + type: object + description: 'Additional data about the response.' + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 3 + success: + type: integer + description: | + Total number of items that were successfully deleted. + example: 1 + failed: + type: integer + description: | + Total number of items that failed to be deleted. + example: 2 + title: Collection Meta + x-internal: false + WriteCollectionSuccessMeta: + type: object + description: 'Additional data about the response.' + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 3 + success: + type: integer + description: | + Total number of items that were successfully deleted. + example: 3 + failed: + type: integer + description: | + Total number of items that failed to be deleted. + example: 0 + title: Collection Meta + x-internal: false + Total: + type: integer + description: | + Total number of items in the result set. + example: 3 + Success: + type: integer + description: | + Total number of items that were successfully deleted. + example: 1 + Failed: + type: integer + description: | + Total number of items that failed to be deleted. + example: 2 + Error: + type: object + description: | + Error response payload for the BigCommerce API. + properties: + status: + type: integer + description: | + The HTTP status code for the error. + example: 422 + title: + type: string + description: | + The error title. + example: Bulk operation has failed + type: + type: string + description: | + The error type. + example: https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes + errors: + $ref: '#/components/schemas/ErrorDetail' + ErrorDetail: + type: object + description: | + Error detail response payload for the BigCommerce API. + example: + { + "1": "Unauthorized to delete", + "2": "Metafield does not exist" + } + CollectionMeta: + type: object + description: 'Data about the response, including pagination and collection totals.' + properties: + pagination: + type: object + description: 'Data about the response, including pagination and collection totals.' + title: Pagination + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 36 + count: + type: integer + description: | + Total number of items in the collection response. + example: 36 + per_page: + type: integer + description: | + The amount of items returned in the collection per page, controlled by the limit parameter. + example: 50 + current_page: + type: integer + description: | + The page you are currently on within the collection. + example: 1 + total_pages: + type: integer + description: | + The total number of pages in the collection. + example: 1 + links: + type: object + description: | + Pagination links for the previous and next parts of the whole collection. + properties: + previous: + type: string + description: | + Link to the previous page returned in the response. + current: + type: string + description: | + Link to the current page returned in the response. + example: '?page=1&limit=50' + next: + type: string + description: | + Link to the next page returned in the response. + additionalProperties: true + title: Collection Meta + x-internal: false + MetafieldBase_Post: + type: object + description: | + Common Metafield properties. + x-internal: false + properties: + permission_set: + type: string + description: | + Determines the visibility and writeability of the field by other API consumers. + | Value | Description | + | :--- | :--- | + | `app_only` | Private to the app that owns the field. | + | `read` | Visible to other API consumers. | + | `write` | Open for reading and writing by other API consumers. | + | `read_and_sf_access` | Visible to other API consumers, including on storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + enum: + - app_only + - read + - write + - read_and_sf_access + - write_and_sf_access + namespace: + type: string + description: | + Namespace for the metafield, for organizational purposes. + example: Sales Department + minLength: 1 + maxLength: 64 + key: + type: string + description: | + The name of the field, for example: `location_id`, `color`. + minLength: 1 + maxLength: 64 + example: Staff Name + value: + type: string + description: | + The value of the field, for example: `1`, `blue`. + minLength: 1 + maxLength: 65535 + example: Ronaldo + description: + type: string + description: | + Description for the metafields. + minLength: 0 + maxLength: 255 + example: Name of Staff Member + required: + - permission_set + - namespace + - key + - value + MetafieldPost: + description: | + The model for a POST to create metafield. + allOf: + - $ref: '#/components/schemas/MetafieldBase_Post' + - type: object + properties: + resource_id: + type: integer + example: 42 + description: | + The ID for the resource with which the metafield is associated. + required: + - resource_id + x-internal: false + MetafieldBase_Put: + type: object + description: | + Common Metafield properties. + x-internal: false + properties: + permission_set: + type: string + description: | + Determines the visibility and writeability of the field by other API consumers. + | Value | Description | + | :--- | :--- | + | `app_only` | Private to the app that owns the field. | + | `read` | Visible to other API consumers. | + | `write` | Open for reading and writing by other API consumers. | + | `read_and_sf_access` | Visible to other API consumers, including on storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + enum: + - app_only + - read + - write + - read_and_sf_access + - write_and_sf_access + namespace: + type: string + description: | + Namespace for the metafield, for organizational purposes. + example: Sales Department + minLength: 1 + maxLength: 64 + key: + type: string + description: | + The name of the field, for example: `location_id`, `color`. + minLength: 1 + maxLength: 64 + example: Staff Name + value: + type: string + description: | + The value of the field, for example: `1`, `blue`. + minLength: 1 + maxLength: 65535 + example: Ronaldo + description: + type: string + description: | + Description for the metafields. + minLength: 0 + maxLength: 255 + example: Name of Staff Member + MetafieldPut: + description: | + The model for a PUT to create metafield. + allOf: + - $ref: '#/components/schemas/MetafieldBase_Put' + - type: object + properties: + id: + type: integer + example: 42 + description: | + The ID of metafield to update. + resource_id: + type: integer + example: 42 + description: | + The ID for the resource with which the metafield is associated. + required: + - id + x-internal: false parameters: ProductIdParam: name: product_id @@ -2401,6 +2955,69 @@ components: schema: type: string default: 'application/json' + PageParam: + name: page + description: | + Specifies the page number in a limited (paginated) list of products. + required: false + in: query + schema: + type: integer + MetafieldKeyParam: + name: key + in: query + description: Filter based on a metafieldʼs key. + required: false + schema: + type: string + MetafieldKeyInParam: + name: key:in + in: query + description: Filter based on comma separated metafieldʼs keys. Could be used with vanila 'key' query parameter. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + MetafieldNamespaceParam: + name: namespace + in: query + description: Filter based on a metafieldʼs namespaces. + required: false + schema: + type: string + MetafieldNamespaceInParam: + name: namespace:in + in: query + description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanila 'namespace' query parameter. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + LimitParam: + name: limit + description: | + Controls the number of items per page in a limited (paginated) list of products. + required: false + in: query + schema: + type: integer + DirectionParam: + name: direction + description: | + Sort direction. Acceptable values are: `asc`, `desc`. + required: false + in: query + schema: + type: string + enum: + - asc + - desc securitySchemes: X-Auth-Token: name: X-Auth-Token From 79311b416562db94f0e5a47b936673dffe789f88 Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Sun, 28 Jan 2024 19:15:51 -0600 Subject: [PATCH 08/41] add product metafields --- reference/catalog/products_catalog.v3.yml | 617 ++++++++++++++++++++++ 1 file changed, 617 insertions(+) diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml index 7edf71b93..56e7f032a 100644 --- a/reference/catalog/products_catalog.v3.yml +++ b/reference/catalog/products_catalog.v3.yml @@ -6281,6 +6281,122 @@ paths: $ref: '#/components/schemas/metaEmpty_Full' parameters: - $ref: '#/components/parameters/Accept' + '/catalog/products/metafields': + get: + summary: Get All Metafields + tags: + - Metafields + description: Get all product metafields. + operationId: getProductsMetafields + responses: + '200': + description: | + List of `Metafield` objects. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '500': + description: Internal Server Error + parameters: + - $ref: '#/components/parameters/PageParam' + - $ref: '#/components/parameters/LimitParam' + - $ref: '#/components/parameters/MetafieldKeyParam' + - $ref: '#/components/parameters/MetafieldKeyInParam' + - $ref: '#/components/parameters/MetafieldNamespaceParam' + - $ref: '#/components/parameters/MetafieldNamespaceInParam' + - $ref: '#/components/parameters/DirectionParam' + post: + summary: Create multiple Metafields + tags: + - Metafields + description: Create multiple metafields. + operationId: createProductMetafields + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MetafieldPost' + description: '' + responses: + '200': + description: | + List of created `Metafield` objects. # TODO + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' + '422': + description: | + Response object for metafields creation with partial success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '500': + description: Internal Server Error + put: + summary: Update multiple Metafields + tags: + - Metafields + description: Create multiple metafields. + operationId: updateProductMetafields + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MetafieldPut' + description: '' + responses: + '200': + description: | + List of updated `Metafield` objects. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '422': + description: | + Response object for metafields creation with partial success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionResponse' + '500': + description: Internal Server Error + delete: + summary: Delete All Metafields + tags: + - Metafields + description: Delete all product metafields. + operationId: deleteProductMetafields + requestBody: + content: + application/json: + schema: + type: array + items: + type: integer + description: "Metafield's id list" + responses: + '200': + description: | + Response object for metafields deletion with success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionDeleteResponseSuccess' + '422': + description: | + Response object for metafields deletion with partial success. + content: + application/json: + schema: + $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' components: schemas: productModifier_Base: @@ -8636,6 +8752,444 @@ components: $ref: '#/components/schemas/beta5DetailedErrors' x-tags: - Models + Metafield: + type: object + description: | + Common Metafield properties. + x-internal: false + properties: + permission_set: + type: string + description: | + Determines the visibility and writeability of the field by other API consumers. + | Value | Description | + | :--- | :--- | + | `app_only` | Private to the app that owns the field. | + | `read` | Visible to other API consumers. | + | `write` | Open for reading and writing by other API consumers. | + | `read_and_sf_access` | Visible to other API consumers, including on storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + enum: + - app_only + - read + - write + - read_and_sf_access + - write_and_sf_access + namespace: + type: string + description: | + Namespace for the metafield, for organizational purposes. + example: Sales Department + minLength: 1 + maxLength: 64 + key: + type: string + description: | + The name of the field, for example: `location_id`, `color`. + minLength: 1 + maxLength: 64 + example: Staff Name + value: + type: string + description: | + The value of the field, for example: `1`, `blue`. + minLength: 1 + maxLength: 65535 + example: Ronaldo + description: + type: string + description: | + Description for the metafields. + example: order + minLength: 0 + maxLength: 255 + resource_type: + type: string + description: | + The type of resource with which the metafield is associated. + enum: + - brand + - product + - variant + - category + - cart + - channel + - location + - order + - customer + example: cart + resource_id: + type: integer + description: | + The unique identifier for the resource with which the metafield is associated. + example: 424242 + readOnly: true + id: + type: integer + description: The unique identifier for the metafield. + date_created: + type: string + format: date-time + description: Date and time of the metafieldʼs creation. + example: '2022-06-16T18:39:00+00:00' + date_modified: + type: string + format: date-time + description: Date and time when the metafield was last updated. + example: '2022-06-16T18:39:00+00:00' + required: + - namespace + - key + - value + - permission_set + - resource_type + - resource_id + - description + - id + - date_created + - date_modified + MetaFieldCollectionResponse: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + $ref: '#/components/schemas/Metafield' + meta: + $ref: '#/components/schemas/CollectionMeta' + x-internal: false + MetaFieldCollectionDeleteResponsePartialSuccess: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + type: integer + description: | + The unique identifier for the metafield. + example: [ + 123 + ] + errors: + type: array + items: + $ref: '#/components/schemas/Error' + meta: + $ref: '#/components/schemas/WriteCollectionPartialSuccessMeta' + x-internal: false + MetaFieldCollectionDeleteResponseSuccess: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + type: integer + description: | + The unique identifier for the metafield. + example: [ + 123, + 124, + 125 + ] + errors: + type: array + items: + $ref: '#/components/schemas/Error' + example: [] + meta: + $ref: '#/components/schemas/WriteCollectionSuccessMeta' + x-internal: false + WriteCollectionPartialSuccessMeta: + type: object + description: 'Additional data about the response.' + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 3 + success: + type: integer + description: | + Total number of items that were successfully deleted. + example: 1 + failed: + type: integer + description: | + Total number of items that failed to be deleted. + example: 2 + title: Collection Meta + x-internal: false + WriteCollectionSuccessMeta: + type: object + description: 'Additional data about the response.' + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 3 + success: + type: integer + description: | + Total number of items that were successfully deleted. + example: 3 + failed: + type: integer + description: | + Total number of items that failed to be deleted. + example: 0 + title: Collection Meta + x-internal: false + Total: + type: integer + description: | + Total number of items in the result set. + example: 3 + Success: + type: integer + description: | + Total number of items that were successfully deleted. + example: 1 + Failed: + type: integer + description: | + Total number of items that failed to be deleted. + example: 2 + Error: + type: object + description: | + Error response payload for the BigCommerce API. + properties: + status: + type: integer + description: | + The HTTP status code for the error. + example: 422 + title: + type: string + description: | + The error title. + example: Bulk operation has failed + type: + type: string + description: | + The error type. + example: https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes + errors: + $ref: '#/components/schemas/ErrorDetail' + ErrorDetail: + type: object + description: | + Error detail response payload for the BigCommerce API. + example: + { + "1": "Unauthorized to delete", + "2": "Metafield does not exist" + } + CollectionMeta: + type: object + description: 'Data about the response, including pagination and collection totals.' + properties: + pagination: + type: object + description: 'Data about the response, including pagination and collection totals.' + title: Pagination + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 36 + count: + type: integer + description: | + Total number of items in the collection response. + example: 36 + per_page: + type: integer + description: | + The amount of items returned in the collection per page, controlled by the limit parameter. + example: 50 + current_page: + type: integer + description: | + The page you are currently on within the collection. + example: 1 + total_pages: + type: integer + description: | + The total number of pages in the collection. + example: 1 + links: + type: object + description: | + Pagination links for the previous and next parts of the whole collection. + properties: + previous: + type: string + description: | + Link to the previous page returned in the response. + current: + type: string + description: | + Link to the current page returned in the response. + example: '?page=1&limit=50' + next: + type: string + description: | + Link to the next page returned in the response. + additionalProperties: true + title: Collection Meta + x-internal: false + MetafieldBase_Post: + type: object + description: | + Common Metafield properties. + x-internal: false + properties: + permission_set: + type: string + description: | + Determines the visibility and writeability of the field by other API consumers. + | Value | Description | + | :--- | :--- | + | `app_only` | Private to the app that owns the field. | + | `read` | Visible to other API consumers. | + | `write` | Open for reading and writing by other API consumers. | + | `read_and_sf_access` | Visible to other API consumers, including on storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + enum: + - app_only + - read + - write + - read_and_sf_access + - write_and_sf_access + namespace: + type: string + description: | + Namespace for the metafield, for organizational purposes. + example: Sales Department + minLength: 1 + maxLength: 64 + key: + type: string + description: | + The name of the field, for example: `location_id`, `color`. + minLength: 1 + maxLength: 64 + example: Staff Name + value: + type: string + description: | + The value of the field, for example: `1`, `blue`. + minLength: 1 + maxLength: 65535 + example: Ronaldo + description: + type: string + description: | + Description for the metafields. + minLength: 0 + maxLength: 255 + example: Name of Staff Member + required: + - permission_set + - namespace + - key + - value + MetafieldPost: + description: | + The model for a POST to create metafield. + allOf: + - $ref: '#/components/schemas/MetafieldBase_Post' + - type: object + properties: + resource_id: + type: integer + example: 42 + description: | + The ID for the resource with which the metafield is associated. + required: + - resource_id + x-internal: false + MetafieldBase_Put: + type: object + description: | + Common Metafield properties. + x-internal: false + properties: + permission_set: + type: string + description: | + Determines the visibility and writeability of the field by other API consumers. + | Value | Description | + | :--- | :--- | + | `app_only` | Private to the app that owns the field. | + | `read` | Visible to other API consumers. | + | `write` | Open for reading and writing by other API consumers. | + | `read_and_sf_access` | Visible to other API consumers, including on storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + enum: + - app_only + - read + - write + - read_and_sf_access + - write_and_sf_access + namespace: + type: string + description: | + Namespace for the metafield, for organizational purposes. + example: Sales Department + minLength: 1 + maxLength: 64 + key: + type: string + description: | + The name of the field, for example: `location_id`, `color`. + minLength: 1 + maxLength: 64 + example: Staff Name + value: + type: string + description: | + The value of the field, for example: `1`, `blue`. + minLength: 1 + maxLength: 65535 + example: Ronaldo + description: + type: string + description: | + Description for the metafields. + minLength: 0 + maxLength: 255 + example: Name of Staff Member + MetafieldPut: + description: | + The model for a PUT to create metafield. + allOf: + - $ref: '#/components/schemas/MetafieldBase_Put' + - type: object + properties: + id: + type: integer + example: 42 + description: | + The ID of metafield to update. + resource_id: + type: integer + example: 42 + description: | + The ID for the resource with which the metafield is associated. + required: + - id + x-internal: false parameters: ProductIdParam: name: product_id @@ -8716,6 +9270,69 @@ components: schema: type: string default: 'application/json' + PageParam: + name: page + description: | + Specifies the page number in a limited (paginated) list of products. + required: false + in: query + schema: + type: integer + MetafieldKeyParam: + name: key + in: query + description: Filter based on a metafieldʼs key. + required: false + schema: + type: string + MetafieldKeyInParam: + name: key:in + in: query + description: Filter based on comma separated metafieldʼs keys. Could be used with vanila 'key' query parameter. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + MetafieldNamespaceParam: + name: namespace + in: query + description: Filter based on a metafieldʼs namespaces. + required: false + schema: + type: string + MetafieldNamespaceInParam: + name: namespace:in + in: query + description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanila 'namespace' query parameter. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + LimitParam: + name: limit + description: | + Controls the number of items per page in a limited (paginated) list of products. + required: false + in: query + schema: + type: integer + DirectionParam: + name: direction + description: | + Sort direction. Acceptable values are: `asc`, `desc`. + required: false + in: query + schema: + type: string + enum: + - asc + - desc securitySchemes: X-Auth-Token: name: X-Auth-Token From a9c201c98f80b5d9c7feadf1687037947af22de8 Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Sun, 28 Jan 2024 20:18:07 -0600 Subject: [PATCH 09/41] carts: remove redundant schema --- reference/carts.v3.yml | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/reference/carts.v3.yml b/reference/carts.v3.yml index 0cbaa8584..d498e945d 100644 --- a/reference/carts.v3.yml +++ b/reference/carts.v3.yml @@ -823,7 +823,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetafieldPost' + $ref: '#/components/schemas/MetafieldBase_Post' example: { "permission_set": app_only, @@ -918,7 +918,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetafieldPost' + $ref: '#/components/schemas/MetafieldBase_Post' examples: {} description: | A `Metafield` object. @@ -971,7 +971,7 @@ paths: tags: - Metafields description: Get all cart metafields. - operationId: getCartsMetafields #getAllMetafeilds + operationId: getCartsMetafields responses: '200': description: | @@ -1002,7 +1002,7 @@ paths: schema: type: array items: - $ref: '#/components/schemas/MetafieldPost' + $ref: '#/components/schemas/MetafieldBase_Post' description: '' responses: '200': @@ -3207,12 +3207,6 @@ components: readOnly: true required: - permission_set - MetafieldPost: - description: | - The model for a POST to create metafield. - allOf: - - $ref: '#/components/schemas/MetafieldBase_Post' - x-internal: false MetafieldBase_Post: type: object description: | From f347025c724c5c45b3a30c5690c1deb84fce8930 Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Wed, 31 Jan 2024 11:32:31 -0600 Subject: [PATCH 10/41] update carts metafields --- reference/carts.v3.yml | 34 ++++++++++++++++++++-------------- 1 file changed, 20 insertions(+), 14 deletions(-) diff --git a/reference/carts.v3.yml b/reference/carts.v3.yml index d498e945d..6738e3247 100644 --- a/reference/carts.v3.yml +++ b/reference/carts.v3.yml @@ -979,7 +979,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponse_Batch' '500': description: Internal Server Error parameters: @@ -1002,7 +1002,7 @@ paths: schema: type: array items: - $ref: '#/components/schemas/MetafieldBase_Post' + $ref: '#/components/schemas/MetafieldPost_Batch' description: '' responses: '200': @@ -1011,14 +1011,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponse_Batch' '422': description: | Response object for metafields creation with partial success. content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponse_Batch' '500': description: Internal Server Error put: @@ -1033,7 +1033,7 @@ paths: schema: type: array items: - $ref: '#/components/schemas/MetafieldPut' + $ref: '#/components/schemas/MetafieldPut_Batch' description: '' responses: '200': @@ -1042,14 +1042,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponse_Batch' '422': description: | Response object for metafields creation with partial success. content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponse_Batch' '500': description: Internal Server Error delete: @@ -1065,7 +1065,7 @@ paths: type: array items: type: integer - description: Metafieldʼs ID list. + description: List of metafield `id`s. responses: '200': description: | @@ -3278,18 +3278,13 @@ components: required: - resource_id x-internal: false - MetafieldPut: + MetafieldPut_Batch: description: | The model for a PUT to create metafield. allOf: - $ref: '#/components/schemas/MetafieldBase_Post' - type: object properties: - resource_id: - type: string - example: "42" - description: | - The id for the cart with which the metafield is associated. id: type: string example: "42" @@ -3308,6 +3303,17 @@ components: meta: $ref: '#/components/schemas/CollectionMeta' x-internal: false + MetaFieldCollectionResponse_Batch: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + $ref: '#/components/schemas/Metafield' + meta: + $ref: '#/components/schemas/CollectionMeta' MetaFieldCollectionDeleteResponseSuccess: type: object description: | From 63b265d4e453d922733ccf5582bb985dfaf30639 Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Wed, 31 Jan 2024 11:45:15 -0600 Subject: [PATCH 11/41] update carts metafields, simplify schema --- reference/carts.v3.yml | 54 +++++++++++++++++------------------------- 1 file changed, 22 insertions(+), 32 deletions(-) diff --git a/reference/carts.v3.yml b/reference/carts.v3.yml index 6738e3247..201d8336c 100644 --- a/reference/carts.v3.yml +++ b/reference/carts.v3.yml @@ -1002,7 +1002,17 @@ paths: schema: type: array items: - $ref: '#/components/schemas/MetafieldPost_Batch' + allOf: + - $ref: '#/components/schemas/MetafieldBase_Post' + - type: object + properties: + resource_id: + type: string + example: "42" + description: | + The id for the cart with which the metafield is associated. + required: + - resource_id description: '' responses: '200': @@ -1033,7 +1043,17 @@ paths: schema: type: array items: - $ref: '#/components/schemas/MetafieldPut_Batch' + allOf: + - $ref: '#/components/schemas/MetafieldBase_Post' + - type: object + properties: + id: + type: string + example: "42" + description: | + The id of metafield to update. + required: + - id description: '' responses: '200': @@ -3263,36 +3283,6 @@ components: - namespace - key - value - MetafieldPost_Batch: - description: | - The model for a POST to create metafield. - allOf: - - $ref: '#/components/schemas/MetafieldBase_Post' - - type: object - properties: - resource_id: - type: string - example: "42" - description: | - The id for the cart with which the metafield is associated. - required: - - resource_id - x-internal: false - MetafieldPut_Batch: - description: | - The model for a PUT to create metafield. - allOf: - - $ref: '#/components/schemas/MetafieldBase_Post' - - type: object - properties: - id: - type: string - example: "42" - description: | - The id of metafield to update. - required: - - id - x-internal: false MetaFieldCollectionResponse: type: object description: | From 456b8a74b3a1bf7bdf4017a4767822fb6acd2ba1 Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Thu, 1 Feb 2024 08:56:13 -0600 Subject: [PATCH 12/41] ujpdate channels metafields --- reference/channels.v3.yml | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) diff --git a/reference/channels.v3.yml b/reference/channels.v3.yml index ae6fad7d0..7a55745b6 100644 --- a/reference/channels.v3.yml +++ b/reference/channels.v3.yml @@ -773,7 +773,7 @@ paths: tags: - Channel Metafields description: Get all channel metafields. - operationId: getChannelsMetafields #getAllMetafeilds + operationId: getChannelsMetafields responses: '200': description: | @@ -813,14 +813,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponse' '422': description: | Response object for metafields creation with partial success. content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' '500': description: Internal Server Error put: @@ -867,7 +867,7 @@ paths: type: array items: type: integer - description: "Metafield's id list" + description: "List of metafield `id`s." responses: '200': description: | @@ -2714,11 +2714,6 @@ components: example: 42 description: | The ID of metafield to update. - resource_id: - type: integer - example: 42 - description: | - The ID for the resource with which the metafield is associated. required: - id x-internal: false From f93e8ca7d18340e7e9426cb9185c16cd633ee84a Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Thu, 1 Feb 2024 09:50:00 -0600 Subject: [PATCH 13/41] update customers metafields --- reference/customers.v3.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/reference/customers.v3.yml b/reference/customers.v3.yml index 9648485c1..2bccfd384 100644 --- a/reference/customers.v3.yml +++ b/reference/customers.v3.yml @@ -1664,11 +1664,11 @@ paths: responses: '200': description: | - List of created `Metafield` objects. # TODO + List of created `Metafield` objects. content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponse' '422': description: | Response object for metafields creation with partial success. From be589bd601f1e5caeea355b2dc0d684259803957 Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Thu, 1 Feb 2024 09:52:45 -0600 Subject: [PATCH 14/41] update customers metafields PUT --- reference/customers.v3.yml | 5 ----- 1 file changed, 5 deletions(-) diff --git a/reference/customers.v3.yml b/reference/customers.v3.yml index 2bccfd384..ca53a1c23 100644 --- a/reference/customers.v3.yml +++ b/reference/customers.v3.yml @@ -4440,11 +4440,6 @@ components: example: 42 description: | The ID of metafield to update. - resource_id: - type: integer - example: 42 - description: | - The ID for the resource with which the metafield is associated. required: - id x-internal: false From f73c5577de6b6b1935b2187c56769d8a3d080c83 Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Thu, 1 Feb 2024 09:59:13 -0600 Subject: [PATCH 15/41] update customers metafields put and post --- reference/customers.v3.yml | 54 ++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 32 deletions(-) diff --git a/reference/customers.v3.yml b/reference/customers.v3.yml index ca53a1c23..cbb31bfec 100644 --- a/reference/customers.v3.yml +++ b/reference/customers.v3.yml @@ -1659,7 +1659,17 @@ paths: schema: type: array items: - $ref: '#/components/schemas/MetafieldPost' + allOf: + - $ref: '#/components/schemas/MetafieldBase_Post' + - type: object + properties: + resource_id: + type: integer + example: 42 + description: | + The ID for the resource with which the metafield is associated. + required: + - resource_id description: '' responses: '200': @@ -1690,7 +1700,17 @@ paths: schema: type: array items: - $ref: '#/components/schemas/MetafieldPut' + allOf: + - $ref: '#/components/schemas/MetafieldBase_Put' + - type: object + properties: + id: + type: integer + example: 42 + description: | + The ID of metafield to update. + required: + - id description: '' responses: '200': @@ -4362,21 +4382,6 @@ components: - namespace - key - value - MetafieldPost: - description: | - The model for a POST to create metafield. - allOf: - - $ref: '#/components/schemas/MetafieldBase_Post' - - type: object - properties: - resource_id: - type: integer - example: 42 - description: | - The ID for the resource with which the metafield is associated. - required: - - resource_id - x-internal: false MetafieldBase_Put: type: object description: | @@ -4428,21 +4433,6 @@ components: minLength: 0 maxLength: 255 example: Name of Staff Member - MetafieldPut: - description: | - The model for a PUT to create metafield. - allOf: - - $ref: '#/components/schemas/MetafieldBase_Put' - - type: object - properties: - id: - type: integer - example: 42 - description: | - The ID of metafield to update. - required: - - id - x-internal: false metafield_Full: title: metafield_Full allOf: From 6cf0a25cdcdc4fa42a5bbb40c88b4b4cecec4205 Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Mon, 5 Feb 2024 09:51:50 -0600 Subject: [PATCH 16/41] add order metafields --- reference/orders.v3.yml | 39 ++++++++++++++++++++++++++------------- 1 file changed, 26 insertions(+), 13 deletions(-) diff --git a/reference/orders.v3.yml b/reference/orders.v3.yml index afbf34d5f..03af2f15a 100644 --- a/reference/orders.v3.yml +++ b/reference/orders.v3.yml @@ -617,7 +617,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetafieldPost' + $ref: '#/components/schemas/MetafieldBase_Post' examples: {} description: | A `Metafield` object. @@ -879,7 +879,7 @@ paths: tags: - Metafields description: Get all order metafields. - operationId: getOrdersMetafields #getAllMetafeilds + operationId: getOrdersMetafields responses: '200': description: | @@ -910,7 +910,17 @@ paths: schema: type: array items: - $ref: '#/components/schemas/MetafieldPost' + allOf: + - $ref: '#/components/schemas/MetafieldBase_Post' + - type: object + properties: + resource_id: + type: string + example: "42" + description: | + The id for the cart with which the metafield is associated. + required: + - resource_id description: '' responses: '200': @@ -919,7 +929,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponse' '422': description: | Response object for metafields creation with partial success. @@ -941,7 +951,17 @@ paths: schema: type: array items: - $ref: '#/components/schemas/MetafieldPut' + allOf: + - $ref: '#/components/schemas/MetafieldBase_Post' + - type: object + properties: + id: + type: integer + example: 42 + description: | + The id of metafield to update. + required: + - id description: '' responses: '200': @@ -973,7 +993,7 @@ paths: type: array items: type: integer - description: "Metafield's id list" + description: "List of metafield `id`s." responses: '200': description: | @@ -2967,13 +2987,6 @@ components: example: '2022-06-16T18:39:00+00:00' x-internal: false x-examples: {} - MetafieldPost: - description: | - The model for a POST to create metafield. - allOf: - - $ref: '#/components/schemas/MetafieldBase_Post' - x-internal: false - x-examples: {} MetafieldPut: description: | The model for a PUT to update metafield. From e6eb90b2731608e916ecdab1566f6d82838b760e Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Mon, 5 Feb 2024 10:03:49 -0600 Subject: [PATCH 17/41] update brands metafields --- reference/catalog/brands_catalog.v3.yml | 50 ++++++++++++------------- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/reference/catalog/brands_catalog.v3.yml b/reference/catalog/brands_catalog.v3.yml index 4a1bf4d9f..7861f1552 100644 --- a/reference/catalog/brands_catalog.v3.yml +++ b/reference/catalog/brands_catalog.v3.yml @@ -1624,16 +1624,26 @@ paths: schema: type: array items: - $ref: '#/components/schemas/MetafieldPost' + allOf: + - $ref: '#/components/schemas/MetafieldBase_Post' + - type: object + properties: + resource_id: + type: string + example: "42" + description: | + The id for the cart with which the metafield is associated. + required: + - resource_id description: '' responses: '200': description: | - List of created `Metafield` objects. # TODO + List of created `Metafield` objects. content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponse' '422': description: | Response object for metafields creation with partial success. @@ -1655,7 +1665,17 @@ paths: schema: type: array items: - $ref: '#/components/schemas/MetafieldPut' + allOf: + - $ref: '#/components/schemas/MetafieldBase_Put' + - type: object + properties: + id: + type: integer + example: 42 + description: | + The id of metafield to update. + required: + - id description: '' responses: '200': @@ -1687,7 +1707,7 @@ paths: type: array items: type: integer - description: "Metafield's id list" + description: "List of metafield `id`s." responses: '200': description: | @@ -2392,26 +2412,6 @@ components: minLength: 0 maxLength: 255 example: Name of Staff Member - MetafieldPut: - description: | - The model for a PUT to create metafield. - allOf: - - $ref: '#/components/schemas/MetafieldBase_Put' - - type: object - properties: - id: - type: integer - example: 42 - description: | - The ID of metafield to update. - resource_id: - type: integer - example: 42 - description: | - The ID for the resource with which the metafield is associated. - required: - - id - x-internal: false parameters: BrandIdParam: name: brand_id From 416e4edde9d95e6dc9387327934150b0c781518b Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Mon, 5 Feb 2024 10:10:21 -0600 Subject: [PATCH 18/41] update categories metafields --- reference/catalog/categories_catalog.v3.yml | 64 ++++++++------------- 1 file changed, 24 insertions(+), 40 deletions(-) diff --git a/reference/catalog/categories_catalog.v3.yml b/reference/catalog/categories_catalog.v3.yml index 527c8933c..11372714f 100644 --- a/reference/catalog/categories_catalog.v3.yml +++ b/reference/catalog/categories_catalog.v3.yml @@ -1820,7 +1820,17 @@ paths: schema: type: array items: - $ref: '#/components/schemas/MetafieldPost' + allOf: + - $ref: '#/components/schemas/MetafieldBase_Post' + - type: object + properties: + resource_id: + type: string + example: "42" + description: | + The id for the cart with which the metafield is associated. + required: + - resource_id description: '' responses: '200': @@ -1829,7 +1839,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponse' '422': description: | Response object for metafields creation with partial success. @@ -1851,9 +1861,18 @@ paths: schema: type: array items: - $ref: '#/components/schemas/MetafieldPut' + allOf: + - $ref: '#/components/schemas/MetafieldBase_Put' + - type: object + properties: + id: + type: string + example: "42" + description: | + The id of metafield to update. + required: + - id description: '' - required: true responses: '200': description: | @@ -1884,7 +1903,7 @@ paths: type: array items: type: integer - description: "Metafield's id list" + description: "List of metafield `id`s." responses: '200': description: | @@ -2773,21 +2792,6 @@ components: - namespace - key - value - MetafieldPost: - description: | - The model for a POST to create metafield. - allOf: - - $ref: '#/components/schemas/MetafieldBase_Post' - - type: object - properties: - resource_id: - type: integer - example: 42 - description: | - The ID for the resource with which the metafield is associated. - required: - - resource_id - x-internal: false MetafieldBase_Put: type: object description: | @@ -2839,26 +2843,6 @@ components: minLength: 0 maxLength: 255 example: Name of Staff Member - MetafieldPut: - description: | - The model for a PUT to create metafield. - allOf: - - $ref: '#/components/schemas/MetafieldBase_Put' - - type: object - properties: - id: - type: integer - example: 42 - description: | - The ID of metafield to update. - resource_id: - type: integer - example: 42 - description: | - The ID for the resource with which the metafield is associated. - required: - - id - x-internal: false responses: General207Status: description: 'Multi-status. Multiple operations have taken place and the status for each operation can be viewed in the body of the response. Typically indicates that a partial failure has occurred, such as when a `POST` or `PUT` request is successful, but saving the URL or inventory data has failed.' From 37fdf2f80d1152c0d35d35f8992a5a71c9c4c0a1 Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Mon, 5 Feb 2024 10:26:38 -0600 Subject: [PATCH 19/41] update product variants metafields --- .../catalog/product-variants_catalog.v3.yml | 65 +++++++------------ 1 file changed, 25 insertions(+), 40 deletions(-) diff --git a/reference/catalog/product-variants_catalog.v3.yml b/reference/catalog/product-variants_catalog.v3.yml index ec08f44c7..9a23f8258 100644 --- a/reference/catalog/product-variants_catalog.v3.yml +++ b/reference/catalog/product-variants_catalog.v3.yml @@ -1768,16 +1768,26 @@ paths: schema: type: array items: - $ref: '#/components/schemas/MetafieldPost' + allOf: + - $ref: '#/components/schemas/MetafieldBase_Post' + - type: object + properties: + resource_id: + type: string + example: "42" + description: | + The id for the cart with which the metafield is associated. + required: + - resource_id description: '' responses: '200': description: | - List of created `Metafield` objects. # TODO + List of created `Metafield` objects. content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponse' '422': description: | Response object for metafields creation with partial success. @@ -1799,7 +1809,17 @@ paths: schema: type: array items: - $ref: '#/components/schemas/MetafieldPut' + allOf: + - $ref: '#/components/schemas/MetafieldBase_Put' + - type: object + properties: + id: + type: integer + example: 42 + description: | + The id of metafield to update. + required: + - id description: '' responses: '200': @@ -1831,7 +1851,7 @@ paths: type: array items: type: integer - description: "Metafield's id list" + description: "List of metafield `id`s." responses: '200': description: | @@ -2828,21 +2848,6 @@ components: - namespace - key - value - MetafieldPost: - description: | - The model for a POST to create metafield. - allOf: - - $ref: '#/components/schemas/MetafieldBase_Post' - - type: object - properties: - resource_id: - type: integer - example: 42 - description: | - The ID for the resource with which the metafield is associated. - required: - - resource_id - x-internal: false MetafieldBase_Put: type: object description: | @@ -2894,26 +2899,6 @@ components: minLength: 0 maxLength: 255 example: Name of Staff Member - MetafieldPut: - description: | - The model for a PUT to create metafield. - allOf: - - $ref: '#/components/schemas/MetafieldBase_Put' - - type: object - properties: - id: - type: integer - example: 42 - description: | - The ID of metafield to update. - resource_id: - type: integer - example: 42 - description: | - The ID for the resource with which the metafield is associated. - required: - - id - x-internal: false parameters: ProductIdParam: name: product_id From c7930c2d8cadbf4725a044b1a308e5339c396239 Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Mon, 5 Feb 2024 10:43:48 -0600 Subject: [PATCH 20/41] update products metafields --- reference/catalog/products_catalog.v3.yml | 63 +++++++++-------------- 1 file changed, 24 insertions(+), 39 deletions(-) diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml index 56e7f032a..5f3e895ef 100644 --- a/reference/catalog/products_catalog.v3.yml +++ b/reference/catalog/products_catalog.v3.yml @@ -6318,7 +6318,17 @@ paths: schema: type: array items: - $ref: '#/components/schemas/MetafieldPost' + allOf: + - $ref: '#/components/schemas/MetafieldBase_Post' + - type: object + properties: + resource_id: + type: string + example: "42" + description: | + The id for the cart with which the metafield is associated. + required: + - resource_id description: '' responses: '200': @@ -6327,7 +6337,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponse' '422': description: | Response object for metafields creation with partial success. @@ -6349,7 +6359,17 @@ paths: schema: type: array items: - $ref: '#/components/schemas/MetafieldPut' + allOf: + - $ref: '#/components/schemas/MetafieldBase_Put' + - type: object + properties: + id: + type: integer + example: 42 + description: | + The id of metafield to update. + required: + - id description: '' responses: '200': @@ -6381,7 +6401,7 @@ paths: type: array items: type: integer - description: "Metafield's id list" + description: "List of metafield `id`s." responses: '200': description: | @@ -9104,21 +9124,6 @@ components: - namespace - key - value - MetafieldPost: - description: | - The model for a POST to create metafield. - allOf: - - $ref: '#/components/schemas/MetafieldBase_Post' - - type: object - properties: - resource_id: - type: integer - example: 42 - description: | - The ID for the resource with which the metafield is associated. - required: - - resource_id - x-internal: false MetafieldBase_Put: type: object description: | @@ -9170,26 +9175,6 @@ components: minLength: 0 maxLength: 255 example: Name of Staff Member - MetafieldPut: - description: | - The model for a PUT to create metafield. - allOf: - - $ref: '#/components/schemas/MetafieldBase_Put' - - type: object - properties: - id: - type: integer - example: 42 - description: | - The ID of metafield to update. - resource_id: - type: integer - example: 42 - description: | - The ID for the resource with which the metafield is associated. - required: - - id - x-internal: false parameters: ProductIdParam: name: product_id From 4f806c8d8fb5335e022671fa9479d439a3908e12 Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Mon, 5 Feb 2024 11:50:42 -0600 Subject: [PATCH 21/41] add owner cliend id field to responses --- reference/carts.v3.yml | 4 ++++ reference/catalog/brands_catalog.v3.yml | 4 ++++ reference/catalog/categories_catalog.v3.yml | 4 ++++ reference/catalog/product-variants_catalog.v3.yml | 4 ++++ reference/catalog/products_catalog.v3.yml | 4 ++++ reference/channels.v3.yml | 6 +++++- reference/customers.v3.yml | 4 ++++ reference/orders.v3.yml | 4 ++++ 8 files changed, 33 insertions(+), 1 deletion(-) diff --git a/reference/carts.v3.yml b/reference/carts.v3.yml index 201d8336c..78375f352 100644 --- a/reference/carts.v3.yml +++ b/reference/carts.v3.yml @@ -3156,6 +3156,10 @@ components: format: date-time description: Date and time when the metafield was last updated. example: '2022-06-16T18:39:00+00:00' + owner_client_id: + type: string + description: Client ID for the metafield's creator. + readOnly: true x-internal: false MetafieldBase: type: object diff --git a/reference/catalog/brands_catalog.v3.yml b/reference/catalog/brands_catalog.v3.yml index 7861f1552..6bd9dccbd 100644 --- a/reference/catalog/brands_catalog.v3.yml +++ b/reference/catalog/brands_catalog.v3.yml @@ -2089,6 +2089,10 @@ components: format: date-time description: Date and time when the metafield was last updated. example: '2022-06-16T18:39:00+00:00' + owner_client_id: + type: string + description: Client ID for the metafield's creator. + readOnly: true required: - namespace - key diff --git a/reference/catalog/categories_catalog.v3.yml b/reference/catalog/categories_catalog.v3.yml index 11372714f..36e20814b 100644 --- a/reference/catalog/categories_catalog.v3.yml +++ b/reference/catalog/categories_catalog.v3.yml @@ -2525,6 +2525,10 @@ components: format: date-time description: Date and time when the metafield was last updated. example: '2022-06-16T18:39:00+00:00' + owner_client_id: + type: string + description: Client ID for the metafield's creator. + readOnly: true required: - namespace - key diff --git a/reference/catalog/product-variants_catalog.v3.yml b/reference/catalog/product-variants_catalog.v3.yml index 9a23f8258..56931157f 100644 --- a/reference/catalog/product-variants_catalog.v3.yml +++ b/reference/catalog/product-variants_catalog.v3.yml @@ -2581,6 +2581,10 @@ components: format: date-time description: Date and time when the metafield was last updated. example: '2022-06-16T18:39:00+00:00' + owner_client_id: + type: string + description: Client ID for the metafield's creator. + readOnly: true required: - namespace - key diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml index 5f3e895ef..836f78370 100644 --- a/reference/catalog/products_catalog.v3.yml +++ b/reference/catalog/products_catalog.v3.yml @@ -8857,6 +8857,10 @@ components: format: date-time description: Date and time when the metafield was last updated. example: '2022-06-16T18:39:00+00:00' + owner_client_id: + type: string + description: Client ID for the metafield's creator. + readOnly: true required: - namespace - key diff --git a/reference/channels.v3.yml b/reference/channels.v3.yml index 7a55745b6..ef1746612 100644 --- a/reference/channels.v3.yml +++ b/reference/channels.v3.yml @@ -820,7 +820,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponse' '500': description: Internal Server Error put: @@ -2368,6 +2368,10 @@ components: format: date-time description: Date and time when the metafield was last updated. example: '2022-06-16T18:39:00+00:00' + owner_client_id: + type: string + description: Client ID for the metafield's creator. + readOnly: true required: - namespace - key diff --git a/reference/customers.v3.yml b/reference/customers.v3.yml index cbb31bfec..b8caaf764 100644 --- a/reference/customers.v3.yml +++ b/reference/customers.v3.yml @@ -4115,6 +4115,10 @@ components: format: date-time description: Date and time when the metafield was last updated. example: '2022-06-16T18:39:00+00:00' + owner_client_id: + type: string + description: Client ID for the metafield's creator. + readOnly: true required: - namespace - key diff --git a/reference/orders.v3.yml b/reference/orders.v3.yml index 03af2f15a..f80bd1266 100644 --- a/reference/orders.v3.yml +++ b/reference/orders.v3.yml @@ -2985,6 +2985,10 @@ components: description: | Date and time when the metafield was last updated. example: '2022-06-16T18:39:00+00:00' + owner_client_id: + type: string + description: Client ID for the metafield's creator. + readOnly: true x-internal: false x-examples: {} MetafieldPut: From 0e75220557bc91ba159b369d5e737f9fcfdf0e75 Mon Sep 17 00:00:00 2001 From: Sarah Riehl Date: Tue, 6 Feb 2024 15:41:57 -0600 Subject: [PATCH 22/41] update operation IDs --- reference/carts.v3.yml | 4 ++-- reference/catalog/brands_catalog.v3.yml | 10 +++++----- reference/catalog/categories_catalog.v3.yml | 8 ++++---- reference/catalog/product-variants_catalog.v3.yml | 6 +++--- reference/catalog/products_catalog.v3.yml | 6 +++--- reference/channels.v3.yml | 6 +++--- reference/customers.v3.yml | 4 ++-- reference/orders.v3.yml | 6 +++--- 8 files changed, 25 insertions(+), 25 deletions(-) diff --git a/reference/carts.v3.yml b/reference/carts.v3.yml index 78375f352..c3ef4b3b5 100644 --- a/reference/carts.v3.yml +++ b/reference/carts.v3.yml @@ -779,7 +779,7 @@ paths: tags: - Metafields description: Get all cart metafields. - operationId: getAllCartMetafields + operationId: getCartMetafields parameters: - $ref: '#/components/parameters/PageParam' - $ref: '#/components/parameters/LimitParam' @@ -1077,7 +1077,7 @@ paths: tags: - Metafields description: Delete all cart metafields. - operationId: deleteCartMetafields + operationId: deleteCartsMetafields requestBody: content: application/json: diff --git a/reference/catalog/brands_catalog.v3.yml b/reference/catalog/brands_catalog.v3.yml index 6bd9dccbd..b8f190f0f 100644 --- a/reference/catalog/brands_catalog.v3.yml +++ b/reference/catalog/brands_catalog.v3.yml @@ -633,7 +633,7 @@ paths: - Brands summary: Get a Brand description: Returns a single *Brand*. Optional filter parameters can be passed in. - operationId: getBrandById + operationId: getBrand parameters: - name: include_fields in: query @@ -1593,7 +1593,7 @@ paths: tags: - Metafields description: Get all brand metafields. - operationId: getAllBrandMetafields + operationId: getBrandsMetafields responses: '200': description: | @@ -1617,7 +1617,7 @@ paths: tags: - Metafields description: Create multiple metafields. - operationId: createBrandMetafields + operationId: createBrandsMetafields requestBody: content: application/json: @@ -1658,7 +1658,7 @@ paths: tags: - Metafields description: Create multiple metafields. - operationId: updateBrandMetafields + operationId: updateBrandsMetafields requestBody: content: application/json: @@ -1699,7 +1699,7 @@ paths: tags: - Metafields description: Delete all brand metafields. - operationId: deleteBrandMetafields + operationId: deleteBrandsMetafields requestBody: content: application/json: diff --git a/reference/catalog/categories_catalog.v3.yml b/reference/catalog/categories_catalog.v3.yml index 36e20814b..ebaaf97a8 100644 --- a/reference/catalog/categories_catalog.v3.yml +++ b/reference/catalog/categories_catalog.v3.yml @@ -1789,7 +1789,7 @@ paths: tags: - Metafields description: Get all category metafields. - operationId: getAllCategoryMetafields + operationId: getCategoriesMetafields responses: '200': description: | @@ -1813,7 +1813,7 @@ paths: tags: - Metafields description: Create multiple metafields. - operationId: createCategoryMetafields + operationId: createCategoriesMetafields requestBody: content: application/json: @@ -1854,7 +1854,7 @@ paths: tags: - Metafields description: Create multiple metafields. - operationId: updateCategoryMetafields + operationId: updateCategoriesMetafields requestBody: content: application/json: @@ -1895,7 +1895,7 @@ paths: tags: - Metafields description: Delete all category metafields. - operationId: deleteCategoryMetafields + operationId: deleteCategoriesMetafields requestBody: content: application/json: diff --git a/reference/catalog/product-variants_catalog.v3.yml b/reference/catalog/product-variants_catalog.v3.yml index 56931157f..03614e3dd 100644 --- a/reference/catalog/product-variants_catalog.v3.yml +++ b/reference/catalog/product-variants_catalog.v3.yml @@ -1761,7 +1761,7 @@ paths: tags: - Metafields description: Create multiple metafields. - operationId: createVariantMetafields + operationId: createVariantsMetafields requestBody: content: application/json: @@ -1802,7 +1802,7 @@ paths: tags: - Metafields description: Create multiple metafields. - operationId: updateVariantMetafields + operationId: updateVariantsMetafields requestBody: content: application/json: @@ -1843,7 +1843,7 @@ paths: tags: - Metafields description: Delete all variant metafields. - operationId: deleteVariantMetafields + operationId: deleteVariantsMetafields requestBody: content: application/json: diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml index 836f78370..d189076cb 100644 --- a/reference/catalog/products_catalog.v3.yml +++ b/reference/catalog/products_catalog.v3.yml @@ -6311,7 +6311,7 @@ paths: tags: - Metafields description: Create multiple metafields. - operationId: createProductMetafields + operationId: createProductsMetafields requestBody: content: application/json: @@ -6352,7 +6352,7 @@ paths: tags: - Metafields description: Create multiple metafields. - operationId: updateProductMetafields + operationId: updateProductsMetafields requestBody: content: application/json: @@ -6393,7 +6393,7 @@ paths: tags: - Metafields description: Delete all product metafields. - operationId: deleteProductMetafields + operationId: deleteProductsMetafields requestBody: content: application/json: diff --git a/reference/channels.v3.yml b/reference/channels.v3.yml index ef1746612..c7346afd3 100644 --- a/reference/channels.v3.yml +++ b/reference/channels.v3.yml @@ -797,7 +797,7 @@ paths: tags: - Channel Metafields description: Create multiple metafields. - operationId: createChannelMetafields + operationId: createChannelsMetafields requestBody: content: application/json: @@ -828,7 +828,7 @@ paths: tags: - Channel Metafields description: Create multiple metafields. - operationId: updateChannelMetafields + operationId: updateChannelsMetafields requestBody: content: application/json: @@ -859,7 +859,7 @@ paths: tags: - Channel Metafields description: Delete all channel metafields. - operationId: deleteChannelMetafields + operationId: deleteChannelsMetafields requestBody: content: application/json: diff --git a/reference/customers.v3.yml b/reference/customers.v3.yml index b8caaf764..4948d29ce 100644 --- a/reference/customers.v3.yml +++ b/reference/customers.v3.yml @@ -1652,7 +1652,7 @@ paths: tags: - Customer Metafields description: Create multiple metafields. - operationId: createCustomerMetafields + operationId: createCustomersMetafields requestBody: content: application/json: @@ -1734,7 +1734,7 @@ paths: tags: - Customer Metafields description: Delete all customer metafields. - operationId: deleteCustomerMetafields + operationId: deleteCustomersMetafields requestBody: content: application/json: diff --git a/reference/orders.v3.yml b/reference/orders.v3.yml index f80bd1266..1a9f7c191 100644 --- a/reference/orders.v3.yml +++ b/reference/orders.v3.yml @@ -903,7 +903,7 @@ paths: tags: - Metafields description: Create multiple metafields. - operationId: createOrderMetafields + operationId: createOrdersMetafields requestBody: content: application/json: @@ -944,7 +944,7 @@ paths: tags: - Metafields description: Create multiple metafields. - operationId: updateOrderMetafields + operationId: updateOrdersMetafields requestBody: content: application/json: @@ -985,7 +985,7 @@ paths: tags: - Metafields description: Delete all order metafields. - operationId: deleteOrderMetafields + operationId: deleteOrdersMetafields requestBody: content: application/json: From 32ac6d9c0c779d4bf048ef54704a8c7b4da18121 Mon Sep 17 00:00:00 2001 From: Sarah Riehl Date: Tue, 6 Feb 2024 17:03:15 -0600 Subject: [PATCH 23/41] update metafield types, replace apostrophes to fix syntax highlighting --- reference/carts.v3.yml | 30 ++--- reference/catalog/brands_catalog.v3.yml | 22 ++-- reference/catalog/categories_catalog.v3.yml | 60 +++++----- .../catalog/product-variants_catalog.v3.yml | 71 ++++++------ reference/catalog/products_catalog.v3.yml | 108 +++++++++--------- reference/channels.v3.yml | 52 ++++----- reference/customers.v3.yml | 24 ++-- reference/orders.v3.yml | 29 ++--- 8 files changed, 198 insertions(+), 198 deletions(-) diff --git a/reference/carts.v3.yml b/reference/carts.v3.yml index c3ef4b3b5..1ce4c4103 100644 --- a/reference/carts.v3.yml +++ b/reference/carts.v3.yml @@ -534,7 +534,7 @@ paths: - $ref: '#/components/parameters/Accept' - $ref: '#/components/parameters/cartId' get: - description: Returns a store's *Cart*. + description: Returns a storeʼs *Cart*. parameters: - name: include in: query @@ -561,7 +561,7 @@ paths: operationId: getCart put: description: |- - Updates a *Cart's* `customer_id`. + Updates a *Cartʼs* `customer_id`. **Notes** @@ -796,7 +796,7 @@ paths: $ref: '#/components/schemas/MetafieldResponse' '409': description: | - The `Metafield` conflicts with another `Metafield`. This can be the result of duplicate unique key combinations of the app's client id, namespace, key, resource_type, and resource_id. + The `Metafield` conflicts with another `Metafield`. This can be the result of duplicate unique key combinations of the appʼs client id, namespace, key, resource_type, and resource_id. content: application/json: schema: @@ -885,7 +885,7 @@ paths: $ref: '#/components/schemas/MetafieldResponse' '409': description: | - The `Metafield` conflicts with another `Metafield`. This can be the result of duplicate unique key combinations of the app's client id, namespace, key, resource_type, and resource_id. + The `Metafield` conflicts with another `Metafield`. This can be the result of duplicate unique key combinations of the appʼs client id, namespace, key, resource_type, and resource_id. content: application/json: schema: @@ -1010,7 +1010,7 @@ paths: type: string example: "42" description: | - The id for the cart with which the metafield is associated. + The ID for the cart with which the metafield is associated. required: - resource_id description: '' @@ -1051,7 +1051,7 @@ paths: type: string example: "42" description: | - The id of metafield to update. + The ID of metafield to update. required: - id description: '' @@ -2262,7 +2262,7 @@ components: description: SKU of the variant. name: type: string - description: The item's product name. + description: The itemʼs product name. example: T-Shirt url: description: The product URL. @@ -2509,7 +2509,7 @@ components: type: object title: Item Custom description: |- - Add a custom item to the shopper's cart. + Add a custom item to the shopperʼs cart. * Custom items are not added to the catalog. * The price should be set to match the store settings for taxes. @@ -2533,7 +2533,7 @@ components: type: object title: Item Custom description: |- - Add a custom item to the shopper's cart. + Add a custom item to the shopperʼs cart. * Custom items are not added to the catalog. * The price should be set to match the store settings for taxes. @@ -3149,7 +3149,7 @@ components: date_created: type: string format: date-time - description: Date and time of the metafield's creation. + description: Date and time of the metafieldʼs creation. example: '2022-06-16T18:39:00+00:00' date_modified: type: string @@ -3158,7 +3158,7 @@ components: example: '2022-06-16T18:39:00+00:00' owner_client_id: type: string - description: Client ID for the metafield's creator. + description: Client ID for the metafieldʼs creator. readOnly: true x-internal: false MetafieldBase: @@ -3593,14 +3593,14 @@ components: MetafieldKeyParam: name: key in: query - description: Filter based on a metafield's key. + description: Filter based on a metafieldʼs key. required: false schema: type: string MetafieldKeyInParam: name: key:in in: query - description: Filter based on comma separated metafieldʼs keys. Could be used with vanila 'key' query parameter. + description: Filter based on comma separated metafieldʼs keys. Could be used with vanilla `key` query parameter. required: false style: form explode: false @@ -3611,14 +3611,14 @@ components: MetafieldNamespaceParam: name: namespace in: query - description: Filter based on a metafield's namespaces. + description: Filter based on a metafieldʼs namespaces. required: false schema: type: string MetafieldNamespaceInParam: name: namespace:in in: query - description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanila 'namespace' query parameter. + description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. required: false style: form explode: false diff --git a/reference/catalog/brands_catalog.v3.yml b/reference/catalog/brands_catalog.v3.yml index b8f190f0f..136afeb9f 100644 --- a/reference/catalog/brands_catalog.v3.yml +++ b/reference/catalog/brands_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](/docs/store-operations/catalog). - Our Catalog Brands endpoints let you [create individual brands](/docs/rest-catalog/brands#create-a-brand) and [modify the brands](/docs/rest-catalog/brands#update-a-brand) associated with a store's products, along with [deleting brands](/docs/rest-catalog/brands#delete-a-brand). + Our Catalog Brands endpoints let you [create individual brands](/docs/rest-catalog/brands#create-a-brand) and [modify the brands](/docs/rest-catalog/brands#update-a-brand) associated with a storeʼs products, along with [deleting brands](/docs/rest-catalog/brands#delete-a-brand). Brand images have their own dedicated [create a brand image](/docs/rest-catalog/brands/images#create-a-brand-image) and [delete a brand image](/docs/rest-catalog/brands/images#delete-a-brand-image) endpoints. @@ -1065,12 +1065,12 @@ paths: - name: key in: query description: | - Filter based on a metafield's key. + Filter based on a metafieldʼs key. schema: type: string - name: namespace in: query - description: Filter based on a metafield's namespace. + description: Filter based on a metafieldʼs namespace. schema: type: string - name: include_fields @@ -1237,7 +1237,7 @@ paths: meta: {} '409': description: | - The `Metafield` was in conflict with another `Metafield`. This can be the result of duplicate unique key combination of the app's client id, namespace, key, resource_type, and resource_id. + The `Metafield` was in conflict with another `Metafield`. This can be the result of duplicate unique key combination of the appʼs client id, namespace, key, resource_type, and resource_id. content: application/json: schema: @@ -1632,7 +1632,7 @@ paths: type: string example: "42" description: | - The id for the cart with which the metafield is associated. + The ID for the brand with which the metafield is associated. required: - resource_id description: '' @@ -1673,7 +1673,7 @@ paths: type: integer example: 42 description: | - The id of metafield to update. + The ID of metafield to update. required: - id description: '' @@ -1707,7 +1707,7 @@ paths: type: array items: type: integer - description: "List of metafield `id`s." + description: List of metafield IDs. responses: '200': description: | @@ -1992,7 +1992,7 @@ components: date_created: type: string description: | - Date and time of the metafield's creation. Read-Only. + Date and time of the metafieldʼs creation. Read-Only. readOnly: true format: date-time example: '2018-05-07T20:14:17+00:00' @@ -2091,7 +2091,7 @@ components: example: '2022-06-16T18:39:00+00:00' owner_client_id: type: string - description: Client ID for the metafield's creator. + description: Client ID for the metafieldʼs creator. readOnly: true required: - namespace @@ -2467,7 +2467,7 @@ components: MetafieldKeyInParam: name: key:in in: query - description: Filter based on comma separated metafieldʼs keys. Could be used with vanila 'key' query parameter. + description: Filter based on comma separated metafieldʼs keys. Could be used with vanilla `key` query parameter. required: false style: form explode: false @@ -2485,7 +2485,7 @@ components: MetafieldNamespaceInParam: name: namespace:in in: query - description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanila 'namespace' query parameter. + description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. required: false style: form explode: false diff --git a/reference/catalog/categories_catalog.v3.yml b/reference/catalog/categories_catalog.v3.yml index ebaaf97a8..f0fc0ff04 100644 --- a/reference/catalog/categories_catalog.v3.yml +++ b/reference/catalog/categories_catalog.v3.yml @@ -389,7 +389,7 @@ paths: parent_id: type: integer description: |- - The unique numeric ID of the category's parent. This field controls where the category sits in the tree of categories that organize the catalog. + The unique numeric ID of the categoryʼs parent. This field controls where the category sits in the tree of categories that organize the catalog. Required in a POST if creating a child category. example: 2 x-required: @@ -399,7 +399,7 @@ paths: minLength: 1 type: string description: |- - The name displayed for the category. Name is unique with respect to the category's siblings. + The name displayed for the category. Name is unique with respect to the categoryʼs siblings. Required in a POST. example: Bath x-required: @@ -437,7 +437,7 @@ paths: meta_keywords: type: array description: | - Custom meta keywords for the category page. If not defined, the store's default keywords will be used. Must post as an array like: ["awesome","sauce"]. + Custom meta keywords for the category page. If not defined, the storeʼs default keywords will be used. Must post as an array like: ["awesome","sauce"]. items: type: string meta_description: @@ -445,7 +445,7 @@ paths: minLength: 0 type: string description: | - Custom meta description for the category page. If not defined, the store's default meta description will be used. + Custom meta description for the category page. If not defined, the storeʼs default meta description will be used. layout_file: maxLength: 500 minLength: 0 @@ -831,7 +831,7 @@ paths: parent_id: type: integer description: |- - The unique numeric ID of the category's parent. This field controls where the category sits in the tree of categories that organize the catalog. + The unique numeric ID of the categoryʼs parent. This field controls where the category sits in the tree of categories that organize the catalog. Required in a POST if creating a child category. example: 2 x-required: @@ -841,7 +841,7 @@ paths: minLength: 1 type: string description: |- - The name displayed for the category. Name is unique with respect to the category's siblings. + The name displayed for the category. Name is unique with respect to the categoryʼs siblings. Required in a POST. example: Bath x-required: @@ -879,7 +879,7 @@ paths: meta_keywords: type: array description: | - Custom meta keywords for the category page. If not defined, the store's default keywords will be used. Must post as an array like: ["awesome","sauce"]. + Custom meta keywords for the category page. If not defined, the storeʼs default keywords will be used. Must post as an array like: ["awesome","sauce"]. items: type: string meta_description: @@ -887,7 +887,7 @@ paths: minLength: 0 type: string description: | - Custom meta description for the category page. If not defined, the store's default meta description will be used. + Custom meta description for the category page. If not defined, the storeʼs default meta description will be used. layout_file: maxLength: 500 minLength: 0 @@ -969,7 +969,7 @@ paths: parent_id: type: integer description: |- - The unique numeric ID of the category's parent. This field controls where the category sits in the tree of categories that organize the catalog. + The unique numeric ID of the categoryʼs parent. This field controls where the category sits in the tree of categories that organize the catalog. Required in a POST if creating a child category. example: 2 x-required: @@ -979,7 +979,7 @@ paths: minLength: 1 type: string description: |- - The name displayed for the category. Name is unique with respect to the category's siblings. + The name displayed for the category. Name is unique with respect to the categoryʼs siblings. Required in a POST. example: Bath x-required: @@ -1017,7 +1017,7 @@ paths: meta_keywords: type: array description: | - Custom meta keywords for the category page. If not defined, the store's default keywords will be used. Must post as an array like: ["awesome","sauce"]. + Custom meta keywords for the category page. If not defined, the storeʼs default keywords will be used. Must post as an array like: ["awesome","sauce"]. items: type: string meta_description: @@ -1025,7 +1025,7 @@ paths: minLength: 0 type: string description: | - Custom meta description for the category page. If not defined, the store's default meta description will be used. + Custom meta description for the category page. If not defined, the storeʼs default meta description will be used. layout_file: maxLength: 500 minLength: 0 @@ -1255,12 +1255,12 @@ paths: - name: key in: query description: | - Filter based on a metafield's key. + Filter based on a metafieldʼs key. schema: type: string - name: namespace in: query - description: Filter based on a metafield's namespace. + description: Filter based on a metafieldʼs namespace. schema: type: string - name: include_fields @@ -1394,7 +1394,7 @@ paths: meta: {} '409': description: | - The `Metafield` was in conflict with another `Metafield`. This can be the result of duplicate, unique key combinations of the app's client id, namespace, key, resource_type, and resource_id. + The `Metafield` was in conflict with another `Metafield`. This can be the result of duplicate, unique key combinations of the appʼs client id, namespace, key, resource_type, and resource_id. content: application/json: schema: @@ -1828,7 +1828,7 @@ paths: type: string example: "42" description: | - The id for the cart with which the metafield is associated. + The ID for the category with which the metafield is associated. required: - resource_id description: '' @@ -1869,7 +1869,7 @@ paths: type: string example: "42" description: | - The id of metafield to update. + The ID of metafield to update. required: - id description: '' @@ -1903,7 +1903,7 @@ paths: type: array items: type: integer - description: "List of metafield `id`s." + description: List of metafield IDs. responses: '200': description: | @@ -1936,7 +1936,7 @@ components: parent_id: type: integer description: |- - The unique numeric ID of the category's parent. This field controls where the category sits in the tree of categories that organize the catalog. + The unique numeric ID of the categoryʼs parent. This field controls where the category sits in the tree of categories that organize the catalog. Required in a POST if creating a child category. example: 2 x-required: @@ -1946,7 +1946,7 @@ components: minLength: 1 type: string description: |- - The name displayed for the category. Name is unique with respect to the category's siblings. + The name displayed for the category. Name is unique with respect to the categoryʼs siblings. Required in a POST. example: Bath x-required: @@ -1984,7 +1984,7 @@ components: meta_keywords: type: array description: | - Custom meta keywords for the category page. If not defined, the store's default keywords will be used. Must post as an array like: ["awesome","sauce"]. + Custom meta keywords for the category page. If not defined, the storeʼs default keywords will be used. Must post as an array like: ["awesome","sauce"]. items: type: string meta_description: @@ -1992,7 +1992,7 @@ components: minLength: 0 type: string description: | - Custom meta description for the category page. If not defined, the store's default meta description will be used. + Custom meta description for the category page. If not defined, the storeʼs default meta description will be used. layout_file: maxLength: 500 minLength: 0 @@ -2234,7 +2234,7 @@ components: date_created: type: string description: | - Date and time of the metafield's creation. Read-Only. + Date and time of the metafieldʼs creation. Read-Only. readOnly: true format: date-time example: '2018-05-07T20:14:17+00:00' @@ -2324,7 +2324,7 @@ components: minLength: 1 type: string description: |- - The name displayed for the category. Name is unique with respect to the category's siblings. + The name displayed for the category. Name is unique with respect to the categoryʼs siblings. Required in a POST. example: Bath description: @@ -2378,7 +2378,7 @@ components: meta_keywords: type: array description: | - Custom meta keywords for the category page. If not defined, the store's default keywords will be used. Must post as an array like: ["awesome","sauce"]. + Custom meta keywords for the category page. If not defined, the storeʼs default keywords will be used. Must post as an array like: ["awesome","sauce"]. items: type: string layout_file: @@ -2419,7 +2419,7 @@ components: minLength: 0 type: string description: | - Custom meta description for the category page. If not defined, the store's default meta description will be used. + Custom meta description for the category page. If not defined, the storeʼs default meta description will be used. id: title: id type: object @@ -2437,7 +2437,7 @@ components: parent_id: type: integer description: |- - The unique numeric ID of the category's parent. This field controls where the category sits in the tree of categories that organize the catalog. + The unique numeric ID of the categoryʼs parent. This field controls where the category sits in the tree of categories that organize the catalog. Required in a POST if creating a child category. example: 2 Metafield: @@ -2527,7 +2527,7 @@ components: example: '2022-06-16T18:39:00+00:00' owner_client_id: type: string - description: Client ID for the metafield's creator. + description: Client ID for the metafieldʼs creator. readOnly: true required: - namespace @@ -2905,7 +2905,7 @@ components: MetafieldKeyInParam: name: key:in in: query - description: Filter based on comma separated metafieldʼs keys. Could be used with vanila 'key' query parameter. + description: Filter based on comma separated metafieldʼs keys. Could be used with vanilla `key` query parameter. required: false style: form explode: false @@ -2923,7 +2923,7 @@ components: MetafieldNamespaceInParam: name: namespace:in in: query - description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanila 'namespace' query parameter. + description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. required: false style: form explode: false diff --git a/reference/catalog/product-variants_catalog.v3.yml b/reference/catalog/product-variants_catalog.v3.yml index 03614e3dd..0787e1e8e 100644 --- a/reference/catalog/product-variants_catalog.v3.yml +++ b/reference/catalog/product-variants_catalog.v3.yml @@ -580,7 +580,6 @@ paths: required: true schema: type: integer - - name: page in: query description: Specifies the page number in a limited (paginated) list of products. @@ -594,12 +593,12 @@ paths: - name: key in: query description: | - Filter based on a metafield's key. + Filter based on a metafieldʼs key. schema: type: string - name: namespace in: query - description: Filter based on a metafield's namespace. + description: Filter based on a metafieldʼs namespace. schema: type: string - name: include_fields @@ -709,7 +708,7 @@ paths: meta: {} '409': description: | - The `Metafield` was in conflict with another `Metafield`. This can be the result of duplicate unique-key combinations of the app's client id, namespace, key, resource_type, and resource_id. + The `Metafield` was in conflict with another `Metafield`. This can be the result of duplicate unique-key combinations of the appʼs client id, namespace, key, resource_type, and resource_id. content: application/json: schema: @@ -1166,21 +1165,21 @@ paths: minimum: 0 type: number description: | - Width of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default width (set in the Product resource's `width` field) will be used as the base width. + Width of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default width (set in the Product resourceʼs `width` field) will be used as the base width. format: double x-nullable: true height: minimum: 0 type: number description: | - Height of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default height (set in the Product resource's `height` field) will be used as the base height. + Height of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default height (set in the Product resourceʼs `height` field) will be used as the base height. format: double x-nullable: true depth: minimum: 0 type: number description: | - Depth of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default depth (set in the Product resource's `depth` field) will be used as the base depth. + Depth of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default depth (set in the Product resourceʼs `depth` field) will be used as the base depth. format: double x-nullable: true is_free_shipping: @@ -1240,11 +1239,11 @@ paths: type: string sku_id: type: integer - description: Read-only reference to v2 API's SKU ID. Null if it is a base variant. + description: Read-only reference to v2 APIʼs SKU ID. Null if it is a base variant. x-nullable: true option_values: type: array - description: Array of option and option values IDs that make up this variant. Will be empty if the variant is the product's base variant. + description: Array of option and option values IDs that make up this variant. Will be empty if the variant is the productʼs base variant. items: title: Option Value Variant type: object @@ -1314,7 +1313,7 @@ paths: **Required Fields** To update an existing variant: - * id (variant id) + * id (variant ID) To create a new variant: * product_id @@ -1380,7 +1379,7 @@ paths: minimum: 0 type: number description: | - Width of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default width (set in the Product resource's `width` field) will be used as the base width. + Width of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default width (set in the Product resourceʼs `width` field) will be used as the base width. format: double x-nullable: true example: 5 @@ -1388,7 +1387,7 @@ paths: minimum: 0 type: number description: | - Height of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default height (set in the Product resource's `height` field) will be used as the base height. + Height of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default height (set in the Product resourceʼs `height` field) will be used as the base height. format: double x-nullable: true example: 5 @@ -1396,7 +1395,7 @@ paths: minimum: 0 type: number description: | - Depth of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default depth (set in the Product resource's `depth` field) will be used as the base depth. + Depth of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default depth (set in the Product resourceʼs `depth` field) will be used as the base depth. format: double x-nullable: true example: 5 @@ -1509,21 +1508,21 @@ paths: minimum: 0 type: number description: | - Width of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default width (set in the Product resource's `width` field) will be used as the base width. + Width of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default width (set in the Product resourceʼs `width` field) will be used as the base width. format: double x-nullable: true height: minimum: 0 type: number description: | - Height of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default height (set in the Product resource's `height` field) will be used as the base height. + Height of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default height (set in the Product resourceʼs `height` field) will be used as the base height. format: double x-nullable: true depth: minimum: 0 type: number description: | - Depth of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default depth (set in the Product resource's `depth` field) will be used as the base depth. + Depth of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default depth (set in the Product resourceʼs `depth` field) will be used as the base depth. format: double x-nullable: true is_free_shipping: @@ -1583,11 +1582,11 @@ paths: type: string sku_id: type: integer - description: Read-only reference to v2 API's SKU ID. Null if it is a base variant. + description: Read-only reference to v2 APIʼs SKU ID. Null if it is a base variant. x-nullable: true option_values: type: array - description: Array of option and option values IDs that make up this variant. Will be empty if the variant is the product's base variant. + description: Array of option and option values IDs that make up this variant. Will be empty if the variant is the productʼs base variant. items: title: Option Value Variant type: object @@ -1776,7 +1775,7 @@ paths: type: string example: "42" description: | - The id for the cart with which the metafield is associated. + The ID for the product variant with which the metafield is associated. required: - resource_id description: '' @@ -1817,7 +1816,7 @@ paths: type: integer example: 42 description: | - The id of metafield to update. + The ID of metafield to update. required: - id description: '' @@ -1851,7 +1850,7 @@ paths: type: array items: type: integer - description: "List of metafield `id`s." + description: List of metafield IDs. responses: '200': description: | @@ -1894,12 +1893,12 @@ components: parent_id: type: integer description: | - The unique numeric ID of the category's parent. This field controls where the category sits in the tree of categories that organize the catalog. + The unique numeric ID of the categoryʼs parent. This field controls where the category sits in the tree of categories that organize the catalog. example: 25 name: type: string description: | - The name displayed for the category. Name is unique with respect to the category's siblings. + The name displayed for the category. Name is unique with respect to the categoryʼs siblings. example: Bath is_visible: type: boolean @@ -1951,21 +1950,21 @@ components: minimum: 0 type: number description: | - Width of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default width (set in the Product resource's `width` field) will be used as the base width. + Width of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default width (set in the Product resourceʼs `width` field) will be used as the base width. format: double nullable: true height: minimum: 0 type: number description: | - Height of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default height (set in the Product resource's `height` field) will be used as the base height. + Height of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default height (set in the Product resourceʼs `height` field) will be used as the base height. format: double nullable: true depth: minimum: 0 type: number description: | - Depth of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default depth (set in the Product resource's `depth` field) will be used as the base depth. + Depth of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default depth (set in the Product resourceʼs `depth` field) will be used as the base depth. format: double nullable: true is_free_shipping: @@ -2056,11 +2055,11 @@ components: type: string sku_id: type: integer - description: Read-only reference to v2 API's SKU ID. Null if it is a base variant. + description: Read-only reference to v2 APIʼs SKU ID. Null if it is a base variant. nullable: true option_values: type: array - description: Array of option and option values IDs that make up this variant. Will be empty if the variant is the product's base variant. + description: Array of option and option values IDs that make up this variant. Will be empty if the variant is the productʼs base variant. items: $ref: '#/components/schemas/productVariantOptionValue_Full' calculated_price: @@ -2145,21 +2144,21 @@ components: minimum: 0 type: number description: | - Width of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default width (set in the Product resource's `width` field) will be used as the base width. + Width of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default width (set in the Product resourceʼs `width` field) will be used as the base width. format: double nullable: true height: minimum: 0 type: number description: | - Height of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default height (set in the Product resource's `height` field) will be used as the base height. + Height of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default height (set in the Product resourceʼs `height` field) will be used as the base height. format: double nullable: true depth: minimum: 0 type: number description: | - Depth of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default depth (set in the Product resource's `depth` field) will be used as the base depth. + Depth of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default depth (set in the Product resourceʼs `depth` field) will be used as the base depth. format: double nullable: true is_free_shipping: @@ -2234,7 +2233,7 @@ components: - post option_values: type: array - description: Array of option and option values IDs that make up this variant. Will be empty if the variant is the product's base variant. + description: Array of option and option values IDs that make up this variant. Will be empty if the variant is the productʼs base variant. items: $ref: '#/components/schemas/productVariantOptionValue_Full' x-required: @@ -2466,7 +2465,7 @@ components: date_created: type: string description: | - Date and time of the metafield's creation. Read-Only. + Date and time of the metafieldʼs creation. Read-Only. readOnly: true format: date-time example: '2018-05-07T20:14:17+00:00' @@ -2583,7 +2582,7 @@ components: example: '2022-06-16T18:39:00+00:00' owner_client_id: type: string - description: Client ID for the metafield's creator. + description: Client ID for the metafieldʼs creator. readOnly: true required: - namespace @@ -2962,7 +2961,7 @@ components: MetafieldKeyInParam: name: key:in in: query - description: Filter based on comma separated metafieldʼs keys. Could be used with vanila 'key' query parameter. + description: Filter based on comma separated metafieldʼs keys. Could be used with vanilla `key` query parameter. required: false style: form explode: false @@ -2980,7 +2979,7 @@ components: MetafieldNamespaceInParam: name: namespace:in in: query - description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanila 'namespace' query parameter. + description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. required: false style: form explode: false diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml index d189076cb..1d36c3ca6 100644 --- a/reference/catalog/products_catalog.v3.yml +++ b/reference/catalog/products_catalog.v3.yml @@ -1225,7 +1225,7 @@ paths: > The maximum number of products you can delete at one time is 250. **Example**: - To delete products with the id's of 1,2 and 3, use `DELETE /v3/catalog/products?id:in=1,2,3`. + To delete products with IDs 1,2 and 3, use `DELETE /v3/catalog/products?id:in=1,2,3`. operationId: deleteProducts parameters: - name: name @@ -2042,13 +2042,13 @@ paths: is_thumbnail: type: boolean description: | - Flag for identifying whether the image is used as the product's thumbnail. + Flag for identifying whether the image is used as the productʼs thumbnail. sort_order: maximum: 2147483647 minimum: -2147483648 type: integer description: | - The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the image's new `sort_order` value will have their `sort_order`s reordered. + The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the imageʼs new `sort_order` value will have their `sort_order`s reordered. description: type: string description: | @@ -2110,13 +2110,13 @@ paths: is_thumbnail: type: boolean description: | - Flag for identifying whether the image is used as the product's thumbnail. + Flag for identifying whether the image is used as the productʼs thumbnail. sort_order: maximum: 2147483647 minimum: -2147483648 type: integer description: | - The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the image's new `sort_order` value will have their `sort_order`s reordered. + The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the imageʼs new `sort_order` value will have their `sort_order`s reordered. description: type: string description: | @@ -2187,13 +2187,13 @@ paths: is_thumbnail: type: boolean description: | - Flag for identifying whether the image is used as the product's thumbnail. + Flag for identifying whether the image is used as the productʼs thumbnail. sort_order: maximum: 2147483647 minimum: -2147483648 type: integer description: | - The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the image's new `sort_order` value will have their `sort_order`s reordered. + The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the imageʼs new `sort_order` value will have their `sort_order`s reordered. description: type: string description: | @@ -2464,13 +2464,13 @@ paths: is_thumbnail: type: boolean description: | - Flag for identifying whether the image is used as the product's thumbnail. + Flag for identifying whether the image is used as the productʼs thumbnail. sort_order: maximum: 2147483647 minimum: -2147483648 type: integer description: | - The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the image's new `sort_order` value will have their `sort_order`s reordered. + The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the imageʼs new `sort_order` value will have their `sort_order`s reordered. description: type: string description: | @@ -2664,7 +2664,7 @@ paths: sort_order: 3 title: TOP WORKPLACES 2016 - Austin American Statesman + BigCommerce description: |- - We've been named one of Austin American-Statesman's Top WorkPlaces for the 5th year in a row! Here's what some employees have to say: + We've been named one of Austin American-Statesmanʼs Top WorkPlaces for the 5th year in a row! Hereʼs what some employees have to say: “I am given the freedom and trust to make a difference.” @@ -2731,7 +2731,7 @@ paths: example: 1 type: integer description: | - The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a `sort_order` the same as or greater than the video's new `sort_order` value will have their `sort_order`s reordered. + The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a `sort_order` the same as or greater than the videoʼs new `sort_order` value will have their `sort_order`s reordered. type: type: string description: | @@ -2783,7 +2783,7 @@ paths: minimum: -2147483648 type: integer description: | - The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a `sort_order` the same as or greater than the video's new `sort_order` value will have their `sort_order`s reordered. + The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a `sort_order` the same as or greater than the videoʼs new `sort_order` value will have their `sort_order`s reordered. type: type: string description: | @@ -2945,7 +2945,7 @@ paths: minimum: -2147483648 type: integer description: | - The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a `sort_order` the same as or greater than the video's new `sort_order` value will have their `sort_order`s reordered. + The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a `sort_order` the same as or greater than the videoʼs new `sort_order` value will have their `sort_order`s reordered. type: type: string description: | @@ -2995,7 +2995,7 @@ paths: minimum: -2147483648 type: integer description: | - The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a `sort_order` the same as or greater than the video's new `sort_order` value will have their `sort_order`s reordered. + The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a `sort_order` the same as or greater than the videoʼs new `sort_order` value will have their `sort_order`s reordered. type: type: string description: | @@ -3207,7 +3207,7 @@ paths: enabled: type: boolean description: | - Flag for determining whether the rule is to be used when adjusting a product's price, weight, image, or availabilty. + Flag for determining whether the rule is to be used when adjusting a productʼs price, weight, image, or availabilty. example: true stop: type: boolean @@ -3339,7 +3339,7 @@ paths: enabled: type: boolean description: | - Flag for determining whether the rule is to be used when adjusting a product's price, weight, image, or availabilty. + Flag for determining whether the rule is to be used when adjusting a productʼs price, weight, image, or availabilty. example: true stop: type: boolean @@ -3563,7 +3563,7 @@ paths: enabled: type: boolean description: | - Flag for determining whether the rule is to be used when adjusting a product's price, weight, image, or availabilty. + Flag for determining whether the rule is to be used when adjusting a productʼs price, weight, image, or availabilty. example: true stop: type: boolean @@ -3736,7 +3736,7 @@ paths: enabled: type: boolean description: | - Flag for determining whether the rule is to be used when adjusting a product's price, weight, image, or availabilty. + Flag for determining whether the rule is to be used when adjusting a productʼs price, weight, image, or availabilty. example: true stop: type: boolean @@ -3867,7 +3867,7 @@ paths: enabled: type: boolean description: | - Flag for determining whether the rule is to be used when adjusting a product's price, weight, image, or availabilty. + Flag for determining whether the rule is to be used when adjusting a productʼs price, weight, image, or availabilty. example: true stop: type: boolean @@ -5065,12 +5065,12 @@ paths: - name: key in: query description: | - Filter based on a metafield's key. + Filter based on a metafieldʼs key. schema: type: string - name: namespace in: query - description: Filter based on a metafield's namespace. + description: Filter based on a metafieldʼs namespace. schema: type: string - name: include_fields @@ -5201,7 +5201,7 @@ paths: meta: {} '409': description: | - The `Metafield` was in conflict with another `Metafield`. This can be the result of duplicate unique key combinations of the app's client ID, namespace, key, resource_type, and resource_id. + The `Metafield` was in conflict with another `Metafield`. This can be the result of duplicate unique key combinations of the appʼs client ID, namespace, key, resource_type, and resource_id. content: application/json: schema: @@ -6239,7 +6239,7 @@ paths: inventory_value: type: number description: | - Total value of store's inventory. + Total value of storeʼs inventory. format: double example: 267000 primary_category_id: @@ -6326,7 +6326,7 @@ paths: type: string example: "42" description: | - The id for the cart with which the metafield is associated. + The ID for the product with which the metafield is associated. required: - resource_id description: '' @@ -6367,7 +6367,7 @@ paths: type: integer example: 42 description: | - The id of metafield to update. + The ID of metafield to update. required: - id description: '' @@ -6401,7 +6401,7 @@ paths: type: array items: type: integer - description: "List of metafield `id`s." + description: List of metafield IDs. responses: '200': description: | @@ -6632,21 +6632,21 @@ components: minimum: 0 type: number description: | - Width of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default width (set in the Product resource's `width` field) will be used as the base width. + Width of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default width (set in the Product resourceʼs `width` field) will be used as the base width. format: double nullable: true height: minimum: 0 type: number description: | - Height of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default height (set in the Product resource's `height` field) will be used as the base height. + Height of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default height (set in the Product resourceʼs `height` field) will be used as the base height. format: double nullable: true depth: minimum: 0 type: number description: | - Depth of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default depth (set in the Product resource's `depth` field) will be used as the base depth. + Depth of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default depth (set in the Product resourceʼs `depth` field) will be used as the base depth. format: double nullable: true is_free_shipping: @@ -6735,7 +6735,7 @@ components: type: string option_values: type: array - description: Array of option and option values IDs that make up this variant. Will be empty if the variant is the product's base variant. + description: Array of option and option values IDs that make up this variant. Will be empty if the variant is the productʼs base variant. items: $ref: '#/components/schemas/productVariantOptionValue_Full' calculated_price: @@ -6818,21 +6818,21 @@ components: minimum: 0 type: number description: | - Width of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default width (set in the Product resource's `width` field) will be used as the base width. + Width of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default width (set in the Product resourceʼs `width` field) will be used as the base width. format: double nullable: true height: minimum: 0 type: number description: | - Height of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default height (set in the Product resource's `height` field) will be used as the base height. + Height of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default height (set in the Product resourceʼs `height` field) will be used as the base height. format: double nullable: true depth: minimum: 0 type: number description: | - Depth of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default depth (set in the Product resource's `depth` field) will be used as the base depth. + Depth of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default depth (set in the Product resourceʼs `depth` field) will be used as the base depth. format: double nullable: true is_free_shipping: @@ -6999,13 +6999,13 @@ components: is_thumbnail: type: boolean description: | - Flag for identifying whether the image is used as the product's thumbnail. + Flag for identifying whether the image is used as the productʼs thumbnail. sort_order: maximum: 2147483647 minimum: -2147483648 type: integer description: | - The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the image's new `sort_order` value will have their `sort_order`s reordered. + The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the imageʼs new `sort_order` value will have their `sort_order`s reordered. description: type: string description: | @@ -7073,7 +7073,7 @@ components: maximum: 2147483647 minimum: -2147483648 description: | - The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a `sort_order` the same as or greater than the video's new `sort_order` value will have their `sort_order`s reordered. + The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a `sort_order` the same as or greater than the videoʼs new `sort_order` value will have their `sort_order`s reordered. example: 1 type: type: string @@ -7210,7 +7210,7 @@ components: enabled: type: boolean description: | - Flag for determining whether the rule is to be used when adjusting a product's price, weight, image, or availabilty. + Flag for determining whether the rule is to be used when adjusting a productʼs price, weight, image, or availabilty. example: true stop: type: boolean @@ -7563,11 +7563,11 @@ components: product_list_adjusts_pricing: type: boolean description: | - (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price. + (product_list, product_list_with_images) Flag to add the optional productʼs price to the main productʼs price. product_list_shipping_calc: type: string description: | - (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: `none` - don't adjust; `weight` - use shipping weight only; `package` - use weight and dimensions. + (product_list, product_list_with_images) How to factor the optional productʼs weight and package dimensions into the shipping quote. Values: `none` - donʼt adjust; `weight` - use shipping weight only; `package` - use weight and dimensions. example: weight enum: - none @@ -8042,11 +8042,11 @@ components: product_list_adjusts_pricing: type: boolean description: | - (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price. + (product_list, product_list_with_images) Flag to add the optional productʼs price to the main productʼs price. product_list_shipping_calc: type: string description: | - (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: `none` - don't adjust; `weight` - use shipping weight only; `package` - use weight and dimensions. + (product_list, product_list_with_images) How to factor the optional productʼs weight and package dimensions into the shipping quote. Values: `none` - donʼt adjust; `weight` - use shipping weight only; `package` - use weight and dimensions. example: weight enum: - none @@ -8272,7 +8272,7 @@ components: minimum: 0 type: number description: | - If entered, the sale price will be used instead of value in the price field when calculating the product's cost. + If entered, the sale price will be used instead of value in the price field when calculating the productʼs cost. format: float map_price: type: number @@ -8288,7 +8288,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, 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. categories: type: array description: | @@ -8324,7 +8324,7 @@ components: minimum: 0 type: integer description: | - Inventory warning level for the product. When the product's inventory level drops below the warning level, the store owner will be informed. Simple inventory tracking must be enabled (see the `inventory_tracking` field) for this to take any effect. + Inventory warning level for the product. When the productʼs inventory level drops below the warning level, the store owner will be informed. Simple inventory tracking must be enabled (see the `inventory_tracking` field) for this to take any effect. inventory_tracking: type: string description: | @@ -8396,7 +8396,7 @@ components: availability: type: string description: | - Availability of the product. (Corresponds to the product's [Purchasability](https://support.bigcommerce.com/s/article/Adding-Products-v3?language=en_US#sections) section in the control panel.) Supported values: `available` - the product is available for purchase; `disabled` - the product is listed on the storefront, but cannot be purchased; `preorder` - the product is listed for pre-orders. + Availability of the product. (Corresponds to the productʼs [Purchasability](https://support.bigcommerce.com/s/article/Adding-Products-v3?language=en_US#sections) section in the control panel.) Supported values: `available` - the product is available for purchase; `disabled` - the product is listed on the storefront, but cannot be purchased; `preorder` - the product is listed for pre-orders. enum: - available - disabled @@ -8428,7 +8428,7 @@ components: condition: type: string description: | - The product condition. Will be shown on the product page if the `is_condition_shown` field's value is `true`. Possible values: `New`, `Used`, `Refurbished`. + The product condition. Will be shown on the product page if the `is_condition_shown` fieldʼs value is `true`. Possible values: `New`, `Used`, `Refurbished`. enum: - New - Used @@ -8460,7 +8460,7 @@ components: maxLength: 65535 minLength: 0 description: | - Custom meta keywords for the product page. If not defined, the store's default keywords will be used. + Custom meta keywords for the product page. If not defined, the storeʼs default keywords will be used. items: type: string meta_description: @@ -8468,7 +8468,7 @@ components: minLength: 0 type: string description: | - Custom meta description for the product page. If not defined, the store's default meta description will be used. + Custom meta description for the product page. If not defined, the storeʼs default meta description will be used. view_count: maximum: 1000000000 minimum: 0 @@ -8479,7 +8479,7 @@ components: preorder_release_date: type: string description: | - Pre-order release date. See the `availability` field for details on setting a product's availability to accept pre-orders. + Pre-order release date. See the `availability` field for details on setting a productʼs availability to accept pre-orders. format: date-time nullable: true preorder_message: @@ -8497,7 +8497,7 @@ components: is_price_hidden: type: boolean description: | - False by default, indicating that this product's price should be shown on the product page. If set to `true`, the price is hidden. (NOTE: To successfully set `is_price_hidden` to `true`, the `availability` value must be `disabled`.) + False by default, indicating that this productʼs price should be shown on the product page. If set to `true`, the price is hidden. (NOTE: To successfully set `is_price_hidden` to `true`, the `availability` value must be `disabled`.) price_hidden_label: maxLength: 200 minLength: 0 @@ -8635,7 +8635,7 @@ components: date_created: type: string description: | - Date and time of the metafield's creation. Read-Only. + Date and time of the metafieldʼs creation. Read-Only. readOnly: true format: date-time example: '2018-05-07T20:14:17+00:00' @@ -8859,7 +8859,7 @@ components: example: '2022-06-16T18:39:00+00:00' owner_client_id: type: string - description: Client ID for the metafield's creator. + description: Client ID for the metafieldʼs creator. readOnly: true required: - namespace @@ -9277,7 +9277,7 @@ components: MetafieldKeyInParam: name: key:in in: query - description: Filter based on comma separated metafieldʼs keys. Could be used with vanila 'key' query parameter. + description: Filter based on comma separated metafieldʼs keys. Could be used with vanilla `key` query parameter. required: false style: form explode: false @@ -9295,7 +9295,7 @@ components: MetafieldNamespaceInParam: name: namespace:in in: query - description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanila 'namespace' query parameter. + description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. required: false style: form explode: false diff --git a/reference/channels.v3.yml b/reference/channels.v3.yml index c7346afd3..6bdc97f73 100644 --- a/reference/channels.v3.yml +++ b/reference/channels.v3.yml @@ -16,7 +16,7 @@ info: ### Platform - A channel's `type` and `platform` combination must be a valid pair as indicated in the table below. + A channelʼs `type` and `platform` combination must be a valid pair as indicated in the table below. | Platform | Accepted Type | |:--------------------|:--------------| @@ -58,7 +58,7 @@ info: ### Status - Allowed values for a channel's `status` vary by channel `type` and `platform`. + Allowed values for a channelʼs `status` vary by channel `type` and `platform`. |Type|Platform|Allowed Statuses| |--|--|--| @@ -464,10 +464,10 @@ paths: - $ref: '#/components/parameters/Accept' - $ref: '#/components/parameters/channel_id_path_param' put: - summary: Upsert a Site's Checkout URL + summary: Upsert a Siteʼs Checkout URL tags: - Channel Site Checkout Url - description: Creates or updates (upserts) a site's checkout URL + description: Creates or updates (upserts) a siteʼs checkout URL operationId: updateCheckoutUrl parameters: - $ref: '#/components/parameters/ContentType' @@ -541,7 +541,7 @@ paths: errors: type: object delete: - summary: Delete a Site's Checkout URL + summary: Delete a Siteʼs Checkout URL operationId: deleteCheckoutUrl description: Deletes a siteʼs checkout URL. After deletion, a shared checkout URL is used. tags: @@ -827,7 +827,7 @@ paths: summary: Update multiple Metafields tags: - Channel Metafields - description: Create multiple metafields. + description: Update multiple metafields. operationId: updateChannelsMetafields requestBody: content: @@ -867,7 +867,7 @@ paths: type: array items: type: integer - description: "List of metafield `id`s." + description: List of metafield IDs. responses: '200': description: | @@ -921,14 +921,14 @@ components: name: key in: query description: | - Filter based on a metafield's key. + Filter based on a metafieldʼs key. required: false schema: type: string MetafieldKeyInParam: name: key:in in: query - description: Filter based on comma separated metafieldʼs keys. Could be used with vanila 'key' query parameter. + description: Filter based on comma separated metafieldʼs keys. Could be used with vanilla `key` query parameter. required: false style: form explode: false @@ -939,14 +939,14 @@ components: MetafieldNamespaceParam: name: namespace in: query - description: Filter based on a metafield's namespace. + description: Filter based on a metafieldʼs namespace. required: false schema: type: string MetafieldNamespaceInParam: name: namespace:in in: query - description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanila 'namespace' query parameter. + description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. required: false style: form explode: false @@ -1534,7 +1534,7 @@ components: date_created: type: string description: | - Date and time of the metafield's creation. Read-Only. + Date and time of the metafieldʼs creation. Read-Only. format: date-time example: '2018-05-07T20:14:17.000Z' date_modified: @@ -1678,17 +1678,17 @@ components: name: Terrarium with fish - product_id: 100 state: pending - name: Women's Bold T-Shirt + name: Womenʼs Bold T-Shirt description: 'The same t-shirt, but not a [Sample]' variants: - product_id: 100 variant_id: 91 state: pending - name: Small women's bold t-shirt + name: Small womenʼs bold t-shirt - product_id: 100 variant_id: 92 state: pending - name: Medium women's bold t-shirt + name: Medium womenʼs bold t-shirt update_single_listing_req_example: value: - listing_id: 882998595 @@ -1714,12 +1714,12 @@ components: - listing_id: 882789362 product_id: 100 state: pending - name: Women's Bold T-Shirt + name: Womenʼs Bold T-Shirt variants: - product_id: 100 variant_id: 91 state: pending - name: Small women's bold t-shirt + name: Small womenʼs bold t-shirt multiple_channels_without_currencies_resp_example: value: data: @@ -1933,7 +1933,7 @@ components: listing_id: 882789362 product_id: 100 state: pending - name: Women's Bold T-Shirt + name: Womenʼs Bold T-Shirt description: 'The same t-shirt, but not a [Sample]' date_created: '2021-05-24T17:46:33Z' date_modified: '2021-05-24T17:46:33Z' @@ -1942,14 +1942,14 @@ components: product_id: 100 variant_id: 91 state: pending - name: Small women's bold t-shirt + name: Small womenʼs bold t-shirt date_created: '2021-05-24T17:46:33Z' date_modified: '2021-05-24T17:46:33Z' - channel_id: 664177 product_id: 100 variant_id: 92 state: pending - name: Medium women's bold t-shirt + name: Medium womenʼs bold t-shirt date_created: '2021-05-24T17:46:33Z' date_modified: '2021-05-24T17:46:33Z' meta: @@ -2068,8 +2068,8 @@ components: title: 'The following fields are invalid: type, platform' type: /api-docs/getting-started/api-status-codes errors: - type: The field 'type' can not be updated after channel is created. - platform: The field 'platform' can not be updated after channel is created. + type: "The field 'type' can not be updated after channel is created." + platform: "The field 'platform' can not be updated after channel is created." error_422_prevent_update_deleted_channel_resp_example: value: status: 422 @@ -2274,7 +2274,7 @@ components: date_created: type: string description: | - Date and time of the metafield's creation. Read-Only. + Date and time of the metafieldʼs creation. Read-Only. format: date-time example: '2018-05-07T20:14:17.000Z' date_modified: @@ -2370,7 +2370,7 @@ components: example: '2022-06-16T18:39:00+00:00' owner_client_id: type: string - description: Client ID for the metafield's creator. + description: Client ID for the metafieldʼs creator. readOnly: true required: - namespace @@ -2919,7 +2919,7 @@ components: deprecated: true query_path: type: string - description: The value that will be passed to the app's iFrame in the URL and will allow the app to display the appropriate section within the app iFrame in the control panel. + description: The value that will be passed to the appʼs iFrame in the URL and will allow the app to display the appropriate section within the app iFrame in the control panel. deprecated: true x-examples: example-1: @@ -3193,7 +3193,7 @@ components: x-internal: false ActiveTheme: type: object - description: Details about the Channel's relationship to Themes. + description: Details about the Channelʼs relationship to Themes. properties: active_theme_uuid: type: string diff --git a/reference/customers.v3.yml b/reference/customers.v3.yml index 4948d29ce..ec83221ad 100644 --- a/reference/customers.v3.yml +++ b/reference/customers.v3.yml @@ -1470,7 +1470,7 @@ paths: value: Mushrooms '/customers/{customerId}/consent': get: - description: Gets the status of a customer's consent to allow data collection by cookies and scripts while shopping on a storefront. + description: Gets the status of a customerʼs consent to allow data collection by cookies and scripts while shopping on a storefront. summary: Get Customer Consent tags: - Customer Consent @@ -1498,7 +1498,7 @@ paths: schema: $ref: '#/components/schemas/ErrorResponse' put: - description: Updates the status of a customer's consent to allow data collection by cookies and scripts while shopping on a storefront. + description: Updates the status of a customerʼs consent to allow data collection by cookies and scripts while shopping on a storefront. summary: Update Customer Consent tags: - Customer Consent @@ -1742,7 +1742,7 @@ paths: type: array items: type: integer - description: "Metafield's id list" + description: Metafields ID list. responses: '200': description: | @@ -1785,7 +1785,7 @@ components: MetafieldKeyInParam: name: key:in in: query - description: Filter based on comma separated metafieldʼs keys. Could be used with vanila 'key' query parameter. + description: Filter based on comma separated metafieldʼs keys. Could be used with vanilla `key` query parameter. required: false style: form explode: false @@ -1803,7 +1803,7 @@ components: MetafieldNamespaceInParam: name: namespace:in in: query - description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanila 'namespace' query parameter. + description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. required: false style: form explode: false @@ -3039,7 +3039,7 @@ components: format: int32 value: description: |- - Attribute value. This will always be a string, regardless of the attribute's type. + Attribute value. This will always be a string, regardless of the attributeʼs type. Corresponds to `attribute_value` used in customer attribute values `GET` requests. type: string @@ -3486,7 +3486,7 @@ components: - address1 - city - country_code - description: The `address` object for the `customer` object's `addresses` array. + description: The `address` object for the `customer` objectʼs `addresses` array. x-internal: false customerAddresses_CustomerPost: title: customerAddresses_CustomerPost @@ -3574,7 +3574,7 @@ components: - address1 - city - country_code - description: The `address` object for the `customer` object's `addresses` array. + description: The `address` object for the `customer` objectʼs `addresses` array. x-internal: false customerAuthentication_PostPut: title: customerAuthentication_PostPut @@ -3935,7 +3935,7 @@ components: policy_url: type: string example: 'https://bigcommmerce.com/policy' - description: The URL for a website's privacy policy. + description: The URL for a websiteʼs privacy policy. customer_group_settings: type: object description: The settings for a collection of customers. @@ -3972,7 +3972,7 @@ components: policy_url: type: string example: 'https://bigcommmerce.com/policy' - description: The URL for a website's privacy policy. + description: The URL for a websiteʼs privacy policy. customer_group_settings: type: object description: The settings for a collection of customers. @@ -4117,7 +4117,7 @@ components: example: '2022-06-16T18:39:00+00:00' owner_client_id: type: string - description: Client ID for the metafield's creator. + description: Client ID for the metafieldʼs creator. readOnly: true required: - namespace @@ -4475,7 +4475,7 @@ components: date_created: type: string description: | - Date and time of the metafield's creation. Read-Only. + Date and time of the metafieldʼs creation. Read-Only. readOnly: true format: date-time example: '2018-05-07T20:14:17+00:00' diff --git a/reference/orders.v3.yml b/reference/orders.v3.yml index 1a9f7c191..5f5398176 100644 --- a/reference/orders.v3.yml +++ b/reference/orders.v3.yml @@ -96,7 +96,7 @@ paths: tags: - Transactions description: |- - Returns an **order's** transactions. + Returns an **orderʼs** transactions. **Usage Notes** * Depending on the payment method, different information will be available (not all payment gateways return full card or fraud detail). @@ -632,7 +632,7 @@ paths: $ref: '#/components/schemas/MetafieldResponse' '409': description: | - The `Metafield` conflicts with another `Metafield`. This can be the result of duplicate unique key combinations of the app's client ID, namespace, key, resource_type, and resource_id. + The `Metafield` conflicts with another `Metafield`. This can be the result of duplicate unique key combinations of the appʼs client ID, namespace, key, resource_type, and resource_id. content: application/json: schema: @@ -918,7 +918,7 @@ paths: type: string example: "42" description: | - The id for the cart with which the metafield is associated. + The ID for the order with which the metafield is associated. required: - resource_id description: '' @@ -959,7 +959,7 @@ paths: type: integer example: 42 description: | - The id of metafield to update. + The ID of metafield to update. required: - id description: '' @@ -993,7 +993,7 @@ paths: type: array items: type: integer - description: "List of metafield `id`s." + description: List of metafield IDs. responses: '200': description: | @@ -1909,7 +1909,7 @@ components: properties: remaining_balance: description: | - Remaining balance of shopper's store credit. + Remaining balance of shopperʼs store credit. type: number format: float example: 35.42 @@ -2012,7 +2012,7 @@ components: properties: remaining_balance: description: | - Remaining balance of shopper's store credit. + Remaining balance of shopperʼs store credit. type: number format: float example: 35.42 @@ -2270,6 +2270,7 @@ components: Note that `refund_methods` is an array of refund methods, with each refund method being an array of payment options. For example, if the order was placed by a combination of store credit and bank deposit the refund methods would be: + ```json { "refund_methods": [ @@ -2664,7 +2665,7 @@ components: description: Reference to order ID. user_id: type: integer - description: Reference to the user's ID who create this refund. This is automatically populated by BigCommerce. + description: Reference to the userʼs ID who create this refund. This is automatically populated by BigCommerce. readOnly: true created: type: string @@ -2977,7 +2978,7 @@ components: type: string format: date-time description: | - Date and time of the metafield's creation. + Date and time of the metafieldʼs creation. example: '2022-06-16T18:39:00+00:00' date_modified: type: string @@ -2987,7 +2988,7 @@ components: example: '2022-06-16T18:39:00+00:00' owner_client_id: type: string - description: Client ID for the metafield's creator. + description: Client ID for the metafieldʼs creator. readOnly: true x-internal: false x-examples: {} @@ -3680,14 +3681,14 @@ components: name: key in: query description: | - Filter based on a metafield's key. + Filter based on a metafieldʼs key. required: false schema: type: string MetafieldKeyInParam: name: key:in in: query - description: Filter based on comma separated metafieldʼs keys. Could be used with vanila 'key' query parameter. + description: Filter based on comma separated metafieldʼs keys. Could be used with vanilla `key` query parameter. required: false style: form explode: false @@ -3699,14 +3700,14 @@ components: name: namespace in: query description: | - Filter based on a metafield's key. + Filter based on a metafieldʼs key. required: false schema: type: string MetafieldNamespaceInParam: name: namespace:in in: query - description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanila 'namespace' query parameter. + description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. required: false style: form explode: false From 90ba6053953ebf85d24843081ef35cc2d40c8c9c Mon Sep 17 00:00:00 2001 From: Sarah Riehl Date: Tue, 6 Feb 2024 17:05:57 -0600 Subject: [PATCH 24/41] update non-metafields json to yaml --- reference/carts.v3.yml | 113 +++++++------------- reference/catalog/categories_catalog.v3.yml | 1 - reference/channels.v3.yml | 49 ++++----- reference/customers.v3.yml | 3 +- 4 files changed, 60 insertions(+), 106 deletions(-) diff --git a/reference/carts.v3.yml b/reference/carts.v3.yml index 1ce4c4103..611f9fdd7 100644 --- a/reference/carts.v3.yml +++ b/reference/carts.v3.yml @@ -177,76 +177,41 @@ paths: currency: code: usd locale: en-US - description: |- + description: "" required: true x-examples: - Simple Product: |- - { - "line_items": [ - { - "quantity": 5, - "product_id": 191 - } - ] - } - Create a Cart with a Variant: |- - { - "line_items":[ - { - "quantity": 2, - "product_id": 107, - "variant_id": 185 - } - ] - } - Create a Cart using Date Option: |- - { - "line_items": [ - { - "quantity": 5, - "product_id": 191, - "variant_id": 185, - "option_selections": [ - { - "option_id": 440, - "option_value": 1743570000 - } - ] - } - ] - } - With a Variant of Checkbox and Picklist: |- - { - "line_items": [ - { - "quantity": 1, - "product_id": 77, - "option_selections": [ - { - "option_id": 120, - "option_value": 69 - }, - { - "option_id": 121, - "option_value": 10 - }, - - { - "option_id": 124, - "option_value": 106 - }, - { - "option_id": 122, - "option_value": "Hello" - }, - { - "option_id": 123, - "option_value": 104 - } - ] - } - ] - } + Simple Product: + line_items: + - quantity: 5 + product_id: 191 + Create a Cart with a Variant: + line_items: + - quantity: 2 + product_id: 107 + variant_id: 185 + Create a Cart using Date Option: + line_items: + - quantity: 5 + product_id: 191 + variant_id: 185 + option_selections: + - option_id: 440 + option_value: 1743570000 + With a Variant of Checkbox and Picklist: + line_items: + - quantity: 1 + product_id: 77 + option_selections: + - option_id: 120 + option_value: 69 + - option_id: 121 + option_value: 10 + - option_id: 124 + option_value: 106 + - option_id: 122 + option_value: "Hello" + - option_id: 123 + option_value: 104 Custom Item: custom_items: - sku: abc-123 @@ -825,13 +790,11 @@ paths: schema: $ref: '#/components/schemas/MetafieldBase_Post' example: - { - "permission_set": app_only, - "namespace": Sales Department, - "key": Staff Name, - "value": Sam, - "description": Name of staff member - } + permission_set: app_only + namespace: Sales Department + key: Staff Name + value: Sam + description: Name of staff member description: '' required: true responses: diff --git a/reference/catalog/categories_catalog.v3.yml b/reference/catalog/categories_catalog.v3.yml index f0fc0ff04..d7078f461 100644 --- a/reference/catalog/categories_catalog.v3.yml +++ b/reference/catalog/categories_catalog.v3.yml @@ -2287,7 +2287,6 @@ components: properties: custom_url: $ref: '#/components/schemas/Url' - x-examples: {} Url: type: object properties: diff --git a/reference/channels.v3.yml b/reference/channels.v3.yml index 6bdc97f73..74dc74777 100644 --- a/reference/channels.v3.yml +++ b/reference/channels.v3.yml @@ -487,35 +487,26 @@ paths: Example 1: examples: response: - value: |- - { - "id": 1, - "url": "https://kittens.mybigcommerce.com/", - "channel_id": 1, - "created_at": "2018-01-04T04:15:50.000Z", - "updated_at": "2018-01-04T04:15:50.000Z", - "urls": [ - { - "url": "https://kittens.mybigcommerce.com", - "type": "primary", - "created_at": "2022-03-22T13:08:59Z", - "updated_at": "2022-03-22T13:08:59Z" - }, - { - "url": "https://store-abc.store.bcdev", - "type": "canonical", - "created_at": "2022-03-22T13:08:59Z", - "updated_at": "2022-03-22T13:08:59Z" - }, - { - "url": "https://checkout.kittens.mybigcommerce.com", - "type": "checkout", - "created_at": "2022-03-23T10:21:11Z", - "updated_at": "2022-03-29T13:44:22Z" - } - ], - "is_checkout_url_customized": true - } + value: + id: 1 + url: 'https://kittens.mybigcommerce.com/' + channel_id: 1 + created_at: "2018-01-04T04:15:50.000Z" + updated_at: "2018-01-04T04:15:50.000Z" + urls: + - url: "https://kittens.mybigcommerce.com" + type: primary + created_at: "2022-03-22T13:08:59Z" + updated_at: "2022-03-22T13:08:59Z" + - url: 'https://store-abc.store.bcdev' + type: canonical + created_at: "2022-03-22T13:08:59Z" + updated_at: "2022-03-22T13:08:59Z" + - url: 'https://checkout.kittens.mybigcommerce.com' + type: checkout + created_at: '2022-03-23T10:21:11Z' + updated_at: '2022-03-29T13:44:22Z' + is_checkout_url_customized: true '422': description: Unprocessable Entity. Your checkout and storefront must be within the same main domain like `example.com` and `subdomain.example.com` content: diff --git a/reference/customers.v3.yml b/reference/customers.v3.yml index ec83221ad..620f70acc 100644 --- a/reference/customers.v3.yml +++ b/reference/customers.v3.yml @@ -1876,7 +1876,8 @@ components: channel_ids: - 1 shopper_profile_id: "82511e54-4040-40fe-b742-2b25655f205b" - segment_ids: ["5bb733a9-5491-47b3-9451-9ae8d6a6bc6b"] + segment_ids: + - "5bb733a9-5491-47b3-9451-9ae8d6a6bc6b" meta: pagination: total: 0 From aa40ff6cfe18f5c3b02a7082d95b74e88a25903b Mon Sep 17 00:00:00 2001 From: Sarah Riehl Date: Tue, 6 Feb 2024 17:07:26 -0600 Subject: [PATCH 25/41] metafields json to yaml --- reference/carts.v3.yml | 20 ++++++--------- reference/catalog/brands_catalog.v3.yml | 21 ++++++---------- reference/catalog/categories_catalog.v3.yml | 21 ++++++---------- .../catalog/product-variants_catalog.v3.yml | 21 ++++++---------- reference/catalog/products_catalog.v3.yml | 21 ++++++---------- reference/channels.v3.yml | 21 ++++++---------- reference/customers.v3.yml | 25 ++++++++----------- reference/orders.v3.yml | 21 ++++++---------- 8 files changed, 67 insertions(+), 104 deletions(-) diff --git a/reference/carts.v3.yml b/reference/carts.v3.yml index 611f9fdd7..ee857a490 100644 --- a/reference/carts.v3.yml +++ b/reference/carts.v3.yml @@ -3282,11 +3282,10 @@ components: type: integer description: | The unique identifier for the metafield. - example: [ - 123, - 124, - 125 - ] + example: + - 123 + - 124 + - 125 errors: type: array items: @@ -3306,9 +3305,8 @@ components: type: integer description: | The unique identifier for the metafield. - example: [ - 123 - ] + example: + - 123 errors: type: array items: @@ -3343,10 +3341,8 @@ components: description: | Error detail response payload for the BigCommerce API. example: - { - "1": "Unauthorized to delete", - "2": "Metafield does not exist" - } + "1": "Unauthorized to delete" + "2": "Metafield does not exist" WriteCollectionSuccessMeta: type: object description: 'Additional data about the response.' diff --git a/reference/catalog/brands_catalog.v3.yml b/reference/catalog/brands_catalog.v3.yml index 136afeb9f..9d6ade33d 100644 --- a/reference/catalog/brands_catalog.v3.yml +++ b/reference/catalog/brands_catalog.v3.yml @@ -2127,9 +2127,8 @@ components: type: integer description: | The unique identifier for the metafield. - example: [ - 123 - ] + example: + - 123 errors: type: array items: @@ -2148,16 +2147,14 @@ components: type: integer description: | The unique identifier for the metafield. - example: [ - 123, - 124, - 125 - ] + example: + - 123 + - 124 + - 125 errors: type: array items: $ref: '#/components/schemas/Error' - example: [] meta: $ref: '#/components/schemas/WriteCollectionSuccessMeta' x-internal: false @@ -2235,10 +2232,8 @@ components: description: | Error detail response payload for the BigCommerce API. example: - { - "1": "Unauthorized to delete", - "2": "Metafield does not exist" - } + "1": "Unauthorized to delete" + "2": "Metafield does not exist" CollectionMeta: type: object description: 'Data about the response, including pagination and collection totals.' diff --git a/reference/catalog/categories_catalog.v3.yml b/reference/catalog/categories_catalog.v3.yml index d7078f461..138b491c1 100644 --- a/reference/catalog/categories_catalog.v3.yml +++ b/reference/catalog/categories_catalog.v3.yml @@ -2562,9 +2562,8 @@ components: type: integer description: | The unique identifier for the metafield. - example: [ - 123 - ] + example: + - 123 errors: type: array items: @@ -2583,16 +2582,14 @@ components: type: integer description: | The unique identifier for the metafield. - example: [ - 123, - 124, - 125 - ] + example: + - 123 + - 124 + - 125 errors: type: array items: $ref: '#/components/schemas/Error' - example: [] meta: $ref: '#/components/schemas/WriteCollectionSuccessMeta' x-internal: false @@ -2680,10 +2677,8 @@ components: description: | Error detail response payload for the BigCommerce API. example: - { - "1": "Unauthorized to delete", - "2": "Metafield does not exist" - } + "1": "Unauthorized to delete" + "2": "Metafield does not exist" CollectionMeta: type: object description: 'Data about the response, including pagination and collection totals.' diff --git a/reference/catalog/product-variants_catalog.v3.yml b/reference/catalog/product-variants_catalog.v3.yml index 0787e1e8e..ce7eb186a 100644 --- a/reference/catalog/product-variants_catalog.v3.yml +++ b/reference/catalog/product-variants_catalog.v3.yml @@ -2618,9 +2618,8 @@ components: type: integer description: | The unique identifier for the metafield. - example: [ - 123 - ] + example: + - 123 errors: type: array items: @@ -2639,16 +2638,14 @@ components: type: integer description: | The unique identifier for the metafield. - example: [ - 123, - 124, - 125 - ] + example: + - 123 + - 124 + - 125 errors: type: array items: $ref: '#/components/schemas/Error' - example: [] meta: $ref: '#/components/schemas/WriteCollectionSuccessMeta' x-internal: false @@ -2736,10 +2733,8 @@ components: description: | Error detail response payload for the BigCommerce API. example: - { - "1": "Unauthorized to delete", - "2": "Metafield does not exist" - } + "1": "Unauthorized to delete" + "2": "Metafield does not exist" CollectionMeta: type: object description: 'Data about the response, including pagination and collection totals.' diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml index 1d36c3ca6..e0a48d3fd 100644 --- a/reference/catalog/products_catalog.v3.yml +++ b/reference/catalog/products_catalog.v3.yml @@ -8895,9 +8895,8 @@ components: type: integer description: | The unique identifier for the metafield. - example: [ - 123 - ] + example: + - 123 errors: type: array items: @@ -8916,16 +8915,14 @@ components: type: integer description: | The unique identifier for the metafield. - example: [ - 123, - 124, - 125 - ] + example: + - 123 + - 124 + - 125 errors: type: array items: $ref: '#/components/schemas/Error' - example: [] meta: $ref: '#/components/schemas/WriteCollectionSuccessMeta' x-internal: false @@ -9013,10 +9010,8 @@ components: description: | Error detail response payload for the BigCommerce API. example: - { - "1": "Unauthorized to delete", - "2": "Metafield does not exist" - } + "1": "Unauthorized to delete" + "2": "Metafield does not exist" CollectionMeta: type: object description: 'Data about the response, including pagination and collection totals.' diff --git a/reference/channels.v3.yml b/reference/channels.v3.yml index 74dc74777..29c80b3a3 100644 --- a/reference/channels.v3.yml +++ b/reference/channels.v3.yml @@ -2397,9 +2397,8 @@ components: type: integer description: | The unique identifier for the metafield. - example: [ - 123 - ] + example: + - 123 errors: type: array items: @@ -2418,16 +2417,14 @@ components: type: integer description: | The unique identifier for the metafield. - example: [ - 123, - 124, - 125 - ] + example: + - 123 + - 124 + - 125 errors: type: array items: $ref: '#/components/schemas/Error' - example: [] meta: $ref: '#/components/schemas/WriteCollectionSuccessMeta' x-internal: false @@ -2516,10 +2513,8 @@ components: description: | Error detail response payload for the BigCommerce API. example: - { - "1": "Unauthorized to delete", - "2": "Metafield does not exist" - } + "1": "Unauthorized to delete" + "2": "Metafield does not exist" CollectionMeta: type: object description: 'Data about the response, including pagination and collection totals.' diff --git a/reference/customers.v3.yml b/reference/customers.v3.yml index 620f70acc..7f579a608 100644 --- a/reference/customers.v3.yml +++ b/reference/customers.v3.yml @@ -2938,7 +2938,9 @@ components: channel_ids: description: Array of channels the customer can access. type: array - example: [1,2] + example: + - 1 + - 2 items: type: integer form_fields: @@ -4154,9 +4156,8 @@ components: type: integer description: | The unique identifier for the metafield. - example: [ - 123 - ] + example: + - 123 errors: type: array items: @@ -4175,16 +4176,14 @@ components: type: integer description: | The unique identifier for the metafield. - example: [ - 123, - 124, - 125 - ] + example: + - 123 + - 124 + - 125 errors: type: array items: $ref: '#/components/schemas/Error' - example: [] meta: $ref: '#/components/schemas/WriteCollectionSuccessMeta' x-internal: false @@ -4272,10 +4271,8 @@ components: description: | Error detail response payload for the BigCommerce API. example: - { - "1": "Unauthorized to delete", - "2": "Metafield does not exist" - } + "1": "Unauthorized to delete" + "2": "Metafield does not exist" CollectionMeta: type: object description: 'Data about the response, including pagination and collection totals.' diff --git a/reference/orders.v3.yml b/reference/orders.v3.yml index 5f5398176..4f402e165 100644 --- a/reference/orders.v3.yml +++ b/reference/orders.v3.yml @@ -3042,9 +3042,8 @@ components: type: integer description: | The unique identifier for the metafield. - example: [ - 123 - ] + example: + - 123 errors: type: array items: @@ -3063,16 +3062,14 @@ components: type: integer description: | The unique identifier for the metafield. - example: [ - 123, - 124, - 125 - ] + example: + - 123 + - 124 + - 125 errors: type: array items: $ref: '#/components/schemas/Error' - example: [] meta: $ref: '#/components/schemas/WriteCollectionSuccessMeta' x-internal: false @@ -3160,10 +3157,8 @@ components: description: | Error detail response payload for the BigCommerce API. example: - { - "1": "Unauthorized to delete", - "2": "Metafield does not exist" - } + "1": "Unauthorized to delete" + "2": "Metafield does not exist" MetafieldPost_Batch: description: | The model for a POST to create metafield. From eb4463b2f46047cef6f4908767e97b117871e718 Mon Sep 17 00:00:00 2001 From: Sarah Riehl Date: Tue, 6 Feb 2024 17:07:42 -0600 Subject: [PATCH 26/41] more non-metafields json to yaml --- reference/orders.v3.yml | 46 ++++++++++++++++------------------------- 1 file changed, 18 insertions(+), 28 deletions(-) diff --git a/reference/orders.v3.yml b/reference/orders.v3.yml index 4f402e165..ec5191966 100644 --- a/reference/orders.v3.yml +++ b/reference/orders.v3.yml @@ -498,34 +498,24 @@ paths: Example 1: examples: response: - value: |- - { - "data": [ - { - "order_id": 1, - "total_refund_amount": 1.99, - "total_refund_tax_amount": 1.95, - "rounding": 1, - "adjustment": 0.05, - "tax_inclusive": true, - "refund_methods": [ - "" - ] - } - ], - "errors": [ - { - "order_id": 1, - "status": 422, - "error": "Refund amount is greater than remaining amount" - } - ], - "meta": { - "failure": 1, - "success": 1, - "total": 2 - } - } + value: + data: + - order_id: 1 + total_refund_amount: 1.99 + total_refund_tax_amount: 1.95 + rounding: 1 + adjustment: 0.05 + tax_inclusive: true + refund_methods: + - "" + errors: + - order_id: 1 + status: 422 + error: "Refund amount is greater than remaining amount" + meta: + failure: 1 + success: 1 + total: 2 '503': description: Every request in the batch failed. The error object describes the failure for each component request. content: From 358981581cfc45012de00cd6c28525a33ae543be Mon Sep 17 00:00:00 2001 From: Sarah Riehl Date: Tue, 6 Feb 2024 17:08:01 -0600 Subject: [PATCH 27/41] update channels and customers tags --- reference/channels.v3.yml | 76 +++++++++++++++++++------------------- reference/customers.v3.yml | 74 ++++++++++++++++++------------------- 2 files changed, 75 insertions(+), 75 deletions(-) diff --git a/reference/channels.v3.yml b/reference/channels.v3.yml index 29c80b3a3..f39948cad 100644 --- a/reference/channels.v3.yml +++ b/reference/channels.v3.yml @@ -95,13 +95,13 @@ security: - X-Auth-Token: [] tags: - name: Channels - - name: Channel Active Theme - - name: Channel Currency Assignments - - name: Channel Listings - - name: Channel Site - - name: Channel Site Checkout Url - - name: Channel Menus - - name: Channel Metafields + - name: Metafields + - name: Menus + - name: Active Theme + - name: Currency Assignments + - name: Listings + - name: Site + - name: Site Checkout URL paths: '/channels': parameters: @@ -222,7 +222,7 @@ paths: - $ref: '#/components/parameters/channel_id_path_param' get: tags: - - Channel Active Theme + - Active Theme summary: Get a Channel Active Theme operationId: getChannelActiveTheme description: |- @@ -238,7 +238,7 @@ paths: - $ref: '#/components/parameters/Accept' get: tags: - - Channel Currency Assignments + - Currency Assignments summary: Get All Channels Currency Assignments operationId: getAllCurrencyAssignments description: Returns a list of currency assignments for all channels. @@ -247,7 +247,7 @@ paths: $ref: '#/components/responses/multiple_channels_currency_assignments_resp' post: tags: - - Channel Currency Assignments + - Currency Assignments parameters: - $ref: '#/components/parameters/ContentType' summary: Create Multiple Channels Currency Assignments @@ -269,7 +269,7 @@ paths: $ref: '#/components/responses/missing_or_invalid_multiple_channels_currency_assignments_data_resp' put: tags: - - Channel Currency Assignments + - Currency Assignments summary: Update Multiple Channels Currency Assignments parameters: - $ref: '#/components/parameters/ContentType' @@ -295,7 +295,7 @@ paths: - $ref: '#/components/parameters/channel_id_path_param' get: tags: - - Channel Currency Assignments + - Currency Assignments summary: Get Channel Currency Assignments operationId: getSingleChannelCurrencyAssignments description: Returns a list of currency assignments for a specific channel. @@ -306,7 +306,7 @@ paths: $ref: '#/components/responses/channel_not_found_resp' post: tags: - - Channel Currency Assignments + - Currency Assignments summary: Create Channel Currency Assignments parameters: - $ref: '#/components/parameters/ContentType' @@ -328,7 +328,7 @@ paths: $ref: '#/components/responses/missing_or_invalid_single_channel_currency_assignments_data_resp' put: tags: - - Channel Currency Assignments + - Currency Assignments summary: Update Channel Currency Assignments parameters: - $ref: '#/components/parameters/ContentType' @@ -350,7 +350,7 @@ paths: $ref: '#/components/responses/missing_or_invalid_single_channel_currency_assignments_data_resp' delete: tags: - - Channel Currency Assignments + - Currency Assignments summary: Delete Channel Currency Assignments operationId: deleteSingleChannelCurrencyAssignments description: 'Deletes currency assignments for a specific channel. Once done, this channel will inherit the store’s currency settings.' @@ -365,7 +365,7 @@ paths: - $ref: '#/components/parameters/channel_id_path_param' get: tags: - - Channel Listings + - Listings summary: Get Channel Listings operationId: getChannelListings description: 'Returns a list of all *Channel Listings* for a specific channel. Note that if the *Channel* is not found or there is no listing associated to the *Channel*, it will return a 200 response with empty data.' @@ -388,7 +388,7 @@ paths: $ref: '#/components/responses/invalid_filters_resp' post: tags: - - Channel Listings + - Listings summary: Create Channel Listings parameters: - $ref: '#/components/parameters/ContentType' @@ -412,7 +412,7 @@ paths: $ref: '#/components/responses/missing_or_invalid_multiple_listings_data_for_post_resp' put: tags: - - Channel Listings + - Listings summary: Update Channel Listings parameters: - $ref: '#/components/parameters/ContentType' @@ -450,7 +450,7 @@ paths: - $ref: '#/components/parameters/listing_id_path_param' get: tags: - - Channel Listings + - Listings summary: Get a Channel Listing operationId: getChannelListing description: Returns a *Channel Listing* for a specific channel. @@ -466,7 +466,7 @@ paths: put: summary: Upsert a Siteʼs Checkout URL tags: - - Channel Site Checkout Url + - Site Checkout URL description: Creates or updates (upserts) a siteʼs checkout URL operationId: updateCheckoutUrl parameters: @@ -536,7 +536,7 @@ paths: operationId: deleteCheckoutUrl description: Deletes a siteʼs checkout URL. After deletion, a shared checkout URL is used. tags: - - Channel Site Checkout Url + - Site Checkout URL responses: '200': description: OK. `data` and `meta` are empty objects. @@ -565,7 +565,7 @@ paths: '200': $ref: '#/components/responses/site_Resp' tags: - - Channel Site + - Site put: responses: '200': @@ -583,7 +583,7 @@ paths: application/json: url: 'https://example.com/' tags: - - Channel Site + - Site description: Updates a site for provided channel. post: responses: @@ -603,7 +603,7 @@ paths: url: 'http://kittens.mybigcommerce.com/' channel_id: 123 tags: - - Channel Site + - Site description: Alias of POST `/sites`. Creates a site for provided channel. delete: responses: @@ -614,10 +614,10 @@ paths: schema: type: object properties: {} - description: Deletes the Channel's site. + description: Deletes the Channelʼs site. operationId: deleteChannelSite tags: - - Channel Site + - Site summary: Delete a Channel Site '/channels/{channel_id}/channel-menus': parameters: @@ -632,7 +632,7 @@ paths: '200': $ref: '#/components/responses/channel_menus_Resp' tags: - - Channel Menus + - Menus post: responses: '200': @@ -648,7 +648,7 @@ paths: $ref: '#/components/schemas/channel_menus_Post' examples: {} tags: - - Channel Menus + - Menus description: Creates or replaces list of control panel side navigation menus for a channel. delete: responses: @@ -670,7 +670,7 @@ paths: description: Deletes control panel side navigation menus for a channel. operationId: deleteChannelMenus tags: - - Channel Menus + - Menus summary: Delete Channel Menus '/channels/{channel_id}/metafields': parameters: @@ -679,7 +679,7 @@ paths: get: summary: Get Channel Metafields tags: - - Channel Metafields + - Metafields responses: '200': $ref: '#/components/responses/metafield_200' @@ -706,7 +706,7 @@ paths: $ref: '#/components/schemas/metafield_Post' examples: {} tags: - - Channel Metafields + - Metafields description: |- Creates a channel metafield. @@ -723,7 +723,7 @@ paths: get: summary: Get a Channel Metafield tags: - - Channel Metafields + - Metafields responses: '200': $ref: '#/components/responses/metafield_200' @@ -743,7 +743,7 @@ paths: schema: $ref: '#/components/schemas/metafield_Put' tags: - - Channel Metafields + - Metafields description: |- Updates a single channel metafield. @@ -756,13 +756,13 @@ paths: '204': description: No Content tags: - - Channel Metafields + - Metafields description: Deletes a single channel metafield. '/channels/metafields': get: summary: Get All Metafields tags: - - Channel Metafields + - Metafields description: Get all channel metafields. operationId: getChannelsMetafields responses: @@ -786,7 +786,7 @@ paths: post: summary: Create multiple Metafields tags: - - Channel Metafields + - Metafields description: Create multiple metafields. operationId: createChannelsMetafields requestBody: @@ -817,7 +817,7 @@ paths: put: summary: Update multiple Metafields tags: - - Channel Metafields + - Metafields description: Update multiple metafields. operationId: updateChannelsMetafields requestBody: @@ -848,7 +848,7 @@ paths: delete: summary: Delete All Metafields tags: - - Channel Metafields + - Metafields description: Delete all channel metafields. operationId: deleteChannelsMetafields requestBody: diff --git a/reference/customers.v3.yml b/reference/customers.v3.yml index 7f579a608..5c1b253b0 100644 --- a/reference/customers.v3.yml +++ b/reference/customers.v3.yml @@ -24,17 +24,17 @@ security: tags: - name: Customers description: BigCommerce Customers API Definition. - - name: Customer Addresses - - name: Customer Attributes - - name: Customer Attribute Values - - name: Customer Form Field Values - - name: Customer Consent - - name: Customer Form Fields - - name: Customer Stored Instruments - - name: Customer Settings - - name: Customer Settings Channel - - name: Customer Validate Credentials - - name: Customer Metafields + - name: Consent + - name: Validate Credentials + - name: Metafields + - name: Addresses + - name: Attributes + - name: Attribute Values + - name: Form Fields + - name: Form Field Values + - name: Stored Instruments + - name: Global Settings + - name: Channel Settings paths: '/customers': get: @@ -484,7 +484,7 @@ paths: '200': $ref: '#/components/responses/AddressCollectionResponse' tags: - - Customer Addresses + - Addresses post: description: |- Creates a Customer Address. Multiple customer addresses can be created in one call. @@ -579,7 +579,7 @@ paths: schema: $ref: '#/components/schemas/ErrorResponse' tags: - - Customer Addresses + - Addresses put: description: |- Updates a Customer Address. Multiple customer addresses can be updated in one call. @@ -673,7 +673,7 @@ paths: schema: $ref: '#/components/schemas/ErrorResponse' tags: - - Customer Addresses + - Addresses delete: description: |- Deletes a Customer Address. @@ -711,11 +711,11 @@ paths: description: '' headers: {} tags: - - Customer Addresses + - Addresses '/customers/validate-credentials': post: tags: - - Customer Validate Credentials + - Validate Credentials description: Validate a customer credentials - This endpoint has special rate limiting protections to protect against abuse. summary: Validate a customer credentials operationId: validateCustomerCredentials @@ -766,7 +766,7 @@ paths: '/customers/settings': get: tags: - - Customer Settings + - Global Settings description: Returns the global-level customer settings. summary: Get Customer Settings operationId: getCustomersSettings @@ -788,7 +788,7 @@ paths: default_customer_group_id: 1 put: tags: - - Customer Settings + - Global Settings description: Updates the customer settings on the global level. summary: Update Customer Settings operationId: updateCustomersSettings @@ -827,7 +827,7 @@ paths: '/customers/settings/channels/{channel_id}': get: tags: - - Customer Settings Channel + - Channel Settings description: |- Returns the customer settings per channel. @@ -860,7 +860,7 @@ paths: allow_global_logins: true put: tags: - - Customer Settings Channel + - Channel Settings description: |- Update the customer settings per channel @@ -1010,7 +1010,7 @@ paths: '200': $ref: '#/components/responses/CustomerAttributesResponse' tags: - - Customer Attributes + - Attributes post: description: |- Creates a Customer Attribute. Multiple customer attributes can be created in one call. @@ -1066,7 +1066,7 @@ paths: schema: $ref: '#/components/schemas/ErrorResponse' tags: - - Customer Attributes + - Attributes put: description: |- Updates a Customer Attribute. Multiple customer attributes can be updated in one call. @@ -1115,7 +1115,7 @@ paths: schema: $ref: '#/components/schemas/ErrorResponse' tags: - - Customer Attributes + - Attributes delete: description: |- Deletes Customer Attributes from the store. @@ -1152,7 +1152,7 @@ paths: description: '' headers: {} tags: - - Customer Attributes + - Attributes '/customers/attribute-values': get: description: Returns a list of Customer Attribute Values. Optional filter parameters can be passed in. @@ -1241,7 +1241,7 @@ paths: '200': $ref: '#/components/responses/CustomerAttributeValueCollectionResponse' tags: - - Customer Attribute Values + - Attribute Values put: description: |- Upserts Customer Attribute Values. Updates the attribute values on the Customer. Multiple customer attribute values can be updated in one call. @@ -1308,7 +1308,7 @@ paths: schema: $ref: '#/components/schemas/ErrorResponse' tags: - - Customer Attribute Values + - Attribute Values delete: description: |- Deletes Customer Attribute Values. Deletes the attribute value from the customer. @@ -1347,7 +1347,7 @@ paths: description: '' headers: {} tags: - - Customer Attribute Values + - Attribute Values '/customers/form-field-values': get: responses: @@ -1366,7 +1366,7 @@ paths: To learn about adding and managing form fields, see [Adding and Editing Fields in the Account Signup Form](https://support.bigcommerce.com/s/article/Editing-Form-Fields). operationId: getCustomersFormFieldValues tags: - - Customer Form Field Values + - Form Field Values parameters: - name: Accept in: header @@ -1448,7 +1448,7 @@ paths: * Limit of 10 concurrent requests. operationId: updateCustomerFormFieldValues tags: - - Customer Form Field Values + - Form Field Values requestBody: content: application/json: @@ -1473,7 +1473,7 @@ paths: description: Gets the status of a customerʼs consent to allow data collection by cookies and scripts while shopping on a storefront. summary: Get Customer Consent tags: - - Customer Consent + - Consent operationId: getCustomerConsent deprecated: false responses: @@ -1501,7 +1501,7 @@ paths: description: Updates the status of a customerʼs consent to allow data collection by cookies and scripts while shopping on a storefront. summary: Update Customer Consent tags: - - Customer Consent + - Consent operationId: updateCustomerConsent deprecated: false parameters: @@ -1549,7 +1549,7 @@ paths: get: summary: Get Stored Instruments tags: - - Customer Stored Instruments + - Stored Instruments description: |- Lists all available stored instruments for a customer. This list will include all types of stored instruments namely card, account and bank_account instruments @@ -1626,7 +1626,7 @@ paths: get: summary: Get All Metafields tags: - - Customer Metafields + - Metafields description: Get all customer metafields. operationId: getCustomersMetafields responses: @@ -1650,7 +1650,7 @@ paths: post: summary: Create multiple Metafields tags: - - Customer Metafields + - Metafields description: Create multiple metafields. operationId: createCustomersMetafields requestBody: @@ -1691,9 +1691,9 @@ paths: put: summary: Update multiple Metafields tags: - - Customer Metafields + - Metafields description: Create multiple metafields. - operationId: updateCustomerMetafields + operationId: updateCustomersMetafields requestBody: content: application/json: @@ -1732,7 +1732,7 @@ paths: delete: summary: Delete All Metafields tags: - - Customer Metafields + - Metafields description: Delete all customer metafields. operationId: deleteCustomersMetafields requestBody: From 695ec23a8bfb7ab9812fa77af3eaf2a197e9d713 Mon Sep 17 00:00:00 2001 From: Sarah Riehl Date: Tue, 6 Feb 2024 17:15:37 -0600 Subject: [PATCH 28/41] remove straight quotes where not needed --- reference/carts.v3.yml | 8 +++---- reference/catalog/brands_catalog.v3.yml | 14 +++++------ reference/catalog/categories_catalog.v3.yml | 12 +++++----- .../catalog/product-variants_catalog.v3.yml | 16 ++++++------- reference/catalog/products_catalog.v3.yml | 12 +++++----- reference/channels.v3.yml | 10 ++++---- reference/customers.v3.yml | 24 +++++++++---------- reference/orders.v3.yml | 12 +++++----- 8 files changed, 54 insertions(+), 54 deletions(-) diff --git a/reference/carts.v3.yml b/reference/carts.v3.yml index ee857a490..b6b6956e4 100644 --- a/reference/carts.v3.yml +++ b/reference/carts.v3.yml @@ -3345,7 +3345,7 @@ components: "2": "Metafield does not exist" WriteCollectionSuccessMeta: type: object - description: 'Additional data about the response.' + description: Additional data about the response. properties: total: type: integer @@ -3366,7 +3366,7 @@ components: x-internal: false WriteCollectionPartialSuccessMeta: type: object - description: 'Additional data about the response.' + description: Additional data about the response. properties: total: type: integer @@ -3387,11 +3387,11 @@ components: x-internal: false CollectionMeta: type: object - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. properties: pagination: type: object - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. title: Pagination properties: total: diff --git a/reference/catalog/brands_catalog.v3.yml b/reference/catalog/brands_catalog.v3.yml index 9d6ade33d..d677ea2c3 100644 --- a/reference/catalog/brands_catalog.v3.yml +++ b/reference/catalog/brands_catalog.v3.yml @@ -1879,7 +1879,7 @@ components: properties: pagination: $ref: '#/components/schemas/pagination_Full' - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. x-internal: false pagination_Full: title: pagination_Full @@ -1928,7 +1928,7 @@ components: Link to the next page returned in the response. description: | Pagination links for the previous and next parts of the whole collection. - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. x-internal: false metaEmpty_Full: type: object @@ -2160,7 +2160,7 @@ components: x-internal: false WriteCollectionPartialSuccessMeta: type: object - description: 'Additional data about the response.' + description: Additional data about the response. properties: total: type: integer @@ -2181,7 +2181,7 @@ components: x-internal: false WriteCollectionSuccessMeta: type: object - description: 'Additional data about the response.' + description: Additional data about the response. properties: total: type: integer @@ -2236,11 +2236,11 @@ components: "2": "Metafield does not exist" CollectionMeta: type: object - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. properties: pagination: type: object - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. title: Pagination properties: total: @@ -2509,7 +2509,7 @@ components: - desc responses: General207Status: - description: 'Multi-status. Multiple operations have taken place and the status for each operation can be viewed in the body of the response. Typically indicates that a partial failure has occured, such as when a `POST` or `PUT` request is successful, but saving the URL or inventory data has failed.' + description: Multi-status. Multiple operations have taken place and the status for each operation can be viewed in the body of the response. Typically indicates that a partial failure has occurred, such as when a `POST` or `PUT` request is successful, but saving the URL or inventory data has failed. content: application/json: schema: diff --git a/reference/catalog/categories_catalog.v3.yml b/reference/catalog/categories_catalog.v3.yml index 138b491c1..b8de23a40 100644 --- a/reference/catalog/categories_catalog.v3.yml +++ b/reference/catalog/categories_catalog.v3.yml @@ -2121,7 +2121,7 @@ components: properties: pagination: $ref: '#/components/schemas/pagination_Full' - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. x-internal: false pagination_Full: title: pagination_Full @@ -2170,7 +2170,7 @@ components: Link to the next page returned in the response. description: | Pagination links for the previous and next parts of the whole collection. - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. x-internal: false metaEmpty_Full: type: object @@ -2595,7 +2595,7 @@ components: x-internal: false WriteCollectionPartialSuccessMeta: type: object - description: 'Additional data about the response.' + description: Additional data about the response. properties: total: type: integer @@ -2616,7 +2616,7 @@ components: x-internal: false WriteCollectionSuccessMeta: type: object - description: 'Additional data about the response.' + description: Additional data about the response. properties: total: type: integer @@ -2681,11 +2681,11 @@ components: "2": "Metafield does not exist" CollectionMeta: type: object - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. properties: pagination: type: object - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. title: Pagination properties: total: diff --git a/reference/catalog/product-variants_catalog.v3.yml b/reference/catalog/product-variants_catalog.v3.yml index ce7eb186a..cb647f886 100644 --- a/reference/catalog/product-variants_catalog.v3.yml +++ b/reference/catalog/product-variants_catalog.v3.yml @@ -1675,8 +1675,8 @@ paths: Link to the next page returned in the response. description: | Pagination links for the previous and next parts of the whole collection. - description: 'Data about the response, including pagination and collection totals.' - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. + description: Data about the response, including pagination and collection totals. '413': description: '' content: @@ -2347,7 +2347,7 @@ components: properties: pagination: $ref: '#/components/schemas/pagination_Full' - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. x-internal: false pagination_Full: title: pagination_Full @@ -2396,7 +2396,7 @@ components: Link to the next page returned in the response. description: | Pagination links for the previous and next parts of the whole collection. - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. x-internal: false metaEmpty_Full: type: object @@ -2651,7 +2651,7 @@ components: x-internal: false WriteCollectionPartialSuccessMeta: type: object - description: 'Additional data about the response.' + description: Additional data about the response. properties: total: type: integer @@ -2672,7 +2672,7 @@ components: x-internal: false WriteCollectionSuccessMeta: type: object - description: 'Additional data about the response.' + description: Additional data about the response. properties: total: type: integer @@ -2737,11 +2737,11 @@ components: "2": "Metafield does not exist" CollectionMeta: type: object - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. properties: pagination: type: object - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. title: Pagination properties: total: diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml index e0a48d3fd..9ca164840 100644 --- a/reference/catalog/products_catalog.v3.yml +++ b/reference/catalog/products_catalog.v3.yml @@ -7600,7 +7600,7 @@ components: properties: pagination: $ref: '#/components/schemas/pagination_Full' - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. x-internal: false pagination_Full: title: pagination_Full @@ -7649,7 +7649,7 @@ components: Link to the next page returned in the response. description: | Pagination links for the previous and next parts of the whole collection. - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. x-internal: false metaEmpty_Full: type: object @@ -8928,7 +8928,7 @@ components: x-internal: false WriteCollectionPartialSuccessMeta: type: object - description: 'Additional data about the response.' + description: Additional data about the response. properties: total: type: integer @@ -8949,7 +8949,7 @@ components: x-internal: false WriteCollectionSuccessMeta: type: object - description: 'Additional data about the response.' + description: Additional data about the response. properties: total: type: integer @@ -9014,11 +9014,11 @@ components: "2": "Metafield does not exist" CollectionMeta: type: object - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. properties: pagination: type: object - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. title: Pagination properties: total: diff --git a/reference/channels.v3.yml b/reference/channels.v3.yml index f39948cad..1869dca67 100644 --- a/reference/channels.v3.yml +++ b/reference/channels.v3.yml @@ -2430,7 +2430,7 @@ components: x-internal: false WriteCollectionPartialSuccessMeta: type: object - description: 'Additional data about the response.' + description: Additional data about the response. properties: total: type: integer @@ -2451,7 +2451,7 @@ components: x-internal: false WriteCollectionSuccessMeta: type: object - description: 'Additional data about the response.' + description: Additional data about the response. properties: total: type: integer @@ -2517,11 +2517,11 @@ components: "2": "Metafield does not exist" CollectionMeta: type: object - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. properties: pagination: type: object - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. title: Pagination properties: total: @@ -3611,4 +3611,4 @@ components: type: string description: | Description for the metafield. - example: Location in the warehouse. \ No newline at end of file + example: Location in the warehouse. diff --git a/reference/customers.v3.yml b/reference/customers.v3.yml index 5c1b253b0..84393e390 100644 --- a/reference/customers.v3.yml +++ b/reference/customers.v3.yml @@ -2270,12 +2270,12 @@ components: - customer_id meta: title: Collection Meta - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. type: object properties: pagination: title: Pagination - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. type: object properties: total: @@ -2448,12 +2448,12 @@ components: title: 'Form Field Value ' meta: title: Collection Meta - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. type: object properties: pagination: title: Pagination - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. type: object properties: total: @@ -2708,7 +2708,7 @@ components: schemas: Pagination: title: Pagination - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. type: object properties: total: @@ -2736,7 +2736,7 @@ components: x-internal: false _metaCollection: title: _metaCollection - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. type: object properties: pagination: @@ -4189,7 +4189,7 @@ components: x-internal: false WriteCollectionPartialSuccessMeta: type: object - description: 'Additional data about the response.' + description: Additional data about the response. properties: total: type: integer @@ -4210,7 +4210,7 @@ components: x-internal: false WriteCollectionSuccessMeta: type: object - description: 'Additional data about the response.' + description: Additional data about the response. properties: total: type: integer @@ -4275,11 +4275,11 @@ components: "2": "Metafield does not exist" CollectionMeta: type: object - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. properties: pagination: type: object - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. title: Pagination properties: total: @@ -4560,7 +4560,7 @@ components: properties: pagination: $ref: '#/components/schemas/pagination_Full' - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. x-internal: false pagination_Full: title: pagination_Full @@ -4609,5 +4609,5 @@ components: Link to the next page returned in the response. description: | Pagination links for the previous and next parts of the whole collection. - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. x-internal: false diff --git a/reference/orders.v3.yml b/reference/orders.v3.yml index ec5191966..ca222919d 100644 --- a/reference/orders.v3.yml +++ b/reference/orders.v3.yml @@ -1236,7 +1236,7 @@ components: x-internal: false Pagination: type: object - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. title: Pagination properties: total: @@ -1419,11 +1419,11 @@ components: x-internal: false CollectionMeta: type: object - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. properties: pagination: type: object - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. title: Pagination properties: total: @@ -1477,7 +1477,7 @@ components: properties: meta: type: object - description: 'Data about the response, including pagination and collection totals.' + description: Data about the response, including pagination and collection totals. title: Pagination properties: total: @@ -3065,7 +3065,7 @@ components: x-internal: false WriteCollectionPartialSuccessMeta: type: object - description: 'Additional data about the response.' + description: Additional data about the response. properties: total: type: integer @@ -3086,7 +3086,7 @@ components: x-internal: false WriteCollectionSuccessMeta: type: object - description: 'Additional data about the response.' + description: Additional data about the response. properties: total: type: integer From dead77197cd6cb2bd8786aa203396613ca8bfd21 Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Wed, 7 Feb 2024 13:13:34 -0600 Subject: [PATCH 29/41] resource id types --- reference/catalog/brands_catalog.v3.yml | 4 ++-- reference/catalog/categories_catalog.v3.yml | 8 ++++---- reference/catalog/product-variants_catalog.v3.yml | 4 ++-- reference/catalog/products_catalog.v3.yml | 4 ++-- reference/orders.v3.yml | 4 ++-- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/reference/catalog/brands_catalog.v3.yml b/reference/catalog/brands_catalog.v3.yml index bd9b628b2..5402932b8 100644 --- a/reference/catalog/brands_catalog.v3.yml +++ b/reference/catalog/brands_catalog.v3.yml @@ -1630,8 +1630,8 @@ paths: - type: object properties: resource_id: - type: string - example: "42" + type: integer + example: 42 description: | The ID for the brand with which the metafield is associated. required: diff --git a/reference/catalog/categories_catalog.v3.yml b/reference/catalog/categories_catalog.v3.yml index bf459239c..16c282c0f 100644 --- a/reference/catalog/categories_catalog.v3.yml +++ b/reference/catalog/categories_catalog.v3.yml @@ -1825,8 +1825,8 @@ paths: - type: object properties: resource_id: - type: string - example: "42" + type: integer + example: 42 description: | The ID for the category with which the metafield is associated. required: @@ -1866,8 +1866,8 @@ paths: - type: object properties: id: - type: string - example: "42" + type: integer + example: 42 description: | The ID of metafield to update. required: diff --git a/reference/catalog/product-variants_catalog.v3.yml b/reference/catalog/product-variants_catalog.v3.yml index 8420943a0..0181907d1 100644 --- a/reference/catalog/product-variants_catalog.v3.yml +++ b/reference/catalog/product-variants_catalog.v3.yml @@ -1758,8 +1758,8 @@ paths: - type: object properties: resource_id: - type: string - example: "42" + type: integer + example: 42 description: | The ID for the product variant with which the metafield is associated. required: diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml index 9bf4759fd..318e91d7c 100644 --- a/reference/catalog/products_catalog.v3.yml +++ b/reference/catalog/products_catalog.v3.yml @@ -6327,8 +6327,8 @@ paths: - type: object properties: resource_id: - type: string - example: "42" + type: integer + example: 42 description: | The ID for the product with which the metafield is associated. required: diff --git a/reference/orders.v3.yml b/reference/orders.v3.yml index ca222919d..5edcf54de 100644 --- a/reference/orders.v3.yml +++ b/reference/orders.v3.yml @@ -905,8 +905,8 @@ paths: - type: object properties: resource_id: - type: string - example: "42" + type: integer + example: 42 description: | The ID for the order with which the metafield is associated. required: From 1cb4e398ec6b6b44f9494ee0b4532869dbba02ed Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Wed, 7 Feb 2024 14:15:51 -0600 Subject: [PATCH 30/41] update DELETE 200 response (empty errors array) --- reference/carts.v3.yml | 2 -- reference/catalog/brands_catalog.v3.yml | 3 +-- reference/catalog/categories_catalog.v3.yml | 3 +-- reference/catalog/product-variants_catalog.v3.yml | 3 +-- reference/catalog/products_catalog.v3.yml | 3 +-- reference/channels.v3.yml | 3 +-- reference/customers.v3.yml | 3 +-- reference/orders.v3.yml | 3 +-- 8 files changed, 7 insertions(+), 16 deletions(-) diff --git a/reference/carts.v3.yml b/reference/carts.v3.yml index 3d7efcdbe..3279abcff 100644 --- a/reference/carts.v3.yml +++ b/reference/carts.v3.yml @@ -3288,8 +3288,6 @@ components: - 125 errors: type: array - items: - $ref: '#/components/schemas/Error' example: [] meta: $ref: '#/components/schemas/WriteCollectionSuccessMeta' diff --git a/reference/catalog/brands_catalog.v3.yml b/reference/catalog/brands_catalog.v3.yml index 5402932b8..0628a6104 100644 --- a/reference/catalog/brands_catalog.v3.yml +++ b/reference/catalog/brands_catalog.v3.yml @@ -2154,8 +2154,7 @@ components: - 125 errors: type: array - items: - $ref: '#/components/schemas/Error' + example: [] meta: $ref: '#/components/schemas/WriteCollectionSuccessMeta' x-internal: false diff --git a/reference/catalog/categories_catalog.v3.yml b/reference/catalog/categories_catalog.v3.yml index 16c282c0f..4ddb1c18f 100644 --- a/reference/catalog/categories_catalog.v3.yml +++ b/reference/catalog/categories_catalog.v3.yml @@ -2588,8 +2588,7 @@ components: - 125 errors: type: array - items: - $ref: '#/components/schemas/Error' + example: [] meta: $ref: '#/components/schemas/WriteCollectionSuccessMeta' x-internal: false diff --git a/reference/catalog/product-variants_catalog.v3.yml b/reference/catalog/product-variants_catalog.v3.yml index 0181907d1..8844eb6c0 100644 --- a/reference/catalog/product-variants_catalog.v3.yml +++ b/reference/catalog/product-variants_catalog.v3.yml @@ -2639,8 +2639,7 @@ components: - 125 errors: type: array - items: - $ref: '#/components/schemas/Error' + example: [] meta: $ref: '#/components/schemas/WriteCollectionSuccessMeta' x-internal: false diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml index 318e91d7c..b4771c908 100644 --- a/reference/catalog/products_catalog.v3.yml +++ b/reference/catalog/products_catalog.v3.yml @@ -8925,8 +8925,7 @@ components: - 125 errors: type: array - items: - $ref: '#/components/schemas/Error' + example: [] meta: $ref: '#/components/schemas/WriteCollectionSuccessMeta' x-internal: false diff --git a/reference/channels.v3.yml b/reference/channels.v3.yml index 1876be670..344dff26b 100644 --- a/reference/channels.v3.yml +++ b/reference/channels.v3.yml @@ -2423,8 +2423,7 @@ components: - 125 errors: type: array - items: - $ref: '#/components/schemas/Error' + example: [] meta: $ref: '#/components/schemas/WriteCollectionSuccessMeta' x-internal: false diff --git a/reference/customers.v3.yml b/reference/customers.v3.yml index 84393e390..1d79727c8 100644 --- a/reference/customers.v3.yml +++ b/reference/customers.v3.yml @@ -4182,8 +4182,7 @@ components: - 125 errors: type: array - items: - $ref: '#/components/schemas/Error' + example: [] meta: $ref: '#/components/schemas/WriteCollectionSuccessMeta' x-internal: false diff --git a/reference/orders.v3.yml b/reference/orders.v3.yml index 5edcf54de..c3b0f14e7 100644 --- a/reference/orders.v3.yml +++ b/reference/orders.v3.yml @@ -3058,8 +3058,7 @@ components: - 125 errors: type: array - items: - $ref: '#/components/schemas/Error' + example: [] meta: $ref: '#/components/schemas/WriteCollectionSuccessMeta' x-internal: false From 2b543f8911300169c1b8bd4d841b088a82a344a4 Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Wed, 7 Feb 2024 16:47:23 -0600 Subject: [PATCH 31/41] update tags (batch metafields) --- reference/carts.v3.yml | 9 +++++---- reference/catalog/brands_catalog.v3.yml | 9 +++++---- reference/catalog/categories_catalog.v3.yml | 9 +++++---- reference/catalog/product-variants_catalog.v3.yml | 9 +++++---- reference/catalog/products_catalog.v3.yml | 9 +++++---- reference/channels.v3.yml | 9 +++++---- reference/customers.v3.yml | 9 +++++---- reference/orders.v3.yml | 9 +++++---- 8 files changed, 40 insertions(+), 32 deletions(-) diff --git a/reference/carts.v3.yml b/reference/carts.v3.yml index 3279abcff..e1423db2b 100644 --- a/reference/carts.v3.yml +++ b/reference/carts.v3.yml @@ -26,6 +26,7 @@ tags: - name: Redirects - name: Settings - name: Metafields + - name: Batch metafields paths: '/carts': parameters: @@ -932,7 +933,7 @@ paths: get: summary: Get All Metafields tags: - - Metafields + - Batch metafields description: Get all cart metafields. operationId: getCartsMetafields responses: @@ -956,7 +957,7 @@ paths: post: summary: Create multiple Metafields tags: - - Metafields + - Batch metafields description: Create multiple metafields. operationId: createCartsMetafields requestBody: @@ -997,7 +998,7 @@ paths: put: summary: Update multiple Metafields tags: - - Metafields + - Batch metafields description: Create multiple metafields. operationId: updateCartsMetafields requestBody: @@ -1038,7 +1039,7 @@ paths: delete: summary: Delete All Metafields tags: - - Metafields + - Batch metafields description: Delete all cart metafields. operationId: deleteCartsMetafields requestBody: diff --git a/reference/catalog/brands_catalog.v3.yml b/reference/catalog/brands_catalog.v3.yml index 0628a6104..bc4531338 100644 --- a/reference/catalog/brands_catalog.v3.yml +++ b/reference/catalog/brands_catalog.v3.yml @@ -44,6 +44,7 @@ tags: - name: Brands - name: Images - name: Metafields + - name: Batch metafields paths: '/catalog/brands': get: @@ -1592,7 +1593,7 @@ paths: get: summary: Get All Metafields tags: - - Metafields + - Batch metafields description: Get all brand metafields. operationId: getBrandsMetafields responses: @@ -1616,7 +1617,7 @@ paths: post: summary: Create multiple Metafields tags: - - Metafields + - Batch metafields description: Create multiple metafields. operationId: createBrandsMetafields requestBody: @@ -1657,7 +1658,7 @@ paths: put: summary: Update multiple Metafields tags: - - Metafields + - Batch metafields description: Create multiple metafields. operationId: updateBrandsMetafields requestBody: @@ -1698,7 +1699,7 @@ paths: delete: summary: Delete All Metafields tags: - - Metafields + - Batch metafields description: Delete all brand metafields. operationId: deleteBrandsMetafields requestBody: diff --git a/reference/catalog/categories_catalog.v3.yml b/reference/catalog/categories_catalog.v3.yml index 4ddb1c18f..90f032519 100644 --- a/reference/catalog/categories_catalog.v3.yml +++ b/reference/catalog/categories_catalog.v3.yml @@ -46,6 +46,7 @@ servers: security: - X-Auth-Token: [] tags: + - name: Batch metafields - name: Metafields - name: Images - name: Sort Order @@ -1787,7 +1788,7 @@ paths: get: summary: Get All Metafields tags: - - Metafields + - Batch metafields description: Get all category metafields. operationId: getCategoriesMetafields responses: @@ -1811,7 +1812,7 @@ paths: post: summary: Create multiple Metafields tags: - - Metafields + - Batch metafields description: Create multiple metafields. operationId: createCategoriesMetafields requestBody: @@ -1852,7 +1853,7 @@ paths: put: summary: Update multiple Metafields tags: - - Metafields + - Batch metafields description: Create multiple metafields. operationId: updateCategoriesMetafields requestBody: @@ -1893,7 +1894,7 @@ paths: delete: summary: Delete All Metafields tags: - - Metafields + - Batch metafields description: Delete all category metafields. operationId: deleteCategoriesMetafields requestBody: diff --git a/reference/catalog/product-variants_catalog.v3.yml b/reference/catalog/product-variants_catalog.v3.yml index 8844eb6c0..074d7bac7 100644 --- a/reference/catalog/product-variants_catalog.v3.yml +++ b/reference/catalog/product-variants_catalog.v3.yml @@ -47,6 +47,7 @@ servers: security: - X-Auth-Token: [] tags: + - name: Batch metafields - name: Product Variants - name: Variants (Batch) - name: Metafields @@ -1720,7 +1721,7 @@ paths: get: summary: Get All Metafields tags: - - Metafields + - Batch metafields description: Get all variant metafields. operationId: getVariantsMetafields responses: @@ -1744,7 +1745,7 @@ paths: post: summary: Create multiple Metafields tags: - - Metafields + - Batch metafields description: Create multiple metafields. operationId: createVariantsMetafields requestBody: @@ -1785,7 +1786,7 @@ paths: put: summary: Update multiple Metafields tags: - - Metafields + - Batch metafields description: Create multiple metafields. operationId: updateVariantsMetafields requestBody: @@ -1826,7 +1827,7 @@ paths: delete: summary: Delete All Metafields tags: - - Metafields + - Batch metafields description: Delete all variant metafields. operationId: deleteVariantsMetafields requestBody: diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml index b4771c908..a143cba3e 100644 --- a/reference/catalog/products_catalog.v3.yml +++ b/reference/catalog/products_catalog.v3.yml @@ -42,6 +42,7 @@ servers: security: - X-Auth-Token: [] tags: + - name: Batch metafields - name: Products - name: Bulk Pricing Rules - name: Complex Rules @@ -6289,7 +6290,7 @@ paths: get: summary: Get All Metafields tags: - - Metafields + - Batch metafields description: Get all product metafields. operationId: getProductsMetafields responses: @@ -6313,7 +6314,7 @@ paths: post: summary: Create multiple Metafields tags: - - Metafields + - Batch metafields description: Create multiple metafields. operationId: createProductsMetafields requestBody: @@ -6354,7 +6355,7 @@ paths: put: summary: Update multiple Metafields tags: - - Metafields + - Batch metafields description: Create multiple metafields. operationId: updateProductsMetafields requestBody: @@ -6395,7 +6396,7 @@ paths: delete: summary: Delete All Metafields tags: - - Metafields + - Batch metafields description: Delete all product metafields. operationId: deleteProductsMetafields requestBody: diff --git a/reference/channels.v3.yml b/reference/channels.v3.yml index 344dff26b..476a0a58d 100644 --- a/reference/channels.v3.yml +++ b/reference/channels.v3.yml @@ -94,6 +94,7 @@ servers: security: - X-Auth-Token: [] tags: + - name: Batch metafields - name: Channels - name: Metafields - name: Menus @@ -762,7 +763,7 @@ paths: get: summary: Get All Metafields tags: - - Metafields + - Batch metafields description: Get all channel metafields. operationId: getChannelsMetafields responses: @@ -786,7 +787,7 @@ paths: post: summary: Create multiple Metafields tags: - - Metafields + - Batch metafields description: Create multiple metafields. operationId: createChannelsMetafields requestBody: @@ -817,7 +818,7 @@ paths: put: summary: Update multiple Metafields tags: - - Metafields + - Batch metafields description: Update multiple metafields. operationId: updateChannelsMetafields requestBody: @@ -848,7 +849,7 @@ paths: delete: summary: Delete All Metafields tags: - - Metafields + - Batch metafields description: Delete all channel metafields. operationId: deleteChannelsMetafields requestBody: diff --git a/reference/customers.v3.yml b/reference/customers.v3.yml index 1d79727c8..92cfe7fe3 100644 --- a/reference/customers.v3.yml +++ b/reference/customers.v3.yml @@ -22,6 +22,7 @@ servers: security: - X-Auth-Token: [] tags: + - name: Batch metafields - name: Customers description: BigCommerce Customers API Definition. - name: Consent @@ -1626,7 +1627,7 @@ paths: get: summary: Get All Metafields tags: - - Metafields + - Batch metafields description: Get all customer metafields. operationId: getCustomersMetafields responses: @@ -1650,7 +1651,7 @@ paths: post: summary: Create multiple Metafields tags: - - Metafields + - Batch metafields description: Create multiple metafields. operationId: createCustomersMetafields requestBody: @@ -1691,7 +1692,7 @@ paths: put: summary: Update multiple Metafields tags: - - Metafields + - Batch metafields description: Create multiple metafields. operationId: updateCustomersMetafields requestBody: @@ -1732,7 +1733,7 @@ paths: delete: summary: Delete All Metafields tags: - - Metafields + - Batch metafields description: Delete all customer metafields. operationId: deleteCustomersMetafields requestBody: diff --git a/reference/orders.v3.yml b/reference/orders.v3.yml index c3b0f14e7..674865d3f 100644 --- a/reference/orders.v3.yml +++ b/reference/orders.v3.yml @@ -24,6 +24,7 @@ tags: - name: Payment Actions - name: Transactions - name: Order Settings + - name: Batch metafields paths: '/orders/{order_id}/payment_actions/capture': post: @@ -867,7 +868,7 @@ paths: get: summary: Get All Metafields tags: - - Metafields + - Batch metafields description: Get all order metafields. operationId: getOrdersMetafields responses: @@ -891,7 +892,7 @@ paths: post: summary: Create multiple Metafields tags: - - Metafields + - Batch metafields description: Create multiple metafields. operationId: createOrdersMetafields requestBody: @@ -932,7 +933,7 @@ paths: put: summary: Update multiple Metafields tags: - - Metafields + - Batch metafields description: Create multiple metafields. operationId: updateOrdersMetafields requestBody: @@ -973,7 +974,7 @@ paths: delete: summary: Delete All Metafields tags: - - Metafields + - Batch metafields description: Delete all order metafields. operationId: deleteOrdersMetafields requestBody: From 97492a7c34fa1bfecbc1d7168b4548981e256423 Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Wed, 7 Feb 2024 17:00:04 -0600 Subject: [PATCH 32/41] fix typo --- reference/catalog/products_catalog.v3.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml index a143cba3e..0aa02ad7e 100644 --- a/reference/catalog/products_catalog.v3.yml +++ b/reference/catalog/products_catalog.v3.yml @@ -6356,7 +6356,7 @@ paths: summary: Update multiple Metafields tags: - Batch metafields - description: Create multiple metafields. + description: Update multiple metafields. operationId: updateProductsMetafields requestBody: content: From f2f85719ec4ef4b8dee426817a04d5c82a375389 Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Wed, 7 Feb 2024 17:54:29 -0600 Subject: [PATCH 33/41] update 422 responses --- reference/carts.v3.yml | 15 +++++---------- reference/catalog/brands_catalog.v3.yml | 15 +++++---------- reference/catalog/categories_catalog.v3.yml | 15 +++++---------- reference/catalog/product-variants_catalog.v3.yml | 15 +++++---------- reference/catalog/products_catalog.v3.yml | 15 +++++---------- reference/channels.v3.yml | 15 +++++---------- reference/customers.v3.yml | 15 +++++---------- reference/orders.v3.yml | 15 +++++---------- 8 files changed, 40 insertions(+), 80 deletions(-) diff --git a/reference/carts.v3.yml b/reference/carts.v3.yml index e1423db2b..b4ab33209 100644 --- a/reference/carts.v3.yml +++ b/reference/carts.v3.yml @@ -992,7 +992,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse_Batch' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' '500': description: Internal Server Error put: @@ -1033,7 +1033,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse_Batch' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' '500': description: Internal Server Error delete: @@ -1064,7 +1064,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' components: schemas: CartUpdateRequest: @@ -3293,19 +3293,14 @@ components: meta: $ref: '#/components/schemas/WriteCollectionSuccessMeta' x-internal: false - MetaFieldCollectionDeleteResponsePartialSuccess: + MetaFieldCollectionResponsePartialSuccess: type: object description: | Response payload for the BigCommerce API. properties: data: type: array - items: - type: integer - description: | - The unique identifier for the metafield. - example: - - 123 + example: [] errors: type: array items: diff --git a/reference/catalog/brands_catalog.v3.yml b/reference/catalog/brands_catalog.v3.yml index bc4531338..796d7c846 100644 --- a/reference/catalog/brands_catalog.v3.yml +++ b/reference/catalog/brands_catalog.v3.yml @@ -1652,7 +1652,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' '500': description: Internal Server Error put: @@ -1693,7 +1693,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' '500': description: Internal Server Error delete: @@ -1724,7 +1724,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' components: schemas: brand_Full: @@ -2118,19 +2118,14 @@ components: meta: $ref: '#/components/schemas/CollectionMeta' x-internal: false - MetaFieldCollectionDeleteResponsePartialSuccess: + MetaFieldCollectionResponsePartialSuccess: type: object description: | Response payload for the BigCommerce API. properties: data: type: array - items: - type: integer - description: | - The unique identifier for the metafield. - example: - - 123 + example: [] errors: type: array items: diff --git a/reference/catalog/categories_catalog.v3.yml b/reference/catalog/categories_catalog.v3.yml index 90f032519..9ed085705 100644 --- a/reference/catalog/categories_catalog.v3.yml +++ b/reference/catalog/categories_catalog.v3.yml @@ -1847,7 +1847,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' '500': description: Internal Server Error put: @@ -1888,7 +1888,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' '500': description: Internal Server Error delete: @@ -1919,7 +1919,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' components: schemas: category_Full: @@ -2552,19 +2552,14 @@ components: meta: $ref: '#/components/schemas/CollectionMeta' x-internal: false - MetaFieldCollectionDeleteResponsePartialSuccess: + MetaFieldCollectionResponsePartialSuccess: type: object description: | Response payload for the BigCommerce API. properties: data: type: array - items: - type: integer - description: | - The unique identifier for the metafield. - example: - - 123 + example: [] errors: type: array items: diff --git a/reference/catalog/product-variants_catalog.v3.yml b/reference/catalog/product-variants_catalog.v3.yml index 074d7bac7..f58425086 100644 --- a/reference/catalog/product-variants_catalog.v3.yml +++ b/reference/catalog/product-variants_catalog.v3.yml @@ -1780,7 +1780,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' '500': description: Internal Server Error put: @@ -1821,7 +1821,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' '500': description: Internal Server Error delete: @@ -1852,7 +1852,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' components: schemas: categoriesTree_Resp: @@ -2603,19 +2603,14 @@ components: meta: $ref: '#/components/schemas/CollectionMeta' x-internal: false - MetaFieldCollectionDeleteResponsePartialSuccess: + MetaFieldCollectionResponsePartialSuccess: type: object description: | Response payload for the BigCommerce API. properties: data: type: array - items: - type: integer - description: | - The unique identifier for the metafield. - example: - - 123 + example: [] errors: type: array items: diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml index 0aa02ad7e..a94d5f30b 100644 --- a/reference/catalog/products_catalog.v3.yml +++ b/reference/catalog/products_catalog.v3.yml @@ -6349,7 +6349,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' '500': description: Internal Server Error put: @@ -6390,7 +6390,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' '500': description: Internal Server Error delete: @@ -6421,7 +6421,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' components: schemas: productModifier_Base: @@ -8889,19 +8889,14 @@ components: meta: $ref: '#/components/schemas/CollectionMeta' x-internal: false - MetaFieldCollectionDeleteResponsePartialSuccess: + MetaFieldCollectionResponsePartialSuccess: type: object description: | Response payload for the BigCommerce API. properties: data: type: array - items: - type: integer - description: | - The unique identifier for the metafield. - example: - - 123 + example: [] errors: type: array items: diff --git a/reference/channels.v3.yml b/reference/channels.v3.yml index 476a0a58d..013bcad06 100644 --- a/reference/channels.v3.yml +++ b/reference/channels.v3.yml @@ -812,7 +812,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' '500': description: Internal Server Error put: @@ -843,7 +843,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' '500': description: Internal Server Error delete: @@ -874,7 +874,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' components: parameters: Accept: @@ -2387,19 +2387,14 @@ components: meta: $ref: '#/components/schemas/CollectionMeta' x-internal: false - MetaFieldCollectionDeleteResponsePartialSuccess: + MetaFieldCollectionResponsePartialSuccess: type: object description: | Response payload for the BigCommerce API. properties: data: type: array - items: - type: integer - description: | - The unique identifier for the metafield. - example: - - 123 + example: [] errors: type: array items: diff --git a/reference/customers.v3.yml b/reference/customers.v3.yml index 92cfe7fe3..c06d3746d 100644 --- a/reference/customers.v3.yml +++ b/reference/customers.v3.yml @@ -1686,7 +1686,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' '500': description: Internal Server Error put: @@ -1727,7 +1727,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' '500': description: Internal Server Error delete: @@ -1758,7 +1758,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' components: parameters: customerId: @@ -4146,19 +4146,14 @@ components: meta: $ref: '#/components/schemas/CollectionMeta' x-internal: false - MetaFieldCollectionDeleteResponsePartialSuccess: + MetaFieldCollectionResponsePartialSuccess: type: object description: | Response payload for the BigCommerce API. properties: data: type: array - items: - type: integer - description: | - The unique identifier for the metafield. - example: - - 123 + example: [] errors: type: array items: diff --git a/reference/orders.v3.yml b/reference/orders.v3.yml index 674865d3f..22bb1a119 100644 --- a/reference/orders.v3.yml +++ b/reference/orders.v3.yml @@ -927,7 +927,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' '500': description: Internal Server Error put: @@ -968,7 +968,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' '500': description: Internal Server Error delete: @@ -999,7 +999,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionDeleteResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' components: schemas: GetReturnsSettings: @@ -3022,19 +3022,14 @@ components: x-examples: example-1: $ref: '#/components/examples/EnableMultipleOrderNotifications/value' - MetaFieldCollectionDeleteResponsePartialSuccess: + MetaFieldCollectionResponsePartialSuccess: type: object description: | Response payload for the BigCommerce API. properties: data: type: array - items: - type: integer - description: | - The unique identifier for the metafield. - example: - - 123 + example: [] errors: type: array items: From 9d2fd8d327d7805a9d56098a102d9903ca67930c Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Wed, 7 Feb 2024 18:04:24 -0600 Subject: [PATCH 34/41] remove unneeded comment --- reference/carts.v3.yml | 2 +- reference/catalog/categories_catalog.v3.yml | 2 +- reference/catalog/products_catalog.v3.yml | 2 +- reference/channels.v3.yml | 2 +- reference/orders.v3.yml | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/reference/carts.v3.yml b/reference/carts.v3.yml index b4ab33209..222b74042 100644 --- a/reference/carts.v3.yml +++ b/reference/carts.v3.yml @@ -981,7 +981,7 @@ paths: responses: '200': description: | - List of created `Metafield` objects. # TODO + List of created `Metafield` objects. content: application/json: schema: diff --git a/reference/catalog/categories_catalog.v3.yml b/reference/catalog/categories_catalog.v3.yml index 9ed085705..deee62068 100644 --- a/reference/catalog/categories_catalog.v3.yml +++ b/reference/catalog/categories_catalog.v3.yml @@ -1836,7 +1836,7 @@ paths: responses: '200': description: | - List of created `Metafield` objects. # TODO + List of created `Metafield` objects. content: application/json: schema: diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml index a94d5f30b..fc449444b 100644 --- a/reference/catalog/products_catalog.v3.yml +++ b/reference/catalog/products_catalog.v3.yml @@ -6338,7 +6338,7 @@ paths: responses: '200': description: | - List of created `Metafield` objects. # TODO + List of created `Metafield` objects. content: application/json: schema: diff --git a/reference/channels.v3.yml b/reference/channels.v3.yml index 013bcad06..edb093091 100644 --- a/reference/channels.v3.yml +++ b/reference/channels.v3.yml @@ -801,7 +801,7 @@ paths: responses: '200': description: | - List of created `Metafield` objects. # TODO + List of created `Metafield` objects. content: application/json: schema: diff --git a/reference/orders.v3.yml b/reference/orders.v3.yml index 22bb1a119..0cf453003 100644 --- a/reference/orders.v3.yml +++ b/reference/orders.v3.yml @@ -916,7 +916,7 @@ paths: responses: '200': description: | - List of created `Metafield` objects. # TODO + List of created `Metafield` objects. content: application/json: schema: From 10ec93eb84fddcee2810424ae65cd75082618a92 Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Wed, 7 Feb 2024 18:30:30 -0600 Subject: [PATCH 35/41] update POST and PUT 200 responses --- reference/carts.v3.yml | 18 ++++++++++++++++-- reference/catalog/brands_catalog.v3.yml | 18 ++++++++++++++++-- reference/catalog/categories_catalog.v3.yml | 18 ++++++++++++++++-- .../catalog/product-variants_catalog.v3.yml | 18 ++++++++++++++++-- reference/catalog/products_catalog.v3.yml | 18 ++++++++++++++++-- reference/channels.v3.yml | 18 ++++++++++++++++-- reference/customers.v3.yml | 18 ++++++++++++++++-- reference/orders.v3.yml | 19 +++++++++++++++++-- 8 files changed, 129 insertions(+), 16 deletions(-) diff --git a/reference/carts.v3.yml b/reference/carts.v3.yml index 222b74042..4e7f6dcec 100644 --- a/reference/carts.v3.yml +++ b/reference/carts.v3.yml @@ -985,7 +985,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse_Batch' + $ref: '#/components/schemas/MetaFieldCollectionResponse_Batch_POST_PUT' '422': description: | Response object for metafields creation with partial success. @@ -1026,7 +1026,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse_Batch' + $ref: '#/components/schemas/MetaFieldCollectionResponse_Batch_POST_PUT' '422': description: | Response object for metafields creation with partial success. @@ -3272,6 +3272,20 @@ components: $ref: '#/components/schemas/Metafield' meta: $ref: '#/components/schemas/CollectionMeta' + MetaFieldCollectionResponse_Batch_POST_PUT: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + $ref: '#/components/schemas/Metafield' + errors: + type: array + example: [] + meta: + $ref: '#/components/schemas/CollectionMeta' MetaFieldCollectionDeleteResponseSuccess: type: object description: | diff --git a/reference/catalog/brands_catalog.v3.yml b/reference/catalog/brands_catalog.v3.yml index 796d7c846..d7bd019a0 100644 --- a/reference/catalog/brands_catalog.v3.yml +++ b/reference/catalog/brands_catalog.v3.yml @@ -1645,7 +1645,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponse_POST_PUT' '422': description: | Response object for metafields creation with partial success. @@ -1686,7 +1686,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponse_POST_PUT' '422': description: | Response object for metafields creation with partial success. @@ -2118,6 +2118,20 @@ components: meta: $ref: '#/components/schemas/CollectionMeta' x-internal: false + MetaFieldCollectionResponse_POST_PUT: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + $ref: '#/components/schemas/Metafield' + errors: + type: array + example: [] + meta: + $ref: '#/components/schemas/CollectionMeta' MetaFieldCollectionResponsePartialSuccess: type: object description: | diff --git a/reference/catalog/categories_catalog.v3.yml b/reference/catalog/categories_catalog.v3.yml index deee62068..ae7eef459 100644 --- a/reference/catalog/categories_catalog.v3.yml +++ b/reference/catalog/categories_catalog.v3.yml @@ -1840,7 +1840,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponse_POST_PUT' '422': description: | Response object for metafields creation with partial success. @@ -1881,7 +1881,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponse_POST_PUT' '422': description: | Response object for metafields creation with partial success. @@ -2552,6 +2552,20 @@ components: meta: $ref: '#/components/schemas/CollectionMeta' x-internal: false + MetaFieldCollectionResponse_POST_PUT: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + $ref: '#/components/schemas/Metafield' + errors: + type: array + example: [] + meta: + $ref: '#/components/schemas/CollectionMeta' MetaFieldCollectionResponsePartialSuccess: type: object description: | diff --git a/reference/catalog/product-variants_catalog.v3.yml b/reference/catalog/product-variants_catalog.v3.yml index f58425086..35773e65c 100644 --- a/reference/catalog/product-variants_catalog.v3.yml +++ b/reference/catalog/product-variants_catalog.v3.yml @@ -1773,7 +1773,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponse_POST_PUT' '422': description: | Response object for metafields creation with partial success. @@ -1814,7 +1814,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponse_POST_PUT' '422': description: | Response object for metafields creation with partial success. @@ -2603,6 +2603,20 @@ components: meta: $ref: '#/components/schemas/CollectionMeta' x-internal: false + MetaFieldCollectionResponse_POST_PUT: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + $ref: '#/components/schemas/Metafield' + errors: + type: array + example: [] + meta: + $ref: '#/components/schemas/CollectionMeta' MetaFieldCollectionResponsePartialSuccess: type: object description: | diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml index fc449444b..e9968fb7b 100644 --- a/reference/catalog/products_catalog.v3.yml +++ b/reference/catalog/products_catalog.v3.yml @@ -6342,7 +6342,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponse_POST_PUT' '422': description: | Response object for metafields creation with partial success. @@ -6383,7 +6383,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponse_POST_PUT' '422': description: | Response object for metafields creation with partial success. @@ -8889,6 +8889,20 @@ components: meta: $ref: '#/components/schemas/CollectionMeta' x-internal: false + MetaFieldCollectionResponse_POST_PUT: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + $ref: '#/components/schemas/Metafield' + errors: + type: array + example: [] + meta: + $ref: '#/components/schemas/CollectionMeta' MetaFieldCollectionResponsePartialSuccess: type: object description: | diff --git a/reference/channels.v3.yml b/reference/channels.v3.yml index edb093091..36e8226f9 100644 --- a/reference/channels.v3.yml +++ b/reference/channels.v3.yml @@ -805,7 +805,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponse_POST_PUT' '422': description: | Response object for metafields creation with partial success. @@ -836,7 +836,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponse_POST_PUT' '422': description: | Response object for metafields creation with partial success. @@ -2387,6 +2387,20 @@ components: meta: $ref: '#/components/schemas/CollectionMeta' x-internal: false + MetaFieldCollectionResponse_POST_PUT: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + $ref: '#/components/schemas/Metafield' + errors: + type: array + example: [] + meta: + $ref: '#/components/schemas/CollectionMeta' MetaFieldCollectionResponsePartialSuccess: type: object description: | diff --git a/reference/customers.v3.yml b/reference/customers.v3.yml index c06d3746d..15b19e0ed 100644 --- a/reference/customers.v3.yml +++ b/reference/customers.v3.yml @@ -1679,7 +1679,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponse_POST_PUT' '422': description: | Response object for metafields creation with partial success. @@ -1720,7 +1720,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponse_POST_PUT' '422': description: | Response object for metafields creation with partial success. @@ -4146,6 +4146,20 @@ components: meta: $ref: '#/components/schemas/CollectionMeta' x-internal: false + MetaFieldCollectionResponse_POST_PUT: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + $ref: '#/components/schemas/Metafield' + errors: + type: array + example: [] + meta: + $ref: '#/components/schemas/CollectionMeta' MetaFieldCollectionResponsePartialSuccess: type: object description: | diff --git a/reference/orders.v3.yml b/reference/orders.v3.yml index 0cf453003..4a2cba080 100644 --- a/reference/orders.v3.yml +++ b/reference/orders.v3.yml @@ -920,7 +920,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponse_POST_PUT' '422': description: | Response object for metafields creation with partial success. @@ -961,7 +961,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponse' + $ref: '#/components/schemas/MetaFieldCollectionResponse_POST_PUT' '422': description: | Response object for metafields creation with partial success. @@ -2815,6 +2815,21 @@ components: meta: $ref: '#/components/schemas/CollectionMeta' x-internal: false + MetaFieldCollectionResponse_POST_PUT: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + $ref: '#/components/schemas/Metafield' + errors: + type: array + example: [] + meta: + $ref: '#/components/schemas/CollectionMeta' + x-internal: false MetafieldResponse: description: | Response payload for the BigCommerce API. From a5446f71b5dcd81da49aaae0cf1c4df22e89af4e Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Wed, 7 Feb 2024 18:44:54 -0600 Subject: [PATCH 36/41] description for when empty array --- reference/carts.v3.yml | 3 +++ reference/catalog/brands_catalog.v3.yml | 3 +++ reference/catalog/categories_catalog.v3.yml | 3 +++ reference/catalog/product-variants_catalog.v3.yml | 3 +++ reference/catalog/products_catalog.v3.yml | 3 +++ reference/channels.v3.yml | 3 +++ reference/customers.v3.yml | 3 +++ reference/orders.v3.yml | 3 +++ 8 files changed, 24 insertions(+) diff --git a/reference/carts.v3.yml b/reference/carts.v3.yml index 4e7f6dcec..f124bc759 100644 --- a/reference/carts.v3.yml +++ b/reference/carts.v3.yml @@ -3283,6 +3283,7 @@ components: $ref: '#/components/schemas/Metafield' errors: type: array + description: Empty for 200 responses. example: [] meta: $ref: '#/components/schemas/CollectionMeta' @@ -3303,6 +3304,7 @@ components: - 125 errors: type: array + description: Empty for 200 responses. example: [] meta: $ref: '#/components/schemas/WriteCollectionSuccessMeta' @@ -3314,6 +3316,7 @@ components: properties: data: type: array + description: Empty for 422 responses. example: [] errors: type: array diff --git a/reference/catalog/brands_catalog.v3.yml b/reference/catalog/brands_catalog.v3.yml index d7bd019a0..66aa91f39 100644 --- a/reference/catalog/brands_catalog.v3.yml +++ b/reference/catalog/brands_catalog.v3.yml @@ -2129,6 +2129,7 @@ components: $ref: '#/components/schemas/Metafield' errors: type: array + description: Empty for 200 responses. example: [] meta: $ref: '#/components/schemas/CollectionMeta' @@ -2139,6 +2140,7 @@ components: properties: data: type: array + description: Empty for 422 responses. example: [] errors: type: array @@ -2164,6 +2166,7 @@ components: - 125 errors: type: array + description: Empty for 200 responses. example: [] meta: $ref: '#/components/schemas/WriteCollectionSuccessMeta' diff --git a/reference/catalog/categories_catalog.v3.yml b/reference/catalog/categories_catalog.v3.yml index ae7eef459..cd33a4407 100644 --- a/reference/catalog/categories_catalog.v3.yml +++ b/reference/catalog/categories_catalog.v3.yml @@ -2563,6 +2563,7 @@ components: $ref: '#/components/schemas/Metafield' errors: type: array + description: Empty for 200 responses. example: [] meta: $ref: '#/components/schemas/CollectionMeta' @@ -2573,6 +2574,7 @@ components: properties: data: type: array + description: Empty for 422 responses. example: [] errors: type: array @@ -2598,6 +2600,7 @@ components: - 125 errors: type: array + description: Empty for 200 responses. example: [] meta: $ref: '#/components/schemas/WriteCollectionSuccessMeta' diff --git a/reference/catalog/product-variants_catalog.v3.yml b/reference/catalog/product-variants_catalog.v3.yml index 35773e65c..0ee6349be 100644 --- a/reference/catalog/product-variants_catalog.v3.yml +++ b/reference/catalog/product-variants_catalog.v3.yml @@ -2614,6 +2614,7 @@ components: $ref: '#/components/schemas/Metafield' errors: type: array + description: Empty for 200 responses. example: [] meta: $ref: '#/components/schemas/CollectionMeta' @@ -2624,6 +2625,7 @@ components: properties: data: type: array + description: Empty for 422 responses. example: [] errors: type: array @@ -2649,6 +2651,7 @@ components: - 125 errors: type: array + description: Empty for 200 responses. example: [] meta: $ref: '#/components/schemas/WriteCollectionSuccessMeta' diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml index e9968fb7b..6914dd1f0 100644 --- a/reference/catalog/products_catalog.v3.yml +++ b/reference/catalog/products_catalog.v3.yml @@ -8900,6 +8900,7 @@ components: $ref: '#/components/schemas/Metafield' errors: type: array + description: Empty for 200 responses. example: [] meta: $ref: '#/components/schemas/CollectionMeta' @@ -8910,6 +8911,7 @@ components: properties: data: type: array + description: Empty for 422 responses. example: [] errors: type: array @@ -8935,6 +8937,7 @@ components: - 125 errors: type: array + description: Empty for 200 responses. example: [] meta: $ref: '#/components/schemas/WriteCollectionSuccessMeta' diff --git a/reference/channels.v3.yml b/reference/channels.v3.yml index 36e8226f9..b7453a6c1 100644 --- a/reference/channels.v3.yml +++ b/reference/channels.v3.yml @@ -2398,6 +2398,7 @@ components: $ref: '#/components/schemas/Metafield' errors: type: array + description: Empty for 200 responses. example: [] meta: $ref: '#/components/schemas/CollectionMeta' @@ -2408,6 +2409,7 @@ components: properties: data: type: array + description: Empty for 422 responses. example: [] errors: type: array @@ -2433,6 +2435,7 @@ components: - 125 errors: type: array + description: Empty for 200 responses. example: [] meta: $ref: '#/components/schemas/WriteCollectionSuccessMeta' diff --git a/reference/customers.v3.yml b/reference/customers.v3.yml index 15b19e0ed..11c49ac15 100644 --- a/reference/customers.v3.yml +++ b/reference/customers.v3.yml @@ -4157,6 +4157,7 @@ components: $ref: '#/components/schemas/Metafield' errors: type: array + description: Empty for 200 responses. example: [] meta: $ref: '#/components/schemas/CollectionMeta' @@ -4167,6 +4168,7 @@ components: properties: data: type: array + description: Empty for 422 responses. example: [] errors: type: array @@ -4192,6 +4194,7 @@ components: - 125 errors: type: array + description: Empty for 200 responses. example: [] meta: $ref: '#/components/schemas/WriteCollectionSuccessMeta' diff --git a/reference/orders.v3.yml b/reference/orders.v3.yml index 4a2cba080..19fad56bf 100644 --- a/reference/orders.v3.yml +++ b/reference/orders.v3.yml @@ -2826,6 +2826,7 @@ components: $ref: '#/components/schemas/Metafield' errors: type: array + description: Empty for 200 responses. example: [] meta: $ref: '#/components/schemas/CollectionMeta' @@ -3044,6 +3045,7 @@ components: properties: data: type: array + description: Empty for 422 responses. example: [] errors: type: array @@ -3069,6 +3071,7 @@ components: - 125 errors: type: array + description: Empty for 200 responses. example: [] meta: $ref: '#/components/schemas/WriteCollectionSuccessMeta' From 6430f433fd2d515a976facc2afde92f039753967 Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Wed, 7 Feb 2024 18:51:16 -0600 Subject: [PATCH 37/41] add owner client id example --- reference/carts.v3.yml | 1 + reference/catalog/brands_catalog.v3.yml | 1 + reference/catalog/categories_catalog.v3.yml | 1 + reference/catalog/product-variants_catalog.v3.yml | 1 + reference/catalog/products_catalog.v3.yml | 1 + reference/channels.v3.yml | 1 + reference/customers.v3.yml | 1 + reference/orders.v3.yml | 1 + 8 files changed, 8 insertions(+) diff --git a/reference/carts.v3.yml b/reference/carts.v3.yml index f124bc759..e97bfd5a2 100644 --- a/reference/carts.v3.yml +++ b/reference/carts.v3.yml @@ -3123,6 +3123,7 @@ components: owner_client_id: type: string description: Client ID for the metafieldʼs creator. + example: asdfasdfasdfasdfasdfasdfasdf readOnly: true x-internal: false MetafieldBase: diff --git a/reference/catalog/brands_catalog.v3.yml b/reference/catalog/brands_catalog.v3.yml index 66aa91f39..16fa0797a 100644 --- a/reference/catalog/brands_catalog.v3.yml +++ b/reference/catalog/brands_catalog.v3.yml @@ -2094,6 +2094,7 @@ components: owner_client_id: type: string description: Client ID for the metafieldʼs creator. + example: asdfasdfasdfasdfasdfasdfasdf readOnly: true required: - namespace diff --git a/reference/catalog/categories_catalog.v3.yml b/reference/catalog/categories_catalog.v3.yml index cd33a4407..bd43b0af2 100644 --- a/reference/catalog/categories_catalog.v3.yml +++ b/reference/catalog/categories_catalog.v3.yml @@ -2528,6 +2528,7 @@ components: owner_client_id: type: string description: Client ID for the metafieldʼs creator. + example: asdfasdfasdfasdfasdfasdfasdf readOnly: true required: - namespace diff --git a/reference/catalog/product-variants_catalog.v3.yml b/reference/catalog/product-variants_catalog.v3.yml index 0ee6349be..822649175 100644 --- a/reference/catalog/product-variants_catalog.v3.yml +++ b/reference/catalog/product-variants_catalog.v3.yml @@ -2579,6 +2579,7 @@ components: owner_client_id: type: string description: Client ID for the metafieldʼs creator. + example: asdfasdfasdfasdfasdfasdfasdf readOnly: true required: - namespace diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml index 6914dd1f0..562f99813 100644 --- a/reference/catalog/products_catalog.v3.yml +++ b/reference/catalog/products_catalog.v3.yml @@ -8865,6 +8865,7 @@ components: owner_client_id: type: string description: Client ID for the metafieldʼs creator. + example: asdfasdfasdfasdfasdfasdfasdf readOnly: true required: - namespace diff --git a/reference/channels.v3.yml b/reference/channels.v3.yml index b7453a6c1..c0fa93dd9 100644 --- a/reference/channels.v3.yml +++ b/reference/channels.v3.yml @@ -2363,6 +2363,7 @@ components: owner_client_id: type: string description: Client ID for the metafieldʼs creator. + example: asdfasdfasdfasdfasdfasdfasdf readOnly: true required: - namespace diff --git a/reference/customers.v3.yml b/reference/customers.v3.yml index 11c49ac15..a1625b405 100644 --- a/reference/customers.v3.yml +++ b/reference/customers.v3.yml @@ -4122,6 +4122,7 @@ components: owner_client_id: type: string description: Client ID for the metafieldʼs creator. + example: asdfasdfasdfasdfasdfasdfasdf readOnly: true required: - namespace diff --git a/reference/orders.v3.yml b/reference/orders.v3.yml index 19fad56bf..f151e5c85 100644 --- a/reference/orders.v3.yml +++ b/reference/orders.v3.yml @@ -2996,6 +2996,7 @@ components: owner_client_id: type: string description: Client ID for the metafieldʼs creator. + example: asdfasdfasdfasdfasdfasdfasdf readOnly: true x-internal: false x-examples: {} From b284075adf8f0ac1e86289dc01c1369ec01666f5 Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Fri, 9 Feb 2024 10:26:01 -0600 Subject: [PATCH 38/41] update 422 responses for carts metafields --- reference/carts.v3.yml | 29 ++++++++++++++++++++++++----- 1 file changed, 24 insertions(+), 5 deletions(-) diff --git a/reference/carts.v3.yml b/reference/carts.v3.yml index e97bfd5a2..fde13cd9a 100644 --- a/reference/carts.v3.yml +++ b/reference/carts.v3.yml @@ -1033,7 +1033,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_POST_PUT' '500': description: Internal Server Error delete: @@ -1064,7 +1064,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_DELETE' components: schemas: CartUpdateRequest: @@ -3310,15 +3310,34 @@ components: meta: $ref: '#/components/schemas/WriteCollectionSuccessMeta' x-internal: false - MetaFieldCollectionResponsePartialSuccess: + MetaFieldCollectionResponsePartialSuccess_POST_PUT: type: object description: | Response payload for the BigCommerce API. properties: data: type: array - description: Empty for 422 responses. - example: [] + items: + $ref: '#/components/schemas/Metafield' + errors: + type: array + items: + $ref: '#/components/schemas/Error' + meta: + $ref: '#/components/schemas/WriteCollectionPartialSuccessMeta' + MetaFieldCollectionResponsePartialSuccess_DELETE: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + type: integer + description: | + The unique identifier for the metafield. + example: + - 123 errors: type: array items: From 8d7a739dc6c611bc2467f3e6989dd189f8185338 Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Fri, 9 Feb 2024 10:28:49 -0600 Subject: [PATCH 39/41] update 422 response for carts metafields --- reference/carts.v3.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/carts.v3.yml b/reference/carts.v3.yml index fde13cd9a..04c4d480a 100644 --- a/reference/carts.v3.yml +++ b/reference/carts.v3.yml @@ -992,7 +992,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_POST_PUT' '500': description: Internal Server Error put: From a5701d7fe113c27c32293bab273cb6f43c244699 Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Fri, 9 Feb 2024 10:49:59 -0600 Subject: [PATCH 40/41] update 422 responses --- reference/catalog/brands_catalog.v3.yml | 31 +++++++++++++++---- reference/catalog/categories_catalog.v3.yml | 31 +++++++++++++++---- .../catalog/product-variants_catalog.v3.yml | 31 +++++++++++++++---- reference/catalog/products_catalog.v3.yml | 31 +++++++++++++++---- reference/channels.v3.yml | 31 +++++++++++++++---- reference/customers.v3.yml | 31 +++++++++++++++---- reference/orders.v3.yml | 31 +++++++++++++++---- 7 files changed, 175 insertions(+), 42 deletions(-) diff --git a/reference/catalog/brands_catalog.v3.yml b/reference/catalog/brands_catalog.v3.yml index 16fa0797a..066378247 100644 --- a/reference/catalog/brands_catalog.v3.yml +++ b/reference/catalog/brands_catalog.v3.yml @@ -1652,7 +1652,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_POST_PUT' '500': description: Internal Server Error put: @@ -1693,7 +1693,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_POST_PUT' '500': description: Internal Server Error delete: @@ -1724,7 +1724,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_DELETE' components: schemas: brand_Full: @@ -2134,15 +2134,34 @@ components: example: [] meta: $ref: '#/components/schemas/CollectionMeta' - MetaFieldCollectionResponsePartialSuccess: + MetaFieldCollectionResponsePartialSuccess_POST_PUT: type: object description: | Response payload for the BigCommerce API. properties: data: type: array - description: Empty for 422 responses. - example: [] + items: + $ref: '#/components/schemas/Metafield' + errors: + type: array + items: + $ref: '#/components/schemas/Error' + meta: + $ref: '#/components/schemas/WriteCollectionPartialSuccessMeta' + MetaFieldCollectionResponsePartialSuccess_DELETE: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + type: integer + description: | + The unique identifier for the metafield. + example: + - 123 errors: type: array items: diff --git a/reference/catalog/categories_catalog.v3.yml b/reference/catalog/categories_catalog.v3.yml index bd43b0af2..8d79562d4 100644 --- a/reference/catalog/categories_catalog.v3.yml +++ b/reference/catalog/categories_catalog.v3.yml @@ -1847,7 +1847,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_POST_PUT' '500': description: Internal Server Error put: @@ -1888,7 +1888,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_POST_PUT' '500': description: Internal Server Error delete: @@ -1919,7 +1919,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_DELETE' components: schemas: category_Full: @@ -2568,15 +2568,34 @@ components: example: [] meta: $ref: '#/components/schemas/CollectionMeta' - MetaFieldCollectionResponsePartialSuccess: + MetaFieldCollectionResponsePartialSuccess_POST_PUT: type: object description: | Response payload for the BigCommerce API. properties: data: type: array - description: Empty for 422 responses. - example: [] + items: + $ref: '#/components/schemas/Metafield' + errors: + type: array + items: + $ref: '#/components/schemas/Error' + meta: + $ref: '#/components/schemas/WriteCollectionPartialSuccessMeta' + MetaFieldCollectionResponsePartialSuccess_DELETE: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + type: integer + description: | + The unique identifier for the metafield. + example: + - 123 errors: type: array items: diff --git a/reference/catalog/product-variants_catalog.v3.yml b/reference/catalog/product-variants_catalog.v3.yml index 822649175..3f0b8faa6 100644 --- a/reference/catalog/product-variants_catalog.v3.yml +++ b/reference/catalog/product-variants_catalog.v3.yml @@ -1780,7 +1780,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_POST_PUT' '500': description: Internal Server Error put: @@ -1821,7 +1821,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_POST_PUT' '500': description: Internal Server Error delete: @@ -1852,7 +1852,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_DELETE' components: schemas: categoriesTree_Resp: @@ -2619,15 +2619,34 @@ components: example: [] meta: $ref: '#/components/schemas/CollectionMeta' - MetaFieldCollectionResponsePartialSuccess: + MetaFieldCollectionResponsePartialSuccess_POST_PUT: type: object description: | Response payload for the BigCommerce API. properties: data: type: array - description: Empty for 422 responses. - example: [] + items: + $ref: '#/components/schemas/Metafield' + errors: + type: array + items: + $ref: '#/components/schemas/Error' + meta: + $ref: '#/components/schemas/WriteCollectionPartialSuccessMeta' + MetaFieldCollectionResponsePartialSuccess_DELETE: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + type: integer + description: | + The unique identifier for the metafield. + example: + - 123 errors: type: array items: diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml index 562f99813..05ac7c8dd 100644 --- a/reference/catalog/products_catalog.v3.yml +++ b/reference/catalog/products_catalog.v3.yml @@ -6349,7 +6349,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_POST_PUT' '500': description: Internal Server Error put: @@ -6390,7 +6390,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_POST_PUT' '500': description: Internal Server Error delete: @@ -6421,7 +6421,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_DELETE' components: schemas: productModifier_Base: @@ -8905,15 +8905,34 @@ components: example: [] meta: $ref: '#/components/schemas/CollectionMeta' - MetaFieldCollectionResponsePartialSuccess: + MetaFieldCollectionResponsePartialSuccess_POST_PUT: type: object description: | Response payload for the BigCommerce API. properties: data: type: array - description: Empty for 422 responses. - example: [] + items: + $ref: '#/components/schemas/Metafield' + errors: + type: array + items: + $ref: '#/components/schemas/Error' + meta: + $ref: '#/components/schemas/WriteCollectionPartialSuccessMeta' + MetaFieldCollectionResponsePartialSuccess_DELETE: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + type: integer + description: | + The unique identifier for the metafield. + example: + - 123 errors: type: array items: diff --git a/reference/channels.v3.yml b/reference/channels.v3.yml index c0fa93dd9..f33d218e9 100644 --- a/reference/channels.v3.yml +++ b/reference/channels.v3.yml @@ -812,7 +812,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_POST_PUT' '500': description: Internal Server Error put: @@ -843,7 +843,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_POST_PUT' '500': description: Internal Server Error delete: @@ -874,7 +874,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_DELETE' components: parameters: Accept: @@ -2403,15 +2403,34 @@ components: example: [] meta: $ref: '#/components/schemas/CollectionMeta' - MetaFieldCollectionResponsePartialSuccess: + MetaFieldCollectionResponsePartialSuccess_POST_PUT: type: object description: | Response payload for the BigCommerce API. properties: data: type: array - description: Empty for 422 responses. - example: [] + items: + $ref: '#/components/schemas/Metafield' + errors: + type: array + items: + $ref: '#/components/schemas/Error' + meta: + $ref: '#/components/schemas/WriteCollectionPartialSuccessMeta' + MetaFieldCollectionResponsePartialSuccess_DELETE: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + type: integer + description: | + The unique identifier for the metafield. + example: + - 123 errors: type: array items: diff --git a/reference/customers.v3.yml b/reference/customers.v3.yml index a1625b405..fc23dfd46 100644 --- a/reference/customers.v3.yml +++ b/reference/customers.v3.yml @@ -1686,7 +1686,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_POST_PUT' '500': description: Internal Server Error put: @@ -1727,7 +1727,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_POST_PUT' '500': description: Internal Server Error delete: @@ -1758,7 +1758,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_DELETE' components: parameters: customerId: @@ -4162,15 +4162,34 @@ components: example: [] meta: $ref: '#/components/schemas/CollectionMeta' - MetaFieldCollectionResponsePartialSuccess: + MetaFieldCollectionResponsePartialSuccess_POST_PUT: type: object description: | Response payload for the BigCommerce API. properties: data: type: array - description: Empty for 422 responses. - example: [] + items: + $ref: '#/components/schemas/Metafield' + errors: + type: array + items: + $ref: '#/components/schemas/Error' + meta: + $ref: '#/components/schemas/WriteCollectionPartialSuccessMeta' + MetaFieldCollectionResponsePartialSuccess_DELETE: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + type: integer + description: | + The unique identifier for the metafield. + example: + - 123 errors: type: array items: diff --git a/reference/orders.v3.yml b/reference/orders.v3.yml index f151e5c85..f5b4729f0 100644 --- a/reference/orders.v3.yml +++ b/reference/orders.v3.yml @@ -927,7 +927,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_POST_PUT' '500': description: Internal Server Error put: @@ -968,7 +968,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_POST_PUT' '500': description: Internal Server Error delete: @@ -999,7 +999,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess' + $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_DELETE' components: schemas: GetReturnsSettings: @@ -3039,15 +3039,34 @@ components: x-examples: example-1: $ref: '#/components/examples/EnableMultipleOrderNotifications/value' - MetaFieldCollectionResponsePartialSuccess: + MetaFieldCollectionResponsePartialSuccess_POST_PUT: type: object description: | Response payload for the BigCommerce API. properties: data: type: array - description: Empty for 422 responses. - example: [] + items: + $ref: '#/components/schemas/Metafield' + errors: + type: array + items: + $ref: '#/components/schemas/Error' + meta: + $ref: '#/components/schemas/WriteCollectionPartialSuccessMeta' + MetaFieldCollectionResponsePartialSuccess_DELETE: + type: object + description: | + Response payload for the BigCommerce API. + properties: + data: + type: array + items: + type: integer + description: | + The unique identifier for the metafield. + example: + - 123 errors: type: array items: From 11c4b307073bf70c69eb4ea1d7a67f12403565b5 Mon Sep 17 00:00:00 2001 From: Andrea Dao Date: Fri, 9 Feb 2024 11:49:08 -0600 Subject: [PATCH 41/41] incorporate traci's copyedits --- reference/carts.v3.yml | 16 ++++++++-------- reference/catalog/brands_catalog.v3.yml | 16 ++++++++-------- reference/catalog/categories_catalog.v3.yml | 16 ++++++++-------- .../catalog/product-variants_catalog.v3.yml | 16 ++++++++-------- reference/catalog/products_catalog.v3.yml | 16 ++++++++-------- reference/channels.v3.yml | 16 ++++++++-------- reference/customers.v3.yml | 16 ++++++++-------- reference/orders.v3.yml | 6 +++--- 8 files changed, 59 insertions(+), 59 deletions(-) diff --git a/reference/carts.v3.yml b/reference/carts.v3.yml index 04c4d480a..160fab6b2 100644 --- a/reference/carts.v3.yml +++ b/reference/carts.v3.yml @@ -762,7 +762,7 @@ paths: $ref: '#/components/schemas/MetafieldResponse' '409': description: | - The `Metafield` conflicts with another `Metafield`. This can be the result of duplicate unique key combinations of the appʼs client id, namespace, key, resource_type, and resource_id. + The `Metafield` conflicts with another `Metafield`. This can result from duplicate unique key combinations of the appʼs client id, namespace, key, resource_type, and resource_id. content: application/json: schema: @@ -849,7 +849,7 @@ paths: $ref: '#/components/schemas/MetafieldResponse' '409': description: | - The `Metafield` conflicts with another `Metafield`. This can be the result of duplicate unique key combinations of the appʼs client id, namespace, key, resource_type, and resource_id. + The `Metafield` conflicts with another `Metafield`. This can result from duplicate unique key combinations of the appʼs client id, namespace, key, resource_type, and resource_id. content: application/json: schema: @@ -3141,8 +3141,8 @@ components: | `app_only` | Private to the app that owns the field. | | `read` | Visible to other API consumers. | | `write` | Open for reading and writing by other API consumers. | - | `read_and_sf_access` | Visible to other API consumers, including on storefront. | - | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | enum: - app_only - read @@ -3211,8 +3211,8 @@ components: | `app_only` | Private to the app that owns the field. | | `read` | Visible to other API consumers. | | `write` | Open for reading and writing by other API consumers. | - | `read_and_sf_access` | Visible to other API consumers, including on storefront. | - | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | enum: - app_only - read @@ -3590,7 +3590,7 @@ components: MetafieldKeyInParam: name: key:in in: query - description: Filter based on comma separated metafieldʼs keys. Could be used with vanilla `key` query parameter. + description: Filter based on comma-separated metafieldʼs keys. Could be used with vanilla `key` query parameter. required: false style: form explode: false @@ -3608,7 +3608,7 @@ components: MetafieldNamespaceInParam: name: namespace:in in: query - description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. + description: Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. required: false style: form explode: false diff --git a/reference/catalog/brands_catalog.v3.yml b/reference/catalog/brands_catalog.v3.yml index 066378247..6ba41dc7d 100644 --- a/reference/catalog/brands_catalog.v3.yml +++ b/reference/catalog/brands_catalog.v3.yml @@ -2021,8 +2021,8 @@ components: | `app_only` | Private to the app that owns the field. | | `read` | Visible to other API consumers. | | `write` | Open for reading and writing by other API consumers. | - | `read_and_sf_access` | Visible to other API consumers, including on storefront. | - | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | enum: - app_only - read @@ -2337,8 +2337,8 @@ components: | `app_only` | Private to the app that owns the field. | | `read` | Visible to other API consumers. | | `write` | Open for reading and writing by other API consumers. | - | `read_and_sf_access` | Visible to other API consumers, including on storefront. | - | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | enum: - app_only - read @@ -2408,8 +2408,8 @@ components: | `app_only` | Private to the app that owns the field. | | `read` | Visible to other API consumers. | | `write` | Open for reading and writing by other API consumers. | - | `read_and_sf_access` | Visible to other API consumers, including on storefront. | - | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | enum: - app_only - read @@ -2495,7 +2495,7 @@ components: MetafieldKeyInParam: name: key:in in: query - description: Filter based on comma separated metafieldʼs keys. Could be used with vanilla `key` query parameter. + description: Filter based on comma-separated metafieldʼs keys. Could be used with vanilla `key` query parameter. required: false style: form explode: false @@ -2513,7 +2513,7 @@ components: MetafieldNamespaceInParam: name: namespace:in in: query - description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. + description: Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. required: false style: form explode: false diff --git a/reference/catalog/categories_catalog.v3.yml b/reference/catalog/categories_catalog.v3.yml index 8d79562d4..e2c2387b2 100644 --- a/reference/catalog/categories_catalog.v3.yml +++ b/reference/catalog/categories_catalog.v3.yml @@ -2455,8 +2455,8 @@ components: | `app_only` | Private to the app that owns the field. | | `read` | Visible to other API consumers. | | `write` | Open for reading and writing by other API consumers. | - | `read_and_sf_access` | Visible to other API consumers, including on storefront. | - | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | enum: - app_only - read @@ -2781,8 +2781,8 @@ components: | `app_only` | Private to the app that owns the field. | | `read` | Visible to other API consumers. | | `write` | Open for reading and writing by other API consumers. | - | `read_and_sf_access` | Visible to other API consumers, including on storefront. | - | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | enum: - app_only - read @@ -2837,8 +2837,8 @@ components: | `app_only` | Private to the app that owns the field. | | `read` | Visible to other API consumers. | | `write` | Open for reading and writing by other API consumers. | - | `read_and_sf_access` | Visible to other API consumers, including on storefront. | - | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | enum: - app_only - read @@ -2931,7 +2931,7 @@ components: MetafieldKeyInParam: name: key:in in: query - description: Filter based on comma separated metafieldʼs keys. Could be used with vanilla `key` query parameter. + description: Filter based on comma-separated metafieldʼs keys. Could be used with vanilla `key` query parameter. required: false style: form explode: false @@ -2949,7 +2949,7 @@ components: MetafieldNamespaceInParam: name: namespace:in in: query - description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. + description: Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. required: false style: form explode: false diff --git a/reference/catalog/product-variants_catalog.v3.yml b/reference/catalog/product-variants_catalog.v3.yml index 3f0b8faa6..28652f72f 100644 --- a/reference/catalog/product-variants_catalog.v3.yml +++ b/reference/catalog/product-variants_catalog.v3.yml @@ -2506,8 +2506,8 @@ components: | `app_only` | Private to the app that owns the field. | | `read` | Visible to other API consumers. | | `write` | Open for reading and writing by other API consumers. | - | `read_and_sf_access` | Visible to other API consumers, including on storefront. | - | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | enum: - app_only - read @@ -2832,8 +2832,8 @@ components: | `app_only` | Private to the app that owns the field. | | `read` | Visible to other API consumers. | | `write` | Open for reading and writing by other API consumers. | - | `read_and_sf_access` | Visible to other API consumers, including on storefront. | - | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | enum: - app_only - read @@ -2888,8 +2888,8 @@ components: | `app_only` | Private to the app that owns the field. | | `read` | Visible to other API consumers. | | `write` | Open for reading and writing by other API consumers. | - | `read_and_sf_access` | Visible to other API consumers, including on storefront. | - | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | enum: - app_only - read @@ -2983,7 +2983,7 @@ components: MetafieldKeyInParam: name: key:in in: query - description: Filter based on comma separated metafieldʼs keys. Could be used with vanilla `key` query parameter. + description: Filter based on comma-separated metafieldʼs keys. Could be used with vanilla `key` query parameter. required: false style: form explode: false @@ -3001,7 +3001,7 @@ components: MetafieldNamespaceInParam: name: namespace:in in: query - description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. + description: Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. required: false style: form explode: false diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml index 05ac7c8dd..402b0c8ca 100644 --- a/reference/catalog/products_catalog.v3.yml +++ b/reference/catalog/products_catalog.v3.yml @@ -8792,8 +8792,8 @@ components: | `app_only` | Private to the app that owns the field. | | `read` | Visible to other API consumers. | | `write` | Open for reading and writing by other API consumers. | - | `read_and_sf_access` | Visible to other API consumers, including on storefront. | - | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | enum: - app_only - read @@ -9118,8 +9118,8 @@ components: | `app_only` | Private to the app that owns the field. | | `read` | Visible to other API consumers. | | `write` | Open for reading and writing by other API consumers. | - | `read_and_sf_access` | Visible to other API consumers, including on storefront. | - | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | enum: - app_only - read @@ -9174,8 +9174,8 @@ components: | `app_only` | Private to the app that owns the field. | | `read` | Visible to other API consumers. | | `write` | Open for reading and writing by other API consumers. | - | `read_and_sf_access` | Visible to other API consumers, including on storefront. | - | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | enum: - app_only - read @@ -9308,7 +9308,7 @@ components: MetafieldKeyInParam: name: key:in in: query - description: Filter based on comma separated metafieldʼs keys. Could be used with vanilla `key` query parameter. + description: Filter based on comma-separated metafieldʼs keys. Could be used with vanilla `key` query parameter. required: false style: form explode: false @@ -9326,7 +9326,7 @@ components: MetafieldNamespaceInParam: name: namespace:in in: query - description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. + description: Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. required: false style: form explode: false diff --git a/reference/channels.v3.yml b/reference/channels.v3.yml index f33d218e9..477a3182a 100644 --- a/reference/channels.v3.yml +++ b/reference/channels.v3.yml @@ -920,7 +920,7 @@ components: MetafieldKeyInParam: name: key:in in: query - description: Filter based on comma separated metafieldʼs keys. Could be used with vanilla `key` query parameter. + description: Filter based on comma-separated metafieldʼs keys. Could be used with vanilla `key` query parameter. required: false style: form explode: false @@ -938,7 +938,7 @@ components: MetafieldNamespaceInParam: name: namespace:in in: query - description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. + description: Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. required: false style: form explode: false @@ -2290,8 +2290,8 @@ components: | `app_only` | Private to the app that owns the field. | | `read` | Visible to other API consumers. | | `write` | Open for reading and writing by other API consumers. | - | `read_and_sf_access` | Visible to other API consumers, including on storefront. | - | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | enum: - app_only - read @@ -2617,8 +2617,8 @@ components: | `app_only` | Private to the app that owns the field. | | `read` | Visible to other API consumers. | | `write` | Open for reading and writing by other API consumers. | - | `read_and_sf_access` | Visible to other API consumers, including on storefront. | - | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | enum: - app_only - read @@ -2688,8 +2688,8 @@ components: | `app_only` | Private to the app that owns the field. | | `read` | Visible to other API consumers. | | `write` | Open for reading and writing by other API consumers. | - | `read_and_sf_access` | Visible to other API consumers, including on storefront. | - | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | enum: - app_only - read diff --git a/reference/customers.v3.yml b/reference/customers.v3.yml index fc23dfd46..bf6f0664e 100644 --- a/reference/customers.v3.yml +++ b/reference/customers.v3.yml @@ -1786,7 +1786,7 @@ components: MetafieldKeyInParam: name: key:in in: query - description: Filter based on comma separated metafieldʼs keys. Could be used with vanilla `key` query parameter. + description: Filter based on comma-separated metafieldʼs keys. Could be used with vanilla `key` query parameter. required: false style: form explode: false @@ -1804,7 +1804,7 @@ components: MetafieldNamespaceInParam: name: namespace:in in: query - description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. + description: Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. required: false style: form explode: false @@ -4049,8 +4049,8 @@ components: | `app_only` | Private to the app that owns the field. | | `read` | Visible to other API consumers. | | `write` | Open for reading and writing by other API consumers. | - | `read_and_sf_access` | Visible to other API consumers, including on storefront. | - | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | enum: - app_only - read @@ -4375,8 +4375,8 @@ components: | `app_only` | Private to the app that owns the field. | | `read` | Visible to other API consumers. | | `write` | Open for reading and writing by other API consumers. | - | `read_and_sf_access` | Visible to other API consumers, including on storefront. | - | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | enum: - app_only - read @@ -4431,8 +4431,8 @@ components: | `app_only` | Private to the app that owns the field. | | `read` | Visible to other API consumers. | | `write` | Open for reading and writing by other API consumers. | - | `read_and_sf_access` | Visible to other API consumers, including on storefront. | - | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | + | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | + | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | enum: - app_only - read diff --git a/reference/orders.v3.yml b/reference/orders.v3.yml index f5b4729f0..914a0ab66 100644 --- a/reference/orders.v3.yml +++ b/reference/orders.v3.yml @@ -623,7 +623,7 @@ paths: $ref: '#/components/schemas/MetafieldResponse' '409': description: | - The `Metafield` conflicts with another `Metafield`. This can be the result of duplicate unique key combinations of the appʼs client ID, namespace, key, resource_type, and resource_id. + The `Metafield` conflicts with another `Metafield`. This can result from duplicate unique key combinations of the appʼs client id, namespace, key, resource_type, and resource_id. content: application/json: schema: @@ -3706,7 +3706,7 @@ components: MetafieldKeyInParam: name: key:in in: query - description: Filter based on comma separated metafieldʼs keys. Could be used with vanilla `key` query parameter. + description: Filter based on comma-separated metafieldʼs keys. Could be used with vanilla `key` query parameter. required: false style: form explode: false @@ -3725,7 +3725,7 @@ components: MetafieldNamespaceInParam: name: namespace:in in: query - description: Filter based on comma separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. + description: Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. required: false style: form explode: false