Skip to main content

VariantPrice

A price tier on a variant.

type VariantPrice {
  cost: Float
  createdAt: DateTime!
  currency: String
  customerTierIds: [String!]!
  deletedAt: DateTime
  deletedBy: String
  discountPercent: Float!
  enteredBy: String!
  id: ID!
  isActive: Boolean!
  maxQuantity: Float
  minQuantity: Float!
  name: String!
  organizationId: String!
  price: Float!
  uomId: String
  updatedAt: DateTime!
  updatedBy: String!
  validFrom: DateTime
  validTo: DateTime
  variant: ProductVariant
  variantId: ID!
}

Fields

`VariantPrice.cost` ● `Float` scalar

The cost of one unit in the tier.

`VariantPrice.createdAt` ● `DateTime!` non-null scalar

When the record was created.

`VariantPrice.currency` ● `String` scalar

ISO currency this row is denominated in; null = org base currency. Per-currency ladders are entered as-is, never derived by conversion (Rule A).

`VariantPrice.customerTierIds` ● `[String!]!` non-null scalar

The customer tiers the price is for.

`VariantPrice.deletedAt` ● `DateTime` scalar

When the record was deleted. Empty while the record is live.

`VariantPrice.deletedBy` ● `String` scalar

The ID of the user who deleted the record.

`VariantPrice.discountPercent` ● `Float!` non-null scalar

The discount in percent.

`VariantPrice.enteredBy` ● `String!` non-null scalar

The ID of the user who created the record.

`VariantPrice.id` ● `ID!` non-null scalar

The unique ID of this record.

`VariantPrice.isActive` ● `Boolean!` non-null scalar

Whether the record is active.

`VariantPrice.maxQuantity` ● `Float` scalar

The largest quantity the tier applies to.

`VariantPrice.minQuantity` ● `Float!` non-null scalar

The smallest quantity the tier applies to.

`VariantPrice.name` ● `String!` non-null scalar

The name of the tier.

`VariantPrice.organizationId` ● `String!` non-null scalar

The ID of the organization the record belongs to.

`VariantPrice.price` ● `Float!` non-null scalar

The price in the tier.

`VariantPrice.uomId` ● `String` scalar

UOM the tier qty/price are denominated in; null = base units (legacy ladder, ×cf).

`VariantPrice.updatedAt` ● `DateTime!` non-null scalar

When the record was last changed.

`VariantPrice.updatedBy` ● `String!` non-null scalar

The ID of the user who last changed the record.

`VariantPrice.validFrom` ● `DateTime` scalar

When the tier starts to apply.

`VariantPrice.validTo` ● `DateTime` scalar

When the tier stops applying.

`VariantPrice.variant` ● `ProductVariant` object

The variant the tier is on.

`VariantPrice.variantId` ● `ID!` non-null scalar

The ID of the product variant.

Member Of

ProductVariant object

Fields
Member Of