PriceSpecification

Custom type extensions for PriceSpecification object type.

type PriceSpecification {
  status: PriceSpecificationStatus!
  itemId: String
  type: PriceSpecificationType!
  value: Float!
  minPrice: Float
  maxPrice: Float
  taxRuleId: String
  validFrom: DateTime!
  validTo: DateTime
  currencyId: String
  promotionId: String
  discountIds: [String]
  isMandatory: Boolean
  isCurrent: Boolean
  excludingTax: Boolean
  validationResults: [EntityValidationResult]
  conditionIds: [String]
  globalUniqueId: String
  id: String
  correlationId: String
  tenantId: String
  name: String
  description: String
  businessUnitId: String @deprecated
  businessUnitIds: [String]
  businessUnitGroupId: String
  businessUnitHierarchyLevel: Int
  version: Int!
  revision: Long!
  created: DateTime!
  createdBy: String
  modified: DateTime!
  modifiedBy: String
  additionalProperties(
    ids: [String]
  ): [AdditionalProperty]
}

Fields

PriceSpecification.status ● PriceSpecificationStatus! non-null enum

The price specification status.

PriceSpecification.itemId ● String scalar

The reference ID to an Item to which this price belongs.

PriceSpecification.type ● PriceSpecificationType! non-null enum

The price type. There are several other PriceSpecification Types for different purposes. Depending on the PriceType the PriceSpecification can and should be used for different things. A Promotion PriceSpecification should always reference a Promotion and a Member PriceSpecification has no meaning unless some relation to a member exists.

PriceSpecification.value ● Float! non-null scalar

The floating point price including taxes.

PriceSpecification.minPrice ● Float scalar

The lowest price if the price is a range.

PriceSpecification.maxPrice ● Float scalar

The highest price if the price is a range.

PriceSpecification.taxRuleId ● String scalar

The Tax Rule Id used for this price.

PriceSpecification.validFrom ● DateTime! non-null scalar

The time and date the price is valid from.

PriceSpecification.validTo ● DateTime scalar

Optional time and date for when the price ends. If null the price will be valid forever until replaced.

PriceSpecification.currencyId ● String scalar

Currency this price is specified in.

PriceSpecification.promotionId ● String scalar

If the price is a promotion price this will hold the promotion Id.

PriceSpecification.discountIds ● [String] list scalar

A list of discounts that should be applied to the price to get the net price.

PriceSpecification.isMandatory ● Boolean scalar

The flag makes the price inheritance work from top down instead of bottom up. Meaning that a price marked as mandatory will override prices on lower business unit groups and business unit specific prices. This includes prices marked as mandatory on lower levels.

PriceSpecification.isCurrent ● Boolean scalar

The flag indicating if the price is the current one.

PriceSpecification.excludingTax ● Boolean scalar

Determines if the Price Specification should treat the Value as excluding VAT/Taxes.

PriceSpecification.validationResults ● [EntityValidationResult] list object

The list of entity validation results.

PriceSpecification.conditionIds ● [String] list scalar

Identifiers of the Entity Conditions applicable to this Price Specification. Entity Conditions are intent-based metadata records, owned by the Entity Conditions service, that instruct consuming systems (e.g. POS, UI, Electronic Shelf Labels, external devices) how an entity must be handled - covering legal, business, sales, entity and 3rd party requirements such as age verification or security tag removal.

PriceSpecification.globalUniqueId ● String scalar

Internal unique ID for CRUD operations and relations. A typical example is: TenantId_itemId_BusinessUnitGroupId

PriceSpecification.id ● String scalar

Id for the entity. Either external or internal

PriceSpecification.correlationId ● String scalar

ID for tracing an entity and/or a group of sub entities through the application. Might be external, and if missing from the producer of data the API will add an ID. Must be used in all logging and tracing.

PriceSpecification.tenantId ● String scalar

To support multi tenancy we need to be able to identify the customer that owns this information.

PriceSpecification.name ● String scalar

The name of the entity. This general property can replace the previous ArticleName, StoreName, CampaignName, etc.

PriceSpecification.description ● String scalar

The description of the entity.

PriceSpecification.businessUnitId ● String deprecated scalar

DEPRECATED

BusinessUnitId is obsolete. Use BusinessUnitIds property instead.

Used to assign the entity to tenant's specific business unit.

PriceSpecification.businessUnitIds ● [String] list scalar

The business units associated with the entity.

PriceSpecification.businessUnitGroupId ● String scalar

Used to assign the entity to a specific level in a business unit group hierarchy specific to the tenant.

PriceSpecification.businessUnitHierarchyLevel ● Int scalar

Indicates on which level in the business unit group hierarchy the entity is defined. The property is used for prioritizing which definition to use, if several exists. The higher the number the higher the priority should be considered.

PriceSpecification.version ● Int! non-null scalar

Version of the entity. Must be updated when there is a change to the entity. An ever increasing Integer.

Use revision instead of version if you need a more precise versioning mechanism.

PriceSpecification.revision ● Long! non-null scalar

Contains evergrowing number used to validate the version of an entity.

PriceSpecification.created ● DateTime! non-null scalar

When the object was first created. This timestamp will be set by the input API POST-endpoints before creating the AVRO data for processing.

PriceSpecification.createdBy ● String scalar

Who created. Will be an ID and must be looked up in the user DB. This ID will be set by the input API POST-endpoints before creating the AVRO data for processing.

PriceSpecification.modified ● DateTime! non-null scalar

When the object was modified. Will be updated along with the Version property. This timestamp will be set by the input API PUT and PATCH-endpoints before creating the AVRO data for processing.

PriceSpecification.modifiedBy ● String scalar

Who created or modified the object. Will be an ID and must be looked up in the user DB. This ID will be set by the input API PUT and PATCH-endpoints before creating the AVRO data for processing.

PriceSpecification.additionalProperties ● [AdditionalProperty] list object

The list of customer specific values on the entity level.

PriceSpecification.additionalProperties.ids ● [String] list scalar

Select only additional properties with specific IDs.

Member Of

PrintSchedule object