GraphQL Types

type Product {
  productId: Int!
  uuid: String!
  name: String!
  status: Int!
  sku: String!
  weight: Weight!
  noShippingRequired: Boolean
  taxClass: Int
  description: JSON
  urlKey: String
  metaTitle: String
  metaDescription: String
  metaKeywords: String
  variantGroupId: ID
  visibility: Int
  groupId: ID
  url: String
  
  # Extended fields
  price: ProductPrice!
  image: Image
  gallery: [Image]
  inventory: Inventory!
  category: Category
  collections: [Collection]
  variantGroup: VariantGroup
  
  # Admin only
  editUrl: String
  updateApi: String!
  deleteApi: String!
  removeFromCategoryUrl: String
}

type ProductPrice {
  regular: Price!
  special: Price!
}

type Image {
  id: ID!
  uuid: String!
  alt: String
  url: String
  listing: String @deprecated
  single: String @deprecated
  thumb: String @deprecated
  origin: String @deprecated
}

type Inventory {
  isInStock: Boolean!
  stockAvailability: Int!
  manageStock: Int!
}

type ProductCollection {
  items: [Product]
  currentPage: Int!
  total: Int!
  currentFilters: [Filter]
}

type Category {
  categoryId: Int!
  uuid: String!
  name: String!
  status: Int!
  includeInNav: Int!
  showProducts: Int!
  description: JSON
  urlKey: String
  metaTitle: String
  metaDescription: String
  metaKeywords: String
  url: String
  hasChildren: Boolean!
  
  image: CategoryImage
  products(filters: [FilterInput]): ProductCollection
  children: [Category]
  parent: Category
  path: [Category]
  availableAttributes: [FilterAttribute]
  priceRange: PriceRange
  
  # Admin only
  editUrl: String
  updateApi: String!
  deleteApi: String!
  addProductUrl: String
}

type CategoryImage {
  alt: String!
  url: String!
}

type Collection {
  collectionId: Int!
  uuid: String!
  name: String!
  description: JSON
  code: String!
  products(filters: [FilterInput]): ProductCollection
}

type Attribute {
  attributeId: ID!
  uuid: String!
  attributeCode: String!
  attributeName: String!
  type: String!
  isRequired: Int!
  displayOnFrontend: Int!
  sortOrder: Int!
  isFilterable: Int!
  options: [AttributeOption]
}

type AttributeOption {
  attributeOptionId: ID!
  uuid: String!
  optionText: String!
}

type VariantGroup {
  variantGroupId: Int!
  variantAttributes: [VariantAttribute]!
  items: [Variant]
  addItemApi: String!
}

type Variant {
  id: String!
  product: Product!
  attributes: [VariantAttributeIndex]!
  removeUrl: String!
}

type VariantAttribute {
  attributeId: Int!
  attributeCode: String!
  attributeName: String!
  options: [VariantAttributeOption]
}

type Cart implements ShoppingCart {
  cartId: ID!
  uuid: String!
  status: Int!
  currency: String!
  customerId: Int
  customerGroupId: Int
  customerEmail: String
  customerFullName: String
  userIp: String
  userId: String
  coupon: String
  noShippingRequired: Boolean!
  
  items: [CartItem]
  shippingAddress: CartAddress
  billingAddress: CartAddress
  
  # Pricing
  subTotal: Price!
  subTotalInclTax: Price!
  subTotalWithDiscount: Price!
  subTotalWithDiscountInclTax: Price!
  shippingFeeExclTax: Price!
  shippingFeeInclTax: Price!
  shippingTaxAmount: Price!
  taxAmount: Price!
  taxAmountBeforeDiscount: Price!
  totalTaxAmount: Price!
  discountAmount: Price!
  grandTotal: Price!
  
  totalQty: Int!
  totalWeight: Weight!
  
  shippingMethod: String
  shippingMethodName: String
  paymentMethod: String
  paymentMethodName: String
  shippingNote: String
  
  # API endpoints
  addItemApi: String!
  addPaymentMethodApi: String!
  addShippingMethodApi: String!
  addContactInfoApi: String!
  addAddressApi: String!
  addNoteApi: String!
  checkoutApi: String!
  
  # Available methods
  availableShippingMethods(
    country: String
    province: String
    postcode: String
  ): [AvailableShippingMethod]
  availablePaymentMethods: [AvailablePaymentMethod]
  
  createdAt: Date!
  updatedAt: Date!
}

