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

DEVDOCS-3681 [update]: Catalog API, add image maximum limits #1411

Merged
merged 5 commits into from
Sep 19, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions reference/catalog/products_catalog.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -875,6 +875,7 @@ paths:

**Limits**
- 250 characters product name length.
- A product can have up to 1000 images. Each image file or image uploaded by URL can be up to 8 MB.

**Usage Notes**
* This endpoint accepts a `video` array. To create a product video that accepts a `video` object, see [Create a Product Video](/docs/rest-catalog/products/videos#create-a-product-video) for information.
Expand Down Expand Up @@ -1484,6 +1485,9 @@ paths:
description: |
Updates a *Product*.

**Limits**
- A product can have up to 1000 images. Each image file or image uploaded by URL can be up to 8 MB.

**Read-Only Fields**
- id
- date_created
Expand Down Expand Up @@ -1986,9 +1990,10 @@ paths:

**Usage Notes**
- `image_url` - `255` character limit
- For file uploads, use the `multipart/form-data` media type
- Only one image at a time can be created
- For file uploads, use the `multipart/form-data` media type.
- You can create only one image at a time. A product can have up to 1000 images.
- Supported image file types are BMP, GIF, JPEG, PNG, WBMP, XBM, and WEBP.
- Each image file or image uploaded by URL can be up to 8 MB.
operationId: createProductImage
parameters:
- $ref: '#/components/parameters/ContentType'
Expand Down Expand Up @@ -2060,7 +2065,7 @@ paths:
image_file:
type: string
description: |
Must be sent as a multipart/form-data field in the request body. Limit of 1MB per file.
Must be sent as a multipart/form-data field in the request body. Limit of 8 MB per file.
multipart/form-data:
schema:
title: Product Image Post
Expand Down Expand Up @@ -2131,7 +2136,7 @@ paths:
image_file:
type: string
description: |
Must be sent as a multipart/form-data field in the request body. Limit of 1MB per file.
Must be sent as a multipart/form-data field in the request body. Limit of 8 MB per file.
required: true
responses:
'200':
Expand Down Expand Up @@ -2403,6 +2408,7 @@ paths:

**Usage Notes**
- `image_url` - `255` character limit
- Each image file or image uploaded by URL can be up to 8 MB.
- For file uploads, send a POST request using the `multipart/form-data` media type
operationId: updateProductImage
parameters:
Expand Down Expand Up @@ -6849,7 +6855,7 @@ components:
image_file:
type: string
description: |
The local path to the original image file uploaded to BigCommerce. Limit of 8MB per file.
The local path to the original image file uploaded to BigCommerce. Limit of 8 MB per file.
is_thumbnail:
type: boolean
description: |
Expand Down
Loading