Skip to content

Commit

Permalink
DEVDOCS-6024: [TEST SPEC] changes from testing this endpoint (#383)
Browse files Browse the repository at this point in the history
<!-- Ticket number or summary of work -->
# [DEVDOCS-6024]


## What changed?
Made changes based on my testing.

Outstanding issues:
1. The `is_featured` query parameter does not work as documented.
Entering "1" or "true" does not work.
2. What field does the query parameter `inventory_low` related to? Is
this the same as `inventory_warning_level`.
3. What field does the query paramter `out_of_stock` related to?
4. The values for the `keyword_context` query parameter give the same
result.
5. What are the accepted values for the `status` query parameter?
6. Missing `reviews` and `parent_relations` from the Create a product
response body.

## Release notes draft
<!-- Provide an entry for the release notes using simple, conversational
language. Don't be too technical. Explain how the change will benefit
the merchant and link to the feature.

Examples:
* The newly-released [X feature] is now available to use. Now, you’ll be
able to [perform Y action].
* We're happy to announce [X feature], which can help you [perform Y
action].
* [X feature] helps you to create [Y response] using the [Z query
parameter]. Now, you can deliver [ex, localized shopping experiences for
your customers].
* Fixed a bug in the [X endpoint]. Now the [Y field] will appear when
you click [Z option]. -->
* 

## Anything else?
<!-- Add related PRs, salient notes, additional ticket numbers, etc. -->

ping {names}


[DEVDOCS-6024]:
https://bigcommercecloud.atlassian.net/browse/DEVDOCS-6024?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
  • Loading branch information
bc-traciporter authored Aug 5, 2024
1 parent c92cb2b commit 2b97481
Showing 1 changed file with 103 additions and 17 deletions.
120 changes: 103 additions & 17 deletions reference/catalog/products_catalog.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,6 @@ paths:
- $ref: '#/components/parameters/CategoriesParam'
- $ref: '#/components/parameters/KeywordParam'
- $ref: '#/components/parameters/KeywordContextParam'
- $ref: '#/components/parameters/StatusParam'
- $ref: '#/components/parameters/AvailabilityParam'
- $ref: '#/components/parameters/SkuParam'
- $ref: '#/components/parameters/SkuInParam'
Expand Down Expand Up @@ -5318,6 +5317,9 @@ components:
description: 'This variant’s retail price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product’s retail price (set in the Product resource’s `price` field) will be used as the retail price.'
format: double
nullable: true
map_price:
type: number
description: Minimum Advertised Price.
weight:
minimum: 0
type: number
Expand Down Expand Up @@ -5364,6 +5366,11 @@ components:
minLength: 0
type: string
description: 'If `purchasing_disabled` is `true`, this message should show on the storefront when the variant is selected.'
image_url:
type: string
description: |
The URL for an image displayed on the storefront when the conditions are applied. Limit of 8MB per file.
example: 'https://cdn8.bigcommerce.com/s-123456/product_images/d/fakeimage.png'
upc:
type: string
description: The UPC code used in feeds for shopping comparison sites and external channel integrations.
Expand Down Expand Up @@ -5439,6 +5446,9 @@ components:
description: Variant ID
sku:
type: string
sku_id:
type: integer
example: 70
option_values:
type: array
description: Array of option and option values IDs that make up this variant. Will be empty if the variant is the productʼs base variant.
Expand Down Expand Up @@ -5612,24 +5622,32 @@ components:
allOf:
- type: object
properties:
option_display_name:
id:
type: integer
description: The option_value ID.
label:
maxLength: 255
minLength: 1
type: string
description: |
The name of the option.
example: Color
The label of the option value.
example: Beige
x-required:
- post
label:
option_id:
type: integer
description: The option ID.
example: 151
option_display_name:
maxLength: 255
minLength: 1
type: string
description: |
The label of the option value.
example: Beige
The name of the option.
example: Color
x-required:
- post

