Icarus API Documentation

Welcome to the Icarus API Reference. This reference includes the complete set of GraphQL types, queries, mutations, and their parametes. Learn how to authenticate to the api in the Getting Started.

Terms of Service

https://www.icarus.com/terms

API Endpoints
# Development:
http://51.21.145.183:5001/graphql

Queries

authors

Response

Returns [Authors]

Arguments
Name Description
input - AuthorsListOptions Default = {take: 15}

Example

Query
query Authors($input: AuthorsListOptions) {
  authors(input: $input) {
    id
    name
    email
    blog_posts {
      id
      title
      author_id
      content
      publish_date
      authors {
        id
        name
        email
        blog_posts {
          ...Blog_postsFragment
        }
      }
    }
  }
}
Variables
{"input": {"take": 15}}
Response
{
  "data": {
    "authors": [
      {
        "id": "4",
        "name": "abc123",
        "email": "abc123",
        "blog_posts": [Blog_posts]
      }
    ]
  }
}

authorsCount

Response

Returns an AuthorsCountResult

Arguments
Name Description
input - AuthorsCount

Example

Query
query AuthorsCount($input: AuthorsCount) {
  authorsCount(input: $input) {
    action
    count
  }
}
Variables
{"input": AuthorsCount}
Response
{
  "data": {
    "authorsCount": {
      "action": "abc123",
      "count": 987
    }
  }
}

blog_posts

Response

Returns [Blog_posts]

Arguments
Name Description
input - Blog_postsListOptions Default = {take: 15}

Example

Query
query Blog_posts($input: Blog_postsListOptions) {
  blog_posts(input: $input) {
    id
    title
    author_id
    content
    publish_date
    authors {
      id
      name
      email
      blog_posts {
        id
        title
        author_id
        content
        publish_date
        authors {
          ...AuthorsFragment
        }
      }
    }
  }
}
Variables
{"input": {"take": 15}}
Response
{
  "data": {
    "blog_posts": [
      {
        "id": "4",
        "title": "xyz789",
        "author_id": "4",
        "content": {},
        "publish_date": GraphQLDate,
        "authors": Authors
      }
    ]
  }
}

blog_postsCount

Response

Returns a Blog_postsCountResult

Arguments
Name Description
input - Blog_postsCount

Example

Query
query Blog_postsCount($input: Blog_postsCount) {
  blog_postsCount(input: $input) {
    action
    count
  }
}
Variables
{"input": Blog_postsCount}
Response
{
  "data": {
    "blog_postsCount": {
      "action": "abc123",
      "count": 987
    }
  }
}

brands

Response

Returns [Brands]

Arguments
Name Description
input - BrandsListOptions Default = {take: 15}

Example

Query
query Brands($input: BrandsListOptions) {
  brands(input: $input) {
    id
    name
    country
    founded_year
    products
  }
}
Variables
{"input": {"take": 15}}
Response
{
  "data": {
    "brands": [
      {
        "id": 4,
        "name": "abc123",
        "country": "xyz789",
        "founded_year": "xyz789",
        "products": {}
      }
    ]
  }
}

brandsCount

Response

Returns a BrandsCountResult

Arguments
Name Description
input - BrandsCount

Example

Query
query BrandsCount($input: BrandsCount) {
  brandsCount(input: $input) {
    action
    count
  }
}
Variables
{"input": BrandsCount}
Response
{
  "data": {
    "brandsCount": {
      "action": "xyz789",
      "count": 987
    }
  }
}

categories

Response

Returns [Categories]

Arguments
Name Description
input - CategoriesListOptions Default = {take: 15}

Example

Query
query Categories($input: CategoriesListOptions) {
  categories(input: $input) {
    category_id
    category_name
    icon_class
    icon_label
  }
}
Variables
{"input": {"take": 15}}
Response
{
  "data": {
    "categories": [
      {
        "category_id": 123,
        "category_name": "xyz789",
        "icon_class": "xyz789",
        "icon_label": "xyz789"
      }
    ]
  }
}

categoriesCount

Response

Returns a CategoriesCountResult

Arguments
Name Description
input - CategoriesCount

Example

Query
query CategoriesCount($input: CategoriesCount) {
  categoriesCount(input: $input) {
    action
    count
  }
}
Variables
{"input": CategoriesCount}
Response
{
  "data": {
    "categoriesCount": {
      "action": "abc123",
      "count": 123
    }
  }
}

coupons

Response

Returns [Coupons]

Arguments
Name Description
input - CouponsListOptions Default = {take: 15}

Example

Query
query Coupons($input: CouponsListOptions) {
  coupons(input: $input) {
    id
    code
    discount_percent
    expiration_date
    promotion_id
    promotions {
      id
      name
      description
      start_date
      end_date
      coupons {
        id
        code
        discount_percent
        expiration_date
        promotion_id
        promotions {
          ...PromotionsFragment
        }
      }
    }
  }
}
Variables
{"input": {"take": 15}}
Response
{
  "data": {
    "coupons": [
      {
        "id": 4,
        "code": "abc123",
        "discount_percent": 123,
        "expiration_date": "abc123",
        "promotion_id": 4,
        "promotions": Promotions
      }
    ]
  }
}

couponsCount

Response

Returns a CouponsCountResult

Arguments
Name Description
input - CouponsCount

Example

Query
query CouponsCount($input: CouponsCount) {
  couponsCount(input: $input) {
    action
    count
  }
}
Variables
{"input": CouponsCount}
Response
{
  "data": {
    "couponsCount": {
      "action": "abc123",
      "count": 123
    }
  }
}

customers

Response

Returns [Customers]

Arguments
Name Description
input - CustomersListOptions Default = {take: 15}

Example

Query
query Customers($input: CustomersListOptions) {
  customers(input: $input) {
    customer_id
    customer_name
    email
    icon_class
    icon_label
    orders {
      order_id
      order_date
      customer_id
      icon_class
      icon_label
      customers {
        customer_id
        customer_name
        email
        icon_class
        icon_label
        orders {
          ...OrdersFragment
        }
      }
      order_items {
        order_item_id
        order_id
        product_id
        quantity
        price
        currency_type
        icon_class
        icon_label
        orders {
          ...OrdersFragment
        }
        products {
          ...ProductsFragment
        }
      }
      shipments {
        shipment_id
        order_id
        shipment_date
        tracking_int
        icon_class
        icon_label
        orders {
          ...OrdersFragment
        }
      }
      payment {
        id
        payment_method
        payment_date
        amount
        payment_status
        order_id
        orders {
          ...OrdersFragment
        }
      }
    }
  }
}
Variables
{"input": {"take": 15}}
Response
{
  "data": {
    "customers": [
      {
        "customer_id": 987,
        "customer_name": "abc123",
        "email": "xyz789",
        "icon_class": "xyz789",
        "icon_label": "xyz789",
        "orders": [Orders]
      }
    ]
  }
}

customersCount

Response

Returns a CustomersCountResult

Arguments
Name Description
input - CustomersCount

Example

Query
query CustomersCount($input: CustomersCount) {
  customersCount(input: $input) {
    action
    count
  }
}
Variables
{"input": CustomersCount}
Response
{
  "data": {
    "customersCount": {
      "action": "abc123",
      "count": 987
    }
  }
}

order_items

Response

Returns [Order_items]

Arguments
Name Description
input - Order_itemsListOptions Default = {take: 15}

Example

Query
query Order_items($input: Order_itemsListOptions) {
  order_items(input: $input) {
    order_item_id
    order_id
    product_id
    quantity
    price
    currency_type
    icon_class
    icon_label
    orders {
      order_id
      order_date
      customer_id
      icon_class
      icon_label
      customers {
        customer_id
        customer_name
        email
        icon_class
        icon_label
        orders {
          ...OrdersFragment
        }
      }
      order_items {
        order_item_id
        order_id
        product_id
        quantity
        price
        currency_type
        icon_class
        icon_label
        orders {
          ...OrdersFragment
        }
        products {
          ...ProductsFragment
        }
      }
      shipments {
        shipment_id
        order_id
        shipment_date
        tracking_int
        icon_class
        icon_label
        orders {
          ...OrdersFragment
        }
      }
      payment {
        id
        payment_method
        payment_date
        amount
        payment_status
        order_id
        orders {
          ...OrdersFragment
        }
      }
    }
    products {
      product_id
      product_name
      price
      currency_type
      description
      icon_class
      icon_label
      order_items {
        order_item_id
        order_id
        product_id
        quantity
        price
        currency_type
        icon_class
        icon_label
        orders {
          ...OrdersFragment
        }
        products {
          ...ProductsFragment
        }
      }
    }
  }
}
Variables
{"input": {"take": 15}}
Response
{
  "data": {
    "order_items": [
      {
        "order_item_id": 123,
        "order_id": 987,
        "product_id": 123,
        "quantity": 123,
        "price": 987.65,
        "currency_type": "abc123",
        "icon_class": "xyz789",
        "icon_label": "xyz789",
        "orders": Orders,
        "products": Products
      }
    ]
  }
}

order_itemsCount

Response

Returns an Order_itemsCountResult

Arguments
Name Description
input - Order_itemsCount

Example

Query
query Order_itemsCount($input: Order_itemsCount) {
  order_itemsCount(input: $input) {
    action
    count
  }
}
Variables
{"input": Order_itemsCount}
Response
{
  "data": {
    "order_itemsCount": {
      "action": "xyz789",
      "count": 987
    }
  }
}

orders

Response

Returns [Orders]

Arguments
Name Description
input - OrdersListOptions Default = {take: 15}

Example

Query
query Orders($input: OrdersListOptions) {
  orders(input: $input) {
    order_id
    order_date
    customer_id
    icon_class
    icon_label
    customers {
      customer_id
      customer_name
      email
      icon_class
      icon_label
      orders {
        order_id
        order_date
        customer_id
        icon_class
        icon_label
        customers {
          ...CustomersFragment
        }
        order_items {
          ...Order_itemsFragment
        }
        shipments {
          ...ShipmentsFragment
        }
        payment {
          ...PaymentFragment
        }
      }
    }
    order_items {
      order_item_id
      order_id
      product_id
      quantity
      price
      currency_type
      icon_class
      icon_label
      orders {
        order_id
        order_date
        customer_id
        icon_class
        icon_label
        customers {
          ...CustomersFragment
        }
        order_items {
          ...Order_itemsFragment
        }
        shipments {
          ...ShipmentsFragment
        }
        payment {
          ...PaymentFragment
        }
      }
      products {
        product_id
        product_name
        price
        currency_type
        description
        icon_class
        icon_label
        order_items {
          ...Order_itemsFragment
        }
      }
    }
    shipments {
      shipment_id
      order_id
      shipment_date
      tracking_int
      icon_class
      icon_label
      orders {
        order_id
        order_date
        customer_id
        icon_class
        icon_label
        customers {
          ...CustomersFragment
        }
        order_items {
          ...Order_itemsFragment
        }
        shipments {
          ...ShipmentsFragment
        }
        payment {
          ...PaymentFragment
        }
      }
    }
    payment {
      id
      payment_method
      payment_date
      amount
      payment_status
      order_id
      orders {
        order_id
        order_date
        customer_id
        icon_class
        icon_label
        customers {
          ...CustomersFragment
        }
        order_items {
          ...Order_itemsFragment
        }
        shipments {
          ...ShipmentsFragment
        }
        payment {
          ...PaymentFragment
        }
      }
    }
  }
}
Variables
{"input": {"take": 15}}
Response
{
  "data": {
    "orders": [
      {
        "order_id": 123,
        "order_date": "abc123",
        "customer_id": 123,
        "icon_class": "abc123",
        "icon_label": "abc123",
        "customers": Customers,
        "order_items": [Order_items],
        "shipments": Shipments,
        "payment": Payment
      }
    ]
  }
}

ordersCount

Response

Returns an OrdersCountResult

Arguments
Name Description
input - OrdersCount

Example

