API version 2021-01 Release candidate
API version 2020-10 Latest
API version 2020-07
API version 2020-04
API version 2020-01
API version 2019-10 Unsupported
API version 2019-07 Unsupported

ProductStatus enum

Version 2021-01 (Release candidate)

The possible product statuses.

Values

ACTIVE

The product is ready to sell and is available to customers on the online store, sales channels, and apps. By default, existing products are set to active.

ARCHIVED

The product is no longer being sold and isn't available to customers on sales channels and apps.

DRAFT

The product isn't ready to sell and is unavailable to customers on sales channels and apps. By default, duplicated and unarchived products are set to draft.

Types that return ProductStatus

Version 2020-10 (Latest)

The possible product statuses.

Values

ACTIVE

The product is ready to sell and is available to customers on the online store, sales channels, and apps. By default, existing products are set to active.

ARCHIVED

The product is no longer being sold and isn't available to customers on sales channels and apps.

DRAFT

The product isn't ready to sell and is unavailable to customers on sales channels and apps. By default, duplicated and unarchived products are set to draft.

Types that return ProductStatus