The ProductAttachments resource allows Product Attachments to be listed, viewed, created, and updated. Here are some example URIs:
· /ProductAttachments/E6E8163F-6911-40e9-B740-90E5A0A3A996 - returns specific Attachment;
· /ProductAttachments?page=2 - returns the second page of 10 ProductAttachments;
· /ProductAttachments - returns the first 10 ProductAttachments because page number 1 is the default;
· /ProductAttachments?page=2&limit=10 - returns the second page of 10 ProductAttachments; ie. the 11st to 20th ProductAttachments;
· /ProductAttachments?productid= E6E8163F-6911-40e9-B740-90E5A0A3A996 - the first page of 10 ProductAttachments belonging to the same Product with specified ID;
The full range of URIs and HTTP Verbs supported are:
Operation |
HTTP Action |
List of paginated ProductAttachments. Maximum page size is 10 |
GET /ProductAttachments?page={pageNumber} |
View any product attachment |
GET /ProductAttachments/{id} |
Create product attachment |
POST /ProductAttachments |
Delete product attachment |
DELETE /ProductAttachments/{id} |
These filters can be used with the GET ProductAttachments endpoint:
Filter |
Description |
limit |
Specifies the page size for pagination. Default and Maximum page size is 10 ProductAttachments. |
productid |
Only return ProductAttachments belonging to specific product |
Filters are used by adding the filter and value to the URI: /ProductAttachments?productid={id}
Available Fields for ProductAttachments:
Property |
Type |
Length |
Required |
Notes |
ID |
Guid |
Yes |
Unique attachment ID. Ignored by POST action. Required for DELETE action |
|
ProductID |
Guid |
Yes |
Product ID this attachments belongs to |
|
FileName |
String |
256 |
Yes |
|
ContentType |
String |
256 |
Yes |
|
IsDefault |
Boolean |
Yes |
Default images are used to create primary pictures in eCommerce listings and generated documents |
|
IsImage |
Boolean |
Read-only field indicating if attachment is an image |
||
Content |
String |
|
Yes |
Base-64 encoded string with content of the file |