Query
query OrdersCount($input: OrdersCount) {
  ordersCount(input: $input) {
    action
    count
  }
}
Variables
{"input": OrdersCount}
Response
{
  "data": {
    "ordersCount": {
      "action": "xyz789",
      "count": 987
    }
  }
}

payment

Response

Returns [Payment]

Arguments
Name Description
input - PaymentListOptions Default = {take: 15}

Example

Query
query Payment($input: PaymentListOptions) {
  payment(input: $input) {
    id
    payment_method
    payment_date
    amount
    payment_status
    order_id
    orders {
      order_id
      order_date
      customer_id
      icon_class
      icon_label
      customers {
        customer_id
        customer_name
        email
        icon_class
        icon_label
        orders {
          ...OrdersFragment
        }
      }
      order_items {
        order_item_id
        order_id
        product_id
        quantity
        price
        currency_type
        icon_class
        icon_label
        orders {
          ...OrdersFragment
        }
        products {
          ...ProductsFragment
        }
      }
      shipments {
        shipment_id
        order_id
        shipment_date
        tracking_int
        icon_class
        icon_label
        orders {
          ...OrdersFragment
        }
      }
      payment {
        id
        payment_method
        payment_date
        amount
        payment_status
        order_id
        orders {
          ...OrdersFragment
        }
      }
    }
  }
}
Variables
{"input": {"take": 15}}
Response
{
  "data": {
    "payment": [
      {
        "id": "xyz789",
        "payment_method": "xyz789",
        "payment_date": "xyz789",
        "amount": 123.45,
        "payment_status": "xyz789",
        "order_id": 123,
        "orders": Orders
      }
    ]
  }
}

paymentCount

Response

Returns a PaymentCountResult

Arguments
Name Description
input - PaymentCount

Example

Query
query PaymentCount($input: PaymentCount) {
  paymentCount(input: $input) {
    action
    count
  }
}
Variables
{"input": PaymentCount}
Response
{
  "data": {
    "paymentCount": {
      "action": "abc123",
      "count": 123
    }
  }
}

product_reviews

Response

Returns [Product_reviews]

Arguments
Name Description
input - Product_reviewsListOptions Default = {take: 15}

Example

Query
query Product_reviews($input: Product_reviewsListOptions) {
  product_reviews(input: $input) {
    review_id
    product_id
    customer_id
    rating
    review_text
    review_date
    icon_class
    icon_label
    products {
      product_id
      product_name
      price
      currency_type
      description
      icon_class
      icon_label
      order_items {
        order_item_id
        order_id
        product_id
        quantity
        price
        currency_type
        icon_class
        icon_label
        orders {
          ...OrdersFragment
        }
        products {
          ...ProductsFragment
        }
      }
    }
    customers {
      customer_id
      customer_name
      email
      icon_class
      icon_label
      orders {
        order_id
        order_date
        customer_id
        icon_class
        icon_label
        customers {
          ...CustomersFragment
        }
        order_items {
          ...Order_itemsFragment
        }
        shipments {
          ...ShipmentsFragment
        }
        payment {
          ...PaymentFragment
        }
      }
    }
  }
}
Variables
{"input": {"take": 15}}
Response
{
  "data": {
    "product_reviews": [
      {
        "review_id": 123,
        "product_id": 123,
        "customer_id": 123,
        "rating": 987,
        "review_text": "xyz789",
        "review_date": "abc123",
        "icon_class": "abc123",
        "icon_label": "xyz789",
        "products": Products,
        "customers": Customers
      }
    ]
  }
}

product_reviewsCount

Response

Returns a Product_reviewsCountResult

Arguments
Name Description
input - Product_reviewsCount

Example

Query
query Product_reviewsCount($input: Product_reviewsCount) {
  product_reviewsCount(input: $input) {
    action
    count
  }
}
Variables
{"input": Product_reviewsCount}
Response
{
  "data": {
    "product_reviewsCount": {
      "action": "xyz789",
      "count": 987
    }
  }
}

products

Response

Returns [Products]

Arguments
Name Description
input - ProductsListOptions Default = {take: 15}

Example

Query
query Products($input: ProductsListOptions) {
  products(input: $input) {
    product_id
    product_name
    price
    currency_type
    description
    icon_class
    icon_label
    order_items {
      order_item_id
      order_id
      product_id
      quantity
      price
      currency_type
      icon_class
      icon_label
      orders {
        order_id
        order_date
        customer_id
        icon_class
        icon_label
        customers {
          ...CustomersFragment
        }
        order_items {
          ...Order_itemsFragment
        }
        shipments {
          ...ShipmentsFragment
        }
        payment {
          ...PaymentFragment
        }
      }
      products {
        product_id
        product_name
        price
        currency_type
        description
        icon_class
        icon_label
        order_items {
          ...Order_itemsFragment
        }
      }
    }
  }
}
Variables
{"input": {"take": 15}}
Response
{
  "data": {
    "products": [
      {
        "product_id": 987,
        "product_name": "xyz789",
        "price": 987.65,
        "currency_type": "xyz789",
        "description": "xyz789",
        "icon_class": "abc123",
        "icon_label": "xyz789",
        "order_items": [Order_items]
      }
    ]
  }
}

productsCount

Response

Returns a ProductsCountResult

Arguments
Name Description
input - ProductsCount

Example

Query
query ProductsCount($input: ProductsCount) {
  productsCount(input: $input) {
    action
    count
  }
}
Variables
{"input": ProductsCount}
Response
{
  "data": {
    "productsCount": {
      "action": "xyz789",
      "count": 123
    }
  }
}

promotions

Response

Returns [Promotions]

Arguments
Name Description
input - PromotionsListOptions Default = {take: 15}

Example

Query
query Promotions($input: PromotionsListOptions) {
  promotions(input: $input) {
    id
    name
    description
    start_date
    end_date
    coupons {
      id
      code
      discount_percent
      expiration_date
      promotion_id
      promotions {
        id
        name
        description
        start_date
        end_date
        coupons {
          ...CouponsFragment
        }
      }
    }
  }
}
Variables
{"input": {"take": 15}}
Response
{
  "data": {
    "promotions": [
      {
        "id": 4,
        "name": "xyz789",
        "description": "xyz789",
        "start_date": "xyz789",
        "end_date": "xyz789",
        "coupons": Coupons
      }
    ]
  }
}

promotionsCount

Response

Returns a PromotionsCountResult

Arguments
Name Description
input - PromotionsCount

Example

Query
query PromotionsCount($input: PromotionsCount) {
  promotionsCount(input: $input) {
    action
    count
  }
}
Variables
{"input": PromotionsCount}
Response
{
  "data": {
    "promotionsCount": {
      "action": "xyz789",
      "count": 123
    }
  }
}

shipments

Response

Returns [Shipments]

Arguments
Name Description
input - ShipmentsListOptions Default = {take: 15}

Example

Query
query Shipments($input: ShipmentsListOptions) {
  shipments(input: $input) {
    shipment_id
    order_id
    shipment_date
    tracking_int
    icon_class
    icon_label
    orders {
      order_id
      order_date
      customer_id
      icon_class
      icon_label
      customers {
        customer_id
        customer_name
        email
        icon_class
        icon_label
        orders {
          ...OrdersFragment
        }
      }
      order_items {
        order_item_id
        order_id
        product_id
        quantity
        price
        currency_type
        icon_class
        icon_label
        orders {
          ...OrdersFragment
        }
        products {
          ...ProductsFragment
        }
      }
      shipments {
        shipment_id
        order_id
        shipment_date
        tracking_int
        icon_class
        icon_label
        orders {
          ...OrdersFragment
        }
      }
      payment {
        id
        payment_method
        payment_date
        amount
        payment_status
        order_id
        orders {
          ...OrdersFragment
        }
      }
    }
  }
}
Variables
{"input": {"take": 15}}
Response
{
  "data": {
    "shipments": [
      {
        "shipment_id": 987,
        "order_id": 123,
        "shipment_date": "xyz789",
        "tracking_int": "abc123",
        "icon_class": "abc123",
        "icon_label": "abc123",
        "orders": Orders
      }
    ]
  }
}

shipmentsCount

Response

Returns a ShipmentsCountResult

Arguments
Name Description
input - ShipmentsCount

Example

Query
query ShipmentsCount($input: ShipmentsCount) {
  shipmentsCount(input: $input) {
    action
    count
  }
}
Variables
{"input": ShipmentsCount}
Response
{
  "data": {
    "shipmentsCount": {
      "action": "xyz789",
      "count": 123
    }
  }
}

tables

Response

Returns [TableInfo]

Example

Query
query Tables {
  tables {
    table
    structure
  }
}
Response
{
  "data": {
    "tables": [
      {
        "table": "xyz789",
        "structure": "xyz789"
      }
    ]
  }
}

user_role

Response

Returns [User_role]

Arguments
Name Description
input - User_roleListOptions Default = {take: 15}

Example

Query
query User_role($input: User_roleListOptions) {
  user_role(input: $input) {
    id
    role_name
    users {
      id
      email
      role_id
      customer_id
      created_t
      user_role {
        id
        role_name
        users {
          ...UsersFragment
        }
      }
    }
  }
}
Variables
{"input": {"take": 15}}
Response
{
  "data": {
    "user_role": [
      {
        "id": "4",
        "role_name": "abc123",
        "users": [Users]
      }
    ]
  }
}

user_roleCount

Response

Returns a User_roleCountResult

Arguments
Name Description
input - User_roleCount

Example

Query
query User_roleCount($input: User_roleCount) {
  user_roleCount(input: $input) {
    action
    count
  }
}
Variables
{"input": User_roleCount}
Response
{
  "data": {
    "user_roleCount": {
      "action": "abc123",
      "count": 123
    }
  }
}

users

Response

Returns [Users]

Arguments
Name Description
input - UsersListOptions Default = {take: 15}

Example

Query
query Users($input: UsersListOptions) {
  users(input: $input) {
    id
    email
    role_id
    customer_id
    created_t
    user_role {
      id
      role_name
      users {
        id
        email
        role_id
        customer_id
        created_t
        user_role {
          ...User_roleFragment
        }
      }
    }
  }
}
Variables
{"input": {"take": 15}}
Response
{
  "data": {
    "users": [
      {
        "id": 4,
        "email": "abc123",
        "role_id": "xyz789",
        "customer_id": 123,
        "created_t": "abc123",
        "user_role": User_role
      }
    ]
  }
}

usersCount

Response

Returns a UsersCountResult

Arguments
Name Description
input - UsersCount

Example

Query
query UsersCount($input: UsersCount) {
  usersCount(input: $input) {
    action
    count
  }
}
Variables
{"input": UsersCount}
Response
{
  "data": {
    "usersCount": {
      "action": "xyz789",
      "count": 123
    }
  }
}

Mutations

authorize

Response

Returns an AuthPayload!

Arguments
Name Description
input - AuthorizeUser!

Example

Query
mutation Authorize($input: AuthorizeUser!) {
  authorize(input: $input) {
    token {
      accessToken
      idToken
      refreshToken
    }
  }
}
Variables
{"input": AuthorizeUser}
Response
{"data": {"authorize": {"token": Token}}}

authors

Response

Returns an AuthorsOutput

Arguments
Name Description
input - AuthorsMutationOptions

Example

Query
mutation Authors($input: AuthorsMutationOptions) {
  authors(input: $input) {
    created {
      id
      name
      email
      blog_posts {
        id
        title
        author_id
        content
        publish_date
        authors {
          ...AuthorsFragment
        }
      }
    }
    updated {
      id
      name
      email
      blog_posts {
        id
        title
        author_id
        content
        publish_date
        authors {
          ...AuthorsFragment
        }
      }
    }
    deleted
  }
}
Variables
{"input": AuthorsMutationOptions}
Response
{
  "data": {
    "authors": {
      "created": [Authors],
      "updated": [Authors],
      "deleted": 987
    }
  }
}

blog_posts

Response

Returns a Blog_postsOutput

Arguments
Name Description
input - Blog_postsMutationOptions

Example

