Skip to main content

EntityStatusV1

No description

enum EntityStatusV1 {
  UNKNOWN
  ACTIVE
  PASSIVE @deprecated
  EXPIRED @deprecated
  DISCONTINUED @deprecated
  REPLACED @deprecated
  DELETED
}

Values​

EntityStatusV1.UNKNOWN​

UNKNOWN - means the entity status is unknown.

EntityStatusV1.ACTIVE​

ACTIVE - means the entity is active and available for normal operation. It can be used and processed and displayed as expected.

EntityStatusV1.PASSIVE deprecated​

[DEPRECATED]

This value is DEPRECATED and will be replaced with a DELETED status in v2.

PASSIVE - means the entity is not active and should be evaluated for deprecation or removal. The entity is still available but should not be preferred.

EntityStatusV1.EXPIRED deprecated​

[DEPRECATED]

This value is DEPRECATED for all entities except AssortmentPolicy and will be replaced with a DELETED status in v2.

EXPIRED - means the entity is no longer in service and should be ignored. The entity was in an active state but has exhausted it's lifespan.

EntityStatusV1.DISCONTINUED deprecated​

[DEPRECATED]

This value is DEPRECATED for all entities except Item and will be replaced with a DELETED status in v2.

DISCONTINUED - indicates that the entity has actively been deprecated and the state should be considered very close to Deleted. Often this state is used on Items when they need to sell the item in POS to clear out stock, but it should not be possible to order the Item.

EntityStatusV1.REPLACED deprecated​

[DEPRECATED]

This value is DEPRECATED and will be replaced with a DELETED status in v2.

REPLACED - means that the entity has been replaced by a newer version or different entity. Often used by entities that are never physically deleted but remain as a log of changes. This status should not be used very often.

EntityStatusV1.DELETED​

DELETED - indicates that the entity is deleted and should not be used. It may be displayed but it should never be part of active results or part of business logic unless it actually is to return it to an active state.

Member Of​

EntityMetadataV1 object