Craftplan

GraphQL Reference

Craftplan exposes a GraphQL API at /api/graphql. All requests require a Bearer token; generate one in Settings → API Keys (tokens use the cpk_ prefix).

Craftplan GraphQL API

GraphQL API for Craftplan ERP. All requests require a Bearer token — generate one in Settings → API Keys (tokens use the cpk_ prefix).

Contact

Craftplan

API Endpoints
http://localhost:4000/api/graphql

Queries

getBom

Response

Returns a Bom

Arguments
Name Description
id - ID! The id of the record

Example

Query
query getBom($id: ID!) {
  getBom(id: $id) {
    id
    name
    notes
    status
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getBom": {
      "id": 4,
      "name": "abc123",
      "notes": "xyz789",
      "status": "abc123"
    }
  }
}
Queries

getBomComponent

Response

Returns a BomComponent

Arguments
Name Description
id - ID! The id of the record

Example

Query
query getBomComponent($id: ID!) {
  getBomComponent(id: $id) {
    id
  }
}
Variables
{"id": 4}
Response
{"data": {"getBomComponent": {"id": 4}}}
Queries

getCustomer

Response

Returns a Customer

Arguments
Name Description
id - ID! The id of the record

Example

Query
query getCustomer($id: ID!) {
  getCustomer(id: $id) {
    id
    type
    firstName
    lastName
    email
    phone
    billingAddress
    shippingAddress
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "getCustomer": {
      "id": 4,
      "type": "abc123",
      "firstName": "abc123",
      "lastName": "abc123",
      "email": "abc123",
      "phone": "xyz789",
      "billingAddress": JsonString,
      "shippingAddress": JsonString
    }
  }
}
Queries

getLot

Response

Returns a Lot

Arguments
Name Description
id - ID! The id of the record

Example

Query
query getLot($id: ID!) {
  getLot(id: $id) {
    id
  }
}
Variables
{"id": "4"}
Response
{"data": {"getLot": {"id": 4}}}
Queries

getMaterial

Response

Returns a Material

Arguments
Name Description
id - ID! The id of the record

Example

Query
query getMaterial($id: ID!) {
  getMaterial(id: $id) {
    id
    name
    sku
    unit
    price
    minimumStock
    maximumStock
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "getMaterial": {
      "id": 4,
      "name": "abc123",
      "sku": "xyz789",
      "unit": "abc123",
      "price": Decimal,
      "minimumStock": Decimal,
      "maximumStock": Decimal
    }
  }
}
Queries

getMovement

Response

Returns a Movement

Arguments
Name Description
id - ID! The id of the record

Example

Query
query getMovement($id: ID!) {
  getMovement(id: $id) {
    id
  }
}
Variables
{"id": 4}
Response
{"data": {"getMovement": {"id": 4}}}
Queries

getOrder

Response

Returns an Order

Arguments
Name Description
id - ID! The id of the record

Example

Query
query getOrder($id: ID!) {
  getOrder(id: $id) {
    id
  }
}
Variables
{"id": "4"}
Response
{"data": {"getOrder": {"id": "4"}}}
Queries

getOrderItem

Response

Returns an OrderItem

Arguments
Name Description
id - ID! The id of the record

Example

Query
query getOrderItem($id: ID!) {
  getOrderItem(id: $id) {
    id
  }
}
Variables
{"id": "4"}
Response
{"data": {"getOrderItem": {"id": 4}}}
Queries

getProduct

Response

Returns a Product

Arguments
Name Description
id - ID! The id of the record

Example

Query
query getProduct($id: ID!) {
  getProduct(id: $id) {
    id
    name
    status
    price
    photos
    featuredPhoto
    sellingAvailability
    maxDailyQuantity
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "getProduct": {
      "id": "4",
      "name": "abc123",
      "status": "xyz789",
      "price": Decimal,
      "photos": ["xyz789"],
      "featuredPhoto": "abc123",
      "sellingAvailability": "abc123",
      "maxDailyQuantity": 123
    }
  }
}
Queries

getProductionBatch

Response

Returns a ProductionBatch

Arguments
Name Description
id - ID! The id of the record

Example

Query
query getProductionBatch($id: ID!) {
  getProductionBatch(id: $id) {
    id
  }
}
Variables
{"id": 4}
Response
{"data": {"getProductionBatch": {"id": 4}}}
Queries

getPurchaseOrder

Response

Returns a PurchaseOrder

Arguments
Name Description
id - ID! The id of the record

Example

Query
query getPurchaseOrder($id: ID!) {
  getPurchaseOrder(id: $id) {
    id
  }
}
Variables
{"id": "4"}
Response
{"data": {"getPurchaseOrder": {"id": 4}}}
Queries

getSupplier

Response

Returns a Supplier

Arguments
Name Description
id - ID! The id of the record

Example

Query
query getSupplier($id: ID!) {
  getSupplier(id: $id) {
    id
  }
}
Variables
{"id": 4}
Response
{"data": {"getSupplier": {"id": 4}}}
Queries

listBomComponents

Response

Returns a KeysetPageOfBomComponent

Arguments
Name Description
sort - [BomComponentSortInput] How to sort the records in the response
filter - BomComponentFilterInput A filter to limit the results
first - Int The number of records to return from the beginning. Maximum 250
before - String Show records before the specified keyset.
after - String Show records after the specified keyset.
last - Int The number of records to return to the end. Maximum 250

Example

Query
query listBomComponents(
  $sort: [BomComponentSortInput],
  $filter: BomComponentFilterInput,
  $first: Int,
  $before: String,
  $after: String,
  $last: Int
) {
  listBomComponents(
    sort: $sort,
    filter: $filter,
    first: $first,
    before: $before,
    after: $after,
    last: $last
  ) {
    count
    results {
      ...BomComponentFragment
    }
    startKeyset
    endKeyset
  }
}
Variables
{
  "sort": [BomComponentSortInput],
  "filter": BomComponentFilterInput,
  "first": 123,
  "before": "abc123",
  "after": "abc123",
  "last": 987
}
Response
{
  "data": {
    "listBomComponents": {
      "count": 987,
      "results": [BomComponent],
      "startKeyset": "xyz789",
      "endKeyset": "abc123"
    }
  }
}
Queries

listBoms

Response

Returns [Bom!]!

Arguments
Name Description
sort - [BomSortInput] How to sort the records in the response
filter - BomFilterInput A filter to limit the results
productId - ID!

Example

Query
query listBoms(
  $sort: [BomSortInput],
  $filter: BomFilterInput,
  $productId: ID!
) {
  listBoms(
    sort: $sort,
    filter: $filter,
    productId: $productId
  ) {
    id
    name
    notes
    status
  }
}
Variables
{
  "sort": [BomSortInput],
  "filter": BomFilterInput,
  "productId": "4"
}
Response
{
  "data": {
    "listBoms": [
      {
        "id": "4",
        "name": "abc123",
        "notes": "xyz789",
        "status": "abc123"
      }
    ]
  }
}
Queries

listCustomers

Response

Returns a KeysetPageOfCustomer

Arguments
Name Description
sort - [CustomerSortInput] How to sort the records in the response
filter - CustomerFilterInput A filter to limit the results
first - Int The number of records to return from the beginning. Maximum 250
before - String Show records before the specified keyset.
after - String Show records after the specified keyset.
last - Int The number of records to return to the end. Maximum 250

Example

Query
query listCustomers(
  $sort: [CustomerSortInput],
  $filter: CustomerFilterInput,
  $first: Int,
  $before: String,
  $after: String,
  $last: Int
) {
  listCustomers(
    sort: $sort,
    filter: $filter,
    first: $first,
    before: $before,
    after: $after,
    last: $last
  ) {
    count
    results {
      ...CustomerFragment
    }
    startKeyset
    endKeyset
  }
}
Variables
{
  "sort": [CustomerSortInput],
  "filter": CustomerFilterInput,
  "first": 123,
  "before": "abc123",
  "after": "abc123",
  "last": 123
}
Response
{
  "data": {
    "listCustomers": {
      "count": 987,
      "results": [Customer],
      "startKeyset": "abc123",
      "endKeyset": "xyz789"
    }
  }
}
Queries

listLots

Response

Returns a KeysetPageOfLot

Arguments
Name Description
sort - [LotSortInput] How to sort the records in the response
filter - LotFilterInput A filter to limit the results
first - Int The number of records to return from the beginning. Maximum 250
before - String Show records before the specified keyset.
after - String Show records after the specified keyset.
last - Int The number of records to return to the end. Maximum 250

Example

Query
query listLots(
  $sort: [LotSortInput],
  $filter: LotFilterInput,
  $first: Int,
  $before: String,
  $after: String,
  $last: Int
) {
  listLots(
    sort: $sort,
    filter: $filter,
    first: $first,
    before: $before,
    after: $after,
    last: $last
  ) {
    count
    results {
      ...LotFragment
    }
    startKeyset
    endKeyset
  }
}
Variables
{
  "sort": [LotSortInput],
  "filter": LotFilterInput,
  "first": 987,
  "before": "abc123",
  "after": "abc123",
  "last": 987
}
Response
{
  "data": {
    "listLots": {
      "count": 123,
      "results": [Lot],
      "startKeyset": "abc123",
      "endKeyset": "abc123"
    }
  }
}
Queries

listMaterials

Response

Returns a KeysetPageOfMaterial

