Skip to main content

OrderingOption

Create, update and delete Business Partner data in Hii Retail service

type OrderingOption {
  globalUniqueId: String
  id: String
  correlationId: String
  version: Int!
  displayId: String
  created: DateTime
  createdBy: String
  modified: DateTime
  modifiedBy: String
  status: Status!
  statusName: String
  name: String
  description: String
  tenantId: String
  itemId: String
  businessPartnerId: String
  manufacturerId: String
  orderingOptionType: OrderingOptionType!
  unitsInPackage: Int!
  priority: Int!
  packageGtins: [String]
  orderingOptionPrices: [String]
  availableFrom: DateTime!
  availableTo: DateTime
  additionalProperties: [AdditionalProperty]
  businessUnitId: String
  isPackageDivisible: Boolean!
}

Fields​

OrderingOption.globalUniqueId ● String scalar​

Internal unique ID for CRUD operations and relations. For pnp clan the field have following structure: TenantId_EntityId_BusinessUnitGroupId. Example of GlobalUniqueId of a Mid Level Entity: 10000_45232_200

OrderingOption.id ● String scalar​

Id for the entity. Either external or internal

OrderingOption.correlationId ● String scalar​

ID for tracing an entity and/or a group of sub entities through the application. Might be external, and if missing externally an internal ID should be added. Could very well be used in audit logging as well

OrderingOption.version ● Int! non-null scalar​

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

OrderingOption.displayId ● String scalar​

Correlation ID set in an external system. Specifically used for searching for external IDs. Must not be used for anything except search

OrderingOption.created ● DateTime scalar​

When the object was first created

OrderingOption.createdBy ● String scalar​

Who created the entity. It is an ID that can be looked up in the user DB

OrderingOption.modified ● DateTime scalar​

When the object was modified

OrderingOption.modifiedBy ● String scalar​

Who created or modified the object

OrderingOption.status ● Status! non-null enum​

The status of the entity

OrderingOption.statusName ● String scalar​

The actual name of the status

OrderingOption.name ● String scalar​

The name of the entity

OrderingOption.description ● String scalar​

The description of the entity

OrderingOption.tenantId ● String scalar​

The tenant id of the entity

OrderingOption.itemId ● String scalar​

Id for the item this ordering option is defined for.

OrderingOption.businessPartnerId ● String scalar​

Id of the business partner this ordering option is directed towards.

OrderingOption.manufacturerId ● String scalar​

Id of the manufacturer (a business partner of type Manufacturer).

OrderingOption.orderingOptionType ● OrderingOptionType! non-null enum​

The type of the ordering option.

OrderingOption.unitsInPackage ● Int! non-null scalar​

The number of sales items in this package this ordering option is for.

OrderingOption.priority ● Int! non-null scalar​

Priority number. Always choose the lowest as priority. Will be the property to decide which OO to use as primary in store. All OOs that are not available to the store will not be present on store level.

OrderingOption.packageGtins ● [String] list scalar​

Actual GTIN for the delivery package. Id of the value added to API for AdditionalItemId.

OrderingOption.orderingOptionPrices ● [String] list scalar​

Purchase prices available for this OO, including discounts.

OrderingOption.availableFrom ● DateTime! non-null scalar​

When is this Ordering option available from. It will not be possible to use before this date.

OrderingOption.availableTo ● DateTime scalar​

When will this ordering option become unavailable. It will not be possible to use after this date.

OrderingOption.additionalProperties ● [AdditionalProperty] list object​

List of customer specific values on the entity level. NOT nullable, but can be empty.

OrderingOption.businessUnitId ● String scalar​

OrderingOption.isPackageDivisible ● Boolean! non-null scalar​

Returned By​

orderingOption query

Member Of​

OrderingOptionConnection object ● OrderingOptionEdge object