Skip to main content

PartnerProduct

A product a partner supplies or buys, with its terms and history.

type PartnerProduct {
  createdAt: DateTime!
  currency: String!
  deletedAt: DateTime
  deletedBy: String
  enteredBy: String!
  id: ID!
  isActive: Boolean!
  isPreferred: Boolean!
  lastPurchaseDate: DateTime
  lastPurchasePrice: Float
  lastSaleDate: DateTime
  lastSalePrice: Float
  leadTimeDays: Int!
  maxOrderQuantity: Float
  metadata: JSON!
  minOrderQuantity: Float!
  notes: String
  orderMultiple: Float!
  organizationId: String!
  partnerBrand: String
  partnerId: String!
  partnerName: String
  partnerSku: String!
  priceValidFrom: DateTime
  priceValidTo: DateTime
  productId: String!
  unitPrice: Float!
  updatedAt: DateTime!
  updatedBy: String!
  variantId: String
}

Fields

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

When the record was created.

`PartnerProduct.currency` ● `String!` non-null scalar

ISO 4217 currency code.

`PartnerProduct.deletedAt` ● `DateTime` scalar

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

`PartnerProduct.deletedBy` ● `String` scalar

The ID of the user who deleted the record.

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

The ID of the user who created the record.

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

The unique ID of this record.

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

Whether the record is active.

`PartnerProduct.isPreferred` ● `Boolean!` non-null scalar

True when this is a preferred product for the partner.

`PartnerProduct.lastPurchaseDate` ● `DateTime` scalar

The date of the last purchase.

`PartnerProduct.lastPurchasePrice` ● `Float` scalar

The price on the last purchase.

`PartnerProduct.lastSaleDate` ● `DateTime` scalar

The date of the last sale.

`PartnerProduct.lastSalePrice` ● `Float` scalar

The price on the last sale.

`PartnerProduct.leadTimeDays` ● `Int!` non-null scalar

The expected days from order to delivery.

`PartnerProduct.maxOrderQuantity` ● `Float` scalar

The largest quantity per order.

`PartnerProduct.metadata` ● `JSON!` non-null scalar

Additional data attached to the record, as JSON.

`PartnerProduct.minOrderQuantity` ● `Float!` non-null scalar

The smallest quantity per order.

`PartnerProduct.notes` ● `String` scalar

Notes about the product.

`PartnerProduct.orderMultiple` ● `Float!` non-null scalar

Orders must be a multiple of this quantity.

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

The ID of the organization the record belongs to.

`PartnerProduct.partnerBrand` ● `String` scalar

The brand the partner sells it under.

`PartnerProduct.partnerId` ● `String!` non-null scalar

The ID of the partner.

`PartnerProduct.partnerName` ● `String` scalar

The partner's own name for the product.

`PartnerProduct.partnerSku` ● `String!` non-null scalar

The partner's own code for the product.

`PartnerProduct.priceValidFrom` ● `DateTime` scalar

When the price starts to apply.

`PartnerProduct.priceValidTo` ● `DateTime` scalar

When the price stops applying.

`PartnerProduct.productId` ● `String!` non-null scalar

The ID of the product.

`PartnerProduct.unitPrice` ● `Float!` non-null scalar

The agreed price of one unit.

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

When the record was last changed.

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

The ID of the user who last changed the record.

`PartnerProduct.variantId` ● `String` scalar

The ID of the product variant.

Member Of

Partner object

Fields
Member Of