AdminProductsResource

admin/products.AdminProductsResource

Methods

addOption

addOption(id, payload, customHeaders?): ResponsePromise<AdminProductsRes>

Parameters

idstringRequired

payloadAdminPostProductsProductOptionsReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminProductsRes>

ResponsePromiseResponsePromise<AdminProductsRes>Required

---

create

create(payload, customHeaders?): ResponsePromise<AdminProductsRes>

Parameters

payloadAdminPostProductsReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminProductsRes>

ResponsePromiseResponsePromise<AdminProductsRes>Required

---

createVariant

createVariant(id, payload, customHeaders?): ResponsePromise<AdminProductsRes>

Parameters

idstringRequired

payloadAdminPostProductsProductVariantsReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminProductsRes>

ResponsePromiseResponsePromise<AdminProductsRes>Required

---

delete

delete(id, customHeaders?): ResponsePromise<AdminProductsDeleteRes>

Parameters

idstringRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminProductsDeleteRes>

ResponsePromiseResponsePromise<AdminProductsDeleteRes>Required

---

deleteOption

deleteOption(id, optionId, customHeaders?): ResponsePromise<AdminProductsDeleteOptionRes>

Parameters

idstringRequired

optionIdstringRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminProductsDeleteOptionRes>

ResponsePromiseResponsePromise<AdminProductsDeleteOptionRes>Required

---

deleteVariant

deleteVariant(id, variantId, customHeaders?): ResponsePromise<AdminProductsDeleteVariantRes>

Parameters

idstringRequired

variantIdstringRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminProductsDeleteVariantRes>

ResponsePromiseResponsePromise<AdminProductsDeleteVariantRes>Required

---

list

list(query?, customHeaders?): ResponsePromise<AdminProductsListRes>

Parameters

queryAdminGetProductsParams

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminProductsListRes>

ResponsePromiseResponsePromise<AdminProductsListRes>Required

---

listTags

listTags(customHeaders?): ResponsePromise<AdminProductsListTagsRes>

Parameters

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminProductsListTagsRes>

ResponsePromiseResponsePromise<AdminProductsListTagsRes>Required

---

listTypes

listTypes(customHeaders?): ResponsePromise<AdminProductsListTypesRes>

Parameters

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminProductsListTypesRes>

ResponsePromiseResponsePromise<AdminProductsListTypesRes>Required

Deprecated

Use AdminProductTypesResource.list instead.

---

retrieve

retrieve(id, customHeaders?): ResponsePromise<AdminProductsRes>

Parameters

idstringRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminProductsRes>

ResponsePromiseResponsePromise<AdminProductsRes>Required

---

setMetadata

setMetadata(id, payload, customHeaders?): ResponsePromise<AdminProductsRes>

Parameters

idstringRequired

payloadAdminPostProductsProductMetadataReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminProductsRes>

ResponsePromiseResponsePromise<AdminProductsRes>Required

---

update

update(id, payload, customHeaders?): ResponsePromise<AdminProductsRes>

Parameters

idstringRequired

payloadAdminPostProductsProductReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminProductsRes>

ResponsePromiseResponsePromise<AdminProductsRes>Required

---

updateOption

updateOption(id, optionId, payload, customHeaders?): ResponsePromise<AdminProductsRes>

Parameters

idstringRequired

optionIdstringRequired

payloadAdminPostProductsProductOptionsOptionRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminProductsRes>

ResponsePromiseResponsePromise<AdminProductsRes>Required

---

updateVariant

updateVariant(id, variantId, payload, customHeaders?): ResponsePromise<AdminProductsRes>

Parameters

idstringRequired

variantIdstringRequired

payloadAdminPostProductsProductVariantsVariantReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminProductsRes>

ResponsePromiseResponsePromise<AdminProductsRes>Required