Arguments
Name Description
sort - [MaterialSortInput] How to sort the records in the response
filter - MaterialFilterInput A filter to limit the results
first - Int The number of records to return from the beginning. Maximum 250
before - String Show records before the specified keyset.
after - String Show records after the specified keyset.
last - Int The number of records to return to the end. Maximum 250

Example

Query
query listMaterials(
  $sort: [MaterialSortInput],
  $filter: MaterialFilterInput,
  $first: Int,
  $before: String,
  $after: String,
  $last: Int
) {
  listMaterials(
    sort: $sort,
    filter: $filter,
    first: $first,
    before: $before,
    after: $after,
    last: $last
  ) {
    count
    results {
      ...MaterialFragment
    }
    startKeyset
    endKeyset
  }
}
Variables
{
  "sort": [MaterialSortInput],
  "filter": MaterialFilterInput,
  "first": 123,
  "before": "xyz789",
  "after": "xyz789",
  "last": 123
}
Response
{
  "data": {
    "listMaterials": {
      "count": 123,
      "results": [Material],
      "startKeyset": "xyz789",
      "endKeyset": "abc123"
    }
  }
}
Queries

listMovements

Response

Returns a KeysetPageOfMovement

Arguments
Name Description
sort - [MovementSortInput] How to sort the records in the response
filter - MovementFilterInput A filter to limit the results
first - Int The number of records to return from the beginning. Maximum 250
before - String Show records before the specified keyset.
after - String Show records after the specified keyset.
last - Int The number of records to return to the end. Maximum 250

Example

Query
query listMovements(
  $sort: [MovementSortInput],
  $filter: MovementFilterInput,
  $first: Int,
  $before: String,
  $after: String,
  $last: Int
) {
  listMovements(
    sort: $sort,
    filter: $filter,
    first: $first,
    before: $before,
    after: $after,
    last: $last
  ) {
    count
    results {
      ...MovementFragment
    }
    startKeyset
    endKeyset
  }
}
Variables
{
  "sort": [MovementSortInput],
  "filter": MovementFilterInput,
  "first": 987,
  "before": "abc123",
  "after": "xyz789",
  "last": 987
}
Response
{
  "data": {
    "listMovements": {
      "count": 987,
      "results": [Movement],
      "startKeyset": "xyz789",
      "endKeyset": "abc123"
    }
  }
}
Queries

listOrderItems

Response

Returns a KeysetPageOfOrderItem

Arguments
Name Description
sort - [OrderItemSortInput] How to sort the records in the response
filter - OrderItemFilterInput A filter to limit the results
first - Int The number of records to return from the beginning. Maximum 250
before - String Show records before the specified keyset.
after - String Show records after the specified keyset.
last - Int The number of records to return to the end. Maximum 250

Example

Query
query listOrderItems(
  $sort: [OrderItemSortInput],
  $filter: OrderItemFilterInput,
  $first: Int,
  $before: String,
  $after: String,
  $last: Int
) {
  listOrderItems(
    sort: $sort,
    filter: $filter,
    first: $first,
    before: $before,
    after: $after,
    last: $last
  ) {
    count
    results {
      ...OrderItemFragment
    }
    startKeyset
    endKeyset
  }
}
Variables
{
  "sort": [OrderItemSortInput],
  "filter": OrderItemFilterInput,
  "first": 123,
  "before": "xyz789",
  "after": "xyz789",
  "last": 123
}
Response
{
  "data": {
    "listOrderItems": {
      "count": 123,
      "results": [OrderItem],
      "startKeyset": "xyz789",
      "endKeyset": "xyz789"
    }
  }
}
Queries

listOrders

Response

Returns a KeysetPageOfOrder

Arguments
Name Description
sort - [OrderSortInput] How to sort the records in the response
filter - OrderFilterInput A filter to limit the results
first - Int The number of records to return from the beginning. Maximum 250
before - String Show records before the specified keyset.
after - String Show records after the specified keyset.
last - Int The number of records to return to the end. Maximum 250
status - [String!]
paymentStatus - [String!]
deliveryDateStart - DateTime
deliveryDateEnd - DateTime
customerName - String
productId - ID

Example

Query
query listOrders(
  $sort: [OrderSortInput],
  $filter: OrderFilterInput,
  $first: Int,
  $before: String,
  $after: String,
  $last: Int,
  $status: [String!],
  $paymentStatus: [String!],
  $deliveryDateStart: DateTime,
  $deliveryDateEnd: DateTime,
  $customerName: String,
  $productId: ID
) {
  listOrders(
    sort: $sort,
    filter: $filter,
    first: $first,
    before: $before,
    after: $after,
    last: $last,
    status: $status,
    paymentStatus: $paymentStatus,
    deliveryDateStart: $deliveryDateStart,
    deliveryDateEnd: $deliveryDateEnd,
    customerName: $customerName,
    productId: $productId
  ) {
    count
    results {
      ...OrderFragment
    }
    startKeyset
    endKeyset
  }
}
Variables
{
  "sort": [OrderSortInput],
  "filter": OrderFilterInput,
  "first": 987,
  "before": "xyz789",
  "after": "abc123",
  "last": 987,
  "status": ["abc123"],
  "paymentStatus": ["abc123"],
  "deliveryDateStart": "2007-12-03T10:15:30Z",
  "deliveryDateEnd": "2007-12-03T10:15:30Z",
  "customerName": "abc123",
  "productId": "4"
}
Response
{
  "data": {
    "listOrders": {
      "count": 123,
      "results": [Order],
      "startKeyset": "abc123",
      "endKeyset": "abc123"
    }
  }
}
Queries

listProductionBatches

Response

Returns a KeysetPageOfProductionBatch

Arguments
Name Description
sort - [ProductionBatchSortInput] How to sort the records in the response
filter - ProductionBatchFilterInput A filter to limit the results
first - Int The number of records to return from the beginning. Maximum 250
before - String Show records before the specified keyset.
after - String Show records after the specified keyset.
last - Int The number of records to return to the end. Maximum 250

Example

Query
query listProductionBatches(
  $sort: [ProductionBatchSortInput],
  $filter: ProductionBatchFilterInput,
  $first: Int,
  $before: String,
  $after: String,
  $last: Int
) {
  listProductionBatches(
    sort: $sort,
    filter: $filter,
    first: $first,
    before: $before,
    after: $after,
    last: $last
  ) {
    count
    results {
      ...ProductionBatchFragment
    }
    startKeyset
    endKeyset
  }
}
Variables
{
  "sort": [ProductionBatchSortInput],
  "filter": ProductionBatchFilterInput,
  "first": 987,
  "before": "abc123",
  "after": "abc123",
  "last": 123
}
Response
{
  "data": {
    "listProductionBatches": {
      "count": 123,
      "results": [ProductionBatch],
      "startKeyset": "xyz789",
      "endKeyset": "xyz789"
    }
  }
}
Queries

listProducts

Response

Returns a KeysetPageOfProduct

Arguments
Name Description
sort - [ProductSortInput] How to sort the records in the response
filter - ProductFilterInput A filter to limit the results
first - Int The number of records to return from the beginning. Maximum 250
before - String Show records before the specified keyset.
after - String Show records after the specified keyset.
last - Int The number of records to return to the end. Maximum 250
status - [String!]

Example

Query
query listProducts(
  $sort: [ProductSortInput],
  $filter: ProductFilterInput,
  $first: Int,
  $before: String,
  $after: String,
  $last: Int,
  $status: [String!]
) {
  listProducts(
    sort: $sort,
    filter: $filter,
    first: $first,
    before: $before,
    after: $after,
    last: $last,
    status: $status
  ) {
    count
    results {
      ...ProductFragment
    }
    startKeyset
    endKeyset
  }
}
Variables
{
  "sort": [ProductSortInput],
  "filter": ProductFilterInput,
  "first": 123,
  "before": "xyz789",
  "after": "abc123",
  "last": 987,
  "status": ["abc123"]
}
Response
{
  "data": {
    "listProducts": {
      "count": 123,
      "results": [Product],
      "startKeyset": "xyz789",
      "endKeyset": "abc123"
    }
  }
}
Queries

listPurchaseOrders

Response

Returns [PurchaseOrder!]!

Arguments
Name Description
sort - [PurchaseOrderSortInput] How to sort the records in the response
filter - PurchaseOrderFilterInput A filter to limit the results

Example

Query
query listPurchaseOrders(
  $sort: [PurchaseOrderSortInput],
  $filter: PurchaseOrderFilterInput
) {
  listPurchaseOrders(
    sort: $sort,
    filter: $filter
  ) {
    id
  }
}
Variables
{
  "sort": [PurchaseOrderSortInput],
  "filter": PurchaseOrderFilterInput
}
Response
{"data": {"listPurchaseOrders": [{"id": 4}]}}
Queries

listSuppliers

Response

Returns [Supplier!]!

Arguments
Name Description
sort - [SupplierSortInput] How to sort the records in the response
filter - SupplierFilterInput A filter to limit the results

Example

Query
query listSuppliers(
  $sort: [SupplierSortInput],
  $filter: SupplierFilterInput
) {
  listSuppliers(
    sort: $sort,
    filter: $filter
  ) {
    id
  }
}
Variables
{
  "sort": [SupplierSortInput],
  "filter": SupplierFilterInput
}
Response
{"data": {"listSuppliers": [{"id": 4}]}}

Mutations

createCustomer

Response

Returns a CreateCustomerResult!

Arguments
Name Description
input - CreateCustomerInput!

Example

Query
mutation createCustomer($input: CreateCustomerInput!) {
  createCustomer(input: $input) {
    result {
      ...CustomerFragment
    }
    errors {
      ...MutationErrorFragment
    }
  }
}
Variables
{"input": CreateCustomerInput}
Response
{
  "data": {
    "createCustomer": {
      "result": Customer,
      "errors": [MutationError]
    }
  }
}
Mutations

createMaterial

Response

Returns a CreateMaterialResult!

Arguments
Name Description
input - CreateMaterialInput!

Example

Query
mutation createMaterial($input: CreateMaterialInput!) {
  createMaterial(input: $input) {
    result {
      ...MaterialFragment
    }
    errors {
      ...MutationErrorFragment
    }
  }
}
Variables
{"input": CreateMaterialInput}
Response
{
  "data": {
    "createMaterial": {
      "result": Material,
      "errors": [MutationError]
    }
  }
}
Mutations

createOrder

Response

Returns a CreateOrderResult!

Arguments
Name Description
input - CreateOrderInput!

Example

Query
mutation createOrder($input: CreateOrderInput!) {
  createOrder(input: $input) {
    result {
      ...OrderFragment
    }
    errors {
      ...MutationErrorFragment
    }
  }
}
Variables
{"input": CreateOrderInput}
Response
{
  "data": {
    "createOrder": {
      "result": Order,
      "errors": [MutationError]
    }
  }
}
Mutations

createOrderItem

Response

Returns a CreateOrderItemResult!

Arguments
Name Description
input - CreateOrderItemInput!

Example

Query
mutation createOrderItem($input: CreateOrderItemInput!) {
  createOrderItem(input: $input) {
    result {
      ...OrderItemFragment
    }
    errors {
      ...MutationErrorFragment
    }
  }
}
Variables
{"input": CreateOrderItemInput}
Response
{
  "data": {
    "createOrderItem": {
      "result": OrderItem,
      "errors": [MutationError]
    }
  }
}
Mutations

createProduct

Response

Returns a CreateProductResult!

Arguments
Name Description
input - CreateProductInput!

Example

Query
mutation createProduct($input: CreateProductInput!) {
  createProduct(input: $input) {
    result {
      ...ProductFragment
    }
    errors {
      ...MutationErrorFragment
    }
  }
}
Variables
{"input": CreateProductInput}
Response
{
  "data": {
    "createProduct": {
      "result": Product,
      "errors": [MutationError]
    }
  }
}
Mutations

createPurchaseOrder

Response

Returns a CreatePurchaseOrderResult!

Arguments
Name Description
input - CreatePurchaseOrderInput!

Example

Query
mutation createPurchaseOrder($input: CreatePurchaseOrderInput!) {
  createPurchaseOrder(input: $input) {
    result {
      ...PurchaseOrderFragment
    }
    errors {
      ...MutationErrorFragment
    }
  }
}
Variables
{"input": CreatePurchaseOrderInput}
Response
{
  "data": {
    "createPurchaseOrder": {
      "result": PurchaseOrder,
      "errors": [MutationError]
    }
  }
}
Mutations

createSupplier

Response

Returns a CreateSupplierResult!

Arguments
Name Description
input - CreateSupplierInput!

Example

Query
mutation createSupplier($input: CreateSupplierInput!) {
  createSupplier(input: $input) {
    result {
      ...SupplierFragment
    }
    errors {
      ...MutationErrorFragment
    }
  }
}
Variables
{"input": CreateSupplierInput}
Response
{
  "data": {
    "createSupplier": {
      "result": Supplier,
      "errors": [MutationError]
    }
  }
}
Mutations

destroyCustomer

Response

Returns a DestroyCustomerResult!

Arguments
Name Description
id - ID!

Example

Query
mutation destroyCustomer($id: ID!) {
  destroyCustomer(id: $id) {
    result {
      ...CustomerFragment
    }
    errors {
      ...MutationErrorFragment
    }
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "destroyCustomer": {
      "result": Customer,
      "errors": [MutationError]
    }
  }
}
Mutations

destroyProduct

Response

Returns a DestroyProductResult!

Arguments
Name Description
id - ID!

Example

Query
mutation destroyProduct($id: ID!) {
  destroyProduct(id: $id) {
    result {
      ...ProductFragment
    }
    errors {
      ...MutationErrorFragment
    }
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "destroyProduct": {
      "result": Product,
      "errors": [MutationError]
    }
  }
}
Mutations

updateCustomer

Response

Returns an UpdateCustomerResult!

Arguments
Name Description
id - ID!
input - UpdateCustomerInput

Example

Query
mutation updateCustomer(
  $id: ID!,
  $input: UpdateCustomerInput
) {
  updateCustomer(
    id: $id,
    input: $input
  ) {
    result {
      ...CustomerFragment
    }
    errors {
      ...MutationErrorFragment
    }
  }
}
Variables
{
  "id": "4",
  "input": UpdateCustomerInput
}
Response
{
  "data": {
    "updateCustomer": {
      "result": Customer,
      "errors": [MutationError]
    }
  }
}
Mutations

updateMaterial

Response

Returns an UpdateMaterialResult!

Arguments
Name Description
id - ID!
input - UpdateMaterialInput

Example

Query
mutation updateMaterial(
  $id: ID!,
  $input: UpdateMaterialInput
) {
  updateMaterial(
    id: $id,
    input: $input
  ) {
    result {
      ...MaterialFragment
    }
    errors {
      ...MutationErrorFragment
    }
  }
}
Variables
{
  "id": "4",
  "input": UpdateMaterialInput
}
Response
{
  "data": {
    "updateMaterial": {
      "result": Material,
      "errors": [MutationError]
    }
  }
}
Mutations

updateOrder

Response

Returns an UpdateOrderResult!

Arguments
Name Description
id - ID!
input - UpdateOrderInput

Example

Query
mutation updateOrder(
  $id: ID!,
  $input: UpdateOrderInput
) {
  updateOrder(
    id: $id,
    input: $input
  ) {
    result {
      ...OrderFragment
    }
    errors {
      ...MutationErrorFragment
    }
  }
}
Variables
{
  "id": "4",
  "input": UpdateOrderInput
}
Response
{
  "data": {
    "updateOrder": {
      "result": Order,
      "errors": [MutationError]
    }
  }
}
Mutations

updateOrderItem

Response

Returns an UpdateOrderItemResult!

Arguments
Name Description
id - ID!
input - UpdateOrderItemInput

Example

Query
mutation updateOrderItem(
  $id: ID!,
  $input: UpdateOrderItemInput
) {
  updateOrderItem(
    id: $id,
    input: $input
  ) {
    result {
      ...OrderItemFragment
    }
    errors {
      ...MutationErrorFragment
    }
  }
}
Variables
{
  "id": "4",
  "input": UpdateOrderItemInput
}
Response
{
  "data": {
    "updateOrderItem": {
      "result": OrderItem,
      "errors": [MutationError]
    }
  }
}
Mutations

updateProduct

Response

Returns an UpdateProductResult!

Arguments
Name Description
id - ID!
input - UpdateProductInput

Example

Query
mutation updateProduct(
  $id: ID!,
  $input: UpdateProductInput
) {
  updateProduct(
    id: $id,
    input: $input
  ) {
    result {
      ...ProductFragment
    }
    errors {
      ...MutationErrorFragment
    }
  }
}
Variables
{
  "id": "4",
  "input": UpdateProductInput
}
Response
{
  "data": {
    "updateProduct": {
      "result": Product,
      "errors": [MutationError]
    }
  }
}
Mutations

updatePurchaseOrder

Response

Returns an UpdatePurchaseOrderResult!

Arguments
Name Description
id - ID!
input - UpdatePurchaseOrderInput

Example

Query
mutation updatePurchaseOrder(
  $id: ID!,
  $input: UpdatePurchaseOrderInput
) {
  updatePurchaseOrder(
    id: $id,
    input: $input
  ) {
    result {
      ...PurchaseOrderFragment
    }
    errors {
      ...MutationErrorFragment
    }
  }
}
Variables
{
  "id": "4",
  "input": UpdatePurchaseOrderInput
}
Response
{
  "data": {
    "updatePurchaseOrder": {
      "result": PurchaseOrder,
      "errors": [MutationError]
    }
  }
}
Mutations

updateSupplier

Response

Returns an UpdateSupplierResult!

Arguments
Name Description
id - ID!
input - UpdateSupplierInput

Example

Query
mutation updateSupplier(
  $id: ID!,
  $input: UpdateSupplierInput
) {
  updateSupplier(
    id: $id,
    input: $input
  ) {
    result {
      ...SupplierFragment
    }
    errors {
      ...MutationErrorFragment
    }
  }
}
Variables
{"id": 4, "input": UpdateSupplierInput}
Response
{
  "data": {
    "updateSupplier": {
      "result": Supplier,
      "errors": [MutationError]
    }
  }
}

Types

Bom

Fields
Field Name Description
id - ID!
name - String
notes - String
status - String!
Example
{
  "id": 4,
  "name": "xyz789",
  "notes": "xyz789",
  "status": "xyz789"
}
Types

BomComponent

Fields
Field Name Description
id - ID!
Example
{"id": "4"}
Types

BomComponentFilterId

Fields
Input Field Description
isNil - Boolean
eq - ID
notEq - ID
in - [ID!]
lessThan - ID
greaterThan - ID
lessThanOrEqual - ID
greaterThanOrEqual - ID
Example
{
  "isNil": true,
  "eq": "4",
  "notEq": 4,
  "in": [4],
  "lessThan": "4",
  "greaterThan": 4,
  "lessThanOrEqual": 4,
  "greaterThanOrEqual": "4"
}
Types

BomComponentFilterInput

Fields
Input Field Description
and - [BomComponentFilterInput!]
or - [BomComponentFilterInput!]
not - [BomComponentFilterInput!]
id - BomComponentFilterId
Example
{
  "and": [BomComponentFilterInput],
  "or": [BomComponentFilterInput],
  "not": [BomComponentFilterInput],
  "id": BomComponentFilterId
}
Types

BomComponentSortField

Values
Enum Value Description

ID
Example
"ID"
Types

BomComponentSortInput

Fields
Input Field Description
order - SortOrder
field - BomComponentSortField!
Example
{"order": "DESC", "field": "ID"}
Types

BomFilterId

Fields
Input Field Description
isNil - Boolean
eq - ID
notEq - ID
in - [ID!]
lessThan - ID
greaterThan - ID
lessThanOrEqual - ID
greaterThanOrEqual - ID
Example
{
  "isNil": false,
  "eq": 4,
  "notEq": "4",
  "in": [4],
  "lessThan": "4",
  "greaterThan": 4,
  "lessThanOrEqual": 4,
  "greaterThanOrEqual": 4
}
Types

BomFilterInput

Fields
Input Field Description
and - [BomFilterInput!]
or - [BomFilterInput!]
not - [BomFilterInput!]
id - BomFilterId
name - BomFilterName
notes - BomFilterNotes
status - BomFilterStatus
Example
{
  "and": [BomFilterInput],
  "or": [BomFilterInput],
  "not": [BomFilterInput],
  "id": BomFilterId,
  "name": BomFilterName,
  "notes": BomFilterNotes,
  "status": BomFilterStatus
}
Types

BomFilterName

Fields
Input Field Description
isNil - Boolean
eq - String
notEq - String
in - [String]
lessThan - String
greaterThan - String
lessThanOrEqual - String
greaterThanOrEqual - String
like - String
ilike - String
Example
{
  "isNil": false,
  "eq": "abc123",
  "notEq": "xyz789",
  "in": ["abc123"],
  "lessThan": "abc123",
  "greaterThan": "xyz789",
  "lessThanOrEqual": "abc123",
  "greaterThanOrEqual": "xyz789",
  "like": "abc123",
  "ilike": "xyz789"
}
Types

BomFilterNotes

Fields
Input Field Description
isNil - Boolean
eq - String
notEq - String
in - [String]
lessThan - String
greaterThan - String
lessThanOrEqual - String
greaterThanOrEqual - String
like - String
ilike - String
Example
{
  "isNil": false,
  "eq": "xyz789",
  "notEq": "abc123",
  "in": ["xyz789"],
  "lessThan": "abc123",
  "greaterThan": "xyz789",
  "lessThanOrEqual": "abc123",
  "greaterThanOrEqual": "abc123",
  "like": "abc123",
  "ilike": "abc123"
}
Types

BomFilterStatus

Fields
Input Field Description
isNil - Boolean
eq - String
notEq - String
in - [String!]
lessThan - String
greaterThan - String
lessThanOrEqual - String
greaterThanOrEqual - String
Example
{
  "isNil": false,
  "eq": "xyz789",
  "notEq": "xyz789",
  "in": ["xyz789"],
  "lessThan": "xyz789",
  "greaterThan": "xyz789",
  "lessThanOrEqual": "xyz789",
  "greaterThanOrEqual": "abc123"
}
Types

BomSortField

Values
Enum Value Description

ID

NAME

NOTES

STATUS
Example
"ID"
Types

BomSortInput

Fields
Input Field Description
order - SortOrder
field - BomSortField!
Example
{"order": "DESC", "field": "ID"}
Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

CreateCustomerInput

Fields
Input Field Description
type - String!
firstName - String!
lastName - String!
email - String
phone - String
billingAddress - JsonString
shippingAddress - JsonString
Example
{
  "type": "xyz789",
  "firstName": "abc123",
  "lastName": "abc123",
  "email": "abc123",
  "phone": "abc123",
  "billingAddress": JsonString,
  "shippingAddress": JsonString
}
Types

CreateCustomerResult

Description

The result of the :create_customer mutation

Fields
Field Name Description
result - Customer The successful result of the mutation
errors - [MutationError!]! Any errors generated, if the mutation failed
Example
{
  "result": Customer,
  "errors": [MutationError]
}
Types

CreateMaterialInput

Fields
Input Field Description
name - String!
sku - String!
unit - String!
price - Decimal!
minimumStock - Decimal
maximumStock - Decimal
Example
{
  "name": "xyz789",
  "sku": "abc123",
  "unit": "abc123",
  "price": Decimal,
  "minimumStock": Decimal,
  "maximumStock": Decimal
}
Types

CreateMaterialResult

Description

The result of the :create_material mutation

Fields
Field Name Description
result - Material The successful result of the mutation
errors - [MutationError!]! Any errors generated, if the mutation failed
Example
{
  "result": Material,
  "errors": [MutationError]
}
Types

CreateOrderInput

Fields
Input Field Description
deliveryDate - DateTime!
invoiceNumber - String
invoiceStatus - String
invoicedAt - DateTime
paymentMethod - String
discountType - String
discountValue - Decimal
deliveryMethod - String
status - String
customerId - ID!
items - [OrderCreateItemsInput!]
Example
{
  "deliveryDate": "2007-12-03T10:15:30Z",
  "invoiceNumber": "xyz789",
  "invoiceStatus": "xyz789",
  "invoicedAt": "2007-12-03T10:15:30Z",
  "paymentMethod": "xyz789",
  "discountType": "xyz789",
  "discountValue": Decimal,
  "deliveryMethod": "xyz789",
  "status": "abc123",
  "customerId": "4",
  "items": [OrderCreateItemsInput]
}
Types

CreateOrderItemInput

Fields
Input Field Description
unitPrice - Decimal!
quantity - Decimal!
status - String
productId - ID!
Example
{
  "unitPrice": Decimal,
  "quantity": Decimal,
  "status": "xyz789",
  "productId": "4"
}
Types

CreateOrderItemResult

Description

The result of the :create_order_item mutation

Fields
Field Name Description
result - OrderItem The successful result of the mutation
errors - [MutationError!]! Any errors generated, if the mutation failed
Example
{
  "result": OrderItem,
  "errors": [MutationError]
}
Types

CreateOrderResult

Description

The result of the :create_order mutation

Fields
Field Name Description
result - Order The successful result of the mutation
errors - [MutationError!]! Any errors generated, if the mutation failed
Example
{
  "result": Order,
  "errors": [MutationError]
}
Types

CreateProductInput

Fields
Input Field Description
name - String!
status - String
price - Decimal!
sku - String!
photos - [String!] Array of photo URLs for the product
featuredPhoto - String ID or reference to the featured photo from the photos array
sellingAvailability - String Customer-facing availability: available, preorder, or off
maxDailyQuantity - Int Optional per-product capacity per day (0 = unlimited)
Example
{
  "name": "xyz789",
  "status": "abc123",
  "price": Decimal,
  "sku": "xyz789",
  "photos": ["abc123"],
  "featuredPhoto": "abc123",
  "sellingAvailability": "abc123",
  "maxDailyQuantity": 987
}
Types

CreateProductResult

Description

The result of the :create_product mutation

Fields
Field Name Description
result - Product The successful result of the mutation
errors - [MutationError!]! Any errors generated, if the mutation failed
Example
{
  "result": Product,
  "errors": [MutationError]
}
Types

CreatePurchaseOrderInput

Fields
Input Field Description
status - String
orderedAt - DateTime
supplierId - ID!
Example
{
  "status": "abc123",
  "orderedAt": "2007-12-03T10:15:30Z",
  "supplierId": "4"
}
Types

CreatePurchaseOrderResult

Description

The result of the :create_purchase_order mutation

Fields
Field Name Description
result - PurchaseOrder The successful result of the mutation
errors - [MutationError!]! Any errors generated, if the mutation failed
Example
{
  "result": PurchaseOrder,
  "errors": [MutationError]
}
Types

CreateSupplierInput

Fields
Input Field Description
name - String!
contactName - String
contactEmail - String
contactPhone - String
notes - String
Example
{
  "name": "xyz789",
  "contactName": "abc123",
  "contactEmail": "abc123",
  "contactPhone": "xyz789",
  "notes": "xyz789"
}
Types

CreateSupplierResult

Description

The result of the :create_supplier mutation

Fields
Field Name Description
result - Supplier The successful result of the mutation
errors - [MutationError!]! Any errors generated, if the mutation failed
Example
{
  "result": Supplier,
  "errors": [MutationError]
}
Types

Customer

Fields
Field Name Description
id - ID!
type - String!
firstName - String!
lastName - String!
email - String
phone - String
billingAddress - JsonString
shippingAddress - JsonString
Example
{
  "id": "4",
  "type": "xyz789",
  "firstName": "xyz789",
  "lastName": "xyz789",
  "email": "abc123",
  "phone": "abc123",
  "billingAddress": JsonString,
  "shippingAddress": JsonString
}
Types

CustomerFilterEmail

Fields
Input Field Description
isNil - Boolean
eq - String
notEq - String
in - [String]
lessThan - String
greaterThan - String
lessThanOrEqual - String
greaterThanOrEqual - String
like - String
ilike - String
Example
{
  "isNil": false,
  "eq": "abc123",
  "notEq": "xyz789",
  "in": ["xyz789"],
  "lessThan": "abc123",
  "greaterThan": "abc123",
  "lessThanOrEqual": "abc123",
  "greaterThanOrEqual": "abc123",
  "like": "xyz789",
  "ilike": "xyz789"
}
Types

CustomerFilterFirstName

Fields
Input Field Description
isNil - Boolean
eq - String
notEq - String
in - [String!]
lessThan - String
greaterThan - String
lessThanOrEqual - String
greaterThanOrEqual - String
like - String
ilike - String
Example
{
  "isNil": true,
  "eq": "xyz789",
  "notEq": "abc123",
  "in": ["abc123"],
  "lessThan": "xyz789",
  "greaterThan": "abc123",
  "lessThanOrEqual": "abc123",
  "greaterThanOrEqual": "abc123",
  "like": "abc123",
  "ilike": "abc123"
}
Types

CustomerFilterId

Fields
Input Field Description
isNil - Boolean
eq - ID
notEq - ID
in - [ID!]
lessThan - ID
greaterThan - ID
lessThanOrEqual - ID
greaterThanOrEqual - ID
Example
{
  "isNil": true,
  "eq": "4",
  "notEq": "4",
  "in": [4],
  "lessThan": "4",
  "greaterThan": "4",
  "lessThanOrEqual": "4",
  "greaterThanOrEqual": "4"
}
Types

CustomerFilterInput

Fields
Input Field Description
and - [CustomerFilterInput!]
or - [CustomerFilterInput!]
not - [CustomerFilterInput!]
id - CustomerFilterId
type - CustomerFilterType
firstName - CustomerFilterFirstName
lastName - CustomerFilterLastName
email - CustomerFilterEmail
phone - CustomerFilterPhone
Example
{
  "and": [CustomerFilterInput],
  "or": [CustomerFilterInput],
  "not": [CustomerFilterInput],
  "id": CustomerFilterId,
  "type": CustomerFilterType,
  "firstName": CustomerFilterFirstName,
  "lastName": CustomerFilterLastName,
  "email": CustomerFilterEmail,
  "phone": CustomerFilterPhone
}
Types

CustomerFilterLastName

Fields
Input Field Description
isNil - Boolean
eq - String
notEq - String
in - [String!]
lessThan - String
greaterThan - String
lessThanOrEqual - String
greaterThanOrEqual - String
like - String
ilike - String
Example
{
  "isNil": false,
  "eq": "xyz789",
  "notEq": "xyz789",
  "in": ["abc123"],
  "lessThan": "xyz789",
  "greaterThan": "xyz789",
  "lessThanOrEqual": "xyz789",
  "greaterThanOrEqual": "abc123",
  "like": "xyz789",
  "ilike": "xyz789"
}
Types

CustomerFilterPhone

Fields
Input Field Description
isNil - Boolean
eq - String
notEq - String
in - [String]
lessThan - String
greaterThan - String
lessThanOrEqual - String
greaterThanOrEqual - String
like - String
ilike - String
Example
{
  "isNil": false,
  "eq": "xyz789",
  "notEq": "xyz789",
  "in": ["abc123"],
  "lessThan": "xyz789",
  "greaterThan": "xyz789",
  "lessThanOrEqual": "xyz789",
  "greaterThanOrEqual": "abc123",
  "like": "abc123",
  "ilike": "abc123"
}
Types

CustomerFilterType

Fields
Input Field Description
isNil - Boolean
eq - String
notEq - String
in - [String!]
lessThan - String
greaterThan - String
lessThanOrEqual - String
greaterThanOrEqual - String
Example
{
  "isNil": true,
  "eq": "xyz789",
  "notEq": "xyz789",
  "in": ["xyz789"],
  "lessThan": "xyz789",
  "greaterThan": "xyz789",
  "lessThanOrEqual": "abc123",
  "greaterThanOrEqual": "abc123"
}
Types

CustomerSortField

Values
Enum Value Description

ID

TYPE

FIRST_NAME

LAST_NAME

EMAIL

PHONE
Example
"ID"
Types

CustomerSortInput

Fields
Input Field Description
order - SortOrder
field - CustomerSortField!
Example
{"order": "DESC", "field": "ID"}
Types

DateTime

Description

The DateTime scalar type represents a date and time in the UTC timezone. The DateTime appears in a JSON response as an ISO8601 formatted string, including UTC timezone ("Z"). The parsed date and time string will be converted to UTC if there is an offset.

Example
"2007-12-03T10:15:30Z"
Types

Decimal

Description

The Decimal scalar type represents signed double-precision fractional values parsed by the Decimal library. The Decimal appears in a JSON response as a string to preserve precision.

Example
Decimal
Types

DestroyCustomerResult

Description

The result of the :destroy_customer mutation

Fields
Field Name Description
result - Customer The record that was successfully deleted
errors - [MutationError!]! Any errors generated, if the mutation failed
Example
{
  "result": Customer,
  "errors": [MutationError]
}
Types

DestroyProductResult

Description

The result of the :destroy_product mutation

Fields
Field Name Description
result - Product The record that was successfully deleted
errors - [MutationError!]! Any errors generated, if the mutation failed
Example
{
  "result": Product,
  "errors": [MutationError]
}
Types

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
Types

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
987
Types

Json

Description

The Json scalar type represents arbitrary json string data, represented as UTF-8 character sequences. The Json type is most often used to represent a free-form human-readable json string.

Example
Json
Types

JsonString

Description

The Json scalar type represents arbitrary json string data, represented as UTF-8 character sequences. The Json type is most often used to represent a free-form human-readable json string.

Example
JsonString
Types

KeysetPageOfBomComponent

Description

A keyset page of :bom_component

Fields
Field Name Description
count - Int Total count on all pages
results - [BomComponent!] The records contained in the page
startKeyset - String The first keyset in the results
endKeyset - String The last keyset in the results
Example
{
  "count": 123,
  "results": [BomComponent],
  "startKeyset": "abc123",
  "endKeyset": "xyz789"
}
Types

KeysetPageOfCustomer

Description

A keyset page of :customer

Fields
Field Name Description
count - Int Total count on all pages
results - [Customer!] The records contained in the page
startKeyset - String The first keyset in the results
endKeyset - String The last keyset in the results
Example
{
  "count": 987,
  "results": [Customer],
  "startKeyset": "abc123",
  "endKeyset": "xyz789"
}
Types

KeysetPageOfLot

Description

A keyset page of :lot

Fields
Field Name Description
count - Int Total count on all pages
results - [Lot!] The records contained in the page
startKeyset - String The first keyset in the results
endKeyset - String The last keyset in the results
Example
{
  "count": 987,
  "results": [Lot],
  "startKeyset": "xyz789",
  "endKeyset": "xyz789"
}
Types

KeysetPageOfMaterial

Description

A keyset page of :material

Fields
Field Name Description
count - Int Total count on all pages
results - [Material!] The records contained in the page
startKeyset - String The first keyset in the results
endKeyset - String The last keyset in the results
Example
{
  "count": 987,
  "results": [Material],
  "startKeyset": "xyz789",
  "endKeyset": "abc123"
}
Types

KeysetPageOfMovement

Description

A keyset page of :movement

Fields
Field Name Description
count - Int Total count on all pages
results - [Movement!] The records contained in the page
startKeyset - String The first keyset in the results
endKeyset - String The last keyset in the results
Example
{
  "count": 987,
  "results": [Movement],
  "startKeyset": "xyz789",
  "endKeyset": "abc123"
}
Types

KeysetPageOfOrder

Description

A keyset page of :order

Fields
Field Name Description
count - Int Total count on all pages
results - [Order!] The records contained in the page
startKeyset - String The first keyset in the results
endKeyset - String The last keyset in the results
Example
{
  "count": 987,
  "results": [Order],
  "startKeyset": "abc123",
  "endKeyset": "xyz789"
}
Types

KeysetPageOfOrderItem

Description

A keyset page of :order_item

Fields
Field Name Description
count - Int Total count on all pages
results - [OrderItem!] The records contained in the page
startKeyset - String The first keyset in the results
endKeyset - String The last keyset in the results
Example
{
  "count": 987,
  "results": [OrderItem],
  "startKeyset": "abc123",
  "endKeyset": "xyz789"
}
Types

KeysetPageOfProduct

Description

A keyset page of :product

Fields
Field Name Description
count - Int Total count on all pages
results - [Product!] The records contained in the page
startKeyset - String The first keyset in the results
endKeyset - String The last keyset in the results
Example
{
  "count": 987,
  "results": [Product],
  "startKeyset": "abc123",
  "endKeyset": "xyz789"
}
Types

KeysetPageOfProductionBatch

Description

A keyset page of :production_batch

Fields
Field Name Description
count - Int Total count on all pages
results - [ProductionBatch!] The records contained in the page
startKeyset - String The first keyset in the results
endKeyset - String The last keyset in the results
Example
{
  "count": 123,
  "results": [ProductionBatch],
  "startKeyset": "abc123",
  "endKeyset": "abc123"
}
Types

Lot

Fields
Field Name Description
id - ID!
Example
{"id": "4"}
Types

LotFilterId

Fields
Input Field Description
isNil - Boolean
eq - ID
notEq - ID
in - [ID!]
lessThan - ID
greaterThan - ID
lessThanOrEqual - ID
greaterThanOrEqual - ID
Example
{
  "isNil": true,
  "eq": "4",
  "notEq": "4",
  "in": ["4"],
  "lessThan": 4,
  "greaterThan": 4,
  "lessThanOrEqual": "4",
  "greaterThanOrEqual": "4"
}
Types

LotFilterInput

Fields
Input Field Description
and - [LotFilterInput!]
or - [LotFilterInput!]
not - [LotFilterInput!]
id - LotFilterId
Example
{
  "and": [LotFilterInput],
  "or": [LotFilterInput],
  "not": [LotFilterInput],
  "id": LotFilterId
}
Types

LotSortField

Values
Enum Value Description

ID
Example
"ID"
Types

LotSortInput

Fields
Input Field Description
order - SortOrder
field - LotSortField!
Example
{"order": "DESC", "field": "ID"}
Types

Material

Fields
Field Name Description
id - ID!
name - String!
sku - String!
unit - String!
price - Decimal!
minimumStock - Decimal
maximumStock - Decimal
Example
{
  "id": "4",
  "name": "xyz789",
  "sku": "abc123",
  "unit": "xyz789",
  "price": Decimal,
  "minimumStock": Decimal,
  "maximumStock": Decimal
}
Types

MaterialFilterId

Fields
Input Field Description
isNil - Boolean
eq - ID
notEq - ID
in - [ID!]
lessThan - ID
greaterThan - ID
lessThanOrEqual - ID
greaterThanOrEqual - ID
Example
{
  "isNil": true,
  "eq": 4,
  "notEq": 4,
  "in": [4],
  "lessThan": "4",
  "greaterThan": "4",
  "lessThanOrEqual": "4",
  "greaterThanOrEqual": 4
}
Types

MaterialFilterInput

Fields
Input Field Description
and - [MaterialFilterInput!]
or - [MaterialFilterInput!]
not - [MaterialFilterInput!]
id - MaterialFilterId
name - MaterialFilterName
sku - MaterialFilterSku
unit - MaterialFilterUnit
price - MaterialFilterPrice
minimumStock - MaterialFilterMinimumStock
maximumStock - MaterialFilterMaximumStock
Example
{
  "and": [MaterialFilterInput],
  "or": [MaterialFilterInput],
  "not": [MaterialFilterInput],
  "id": MaterialFilterId,
  "name": MaterialFilterName,
  "sku": MaterialFilterSku,
  "unit": MaterialFilterUnit,
  "price": MaterialFilterPrice,
  "minimumStock": MaterialFilterMinimumStock,
  "maximumStock": MaterialFilterMaximumStock
}
Types

MaterialFilterMaximumStock

Fields
Input Field Description
isNil - Boolean
eq - Decimal
notEq - Decimal
in - [Decimal]
lessThan - Decimal
greaterThan - Decimal
lessThanOrEqual - Decimal
greaterThanOrEqual - Decimal
Example
{
  "isNil": true,
  "eq": Decimal,
  "notEq": Decimal,
  "in": [Decimal],
  "lessThan": Decimal,
  "greaterThan": Decimal,
  "lessThanOrEqual": Decimal,
  "greaterThanOrEqual": Decimal
}
Types

MaterialFilterMinimumStock

Fields
Input Field Description
isNil - Boolean
eq - Decimal
notEq - Decimal
in - [Decimal]
lessThan - Decimal
greaterThan - Decimal
lessThanOrEqual - Decimal
greaterThanOrEqual - Decimal
Example
{
  "isNil": false,
  "eq": Decimal,
  "notEq": Decimal,
  "in": [Decimal],
  "lessThan": Decimal,
  "greaterThan": Decimal,
  "lessThanOrEqual": Decimal,
  "greaterThanOrEqual": Decimal
}
Types

MaterialFilterName

Fields
Input Field Description
isNil - Boolean
eq - String
notEq - String
in - [String!]
lessThan - String
greaterThan - String
lessThanOrEqual - String
greaterThanOrEqual - String
like - String
ilike - String
Example
{
  "isNil": true,
  "eq": "xyz789",
  "notEq": "abc123",
  "in": ["abc123"],
  "lessThan": "abc123",
  "greaterThan": "xyz789",
  "lessThanOrEqual": "xyz789",
  "greaterThanOrEqual": "abc123",
  "like": "abc123",
  "ilike": "abc123"
}
Types

MaterialFilterPrice

Fields
Input Field Description
isNil - Boolean
eq - Decimal
notEq - Decimal
in - [Decimal!]
lessThan - Decimal
greaterThan - Decimal
lessThanOrEqual - Decimal
greaterThanOrEqual - Decimal
Example
{
  "isNil": false,
  "eq": Decimal,
  "notEq": Decimal,
  "in": [Decimal],
  "lessThan": Decimal,
  "greaterThan": Decimal,
  "lessThanOrEqual": Decimal,
  "greaterThanOrEqual": Decimal
}
Types

MaterialFilterSku

Fields
Input Field Description
isNil - Boolean
eq - String
notEq - String
in - [String!]
lessThan - String
greaterThan - String
lessThanOrEqual - String
greaterThanOrEqual - String
like - String
ilike - String
Example
{
  "isNil": true,
  "eq": "xyz789",
  "notEq": "abc123",
  "in": ["xyz789"],
  "lessThan": "xyz789",
  "greaterThan": "abc123",
  "lessThanOrEqual": "abc123",
  "greaterThanOrEqual": "abc123",
  "like": "abc123",
  "ilike": "abc123"
}
Types

MaterialFilterUnit

Fields
Input Field Description
isNil - Boolean
eq - String
notEq - String
in - [String!]
lessThan - String
greaterThan - String
lessThanOrEqual - String
greaterThanOrEqual - String
Example
{
  "isNil": true,
  "eq": "xyz789",
  "notEq": "xyz789",
  "in": ["abc123"],
  "lessThan": "abc123",
  "greaterThan": "xyz789",
  "lessThanOrEqual": "abc123",
  "greaterThanOrEqual": "abc123"
}
Types

MaterialSortField

Values
Enum Value Description

ID

NAME

SKU

UNIT

PRICE

MINIMUM_STOCK

MAXIMUM_STOCK
Example
"ID"
Types

MaterialSortInput

Fields
Input Field Description
order - SortOrder
field - MaterialSortField!
Example
{"order": "DESC", "field": "ID"}
Types

Movement

Fields
Field Name Description
id - ID!
Example
{"id": 4}
Types

MovementFilterId

Fields
Input Field Description
isNil - Boolean
eq - ID
notEq - ID
in - [ID!]
lessThan - ID
greaterThan - ID
lessThanOrEqual - ID
greaterThanOrEqual - ID
Example
{
  "isNil": true,
  "eq": 4,
  "notEq": "4",
  "in": ["4"],
  "lessThan": 4,
  "greaterThan": "4",
  "lessThanOrEqual": 4,
  "greaterThanOrEqual": "4"
}
Types

MovementFilterInput

Fields
Input Field Description
and - [MovementFilterInput!]
or - [MovementFilterInput!]
not - [MovementFilterInput!]
id - MovementFilterId
Example
{
  "and": [MovementFilterInput],
  "or": [MovementFilterInput],
  "not": [MovementFilterInput],
  "id": MovementFilterId
}
Types

MovementSortField

Values
Enum Value Description

ID
Example
"ID"
Types

MovementSortInput

Fields
Input Field Description
order - SortOrder
field - MovementSortField!
Example
{"order": "DESC", "field": "ID"}
Types

MutationError

Description

An error generated by a failed mutation

Fields
Field Name Description
message - String The human readable error message
shortMessage - String A shorter error message, with vars not replaced
vars - Json Replacements for the short message
code - String An error code for the given error
fields - [String!] The field or fields that produced the error
Example
{
  "message": "abc123",
  "shortMessage": "xyz789",
  "vars": Json,
  "code": "xyz789",
  "fields": ["abc123"]
}
Types

Order

Fields
Field Name Description
id - ID!
Example
{"id": "4"}
Types

OrderCreateItemsInput

Fields
Input Field Description
id - ID
status - String
quantity - Decimal
productId - ID
laborCost - Decimal Labor cost allocated to this order item during batch completion
materialCost - Decimal Material cost allocated to this order item during batch completion
overheadCost - Decimal Overhead cost allocated to this order item during batch completion
unitCost - Decimal Per-unit production cost captured at batch completion
unitPrice - Decimal
consumedAt - DateTime Timestamp indicating materials were consumed for this item
Example
{
  "id": "4",
  "status": "xyz789",
  "quantity": Decimal,
  "productId": "4",
  "laborCost": Decimal,
  "materialCost": Decimal,
  "overheadCost": Decimal,
  "unitCost": Decimal,
  "unitPrice": Decimal,
  "consumedAt": "2007-12-03T10:15:30Z"
}
Types

OrderFilterId

Fields
Input Field Description
isNil - Boolean
eq - ID
notEq - ID
in - [ID!]
lessThan - ID
greaterThan - ID
lessThanOrEqual - ID
greaterThanOrEqual - ID
Example
{
  "isNil": false,
  "eq": 4,
  "notEq": 4,
  "in": ["4"],
  "lessThan": 4,
  "greaterThan": "4",
  "lessThanOrEqual": 4,
  "greaterThanOrEqual": "4"
}
Types

OrderFilterInput

Fields
Input Field Description
and - [OrderFilterInput!]
or - [OrderFilterInput!]
not - [OrderFilterInput!]
id - OrderFilterId
Example
{
  "and": [OrderFilterInput],
  "or": [OrderFilterInput],
  "not": [OrderFilterInput],
  "id": OrderFilterId
}
Types

OrderItem

Fields
Field Name Description
id - ID!
Example
{"id": 4}
Types

OrderItemFilterId

Fields
Input Field Description
isNil - Boolean
eq - ID
notEq - ID
in - [ID!]
lessThan - ID
greaterThan - ID
lessThanOrEqual - ID
greaterThanOrEqual - ID
Example
{
  "isNil": false,
  "eq": 4,
  "notEq": 4,
  "in": [4],
  "lessThan": "4",
  "greaterThan": 4,
  "lessThanOrEqual": "4",
  "greaterThanOrEqual": "4"
}
Types

OrderItemFilterInput

Fields
Input Field Description
and - [OrderItemFilterInput!]
or - [OrderItemFilterInput!]
not - [OrderItemFilterInput!]
id - OrderItemFilterId
Example
{
  "and": [OrderItemFilterInput],
  "or": [OrderItemFilterInput],
  "not": [OrderItemFilterInput],
  "id": OrderItemFilterId
}
Types

OrderItemSortField

Values
Enum Value Description

ID
Example
"ID"
Types

OrderItemSortInput

Fields
Input Field Description
order - SortOrder
field - OrderItemSortField!
Example
{"order": "DESC", "field": "ID"}
Types

OrderSortField

Values
Enum Value Description

ID
Example
"ID"
Types

OrderSortInput

Fields
Input Field Description
order - SortOrder
field - OrderSortField!
Example
{"order": "DESC", "field": "ID"}
Types

OrderUpdateItemsInput

Fields
Input Field Description
id - ID
status - String
quantity - Decimal
productId - ID
laborCost - Decimal Labor cost allocated to this order item during batch completion
materialCost - Decimal Material cost allocated to this order item during batch completion
overheadCost - Decimal Overhead cost allocated to this order item during batch completion
unitCost - Decimal Per-unit production cost captured at batch completion
unitPrice - Decimal
consumedAt - DateTime Timestamp indicating materials were consumed for this item
Example
{
  "id": "4",
  "status": "xyz789",
  "quantity": Decimal,
  "productId": "4",
  "laborCost": Decimal,
  "materialCost": Decimal,
  "overheadCost": Decimal,
  "unitCost": Decimal,
  "unitPrice": Decimal,
  "consumedAt": "2007-12-03T10:15:30Z"
}
Types

Product

Fields
Field Name Description
id - ID!
name - String!
status - String!
price - Decimal!
photos - [String!] Array of photo URLs for the product
featuredPhoto - String ID or reference to the featured photo from the photos array
sellingAvailability - String! Customer-facing availability: available, preorder, or off
maxDailyQuantity - Int! Optional per-product capacity per day (0 = unlimited)
Example
{
  "id": "4",
  "name": "abc123",
  "status": "abc123",
  "price": Decimal,
  "photos": ["xyz789"],
  "featuredPhoto": "xyz789",
  "sellingAvailability": "abc123",
  "maxDailyQuantity": 987
}
Types

ProductFilterFeaturedPhoto

Fields
Input Field Description
isNil - Boolean
eq - String
notEq - String
in - [String]
lessThan - String
greaterThan - String
lessThanOrEqual - String
greaterThanOrEqual - String
like - String
ilike - String
Example
{
  "isNil": true,
  "eq": "abc123",
  "notEq": "xyz789",
  "in": ["xyz789"],
  "lessThan": "xyz789",
  "greaterThan": "xyz789",
  "lessThanOrEqual": "xyz789",
  "greaterThanOrEqual": "xyz789",
  "like": "abc123",
  "ilike": "abc123"
}
Types

ProductFilterId

Fields
Input Field Description
isNil - Boolean
eq - ID
notEq - ID
in - [ID!]
lessThan - ID
greaterThan - ID
lessThanOrEqual - ID
greaterThanOrEqual - ID
Example
{
  "isNil": false,
  "eq": "4",
  "notEq": 4,
  "in": ["4"],
  "lessThan": 4,
  "greaterThan": "4",
  "lessThanOrEqual": "4",
  "greaterThanOrEqual": 4
}
Types

ProductFilterInput

Fields
Input Field Description
and - [ProductFilterInput!]
or - [ProductFilterInput!]
not - [ProductFilterInput!]
id - ProductFilterId
name - ProductFilterName
status - ProductFilterStatus
price - ProductFilterPrice
featuredPhoto - ProductFilterFeaturedPhoto ID or reference to the featured photo from the photos array
sellingAvailability - ProductFilterSellingAvailability Customer-facing availability: available, preorder, or off
maxDailyQuantity - ProductFilterMaxDailyQuantity Optional per-product capacity per day (0 = unlimited)
Example
{
  "and": [ProductFilterInput],
  "or": [ProductFilterInput],
  "not": [ProductFilterInput],
  "id": ProductFilterId,
  "name": ProductFilterName,
  "status": ProductFilterStatus,
  "price": ProductFilterPrice,
  "featuredPhoto": ProductFilterFeaturedPhoto,
  "sellingAvailability": ProductFilterSellingAvailability,
  "maxDailyQuantity": ProductFilterMaxDailyQuantity
}
Types

ProductFilterMaxDailyQuantity

Fields
Input Field Description
isNil - Boolean
eq - Int
notEq - Int
in - [Int!]
lessThan - Int
greaterThan - Int
lessThanOrEqual - Int
greaterThanOrEqual - Int
Example
{
  "isNil": false,
  "eq": 123,
  "notEq": 123,
  "in": [987],
  "lessThan": 987,
  "greaterThan": 987,
  "lessThanOrEqual": 987,
  "greaterThanOrEqual": 123
}
Types

ProductFilterName

Fields
Input Field Description
isNil - Boolean
eq - String
notEq - String
in - [String!]
lessThan - String
greaterThan - String
lessThanOrEqual - String
greaterThanOrEqual - String
like - String
ilike - String
Example
{
  "isNil": false,
  "eq": "xyz789",
  "notEq": "xyz789",
  "in": ["abc123"],
  "lessThan": "xyz789",
  "greaterThan": "xyz789",
  "lessThanOrEqual": "abc123",
  "greaterThanOrEqual": "xyz789",
  "like": "xyz789",
  "ilike": "abc123"
}
Types

ProductFilterPrice

Fields
Input Field Description
isNil - Boolean
eq - Decimal
notEq - Decimal
in - [Decimal!]
lessThan - Decimal
greaterThan - Decimal
lessThanOrEqual - Decimal
greaterThanOrEqual - Decimal
Example
{
  "isNil": false,
  "eq": Decimal,
  "notEq": Decimal,
  "in": [Decimal],
  "lessThan": Decimal,
  "greaterThan": Decimal,
  "lessThanOrEqual": Decimal,
  "greaterThanOrEqual": Decimal
}
Types

ProductFilterSellingAvailability

Fields
Input Field Description
isNil - Boolean
eq - String
notEq - String
in - [String!]
lessThan - String
greaterThan - String
lessThanOrEqual - String
greaterThanOrEqual - String
Example
{
  "isNil": true,
  "eq": "abc123",
  "notEq": "abc123",
  "in": ["xyz789"],
  "lessThan": "abc123",
  "greaterThan": "xyz789",
  "lessThanOrEqual": "xyz789",
  "greaterThanOrEqual": "xyz789"
}
Types

ProductFilterStatus

Fields
Input Field Description
isNil - Boolean
eq - String
notEq - String
in - [String!]
lessThan - String
greaterThan - String
lessThanOrEqual - String
greaterThanOrEqual - String
Example
{
  "isNil": true,
  "eq": "abc123",
  "notEq": "xyz789",
  "in": ["abc123"],
  "lessThan": "abc123",
  "greaterThan": "abc123",
  "lessThanOrEqual": "xyz789",
  "greaterThanOrEqual": "xyz789"
}
Types

ProductSortField

Values
Enum Value Description

ID

NAME

STATUS

PRICE

FEATURED_PHOTO

SELLING_AVAILABILITY

MAX_DAILY_QUANTITY
Example
"ID"
Types

ProductSortInput

Fields
Input Field Description
order - SortOrder
field - ProductSortField!
Example
{"order": "DESC", "field": "ID"}
Types

ProductionBatch

Fields
Field Name Description
id - ID!
Example
{"id": "4"}
Types

ProductionBatchFilterId

Fields
Input Field Description
isNil - Boolean
eq - ID
notEq - ID
in - [ID!]
lessThan - ID
greaterThan - ID
lessThanOrEqual - ID
greaterThanOrEqual - ID
Example
{
  "isNil": false,
  "eq": 4,
  "notEq": "4",
  "in": [4],
  "lessThan": 4,
  "greaterThan": "4",
  "lessThanOrEqual": 4,
  "greaterThanOrEqual": "4"
}
Types

ProductionBatchFilterInput

Fields
Input Field Description
and - [ProductionBatchFilterInput!]
or - [ProductionBatchFilterInput!]
not - [ProductionBatchFilterInput!]
id - ProductionBatchFilterId
Example
{
  "and": [ProductionBatchFilterInput],
  "or": [ProductionBatchFilterInput],
  "not": [ProductionBatchFilterInput],
  "id": ProductionBatchFilterId
}
Types

ProductionBatchSortField

Values
Enum Value Description

ID
Example
"ID"
Types

ProductionBatchSortInput

Fields
Input Field Description
order - SortOrder
field - ProductionBatchSortField!
Example
{"order": "DESC", "field": "ID"}
Types

PurchaseOrder

Fields
Field Name Description
id - ID!
Example
{"id": 4}
Types

PurchaseOrderFilterId

Fields
Input Field Description
isNil - Boolean
eq - ID
notEq - ID
in - [ID!]
lessThan - ID
greaterThan - ID
lessThanOrEqual - ID
greaterThanOrEqual - ID
Example
{
  "isNil": true,
  "eq": 4,
  "notEq": 4,
  "in": [4],
  "lessThan": 4,
  "greaterThan": "4",
  "lessThanOrEqual": "4",
  "greaterThanOrEqual": 4
}
Types

PurchaseOrderFilterInput

Fields
Input Field Description
and - [PurchaseOrderFilterInput!]
or - [PurchaseOrderFilterInput!]
not - [PurchaseOrderFilterInput!]
id - PurchaseOrderFilterId
Example
{
  "and": [PurchaseOrderFilterInput],
  "or": [PurchaseOrderFilterInput],
  "not": [PurchaseOrderFilterInput],
  "id": PurchaseOrderFilterId
}
Types

PurchaseOrderSortField

Values
Enum Value Description

ID
Example
"ID"
Types

PurchaseOrderSortInput

Fields
Input Field Description
order - SortOrder
field - PurchaseOrderSortField!
Example
{"order": "DESC", "field": "ID"}
Types

SortOrder

Values
Enum Value Description

DESC

DESC_NULLS_FIRST

DESC_NULLS_LAST

ASC

ASC_NULLS_FIRST

ASC_NULLS_LAST
Example
"DESC"
Types

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
"xyz789"
Types

Supplier

Fields
Field Name Description
id - ID!
Example
{"id": 4}
Types

SupplierFilterId

Fields
Input Field Description
isNil - Boolean
eq - ID
notEq - ID
in - [ID!]
lessThan - ID
greaterThan - ID
lessThanOrEqual - ID
greaterThanOrEqual - ID
Example
{
  "isNil": false,
  "eq": 4,
  "notEq": "4",
  "in": ["4"],
  "lessThan": 4,
  "greaterThan": "4",
  "lessThanOrEqual": "4",
  "greaterThanOrEqual": "4"
}
Types

SupplierFilterInput

Fields
Input Field Description
and - [SupplierFilterInput!]
or - [SupplierFilterInput!]
not - [SupplierFilterInput!]
id - SupplierFilterId
Example
{
  "and": [SupplierFilterInput],
  "or": [SupplierFilterInput],
  "not": [SupplierFilterInput],
  "id": SupplierFilterId
}
Types

SupplierSortField

Values
Enum Value Description

ID
Example
"ID"
Types

SupplierSortInput

Fields
Input Field Description
order - SortOrder
field - SupplierSortField!
Example
{"order": "DESC", "field": "ID"}
Types

UpdateCustomerInput

Fields
Input Field Description
type - String
firstName - String
lastName - String
email - String
phone - String
billingAddress - JsonString
shippingAddress - JsonString
Example
{
  "type": "xyz789",
  "firstName": "abc123",
  "lastName": "abc123",
  "email": "xyz789",
  "phone": "xyz789",
  "billingAddress": JsonString,
  "shippingAddress": JsonString
}
Types

UpdateCustomerResult

Description

The result of the :update_customer mutation

Fields
Field Name Description
result - Customer The successful result of the mutation
errors - [MutationError!]! Any errors generated, if the mutation failed
Example
{
  "result": Customer,
  "errors": [MutationError]
}
Types

UpdateMaterialInput

Fields
Input Field Description
name - String
sku - String
unit - String
price - Decimal
minimumStock - Decimal
maximumStock - Decimal
Example
{
  "name": "xyz789",
  "sku": "xyz789",
  "unit": "abc123",
  "price": Decimal,
  "minimumStock": Decimal,
  "maximumStock": Decimal
}
Types

UpdateMaterialResult

Description

The result of the :update_material mutation

Fields
Field Name Description
result - Material The successful result of the mutation
errors - [MutationError!]! Any errors generated, if the mutation failed
Example
{
  "result": Material,
  "errors": [MutationError]
}
Types

UpdateOrderInput

Fields
Input Field Description
deliveryDate - DateTime
invoiceNumber - String
invoiceStatus - String
invoicedAt - DateTime
paymentMethod - String
discountType - String
discountValue - Decimal
deliveryMethod - String
status - String
taxTotal - Decimal
shippingTotal - Decimal
discountTotal - Decimal
customerId - ID
items - [OrderUpdateItemsInput!]
Example
{
  "deliveryDate": "2007-12-03T10:15:30Z",
  "invoiceNumber": "abc123",
  "invoiceStatus": "xyz789",
  "invoicedAt": "2007-12-03T10:15:30Z",
  "paymentMethod": "xyz789",
  "discountType": "xyz789",
  "discountValue": Decimal,
  "deliveryMethod": "abc123",
  "status": "xyz789",
  "taxTotal": Decimal,
  "shippingTotal": Decimal,
  "discountTotal": Decimal,
  "customerId": 4,
  "items": [OrderUpdateItemsInput]
}
Types

UpdateOrderItemInput

Fields
Input Field Description
quantity - Decimal
status - String
consumedAt - DateTime Timestamp indicating materials were consumed for this item
materialCost - Decimal Material cost allocated to this order item during batch completion
laborCost - Decimal Labor cost allocated to this order item during batch completion
overheadCost - Decimal Overhead cost allocated to this order item during batch completion
unitCost - Decimal Per-unit production cost captured at batch completion
Example
{
  "quantity": Decimal,
  "status": "xyz789",
  "consumedAt": "2007-12-03T10:15:30Z",
  "materialCost": Decimal,
  "laborCost": Decimal,
  "overheadCost": Decimal,
  "unitCost": Decimal
}
Types

UpdateOrderItemResult

Description

The result of the :update_order_item mutation

Fields
Field Name Description
result - OrderItem The successful result of the mutation
errors - [MutationError!]! Any errors generated, if the mutation failed
Example
{
  "result": OrderItem,
  "errors": [MutationError]
}
Types

UpdateOrderResult

Description

The result of the :update_order mutation

Fields
Field Name Description
result - Order The successful result of the mutation
errors - [MutationError!]! Any errors generated, if the mutation failed
Example
{
  "result": Order,
  "errors": [MutationError]
}
Types

UpdateProductInput

Fields
Input Field Description
name - String
status - String
price - Decimal
sku - String
photos - [String!] Array of photo URLs for the product
featuredPhoto - String ID or reference to the featured photo from the photos array
sellingAvailability - String Customer-facing availability: available, preorder, or off
maxDailyQuantity - Int Optional per-product capacity per day (0 = unlimited)
Example
{
  "name": "abc123",
  "status": "abc123",
  "price": Decimal,
  "sku": "abc123",
  "photos": ["abc123"],
  "featuredPhoto": "xyz789",
  "sellingAvailability": "abc123",
  "maxDailyQuantity": 123
}
Types

UpdateProductResult

Description

The result of the :update_product mutation

Fields
Field Name Description
result - Product The successful result of the mutation
errors - [MutationError!]! Any errors generated, if the mutation failed
Example
{
  "result": Product,
  "errors": [MutationError]
}
Types

UpdatePurchaseOrderInput

Fields
Input Field Description
status - String
orderedAt - DateTime
receivedAt - DateTime
supplierId - ID
Example
{
  "status": "xyz789",
  "orderedAt": "2007-12-03T10:15:30Z",
  "receivedAt": "2007-12-03T10:15:30Z",
  "supplierId": 4
}
Types

UpdatePurchaseOrderResult

Description

The result of the :update_purchase_order mutation

Fields
Field Name Description
result - PurchaseOrder The successful result of the mutation
errors - [MutationError!]! Any errors generated, if the mutation failed
Example
{
  "result": PurchaseOrder,
  "errors": [MutationError]
}
Types

UpdateSupplierInput

Fields
Input Field Description
name - String
contactName - String
contactEmail - String
contactPhone - String
notes - String
Example
{
  "name": "abc123",
  "contactName": "xyz789",
  "contactEmail": "abc123",
  "contactPhone": "abc123",
  "notes": "abc123"
}
Types

UpdateSupplierResult

Description

The result of the :update_supplier mutation

Fields
Field Name Description
result - Supplier The successful result of the mutation
errors - [MutationError!]! Any errors generated, if the mutation failed
Example
{
  "result": Supplier,
  "errors": [MutationError]
}
Documentation by Anvil SpectaQL