- post
required:
- option_display_name
- label
Expand Down Expand Up @@ -6503,6 +6521,68 @@ components:
format: date-time
description: Common ProductImage properties.
x-internal: false
primaryImage_Full:
title: primaryImage_Full
description: Common PrimaryImage properties.
allOf:
- title: productImage
type: object
properties:
id:
type: integer
description: |
The unique numeric ID of the image; increments sequentially.
product_id:
type: integer
description: |
The unique numeric identifier for the product with which the image is associated.
is_thumbnail:
type: boolean
description: |
Flag for identifying whether the image is used as the productʼs thumbnail.
sort_order:
maximum: 2147483647
minimum: -2147483648
type: integer
description: |
The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the imageʼs new `sort_order` value will have their `sort_order`s reordered.
description:
type: string
description: |
The description for the image.
image_file:
type: string
description: |
The local path to the original image file uploaded to BigCommerce. Use image_url when creating a product.
Must be sent as a `multipart/form-data` field in the request body. Limit of 8 MB per file.
url_zoom:
readOnly: true
type: string
description: |
The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled. You should provide an image smaller than 1280x1280; otherwise, the API returns a resized image.
url_standard:
readOnly: true
type: string
description: |
The standard URL for this image. By default, this is used for product-page images.
url_thumbnail:
readOnly: true
type: string
description: |
The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels.
url_tiny:
readOnly: true
type: string
description: |
The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page.
date_modified:
type: string
description: |
The date on which the product image was modified.
format: date-time
description: Common PrimaryImage properties.
x-internal: false
product_Put_Collection:
title: product_Put_Collection
description: The model for batch updating products.
Expand Down Expand Up @@ -7773,6 +7853,8 @@ components:
type: array
items:
$ref: '#/components/schemas/productImage_Full'
primary_image:
$ref: '#/components/schemas/primaryImage_Full'
videos:
type: array
description: |
Expand Down Expand Up @@ -8985,6 +9067,8 @@ components:
- modifiers
- options
- videos
- reviews
- parent_relations
IdMinParam:
name: 'id:min'
in: query
Expand Down Expand Up @@ -9061,10 +9145,11 @@ components:
DateModifiedParam:
name: date_modified
in: query
example: 2024-07-18
description: 'Filter items by `date_modified`.'
schema:
type: string
format: date-time
format: date
DateModifiedMaxParam:
name: 'date_modified:max'
in: query
Expand All @@ -9083,31 +9168,39 @@ components:
description: Filter items by date_last_imported.
schema:
type: string
format: date-time
format: date
example: 2020-07-18
DateLastImportedNotParam:
name: 'date_last_imported:not'
in: query
description: 'Filter products by specifying a date they were NOT last imported. For example, `date_last_imported:not=2015-08-21T22%3A53%3A23%2B00%3A00`.'
schema:
type: string
format: date
example: 2020-07-18
DateLastImportedMaxParam:
name: 'date_last_imported:max'
in: query
description: 'Filter items by date_last_imported. For example, `date_last_imported:max=2015-08-21T22%3A53%3A23%2B00%3A00`.'
schema:
type: string
format: date
example: 2020-07-18
DateLastImportedMinParam:
name: 'date_last_imported:min'
in: query
description: 'Filter items by date_last_imported. For example, `date_last_imported:min=2015-08-21T22%3A53%3A23%2B00%3A00`.'
schema:
type: string
format: date
example: 2020-07-18
IsVisibleParam:
name: is_visible
in: query
description: Filter items based on whether the product is currently visible on the storefront.
schema:
type: boolean
example: true
IsFeaturedParam:
name: is_featured
in: query
Expand Down Expand Up @@ -9223,13 +9316,6 @@ components:
enum:
- shopper
- merchant
StatusParam:
name: status
in: query
description: |
Filter items by status.
schema:
type: integer
AvailabilityParam:
name: availability
in: query
Expand Down

0 comments on commit 2b97481

Please sign in to comment.