Query
mutation Blog_posts($input: Blog_postsMutationOptions) {
  blog_posts(input: $input) {
    created {
      id
      title
      author_id
      content
      publish_date
      authors {
        id
        name
        email
        blog_posts {
          ...Blog_postsFragment
        }
      }
    }
    updated {
      id
      title
      author_id
      content
      publish_date
      authors {
        id
        name
        email
        blog_posts {
          ...Blog_postsFragment
        }
      }
    }
    deleted
  }
}
Variables
{"input": Blog_postsMutationOptions}
Response
{
  "data": {
    "blog_posts": {
      "created": [Blog_posts],
      "updated": [Blog_posts],
      "deleted": 987
    }
  }
}

brands

Response

Returns a BrandsOutput

Arguments
Name Description
input - BrandsMutationOptions

Example

Query
mutation Brands($input: BrandsMutationOptions) {
  brands(input: $input) {
    created {
      id
      name
      country
      founded_year
      products
    }
    updated {
      id
      name
      country
      founded_year
      products
    }
    deleted
  }
}
Variables
{"input": BrandsMutationOptions}
Response
{
  "data": {
    "brands": {
      "created": [Brands],
      "updated": [Brands],
      "deleted": 987
    }
  }
}

categories

Response

Returns a CategoriesOutput

Arguments
Name Description
input - CategoriesMutationOptions

Example

Query
mutation Categories($input: CategoriesMutationOptions) {
  categories(input: $input) {
    created {
      category_id
      category_name
      icon_class
      icon_label
    }
    updated {
      category_id
      category_name
      icon_class
      icon_label
    }
    deleted
  }
}
Variables
{"input": CategoriesMutationOptions}
Response
{
  "data": {
    "categories": {
      "created": [Categories],
      "updated": [Categories],
      "deleted": 987
    }
  }
}

coupons

Response

Returns a CouponsOutput

Arguments
Name Description
input - CouponsMutationOptions

Example

Query
mutation Coupons($input: CouponsMutationOptions) {
  coupons(input: $input) {
    created {
      id
      code
      discount_percent
      expiration_date
      promotion_id
      promotions {
        id
        name
        description
        start_date
        end_date
        coupons {
          ...CouponsFragment
        }
      }
    }
    updated {
      id
      code
      discount_percent
      expiration_date
      promotion_id
      promotions {
        id
        name
        description
        start_date
        end_date
        coupons {
          ...CouponsFragment
        }
      }
    }
    deleted
  }
}
Variables
{"input": CouponsMutationOptions}
Response
{
  "data": {
    "coupons": {
      "created": [Coupons],
      "updated": [Coupons],
      "deleted": 987
    }
  }
}

customers

Response

Returns a CustomersOutput

Arguments
Name Description
input - CustomersMutationOptions

Example

Query
mutation Customers($input: CustomersMutationOptions) {
  customers(input: $input) {
    created {
      customer_id
      customer_name
      email
      icon_class
      icon_label
      orders {
        order_id
        order_date
        customer_id
        icon_class
        icon_label
        customers {
          ...CustomersFragment
        }
        order_items {
          ...Order_itemsFragment
        }
        shipments {
          ...ShipmentsFragment
        }
        payment {
          ...PaymentFragment
        }
      }
    }
    updated {
      customer_id
      customer_name
      email
      icon_class
      icon_label
      orders {
        order_id
        order_date
        customer_id
        icon_class
        icon_label
        customers {
          ...CustomersFragment
        }
        order_items {
          ...Order_itemsFragment
        }
        shipments {
          ...ShipmentsFragment
        }
        payment {
          ...PaymentFragment
        }
      }
    }
    deleted
  }
}
Variables
{"input": CustomersMutationOptions}
Response
{
  "data": {
    "customers": {
      "created": [Customers],
      "updated": [Customers],
      "deleted": 123
    }
  }
}

order_items

Response

Returns an Order_itemsOutput

Arguments
Name Description
input - Order_itemsMutationOptions

Example

Query
mutation Order_items($input: Order_itemsMutationOptions) {
  order_items(input: $input) {
    created {
      order_item_id
      order_id
      product_id
      quantity
      price
      currency_type
      icon_class
      icon_label
      orders {
        order_id
        order_date
        customer_id
        icon_class
        icon_label
        customers {
          ...CustomersFragment
        }
        order_items {
          ...Order_itemsFragment
        }
        shipments {
          ...ShipmentsFragment
        }
        payment {
          ...PaymentFragment
        }
      }
      products {
        product_id
        product_name
        price
        currency_type
        description
        icon_class
        icon_label
        order_items {
          ...Order_itemsFragment
        }
      }
    }
    updated {
      order_item_id
      order_id
      product_id
      quantity
      price
      currency_type
      icon_class
      icon_label
      orders {
        order_id
        order_date
        customer_id
        icon_class
        icon_label
        customers {
          ...CustomersFragment
        }
        order_items {
          ...Order_itemsFragment
        }
        shipments {
          ...ShipmentsFragment
        }
        payment {
          ...PaymentFragment
        }
      }
      products {
        product_id
        product_name
        price
        currency_type
        description
        icon_class
        icon_label
        order_items {
          ...Order_itemsFragment
        }
      }
    }
    deleted
  }
}
Variables
{"input": Order_itemsMutationOptions}
Response
{
  "data": {
    "order_items": {
      "created": [Order_items],
      "updated": [Order_items],
      "deleted": 123
    }
  }
}

orders

Response

Returns an OrdersOutput

Arguments
Name Description
input - OrdersMutationOptions

Example

Query
mutation Orders($input: OrdersMutationOptions) {
  orders(input: $input) {
    created {
      order_id
      order_date
      customer_id
      icon_class
      icon_label
      customers {
        customer_id
        customer_name
        email
        icon_class
        icon_label
        orders {
          ...OrdersFragment
        }
      }
      order_items {
        order_item_id
        order_id
        product_id
        quantity
        price
        currency_type
        icon_class
        icon_label
        orders {
          ...OrdersFragment
        }
        products {
          ...ProductsFragment
        }
      }
      shipments {
        shipment_id
        order_id
        shipment_date
        tracking_int
        icon_class
        icon_label
        orders {
          ...OrdersFragment
        }
      }
      payment {
        id
        payment_method
        payment_date
        amount
        payment_status
        order_id
        orders {
          ...OrdersFragment
        }
      }
    }
    updated {
      order_id
      order_date
      customer_id
      icon_class
      icon_label
      customers {
        customer_id
        customer_name
        email
        icon_class
        icon_label
        orders {
          ...OrdersFragment
        }
      }
      order_items {
        order_item_id
        order_id
        product_id
        quantity
        price
        currency_type
        icon_class
        icon_label
        orders {
          ...OrdersFragment
        }
        products {
          ...ProductsFragment
        }
      }
      shipments {
        shipment_id
        order_id
        shipment_date
        tracking_int
        icon_class
        icon_label
        orders {
          ...OrdersFragment
        }
      }
      payment {
        id
        payment_method
        payment_date
        amount
        payment_status
        order_id
        orders {
          ...OrdersFragment
        }
      }
    }
    deleted
  }
}
Variables
{"input": OrdersMutationOptions}
Response
{
  "data": {
    "orders": {
      "created": [Orders],
      "updated": [Orders],
      "deleted": 987
    }
  }
}

payment

Response

Returns a PaymentOutput

Arguments
Name Description
input - PaymentMutationOptions

Example

Query
mutation Payment($input: PaymentMutationOptions) {
  payment(input: $input) {
    created {
      id
      payment_method
      payment_date
      amount
      payment_status
      order_id
      orders {
        order_id
        order_date
        customer_id
        icon_class
        icon_label
        customers {
          ...CustomersFragment
        }
        order_items {
          ...Order_itemsFragment
        }
        shipments {
          ...ShipmentsFragment
        }
        payment {
          ...PaymentFragment
        }
      }
    }
    updated {
      id
      payment_method
      payment_date
      amount
      payment_status
      order_id
      orders {
        order_id
        order_date
        customer_id
        icon_class
        icon_label
        customers {
          ...CustomersFragment
        }
        order_items {
          ...Order_itemsFragment
        }
        shipments {
          ...ShipmentsFragment
        }
        payment {
          ...PaymentFragment
        }
      }
    }
    deleted
  }
}
Variables
{"input": PaymentMutationOptions}
Response
{
  "data": {
    "payment": {
      "created": [Payment],
      "updated": [Payment],
      "deleted": 987
    }
  }
}

product_reviews

Response

Returns a Product_reviewsOutput

Arguments
Name Description
input - Product_reviewsMutationOptions

Example

Query
mutation Product_reviews($input: Product_reviewsMutationOptions) {
  product_reviews(input: $input) {
    created {
      review_id
      product_id
      customer_id
      rating
      review_text
      review_date
      icon_class
      icon_label
      products {
        product_id
        product_name
        price
        currency_type
        description
        icon_class
        icon_label
        order_items {
          ...Order_itemsFragment
        }
      }
      customers {
        customer_id
        customer_name
        email
        icon_class
        icon_label
        orders {
          ...OrdersFragment
        }
      }
    }
    updated {
      review_id
      product_id
      customer_id
      rating
      review_text
      review_date
      icon_class
      icon_label
      products {
        product_id
        product_name
        price
        currency_type
        description
        icon_class
        icon_label
        order_items {
          ...Order_itemsFragment
        }
      }
      customers {
        customer_id
        customer_name
        email
        icon_class
        icon_label
        orders {
          ...OrdersFragment
        }
      }
    }
    deleted
  }
}
Variables
{"input": Product_reviewsMutationOptions}
Response
{
  "data": {
    "product_reviews": {
      "created": [Product_reviews],
      "updated": [Product_reviews],
      "deleted": 123
    }
  }
}

products

Response

Returns a ProductsOutput

Arguments
Name Description
input - ProductsMutationOptions

Example

Query
mutation Products($input: ProductsMutationOptions) {
  products(input: $input) {
    created {
      product_id
      product_name
      price
      currency_type
      description
      icon_class
      icon_label
      order_items {
        order_item_id
        order_id
        product_id
        quantity
        price
        currency_type
        icon_class
        icon_label
        orders {
          ...OrdersFragment
        }
        products {
          ...ProductsFragment
        }
      }
    }
    updated {
      product_id
      product_name
      price
      currency_type
      description
      icon_class
      icon_label
      order_items {
        order_item_id
        order_id
        product_id
        quantity
        price
        currency_type
        icon_class
        icon_label
        orders {
          ...OrdersFragment
        }
        products {
          ...ProductsFragment
        }
      }
    }
    deleted
  }
}
Variables
{"input": ProductsMutationOptions}
Response
{
  "data": {
    "products": {
      "created": [Products],
      "updated": [Products],
      "deleted": 987
    }
  }
}

promotions

Response

Returns a PromotionsOutput

Arguments
Name Description
input - PromotionsMutationOptions

Example

Query
mutation Promotions($input: PromotionsMutationOptions) {
  promotions(input: $input) {
    created {
      id
      name
      description
      start_date
      end_date
      coupons {
        id
        code
        discount_percent
        expiration_date
        promotion_id
        promotions {
          ...PromotionsFragment
        }
      }
    }
    updated {
      id
      name
      description
      start_date
      end_date
      coupons {
        id
        code
        discount_percent
        expiration_date
        promotion_id
        promotions {
          ...PromotionsFragment
        }
      }
    }
    deleted
  }
}
Variables
{"input": PromotionsMutationOptions}
Response
{
  "data": {
    "promotions": {
      "created": [Promotions],
      "updated": [Promotions],
      "deleted": 987
    }
  }
}

shipments

Response

Returns a ShipmentsOutput

Arguments
Name Description
input - ShipmentsMutationOptions

Example

