Product Storage Management API
- Source:
Methods
(async, static) get(shop_id, id, bucketopt, nullable, fetchopt, nullable, filesopt, nullable, versionsopt, nullable, pathopt) → {Promise.<CustomProduct>}
Get Custom Product Configuration Data
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
shop_id |
number | string | |||
id |
number | string | |||
bucket |
string |
<optional> <nullable> |
App.get('bucket')=process.env.BUCKET | gce storage bucket |
fetch |
boolean |
<optional> <nullable> |
false | fetch new data |
files |
boolean |
<optional> <nullable> |
false | include files |
versions |
boolean |
<optional> <nullable> |
false | include previous versions |
path |
string |
<optional> |
`${shop_id}/${id}.json` | custom product config file path |
- Source:
Returns:
- Type
- Promise.<CustomProduct>
(static) list(idopt, nullable, ids, shopIDopt, nullable, shopNameopt, nullable, bucketopt, filesopt, nullable, versionsopt, nullable) → {ProductList}
Get list of products for the filestore
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
id |
number |
<optional> <nullable> |
shopify product id |
|
ids |
Array.<number> | shopify product ids to retrieve |
||
shopID |
number |
<optional> <nullable> |
shopify shop id |
|
shopName |
string |
<optional> <nullable> |
shopify shop name |
|
bucket |
string |
<optional> |
'custom-product-builder' | gce storage bucket |
files |
* |
<optional> <nullable> |
include storage files, deleted files, and file stats |
|
versions |
* |
<optional> <nullable> |
include file versions |
- Source:
Returns:
- Type
- ProductList