type CartItem implements ShoppingCartItem {
  cartItemId: ID
  uuid: String!
  cartId: ID!
  productId: ID!
  productSku: String!
  productName: String
  thumbnail: String
  qty: Int!
  noShippingRequired: Boolean!
  
  productWeight: Weight!
  productPrice: Price!
  productPriceInclTax: Price!
  finalPrice: Price!
  finalPriceInclTax: Price!
  
  taxPercent: Float!
  taxAmount: Price!
  taxAmountBeforeDiscount: Price!
  discountAmount: Price!
  
  lineTotal: Price!
  lineTotalWithDiscount: Price!
  lineTotalWithDiscountInclTax: Price!
  lineTotalInclTax: Price!
  
  subTotal: Price! @deprecated
  total: Price! @deprecated
  
  variantGroupId: Int
  variantOptions: [VariantOption]
  productCustomOptions: String
  productUrl: String
  errors: [String!]
  
  removeApi: String!
  updateQtyApi: String!
}

type CartAddress implements Address {
  cartAddressId: Int!
  uuid: String!
  fullName: String
  postcode: String
  telephone: String
  country: Country
  province: Province
  city: String
  address1: String
  address2: String
}

type AvailableShippingMethod {
  id: String!
  code: String!
  name: String!
  cost: Price!
}

type AvailablePaymentMethod {
  code: String!
  name: String!
}

type Price {
  value: Float!
  currency(currency: String): String!
  text(currency: String): String!
}

{
  "value": 29.99,
  "currency": "USD",
  "text": "$29.99"
}

type Weight {
  value: Float!
  unit: String!
  text: String!
}

{
  "value": 1.5,
  "unit": "kg",
  "text": "1.5 kg"
}

type Customer {
  customerId: Int!
  uuid: String!
  status: Int!
  email: String!
  fullName: String!
  createdAt: Date!
  
  addresses: [CustomerAddress]
  orders: [Order]
  
  addAddressApi: String!
  
  # Admin only
  editUrl: String!
  updateApi: String!
  deleteApi: String!
}

type CustomerAddress implements Address {
  cartAddressId: Int!
  uuid: String!
  fullName: String
  postcode: String
  telephone: String
  country: Country
  province: Province
  city: String
  address1: String
  address2: String
  isDefault: Boolean
  updateApi: String!
  deleteApi: String!
}

type CustomerCollection {
  items: [Customer]
  currentPage: Int!
  total: Int!
  currentFilters: [Filter]
}

type Order implements ShoppingCart {
  orderId: ID!
  uuid: String!
  orderNumber: String!
  status: Status
  paymentStatus: PaymentStatus
  shipmentStatus: ShipmentStatus
  
  # Inherits all ShoppingCart fields
  currency: String!
  items: [OrderItem]
  shippingAddress: OrderAddress
  billingAddress: OrderAddress
  
  # Pricing (same as Cart)
  subTotal: Price!
  grandTotal: Price!
  # ... all pricing fields
  
  activities: [Activity]
  shipment: Shipment
  
  createdAt: Date!
  updatedAt: Date!
  
  # Admin only
  customerUrl: String
  editUrl: String!
  createShipmentApi: String!
  cancelApi: String!
}

type OrderItem implements ShoppingCartItem {
  orderItemId: ID!
  uuid: String!
  orderId: ID!
  productId: ID!
  productSku: String!
  productName: String
  qty: Int!
  
  # All pricing fields from ShoppingCartItem
  productPrice: Price!
  finalPrice: Price!
  lineTotal: Price!
  # ... etc
  
  variantOptions: [VariantOption]
}

type OrderAddress implements Address {
  orderAddressId: Int!
  uuid: String!
  fullName: String
  postcode: String
  telephone: String
  country: Country
  province: Province
  city: String
  address1: String
  address2: String
}

type Status {
  name: String
  code: String
  badge: String
}

type PaymentStatus {
  name: String
  code: String
  badge: String
  isDefault: Boolean
  isCancelable: Boolean
}

type ShipmentStatus {
  name: String
  code: String
  badge: String
  isDefault: Boolean
  isCancelable: Boolean
}

type Shipment {
  shipmentId: Int!
  uuid: String!
  carrier: String
  trackingNumber: String
  createdAt: DateTime!
  updatedAt: DateTime
  
  # Admin only
  updateShipmentApi: String!
}

type Activity {
  orderActivityId: Int!
  comment: String
  customerNotified: Int!
  createdAt: DateTime
  updatedAt: DateTime
}

type OrderCollection {
  items: [Order]
  currentPage: Int!
  total: Int!
  currentFilters: [Filter]
}

type CmsPage {
  cmsPageId: Int
  uuid: String!
  status: Int!
  urlKey: String!
  name: String!
  content: JSON!
  metaTitle: String
  metaKeywords: String
  metaDescription: String
  url: String!
  editUrl: String!
  updateApi: String!
  deleteApi: String!
}

type CmsPageCollection {
  items: [CmsPage]
  currentPage: Int!
  total: Int!
  currentFilters: [Filter]
}

type Menu {
  items: [MenuItem]
}

type MenuItem {
  name: String!
  url: String!
  children: [MenuItem]
}

type Country {
  name: String!
  code: String!
  provinces: [Province]
}

type Province {
  name: String!
  code: String!
  countryCode: String!
}

scalar Date

scalar DateTime

scalar JSON

interface ShoppingCart {
  uuid: String!
  currency: String!
  customerId: Int
  customerGroupId: Int
  customerEmail: String
  customerFullName: String
  noShippingRequired: Boolean!
  
  shippingFeeExclTax: Price!
  shippingFeeInclTax: Price!
  shippingTaxAmount: Price!
  discountAmount: Price!
  subTotal: Price!
  subTotalInclTax: Price!
  grandTotal: Price!
  
  totalQty: Int!
  totalWeight: Weight!
  
  shippingMethod: String
  shippingMethodName: String
  shippingAddress: Address
  paymentMethod: String
  paymentMethodName: String
  billingAddress: Address
  shippingNote: String
  
  createdAt: Date!
  updatedAt: Date!
}

interface ShoppingCartItem {
  uuid: String!
  productId: ID!
  productSku: String!
  productName: String
  thumbnail: String
  noShippingRequired: Boolean!
  productWeight: Weight!
  qty: Int!
  
  productPrice: Price!
  productPriceInclTax: Price!
  finalPrice: Price!
  finalPriceInclTax: Price!
  
  taxPercent: Float!
  taxAmount: Price!
  discountAmount: Price!
  
  lineTotal: Price!
  lineTotalWithDiscount: Price!
  lineTotalInclTax: Price!
  
  variantGroupId: Int
  variantOptions: [VariantOption]
  productUrl: String
}

interface Address {
  fullName: String
  postcode: String
  telephone: String
  country: Country
  province: Province
  city: String
  address1: String
  address2: String
}

input FilterInput {
  key: String!
  operation: FilterOperation!
  value: ID
}

enum FilterOperation {
  eq      # Equal
  neq     # Not equal
  gt      # Greater than
  gteq    # Greater than or equal
  lt      # Less than
  lteq    # Less than or equal
  like    # Pattern match
  nlike   # Not like
  in      # In array
  nin     # Not in array
}

type Filter {
  key: String!
  operation: String!
  value: String!
}

type EntityCollection {
  items: [Entity]
  currentPage: Int!
  total: Int!
  currentFilters: [Filter]
}

type Entity {
  # ... fields
  updateApi: String!
  deleteApi: String!
}

type VariantOption {
  attributeCode: String!
  attributeName: String!
  attributeId: Int!
  optionId: Int!
  optionText: String!
}