Query
mutation Shipments($input: ShipmentsMutationOptions) {
  shipments(input: $input) {
    created {
      shipment_id
      order_id
      shipment_date
      tracking_int
      icon_class
      icon_label
      orders {
        order_id
        order_date
        customer_id
        icon_class
        icon_label
        customers {
          ...CustomersFragment
        }
        order_items {
          ...Order_itemsFragment
        }
        shipments {
          ...ShipmentsFragment
        }
        payment {
          ...PaymentFragment
        }
      }
    }
    updated {
      shipment_id
      order_id
      shipment_date
      tracking_int
      icon_class
      icon_label
      orders {
        order_id
        order_date
        customer_id
        icon_class
        icon_label
        customers {
          ...CustomersFragment
        }
        order_items {
          ...Order_itemsFragment
        }
        shipments {
          ...ShipmentsFragment
        }
        payment {
          ...PaymentFragment
        }
      }
    }
    deleted
  }
}
Variables
{"input": ShipmentsMutationOptions}
Response
{
  "data": {
    "shipments": {
      "created": [Shipments],
      "updated": [Shipments],
      "deleted": 987
    }
  }
}

user_role

Response

Returns a User_roleOutput

Arguments
Name Description
input - User_roleMutationOptions

Example

Query
mutation User_role($input: User_roleMutationOptions) {
  user_role(input: $input) {
    created {
      id
      role_name
      users {
        id
        email
        role_id
        customer_id
        created_t
        user_role {
          ...User_roleFragment
        }
      }
    }
    updated {
      id
      role_name
      users {
        id
        email
        role_id
        customer_id
        created_t
        user_role {
          ...User_roleFragment
        }
      }
    }
    deleted
  }
}
Variables
{"input": User_roleMutationOptions}
Response
{
  "data": {
    "user_role": {
      "created": [User_role],
      "updated": [User_role],
      "deleted": 123
    }
  }
}

users

Response

Returns a UsersOutput

Arguments
Name Description
input - UsersMutationOptions

Example

Query
mutation Users($input: UsersMutationOptions) {
  users(input: $input) {
    created {
      id
      email
      role_id
      customer_id
      created_t
      user_role {
        id
        role_name
        users {
          ...UsersFragment
        }
      }
    }
    updated {
      id
      email
      role_id
      customer_id
      created_t
      user_role {
        id
        role_name
        users {
          ...UsersFragment
        }
      }
    }
    deleted
  }
}
Variables
{"input": UsersMutationOptions}
Response
{
  "data": {
    "users": {
      "created": [Users],
      "updated": [Users],
      "deleted": 123
    }
  }
}

Types

ActionType

Values
Enum Value Description

COUNT

CREATE

UPDATE

DELETE

Example
"COUNT"

AuthPayload

Fields
Field Name Description
token - Token!
Example
{"token": Token}

AuthorizeUser

Fields
Input Field Description
email - String!
password - String!
Example
{
  "email": "abc123",
  "password": "abc123"
}

Authors

Fields
Field Name Description
id - ID!
name - String!
email - String!
blog_posts - [Blog_posts]
Arguments
take - Int
skip - Int
Example
{
  "id": 4,
  "name": "abc123",
  "email": "xyz789",
  "blog_posts": [Blog_posts]
}

AuthorsCount

Fields
Input Field Description
_count - Int
Example
{"_count": 123}

AuthorsCountResult

Fields
Field Name Description
action - String
count - Int!
Example
{"action": "xyz789", "count": 123}

AuthorsDelete

Fields
Input Field Description
filter - AuthorsFilter
Example
{"filter": AuthorsFilter}

AuthorsFilter

Fields
Input Field Description
_and - [AuthorsLogicalOp]
_or - [AuthorsLogicalOp]
Example
{
  "_and": [AuthorsLogicalOp],
  "_or": [AuthorsLogicalOp]
}

AuthorsInput

Fields
Input Field Description
name - String!
email - String!
Example
{
  "name": "xyz789",
  "email": "abc123"
}

AuthorsListOptions

Fields
Input Field Description
filter - AuthorsFilter
skip - Int
take - Int
sort - AuthorsSortOptions
Example
{
  "filter": AuthorsFilter,
  "skip": 123,
  "take": 987,
  "sort": AuthorsSortOptions
}

AuthorsLogicalOp

Fields
Input Field Description
_and - [AuthorsLogicalOp]
_or - [AuthorsLogicalOp]
id - ComparisonOperators
name - ComparisonOperators
email - ComparisonOperators
Example
{
  "_and": [AuthorsLogicalOp],
  "_or": [AuthorsLogicalOp],
  "id": ComparisonOperators,
  "name": ComparisonOperators,
  "email": ComparisonOperators
}

AuthorsMutationOptions

Fields
Input Field Description
_create - AuthorsInput
_update - AuthorsUpDel
_delete - AuthorsDelete
Example
{
  "_create": AuthorsInput,
  "_update": AuthorsUpDel,
  "_delete": AuthorsDelete
}

AuthorsOutput

Fields
Field Name Description
created - [Authors]!
updated - [Authors]!
deleted - Int
Example
{
  "created": [Authors],
  "updated": [Authors],
  "deleted": 987
}

AuthorsSort

Fields
Input Field Description
name - Sort
email - Sort
Example
{"name": "ASC", "email": "ASC"}

AuthorsSortOptions

Fields
Input Field Description
id - Sort
name - Sort
email - Sort
Example
{"id": "ASC", "name": "ASC", "email": "ASC"}

AuthorsUpDel

Fields
Input Field Description
name - String
email - String
filter - AuthorsFilter
Example
{
  "name": "abc123",
  "email": "abc123",
  "filter": AuthorsFilter
}

Blog_posts

Fields
Field Name Description
id - ID!
title - String!
author_id - ID!
content - JSON!
publish_date - GraphQLDate!
authors - Authors
Arguments
take - Int
skip - Int
Example
{
  "id": 4,
  "title": "xyz789",
  "author_id": "4",
  "content": {},
  "publish_date": GraphQLDate,
  "authors": Authors
}

Blog_postsCount

Fields
Input Field Description
_count - Int
Example
{"_count": 123}

Blog_postsCountResult

Fields
Field Name Description
action - String
count - Int!
Example
{"action": "xyz789", "count": 987}

Blog_postsDelete

Fields
Input Field Description
filter - Blog_postsFilter
Example
{"filter": Blog_postsFilter}

Blog_postsFilter

Fields
Input Field Description
_and - [Blog_postsLogicalOp]
_or - [Blog_postsLogicalOp]
Example
{
  "_and": [Blog_postsLogicalOp],
  "_or": [Blog_postsLogicalOp]
}

Blog_postsInput

Fields
Input Field Description
title - String!
author_id - ID!
content - JSON!
publish_date - GraphQLDate!
Example
{
  "title": "xyz789",
  "author_id": 4,
  "content": {},
  "publish_date": GraphQLDate
}

Blog_postsListOptions

Fields
Input Field Description
filter - Blog_postsFilter
skip - Int
take - Int
sort - Blog_postsSortOptions
Example
{
  "filter": Blog_postsFilter,
  "skip": 987,
  "take": 987,
  "sort": Blog_postsSortOptions
}

Blog_postsLogicalOp

Fields
Input Field Description
_and - [Blog_postsLogicalOp]
_or - [Blog_postsLogicalOp]
id - ComparisonOperators
title - ComparisonOperators
author_id - ComparisonOperators
content - ComparisonOperators
publish_date - ComparisonOperators
Example
{
  "_and": [Blog_postsLogicalOp],
  "_or": [Blog_postsLogicalOp],
  "id": ComparisonOperators,
  "title": ComparisonOperators,
  "author_id": ComparisonOperators,
  "content": ComparisonOperators,
  "publish_date": ComparisonOperators
}

Blog_postsMutationOptions

Fields
Input Field Description
_create - Blog_postsInput
_update - Blog_postsUpDel
_delete - Blog_postsDelete
Example
{
  "_create": Blog_postsInput,
  "_update": Blog_postsUpDel,
  "_delete": Blog_postsDelete
}

Blog_postsOutput

Fields
Field Name Description
created - [Blog_posts]!
updated - [Blog_posts]!
deleted - Int
Example
{
  "created": [Blog_posts],
  "updated": [Blog_posts],
  "deleted": 987
}

Blog_postsSort

Fields
Input Field Description
title - Sort
content - Sort
publish_date - Sort
Example
{"title": "ASC", "content": "ASC", "publish_date": "ASC"}

Blog_postsSortOptions

Fields
Input Field Description
id - Sort
title - Sort
author_id - Sort
content - Sort
publish_date - Sort
Example
{
  "id": "ASC",
  "title": "ASC",
  "author_id": "ASC",
  "content": "ASC",
  "publish_date": "ASC"
}

Blog_postsUpDel

Fields
Input Field Description
title - String
author_id - ID
content - JSON
publish_date - GraphQLDate
filter - Blog_postsFilter
Example
{
  "title": "xyz789",
  "author_id": 4,
  "content": {},
  "publish_date": GraphQLDate,
  "filter": Blog_postsFilter
}

Boolean

Description

The Boolean scalar type represents true or false.

Brands

Fields
Field Name Description
id - ID!
name - String!
country - String!
founded_year - String!
products - JSON!
Example
{
  "id": 4,
  "name": "abc123",
  "country": "abc123",
  "founded_year": "xyz789",
  "products": {}
}

BrandsCount

Fields
Input Field Description
_count - Int
Example
{"_count": 987}

BrandsCountResult

Fields
Field Name Description
action - String
count - Int!
Example
{"action": "abc123", "count": 123}

BrandsDelete

Fields
Input Field Description
filter - BrandsFilter
Example
{"filter": BrandsFilter}

BrandsFilter

Fields
Input Field Description
_and - [BrandsLogicalOp]
_or - [BrandsLogicalOp]
Example
{
  "_and": [BrandsLogicalOp],
  "_or": [BrandsLogicalOp]
}

BrandsInput

Fields
Input Field Description
name - String!
country - String!
founded_year - String!
products - JSON!
Example
{
  "name": "abc123",
  "country": "abc123",
  "founded_year": "xyz789",
  "products": {}
}

BrandsListOptions

Fields
Input Field Description
filter - BrandsFilter
skip - Int
take - Int
sort - BrandsSortOptions
Example
{
  "filter": BrandsFilter,
  "skip": 123,
  "take": 123,
  "sort": BrandsSortOptions
}

BrandsLogicalOp

Fields
Input Field Description
_and - [BrandsLogicalOp]
_or - [BrandsLogicalOp]
id - ComparisonOperators
name - ComparisonOperators
country - ComparisonOperators
founded_year - ComparisonOperators
products - ComparisonOperators
Example
{
  "_and": [BrandsLogicalOp],
  "_or": [BrandsLogicalOp],
  "id": ComparisonOperators,
  "name": ComparisonOperators,
  "country": ComparisonOperators,
  "founded_year": ComparisonOperators,
  "products": ComparisonOperators
}

BrandsMutationOptions

Fields
Input Field Description
_create - BrandsInput
_update - BrandsUpDel
_delete - BrandsDelete
Example
{
  "_create": BrandsInput,
  "_update": BrandsUpDel,
  "_delete": BrandsDelete
}

BrandsOutput

Fields
Field Name Description
created - [Brands]!
updated - [Brands]!
deleted - Int
Example
{
  "created": [Brands],
  "updated": [Brands],
  "deleted": 987
}

BrandsSort

Fields
Input Field Description
name - Sort
country - Sort
founded_year - Sort
products - Sort
Example
{"name": "ASC", "country": "ASC", "founded_year": "ASC", "products": "ASC"}

BrandsSortOptions

Fields
Input Field Description
id - Sort
name - Sort
country - Sort
founded_year - Sort
products - Sort
Example
{
  "id": "ASC",
  "name": "ASC",
  "country": "ASC",
  "founded_year": "ASC",
  "products": "ASC"
}

BrandsUpDel

Fields
Input Field Description
name - String
country - String
founded_year - String
products - JSON
filter - BrandsFilter
Example
{
  "name": "abc123",
  "country": "abc123",
  "founded_year": "abc123",
  "products": {},
  "filter": BrandsFilter
}

Categories

Fields
Field Name Description
category_id - Int!
category_name - String!
icon_class - String!
icon_label - String!
Example
{
  "category_id": 987,
  "category_name": "abc123",
  "icon_class": "xyz789",
  "icon_label": "abc123"
}

CategoriesCount

Fields
Input Field Description
_count - Int
Example
{"_count": 123}

CategoriesCountResult

Fields
Field Name Description
action - String
count - Int!
Example
{"action": "xyz789", "count": 987}

CategoriesDelete

Fields
Input Field Description
filter - CategoriesFilter
Example
{"filter": CategoriesFilter}

CategoriesFilter

Fields
Input Field Description
_and - [CategoriesLogicalOp]
_or - [CategoriesLogicalOp]
Example
{
  "_and": [CategoriesLogicalOp],
  "_or": [CategoriesLogicalOp]
}

CategoriesInput

Fields
Input Field Description
category_name - String!
icon_class - String!
icon_label - String!
Example
{
  "category_name": "xyz789",
  "icon_class": "xyz789",
  "icon_label": "xyz789"
}

CategoriesListOptions

Fields
Input Field Description
filter - CategoriesFilter
skip - Int
take - Int
sort - CategoriesSortOptions
Example
{
  "filter": CategoriesFilter,
  "skip": 123,
  "take": 987,
  "sort": CategoriesSortOptions
}

CategoriesLogicalOp

Fields
Input Field Description
_and - [CategoriesLogicalOp]
_or - [CategoriesLogicalOp]
category_id - ComparisonOperators
category_name - ComparisonOperators
icon_class - ComparisonOperators
icon_label - ComparisonOperators
Example
{
  "_and": [CategoriesLogicalOp],
  "_or": [CategoriesLogicalOp],
  "category_id": ComparisonOperators,
  "category_name": ComparisonOperators,
  "icon_class": ComparisonOperators,
  "icon_label": ComparisonOperators
}

CategoriesMutationOptions

Fields
Input Field Description
_create - CategoriesInput
_update - CategoriesUpDel
_delete - CategoriesDelete
Example
{
  "_create": CategoriesInput,
  "_update": CategoriesUpDel,
  "_delete": CategoriesDelete
}

CategoriesOutput

Fields
Field Name Description
created - [Categories]!
updated - [Categories]!
deleted - Int
Example
{
  "created": [Categories],
  "updated": [Categories],
  "deleted": 123
}

CategoriesSort

Fields
Input Field Description
category_name - Sort
icon_class - Sort
icon_label - Sort
Example
{"category_name": "ASC", "icon_class": "ASC", "icon_label": "ASC"}

CategoriesSortOptions

Fields
Input Field Description
category_id - Sort
category_name - Sort
icon_class - Sort
icon_label - Sort
Example
{
  "category_id": "ASC",
  "category_name": "ASC",
  "icon_class": "ASC",
  "icon_label": "ASC"
}

CategoriesUpDel

Fields
Input Field Description
category_name - String
icon_class - String
icon_label - String
filter - CategoriesFilter
Example
{
  "category_name": "abc123",
  "icon_class": "abc123",
  "icon_label": "xyz789",
  "filter": CategoriesFilter
}

ComparisonOperators

Fields
Input Field Description
_eq - String
_neq - String
_lt - String
_lte - String
_gt - String
_gte - String
_in - String
_nin - String
_like - String
Example
{
  "_eq": "xyz789",
  "_neq": "xyz789",
  "_lt": "abc123",
  "_lte": "abc123",
  "_gt": "abc123",
  "_gte": "xyz789",
  "_in": "xyz789",
  "_nin": "abc123",
  "_like": "xyz789"
}

Coupons

Fields
Field Name Description
id - ID!
code - String!
discount_percent - Int!
expiration_date - String!
promotion_id - ID!
promotions - Promotions
Arguments
take - Int
skip - Int
Example
{
  "id": "4",
  "code": "abc123",
  "discount_percent": 987,
  "expiration_date": "abc123",
  "promotion_id": 4,
  "promotions": Promotions
}

CouponsCount

Fields
Input Field Description
_count - Int
Example
{"_count": 987}

CouponsCountResult

Fields
Field Name Description
action - String
count - Int!
Example
{"action": "abc123", "count": 123}

CouponsDelete

Fields
Input Field Description
filter - CouponsFilter
Example
{"filter": CouponsFilter}

CouponsFilter

Fields
Input Field Description
_and - [CouponsLogicalOp]
_or - [CouponsLogicalOp]
Example
{
  "_and": [CouponsLogicalOp],
  "_or": [CouponsLogicalOp]
}

CouponsInput

Fields
Input Field Description
code - String!
discount_percent - Int!
expiration_date - String!
promotion_id - ID!
Example
{
  "code": "abc123",
  "discount_percent": 123,
  "expiration_date": "abc123",
  "promotion_id": 4
}

CouponsListOptions

Fields
Input Field Description
filter - CouponsFilter
skip - Int
take - Int
sort - CouponsSortOptions
Example
{
  "filter": CouponsFilter,
  "skip": 987,
  "take": 123,
  "sort": CouponsSortOptions
}

CouponsLogicalOp

Fields
Input Field Description
_and - [CouponsLogicalOp]
_or - [CouponsLogicalOp]
id - ComparisonOperators
code - ComparisonOperators
discount_percent - ComparisonOperators
expiration_date - ComparisonOperators
promotion_id - ComparisonOperators
Example
{
  "_and": [CouponsLogicalOp],
  "_or": [CouponsLogicalOp],
  "id": ComparisonOperators,
  "code": ComparisonOperators,
  "discount_percent": ComparisonOperators,
  "expiration_date": ComparisonOperators,
  "promotion_id": ComparisonOperators
}

CouponsMutationOptions

Fields
Input Field Description
_create - CouponsInput
_update - CouponsUpDel
_delete - CouponsDelete
Example
{
  "_create": CouponsInput,
  "_update": CouponsUpDel,
  "_delete": CouponsDelete
}

CouponsOutput

Fields
Field Name Description
created - [Coupons]!
updated - [Coupons]!
deleted - Int
Example
{
  "created": [Coupons],
  "updated": [Coupons],
  "deleted": 987
}

CouponsSort

Fields
Input Field Description
code - Sort
discount_percent - Sort
expiration_date - Sort
Example
{"code": "ASC", "discount_percent": "ASC", "expiration_date": "ASC"}

CouponsSortOptions

Fields
Input Field Description
id - Sort
code - Sort
discount_percent - Sort
expiration_date - Sort
promotion_id - Sort
Example
{
  "id": "ASC",
  "code": "ASC",
  "discount_percent": "ASC",
  "expiration_date": "ASC",
  "promotion_id": "ASC"
}

CouponsUpDel

Fields
Input Field Description
code - String
discount_percent - Int
expiration_date - String
promotion_id - ID
filter - CouponsFilter
Example
{
  "code": "xyz789",
  "discount_percent": 987,
  "expiration_date": "xyz789",
  "promotion_id": 4,
  "filter": CouponsFilter
}

Customers

Fields
Field Name Description
customer_id - Int!
customer_name - String!
email - String!
icon_class - String
icon_label - String
orders - [Orders]
Arguments
take - Int
skip - Int
Example
{
  "customer_id": 987,
  "customer_name": "xyz789",
  "email": "xyz789",
  "icon_class": "abc123",
  "icon_label": "xyz789",
  "orders": [Orders]
}

CustomersCount

Fields
Input Field Description
_count - Int
Example
{"_count": 123}

CustomersCountResult

Fields
Field Name Description
action - String
count - Int!
Example
{"action": "xyz789", "count": 123}

CustomersDelete

Fields
Input Field Description
filter - CustomersFilter
Example
{"filter": CustomersFilter}

CustomersFilter

Fields
Input Field Description
_and - [CustomersLogicalOp]
_or - [CustomersLogicalOp]
Example
{
  "_and": [CustomersLogicalOp],
  "_or": [CustomersLogicalOp]
}

CustomersInput

Fields
Input Field Description
customer_name - String!
email - String!
icon_class - String
icon_label - String
Example
{
  "customer_name": "xyz789",
  "email": "abc123",
  "icon_class": "abc123",
  "icon_label": "xyz789"
}

CustomersListOptions

Fields
Input Field Description
filter - CustomersFilter
skip - Int
take - Int
sort - CustomersSortOptions
Example
{
  "filter": CustomersFilter,
  "skip": 987,
  "take": 987,
  "sort": CustomersSortOptions
}

CustomersLogicalOp

Fields
Input Field Description
_and - [CustomersLogicalOp]
_or - [CustomersLogicalOp]
customer_id - ComparisonOperators
customer_name - ComparisonOperators
email - ComparisonOperators
icon_class - ComparisonOperators
icon_label - ComparisonOperators
Example
{
  "_and": [CustomersLogicalOp],
  "_or": [CustomersLogicalOp],
  "customer_id": ComparisonOperators,
  "customer_name": ComparisonOperators,
  "email": ComparisonOperators,
  "icon_class": ComparisonOperators,
  "icon_label": ComparisonOperators
}

CustomersMutationOptions

Fields
Input Field Description
_create - CustomersInput
_update - CustomersUpDel
_delete - CustomersDelete
Example
{
  "_create": CustomersInput,
  "_update": CustomersUpDel,
  "_delete": CustomersDelete
}

CustomersOutput

Fields
Field Name Description
created - [Customers]!
updated - [Customers]!
deleted - Int
Example
{
  "created": [Customers],
  "updated": [Customers],
  "deleted": 987
}

CustomersSort

Fields
Input Field Description
customer_name - Sort
email - Sort
icon_class - Sort
icon_label - Sort
Example
{
  "customer_name": "ASC",
  "email": "ASC",
  "icon_class": "ASC",
  "icon_label": "ASC"
}

CustomersSortOptions

Fields
Input Field Description
customer_id - Sort
customer_name - Sort
email - Sort
icon_class - Sort
icon_label - Sort
Example
{
  "customer_id": "ASC",
  "customer_name": "ASC",
  "email": "ASC",
  "icon_class": "ASC",
  "icon_label": "ASC"
}

CustomersUpDel

Fields
Input Field Description
customer_name - String
email - String
icon_class - String
icon_label - String
filter - CustomersFilter
Example
{
  "customer_name": "abc123",
  "email": "abc123",
  "icon_class": "abc123",
  "icon_label": "abc123",
  "filter": CustomersFilter
}

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
123.45

GraphQLDate

Example
GraphQLDate

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example
4

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
123

JSON

Example
{}

MySQLDate

Example
MySQLDate

NestedFiltering

Fields
Input Field Description
_and - [NestedFiltering]
_or - [NestedFiltering]
name - ComparisonOperators
email - ComparisonOperators
id - ComparisonOperators
title - ComparisonOperators
author_id - ComparisonOperators
content - ComparisonOperators
publish_date - ComparisonOperators
country - ComparisonOperators
founded_year - ComparisonOperators
products - ComparisonOperators
category_name - ComparisonOperators
icon_class - ComparisonOperators
icon_label - ComparisonOperators
code - ComparisonOperators
discount_percent - ComparisonOperators
expiration_date - ComparisonOperators
promotion_id - ComparisonOperators
customer_name - ComparisonOperators
orders - ComparisonOperators
order_id - ComparisonOperators
product_id - ComparisonOperators
quantity - ComparisonOperators
price - ComparisonOperators
currency_type - ComparisonOperators
order_date - ComparisonOperators
customer_id - ComparisonOperators
order_items - ComparisonOperators
shipments - ComparisonOperators
payment - ComparisonOperators
payment_method - ComparisonOperators
payment_date - ComparisonOperators
amount - ComparisonOperators
payment_status - ComparisonOperators
product_name - ComparisonOperators
description - ComparisonOperators
rating - ComparisonOperators
review_text - ComparisonOperators
review_date - ComparisonOperators
start_date - ComparisonOperators
end_date - ComparisonOperators
shipment_date - ComparisonOperators
tracking_int - ComparisonOperators
role_name - ComparisonOperators
password - ComparisonOperators
role_id - ComparisonOperators
created_t - ComparisonOperators
Example
{
  "_and": [NestedFiltering],
  "_or": [NestedFiltering],
  "name": ComparisonOperators,
  "email": ComparisonOperators,
  "id": ComparisonOperators,
  "title": ComparisonOperators,
  "author_id": ComparisonOperators,
  "content": ComparisonOperators,
  "publish_date": ComparisonOperators,
  "country": ComparisonOperators,
  "founded_year": ComparisonOperators,
  "products": ComparisonOperators,
  "category_name": ComparisonOperators,
  "icon_class": ComparisonOperators,
  "icon_label": ComparisonOperators,
  "code": ComparisonOperators,
  "discount_percent": ComparisonOperators,
  "expiration_date": ComparisonOperators,
  "promotion_id": ComparisonOperators,
  "customer_name": ComparisonOperators,
  "orders": ComparisonOperators,
  "order_id": ComparisonOperators,
  "product_id": ComparisonOperators,
  "quantity": ComparisonOperators,
  "price": ComparisonOperators,
  "currency_type": ComparisonOperators,
  "order_date": ComparisonOperators,
  "customer_id": ComparisonOperators,
  "order_items": ComparisonOperators,
  "shipments": ComparisonOperators,
  "payment": ComparisonOperators,
  "payment_method": ComparisonOperators,
  "payment_date": ComparisonOperators,
  "amount": ComparisonOperators,
  "payment_status": ComparisonOperators,
  "product_name": ComparisonOperators,
  "description": ComparisonOperators,
  "rating": ComparisonOperators,
  "review_text": ComparisonOperators,
  "review_date": ComparisonOperators,
  "start_date": ComparisonOperators,
  "end_date": ComparisonOperators,
  "shipment_date": ComparisonOperators,
  "tracking_int": ComparisonOperators,
  "role_name": ComparisonOperators,
  "password": ComparisonOperators,
  "role_id": ComparisonOperators,
  "created_t": ComparisonOperators
}

Order_items

Fields
Field Name Description
order_item_id - Int!
order_id - Int!
product_id - Int!
quantity - Int!
price - Float!
currency_type - String!
icon_class - String
icon_label - String
orders - Orders
Arguments
take - Int
skip - Int
products - Products
Arguments
take - Int
skip - Int
Example
{
  "order_item_id": 123,
  "order_id": 123,
  "product_id": 987,
  "quantity": 987,
  "price": 123.45,
  "currency_type": "abc123",
  "icon_class": "abc123",
  "icon_label": "abc123",
  "orders": Orders,
  "products": Products
}

Order_itemsCount

Fields
Input Field Description
_count - Int
Example
{"_count": 123}

Order_itemsCountResult

Fields
Field Name Description
action - String
count - Int!
Example
{"action": "abc123", "count": 987}

Order_itemsDelete

Fields
Input Field Description
filter - Order_itemsFilter
Example
{"filter": Order_itemsFilter}

Order_itemsFilter

Fields
Input Field Description
_and - [Order_itemsLogicalOp]
_or - [Order_itemsLogicalOp]
Example
{
  "_and": [Order_itemsLogicalOp],
  "_or": [Order_itemsLogicalOp]
}

Order_itemsInput

Fields
Input Field Description
order_id - Int!
product_id - Int!
quantity - Int!
price - Float!
currency_type - String!
icon_class - String
icon_label - String
Example
{
  "order_id": 987,
  "product_id": 987,
  "quantity": 987,
  "price": 123.45,
  "currency_type": "abc123",
  "icon_class": "abc123",
  "icon_label": "abc123"
}

Order_itemsListOptions

Fields
Input Field Description
filter - Order_itemsFilter
skip - Int
take - Int
sort - Order_itemsSortOptions
Example
{
  "filter": Order_itemsFilter,
  "skip": 987,
  "take": 123,
  "sort": Order_itemsSortOptions
}

Order_itemsLogicalOp

Fields
Input Field Description
_and - [Order_itemsLogicalOp]
_or - [Order_itemsLogicalOp]
order_item_id - ComparisonOperators
order_id - ComparisonOperators
product_id - ComparisonOperators
quantity - ComparisonOperators
price - ComparisonOperators
currency_type - ComparisonOperators
icon_class - ComparisonOperators
icon_label - ComparisonOperators
Example
{
  "_and": [Order_itemsLogicalOp],
  "_or": [Order_itemsLogicalOp],
  "order_item_id": ComparisonOperators,
  "order_id": ComparisonOperators,
  "product_id": ComparisonOperators,
  "quantity": ComparisonOperators,
  "price": ComparisonOperators,
  "currency_type": ComparisonOperators,
  "icon_class": ComparisonOperators,
  "icon_label": ComparisonOperators
}

Order_itemsMutationOptions

Fields
Input Field Description
_create - Order_itemsInput
_update - Order_itemsUpDel
_delete - Order_itemsDelete
Example
{
  "_create": Order_itemsInput,
  "_update": Order_itemsUpDel,
  "_delete": Order_itemsDelete
}

Order_itemsOutput

Fields
Field Name Description
created - [Order_items]!
updated - [Order_items]!
deleted - Int
Example
{
  "created": [Order_items],
  "updated": [Order_items],
  "deleted": 123
}

Order_itemsSort

Fields
Input Field Description
quantity - Sort
price - Sort
currency_type - Sort
icon_class - Sort
icon_label - Sort
Example
{
  "quantity": "ASC",
  "price": "ASC",
  "currency_type": "ASC",
  "icon_class": "ASC",
  "icon_label": "ASC"
}

Order_itemsSortOptions

Fields
Input Field Description
order_item_id - Sort
order_id - Sort
product_id - Sort
quantity - Sort
price - Sort
currency_type - Sort
icon_class - Sort
icon_label - Sort
Example
{
  "order_item_id": "ASC",
  "order_id": "ASC",
  "product_id": "ASC",
  "quantity": "ASC",
  "price": "ASC",
  "currency_type": "ASC",
  "icon_class": "ASC",
  "icon_label": "ASC"
}

Order_itemsUpDel

Fields
Input Field Description
order_id - Int
product_id - Int
quantity - Int
price - Float
currency_type - String
icon_class - String
icon_label - String
filter - Order_itemsFilter
Example
{
  "order_id": 123,
  "product_id": 123,
  "quantity": 987,
  "price": 987.65,
  "currency_type": "xyz789",
  "icon_class": "abc123",
  "icon_label": "xyz789",
  "filter": Order_itemsFilter
}

Orders

Fields
Field Name Description
order_id - Int!
order_date - String!
customer_id - Int!
icon_class - String
icon_label - String
customers - Customers
Arguments
take - Int
skip - Int
order_items - [Order_items]
Arguments
take - Int
skip - Int
shipments - Shipments
Arguments
take - Int
skip - Int
payment - Payment
Arguments
take - Int
skip - Int
Example
{
  "order_id": 987,
  "order_date": "xyz789",
  "customer_id": 987,
  "icon_class": "abc123",
  "icon_label": "abc123",
  "customers": Customers,
  "order_items": [Order_items],
  "shipments": Shipments,
  "payment": Payment
}

OrdersCount

Fields
Input Field Description
_count - Int
Example
{"_count": 987}

OrdersCountResult

Fields
Field Name Description
action - String
count - Int!
Example
{"action": "abc123", "count": 123}

OrdersDelete

Fields
Input Field Description
filter - OrdersFilter
Example
{"filter": OrdersFilter}

OrdersFilter

Fields
Input Field Description
_and - [OrdersLogicalOp]
_or - [OrdersLogicalOp]
Example
{
  "_and": [OrdersLogicalOp],
  "_or": [OrdersLogicalOp]
}

OrdersInput

Fields
Input Field Description
order_date - String!
customer_id - Int!
icon_class - String
icon_label - String
Example
{
  "order_date": "xyz789",
  "customer_id": 123,
  "icon_class": "xyz789",
  "icon_label": "xyz789"
}

OrdersListOptions

Fields
Input Field Description
filter - OrdersFilter
skip - Int
take - Int
sort - OrdersSortOptions
Example
{
  "filter": OrdersFilter,
  "skip": 987,
  "take": 123,
  "sort": OrdersSortOptions
}

OrdersLogicalOp

Fields
Input Field Description
_and - [OrdersLogicalOp]
_or - [OrdersLogicalOp]
order_id - ComparisonOperators
order_date - ComparisonOperators
customer_id - ComparisonOperators
icon_class - ComparisonOperators
icon_label - ComparisonOperators
Example
{
  "_and": [OrdersLogicalOp],
  "_or": [OrdersLogicalOp],
  "order_id": ComparisonOperators,
  "order_date": ComparisonOperators,
  "customer_id": ComparisonOperators,
  "icon_class": ComparisonOperators,
  "icon_label": ComparisonOperators
}

OrdersMutationOptions

Fields
Input Field Description
_create - OrdersInput
_update - OrdersUpDel
_delete - OrdersDelete
Example
{
  "_create": OrdersInput,
  "_update": OrdersUpDel,
  "_delete": OrdersDelete
}

OrdersOutput

Fields
Field Name Description
created - [Orders]!
updated - [Orders]!
deleted - Int
Example
{
  "created": [Orders],
  "updated": [Orders],
  "deleted": 987
}

OrdersSort

Fields
Input Field Description
order_date - Sort
icon_class - Sort
icon_label - Sort
Example
{"order_date": "ASC", "icon_class": "ASC", "icon_label": "ASC"}

OrdersSortOptions

Fields
Input Field Description
order_id - Sort
order_date - Sort
customer_id - Sort
icon_class - Sort
icon_label - Sort
Example
{
  "order_id": "ASC",
  "order_date": "ASC",
  "customer_id": "ASC",
  "icon_class": "ASC",
  "icon_label": "ASC"
}

OrdersUpDel

Fields
Input Field Description
order_date - String
customer_id - Int
icon_class - String
icon_label - String
filter - OrdersFilter
Example
{
  "order_date": "abc123",
  "customer_id": 987,
  "icon_class": "xyz789",
  "icon_label": "xyz789",
  "filter": OrdersFilter
}

Payment

Fields
Field Name Description
id - String!
payment_method - String!
payment_date - String!
amount - Float!
payment_status - String!
order_id - Int
orders - Orders
Arguments
take - Int
skip - Int
Example
{
  "id": "xyz789",
  "payment_method": "xyz789",
  "payment_date": "abc123",
  "amount": 987.65,
  "payment_status": "abc123",
  "order_id": 123,
  "orders": Orders
}

PaymentCount

Fields
Input Field Description
_count - Int
Example
{"_count": 987}

PaymentCountResult

Fields
Field Name Description
action - String
count - Int!
Example
{"action": "xyz789", "count": 987}

PaymentDelete

Fields
Input Field Description
filter - PaymentFilter
Example
{"filter": PaymentFilter}

PaymentFilter

Fields
Input Field Description
_and - [PaymentLogicalOp]
_or - [PaymentLogicalOp]
Example
{
  "_and": [PaymentLogicalOp],
  "_or": [PaymentLogicalOp]
}

PaymentInput

Fields
Input Field Description
payment_method - String!
payment_date - String!
amount - Float!
payment_status - String!
order_id - Int
Example
{
  "payment_method": "xyz789",
  "payment_date": "abc123",
  "amount": 987.65,
  "payment_status": "abc123",
  "order_id": 123
}

PaymentListOptions

Fields
Input Field Description
filter - PaymentFilter
skip - Int
take - Int
sort - PaymentSortOptions
Example
{
  "filter": PaymentFilter,
  "skip": 123,
  "take": 123,
  "sort": PaymentSortOptions
}

PaymentLogicalOp

Fields
Input Field Description
_and - [PaymentLogicalOp]
_or - [PaymentLogicalOp]
id - ComparisonOperators
payment_method - ComparisonOperators
payment_date - ComparisonOperators
amount - ComparisonOperators
payment_status - ComparisonOperators
order_id - ComparisonOperators
Example
{
  "_and": [PaymentLogicalOp],
  "_or": [PaymentLogicalOp],
  "id": ComparisonOperators,
  "payment_method": ComparisonOperators,
  "payment_date": ComparisonOperators,
  "amount": ComparisonOperators,
  "payment_status": ComparisonOperators,
  "order_id": ComparisonOperators
}

PaymentMutationOptions

Fields
Input Field Description
_create - PaymentInput
_update - PaymentUpDel
_delete - PaymentDelete
Example
{
  "_create": PaymentInput,
  "_update": PaymentUpDel,
  "_delete": PaymentDelete
}

PaymentOutput

Fields
Field Name Description
created - [Payment]!
updated - [Payment]!
deleted - Int
Example
{
  "created": [Payment],
  "updated": [Payment],
  "deleted": 987
}

PaymentSort

Fields
Input Field Description
payment_method - Sort
payment_date - Sort
amount - Sort
payment_status - Sort
Example
{
  "payment_method": "ASC",
  "payment_date": "ASC",
  "amount": "ASC",
  "payment_status": "ASC"
}

PaymentSortOptions

Fields
Input Field Description
id - Sort
payment_method - Sort
payment_date - Sort
amount - Sort
payment_status - Sort
order_id - Sort
Example
{
  "id": "ASC",
  "payment_method": "ASC",
  "payment_date": "ASC",
  "amount": "ASC",
  "payment_status": "ASC",
  "order_id": "ASC"
}

PaymentUpDel

Fields
Input Field Description
payment_method - String
payment_date - String
amount - Float
payment_status - String
order_id - Int
filter - PaymentFilter
Example
{
  "payment_method": "abc123",
  "payment_date": "abc123",
  "amount": 123.45,
  "payment_status": "xyz789",
  "order_id": 987,
  "filter": PaymentFilter
}

Product_reviews

Fields
Field Name Description
review_id - Int!
product_id - Int!
customer_id - Int!
rating - Int!
review_text - String!
review_date - String!
icon_class - String
icon_label - String
products - Products
Arguments
take - Int
skip - Int
customers - Customers
Arguments
take - Int
skip - Int
Example
{
  "review_id": 987,
  "product_id": 123,
  "customer_id": 123,
  "rating": 123,
  "review_text": "xyz789",
  "review_date": "abc123",
  "icon_class": "xyz789",
  "icon_label": "xyz789",
  "products": Products,
  "customers": Customers
}

Product_reviewsCount

Fields
Input Field Description
_count - Int
Example
{"_count": 123}

Product_reviewsCountResult

Fields
Field Name Description
action - String
count - Int!
Example
{"action": "xyz789", "count": 123}

Product_reviewsDelete

Fields
Input Field Description
filter - Product_reviewsFilter
Example
{"filter": Product_reviewsFilter}

Product_reviewsFilter

Fields
Input Field Description
_and - [Product_reviewsLogicalOp]
_or - [Product_reviewsLogicalOp]
Example
{
  "_and": [Product_reviewsLogicalOp],
  "_or": [Product_reviewsLogicalOp]
}

Product_reviewsInput

Fields
Input Field Description
product_id - Int!
customer_id - Int!
rating - Int!
review_text - String!
review_date - String!
icon_class - String
icon_label - String
Example
{
  "product_id": 987,
  "customer_id": 123,
  "rating": 987,
  "review_text": "xyz789",
  "review_date": "abc123",
  "icon_class": "xyz789",
  "icon_label": "xyz789"
}

Product_reviewsListOptions

Fields
Input Field Description
filter - Product_reviewsFilter
skip - Int
take - Int
sort - Product_reviewsSortOptions
Example
{
  "filter": Product_reviewsFilter,
  "skip": 987,
  "take": 987,
  "sort": Product_reviewsSortOptions
}

Product_reviewsLogicalOp

Fields
Input Field Description
_and - [Product_reviewsLogicalOp]
_or - [Product_reviewsLogicalOp]
review_id - ComparisonOperators
product_id - ComparisonOperators
customer_id - ComparisonOperators
rating - ComparisonOperators
review_text - ComparisonOperators
review_date - ComparisonOperators
icon_class - ComparisonOperators
icon_label - ComparisonOperators
Example
{
  "_and": [Product_reviewsLogicalOp],
  "_or": [Product_reviewsLogicalOp],
  "review_id": ComparisonOperators,
  "product_id": ComparisonOperators,
  "customer_id": ComparisonOperators,
  "rating": ComparisonOperators,
  "review_text": ComparisonOperators,
  "review_date": ComparisonOperators,
  "icon_class": ComparisonOperators,
  "icon_label": ComparisonOperators
}

Product_reviewsMutationOptions

Fields
Input Field Description
_create - Product_reviewsInput
_update - Product_reviewsUpDel
_delete - Product_reviewsDelete
Example
{
  "_create": Product_reviewsInput,
  "_update": Product_reviewsUpDel,
  "_delete": Product_reviewsDelete
}

Product_reviewsOutput

Fields
Field Name Description
created - [Product_reviews]!
updated - [Product_reviews]!
deleted - Int
Example
{
  "created": [Product_reviews],
  "updated": [Product_reviews],
  "deleted": 123
}

Product_reviewsSort

Fields
Input Field Description
rating - Sort
review_text - Sort
review_date - Sort
icon_class - Sort
icon_label - Sort
Example
{
  "rating": "ASC",
  "review_text": "ASC",
  "review_date": "ASC",
  "icon_class": "ASC",
  "icon_label": "ASC"
}

Product_reviewsSortOptions

Fields
Input Field Description
review_id - Sort
product_id - Sort
customer_id - Sort
rating - Sort
review_text - Sort
review_date - Sort
icon_class - Sort
icon_label - Sort
Example
{
  "review_id": "ASC",
  "product_id": "ASC",
  "customer_id": "ASC",
  "rating": "ASC",
  "review_text": "ASC",
  "review_date": "ASC",
  "icon_class": "ASC",
  "icon_label": "ASC"
}

Product_reviewsUpDel

Fields
Input Field Description
product_id - Int
customer_id - Int
rating - Int
review_text - String
review_date - String
icon_class - String
icon_label - String
filter - Product_reviewsFilter
Example
{
  "product_id": 123,
  "customer_id": 123,
  "rating": 987,
  "review_text": "abc123",
  "review_date": "abc123",
  "icon_class": "xyz789",
  "icon_label": "abc123",
  "filter": Product_reviewsFilter
}

Products

Fields
Field Name Description
product_id - Int!
product_name - String!
price - Float!
currency_type - String!
description - String
icon_class - String
icon_label - String
order_items - [Order_items]
Arguments
take - Int
skip - Int
Example
{
  "product_id": 987,
  "product_name": "abc123",
  "price": 123.45,
  "currency_type": "abc123",
  "description": "abc123",
  "icon_class": "abc123",
  "icon_label": "abc123",
  "order_items": [Order_items]
}

ProductsCount

Fields
Input Field Description
_count - Int
Example
{"_count": 987}

ProductsCountResult

Fields
Field Name Description
action - String
count - Int!
Example
{"action": "abc123", "count": 123}

ProductsDelete

Fields
Input Field Description
filter - ProductsFilter
Example
{"filter": ProductsFilter}

ProductsFilter

Fields
Input Field Description
_and - [ProductsLogicalOp]
_or - [ProductsLogicalOp]
Example
{
  "_and": [ProductsLogicalOp],
  "_or": [ProductsLogicalOp]
}

ProductsInput

Fields
Input Field Description
product_name - String!
price - Float!
currency_type - String!
description - String
icon_class - String
icon_label - String
Example
{
  "product_name": "xyz789",
  "price": 987.65,
  "currency_type": "xyz789",
  "description": "abc123",
  "icon_class": "xyz789",
  "icon_label": "xyz789"
}

ProductsListOptions

Fields
Input Field Description
filter - ProductsFilter
skip - Int
take - Int
sort - ProductsSortOptions
Example
{
  "filter": ProductsFilter,
  "skip": 123,
  "take": 123,
  "sort": ProductsSortOptions
}

ProductsLogicalOp

Fields
Input Field Description
_and - [ProductsLogicalOp]
_or - [ProductsLogicalOp]
product_id - ComparisonOperators
product_name - ComparisonOperators
price - ComparisonOperators
currency_type - ComparisonOperators
description - ComparisonOperators
icon_class - ComparisonOperators
icon_label - ComparisonOperators
Example
{
  "_and": [ProductsLogicalOp],
  "_or": [ProductsLogicalOp],
  "product_id": ComparisonOperators,
  "product_name": ComparisonOperators,
  "price": ComparisonOperators,
  "currency_type": ComparisonOperators,
  "description": ComparisonOperators,
  "icon_class": ComparisonOperators,
  "icon_label": ComparisonOperators
}

ProductsMutationOptions

Fields
Input Field Description
_create - ProductsInput
_update - ProductsUpDel
_delete - ProductsDelete
Example
{
  "_create": ProductsInput,
  "_update": ProductsUpDel,
  "_delete": ProductsDelete
}

ProductsOutput

Fields
Field Name Description
created - [Products]!
updated - [Products]!
deleted - Int
Example
{
  "created": [Products],
  "updated": [Products],
  "deleted": 987
}

ProductsSort

Fields
Input Field Description
product_name - Sort
price - Sort
currency_type - Sort
description - Sort
icon_class - Sort
icon_label - Sort
Example
{
  "product_name": "ASC",
  "price": "ASC",
  "currency_type": "ASC",
  "description": "ASC",
  "icon_class": "ASC",
  "icon_label": "ASC"
}

ProductsSortOptions

Fields
Input Field Description
product_id - Sort
product_name - Sort
price - Sort
currency_type - Sort
description - Sort
icon_class - Sort
icon_label - Sort
Example
{
  "product_id": "ASC",
  "product_name": "ASC",
  "price": "ASC",
  "currency_type": "ASC",
  "description": "ASC",
  "icon_class": "ASC",
  "icon_label": "ASC"
}

ProductsUpDel

Fields
Input Field Description
product_name - String
price - Float
currency_type - String
description - String
icon_class - String
icon_label - String
filter - ProductsFilter
Example
{
  "product_name": "xyz789",
  "price": 123.45,
  "currency_type": "abc123",
  "description": "abc123",
  "icon_class": "abc123",
  "icon_label": "abc123",
  "filter": ProductsFilter
}

Promotions

Fields
Field Name Description
id - ID!
name - String!
description - String!
start_date - String!
end_date - String!
coupons - Coupons
Arguments
take - Int
skip - Int
Example
{
  "id": 4,
  "name": "xyz789",
  "description": "abc123",
  "start_date": "abc123",
  "end_date": "xyz789",
  "coupons": Coupons
}

PromotionsCount

Fields
Input Field Description
_count - Int
Example
{"_count": 123}

PromotionsCountResult

Fields
Field Name Description
action - String
count - Int!
Example
{"action": "xyz789", "count": 987}

PromotionsDelete

Fields
Input Field Description
filter - PromotionsFilter
Example
{"filter": PromotionsFilter}

PromotionsFilter

Fields
Input Field Description
_and - [PromotionsLogicalOp]
_or - [PromotionsLogicalOp]
Example
{
  "_and": [PromotionsLogicalOp],
  "_or": [PromotionsLogicalOp]
}

PromotionsInput

Fields
Input Field Description
name - String!
description - String!
start_date - String!
end_date - String!
Example
{
  "name": "abc123",
  "description": "abc123",
  "start_date": "abc123",
  "end_date": "xyz789"
}

PromotionsListOptions

Fields
Input Field Description
filter - PromotionsFilter
skip - Int
take - Int
sort - PromotionsSortOptions
Example
{
  "filter": PromotionsFilter,
  "skip": 123,
  "take": 987,
  "sort": PromotionsSortOptions
}

PromotionsLogicalOp

Fields
Input Field Description
_and - [PromotionsLogicalOp]
_or - [PromotionsLogicalOp]
id - ComparisonOperators
name - ComparisonOperators
description - ComparisonOperators
start_date - ComparisonOperators
end_date - ComparisonOperators
Example
{
  "_and": [PromotionsLogicalOp],
  "_or": [PromotionsLogicalOp],
  "id": ComparisonOperators,
  "name": ComparisonOperators,
  "description": ComparisonOperators,
  "start_date": ComparisonOperators,
  "end_date": ComparisonOperators
}

PromotionsMutationOptions

Fields
Input Field Description
_create - PromotionsInput
_update - PromotionsUpDel
_delete - PromotionsDelete
Example
{
  "_create": PromotionsInput,
  "_update": PromotionsUpDel,
  "_delete": PromotionsDelete
}

PromotionsOutput

Fields
Field Name Description
created - [Promotions]!
updated - [Promotions]!
deleted - Int
Example
{
  "created": [Promotions],
  "updated": [Promotions],
  "deleted": 987
}

PromotionsSort

Fields
Input Field Description
name - Sort
description - Sort
start_date - Sort
end_date - Sort
Example
{"name": "ASC", "description": "ASC", "start_date": "ASC", "end_date": "ASC"}

PromotionsSortOptions

Fields
Input Field Description
id - Sort
name - Sort
description - Sort
start_date - Sort
end_date - Sort
Example
{
  "id": "ASC",
  "name": "ASC",
  "description": "ASC",
  "start_date": "ASC",
  "end_date": "ASC"
}

PromotionsUpDel

Fields
Input Field Description
name - String
description - String
start_date - String
end_date - String
filter - PromotionsFilter
Example
{
  "name": "abc123",
  "description": "abc123",
  "start_date": "xyz789",
  "end_date": "abc123",
  "filter": PromotionsFilter
}

RoleInput

Fields
Input Field Description
role - String!
Example
{"role": "xyz789"}

Shipments

Fields
Field Name Description
shipment_id - Int!
order_id - Int!
shipment_date - String!
tracking_int - String
icon_class - String
icon_label - String
orders - Orders
Arguments
take - Int
skip - Int
Example
{
  "shipment_id": 987,
  "order_id": 123,
  "shipment_date": "xyz789",
  "tracking_int": "abc123",
  "icon_class": "abc123",
  "icon_label": "abc123",
  "orders": Orders
}

ShipmentsCount

Fields
Input Field Description
_count - Int
Example
{"_count": 987}

ShipmentsCountResult

Fields
Field Name Description
action - String
count - Int!
Example
{"action": "abc123", "count": 123}

ShipmentsDelete

Fields
Input Field Description
filter - ShipmentsFilter
Example
{"filter": ShipmentsFilter}

ShipmentsFilter

Fields
Input Field Description
_and - [ShipmentsLogicalOp]
_or - [ShipmentsLogicalOp]
Example
{
  "_and": [ShipmentsLogicalOp],
  "_or": [ShipmentsLogicalOp]
}

ShipmentsInput

Fields
Input Field Description
order_id - Int!
shipment_date - String!
tracking_int - String
icon_class - String
icon_label - String
Example
{
  "order_id": 123,
  "shipment_date": "xyz789",
  "tracking_int": "xyz789",
  "icon_class": "abc123",
  "icon_label": "abc123"
}

ShipmentsListOptions

Fields
Input Field Description
filter - ShipmentsFilter
skip - Int
take - Int
sort - ShipmentsSortOptions
Example
{
  "filter": ShipmentsFilter,
  "skip": 987,
  "take": 123,
  "sort": ShipmentsSortOptions
}

ShipmentsLogicalOp

Fields
Input Field Description
_and - [ShipmentsLogicalOp]
_or - [ShipmentsLogicalOp]
shipment_id - ComparisonOperators
order_id - ComparisonOperators
shipment_date - ComparisonOperators
tracking_int - ComparisonOperators
icon_class - ComparisonOperators
icon_label - ComparisonOperators
Example
{
  "_and": [ShipmentsLogicalOp],
  "_or": [ShipmentsLogicalOp],
  "shipment_id": ComparisonOperators,
  "order_id": ComparisonOperators,
  "shipment_date": ComparisonOperators,
  "tracking_int": ComparisonOperators,
  "icon_class": ComparisonOperators,
  "icon_label": ComparisonOperators
}

ShipmentsMutationOptions

Fields
Input Field Description
_create - ShipmentsInput
_update - ShipmentsUpDel
_delete - ShipmentsDelete
Example
{
  "_create": ShipmentsInput,
  "_update": ShipmentsUpDel,
  "_delete": ShipmentsDelete
}

ShipmentsOutput

Fields
Field Name Description
created - [Shipments]!
updated - [Shipments]!
deleted - Int
Example
{
  "created": [Shipments],
  "updated": [Shipments],
  "deleted": 123
}

ShipmentsSort

Fields
Input Field Description
shipment_date - Sort
tracking_int - Sort
icon_class - Sort
icon_label - Sort
Example
{
  "shipment_date": "ASC",
  "tracking_int": "ASC",
  "icon_class": "ASC",
  "icon_label": "ASC"
}

ShipmentsSortOptions

Fields
Input Field Description
shipment_id - Sort
order_id - Sort
shipment_date - Sort
tracking_int - Sort
icon_class - Sort
icon_label - Sort
Example
{
  "shipment_id": "ASC",
  "order_id": "ASC",
  "shipment_date": "ASC",
  "tracking_int": "ASC",
  "icon_class": "ASC",
  "icon_label": "ASC"
}

ShipmentsUpDel

Fields
Input Field Description
order_id - Int
shipment_date - String
tracking_int - String
icon_class - String
icon_label - String
filter - ShipmentsFilter
Example
{
  "order_id": 987,
  "shipment_date": "abc123",
  "tracking_int": "xyz789",
  "icon_class": "abc123",
  "icon_label": "abc123",
  "filter": ShipmentsFilter
}

Sort

Values
Enum Value Description

ASC

DESC

Example
"ASC"

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"abc123"

TableInfo

Fields
Field Name Description
table - String
structure - String
Example
{
  "table": "xyz789",
  "structure": "xyz789"
}

Token

Fields
Field Name Description
accessToken - String!
idToken - String!
refreshToken - String!
Example
{
  "accessToken": "xyz789",
  "idToken": "abc123",
  "refreshToken": "xyz789"
}

User_role

Fields
Field Name Description
id - ID!
role_name - String!
users - [Users]
Arguments
take - Int
skip - Int
Example
{
  "id": 4,
  "role_name": "abc123",
  "users": [Users]
}

User_roleCount

Fields
Input Field Description
_count - Int
Example
{"_count": 123}

User_roleCountResult

Fields
Field Name Description
action - String
count - Int!
Example
{"action": "abc123", "count": 123}

User_roleDelete

Fields
Input Field Description
filter - User_roleFilter
Example
{"filter": User_roleFilter}

User_roleFilter

Fields
Input Field Description
_and - [User_roleLogicalOp]
_or - [User_roleLogicalOp]
Example
{
  "_and": [User_roleLogicalOp],
  "_or": [User_roleLogicalOp]
}

User_roleInput

Fields
Input Field Description
role_name - String!
Example
{"role_name": "abc123"}

User_roleListOptions

Fields
Input Field Description
filter - User_roleFilter
skip - Int
take - Int
sort - User_roleSortOptions
Example
{
  "filter": User_roleFilter,
  "skip": 987,
  "take": 123,
  "sort": User_roleSortOptions
}

User_roleLogicalOp

Fields
Input Field Description
_and - [User_roleLogicalOp]
_or - [User_roleLogicalOp]
id - ComparisonOperators
role_name - ComparisonOperators
Example
{
  "_and": [User_roleLogicalOp],
  "_or": [User_roleLogicalOp],
  "id": ComparisonOperators,
  "role_name": ComparisonOperators
}

User_roleMutationOptions

Fields
Input Field Description
_create - User_roleInput
_update - User_roleUpDel
_delete - User_roleDelete
Example
{
  "_create": User_roleInput,
  "_update": User_roleUpDel,
  "_delete": User_roleDelete
}

User_roleOutput

Fields
Field Name Description
created - [User_role]!
updated - [User_role]!
deleted - Int
Example
{
  "created": [User_role],
  "updated": [User_role],
  "deleted": 123
}

User_roleSort

Fields
Input Field Description
role_name - Sort
Example
{"role_name": "ASC"}

User_roleSortOptions

Fields
Input Field Description
id - Sort
role_name - Sort
Example
{"id": "ASC", "role_name": "ASC"}

User_roleUpDel

Fields
Input Field Description
role_name - String
filter - User_roleFilter
Example
{
  "role_name": "abc123",
  "filter": User_roleFilter
}

Users

Fields
Field Name Description
id - ID!
email - String!
role_id - String!
customer_id - Int
created_t - String
user_role - User_role
Arguments
take - Int
skip - Int
Example
{
  "id": 4,
  "email": "abc123",
  "role_id": "xyz789",
  "customer_id": 123,
  "created_t": "abc123",
  "user_role": User_role
}

UsersCount

Fields
Input Field Description
_count - Int
Example
{"_count": 123}

UsersCountResult

Fields
Field Name Description
action - String
count - Int!
Example
{"action": "xyz789", "count": 987}

UsersDelete

Fields
Input Field Description
filter - UsersFilter
Example
{"filter": UsersFilter}

UsersFilter

Fields
Input Field Description
_and - [UsersLogicalOp]
_or - [UsersLogicalOp]
Example
{
  "_and": [UsersLogicalOp],
  "_or": [UsersLogicalOp]
}

UsersInput

Fields
Input Field Description
password - String!
email - String!
role_id - String!
customer_id - Int
created_t - String
Example
{
  "password": "abc123",
  "email": "abc123",
  "role_id": "xyz789",
  "customer_id": 123,
  "created_t": "xyz789"
}

UsersListOptions

Fields
Input Field Description
filter - UsersFilter
skip - Int
take - Int
sort - UsersSortOptions
Example
{
  "filter": UsersFilter,
  "skip": 123,
  "take": 123,
  "sort": UsersSortOptions
}

UsersLogicalOp

Fields
Input Field Description
_and - [UsersLogicalOp]
_or - [UsersLogicalOp]
id - ComparisonOperators
password - ComparisonOperators
email - ComparisonOperators
role_id - ComparisonOperators
customer_id - ComparisonOperators
created_t - ComparisonOperators
Example
{
  "_and": [UsersLogicalOp],
  "_or": [UsersLogicalOp],
  "id": ComparisonOperators,
  "password": ComparisonOperators,
  "email": ComparisonOperators,
  "role_id": ComparisonOperators,
  "customer_id": ComparisonOperators,
  "created_t": ComparisonOperators
}

UsersMutationOptions

Fields
Input Field Description
_create - UsersInput
_update - UsersUpDel
_delete - UsersDelete
Example
{
  "_create": UsersInput,
  "_update": UsersUpDel,
  "_delete": UsersDelete
}

UsersOutput

Fields
Field Name Description
created - [Users]!
updated - [Users]!
deleted - Int
Example
{
  "created": [Users],
  "updated": [Users],
  "deleted": 987
}

UsersSort

Fields
Input Field Description
password - Sort
email - Sort
customer_id - Sort
created_t - Sort
Example
{"password": "ASC", "email": "ASC", "customer_id": "ASC", "created_t": "ASC"}

UsersSortOptions

Fields
Input Field Description
id - Sort
password - Sort
email - Sort
role_id - Sort
customer_id - Sort
created_t - Sort
Example
{
  "id": "ASC",
  "password": "ASC",
  "email": "ASC",
  "role_id": "ASC",
  "customer_id": "ASC",
  "created_t": "ASC"
}

UsersUpDel

Fields
Input Field Description
password - String
email - String
role_id - String
customer_id - Int
created_t - String
filter - UsersFilter
Example
{
  "password": "abc123",
  "email": "abc123",
  "role_id": "xyz789",
  "customer_id": 123,
  "created_t": "abc123",
  "filter": UsersFilter
}