From 20525cb83f9982bb76cd80544fe8368d11321fa3 Mon Sep 17 00:00:00 2001 From: Sarah Riehl Date: Mon, 6 May 2024 16:48:02 -0500 Subject: [PATCH] ISSUE-249: [update] Spectral & OAS, add obj properties and array items to linter + fixes (#254) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * #249 ## What changed? * Update spectral linter to remove old caveats * Update spectral linter to add the following requirements * all objects have a properties attribute * all arrays have an items attribute * all schemas with a properties attribute have type: object * Update the spec files to meet the new linting requirements ## Release notes draft * ## Anything else? ping @jb-gourav --- .spectral.yaml | 131 ++-- reference/.spectral.yaml | 4 - reference/abandoned_cart_emails.v3.yaml | 1 + reference/abandoned_carts.v3.yml | 3 + reference/carts.sf.yml | 45 +- reference/carts.v3.yml | 29 +- reference/catalog/brands_catalog.v3.yml | 4 + reference/catalog/categories_catalog.v3.yml | 5 + .../catalog/product-modifiers_catalog.v3.yml | 12 - .../product-variant-options_catalog.v3.yml | 20 +- .../catalog/product-variants_catalog.v3.yml | 10 +- reference/catalog/products_catalog.v3.yml | 24 +- reference/channels.v3.yml | 13 +- reference/checkouts.sf.yml | 565 +++++++++--------- reference/checkouts.v3.yml | 14 +- reference/consent.sf.yml | 5 + reference/currencies.v2.yml | 4 + reference/current_customer.yml | 7 +- reference/custom-template-associations.v3.yml | 3 + reference/customer_login.yml | 2 + reference/customers.sf.yml | 5 + reference/customers.v3.yml | 213 ++++--- reference/email_templates.v3.yml | 3 + reference/form_fields.sf.yml | 5 + reference/geography.v2.yml | 32 +- reference/marketing.v2.yml | 14 +- reference/orders.sf.yml | 2 + reference/orders.v2.oas2.yml | 36 +- reference/orders.v3.yml | 97 +-- reference/pages.v3.yml | 365 ++++------- .../payments/accepted-methods_payments.v3.yml | 5 + .../payments/access-tokens_payments.v3.yml | 6 + reference/payments/process_payments.yml | 4 + reference/price_lists.v3.yml | 196 +++--- reference/settings.v3.yml | 90 +-- reference/shipping.v2.yml | 127 ++-- reference/shipping.v3.yml | 4 +- reference/shipping_provider.yml | 4 + reference/sites.v3.yml | 2 + reference/store_content.v2.yml | 12 +- reference/store_logs.v3.yml | 1 + reference/storefront_tokens.v3.yml | 1 + reference/subscribers.v3.yml | 5 +- reference/tax_properties.v3.yml | 2 + reference/tax_provider.yml | 10 +- reference/themes.v3.yml | 37 +- reference/webhooks.v3.yml | 257 ++++---- reference/widgets.v3.yml | 26 +- reference/wishlists.v3.yml | 2 + 49 files changed, 1170 insertions(+), 1294 deletions(-) diff --git a/.spectral.yaml b/.spectral.yaml index 27c0c07b7..a2fa648a4 100644 --- a/.spectral.yaml +++ b/.spectral.yaml @@ -1,93 +1,44 @@ extends: spectral:oas rules: - info-contact: off oas3-unused-component: off - oas2-unused-definition: off -except: - 'reference/tax_provider.yml': - - oas3-schema - 'reference/carts.v3.yml': - - oas2-oneOf - - oas2-valid-schema-example - - operation-tag-defined - 'reference/catalog.v3.yml': - - oas2-operation-security-defined - - oas3-schema - - oas2-schema - - oas2-valid-media-example - - oas2-valid-schema-example - 'reference/channels.v3.yml': - - oas3-schema - - oas3-valid-media-example - 'reference/current_customer.yml': - - operation-success-response - 'reference/custom-template-associations.v3.yml': - - openapi-tags - - operation-tag-defined - 'reference/customer_login.yml': - - operation-success-response - 'reference/email_templates.v3.yml': - - oas3-schema - 'reference/geography.v2.yml': - - oas2-valid-media-example - 'reference/orders.v2.oas2.yml': - - oas3-valid-schema-example - - oas3-valid-media-example - - oas3-schema - 'reference/orders.v3.yml': - - oas2-valid-schema-example - - oas2-valid-media-example - - oas2-anyOf - 'reference/settings.v3.yml': - - oas3-valid-media-example - 'reference/sites.v3.yml': - - oas2-valid-media-example - 'reference/store_information.v2.yml': - - oas2-valid-media-example - - oas2-valid-schema-example - 'reference/themes.v3.yml': - - oas3-schema - 'reference/webhooks.v3.yml': - - oas3-valid-media-example - 'carts.v3.yml': - - oas2-oneOf - - oas2-valid-schema-example - 'catalog.v3.yml': - - oas2-operation-security-defined - - oas3-schema - - oas2-schema - - oas2-valid-media-example - - oas2-valid-schema-example - 'channels.v3.yml': - - oas3-schema - - oas3-valid-media-example - 'current_customer.yml': - - operation-success-response - 'customer_login.yml': - - operation-success-response - 'email_templates.v3.yml': - - oas3-schema - 'geography.v2.yml': - - oas2-valid-media-example - 'orders.v2.oas2.yml': - - oas3-valid-schema-example - - oas3-valid-media-example - - oas3-schema - 'orders.v3.yml': - - oas2-valid-schema-example - - oas2-valid-media-example - - oas2-anyOf - 'settings.v3.yml': - - oas3-valid-media-example - 'sites.v3.yml': - - oas2-valid-media-example - 'store_information.v2.yml': - - oas2-valid-media-example - - oas2-valid-schema-example - 'themes.v3.yml': - - oas3-schema - 'webhooks.v3.yml': - - oas3-valid-media-example - 'pages.v3.yml': - - oas3-valid-media-example - - oas3-valid-schema-example + properties-type-object: + description: "type: object must have a properties sibling." + given: "$..[?(@ && @.type == 'object')]" + severity: error + # must not be resolved because $ref-defined objects shall have its type + # defined in the referenced schema, not the referencing field (and $ref + # must be the only property, anyway) + resolved: false + # type field must be defined and contain the value object + then: + - field: "properties" + function: "truthy" + items-type-array: + description: "type: array must have an items sibling." + given: "$..[?(@ && @.type == 'array')]" + severity: error + # must not be resolved because $ref-defined objects shall have its type + # defined in the referenced schema, not the referencing field (and $ref + # must be the only property, anyway) + resolved: false + # type field must be defined and contain the value object + then: + - field: "items" + function: "truthy" + type-object-properties: + description: "Objects with properties must have type: object." + given: "$..[?(@ && @.properties)]" + severity: error + # must not be resolved because $ref-defined objects shall have its type + # defined in the referenced schema, not the referencing field (and $ref + # must be the only property, anyway) + resolved: false + # type field must be defined and contain the value object + then: + - field: "type" + function: defined + - field: "type" + function: enumeration + functionOptions: + values: + - object diff --git a/reference/.spectral.yaml b/reference/.spectral.yaml index ed9abd2b9..f38a96245 100644 --- a/reference/.spectral.yaml +++ b/reference/.spectral.yaml @@ -1,7 +1,3 @@ extends: - spectral:oas - ../.spectral.yaml -rules: - info-contact: off - oas3-unused-components: off - oas2-unused-definition: off \ No newline at end of file diff --git a/reference/abandoned_cart_emails.v3.yaml b/reference/abandoned_cart_emails.v3.yaml index 2b74b7992..f1523dcb4 100644 --- a/reference/abandoned_cart_emails.v3.yaml +++ b/reference/abandoned_cart_emails.v3.yaml @@ -227,6 +227,7 @@ paths: required: - locale - keys + type: object properties: locale: type: string diff --git a/reference/abandoned_carts.v3.yml b/reference/abandoned_carts.v3.yml index 49c1d4b43..5bcab5296 100644 --- a/reference/abandoned_carts.v3.yml +++ b/reference/abandoned_carts.v3.yml @@ -360,6 +360,7 @@ components: properties: errors: type: object + properties: {} additionalProperties: type: string title: DetailedErrors @@ -508,6 +509,8 @@ components: type: string errors: type: object + properties: {} + additionalProperties: true x-tags: - Models diff --git a/reference/carts.sf.yml b/reference/carts.sf.yml index 68172a982..82b25d622 100644 --- a/reference/carts.sf.yml +++ b/reference/carts.sf.yml @@ -381,8 +381,9 @@ components: requestCart: title: Create Cart Request Object description: Cart object used in create cart requests. - oneOf: - - properties: + anyOf: + - type: object + properties: lineItems: type: array items: @@ -391,7 +392,8 @@ components: type: string required: - lineItems - - properties: + - type: object + properties: giftCertificates: type: array items: @@ -400,7 +402,8 @@ components: type: string required: - giftCertificates - - properties: + - type: object + properties: lineItems: type: array items: @@ -412,8 +415,6 @@ components: required: - lineItems - giftCertificates - type: object - x-internal: false responseCartLineItemsPhysicalItemGiftWrapping: title: Gift Wrapping type: object @@ -498,22 +499,25 @@ components: example: Happy Birthday LineItemsRequest: title: requestLineItems - oneOf: - - properties: + anyOf: + - type: object + properties: lineItems: type: array items: $ref: '#/components/schemas/requestCartPostLineItem' required: - lineItems - - properties: + - type: object + properties: giftCertificates: type: array items: $ref: '#/components/schemas/requestLineItemGiftCertificate' required: - giftCertificates - - properties: + - type: object + properties: lineItems: type: array items: @@ -523,25 +527,27 @@ components: required: - lineItems - giftCertificates - type: object description: Cart object used in add items requests. x-internal: false requestLineItemPut: title: requestLineItemPut - oneOf: - - properties: + anyOf: + - type: object + properties: lineItem: $ref: '#/components/schemas/requestCartPostLineItem' required: - lineItem title: Line item - - properties: + - type: object + properties: giftCertificates: $ref: '#/components/schemas/requestLineItemGiftCertificate' required: - giftCertificates title: Gift certificate item - - properties: + - type: object + properties: lineItem: $ref: '#/components/schemas/requestCartPostLineItem' giftCertificates: @@ -551,8 +557,6 @@ components: - giftCertificates title: line & gift certificate items description: '' - type: object - x-internal: false responseCartCurrency: title: Currency type: object @@ -904,7 +908,8 @@ components: requestCartPostLineItem: title: Line Item Request Data anyOf: - - properties: + - type: object + properties: productId: type: number description: ID of the product. @@ -917,7 +922,8 @@ components: - productId - quantity title: Simple product - - properties: + - type: object + properties: productId: type: number description: ID of the product. @@ -939,7 +945,6 @@ components: productId: 0 quantity: 0 x-internal: false - type: object requestLineItemGiftCertificateRecipient: title: Contact Entity type: object diff --git a/reference/carts.v3.yml b/reference/carts.v3.yml index a9d1f5470..4f71d7c4f 100644 --- a/reference/carts.v3.yml +++ b/reference/carts.v3.yml @@ -360,7 +360,6 @@ paths: * When redirecting the shopper, you can add a set of `query_params` to the URL. The `query_params` feature allows passing additional information to the redirect URL. tags: - Redirects - - Cart Redirect URLs requestBody: content: application/json: @@ -1715,6 +1714,7 @@ components: ItemDigital: allOf: - title: Base Item + type: object properties: id: type: string @@ -1884,7 +1884,8 @@ components: - variant_id - product_id - quantity - - properties: + - type: object + properties: download_file_urls: description: URLs to download all product files. type: array @@ -1898,11 +1899,11 @@ components: download_size: description: 'Specifies the combined download size of all files in human-readable style; for example, `30MB`.' type: string - type: object - title: '' + title: 'Digital Item' ItemDigitalGet: allOf: - title: Base Item + type: object properties: id: type: string @@ -2062,7 +2063,8 @@ components: type: number description: The product option value identifier in number format. example: 128 - - properties: + - type: object + properties: download_file_urls: description: URLs to download all product files. type: array @@ -2076,8 +2078,7 @@ components: download_size: description: 'Specifies the combined download size of all files in human-readable style; for example, `30MB`.' type: string - type: object - title: '' + title: 'Digital Item Response' description: '' ItemPhysical: allOf: @@ -2509,6 +2510,7 @@ components: description: The discounted amount. x-internal: false GiftWrapping: + type: object properties: name: type: string @@ -2758,11 +2760,12 @@ components: properties: line_items: oneOf: - - items: + - type: array + items: $ref: '#/components/schemas/cart_PostVariant' - - items: + - type: array + items: $ref: '#/components/schemas/cart_PostModifier' - type: array gift_certificates: type: array items: @@ -2905,6 +2908,8 @@ components: type: string errors: type: object + properties: {} + additionalProperties: true x-tags: - Models LineItemsGet: @@ -3346,6 +3351,7 @@ components: $ref: '#/components/schemas/Metafield' errors: type: array + items: {} description: Empty for 200 responses. example: [] meta: @@ -3367,6 +3373,7 @@ components: - 125 errors: type: array + items: {} description: Empty for 200 responses. example: [] meta: @@ -3431,6 +3438,8 @@ components: $ref: '#/components/schemas/ErrorDetail' ErrorDetail: type: object + properties: {} + additionalProperties: true description: | Error detail response payload for the BigCommerce API. example: diff --git a/reference/catalog/brands_catalog.v3.yml b/reference/catalog/brands_catalog.v3.yml index d8add32c6..fef12c3ef 100644 --- a/reference/catalog/brands_catalog.v3.yml +++ b/reference/catalog/brands_catalog.v3.yml @@ -1887,6 +1887,7 @@ components: $ref: '#/components/schemas/Metafield' errors: type: array + items: {} description: Empty for 200 responses. example: [] meta: @@ -1943,6 +1944,7 @@ components: - 125 errors: type: array + items: {} description: Empty for 200 responses. example: [] meta: @@ -2019,6 +2021,8 @@ components: $ref: '#/components/schemas/ErrorDetail' ErrorDetail: type: object + properties: {} + additionalProperties: true description: | Error detail response payload for the BigCommerce API. example: diff --git a/reference/catalog/categories_catalog.v3.yml b/reference/catalog/categories_catalog.v3.yml index 7551516a3..4aee7c0c6 100644 --- a/reference/catalog/categories_catalog.v3.yml +++ b/reference/catalog/categories_catalog.v3.yml @@ -817,6 +817,7 @@ paths: meta: title: Meta type: object + properties: {} description: Empty meta object; may be used later. '207': $ref: '#/components/responses/General207Status' @@ -2221,6 +2222,7 @@ components: $ref: '#/components/schemas/Metafield' errors: type: array + items: {} description: Empty for 200 responses. example: [] meta: @@ -2277,6 +2279,7 @@ components: - 125 errors: type: array + items: {} description: Empty for 200 responses. example: [] meta: @@ -2363,6 +2366,8 @@ components: $ref: '#/components/schemas/ErrorDetail' ErrorDetail: type: object + properties: {} + additionalProperties: true description: | Error detail response payload for the BigCommerce API. example: diff --git a/reference/catalog/product-modifiers_catalog.v3.yml b/reference/catalog/product-modifiers_catalog.v3.yml index 5cac45e15..0db02525e 100644 --- a/reference/catalog/product-modifiers_catalog.v3.yml +++ b/reference/catalog/product-modifiers_catalog.v3.yml @@ -334,11 +334,9 @@ paths: type: array items: title: Modifier Value - type: object description: 'Part of Modifier Value Response ' allOf: - title: Modifier Value Base - type: object allOf: - title: Option Value Base required: @@ -460,7 +458,6 @@ paths: properties: data: title: Modifier - type: object description: Product modifier allOf: - title: Modifier Base @@ -639,11 +636,9 @@ paths: type: array items: title: Modifier Value - type: object description: 'Part of Modifier Value Response ' allOf: - title: Modifier Value Base - type: object allOf: - title: Option Value Base required: @@ -1082,7 +1077,6 @@ paths: properties: data: title: Modifier - type: object description: Product modifier allOf: - title: Modifier Base @@ -1261,11 +1255,9 @@ paths: type: array items: title: Modifier Value - type: object description: 'Part of Modifier Value Response ' allOf: - title: Modifier Value Base - type: object allOf: - title: Option Value Base required: @@ -1651,11 +1643,9 @@ paths: properties: data: title: Modifier Value - type: object description: 'Part of Modifier Value Response ' allOf: - title: Modifier Value Base - type: object allOf: - title: Option Value Base required: @@ -2002,11 +1992,9 @@ paths: properties: data: title: Modifier Value - type: object description: 'Part of Modifier Value Response ' allOf: - title: Modifier Value Base - type: object allOf: - title: Option Value Base required: diff --git a/reference/catalog/product-variant-options_catalog.v3.yml b/reference/catalog/product-variant-options_catalog.v3.yml index 6ec9eace7..5a8a6fbce 100644 --- a/reference/catalog/product-variant-options_catalog.v3.yml +++ b/reference/catalog/product-variant-options_catalog.v3.yml @@ -138,6 +138,7 @@ paths: allOf: - title: Option Base description: Common Option properties. + type: object properties: product_id: type: integer @@ -331,6 +332,7 @@ paths: allOf: - title: Option Value Base description: Common Option Value properties. + type: object properties: is_default: type: boolean @@ -361,16 +363,15 @@ paths: required: - label - sort_order - - properties: + - type: object + properties: id: type: integer description: | The unique numeric ID of the value; increments sequentially. - type: object image_url: type: string description: Publicly available image url - type: object required: true responses: '200': @@ -383,7 +384,6 @@ paths: properties: data: title: Option - type: object allOf: - title: Option Base description: Common Option properties. @@ -580,6 +580,7 @@ paths: allOf: - title: Option Value Base description: Common Option Value properties. + type: object properties: is_default: type: boolean @@ -610,12 +611,12 @@ paths: required: - label - sort_order - - properties: + - type: object + properties: id: type: integer description: | The unique numeric ID of the value; increments sequentially. - type: object image_url: type: string description: Publicly available image url @@ -1030,7 +1031,6 @@ paths: type: array items: title: Option Value - type: object allOf: - title: Option Value Base required: @@ -1090,7 +1090,6 @@ paths: properties: data: title: Option - type: object allOf: - title: Option Base type: object @@ -1280,7 +1279,6 @@ paths: type: array items: title: Option Value - type: object allOf: - title: Option Value Base required: @@ -1469,7 +1467,6 @@ paths: type: array items: title: Option Value - type: object allOf: - title: Option Value Base required: @@ -1624,7 +1621,6 @@ paths: properties: data: title: Option Value - type: object allOf: - title: Option Value Base required: @@ -1729,7 +1725,6 @@ paths: properties: data: title: Option Value - type: object allOf: - title: Option Value Base required: @@ -1877,7 +1872,6 @@ paths: properties: data: title: Option Value - type: object allOf: - title: Option Value Base required: diff --git a/reference/catalog/product-variants_catalog.v3.yml b/reference/catalog/product-variants_catalog.v3.yml index a9f8ac9b7..1161758da 100644 --- a/reference/catalog/product-variants_catalog.v3.yml +++ b/reference/catalog/product-variants_catalog.v3.yml @@ -1006,7 +1006,6 @@ paths: data: type: array items: - type: object allOf: - title: Variant Base type: object @@ -1126,7 +1125,6 @@ paths: 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 allOf: - title: Option Value Product Base type: object @@ -1213,7 +1211,6 @@ paths: type: array items: title: Variant Put - type: object description: | The model for a PUT to update variants on a product. allOf: @@ -1349,7 +1346,6 @@ paths: data: type: array items: - type: object allOf: - title: Variant Base type: object @@ -1469,7 +1465,6 @@ paths: 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 allOf: - title: Option Value Product Base type: object @@ -1579,7 +1574,6 @@ paths: type: array items: title: Error Response - type: object allOf: - title: Base Error type: object @@ -2516,6 +2510,7 @@ components: $ref: '#/components/schemas/Metafield' errors: type: array + items: {} description: Empty for 200 responses. example: [] meta: @@ -2573,6 +2568,7 @@ components: - 125 errors: type: array + items: {} description: Empty for 200 responses. example: [] meta: @@ -2659,6 +2655,8 @@ components: $ref: '#/components/schemas/ErrorDetail' ErrorDetail: type: object + properties: {} + additionalProperties: true description: | Error detail response payload for the BigCommerce API. example: diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml index f13e51ea2..f31d6f633 100644 --- a/reference/catalog/products_catalog.v3.yml +++ b/reference/catalog/products_catalog.v3.yml @@ -1741,7 +1741,6 @@ paths: properties: data: title: Product Image - type: object allOf: - title: Product Image Base type: object @@ -2010,7 +2009,6 @@ paths: properties: data: title: Product Image - type: object allOf: - title: Product Image Base type: object @@ -2285,6 +2283,7 @@ paths: allOf: - title: Product Video Base description: Common Product Video properties. + type: object properties: title: maxLength: 255 @@ -2311,7 +2310,8 @@ paths: The video type (a short name of a host site). enum: - youtube - - properties: + - type: object + properties: video_id: type: string maxLength: 25 @@ -2321,7 +2321,6 @@ paths: x-required: - post example: z3fRu9pkuXE - type: object required: true responses: '200': @@ -2334,7 +2333,6 @@ paths: properties: data: title: Product Video - type: object description: | A product video model. allOf: @@ -2541,7 +2539,6 @@ paths: properties: data: title: Product Video - type: object description: | A product video model. allOf: @@ -4373,7 +4370,6 @@ paths: type: array items: title: Product Review - type: object description: | A product review model. allOf: @@ -4534,7 +4530,6 @@ paths: properties: data: title: Product Review - type: object description: | A product review model. allOf: @@ -4659,7 +4654,6 @@ paths: properties: data: title: Product Review - type: object description: | A product review model. allOf: @@ -4829,7 +4823,6 @@ paths: properties: data: title: Product Review - type: object description: | A product review model. allOf: @@ -6007,8 +6000,9 @@ components: title: product_Put description: The model for a PUT to update a product. allOf: - - $ref: '#/components/schemas/product_Base' - type: object + properties: {} + - $ref: '#/components/schemas/product_Base' x-internal: false metafield_Base: title: metafield_Base @@ -7642,6 +7636,7 @@ components: x-tags: - Models ProductChannelAssignment: + type: object properties: product_id: type: integer @@ -7650,6 +7645,7 @@ components: x-tags: - Models ProductCategoryAssignment: + type: object properties: product_id: type: integer @@ -7796,6 +7792,7 @@ components: $ref: '#/components/schemas/Metafield' errors: type: array + items: {} description: Empty for 200 responses. example: [] meta: @@ -7852,6 +7849,7 @@ components: - 125 errors: type: array + items: {} description: Empty for 200 responses. example: [] meta: @@ -7938,6 +7936,8 @@ components: $ref: '#/components/schemas/ErrorDetail' ErrorDetail: type: object + properties: {} + additionalProperties: true description: | Error detail response payload for the BigCommerce API. example: @@ -8330,6 +8330,7 @@ components: content: application/json: schema: + type: object properties: data: type: array @@ -8342,6 +8343,7 @@ components: content: application/json: schema: + type: object properties: data: $ref: '#/components/schemas/customFieldData' diff --git a/reference/channels.v3.yml b/reference/channels.v3.yml index 09f5efb42..08c32a641 100644 --- a/reference/channels.v3.yml +++ b/reference/channels.v3.yml @@ -532,6 +532,8 @@ paths: default: 'https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes' errors: type: object + properties: {} + additionalProperties: true delete: summary: Delete a Siteʼs Checkout URL operationId: deleteCheckoutUrl @@ -1603,15 +1605,16 @@ components: links: current: '?page=1&limit=50' allOf: - - properties: + - type: object + properties: data: type: array items: $ref: '#/components/schemas/metafield_Base' - - properties: + - type: object + properties: meta: $ref: '#/components/schemas/MetaWithFullPagination' - type: object examples: {} examples: create_channel_req_example: @@ -2429,6 +2432,7 @@ components: $ref: '#/components/schemas/Metafield' errors: type: array + items: {} description: Empty for 200 responses. example: [] meta: @@ -2485,6 +2489,7 @@ components: - 125 errors: type: array + items: {} description: Empty for 200 responses. example: [] meta: @@ -2572,6 +2577,8 @@ components: $ref: '#/components/schemas/ErrorDetail' ErrorDetail: type: object + properties: {} + additionalProperties: true description: | Error detail response payload for the BigCommerce API. example: diff --git a/reference/checkouts.sf.yml b/reference/checkouts.sf.yml index 2a91d0c39..c509c3760 100644 --- a/reference/checkouts.sf.yml +++ b/reference/checkouts.sf.yml @@ -77,7 +77,7 @@ paths: lineItems: physicalItems: - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52 - parentId: {} + parentId: '' variantId: 345 productId: 174 sku: '' @@ -244,7 +244,7 @@ paths: lineItems: physicalItems: - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52 - parentId: {} + parentId: '' variantId: 345 productId: 174 sku: '' @@ -389,7 +389,7 @@ paths: lineItems: physicalItems: - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52 - parentId: {} + parentId: '' variantId: 345 productId: 174 sku: '' @@ -530,7 +530,7 @@ paths: lineItems: physicalItems: - id: 69791a88-85c9-4c19-8042-e537621e8a55 - parentId: {} + parentId: '' variantId: 364 productId: 184 sku: SMA-RED @@ -555,7 +555,7 @@ paths: giftWrapping: {} addedByPromotion: false - id: ba2c619d-e6b4-48c2-8809-d88e424ed450 - parentId: {} + parentId: '' variantId: 341 productId: 170 sku: '' @@ -578,7 +578,7 @@ paths: giftWrapping: {} addedByPromotion: false - id: c72d6651-978d-45e5-881b-c2bb5f7ff1d5 - parentId: {} + parentId: '' variantId: 376 productId: 158 sku: SKU-A0C8A203 @@ -602,7 +602,7 @@ paths: addedByPromotion: false digitalItems: - id: 6477a4a1-02cf-4287-8bf2-fd043bdd5234 - parentId: {} + parentId: '' variantId: 360 productId: 189 name: Gather Journal Issue 7 - Digital @@ -767,7 +767,7 @@ paths: lineItems: physicalItems: - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52 - parentId: {} + parentId: '' variantId: 345 productId: 174 sku: '' @@ -925,7 +925,7 @@ paths: lineItems: physicalItems: - id: 69791a88-85c9-4c19-8042-e537621e8a55 - parentId: {} + parentId: '' variantId: 364 productId: 184 sku: SMA-RED @@ -950,7 +950,7 @@ paths: giftWrapping: {} addedByPromotion: false - id: ba2c619d-e6b4-48c2-8809-d88e424ed450 - parentId: {} + parentId: '' variantId: 341 productId: 170 sku: '' @@ -973,7 +973,7 @@ paths: giftWrapping: {} addedByPromotion: false - id: c72d6651-978d-45e5-881b-c2bb5f7ff1d5 - parentId: {} + parentId: '' variantId: 376 productId: 158 sku: SKU-A0C8A203 @@ -997,7 +997,7 @@ paths: addedByPromotion: false digitalItems: - id: 6477a4a1-02cf-4287-8bf2-fd043bdd5234 - parentId: {} + parentId: '' variantId: 360 productId: 189 name: Gather Journal Issue 7 - Digital @@ -1189,7 +1189,7 @@ paths: lineItems: physicalItems: - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52 - parentId: {} + parentId: '' variantId: 345 productId: 174 sku: '' @@ -1353,7 +1353,7 @@ paths: lineItems: physicalItems: - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52 - parentId: {} + parentId: '' variantId: 345 productId: 174 sku: '' @@ -1482,7 +1482,7 @@ paths: lineItems: physicalItems: - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52 - parentId: {} + parentId: '' variantId: 345 productId: 174 sku: '' @@ -1623,7 +1623,7 @@ paths: lineItems: physicalItems: - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52 - parentId: {} + parentId: '' variantId: 345 productId: 174 sku: '' @@ -1716,6 +1716,7 @@ paths: application/json: schema: type: object + properties: {} x-codegen-request-body-name: body '/checkouts/{checkoutId}/gift-certificates/{giftCertificateCode}': parameters: @@ -1801,7 +1802,7 @@ paths: lineItems: physicalItems: - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52 - parentId: {} + parentId: '' variantId: 345 productId: 174 sku: '' @@ -2167,6 +2168,7 @@ paths: application/json: schema: type: object + properties: {} '/checkouts/{checkoutId}/spam-protection': parameters: - $ref: '#/components/parameters/CheckoutIdPath' @@ -2651,13 +2653,11 @@ components: lineItems: type: object description: '' - items: - title: Line Item - required: - - digitalItems - - physicalItems - type: object - properties: + title: Line Items + required: + - digitalItems + - physicalItems + properties: physicalItems: type: array description: '' @@ -2961,7 +2961,6 @@ components: description: A cart contains a collection of items, prices, discounts, etc. It does not contain customer-related data. billingAddress: title: Address Response - type: object allOf: - title: Address Properties required: @@ -3039,7 +3038,6 @@ components: x-deprecated: true address: title: Address Response - type: object allOf: - title: Address Properties required: @@ -3106,7 +3104,6 @@ components: description: This is available only when "include=consignments.availableShippingOptions" is presented in the URL. items: title: Shipping Option Entity - type: object allOf: - title: Selected Shipping Option type: object @@ -3637,275 +3634,273 @@ components: lineItems: type: object description: '' - items: - title: Line Item - required: - - digitalItems - - physicalItems - type: object - properties: - physicalItems: - type: array - description: '' - items: - title: Item Physical - required: - - quantity - type: object - properties: - id: - type: string - description: The line-item ID. - parentId: - type: string - description: The product is part of a bundle such as a product pick list, then the parentId or the main product ID will populate. - variantId: - type: integer - description: ID of the variant. - productId: - type: integer - description: ID of the product. - sku: - type: string - description: SKU of the variant. - name: - type: string - description: The itemʼs product name. - url: - type: string - description: The product URL. - quantity: - type: number - description: Quantity of this item. - format: double - isTaxable: - type: boolean - description: Whether the item is taxable. - imageUrl: - type: string - description: A publicly-accessible URL for an image of this item. - discounts: - type: array - description: A list of discounts applied to this item, as an array of AppliedDiscount objects. - items: - title: Applied Discount - type: object - properties: - name: - type: string - description: The name provided by the merchant. - discountedAmount: - type: number - description: The discounted amount applied within a given context. - format: double - discountAmount: - type: number - description: The total value of all discounts applied to this item (excluding coupon). - format: double - couponAmount: - type: number - description: The total value of all coupons applied to this item. - format: double - listPrice: - type: number - description: The item’s list price, as quoted by the manufacturer or distributor. - format: double - salePrice: - type: number - description: The itemʼs price after all discounts are applied. The final price before tax calculation. - format: double - extendedListPrice: - type: number - description: The itemʼs list price multiplied by the quantity. - format: double - extendedSalePrice: - type: number - description: The itemʼs sale price multiplied by the quantity. - format: double - comparisonPrice: - type: number - description: The itemʼs comparison price - extendedComparisonPrice: - type: number - description: The itemʼs comparison price multiplied by the quantity. - type: - type: string - description: the product type - physical or digital - addedByPromotion: - type: boolean - description: If the item was added automatically by a promotion, such as a coupon or buy one, get one. - isShippingRequired: - type: boolean - description: Whether this item requires shipping to a physical address. - isMutable: - type: boolean - description: '' - giftWrapping: - title: Gift Wrapping + title: Line Items + required: + - digitalItems + - physicalItems + properties: + physicalItems: + type: array + description: '' + items: + title: Item Physical + required: + - quantity + type: object + properties: + id: + type: string + description: The line-item ID. + parentId: + type: string + description: The product is part of a bundle such as a product pick list, then the parentId or the main product ID will populate. + variantId: + type: integer + description: ID of the variant. + productId: + type: integer + description: ID of the product. + sku: + type: string + description: SKU of the variant. + name: + type: string + description: The itemʼs product name. + url: + type: string + description: The product URL. + quantity: + type: number + description: Quantity of this item. + format: double + isTaxable: + type: boolean + description: Whether the item is taxable. + imageUrl: + type: string + description: A publicly-accessible URL for an image of this item. + discounts: + type: array + description: A list of discounts applied to this item, as an array of AppliedDiscount objects. + items: + title: Applied Discount type: object properties: name: type: string - description: '' - message: - type: string - description: '' - amount: + description: The name provided by the merchant. + discountedAmount: type: number - description: '' + description: The discounted amount applied within a given context. format: double - digitalItems: - type: array - description: '' - items: - title: Item Digital - required: - - quantity - type: object - properties: - id: - type: string - description: The line-item ID. - parentId: - type: string - description: Bundled items will have their parentʼs item ID. - variantId: - type: number - description: ID of the variant. - format: double - productId: - type: number - description: ID of the product. - format: double - sku: - type: string - description: SKU of the variant. - name: - type: string - description: The itemʼs product name. - url: - type: string - description: The product URL. - quantity: - type: number - description: Quantity of this item. - format: double - isTaxable: - type: boolean - description: Whether the item is taxable. - imageUrl: - type: string - description: A publicly-accessible URL for an image of this item. - discounts: - type: array - description: A list of discounts applied to this item, as an array of AppliedDiscount objects. - items: - title: Applied Discount - type: object - properties: - name: - type: string - description: The name provided by the merchant. - discountedAmount: - type: number - description: The discounted amount applied within a given context. - format: double - discountAmount: - type: number - description: The total value of all discounts applied to this item (excluding coupon). - format: double - couponAmount: - type: number - description: The total value of all coupons applied to this item. - format: double - listPrice: - type: number - description: The item’s list price, as quoted by the manufacturer or distributor. - format: double - salePrice: - type: number - description: The itemʼs price after all discounts are applied. The final price before tax calculation. - format: double - extendedListPrice: - type: number - description: The itemʼs list price multiplied by the quantity. - format: double - extendedSalePrice: - type: number - description: The itemʼs sale price multiplied by the quantity. - format: double - type: - type: string - description: The product type - physical or digital. - isShippingRequired: - type: boolean - description: Whether this item requires shipping to a physical address. - downloadFileUrls: - type: array - description: URLs to download all product files. - items: + discountAmount: + type: number + description: The total value of all discounts applied to this item (excluding coupon). + format: double + couponAmount: + type: number + description: The total value of all coupons applied to this item. + format: double + listPrice: + type: number + description: The item’s list price, as quoted by the manufacturer or distributor. + format: double + salePrice: + type: number + description: The itemʼs price after all discounts are applied. The final price before tax calculation. + format: double + extendedListPrice: + type: number + description: The itemʼs list price multiplied by the quantity. + format: double + extendedSalePrice: + type: number + description: The itemʼs sale price multiplied by the quantity. + format: double + comparisonPrice: + type: number + description: The itemʼs comparison price + extendedComparisonPrice: + type: number + description: The itemʼs comparison price multiplied by the quantity. + type: + type: string + description: the product type - physical or digital + addedByPromotion: + type: boolean + description: If the item was added automatically by a promotion, such as a coupon or buy one, get one. + isShippingRequired: + type: boolean + description: Whether this item requires shipping to a physical address. + isMutable: + type: boolean + description: '' + giftWrapping: + title: Gift Wrapping + type: object + properties: + name: type: string - downloadPageUrl: - type: string - description: The URL for the combined downloads page. - downloadSize: - type: string - description: 'Specifies the combined download size in human-readable style; for example, `30MB`.' - giftCertificate: - type: array - description: '' - items: - title: Item Gift Certificate - required: - - amount - - recipient - - sender - - theme - type: object - properties: - id: - type: string - description: Gift certificate identifier - name: - type: string - description: 'The name of the purchased gift certificate; for example, `$20 Gift Certificate`.' - theme: - type: string - description: 'Currently supports `Birthday`, `Boy`, `Celebration`, `Christmas`, `General`, and `Girl`.' - amount: - type: number - description: 'Value must be between $1.00 and $1,000.00.' - format: double - taxable: - type: boolean - description: '' - sender: - title: Contact Entity - type: object - properties: - name: - type: string - description: '' - email: - type: string - description: '' - recipient: - title: Contact Entity + description: '' + message: + type: string + description: '' + amount: + type: number + description: '' + format: double + digitalItems: + type: array + description: '' + items: + title: Item Digital + required: + - quantity + type: object + properties: + id: + type: string + description: The line-item ID. + parentId: + type: string + description: Bundled items will have their parentʼs item ID. + variantId: + type: number + description: ID of the variant. + format: double + productId: + type: number + description: ID of the product. + format: double + sku: + type: string + description: SKU of the variant. + name: + type: string + description: The itemʼs product name. + url: + type: string + description: The product URL. + quantity: + type: number + description: Quantity of this item. + format: double + isTaxable: + type: boolean + description: Whether the item is taxable. + imageUrl: + type: string + description: A publicly-accessible URL for an image of this item. + discounts: + type: array + description: A list of discounts applied to this item, as an array of AppliedDiscount objects. + items: + title: Applied Discount type: object properties: name: type: string - description: '' - email: - type: string - description: '' - message: - type: string - description: Limited to 200 characters. - type: + description: The name provided by the merchant. + discountedAmount: + type: number + description: The discounted amount applied within a given context. + format: double + discountAmount: + type: number + description: The total value of all discounts applied to this item (excluding coupon). + format: double + couponAmount: + type: number + description: The total value of all coupons applied to this item. + format: double + listPrice: + type: number + description: The item’s list price, as quoted by the manufacturer or distributor. + format: double + salePrice: + type: number + description: The itemʼs price after all discounts are applied. The final price before tax calculation. + format: double + extendedListPrice: + type: number + description: The itemʼs list price multiplied by the quantity. + format: double + extendedSalePrice: + type: number + description: The itemʼs sale price multiplied by the quantity. + format: double + type: + type: string + description: The product type - physical or digital. + isShippingRequired: + type: boolean + description: Whether this item requires shipping to a physical address. + downloadFileUrls: + type: array + description: URLs to download all product files. + items: type: string - description: Explicitly specifying the gift certificate type. - customItems: + downloadPageUrl: + type: string + description: The URL for the combined downloads page. + downloadSize: + type: string + description: 'Specifies the combined download size in human-readable style; for example, `30MB`.' + giftCertificate: + type: array + description: '' + items: + title: Item Gift Certificate + required: + - amount + - recipient + - sender + - theme + type: object + properties: + id: + type: string + description: Gift certificate identifier + name: + type: string + description: 'The name of the purchased gift certificate; for example, `$20 Gift Certificate`.' + theme: + type: string + description: 'Currently supports `Birthday`, `Boy`, `Celebration`, `Christmas`, `General`, and `Girl`.' + amount: + type: number + description: 'Value must be between $1.00 and $1,000.00.' + format: double + taxable: + type: boolean + description: '' + sender: + title: Contact Entity + type: object + properties: + name: + type: string + description: '' + email: + type: string + description: '' + recipient: + title: Contact Entity + type: object + properties: + name: + type: string + description: '' + email: + type: string + description: '' + message: + type: string + description: Limited to 200 characters. + type: + type: string + description: Explicitly specifying the gift certificate type. + customItems: type: array items: title: Item Custom @@ -4027,7 +4022,7 @@ components: lineItems: physicalItems: - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52 - parentId: {} + parentId: '' variantId: 345 productId: 174 sku: '' diff --git a/reference/checkouts.v3.yml b/reference/checkouts.v3.yml index 069ef683e..e1208d026 100644 --- a/reference/checkouts.v3.yml +++ b/reference/checkouts.v3.yml @@ -7774,6 +7774,8 @@ paths: example: 'https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes' errors: type: object + properties: {} + additionalProperties: true '422': description: Invalid JSON request body - missing or invalid data. content: @@ -8214,6 +8216,7 @@ components: title: Address Response allOf: - title: Address Properties + type: object properties: first_name: type: string @@ -8265,11 +8268,11 @@ components: field_value: type: string description: 'This can also be an array for fields that need to support a list of values (e.g., a set of check boxes.)' - - properties: + - type: object + properties: id: type: string description: '' - type: object consignments: type: array description: '' @@ -8283,11 +8286,14 @@ components: description: '' shippingAddress: type: object + properties: {} + additionalProperties: true x-deprecated: true address: title: Address Response allOf: - title: Address Properties + type: object properties: first_name: type: string @@ -8342,11 +8348,11 @@ components: required: - email - country_code - - properties: + - type: object + properties: id: type: string description: '' - type: object available_shipping_options: type: array description: This is available only when "include=consignments.available_shipping_options" is presented in the URL. diff --git a/reference/consent.sf.yml b/reference/consent.sf.yml index 760410199..bd3558ed2 100644 --- a/reference/consent.sf.yml +++ b/reference/consent.sf.yml @@ -14,6 +14,11 @@ info: For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#same-origin-cors-authentication). version: Storefront + termsOfService: 'https://www.bigcommerce.com/terms' + contact: + name: BigCommerce + url: 'https://www.bigcommerce.com' + email: support@bigcommerce.com tags: - name: Consent paths: diff --git a/reference/currencies.v2.yml b/reference/currencies.v2.yml index bbd9438b5..502991b26 100644 --- a/reference/currencies.v2.yml +++ b/reference/currencies.v2.yml @@ -125,6 +125,8 @@ paths: application/json: schema: type: object + properties: {} + additionalProperties: true /currencies/{id}: parameters: - $ref: '#/components/parameters/Accept' @@ -191,6 +193,8 @@ paths: application/json: schema: type: object + properties: {} + additionalProperties: true components: schemas: currency_Post: diff --git a/reference/current_customer.yml b/reference/current_customer.yml index dfef142db..b4bb0bb56 100644 --- a/reference/current_customer.yml +++ b/reference/current_customer.yml @@ -17,6 +17,11 @@ info: > #### Note > * Substitute your storefront domain for `yourstore.example.com`. > * The Send a Test Request feature is not currently supported for this endpoint. + termsOfService: 'https://www.bigcommerce.com/terms' + contact: + name: BigCommerce + url: 'https://www.bigcommerce.com' + email: support@bigcommerce.com version: '' servers: - url: 'https://{store_domain}' @@ -45,7 +50,7 @@ paths: parameters: - $ref: '#/components/parameters/AppClientId' responses: - default: + '200': description: |- A JWT to decode using the client secret that corresponds with the app client ID you sent as a query parameter. diff --git a/reference/custom-template-associations.v3.yml b/reference/custom-template-associations.v3.yml index bf5a15300..5df1e0fe9 100644 --- a/reference/custom-template-associations.v3.yml +++ b/reference/custom-template-associations.v3.yml @@ -116,6 +116,8 @@ paths: application/json: schema: type: object + properties: {} + additionalProperties: true '422': description: Error response for batch PUT of Custom template associations. Includes the errors for each reference ID. content: @@ -238,6 +240,7 @@ components: x-internal: false DetailedErrors: type: object + properties: {} additionalProperties: type: string x-internal: false diff --git a/reference/customer_login.yml b/reference/customer_login.yml index f79c94414..9c876eb9d 100644 --- a/reference/customer_login.yml +++ b/reference/customer_login.yml @@ -53,6 +53,8 @@ paths: '*/*': schema: type: object + properties: {} + additionalProperties: true components: schemas: customerLoginSSO: diff --git a/reference/customers.sf.yml b/reference/customers.sf.yml index 84b68e766..68c125c4a 100644 --- a/reference/customers.sf.yml +++ b/reference/customers.sf.yml @@ -8,6 +8,11 @@ info: The REST Storefront API uses [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) headers for authentication, and therefore has no required scopes. You do not need to send any BigCommerce-specific tokens with your requests to these endpoints. For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#same-origin-cors-authentication). + termsOfService: 'https://www.bigcommerce.com/terms' + contact: + name: BigCommerce + url: 'https://www.bigcommerce.com' + email: support@bigcommerce.com servers: - url: 'https://{store_domain}/api/storefront' variables: diff --git a/reference/customers.v3.yml b/reference/customers.v3.yml index bf93bb513..0e906de72 100644 --- a/reference/customers.v3.yml +++ b/reference/customers.v3.yml @@ -795,6 +795,8 @@ paths: $ref: '#/components/schemas/CustomerSettingsObject' meta: type: object + properties: {} + additionalProperties: true examples: data: value: @@ -837,6 +839,8 @@ paths: $ref: '#/components/schemas/CustomerSettingsObject' meta: type: object + properties: {} + additionalProperties: true examples: data: value: @@ -877,6 +881,8 @@ paths: $ref: '#/components/schemas/CustomerChannelSettingsObject' meta: type: object + properties: {} + additionalProperties: true examples: data: value: @@ -935,6 +941,8 @@ paths: $ref: '#/components/schemas/CustomerSettingsObject' meta: type: object + properties: {} + additionalProperties: true examples: example: value: @@ -2231,6 +2239,7 @@ components: postal_code: '78759' state_or_province: Texas meta: {} + type: object properties: data: type: array @@ -2311,6 +2320,8 @@ components: meta: $ref: '#/components/schemas/MetaOpen' - title: DuplicateAddressCollectionResponse + type: object + properties: {} example: {} type: object properties: @@ -2873,95 +2884,98 @@ components: properties: data: type: array - id: - type: integer - description: Unique ID of the *Metafield*. Read-Only. - readOnly: true - example: 0 - key: - type: string - description: The key for the metafields. - example: Staff Name - value: - type: string - description: The description for the metafield. - example: Ronaldo - namespace: - type: string - description: | - Namespace for the metafield, for organizational purposes. - example: Sales Department - minLength: 1 - maxLength: 64 - 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 - 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: 0 - readOnly: true - description: - type: string - description: | - Description for the metafields. - example: order - 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' - owner_client_id: - type: string - description: Client ID for the metafield's creator. - readOnly: true - example: ramciw4fnoz87it3ynjfif2zrkil5p - required: - - namespace - - key - - value - - permission_set - - resource_type - - resource_id - - description - - id - - date_created - - date_modified + items: + type: object + properties: + id: + type: integer + description: Unique ID of the *Metafield*. Read-Only. + readOnly: true + example: 0 + key: + type: string + description: The key for the metafields. + example: Staff Name + value: + type: string + description: The description for the metafield. + example: Ronaldo + namespace: + type: string + description: | + Namespace for the metafield, for organizational purposes. + example: Sales Department + minLength: 1 + maxLength: 64 + 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 + 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: 0 + readOnly: true + description: + type: string + description: | + Description for the metafields. + example: order + 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' + owner_client_id: + type: string + description: Client ID for the metafield's creator. + readOnly: true + example: ramciw4fnoz87it3ynjfif2zrkil5p + required: + - namespace + - key + - value + - permission_set + - resource_type + - resource_id + - description + - id + - date_created + - date_modified consent_Resp: description: '' content: @@ -3057,6 +3071,7 @@ components: type: string errors: type: object + properties: {} additionalProperties: type: string x-internal: false @@ -3874,16 +3889,14 @@ components: x-internal: false customerAuthentication_PostPut: title: customerAuthentication_PostPut - allOf: - - properties: - force_password_reset: - description: 'If `true`, this customer will be forced to change password on next login.' - type: boolean - - properties: - new_password: - description: New password for customer. Write only field. - type: string type: object + properties: + force_password_reset: + description: 'If `true`, this customer will be forced to change password on next login.' + type: boolean + new_password: + description: New password for customer. Write only field. + type: string x-internal: false Links: title: Links @@ -4447,6 +4460,7 @@ components: $ref: '#/components/schemas/Metafield' errors: type: array + items: {} description: Empty for 200 responses. example: [] meta: @@ -4503,6 +4517,7 @@ components: - 125 errors: type: array + items: {} description: Empty for 200 responses. example: [] meta: @@ -4589,6 +4604,8 @@ components: $ref: '#/components/schemas/ErrorDetail' ErrorDetail: type: object + properties: {} + additionalProperties: true description: | Error detail response payload for the BigCommerce API. example: diff --git a/reference/email_templates.v3.yml b/reference/email_templates.v3.yml index b06697d31..6d1cef7dd 100644 --- a/reference/email_templates.v3.yml +++ b/reference/email_templates.v3.yml @@ -209,6 +209,7 @@ components: x-internal: false DetailedErrors: type: object + properties: {} additionalProperties: type: string x-internal: false @@ -259,6 +260,8 @@ components: description: 'Locale code for this language, such as "en", "en-us", "fr-ca".' keys: type: object + properties: {} + additionalProperties: true example: reset_password: 'To change your customer account password at {{name}} please click this link or copy and paste it into your browser:' description: Language keys for the template. User-defined. Should match any lang keys used in the template. diff --git a/reference/form_fields.sf.yml b/reference/form_fields.sf.yml index 28c211a5b..5f71b8109 100644 --- a/reference/form_fields.sf.yml +++ b/reference/form_fields.sf.yml @@ -11,6 +11,11 @@ info: > #### Warning > Breaking changes may be introduced to this endpoint while in beta. version: '' + termsOfService: 'https://www.bigcommerce.com/terms' + contact: + name: BigCommerce + url: 'https://www.bigcommerce.com' + email: support@bigcommerce.com servers: - url: 'https://{store_domain}/api/storefront' variables: diff --git a/reference/geography.v2.yml b/reference/geography.v2.yml index b605bdde1..1be63ddc4 100644 --- a/reference/geography.v2.yml +++ b/reference/geography.v2.yml @@ -4,7 +4,23 @@ info: title: Geography description: |- Get countries, states, and provinces. - + termsOfService: 'https://www.bigcommerce.com/terms' + contact: + name: BigCommerce + url: 'https://www.bigcommerce.com' + email: support@bigcommerce.com +security: + - X-Auth-Token: [] +tags: + - name: Countries + - name: States +servers: + - url: 'https://api.bigcommerce.com/stores/{store_hash}/v2' + variables: + store_hash: + default: store_hash + description: Permanent ID of the BigCommerce store. + description: BigCommerce API Gateway paths: '/countries': get: @@ -287,20 +303,6 @@ paths: required: true schema: type: string - -security: - - X-Auth-Token: [] -tags: - - name: Countries - - name: States - -servers: - - url: 'https://api.bigcommerce.com/stores/{store_hash}/v2' - variables: - store_hash: - default: store_hash - description: Permanent ID of the BigCommerce store. - description: BigCommerce API Gateway components: responses: countriesResponse: diff --git a/reference/marketing.v2.yml b/reference/marketing.v2.yml index aec5cd070..aa4a60859 100644 --- a/reference/marketing.v2.yml +++ b/reference/marketing.v2.yml @@ -879,6 +879,7 @@ paths: application/json: schema: type: object + properties: {} components: parameters: Accept: @@ -1047,11 +1048,11 @@ components: banner_Base: title: banner_Base required: - - content - - date_type - - location - - name - - page + - content + - date_type + - location + - name + - page type: object properties: name: @@ -1124,8 +1125,7 @@ components: banner_Put: title: banner_Put allOf: - - type: object - - $ref: '#/components/schemas/banner_Base' + - $ref: '#/components/schemas/banner_Base' x-internal: false giftCertificate_Base: title: giftCertificate_Base diff --git a/reference/orders.sf.yml b/reference/orders.sf.yml index 3d1e353a3..345d6ffc1 100644 --- a/reference/orders.sf.yml +++ b/reference/orders.sf.yml @@ -331,6 +331,7 @@ components: description: Categories the item belongs to. items: type: object + properties: {} x-internal: false GiftWrapping: title: Gift Wrapping @@ -437,6 +438,7 @@ components: description: Categories the item belongs to. items: type: object + properties: {} x-internal: false OrderItemGiftCertificate: title: Order Item Gift Certificate diff --git a/reference/orders.v2.oas2.yml b/reference/orders.v2.oas2.yml index 427b73bcc..118e609b6 100644 --- a/reference/orders.v2.oas2.yml +++ b/reference/orders.v2.oas2.yml @@ -2564,20 +2564,20 @@ components: timestamp: 'Mon, 20 Aug 2018 14:47:13 +0000' shipping_provider_id: bcrealtime shipping_provider_quote: - rate: - value: '44.11' - unit: USD - transitTime: 1 business day - name: UPS Next Day Air® - signatureConfirmationFee: {} - carrierName: '' - carrierCode: {} - code: {} - deliveryMessage: '' - labelSizes: [] - insuredMailFee: {} - dates: [] - rateId: {} + - rate: + value: '44.11' + unit: USD + transitTime: 1 business day + name: UPS Next Day Air® + signatureConfirmationFee: {} + carrierName: '' + carrierCode: {} + code: {} + deliveryMessage: '' + labelSizes: [] + insuredMailFee: {} + dates: [] + rateId: {} provider_code: upsready carrier_code: '' rate_code: '' @@ -3421,6 +3421,7 @@ components: - type: number - type: string - type: array + items: {} example: 123BAF items: type: string @@ -3496,6 +3497,7 @@ components: type: string customer: type: object + properties: {} title: orderMessages x-internal: false shippingQuotes_Resource: @@ -3540,7 +3542,10 @@ components: shipping_provider_quote: type: array description: This can vary based on the shipping provider. Manual shipping methods such as fixed will return an empty array. Shipping providers such as UPS will return an object with the shipping information. Since the shipping quote is tied to a shipping address only one quote will return in the response. - items: {} + items: + type: object + properties: {} + additionalProperties: true provider_code: type: string example: shipping_byweight @@ -3677,7 +3682,6 @@ components: x-internal: false ordersCountStatus: title: ordersCountStatus - type: object allOf: - $ref: '#/components/schemas/orderStatus_Base' - type: object diff --git a/reference/orders.v3.yml b/reference/orders.v3.yml index 5d0a87a6b..5840918b0 100644 --- a/reference/orders.v3.yml +++ b/reference/orders.v3.yml @@ -471,10 +471,9 @@ paths: required: true x-examples: application/json: - - items: - - item_id: 76 - item_type: PRODUCT - quantity: 1 + - item_id: 76 + item_type: PRODUCT + quantity: 1 tax_adjustment_amount: 0 responses: '201': @@ -764,9 +763,9 @@ paths: application/json: schema: allOf: - - type: object - $ref: '#/components/schemas/GlobalOrderSettings' - - properties: + - type: object + properties: meta: $ref: '#/components/schemas/metaEmpty_Full' '400': @@ -1679,6 +1678,7 @@ components: Transaction: allOf: - title: Transaction Base + type: object properties: event: type: string @@ -1808,7 +1808,8 @@ components: - amount - currency - gateway - - properties: + - type: object + properties: id: type: integer description: | @@ -1905,7 +1906,6 @@ components: type: number format: float example: 35.42 - type: object title: '' x-examples: Example 1: @@ -2829,6 +2829,7 @@ components: $ref: '#/components/schemas/Metafield' errors: type: array + items: {} description: Empty for 200 responses. example: [] meta: @@ -3094,6 +3095,7 @@ components: - 125 errors: type: array + items: {} description: Empty for 200 responses. example: [] meta: @@ -3180,6 +3182,8 @@ components: $ref: '#/components/schemas/ErrorDetail' ErrorDetail: type: object + properties: {} + additionalProperties: true description: | Error detail response payload for the BigCommerce API. example: @@ -3278,6 +3282,8 @@ components: properties: errors: type: object + properties: {} + additionalProperties: true x-tags: - Models BaseError: @@ -3297,10 +3303,6 @@ components: type: string x-tags: - Models - betaDetailedErrors: - type: object - x-tags: - - Models responses: Return_Resp: description: '' @@ -3321,6 +3323,7 @@ components: content: application/json: schema: + type: object properties: data: $ref: '#/components/schemas/UpdateReturnStatuses' @@ -3353,6 +3356,7 @@ components: content: application/json: schema: + type: object properties: data: $ref: '#/components/schemas/ReceivedItems_Base' @@ -3367,6 +3371,7 @@ components: content: application/json: schema: + type: object properties: data: $ref: '#/components/schemas/ReviewedItems_Base' @@ -3502,6 +3507,8 @@ components: application/json: schema: type: object + properties: {} + additionalProperties: true RefundCollection_Resp: description: '' content: @@ -3574,40 +3581,40 @@ components: content: application/json: schema: - allOf: - - properties: - data: - $ref: '#/components/schemas/Transaction_Post' - - properties: - id: - type: integer - description: | - Unique identifier for the transaction. - order_id: - type: string - description: Identifier for the BigCommerce Order with which this transaction is associated. - date_created: - type: string - format: date-time - description: | - The datetime of the transaction. - payment_instrument_token: - type: string - description: This field contains internal BigPay token for stored card that is then mapped to the actual third-party token. We currently do not offer a way to get third party tokens.These tokens are read-only and do not return any information about the payment. - avs_result: - $ref: '#/components/schemas/AVSResult' - cvv_result: - $ref: '#/components/schemas/CVVResult' - credit_card: - $ref: '#/components/schemas/CreditCard' - gift_certificate: - $ref: '#/components/schemas/GiftCertificate' - store_credit: - $ref: '#/components/schemas/StoreCredit' - - properties: - meta: - $ref: '#/components/schemas/metaEmpty_Full' type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/Transaction_Post' + - type: object + properties: + id: + type: integer + description: | + Unique identifier for the transaction. + order_id: + type: string + description: Identifier for the BigCommerce Order with which this transaction is associated. + date_created: + type: string + format: date-time + description: | + The datetime of the transaction. + payment_instrument_token: + type: string + description: This field contains internal BigPay token for stored card that is then mapped to the actual third-party token. We currently do not offer a way to get third party tokens.These tokens are read-only and do not return any information about the payment. + avs_result: + $ref: '#/components/schemas/AVSResult' + cvv_result: + $ref: '#/components/schemas/CVVResult' + credit_card: + $ref: '#/components/schemas/CreditCard' + gift_certificate: + $ref: '#/components/schemas/GiftCertificate' + store_credit: + $ref: '#/components/schemas/StoreCredit' + meta: + $ref: '#/components/schemas/metaEmpty_Full' RefundQuotesBATCH_Resp: description: '' content: diff --git a/reference/pages.v3.yml b/reference/pages.v3.yml index fc185a079..76b61001d 100644 --- a/reference/pages.v3.yml +++ b/reference/pages.v3.yml @@ -188,25 +188,25 @@ paths: schema: $ref: '#/components/schemas/PagesCollectionResponse' examples: - update meta descriptions for two pages: + Update meta descriptions for two pages: value: data: - id: 20 channel_id: 1 - name: all about powder detergents + name: Powder detergents meta_title: '' is_visible: false parent_id: 0 sort_order: 0 meta_keywords: null type: page - meta_description: cornpone + meta_description: eco-friendly is_homepage: false is_customers_only: false search_keywords: '' - id: 19 channel_id: 1 - name: sign up to dream big + name: Contact us meta_title: '' email: '' is_visible: false @@ -215,7 +215,7 @@ paths: meta_keywords: null contact_fields: '' type: contact_form - meta_description: arugula + meta_description: contact is_homepage: false is_customers_only: false search_keywords: '' @@ -311,144 +311,107 @@ paths: schema: $ref: '#/components/schemas/SinglePageResponse' examples: - several data types: + Blog: value: data: - - id: 3 - channel_id: 1 - name: Blog - meta_title: Blog - is_visible: false - parent_id: 0 - sort_order: 4 - meta_keywords: '' - type: blog - meta_description: '' - is_homepage: false - is_customers_only: false - search_keywords: '0' - url: /blog/ - - id: 5 - channel_id: 1 - name: Contact Us - meta_title: '' - email: '' - is_visible: true - parent_id: 0 - sort_order: 3 - meta_keywords: contact keyword - contact_fields: 'fullname,companyname,phone,orderno,rma' - type: contact_form - meta_description: contact meta desc - is_homepage: false - is_customers_only: true - search_keywords: contact search keyword - - id: 16 - channel_id: 1 - name: all about powder detergents 2 - meta_title: '' - is_visible: false - parent_id: 0 - sort_order: 0 - meta_keywords: null - type: page - meta_description: '' - is_homepage: false - is_customers_only: false - search_keywords: '' - - id: 17 - channel_id: 1 - name: one hundred million red balloons 3 - is_visible: false - parent_id: 0 - sort_order: 0 - type: raw - is_homepage: false - is_customers_only: false - search_keywords: '' - content_type: text/html - - id: 18 - channel_id: 1 - name: diaper pin purveyors 3 - is_visible: false - parent_id: 0 - sort_order: 0 - link: 'https://example.com/diaper-pins' - type: link - is_homepage: false - is_customers_only: false - - id: 19 - channel_id: 1 - name: sign up to crush dreams 3 - meta_title: '' - email: '' - is_visible: false - parent_id: 0 - sort_order: 0 - meta_keywords: null - contact_fields: '' - type: contact_form - meta_description: '' - is_homepage: false - is_customers_only: false - search_keywords: '' - - id: 20 - channel_id: 1 - name: all about powder detergents 3 - meta_title: '' - is_visible: false - parent_id: 0 - sort_order: 0 - meta_keywords: null - type: page - meta_description: '' - is_homepage: false - is_customers_only: false - search_keywords: '' - - id: 21 - channel_id: 1 - name: feed monsters 3 - meta_title: '' - is_visible: false - parent_id: 0 - sort_order: 0 - meta_keywords: null - feed: /rss/monsters - type: feed - meta_description: '' - is_homepage: false - is_customers_only: false - search_keywords: '' - - id: 22 - channel_id: 1 - name: one hundred million red balloons 4 - is_visible: false - parent_id: 0 - sort_order: 0 - type: raw - is_homepage: false - is_customers_only: false - search_keywords: '' - content_type: text/html - - id: 23 - channel_id: 1 - name: diaper pin purveyors 4 - is_visible: false - parent_id: 0 - sort_order: 0 - link: 'https://example.com/diaper-pins' - type: link - is_homepage: false - is_customers_only: false - meta: - pagination: - total: 6 - count: 6 - per_page: 50 - current_page: 1 - total_pages: 1 - links: - current: '?page=1&limit=50' + id: 3 + channel_id: 1 + name: Blog + meta_title: Blog + is_visible: false + parent_id: 0 + sort_order: 4 + meta_keywords: '' + type: blog + meta_description: '' + is_homepage: false + is_customers_only: false + search_keywords: '0' + url: /blog/ + meta: {} + Contact form: + value: + data: + id: 5 + channel_id: 1 + name: Contact Us + meta_title: '' + email: '' + is_visible: true + parent_id: 0 + sort_order: 3 + meta_keywords: contact keyword + contact_fields: 'fullname,companyname,phone,orderno,rma' + type: contact_form + meta_description: contact meta desc + is_homepage: false + is_customers_only: true + search_keywords: contact search keyword + meta: {} + Page: + value: + data: + id: 16 + channel_id: 1 + name: Powder Detergents + meta_title: '' + is_visible: false + parent_id: 0 + sort_order: 0 + meta_keywords: null + type: page + meta_description: '' + is_homepage: false + is_customers_only: false + search_keywords: '' + meta: {} + Raw: + value: + data: + id: 17 + channel_id: 1 + name: Compare Detergents + is_visible: false + parent_id: 0 + sort_order: 0 + type: raw + is_homepage: false + is_customers_only: false + search_keywords: '' + content_type: text/html + meta: {} + Link: + value: + data: + id: 18 + channel_id: 1 + name: California carcinogen list + is_visible: false + parent_id: 0 + sort_order: 0 + link: 'https://california.example.com/known-carcinogens' + type: link + is_homepage: false + is_customers_only: false + meta: {} + Feed: + value: + data: + id: 21 + channel_id: 1 + name: Detergents podcast feed + meta_title: '' + is_visible: false + parent_id: 0 + sort_order: 0 + meta_keywords: null + feed: /rss/detergents + type: feed + meta_description: '' + is_homepage: false + is_customers_only: false + search_keywords: '' + meta: {} '404': description: Not Found. content: @@ -572,13 +535,6 @@ components: schema: type: string default: application/json - storeHashPath: - schema: - type: string - name: store_hash - in: path - required: true - description: The permanent ID of the BigCommerce store. pageIdPath: schema: type: string @@ -649,21 +605,6 @@ components: in: query name: page description: The ordered grouping of results to return. See `meta.pagination.current_page` in the response body. - headers: - Content-Type: - description: 'The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body.' - schema: - type: string - default: application/json - Accept: - description: 'The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.' - schema: - type: string - default: application/json - X-Auth-Token: - description: Your API account's access token. - schema: - type: string securitySchemes: X-Auth-Token: name: X-Auth-Token @@ -820,7 +761,6 @@ components: x-examples: {} properties: data: - type: object anyOf: - $ref: '#/components/schemas/typePage' - $ref: '#/components/schemas/typeBlog' @@ -832,25 +772,6 @@ components: $ref: '#/components/schemas/ResponseMeta' title: PageResponseObject type: object - ContactFields: - allOf: - - properties: - fullname: - type: string - description: Full name of the customer who is submitting the form. - phone: - type: string - description: 'Customer’s phone number, as submitted on the form.' - companyname: - type: string - description: Customer’s submitted company name. - orderno: - type: string - description: Customer’s submitted order number. - rma: - type: string - description: Customer’s submitted RMA (Return Merchandise Authorization) number. - type: object PagePutObj: type: object description: Properties of the page modification request body. @@ -1051,7 +972,8 @@ components: - $ref: '#/components/schemas/anyTypePage' - $ref: '#/components/schemas/pageMeta' - $ref: '#/components/schemas/searchKeywords' - - properties: + - type: object + properties: url: type: string description: | @@ -1064,7 +986,8 @@ components: - $ref: '#/components/schemas/anyTypePage' - $ref: '#/components/schemas/pageMeta' - $ref: '#/components/schemas/searchKeywords' - - properties: + - type: object + properties: email: type: string description: 'Applicable when the page type is `contact_form`: contact email address that receives messages sent using the form. Must be unique.' @@ -1089,7 +1012,8 @@ components: - $ref: '#/components/schemas/anyTypePage' - $ref: '#/components/schemas/pageMeta' - $ref: '#/components/schemas/searchKeywords' - - properties: + - type: object + properties: feed: type: string description: | @@ -1102,7 +1026,8 @@ components: allOf: - $ref: '#/components/schemas/anyTypePage' - $ref: '#/components/schemas/searchKeywords' - - properties: + - type: object + properties: body: type: string description: | @@ -1120,7 +1045,8 @@ components: `type: link`. A link to an external absolute URL. Displays in the menu of other pages that contain markup. Does not contain a body. allOf: - $ref: '#/components/schemas/anyTypePage' - - properties: + - type: object + properties: link: type: string description: The link for the page type `link`. @@ -1155,51 +1081,6 @@ components: nullable: true default: '""' readOnly: false - ReadShared: - type: object - properties: - name: - type: string - description: The name of the page. Must be unique. - minLength: 1 - maxLength: 100 - uniqueItems: true - example: About Our Company - is_visible: - type: boolean - description: Indicates whether the page is available to users and visible in any menus. - parent_id: - type: integer - description: 'ID of the parent page, if any.' - example: 0 - default: 0 - sort_order: - type: integer - description: Determines the order in which the page is displayed in the parent page’s menu. Pages with lower integers display earlier. - example: 0 - default: 0 - type: - type: string - description: 'Determines the type of page. See [Pages v3 page types](/docs/rest-content/pages#page-types) for more about the differences.' - example: page - enum: - - page - - contact_form - - raw - - blog - - feed - - link - is_homepage: - type: boolean - description: 'Determines whether this page loads at the siteʼs root route. For example, at `https://example.com/`.' - default: false - is_customers_only: - type: boolean - description: 'When `true`, this page is not visible to merchant users who are signed in to the store control panel.' - default: false - required: - - name - - type responses: HTTP207Response: description: 'Multiple operations have occurred 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 has failed.' @@ -1232,21 +1113,3 @@ components: $ref: '#/components/schemas/ResponseMeta' HTTP204: description: No content. A 204 response with no payload indicates successful deletion of all specified pages. - HTTP400: - description: '' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ResponseErrorBrief' - HTTP404: - description: '' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ResponseErrorDetailed' - HTTP422: - description: '' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ResponseErrorDetailed' diff --git a/reference/payments/accepted-methods_payments.v3.yml b/reference/payments/accepted-methods_payments.v3.yml index e75aca489..70b4fd295 100644 --- a/reference/payments/accepted-methods_payments.v3.yml +++ b/reference/payments/accepted-methods_payments.v3.yml @@ -102,6 +102,7 @@ paths: format: int32 errors: type: object + properties: {} additionalProperties: type: string required: @@ -135,6 +136,7 @@ paths: format: int32 errors: type: object + properties: {} additionalProperties: type: string required: @@ -168,6 +170,7 @@ paths: format: int32 errors: type: object + properties: {} additionalProperties: type: string required: @@ -201,6 +204,7 @@ paths: format: int32 errors: type: object + properties: {} additionalProperties: type: string required: @@ -234,6 +238,7 @@ paths: format: int32 errors: type: object + properties: {} additionalProperties: type: string required: diff --git a/reference/payments/access-tokens_payments.v3.yml b/reference/payments/access-tokens_payments.v3.yml index 6d5386ca6..a5a4678c2 100644 --- a/reference/payments/access-tokens_payments.v3.yml +++ b/reference/payments/access-tokens_payments.v3.yml @@ -154,6 +154,7 @@ paths: format: int32 errors: type: object + properties: {} additionalProperties: type: string required: @@ -187,6 +188,7 @@ paths: format: int32 errors: type: object + properties: {} additionalProperties: type: string required: @@ -220,6 +222,7 @@ paths: format: int32 errors: type: object + properties: {} additionalProperties: type: string required: @@ -253,6 +256,7 @@ paths: format: int32 errors: type: object + properties: {} additionalProperties: type: string required: @@ -286,6 +290,7 @@ paths: format: int32 errors: type: object + properties: {} additionalProperties: type: string required: @@ -319,6 +324,7 @@ paths: format: int32 errors: type: object + properties: {} additionalProperties: type: string required: diff --git a/reference/payments/process_payments.yml b/reference/payments/process_payments.yml index 496c0ff16..193aa29f5 100644 --- a/reference/payments/process_payments.yml +++ b/reference/payments/process_payments.yml @@ -252,6 +252,7 @@ paths: errors: description: '' type: object + properties: {} additionalProperties: type: string required: @@ -286,6 +287,7 @@ paths: errors: description: '' type: object + properties: {} additionalProperties: type: string required: @@ -320,6 +322,7 @@ paths: errors: description: '' type: object + properties: {} additionalProperties: type: string required: @@ -354,6 +357,7 @@ paths: errors: description: '' type: object + properties: {} additionalProperties: type: string required: diff --git a/reference/price_lists.v3.yml b/reference/price_lists.v3.yml index 099056f6e..2125f860e 100644 --- a/reference/price_lists.v3.yml +++ b/reference/price_lists.v3.yml @@ -160,7 +160,6 @@ paths: type: array items: title: Price List - type: object allOf: - type: object properties: @@ -324,7 +323,6 @@ paths: properties: data: title: Price List - type: object allOf: - type: object properties: @@ -461,6 +459,8 @@ paths: schema: title: Delete Price Lists Response type: object + properties: {} + additionalProperties: true nullable: true '/pricelists/{price_list_id}': parameters: @@ -622,7 +622,6 @@ paths: properties: data: title: Price List - type: object allOf: - type: object properties: @@ -1005,7 +1004,6 @@ paths: type: array items: title: Price Record - type: object description: The Price Record object. allOf: - type: object @@ -1036,31 +1034,29 @@ paths: example: 158 readOnly: true - title: Price Record Identifiers - type: object description: Price Record object used in batch create or update. - allOf: - - type: object - properties: - price_list_id: - type: integer - description: | - The Price List with which this price set is associated. - example: 2 - variant_id: - type: integer - description: | - The variant with which this price set is associated. Either `variant_id` or `sku` is required. - example: 325 - sku: - type: string - description: | - The variant with which this price set is associated. Either `sku` or `variant_id` is required. - currency: - type: string - description: | - The 3-letter currency code with which this price set is associated. - format: ISO-4217 - example: usd + type: object + properties: + price_list_id: + type: integer + description: | + The Price List with which this price set is associated. + example: 2 + variant_id: + type: integer + description: | + The variant with which this price set is associated. Either `variant_id` or `sku` is required. + example: 325 + sku: + type: string + description: | + The variant with which this price set is associated. Either `sku` or `variant_id` is required. + currency: + type: string + description: | + The 3-letter currency code with which this price set is associated. + format: ISO-4217 + example: usd - title: PriceRecord Base type: object properties: @@ -1467,7 +1463,8 @@ paths: title: PriceRecord Batch Item description: Price Record object used in batch create or update. allOf: - - properties: + - type: object + properties: variant_id: type: integer description: | @@ -1485,6 +1482,7 @@ paths: format: ISO-4217 example: usd - title: PriceRecord Base + type: object description: Common Price Record properties. properties: price: @@ -1552,7 +1550,6 @@ paths: description: | The SKU code associated with this `Price Record` if requested and it exists. example: SMB-123 - type: object required: true description: '' responses: @@ -1586,31 +1583,29 @@ paths: properties: data: title: Price Record Identifiers - type: object description: Price Record object used in batch create or update. - allOf: - - type: object - properties: - price_list_id: - type: integer - description: | - The Price List with which this price set is associated. - example: 2 - variant_id: - type: integer - description: | - The variant ID with which this price set is associated. Either `variant_id` or `sku` is required. - example: 325 - sku: - type: string - description: | - The variant with which this price set is associated. Either `sku` or `variant_id` is required. - currency: - type: string - description: | - The 3-letter currency code with which this price set is associated. - format: ISO-4217 - example: usd + type: object + properties: + price_list_id: + type: integer + description: | + The Price List with which this price set is associated. + example: 2 + variant_id: + type: integer + description: | + The variant ID with which this price set is associated. Either `variant_id` or `sku` is required. + example: 325 + sku: + type: string + description: | + The variant with which this price set is associated. Either `sku` or `variant_id` is required. + currency: + type: string + description: | + The 3-letter currency code with which this price set is associated. + format: ISO-4217 + example: usd field_errors: title: Detailed Errors type: object @@ -1725,7 +1720,8 @@ paths: title: Price Record description: The Price Record object. allOf: - - properties: + - type: object + properties: calculated_price: type: number description: | @@ -1753,6 +1749,7 @@ paths: readOnly: true - title: Price Record Identifiers description: Price Record object used in batch create or update. + type: object properties: price_list_id: type: integer @@ -1775,6 +1772,7 @@ paths: example: usd - title: PriceRecord Base description: Common Price Record properties. + type: object properties: price: type: number @@ -1841,7 +1839,6 @@ paths: description: | The SKU code associated with this `Price Record` if requested and it exists. example: SMB-123 - type: object meta: title: Collection Meta type: object @@ -1969,7 +1966,6 @@ paths: properties: data: title: Price Record - type: object description: The Price Record object. allOf: - type: object @@ -2002,29 +1998,27 @@ paths: - title: Price Record Identifiers type: object description: Price Record object used in batch create or update requests. - allOf: - - type: object - properties: - price_list_id: - type: integer - description: | - The Price List with which this price set is associated. - example: 2 - variant_id: - type: integer - description: | - The variant with which this price set is associated. Either `variant_id` or `sku` is required. - example: 325 - sku: - type: string - description: | - The variant with which this price set is associated. Either `sku` or `variant_id` is required. - currency: - type: string - description: | - The 3-letter currency code with which this price set is associated. - format: ISO-4217 - example: usd + properties: + price_list_id: + type: integer + description: | + The Price List with which this price set is associated. + example: 2 + variant_id: + type: integer + description: | + The variant with which this price set is associated. Either `variant_id` or `sku` is required. + example: 325 + sku: + type: string + description: | + The variant with which this price set is associated. Either `sku` or `variant_id` is required. + currency: + type: string + description: | + The 3-letter currency code with which this price set is associated. + format: ISO-4217 + example: usd - title: PriceRecord Base type: object properties: @@ -2241,7 +2235,8 @@ paths: data: description: The Price Record object. allOf: - - properties: + - type: object + properties: calculated_price: type: number format: double @@ -2268,8 +2263,7 @@ paths: example: 158 readOnly: true - description: Price Record object used in a batch create or update request. - allOf: - - properties: + properties: price_list_id: type: integer description: | @@ -2356,7 +2350,6 @@ paths: The SKU code associated with this `Price Record` if requested and it exists. example: SMB-123 title: Price Record - type: object meta: $ref: '#/components/schemas/Meta' title: Price Record Response @@ -2882,9 +2875,13 @@ components: properties: data: type: object + properties: {} + additionalProperties: true example: {} meta: type: object + properties: {} + additionalProperties: true example: {} PriceRecordBatchErrorResponse: type: object @@ -2897,24 +2894,23 @@ components: PriceRecordIdentifiers: type: object description: The `Price Record` object used in batch create or update. - allOf: - - type: object - properties: - price_list_id: - type: integer - description: The Price List with which this price record is associated. - variant_id: - type: integer - description: The variant with which this price record is associated. Either `variant_id` or `sku` is required. - sku: - type: string - description: The variant with which this price record is associated. Either `sku` or `variant_id` is required. - currency: - type: string - description: The 3-letter currency code with which this price set is associated. - format: ISO-4217 + properties: + price_list_id: + type: integer + description: The Price List with which this price record is associated. + variant_id: + type: integer + description: The variant with which this price record is associated. Either `variant_id` or `sku` is required. + sku: + type: string + description: The variant with which this price record is associated. Either `sku` or `variant_id` is required. + currency: + type: string + description: The 3-letter currency code with which this price set is associated. + format: ISO-4217 DetailedErrors: type: object + properties: {} additionalProperties: type: string PriceListAssignmentsBatchErrorResponse: diff --git a/reference/settings.v3.yml b/reference/settings.v3.yml index 5d33257e9..225e6f42d 100644 --- a/reference/settings.v3.yml +++ b/reference/settings.v3.yml @@ -512,15 +512,15 @@ paths: - collapsed_by_default: false display_name: Brand display_product_count: true - id: Y123= + id: 235fc3dg67 is_enabled: true - items_to_show: 12 + items_to_show: 15 sort_by: alpha type: brand - collapsed_by_default: false display_name: Color display_product_count: true - id: Q123= + id: 25DtbA= is_enabled: true items_to_show: 10 sort_by: alpha @@ -528,7 +528,7 @@ paths: - collapsed_by_default: true display_name: Ships for Free display_product_count: false - id: Y456= + id: Ym329vbA== is_enabled: true show_free_shipping_filter: true show_in_stock_filter: true @@ -559,9 +559,9 @@ paths: - collapsed_by_default: false display_name: Size display_product_count: true - id: U123= + id: '124' is_enabled: true - items_to_show: 12 + items_to_show: 15 sort_by: alpha type: product - collapsed_by_default: false @@ -603,9 +603,9 @@ paths: - collapsed_by_default: false display_name: Size display_product_count: true - id: U123== + id: '126' is_enabled: true - items_to_show: 12 + items_to_show: 10 sort_by: alpha type: product - collapsed_by_default: false @@ -1475,6 +1475,8 @@ paths: $ref: '#/components/schemas/MeasurementUnitsSettings' meta: type: object + properties: {} + additionalProperties: true '422': description: The provided settings could not be applied. See detailed errors in the response. content: @@ -1513,6 +1515,8 @@ paths: $ref: '#/components/schemas/MeasurementUnitsSettings' meta: type: object + properties: {} + additionalProperties: true parameters: - $ref: '#/components/parameters/ChannelIdParam' tags: @@ -1541,24 +1545,6 @@ components: name: channel_id schema: type: integer - KeysToDelete: - description: A comma-separated list of strings representing which configuration keys should be cleared (un-overridden) for the channel. - in: query - name: keys - required: true - style: form - explode: false - schema: - type: array - items: - type: string - RequiredChannelIdParamForDelete: - description: 'Required channel ID. This delete operation will delete overridden settings for this channel, thus restoring them to the global defaults.' - in: query - name: channel_id - required: true - schema: - type: integer schemas: AddressTypeEnumValues: description: Only supports manipulation on a global level. @@ -1594,8 +1580,7 @@ components: $ref: '#/components/schemas/AnalyticsProvider' x-internal: false AvailableFilter: - type: object - oneOf: + anyOf: - $ref: '#/components/schemas/AvailableNormalFilter' - $ref: '#/components/schemas/AvailablePriceFilter' - $ref: '#/components/schemas/AvailableOtherFilter' @@ -1688,7 +1673,7 @@ components: x-tags: - Models ConfiguredFilter: - oneOf: + anyOf: - $ref: '#/components/schemas/EnabledProductFilter' - $ref: '#/components/schemas/EnabledPriceFilter' - $ref: '#/components/schemas/EnabledCategoryFilter' @@ -1740,6 +1725,7 @@ components: type: boolean id: type: string + description: The ID of the filter. is_enabled: type: boolean items_to_show: @@ -1771,6 +1757,7 @@ components: type: boolean id: type: string + description: The ID of the filter. is_enabled: type: boolean items_to_show: @@ -1785,34 +1772,8 @@ components: - category title: EnabledCategoryFilter x-internal: false - EnabledFilter: - oneOf: - - $ref: '#/components/schemas/EnabledProductFilter' - - $ref: '#/components/schemas/EnabledPriceFilter' - - $ref: '#/components/schemas/EnabledCategoryFilter' - - $ref: '#/components/schemas/EnabledBrandFilter' - - $ref: '#/components/schemas/EnabledRatingFilter' - - $ref: '#/components/schemas/EnabledMiscFilter' - title: EnabledFilter - x-internal: false - EnabledFilters: - type: array - items: - $ref: '#/components/schemas/EnabledFilter' - title: EnabledFilters - x-internal: false - EnabledFiltersOverride: - description: 'A new set of enabled Product Filtering filters which should display in a particular context, such as on a particular Channel, or while viewing a particular Category. Array order indicates the display order on the storefront.' - type: object - properties: - data: - $ref: '#/components/schemas/EnabledFilters' - scope: - $ref: '#/components/schemas/SearchFilterOverrideScopeIdentifier' - title: EnabledFiltersOverride - x-internal: false EnabledMiscFilter: - description: Miscellaneous Filters which appear as a group. + description: Miscellaneous filters which appear as a group. type: object properties: collapsed_by_default: @@ -1822,7 +1783,8 @@ components: display_product_count: type: boolean id: - type: integer + type: string + description: The ID of the filter. is_enabled: type: boolean show_free_shipping_filter: @@ -1840,7 +1802,7 @@ components: title: EnabledMiscFilter x-internal: false EnabledPriceFilter: - description: 'A filter based on the product’s price, shown as a price range on the storefront.' + description: A filter based on the product’s price, shown as a price range on the storefront. type: object properties: collapsed_by_default: @@ -1849,6 +1811,7 @@ components: type: string id: type: string + description: The ID of the filter. is_enabled: type: boolean type: @@ -1869,6 +1832,7 @@ components: type: boolean id: type: string + description: The ID of the filter. is_enabled: type: boolean items_to_show: @@ -1899,6 +1863,7 @@ components: type: string id: type: string + description: The ID of the filter. is_enabled: type: boolean type: @@ -2215,15 +2180,6 @@ components: type: integer title: ContextIdentifier x-internal: false - SearchFilterOverrideScopeIdentifier: - type: object - properties: - category_id: - type: integer - channel_id: - type: integer - title: ScopeIdentifier - x-internal: false StoreProfile: title: Store Profile description: The basic profile settings for a store, used to give the shopper information about the business from which they are purchasing. diff --git a/reference/shipping.v2.yml b/reference/shipping.v2.yml index 561e5b1bc..45277dc23 100644 --- a/reference/shipping.v2.yml +++ b/reference/shipping.v2.yml @@ -109,9 +109,9 @@ paths: type: boolean handling_fees: title: Shipping Zone Handling Fees - type: object - oneOf: - - properties: + anyOf: + - type: object + properties: fixed_surcharge: description: Flat-rate handling fee applied to shipping cost. example: '0' @@ -120,8 +120,9 @@ paths: description: Indicates whether store displays handling fee separately at checkout. example: true type: boolean - title: fixed surcharge - - properties: + title: Fixed surcharge + - type: object + properties: percentage_surcharge: description: Percentage handling fee applied to shipping cost. example: '5' @@ -130,7 +131,7 @@ paths: description: Indicates whether store displays handling fee separately at checkout. example: true type: boolean - title: percentage surcharge + title: Percentage surcharge enabled: description: Whether this shipping zone is enabled. example: true @@ -248,9 +249,9 @@ paths: type: boolean handling_fees: title: Shipping Zone Handling Fees - type: object - oneOf: - - properties: + anyOf: + - type: object + properties: fixed_surcharge: description: Flat-rate handling fee applied to shipping cost. example: '0' @@ -259,8 +260,9 @@ paths: description: Indicates whether store displays handling fee separately at checkout. example: true type: boolean - title: fixed surcharge - - properties: + title: Fixed surcharge + - type: object + properties: percentage_surcharge: description: Percentage handling fee applied to shipping cost. example: '5' @@ -269,7 +271,7 @@ paths: description: Indicates whether store displays handling fee separately at checkout. example: true type: boolean - title: percentage surcharge + title: Percentage surcharge enabled: description: Whether this shipping zone is enabled. example: true @@ -362,9 +364,9 @@ paths: type: boolean handling_fees: title: Shipping Zone Handling Fees - type: object - oneOf: - - properties: + anyOf: + - type: object + properties: fixed_surcharge: description: Flat-rate handling fee applied to shipping cost. example: '0' @@ -373,8 +375,9 @@ paths: description: Indicates whether store displays handling fee separately at checkout. example: true type: boolean - title: fixed surcharge - - properties: + title: Fixed surcharge + - type: object + properties: percentage_surcharge: description: Percentage handling fee applied to shipping cost. example: '5' @@ -383,7 +386,7 @@ paths: description: Indicates whether store displays handling fee separately at checkout. example: true type: boolean - title: percentage surcharge + title: Percentage surcharge enabled: description: Whether this shipping zone is enabled. example: true @@ -456,9 +459,9 @@ paths: type: boolean handling_fees: title: Shipping Zone Handling Fees - type: object - oneOf: - - properties: + anyOf: + - type: object + properties: fixed_surcharge: description: Flat-rate handling fee applied to shipping cost. example: '0' @@ -467,8 +470,9 @@ paths: description: Indicates whether store displays handling fee separately at checkout. example: true type: boolean - title: fixed surcharge - - properties: + title: Fixed surcharge + - type: object + properties: percentage_surcharge: description: Percentage handling fee applied to shipping cost. example: '5' @@ -477,7 +481,7 @@ paths: description: Indicates whether store displays handling fee separately at checkout. example: true type: boolean - title: percentage surcharge + title: Percentage surcharge enabled: description: Whether this shipping zone is enabled. example: true @@ -556,9 +560,9 @@ paths: type: boolean handling_fees: title: Shipping Zone Handling Fees - type: object - oneOf: - - properties: + anyOf: + - type: object + properties: fixed_surcharge: description: Flat-rate handling fee applied to shipping cost. example: '0' @@ -567,8 +571,9 @@ paths: description: Indicates whether store displays handling fee separately at checkout. example: true type: boolean - title: fixed surcharge - - properties: + title: Fixed surcharge + - type: object + properties: percentage_surcharge: description: Percentage handling fee applied to shipping cost. example: '5' @@ -577,7 +582,7 @@ paths: description: Indicates whether store displays handling fee separately at checkout. example: true type: boolean - title: percentage surcharge + title: Percentage surcharge enabled: description: Whether this shipping zone is enabled. example: true @@ -646,9 +651,9 @@ paths: type: boolean handling_fees: title: Shipping Zone Handling Fees - type: object - oneOf: - - properties: + anyOf: + - type: object + properties: fixed_surcharge: description: Flat-rate handling fee applied to shipping cost. example: '0' @@ -657,8 +662,9 @@ paths: description: Indicates whether store displays handling fee separately at checkout. example: true type: boolean - title: fixed surcharge - - properties: + title: Fixed surcharge + - type: object + properties: percentage_surcharge: description: Percentage handling fee applied to shipping cost. example: '5' @@ -667,7 +673,7 @@ paths: description: Indicates whether store displays handling fee separately at checkout. example: true type: boolean - title: percentage surcharge + title: Percentage surcharge enabled: description: Whether this shipping zone is enabled. example: true @@ -1420,25 +1426,28 @@ paths: settings: description: 'Depends on the shipping method type. See the [supported settings object](#supported-settings).' type: object + properties: {} + additionalProperties: true enabled: description: Whether or not this shipping zone method is enabled. example: true type: boolean handling_fees: - oneOf: - - title: fixed surcharge + anyOf: + - title: Fixed surcharge + type: object properties: fixed_surcharge: type: number description: Flat-rate handling fee applied to shipping cost. example: 0 - - title: percentage surcharge + - title: Percentage surcharge + type: object properties: percentage_surcharge: type: number description: Percentage handling fee applied to shipping cost. example: 0 - type: object is_fallback: description: Whether or not this shipping zone is the fallback if all others are not valid for the order. example: false @@ -2179,9 +2188,9 @@ components: type: boolean handling_fees: title: Shipping Zone Handling Fees - type: object - oneOf: - - properties: + anyOf: + - type: object + properties: fixed_surcharge: description: Flat-rate handling fee applied to shipping cost. example: '0' @@ -2190,8 +2199,9 @@ components: description: Indicates whether store displays handling fee separately at checkout. example: true type: boolean - title: fixed surcharge - - properties: + title: Fixed surcharge + - type: object + properties: percentage_surcharge: description: Percentage handling fee applied to shipping cost. example: '5' @@ -2200,7 +2210,7 @@ components: description: Indicates whether store displays handling fee separately at checkout. example: true type: boolean - title: percentage surcharge + title: Percentage surcharge enabled: description: Whether this shipping zone is enabled. example: true @@ -2231,9 +2241,9 @@ components: x-internal: false HandlingFees: title: Shipping Zone Handling Fees - type: object - oneOf: - - properties: + anyOf: + - type: object + properties: fixed_surcharge: description: Flat-rate handling fee applied to shipping cost. example: '0' @@ -2242,8 +2252,9 @@ components: description: Indicates whether store displays handling fee separately at checkout. example: true type: boolean - title: fixed surcharge - - properties: + title: Fixed surcharge + - type: object + properties: percentage_surcharge: description: Percentage handling fee applied to shipping cost. example: '5' @@ -2252,8 +2263,7 @@ components: description: Indicates whether store displays handling fee separately at checkout. example: true type: boolean - title: percentage surcharge - x-internal: false + title: Percentage surcharge shippingMethod_Full: title: shippingMethod_Full allOf: @@ -2308,20 +2318,21 @@ components: example: true type: boolean handling_fees: - oneOf: - - title: fixed surcharge + anyOf: + - title: Fixed surcharge + type: object properties: fixed_surcharge: type: number description: Flat-rate handling fee applied to shipping cost. example: 0 - - title: percentage surcharge + - title: Percentage surcharge + type: object properties: percentage_surcharge: type: number description: Percentage handling fee applied to shipping cost. example: 0 - type: object is_fallback: description: Whether or not this shipping zone is the fallback if all others are not valid for the order. example: false @@ -2339,6 +2350,8 @@ components: type: string connection: type: object + properties: {} + additionalProperties: true description: The `connection` object varies by carrier. x-internal: false metaCollection: diff --git a/reference/shipping.v3.yml b/reference/shipping.v3.yml index a750fe544..76a8d8e09 100644 --- a/reference/shipping.v3.yml +++ b/reference/shipping.v3.yml @@ -462,6 +462,8 @@ components: x-internal: false error_Full: title: Error - description: Meta data relating to pagination + description: '' type: object + properties: {} + additionalProperties: true x-internal: false diff --git a/reference/shipping_provider.yml b/reference/shipping_provider.yml index 2b2190c06..228c78a4b 100644 --- a/reference/shipping_provider.yml +++ b/reference/shipping_provider.yml @@ -706,11 +706,15 @@ components: x-internal: false ZoneOptionsInstance: type: object + properties: {} + additionalProperties: true description: Any zone-specific request options declared by the carrier and configured by the merchant to retrieve rates. Optional. title: Zone Options Instance x-internal: false ConnectionOptionsInstance: type: object + properties: {} + additionalProperties: true description: Any global request options declared by the carrier and configured by the merchant to retrieve rates. Optional. title: Connection Options Instance x-internal: false diff --git a/reference/sites.v3.yml b/reference/sites.v3.yml index 2357cc3ba..c1af90a68 100644 --- a/reference/sites.v3.yml +++ b/reference/sites.v3.yml @@ -719,6 +719,8 @@ components: x-internal: false _errors: type: object + properties: {} + additionalProperties: true description: The keys and values in an errors object will vary depending on the error received. title: _errors x-internal: false diff --git a/reference/store_content.v2.yml b/reference/store_content.v2.yml index c279bcf1b..d42a89877 100644 --- a/reference/store_content.v2.yml +++ b/reference/store_content.v2.yml @@ -223,6 +223,8 @@ paths: application/json: schema: type: object + properties: {} + additionalProperties: true delete: tags: - Blog Posts @@ -350,6 +352,8 @@ paths: application/json: schema: type: object + properties: {} + additionalProperties: true delete: tags: - Blog Posts @@ -530,6 +534,8 @@ paths: application/json: schema: type: object + properties: {} + additionalProperties: true '/pages/{id}': parameters: - $ref: '#/components/parameters/Accept' @@ -638,6 +644,8 @@ paths: application/json: schema: type: object + properties: {} + additionalProperties: true delete: deprecated: true tags: @@ -1458,10 +1466,6 @@ components: type: string description: 'Not returned in any responses, but accepts up to two fields allowing you to set the customer’s password. If a password is not supplied, it is generated automatically. For further information about using this object, please see the Customers resource documentation.' x-internal: false - customer_Base: - title: customer_Base - type: object - x-internal: false page_Base: title: page_Base type: object diff --git a/reference/store_logs.v3.yml b/reference/store_logs.v3.yml index b3f0e7612..5d5483808 100644 --- a/reference/store_logs.v3.yml +++ b/reference/store_logs.v3.yml @@ -187,6 +187,7 @@ components: type: string DetailedErrors: type: object + properties: {} additionalProperties: type: string SystemLog: diff --git a/reference/storefront_tokens.v3.yml b/reference/storefront_tokens.v3.yml index 0267d302c..369d938ce 100644 --- a/reference/storefront_tokens.v3.yml +++ b/reference/storefront_tokens.v3.yml @@ -317,6 +317,7 @@ components: x-internal: false DetailedErrors: type: object + properties: {} additionalProperties: type: string x-internal: false diff --git a/reference/subscribers.v3.yml b/reference/subscribers.v3.yml index 3f83ce57b..0157d4ccd 100644 --- a/reference/subscribers.v3.yml +++ b/reference/subscribers.v3.yml @@ -373,8 +373,11 @@ components: format: date-time consents: type: array + items: + type: string description: Shows what active subscriptions a shopper may have. If the consents array is empty, the user has unsubscribed or didn’t enable the newsletter subscription checkbox during checkout. - example: [marketing_newsletter] + example: + - marketing_newsletter x-internal: false subscriber_Base: title: subscriber_Base diff --git a/reference/tax_properties.v3.yml b/reference/tax_properties.v3.yml index 1475145c2..7f3e34082 100644 --- a/reference/tax_properties.v3.yml +++ b/reference/tax_properties.v3.yml @@ -387,6 +387,8 @@ components: example: 157 tax_properties: type: object + properties: {} + additionalProperties: true description: A simple key-value pairing. The tax property must be defined to associate a value. These values will be sent to the active tax provider during Tax Provider API operations whenever the associated diff --git a/reference/tax_provider.yml b/reference/tax_provider.yml index 3dc9bdae3..73554c28a 100644 --- a/reference/tax_provider.yml +++ b/reference/tax_provider.yml @@ -966,7 +966,6 @@ components: origin_address: $ref: '#/components/schemas/Address' shipping: - type: object description: Shipping line item present in each document request. allOf: - $ref: '#/components/schemas/request-item' @@ -977,7 +976,6 @@ components: required: - type handling: - type: object description: Handling line item present in each document request. allOf: - $ref: '#/components/schemas/request-item' @@ -998,15 +996,14 @@ components: type: $ref: '#/components/schemas/item_type' wrapping: - type: object description: Optional gift wrapping for items in the consignment. - nullable: true allOf: - $ref: '#/components/schemas/request-item' - type: object properties: type: $ref: '#/components/schemas/wrapping_type' + nullable: true required: - type required: @@ -1172,21 +1169,19 @@ components: type: $ref: '#/components/schemas/item_type' wrapping: - type: object description: Optional gift wrapping for items in the consignment. - nullable: true allOf: - $ref: '#/components/schemas/response-item' - type: object properties: type: $ref: '#/components/schemas/wrapping_type' + nullable: true required: - type required: - type shipping: - type: object description: Shipping line item present in each document request. allOf: - $ref: '#/components/schemas/response-item' @@ -1197,7 +1192,6 @@ components: required: - type handling: - type: object description: Handling line item present in each document request. allOf: - $ref: '#/components/schemas/response-item' diff --git a/reference/themes.v3.yml b/reference/themes.v3.yml index 44b08a35f..63823d9e5 100644 --- a/reference/themes.v3.yml +++ b/reference/themes.v3.yml @@ -1140,6 +1140,7 @@ components: description: Request definition for activation endpoint. required: - variation_id + type: object properties: variation_id: description: The identifier for the variation to activate. @@ -1342,27 +1343,17 @@ components: description: Response for /GET Jobs by Id. x-internal: false WhichThemeToDownload: - description: 'An object specifying which theme to download. One of: `original`: the original Marketplace or uploaded custom theme; `last_activated`: the theme version most recently applied to the store; `last_created`: the theme version most recently created.' - allOf: - - description: |- - A BigCommerce object specifying which theme to download. - - `original`: the original Marketplace or uploaded custom theme. - - `last_activated`: the theme version most recently applied to the store. - - `last_created`: the theme version most recently created. - - If `which` is missing or invalid in the request, its value will default to `last_activated`. + description: |- + An object specifying which theme to download. One of: `original`: the original Marketplace or uploaded custom theme; `last_activated`: the theme version most recently applied to the store; `last_created`: the theme version most recently created. If `which` is missing or invalid in the request, its value will default to `last_activated`. + properties: + which: + description: Which revision to use. + type: string example: original - properties: - which: - description: Which revision to use. - type: string - enum: - - original - - last_activated - - last_created + enum: + - original + - last_activated + - last_created title: Which Theme To Download type: object x-internal: false @@ -1389,6 +1380,9 @@ components: description: The Variation to which the Configuration belongs. settings: type: object + format: json + properties: {} + additionalProperties: true description: 'The content of the configuration, which is a JSON object which will vary in structure from theme to theme.' date_created: type: string @@ -1406,6 +1400,9 @@ components: description: The Variation to which the Configuration belongs. settings: type: object + format: json + properties: {} + additionalProperties: true description: 'The content of the configuration, which is a JSON object which will vary in structure from theme to theme.' title: themeConfiguration_Write x-internal: false diff --git a/reference/webhooks.v3.yml b/reference/webhooks.v3.yml index 8a241cd95..56ea6c894 100644 --- a/reference/webhooks.v3.yml +++ b/reference/webhooks.v3.yml @@ -727,12 +727,12 @@ components: } } ``` - x-examples: {} title: store/cart/created allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -751,7 +751,6 @@ components: example: 09346904-4175-44fd-be53-f7e598531b6c x-tags: - created - type: object x-internal: false store_cart_updated: title: store/cart/updated @@ -779,11 +778,11 @@ components: } } ``` - x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -799,14 +798,12 @@ components: example: 09346904-4175-44fd-be53-f7e598531b6c x-tags: - created - type: object x-internal: false store_cart_deleted: title: store/cart/deleted description: |- Fires when a cart is deleted. Carts are deleted in two ways; when all items are removed from a cart, and when an API consumer explicitly removes the cart using a `DELETE` request. Cart deletion ends the cart lifecycle. The `store/cart/updated` webhook also fires when the last item is removed. - ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, @@ -820,11 +817,11 @@ components: } } ``` - x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -840,7 +837,6 @@ components: example: 09346904-4175-44fd-be53-f7e598531b6c x-tags: - deleted - type: object x-internal: false store_cart_couponApplied: title: store/cart/couponApplied @@ -861,11 +857,11 @@ components: } } ``` - x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -885,14 +881,12 @@ components: example: 1 x-tags: - created - type: object x-internal: false store_cart_abandoned: title: store/cart/abandoned description: |- This webhook fires after a cart is abandoned. BigCommerce considers a cart abandoned when it has no activity for at least one hour. This webhook is available for all store plans, regardless of whether the Abandoned Cart Saver feature is enabled. - ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, @@ -907,11 +901,11 @@ components: } } ``` - x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -929,14 +923,12 @@ components: type: string example: 1eed6d2d979776ff18e695ceeb10ea61 description: Use this token to obtain cart data. - type: object x-internal: false store_cart_converted: title: store/cart/converted description: |- Fires when a cart/checkout is converted into an order, which is typically after the checkout payment step on the storefront. At this point, the cart is automatically deleted and no longer accessible. This webhook returns both the cart/checkout ID and order ID for correlation purposes. - ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, @@ -951,11 +943,11 @@ components: } } ``` - x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -975,7 +967,6 @@ components: example: 252 x-tags: - created - type: object x-internal: false store_cart_lineItem_wildcard: title: store/cart/lineItem/* @@ -999,7 +990,8 @@ components: allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -1016,7 +1008,6 @@ components: description: ID of the cart. x-tags: - created - type: object x-internal: false store_cart_lineItem_created: title: store/cart/lineItem/created @@ -1041,7 +1032,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -1061,7 +1053,6 @@ components: example: b0386708-fef3-45de-9d8b-fbe3031450a4 x-tags: - created - type: object x-internal: false store_cart_lineItem_updated: title: store/cart/lineItem/updated @@ -1090,7 +1081,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -1108,7 +1100,6 @@ components: type: string description: ID of the cart example: b0386708-fef3-45de-9d8b-fbe3031450a4 - type: object x-tags: - updated x-internal: false @@ -1131,11 +1122,11 @@ components: } } ``` - x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -1153,7 +1144,6 @@ components: type: string description: ID of the cart. example: b0386708-fef3-45de-9d8b-fbe3031450a4 - type: object x-tags: - deleted x-internal: false @@ -1167,7 +1157,6 @@ components: x-internal: false store_category_created: title: store/category/created - type: object description: |- Fires when a category is created. @@ -1184,7 +1173,6 @@ components: } } ``` - x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' @@ -1231,7 +1219,8 @@ components: allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -1247,7 +1236,6 @@ components: example: 42 x-tags: - updated - type: object x-internal: false store_category_deleted: title: store/category/deleted @@ -1270,7 +1258,8 @@ components: allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -1287,7 +1276,6 @@ components: example: 42 x-tags: - deleted - type: object x-internal: false store_channel_wildcard: title: store/channel/* @@ -1317,7 +1305,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -1335,7 +1324,6 @@ components: example: 173331 x-tags: - created - type: object x-internal: false store_channel_updated: title: store/channel/updated @@ -1368,7 +1356,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -1386,7 +1375,6 @@ components: example: 173331 x-tags: - created - type: object x-internal: false store_customer_wildcard: title: store/customer/* @@ -1418,7 +1406,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -1436,7 +1425,6 @@ components: example: 32 x-tags: - created - type: object x-internal: false store_customer_updated: title: store/customer/updated @@ -1461,7 +1449,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -1479,7 +1468,6 @@ components: example: 32 x-tags: - created - type: object x-internal: false store_customer_deleted: title: store/customer/deleted @@ -1502,7 +1490,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -1520,7 +1509,6 @@ components: example: 32 x-tags: - created - type: object x-internal: false store_customer_address_updated: title: store/customer/address/updated @@ -1547,7 +1535,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -1570,7 +1559,6 @@ components: example: 32 x-tags: - created - type: object x-internal: false store_customer_address_created: title: store/customer/address/created @@ -1597,7 +1585,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -1620,7 +1609,6 @@ components: example: 32 x-tags: - created - type: object x-internal: false store_customer_address_deleted: title: store/customer/address/deleted @@ -1647,7 +1635,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -1670,7 +1659,6 @@ components: example: 32 x-tags: - created - type: object x-internal: false store_customer_payment_instrument_default_updated: title: store/customer/payment/instrument/default/updated @@ -1693,7 +1681,8 @@ components: allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -1711,12 +1700,10 @@ components: example: 32 x-tags: - created - type: object x-internal: false store_order_wildcard: title: store/order/* description: Fires for all `store/order` events. - type: object x-internal: false store_order_created: title: store/order/created @@ -1740,7 +1727,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -1757,7 +1745,6 @@ components: example: 250 x-tags: - created - type: object x-internal: false store_order_updated: title: store/order/updated @@ -1801,7 +1788,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -1818,7 +1806,6 @@ components: example: 250 x-tags: - created - type: object x-internal: false store_order_archived: title: store/order/archived @@ -1841,7 +1828,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -1858,7 +1846,6 @@ components: example: 250 x-tags: - created - type: object x-internal: false store_order_statusUpdated: title: store/order/statusUpdated @@ -1886,7 +1873,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -1913,7 +1901,6 @@ components: example: 11 x-tags: - created - type: object x-internal: false store_order_message_created: title: store/order/message/created @@ -1940,7 +1927,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -1963,7 +1951,6 @@ components: example: 3 x-tags: - created - type: object x-internal: false store_order_refund_created: title: store/order/refund/created @@ -1990,7 +1977,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -2013,12 +2001,10 @@ components: example: 3 x-tags: - created - type: object x-internal: false store_product_wildcard: title: store/product/* description: Fires for all `store/product` events. - type: object x-internal: false store_product_deleted: title: store/product/deleted @@ -2042,7 +2028,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -2059,7 +2046,6 @@ components: example: 205 x-tags: - created - type: object x-internal: false store_product_created: title: store/product/created @@ -2083,7 +2069,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -2100,7 +2087,6 @@ components: example: 205 x-tags: - created - type: object x-internal: false store_product_updated: title: store/product/updated @@ -2176,7 +2162,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -2193,7 +2180,6 @@ components: example: 205 x-tags: - created - type: object x-internal: false store_product_inventory_updated: title: store/product/inventory/updated @@ -2230,7 +2216,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -2266,7 +2253,6 @@ components: example: 2 x-tags: - created - type: object x-internal: false store_product_inventory_order_updated: title: store/product/inventory/order/updated @@ -2298,7 +2284,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -2334,12 +2321,10 @@ components: example: 2 x-tags: - created - type: object x-internal: false store_shipment_wildcard: title: store/shipment/* description: Fires for all `store/shipment` events. - type: object x-internal: false store_shipment_created: title: store/shipment/created @@ -2364,7 +2349,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -2384,7 +2370,6 @@ components: example: 251 x-tags: - created - type: object x-internal: false store_shipment_updated: title: store/shipment/updated @@ -2412,7 +2397,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -2432,7 +2418,6 @@ components: example: 251 x-tags: - created - type: object x-internal: false store_shipment_deleted: title: store/shipment/deleted @@ -2457,7 +2442,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -2477,12 +2463,10 @@ components: example: 251 x-tags: - created - type: object x-internal: false store_sku_wildcard: title: store/sku/* description: Fires for all `store/sku` events. - type: object x-internal: false store_sku_created: title: store/sku/created @@ -2510,7 +2494,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -2537,7 +2522,6 @@ components: example: 509 x-tags: - created - type: object x-internal: false store_sku_updated: title: store/sku/updated @@ -2565,7 +2549,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -2592,7 +2577,6 @@ components: example: 509 x-tags: - created - type: object x-internal: false store_sku_deleted: title: store/sku/deleted @@ -2620,7 +2604,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -2647,7 +2632,6 @@ components: example: 509 x-tags: - created - type: object x-internal: false store_sku_inventory_updated: title: store/sku/inventory/updated @@ -2677,7 +2661,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -2717,7 +2702,6 @@ components: example: 509 x-tags: - created - type: object x-internal: false store_sku_inventory_order_updated: title: store/sku/inventory/order/updated @@ -2750,7 +2734,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -2790,7 +2775,6 @@ components: example: 509 x-tags: - created - type: object x-internal: false store_app_uninstalled: title: store/app/uninstalled @@ -2813,7 +2797,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -2825,7 +2810,6 @@ components: example: store x-tags: - created - type: object x-internal: false store_information_updated: title: store/information/updated @@ -2856,7 +2840,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -2868,12 +2853,10 @@ components: example: store x-tags: - created - type: object x-internal: false store_subscriber_wildcard: title: store/subscriber/* description: Fires for all `store/subscriber` events. - type: object x-internal: false store_subscriber_created: title: store/subscriber/created @@ -2897,7 +2880,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -2913,7 +2897,6 @@ components: example: 5 x-tags: - created - type: object x-internal: false store_subscriber_updated: title: store/subscriber/updated @@ -2937,7 +2920,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -2953,7 +2937,6 @@ components: example: 5 x-tags: - created - type: object x-internal: false store_subscriber_deleted: title: store/subscriber/deleted @@ -2977,7 +2960,8 @@ components: x-examples: {} allOf: - $ref: '#/components/schemas/webhook_callback_base' - - description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. + - type: object + description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. properties: data: type: object @@ -2993,7 +2977,6 @@ components: example: 5 x-tags: - created - type: object x-internal: false error_Full: type: object @@ -3027,8 +3010,7 @@ components: description: Typically a link to BigCommerce API Status codes type: string errors: - type: object - x-internal: false + x-internal: false webhook_Put: type: object title: webhook_Put @@ -3093,6 +3075,7 @@ components: allOf: - $ref: '#/components/schemas/webhook_Base' - title: webhook_Full + type: object properties: id: type: integer @@ -3125,6 +3108,8 @@ components: description: A numerical identifier that is unique to each store. data: type: object + properties: {} + additionalProperties: true description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. hash: type: string @@ -3179,35 +3164,33 @@ components: scope: store/cart/created hash: 352e4afc6dd3fc85ea26bfdf3f91852604d57528 title: '' - allOf: - - properties: - created_at: - type: integer - example: 1561488106 - description: The time the webhook was created, represented in UNIX epoch time. - readOnly: true - store_id: - type: string - minLength: 1 - example: '1025646' - description: A numerical identifier that is unique to each store. - producer: - type: string - minLength: 1 - example: 'stores/{store_hash}' - description: Will always follow the pattern `stores/store_hash`. This is the store that created the webhook. - scope: - type: string - minLength: 1 - example: store/cart/created - description: The event registered when the webhook was created. - hash: - type: string - minLength: 1 - example: 352e4afc6dd3fc85ea26bfdf3f91852604d57528 - description: The payload data encoded in JSON format and then passed through SH1 encryption. type: object - x-internal: false + properties: + created_at: + type: integer + example: 1561488106 + description: The time the webhook was created, represented in UNIX epoch time. + readOnly: true + store_id: + type: string + minLength: 1 + example: '1025646' + description: A numerical identifier that is unique to each store. + producer: + type: string + minLength: 1 + example: 'stores/{store_hash}' + description: Will always follow the pattern `stores/store_hash`. This is the store that created the webhook. + scope: + type: string + minLength: 1 + example: store/cart/created + description: The event registered when the webhook was created. + hash: + type: string + minLength: 1 + example: 352e4afc6dd3fc85ea26bfdf3f91852604d57528 + description: The payload data encoded in JSON format and then passed through SH1 encryption. callback_category_data: title: callback_category_data type: object diff --git a/reference/widgets.v3.yml b/reference/widgets.v3.yml index d19c485d4..43753da09 100644 --- a/reference/widgets.v3.yml +++ b/reference/widgets.v3.yml @@ -663,6 +663,7 @@ components: data: type: array items: + type: object properties: uuid: type: string @@ -764,6 +765,7 @@ components: data: type: array items: + type: object properties: uuid: type: string @@ -1031,14 +1033,12 @@ components: content: application/json: schema: - allOf: - - type: object - properties: - data: - $ref: '#/components/schemas/widgetTemplate_Full' - - properties: - meta: - $ref: '#/components/schemas/Meta' + type: object + properties: + data: + $ref: '#/components/schemas/widgetTemplate_Full' + meta: + $ref: '#/components/schemas/Meta' examples: response: value: @@ -1236,9 +1236,12 @@ components: in: header schemas: WidgetTemplatePreview: + type: object properties: widget_configuration: type: object + properties: {} + additionalProperties: true description: The JSON data that populates the template. format: json x-tags: @@ -1247,6 +1250,7 @@ components: type: object properties: data: + type: object properties: html: type: string @@ -1370,6 +1374,8 @@ components: description: The user-friendly description. widget_configuration: type: object + properties: {} + additionalProperties: true description: The JSON data that populates the template. format: json widget_template_uuid: @@ -1538,6 +1544,7 @@ components: type: string errors: type: object + properties: {} x-internal: false title: error_Base BaseError: @@ -1567,6 +1574,7 @@ components: x-tags: - Models themeRegion: + type: object properties: name: type: string @@ -1630,6 +1638,8 @@ components: description: The user-friendly description. widget_configuration: type: object + properties: {} + additionalProperties: true format: json description: The JSON data that populates the template. x-internal: false diff --git a/reference/wishlists.v3.yml b/reference/wishlists.v3.yml index 7e6a6e492..9f53b16c9 100644 --- a/reference/wishlists.v3.yml +++ b/reference/wishlists.v3.yml @@ -297,6 +297,7 @@ paths: application/json: schema: type: object + properties: {} '500': description: Internal server error. content: @@ -382,6 +383,7 @@ paths: application/json: schema: type: object + properties: {} '500': description: Internal server error. content: