Ventory GraphQL API Reference

The API reference for the Ventory API

API Endpoints
# GraphQL Endpoint:
https://api.ventory.io/graphql

Queries

companies

Response

Returns a PaginatedCompany!

Arguments
Name Description
page - Float

Example

Query
query companies($page: Float) {
  companies(page: $page) {
    batchSize
    data {
      ...CompanyFragment
    }
    hasNext
    page
    pageSize
  }
}
Variables
{"page": 987.65}
Response
{
  "data": {
    "companies": {
      "batchSize": 123.45,
      "data": [Company],
      "hasNext": false,
      "page": 123.45,
      "pageSize": 987.65
    }
  }
}
Queries

company

Response

Returns a Company!

Arguments
Name Description
id - String!

Example

Query
query company($id: String!) {
  company(id: $id) {
    companyId
    createdAt
    createdBy
    externalIdentifier {
      ...ExternalEntityIdentifierFragment
    }
    id
    name
    partner
    settings {
      ...CompanySettingsFragment
    }
    status
    updatedAt
    updatedBy
    version
  }
}
Variables
{"id": "xyz789"}
Response
{
  "data": {
    "company": {
      "companyId": "abc123",
      "createdAt": "2007-12-03",
      "createdBy": "abc123",
      "externalIdentifier": ExternalEntityIdentifier,
      "id": "abc123",
      "name": "abc123",
      "partner": false,
      "settings": CompanySettings,
      "status": "active",
      "updatedAt": "2007-12-03",
      "updatedBy": "abc123",
      "version": 123
    }
  }
}
Queries

csvConfigurationsForFile

Response

Returns a CsvUploadConfigurationsForFile!

Arguments
Name Description
companyId - String!
csvFileAsBase64Data - String!
type - String!

Example

Query
query csvConfigurationsForFile(
  $companyId: String!,
  $csvFileAsBase64Data: String!,
  $type: String!
) {
  csvConfigurationsForFile(
    companyId: $companyId,
    csvFileAsBase64Data: $csvFileAsBase64Data,
    type: $type
  ) {
    companyId
    configurations {
      ...CsvUploadConfigurationFragment
    }
    createdAt
    createdBy
    externalIdentifier {
      ...ExternalEntityIdentifierFragment
    }
    fileHeaders
    id
    optionalHeaders
    otherConfigurations {
      ...CsvUploadConfigurationFragment
    }
    requiredHeaders
    updatedAt
    updatedBy
    version
  }
}
Variables
{
  "companyId": "abc123",
  "csvFileAsBase64Data": "abc123",
  "type": "abc123"
}
Response
{
  "data": {
    "csvConfigurationsForFile": {
      "companyId": "abc123",
      "configurations": [CsvUploadConfiguration],
      "createdAt": "2007-12-03",
      "createdBy": "abc123",
      "externalIdentifier": ExternalEntityIdentifier,
      "fileHeaders": ["xyz789"],
      "id": "xyz789",
      "optionalHeaders": ["abc123"],
      "otherConfigurations": [CsvUploadConfiguration],
      "requiredHeaders": ["abc123"],
      "updatedAt": "2007-12-03",
      "updatedBy": "abc123",
      "version": 987
    }
  }
}

Mutations

createCsvUploadConfiguration

Response

Returns [CsvUploadConfiguration!]!

Arguments
Name Description
csvUploadConfigurations - [CreateCsvUploadConfigurationInput!]!

Example

Query
mutation createCsvUploadConfiguration($csvUploadConfigurations: [CreateCsvUploadConfigurationInput!]!) {
  createCsvUploadConfiguration(csvUploadConfigurations: $csvUploadConfigurations) {
    companyId
    createdAt
    createdBy
    description
    externalIdentifier {
      ...ExternalEntityIdentifierFragment
    }
    headerMapping {
      ...CsvUploadConfigurationMappingFragment
    }
    headerNames
    id
    name
    type
    updatedAt
    updatedBy
    version
  }
}
Variables
{
  "csvUploadConfigurations": [
    CreateCsvUploadConfigurationInput
  ]
}
Response
{
  "data": {
    "createCsvUploadConfiguration": [
      {
        "companyId": "xyz789",
        "createdAt": "2007-12-03",
        "createdBy": "abc123",
        "description": "abc123",
        "externalIdentifier": ExternalEntityIdentifier,
        "headerMapping": [CsvUploadConfigurationMapping],
        "headerNames": ["xyz789"],
        "id": "abc123",
        "name": "abc123",
        "type": "asset",
        "updatedAt": "2007-12-03",
        "updatedBy": "xyz789",
        "version": 987
      }
    ]
  }
}
Mutations

deleteBinStatus

Response

Returns [BinStatus!]!

Arguments
Name Description
binStatuses - [DeleteBinStatusInput!]!

Example

Query
mutation deleteBinStatus($binStatuses: [DeleteBinStatusInput!]!) {
  deleteBinStatus(binStatuses: $binStatuses) {
    color
    companyId
    createdAt
    createdBy
    externalIdentifier {
      ...ExternalEntityIdentifierFragment
    }
    id
    inboundAllowed
    outboundAllowed
    status
    updatedAt
    updatedBy
    version
  }
}
Variables
{"binStatuses": [DeleteBinStatusInput]}
Response
{
  "data": {
    "deleteBinStatus": [
      {
        "color": "abc123",
        "companyId": "abc123",
        "createdAt": "2007-12-03",
        "createdBy": "xyz789",
        "externalIdentifier": ExternalEntityIdentifier,
        "id": "xyz789",
        "inboundAllowed": false,
        "outboundAllowed": true,
        "status": "xyz789",
        "updatedAt": "2007-12-03",
        "updatedBy": "abc123",
        "version": 987
      }
    ]
  }
}
Mutations

deleteContact

Response

Returns [Contact!]!

Arguments
Name Description
contacts - [DeleteContactInput!]!

Example

Query
mutation deleteContact($contacts: [DeleteContactInput!]!) {
  deleteContact(contacts: $contacts) {
    address {
      ...AddressFragment
    }
    addresses {
      ...AddressFragment
    }
    companyId
    createdAt
    createdBy
    customFields {
      ...CustomFieldValueFragment
    }
    email
    emails
    externalIdentifier {
      ...ExternalEntityIdentifierFragment
    }
    id
    name
    phones
    shippingLocations {
      ...ShippingLocationFragment
    }
    updatedAt
    updatedBy
    version
  }
}
Variables
{"contacts": [DeleteContactInput]}
Response
{
  "data": {
    "deleteContact": [
      {
        "address": Address,
        "addresses": [Address],
        "companyId": "xyz789",
        "createdAt": "2007-12-03",
        "createdBy": "xyz789",
        "customFields": [CustomFieldValue],
        "email": "abc123",
        "emails": ["xyz789"],
        "externalIdentifier": ExternalEntityIdentifier,
        "id": "abc123",
        "name": "abc123",
        "phones": ["abc123"],
        "shippingLocations": [ShippingLocation],
        "updatedAt": "2007-12-03",
        "updatedBy": "abc123",
        "version": 123
      }
    ]
  }
}
Mutations

deleteCsvUploadConfiguration

Response

Returns [CsvUploadConfiguration!]!

Arguments
Name Description
csvUploadConfigurations - [DeleteCsvUploadConfigurationInput!]!

Example

Query
mutation deleteCsvUploadConfiguration($csvUploadConfigurations: [DeleteCsvUploadConfigurationInput!]!) {
  deleteCsvUploadConfiguration(csvUploadConfigurations: $csvUploadConfigurations) {
    companyId
    createdAt
    createdBy
    description
    externalIdentifier {
      ...ExternalEntityIdentifierFragment
    }
    headerMapping {
      ...CsvUploadConfigurationMappingFragment
    }
    headerNames
    id
    name
    type
    updatedAt
    updatedBy
    version
  }
}
Variables
{
  "csvUploadConfigurations": [
    DeleteCsvUploadConfigurationInput
  ]
}
Response
{
  "data": {
    "deleteCsvUploadConfiguration": [
      {
        "companyId": "xyz789",
        "createdAt": "2007-12-03",
        "createdBy": "xyz789",
        "description": "xyz789",
        "externalIdentifier": ExternalEntityIdentifier,
        "headerMapping": [CsvUploadConfigurationMapping],
        "headerNames": ["abc123"],
        "id": "xyz789",
        "name": "abc123",
        "type": "asset",
        "updatedAt": "2007-12-03",
        "updatedBy": "xyz789",
        "version": 987
      }
    ]
  }
}
Mutations

updateCsvUploadConfiguration

Response

Returns [CsvUploadConfiguration!]!

Arguments
Name Description
csvUploadConfigurations - [UpdateCsvUploadConfigurationInput!]!

Example

Query
mutation updateCsvUploadConfiguration($csvUploadConfigurations: [UpdateCsvUploadConfigurationInput!]!) {
  updateCsvUploadConfiguration(csvUploadConfigurations: $csvUploadConfigurations) {
    companyId
    createdAt
    createdBy
    description
    externalIdentifier {
      ...ExternalEntityIdentifierFragment
    }
    headerMapping {
      ...CsvUploadConfigurationMappingFragment
    }
    headerNames
    id
    name
    type
    updatedAt
    updatedBy
    version
  }
}
Variables
{
  "csvUploadConfigurations": [
    UpdateCsvUploadConfigurationInput
  ]
}
Response
{
  "data": {
    "updateCsvUploadConfiguration": [
      {
        "companyId": "abc123",
        "createdAt": "2007-12-03",
        "createdBy": "abc123",
        "description": "abc123",
        "externalIdentifier": ExternalEntityIdentifier,
        "headerMapping": [CsvUploadConfigurationMapping],
        "headerNames": ["xyz789"],
        "id": "abc123",
        "name": "abc123",
        "type": "asset",
        "updatedAt": "2007-12-03",
        "updatedBy": "abc123",
        "version": 123
      }
    ]
  }
}

Types

Address

Fields
Field Name Description
addressLine1 - String
addressLine2 - String
city - String
coordinates - Coordinates
countryCode - String
name - String
postalCode - String
region - String
type - AddressType
Example
{
  "addressLine1": "xyz789",
  "addressLine2": "abc123",
  "city": "abc123",
  "coordinates": Coordinates,
  "countryCode": "xyz789",
  "name": "abc123",
  "postalCode": "abc123",
  "region": "xyz789",
  "type": "delivery"
}
Types

AddressType

Values
Enum Value Description

delivery

invoicing

primary

visiting
Example
"delivery"
Types

AlertFeatureToggles

Fields
Field Name Description
alerts - Boolean!
Example
{"alerts": false}
Types

AlertUpdateNotification

Fields
Field Name Description
companyId - String!
date - Date!
entities - [AlertWithEntity!]!
topic - String!
Example
{
  "companyId": "xyz789",
  "date": "2007-12-03",
  "entities": [AlertWithEntity],
  "topic": "abc123"
}
Types

AlertWithEntity

Fields
Field Name Description
alertString - String
companyId - String!
createdAt - Date
createdBy - String
customFieldIds - [String!]
entityType - TriggerEntityType!
entityValue - String!
externalIdentifier - ExternalEntityIdentifier
id - String
processed - Boolean!
productTransaction - ProductTransaction
stockLocationAggregateType - StockLocationAggregateType!
stockLocationIds - [String!]
triggerId - String!
triggeredStockLocation - String
triggeredValue - String!
updatedAt - Date
updatedBy - String
userId - String!
version - Int
Example
{
  "alertString": "abc123",
  "companyId": "xyz789",
  "createdAt": "2007-12-03",
  "createdBy": "abc123",
  "customFieldIds": ["xyz789"],
  "entityType": "customField",
  "entityValue": "abc123",
  "externalIdentifier": ExternalEntityIdentifier,
  "id": "abc123",
  "processed": true,
  "productTransaction": ProductTransaction,
  "stockLocationAggregateType": "all",
  "stockLocationIds": ["xyz789"],
  "triggerId": "abc123",
  "triggeredStockLocation": "xyz789",
  "triggeredValue": "xyz789",
  "updatedAt": "2007-12-03",
  "updatedBy": "abc123",
  "userId": "xyz789",
  "version": 987
}
Types

Asset

Fields
Field Name Description
companyId - String!
createdAt - Date
createdBy - String
externalIdentifier - ExternalEntityIdentifier
id - String
identifier - String
location - AssetLocationInput
product - AssetProduct!
updatedAt - Date
updatedBy - String
version - Int
Example
{
  "companyId": "xyz789",
  "createdAt": "2007-12-03",
  "createdBy": "xyz789",
  "externalIdentifier": ExternalEntityIdentifier,
  "id": "xyz789",
  "identifier": "abc123",
  "location": AssetLocationInput,
  "product": AssetProduct,
  "updatedAt": "2007-12-03",
  "updatedBy": "xyz789",
  "version": 123
}
Types

AssetFeatureToggles

Fields
Field Name Description
assets - Boolean
inboundOrder - Boolean
Example
{"assets": true, "inboundOrder": false}
Types

AssetLocationInput

Fields
Field Name Description
entityId - String!
entityType - String!
Example
{
  "entityId": "abc123",
  "entityType": "xyz789"
}
Types

AssetProduct

Fields
Field Name Description
customFields - [CustomFieldValue!]
productMasterDataId - String!
quantity - Float!
serial - String
unitQuantity - String!
Example
{
  "customFields": [CustomFieldValue],
  "productMasterDataId": "abc123",
  "quantity": 987.65,
  "serial": "xyz789",
  "unitQuantity": "abc123"
}
Types

AssetTransaction

Fields
Field Name Description
assetId - String
companyId - String!
createdAt - Date
createdBy - String
customFields - [CustomFieldValue!]
externalIdentifier - ExternalEntityIdentifier
id - String
identifier - String
location - AssetLocationInput
parentId - String
parentType - AssetTransactionParentType!
processedAt - Date
processedBy - String
product - AssetProduct!
status - AssetTransactionStatus!
type - AssetTransactionType!
updatedAt - Date
updatedBy - String
version - Int
Example
{
  "assetId": "abc123",
  "companyId": "abc123",
  "createdAt": "2007-12-03",
  "createdBy": "abc123",
  "customFields": [CustomFieldValue],
  "externalIdentifier": ExternalEntityIdentifier,
  "id": "abc123",
  "identifier": "abc123",
  "location": AssetLocationInput,
  "parentId": "abc123",
  "parentType": "assign",
  "processedAt": "2007-12-03",
  "processedBy": "xyz789",
  "product": AssetProduct,
  "status": "completed",
  "type": "inbound",
  "updatedAt": "2007-12-03",
  "updatedBy": "abc123",
  "version": 987
}
Types

AssetTransactionParentType

Values
Enum Value Description

assign

manual

ownership

reassign

returnAsset

upload
Example
"assign"
Types

AssetTransactionStatus

Values
Enum Value Description

completed

created

pending

rejected
Example
"completed"
Types

AssetTransactionType

Values
Enum Value Description

inbound

outbound

verify
Example
"inbound"
Types

AssetTransactionUpdateNotification

Fields
Field Name Description
companyId - String!
date - Date!
entities - [AssetTransaction!]!
topic - String!
Example
{
  "companyId": "abc123",
  "date": "2007-12-03",
  "entities": [AssetTransaction],
  "topic": "xyz789"
}
Types

AssetUpdateNotification

Fields
Field Name Description
companyId - String!
date - Date!
entities - [Asset!]!
topic - String!
Example
{
  "companyId": "abc123",
  "date": "2007-12-03",
  "entities": [Asset],
  "topic": "xyz789"
}
Types

BarcodeFormat

Values
Enum Value Description

all

aztec

codabar

code39

code93

code128

dataMatrix

ean8

ean13

itf

pdf417

qrCode

unknown

upca

upce
Example
"all"
Types

Bin

Fields
Field Name Description
binStatusId - String!
companyId - String!
createdAt - Date
createdBy - String
customFields - [CustomFieldValue!]
externalIdentifier - ExternalEntityIdentifier
id - String
labels - [String!]
name - String!
stockLocationId - String!
updatedAt - Date
updatedBy - String
version - Int
Example
{
  "binStatusId": "abc123",
  "companyId": "abc123",
  "createdAt": "2007-12-03",
  "createdBy": "abc123",
  "customFields": [CustomFieldValue],
  "externalIdentifier": ExternalEntityIdentifier,
  "id": "xyz789",
  "labels": ["abc123"],
  "name": "abc123",
  "stockLocationId": "xyz789",
  "updatedAt": "2007-12-03",
  "updatedBy": "abc123",
  "version": 987
}
Types

BinStatus

Fields
Field Name Description
color - String
companyId - String!
createdAt - Date
createdBy - String
externalIdentifier - ExternalEntityIdentifier
id - String
inboundAllowed - Boolean
outboundAllowed - Boolean
status - String!
updatedAt - Date
updatedBy - String
version - Int
Example
{
  "color": "abc123",
  "companyId": "xyz789",
  "createdAt": "2007-12-03",
  "createdBy": "abc123",
  "externalIdentifier": ExternalEntityIdentifier,
  "id": "abc123",
  "inboundAllowed": false,
  "outboundAllowed": true,
  "status": "abc123",
  "updatedAt": "2007-12-03",
  "updatedBy": "xyz789",
  "version": 123
}
Types

BinStatusUpdateNotification

Fields
Field Name Description
companyId - String!
date - Date!
entities - [BinStatus!]!
topic - String!
Example
{
  "companyId": "xyz789",
  "date": "2007-12-03",
  "entities": [BinStatus],
  "topic": "xyz789"
}
Types

BinUpdateNotification

Fields
Field Name Description
companyId - String!
date - Date!
entities - [Bin!]!
topic - String!
Example
{
  "companyId": "abc123",
  "date": "2007-12-03",
  "entities": [Bin],
  "topic": "abc123"
}
Types

Boolean

Description

The Boolean scalar type represents true or false.

Example
true
Types

Comment

Fields
Field Name Description
companyId - String!
content - String!
createdAt - Date
createdBy - String
entityId - String!
externalIdentifier - ExternalEntityIdentifier
id - String
parentId - String
type - EntityType!
updatedAt - Date
updatedBy - String
userId - String
version - Int
Example
{
  "companyId": "abc123",
  "content": "abc123",
  "createdAt": "2007-12-03",
  "createdBy": "abc123",
  "entityId": "xyz789",
  "externalIdentifier": ExternalEntityIdentifier,
  "id": "abc123",
  "parentId": "xyz789",
  "type": "asset",
  "updatedAt": "2007-12-03",
  "updatedBy": "xyz789",
  "userId": "xyz789",
  "version": 123
}
Types

CommentUpdateNotification

Fields
Field Name Description
companyId - String!
date - Date!
entities - [Comment!]!
topic - String!
Example
{
  "companyId": "xyz789",
  "date": "2007-12-03",
  "entities": [Comment],
  "topic": "xyz789"
}
Types

Company

Fields
Field Name Description
companyId - String!
createdAt - Date
createdBy - String
externalIdentifier - ExternalEntityIdentifier
id - String
name - String!
partner - Boolean
settings - CompanySettings
status - CompanyStatus
updatedAt - Date
updatedBy - String
version - Int
Example
{
  "companyId": "abc123",
  "createdAt": "2007-12-03",
  "createdBy": "abc123",
  "externalIdentifier": ExternalEntityIdentifier,
  "id": "xyz789",
  "name": "xyz789",
  "partner": true,
  "settings": CompanySettings,
  "status": "active",
  "updatedAt": "2007-12-03",
  "updatedBy": "xyz789",
  "version": 123
}
Types

CompanyConnection

Fields
Field Name Description
companyId - String!
createdAt - Date
createdBy - String
externalIdentifier - ExternalEntityIdentifier
id - String
parentId - String!
state - CompanyConnectionState!
types - [CompanyConnectionEntityType!]!
updatedAt - Date
updatedBy - String
version - Int
Example
{
  "companyId": "xyz789",
  "createdAt": "2007-12-03",
  "createdBy": "abc123",
  "externalIdentifier": ExternalEntityIdentifier,
  "id": "xyz789",
  "parentId": "xyz789",
  "state": "active",
  "types": ["asset_transactions"],
  "updatedAt": "2007-12-03",
  "updatedBy": "xyz789",
  "version": 123
}
Types

CompanyConnectionEntityType

Values
Enum Value Description

asset_transactions

assets

bin_status

bins

container_types

containers

files

handling_units

kit_templates

kits

lots

mobile_stock_location_events

mobile_stock_location_session_history

mobile_stock_location_sessions

orders

product_master_data

product_transactions

products

stock_locations

tag_relation

tags

tasks
Example
"asset_transactions"
Types

CompanyConnectionState

Values
Enum Value Description

active

inactive

pending
Example
"active"
Types

CompanyConnectionUpdateNotification

Fields
Field Name Description
companyId - String!
date - Date!
entities - [CompanyConnection!]!
topic - String!
Example
{
  "companyId": "abc123",
  "date": "2007-12-03",
  "entities": [CompanyConnection],
  "topic": "abc123"
}
Types

CompanyFeatureToggles

Fields
Field Name Description
sessionStorage - Boolean
ventoryVisionAR - Boolean
Example
{"sessionStorage": true, "ventoryVisionAR": true}
Types

CompanyRelationService

Values
Enum Value Description

businessCentral

microsoft

sage

sap

teamleader
Example
"businessCentral"
Types

CompanySettings

Fields
Field Name Description
accentColor - String
companyFavicon - String
companyLogo - String
featureToggles - FeatureToggles!
headerColor - String
language - String
mobileConfiguration - MobileConfigurationType!
primaryColor - String
scanConfigurations - [ScanConfiguration!]!
Example
{
  "accentColor": "xyz789",
  "companyFavicon": "abc123",
  "companyLogo": "abc123",
  "featureToggles": FeatureToggles,
  "headerColor": "abc123",
  "language": "abc123",
  "mobileConfiguration": "current",
  "primaryColor": "xyz789",
  "scanConfigurations": [ScanConfiguration]
}
Types

CompanyStatus

Values
Enum Value Description

active

archived

demo

expired

partner

trial
Example
"active"
Types

Contact

Fields
Field Name Description
address - Address
addresses - [Address!]
companyId - String!
createdAt - Date
createdBy - String
customFields - [CustomFieldValue!]
email - String
emails - [String!]
externalIdentifier - ExternalEntityIdentifier
id - String
name - String!
phones - [String!]
shippingLocations - [ShippingLocation!]
updatedAt - Date
updatedBy - String
version - Int
Example
{
  "address": Address,
  "addresses": [Address],
  "companyId": "abc123",
  "createdAt": "2007-12-03",
  "createdBy": "xyz789",
  "customFields": [CustomFieldValue],
  "email": "xyz789",
  "emails": ["xyz789"],
  "externalIdentifier": ExternalEntityIdentifier,
  "id": "xyz789",
  "name": "abc123",
  "phones": ["abc123"],
  "shippingLocations": [ShippingLocation],
  "updatedAt": "2007-12-03",
  "updatedBy": "abc123",
  "version": 123
}
Types

ContactUpdateNotification

Fields
Field Name Description
companyId - String!
date - Date!
entities - [Contact!]!
topic - String!
Example
{
  "companyId": "abc123",
  "date": "2007-12-03",
  "entities": [Contact],
  "topic": "xyz789"
}
Types

Container

Fields
Field Name Description
binId - String!
companyId - String!
containerTypeId - String!
createdAt - Date
createdBy - String
customFields - [CustomFieldValue!]
deleteOnOutbound - Boolean!
externalIdentifier - ExternalEntityIdentifier
id - String
identifier - String!
labels - [String!]!
parentId - String
stockLocationId - String!
updatedAt - Date
updatedBy - String
version - Int
Example
{
  "binId": "abc123",
  "companyId": "abc123",
  "containerTypeId": "abc123",
  "createdAt": "2007-12-03",
  "createdBy": "abc123",
  "customFields": [CustomFieldValue],
  "deleteOnOutbound": true,
  "externalIdentifier": ExternalEntityIdentifier,
  "id": "abc123",
  "identifier": "xyz789",
  "labels": ["abc123"],
  "parentId": "abc123",
  "stockLocationId": "xyz789",
  "updatedAt": "2007-12-03",
  "updatedBy": "abc123",
  "version": 987
}
Types

ContainerFeatureToggles

Fields
Field Name Description
allowBinMismatch - Boolean
containers - Boolean!
Example
{"allowBinMismatch": true, "containers": true}
Types

ContainerUpdateNotification

Fields
Field Name Description
companyId - String!
date - Date!
entities - [Container!]!
topic - String!
Example
{
  "companyId": "abc123",
  "date": "2007-12-03",
  "entities": [Container],
  "topic": "xyz789"
}
Types

Coordinates

Fields
Field Name Description
latitude - Float!
longitude - Float!
Example
{"latitude": 987.65, "longitude": 123.45}
Types

CreateCsvUploadConfigurationInput

Fields
Input Field Description
companyId - String!
createdAt - Date
createdBy - String
description - String
externalIdentifier - ExternalEntityIdentifierInput
headerMapping - [CsvUploadConfigurationMappingInput!]!
headerNames - [String!]!
id - String
name - String!
type - CsvUploadType!
updatedAt - Date
updatedBy - String
version - Int
Example
{
  "companyId": "abc123",
  "createdAt": "2007-12-03",
  "createdBy": "abc123",
  "description": "xyz789",
  "externalIdentifier": ExternalEntityIdentifierInput,
  "headerMapping": [CsvUploadConfigurationMappingInput],
  "headerNames": ["abc123"],
  "id": "xyz789",
  "name": "xyz789",
  "type": "asset",
  "updatedAt": "2007-12-03",
  "updatedBy": "abc123",
  "version": 123
}
Types

CsvFileStatusNotification

Fields
Field Name Description
fileName - String!
progress - Float!
row - Int!
Example
{
  "fileName": "xyz789",
  "progress": 123.45,
  "row": 987
}
Types

CsvUploadConfiguration

Fields
Field Name Description
companyId - String!
createdAt - Date
createdBy - String
description - String
externalIdentifier - ExternalEntityIdentifier
headerMapping - [CsvUploadConfigurationMapping!]!
headerNames - [String!]!
id - String
name - String!
type - CsvUploadType!
updatedAt - Date
updatedBy - String
version - Int
Example
{
  "companyId": "abc123",
  "createdAt": "2007-12-03",
  "createdBy": "xyz789",
  "description": "abc123",
  "externalIdentifier": ExternalEntityIdentifier,
  "headerMapping": [CsvUploadConfigurationMapping],
  "headerNames": ["abc123"],
  "id": "abc123",
  "name": "xyz789",
  "type": "asset",
  "updatedAt": "2007-12-03",
  "updatedBy": "abc123",
  "version": 123
}
Types

CsvUploadConfigurationMapping

Fields
Field Name Description
customField - String!
field - String!
Example
{
  "customField": "abc123",
  "field": "abc123"
}
Types

CsvUploadConfigurationMappingInput

Fields
Input Field Description
customField - String!
field - String!
Example
{
  "customField": "xyz789",
  "field": "abc123"
}
Types

CsvUploadConfigurationsForFile

Fields
Field Name Description
companyId - String!
configurations - [CsvUploadConfiguration!]!
createdAt - Date
createdBy - String
externalIdentifier - ExternalEntityIdentifier
fileHeaders - [String!]
id - String
optionalHeaders - [String!]
otherConfigurations - [CsvUploadConfiguration!]!
requiredHeaders - [String!]
updatedAt - Date
updatedBy - String
version - Int
Example
{
  "companyId": "xyz789",
  "configurations": [CsvUploadConfiguration],
  "createdAt": "2007-12-03",
  "createdBy": "xyz789",
  "externalIdentifier": ExternalEntityIdentifier,
  "fileHeaders": ["xyz789"],
  "id": "abc123",
  "optionalHeaders": ["xyz789"],
  "otherConfigurations": [CsvUploadConfiguration],
  "requiredHeaders": ["abc123"],
  "updatedAt": "2007-12-03",
  "updatedBy": "abc123",
  "version": 987
}
Types

CsvUploadType

Values
Enum Value Description

asset

bin

lot

order

product

productMasterData

reorderRuleProduct

stockLocation

user
Example
"asset"
Types

Currency

Values
Enum Value Description

AUD

CAD

CHF

CNY

EUR

GBP

HKD

JPY

NZD

USD
Example
"AUD"
Types

CustomFieldEntityType

Values
Enum Value Description

asset

assetTransaction

bin

companyRole

contact

container

containerTransaction

lot

order

product

productMasterData

productTransaction

stockLocation
Example
"asset"
Types

CustomFieldType

Values
Enum Value Description

bool

date

file

image

listOfTuples

listOfValues

number

text
Example
"bool"
Types

CustomFieldValue

Fields
Field Name Description
displayMobile - Boolean
entityType - CustomFieldEntityType
external - Boolean
generated - Boolean
hidden - Boolean
id - String!
index - Float
mandatory - Boolean
name - String
onCreate - Boolean
parentId - String
reference - String
type - CustomFieldType
unitOfMeasure - UnitOfMeasure
value - String!
Example
{
  "displayMobile": false,
  "entityType": "asset",
  "external": false,
  "generated": true,
  "hidden": true,
  "id": "abc123",
  "index": 987.65,
  "mandatory": true,
  "name": "abc123",
  "onCreate": true,
  "parentId": "abc123",
  "reference": "abc123",
  "type": "bool",
  "unitOfMeasure": UnitOfMeasure,
  "value": "abc123"
}
Types

Date

Example
"2007-12-03"
Types

DeleteBinStatusInput

Fields
Input Field Description
companyId - String!
externalIdentifier - ExternalEntityIdentifierInput
id - String!
version - Float!
Example
{
  "companyId": "xyz789",
  "externalIdentifier": ExternalEntityIdentifierInput,
  "id": "abc123",
  "version": 123.45
}
Types

DeleteContactInput

Fields
Input Field Description
companyId - String!
externalIdentifier - ExternalEntityIdentifierInput
id - String!
version - Float!
Example
{
  "companyId": "abc123",
  "externalIdentifier": ExternalEntityIdentifierInput,
  "id": "xyz789",
  "version": 123.45
}
Types

DeleteCsvUploadConfigurationInput

Fields
Input Field Description
companyId - String!
externalIdentifier - ExternalEntityIdentifierInput
id - String!
version - Float!
Example
{
  "companyId": "abc123",
  "externalIdentifier": ExternalEntityIdentifierInput,
  "id": "abc123",
  "version": 987.65
}
Types

Dimensions

Fields
Field Name Description
depth - Float!
height - Float!
length - Float
unit - LengthUnit!
width - Float!
Example
{
  "depth": 123.45,
  "height": 987.65,
  "length": 123.45,
  "unit": "centimeter",
  "width": 987.65
}
Types

Document

Fields
Field Name Description
createdAt - String!
extension - String!
name - String!
url - String!
Example
{
  "createdAt": "xyz789",
  "extension": "abc123",
  "name": "xyz789",
  "url": "abc123"
}
Types

EntityType

Values
Enum Value Description

asset

bin

container

kit

lot

order

pmd

product

productTransaction

reorderRule

serial

stockLocation

task

user
Example
"asset"
Types

ExternalEntityIdentifier

Fields
Field Name Description
additionalInfo - String
externalId - String
settingsId - String
source - String
type - String
Example
{
  "additionalInfo": "xyz789",
  "externalId": "xyz789",
  "settingsId": "xyz789",
  "source": "abc123",
  "type": "abc123"
}
Types

ExternalEntityIdentifierInput

Fields
Input Field Description
additionalInfo - String
externalId - String
settingsId - String
source - String
type - String
Example
{
  "additionalInfo": "xyz789",
  "externalId": "xyz789",
  "settingsId": "abc123",
  "source": "xyz789",
  "type": "xyz789"
}
Types

FeatureToggles

Fields
Field Name Description
alerts - AlertFeatureToggles!
assets - AssetFeatureToggles!
company - CompanyFeatureToggles!
containers - ContainerFeatureToggles!
kits - KitFeatureToggles
lots - LotFeatureToggles
orders - OrderFeatureToggles!
productTransactions - ProductTransactionFeatureToggles!
products - ProductFeatureToggles!
sap - SAPFeatureToggles
scan - ScanFeatureToggles
tasks - TaskFeatureToggles!
Example
{
  "alerts": AlertFeatureToggles,
  "assets": AssetFeatureToggles,
  "company": CompanyFeatureToggles,
  "containers": ContainerFeatureToggles,
  "kits": KitFeatureToggles,
  "lots": LotFeatureToggles,
  "orders": OrderFeatureToggles,
  "productTransactions": ProductTransactionFeatureToggles,
  "products": ProductFeatureToggles,
  "sap": SAPFeatureToggles,
  "scan": ScanFeatureToggles,
  "tasks": TaskFeatureToggles
}
Types

Float

Description

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

Example
987.65
Types

HandlingUnit

Fields
Field Name Description
companyId - String!
createdAt - Date
createdBy - String
default - Boolean
externalIdentifier - ExternalEntityIdentifier
id - String
parentId - String!
productMasterDataId - String!
quantity - Float!
updatedAt - Date
updatedBy - String
version - Int
Example
{
  "companyId": "xyz789",
  "createdAt": "2007-12-03",
  "createdBy": "xyz789",
  "default": false,
  "externalIdentifier": ExternalEntityIdentifier,
  "id": "abc123",
  "parentId": "abc123",
  "productMasterDataId": "abc123",
  "quantity": 987.65,
  "updatedAt": "2007-12-03",
  "updatedBy": "xyz789",
  "version": 987
}
Types

HandlingUnitUpdateNotification

Fields
Field Name Description
companyId - String!
date - Date!
entities - [HandlingUnit!]!
topic - String!
Example
{
  "companyId": "xyz789",
  "date": "2007-12-03",
  "entities": [HandlingUnit],
  "topic": "xyz789"
}
Types

ILot

Fields
Field Name Description
customFields - [CustomFieldValue!]
expirationDate - String
labels - [String!]
number - String!
productMasterDataId - String!
Possible Types
ILot Types

Lot

Example
{
  "customFields": [CustomFieldValue],
  "expirationDate": "xyz789",
  "labels": ["xyz789"],
  "number": "xyz789",
  "productMasterDataId": "abc123"
}
Types

ImageFile

Fields
Field Name Description
createdAt - String!
index - Float
quality - ImageQuality
url - String!
Example
{
  "createdAt": "xyz789",
  "index": 987.65,
  "quality": "high",
  "url": "xyz789"
}
Types

ImageQuality

Values
Enum Value Description

high

low

medium
Example
"high"
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

IntegrationSettings

Fields
Field Name Description
apiKey - String
companyId - String!
createdAt - Date
createdBy - String
environment - String
externalCompanyId - String
externalIdentifier - ExternalEntityIdentifier
externalInfo - String
id - String
name - String!
plantId - String
tenantId - String
type - CompanyRelationService!
updatedAt - Date
updatedBy - String
url - String
userId - String
version - Int
Example
{
  "apiKey": "xyz789",
  "companyId": "xyz789",
  "createdAt": "2007-12-03",
  "createdBy": "xyz789",
  "environment": "xyz789",
  "externalCompanyId": "abc123",
  "externalIdentifier": ExternalEntityIdentifier,
  "externalInfo": "xyz789",
  "id": "xyz789",
  "name": "abc123",
  "plantId": "abc123",
  "tenantId": "xyz789",
  "type": "businessCentral",
  "updatedAt": "2007-12-03",
  "updatedBy": "xyz789",
  "url": "abc123",
  "userId": "abc123",
  "version": 123
}
Types

IntegrationSettingsUpdateNotification

Fields
Field Name Description
companyId - String!
date - Date!
entities - [IntegrationSettings!]!
topic - String!
Example
{
  "companyId": "xyz789",
  "date": "2007-12-03",
  "entities": [IntegrationSettings],
  "topic": "xyz789"
}
Types

Kit

Fields
Field Name Description
companyId - String!
createdAt - Date
createdBy - String
externalIdentifier - ExternalEntityIdentifier
id - String
identifier - String!
templateId - String!
updatedAt - Date
updatedBy - String
version - Int
Example
{
  "companyId": "abc123",
  "createdAt": "2007-12-03",
  "createdBy": "abc123",
  "externalIdentifier": ExternalEntityIdentifier,
  "id": "abc123",
  "identifier": "abc123",
  "templateId": "xyz789",
  "updatedAt": "2007-12-03",
  "updatedBy": "abc123",
  "version": 987
}
Types

KitFeatureToggles

Fields
Field Name Description
kits - Boolean
refillKits - Boolean
Example
{"kits": false, "refillKits": false}
Types

KitProduct

Fields
Field Name Description
productMasterDataId - String!
quantity - Float!
Example
{
  "productMasterDataId": "xyz789",
  "quantity": 123.45
}
Types

KitSpecifiers

Fields
Field Name Description
complete - Boolean
fromKitId - String
templateId - String
toKitId - String
Example
{
  "complete": true,
  "fromKitId": "xyz789",
  "templateId": "abc123",
  "toKitId": "abc123"
}
Types

KitTemplate

Fields
Field Name Description
companyId - String!
createdAt - Date
createdBy - String
externalIdentifier - ExternalEntityIdentifier
id - String
name - String!
productMasterDataId - String!
products - [KitProduct!]!
updatedAt - Date
updatedBy - String
version - Int
Example
{
  "companyId": "abc123",
  "createdAt": "2007-12-03",
  "createdBy": "abc123",
  "externalIdentifier": ExternalEntityIdentifier,
  "id": "abc123",
  "name": "abc123",
  "productMasterDataId": "xyz789",
  "products": [KitProduct],
  "updatedAt": "2007-12-03",
  "updatedBy": "abc123",
  "version": 123
}
Types

KitTemplateUpdateNotification

Fields
Field Name Description
companyId - String!
date - Date!
entities - [KitTemplate!]!
topic - String!
Example
{
  "companyId": "xyz789",
  "date": "2007-12-03",
  "entities": [KitTemplate],
  "topic": "xyz789"
}
Types

KitUpdateNotification

Fields
Field Name Description
companyId - String!
date - Date!
entities - [Kit!]!
topic - String!
Example
{
  "companyId": "xyz789",
  "date": "2007-12-03",
  "entities": [Kit],
  "topic": "xyz789"
}
Types

LengthUnit

Values
Enum Value Description

centimeter

decimeter

foot

inch

meter

millimeter

yard
Example
"centimeter"
Types

Lot

Fields
Field Name Description
companyId - String!
createdAt - Date
createdBy - String
customFields - [CustomFieldValue!]
expirationDate - String
externalIdentifier - ExternalEntityIdentifier
id - String
labels - [String!]
number - String!
productMasterDataId - String!
updatedAt - Date
updatedBy - String
version - Int
Example
{
  "companyId": "abc123",
  "createdAt": "2007-12-03",
  "createdBy": "abc123",
  "customFields": [CustomFieldValue],
  "expirationDate": "xyz789",
  "externalIdentifier": ExternalEntityIdentifier,
  "id": "xyz789",
  "labels": ["abc123"],
  "number": "xyz789",
  "productMasterDataId": "abc123",
  "updatedAt": "2007-12-03",
  "updatedBy": "xyz789",
  "version": 123
}
Types

LotFeatureToggles

Fields
Field Name Description
expiryManagement - Boolean
lotUniqueCompany - Boolean
lotUniqueProductMasterData - Boolean
lots - Boolean
Example
{
  "expiryManagement": true,
  "lotUniqueCompany": false,
  "lotUniqueProductMasterData": false,
  "lots": true
}
Types

LotUpdateNotification

Fields
Field Name Description
companyId - String!
date - Date!
entities - [Lot!]!
topic - String!
Example
{
  "companyId": "xyz789",
  "date": "2007-12-03",
  "entities": [Lot],
  "topic": "xyz789"
}
Types

MobileConfigurationType

Values
Enum Value Description

current

legacy
Example
"current"
Types

MobileStockLocationSession

Fields
Field Name Description
companyId - String!
coordinates - Coordinates!
createdAt - Date
createdBy - String
externalIdentifier - ExternalEntityIdentifier
id - String
status - MobileStockLocationSessionStatus!
stockLocationId - String!
updatedAt - Date
updatedBy - String
version - Int
Example
{
  "companyId": "xyz789",
  "coordinates": Coordinates,
  "createdAt": "2007-12-03",
  "createdBy": "xyz789",
  "externalIdentifier": ExternalEntityIdentifier,
  "id": "xyz789",
  "status": "active",
  "stockLocationId": "xyz789",
  "updatedAt": "2007-12-03",
  "updatedBy": "abc123",
  "version": 123
}
Types

MobileStockLocationSessionNotification

Fields
Field Name Description
companyId - String!
date - Date!
entities - [MobileStockLocationSession!]!
topic - String!
Example
{
  "companyId": "xyz789",
  "date": "2007-12-03",
  "entities": [MobileStockLocationSession],
  "topic": "abc123"
}
Types

MobileStockLocationSessionStatus

Values
Enum Value Description

active

completed
Example
"active"
Types

Order

Fields
Field Name Description
address - Address
assignedTo - [String!]
companyId - String!
contactId - String
contactLocation - ShippingLocation
createdAt - Date
createdBy - String
customFields - [CustomFieldValue!]
estimatedTimeOfArrival - Date
externalIdentifier - ExternalEntityIdentifier
externalReferenceId - String
fromStockLocationId - String
id - String
number - String
parentId - String
parentType - String
products - [ProductTransactionSpecifiers!]!
purchaseOrderNumber - String
status - OrderStatus!
toStockLocationId - String
type - OrderType!
updatedAt - Date
updatedBy - String
version - Int
Example
{
  "address": Address,
  "assignedTo": ["xyz789"],
  "companyId": "xyz789",
  "contactId": "abc123",
  "contactLocation": ShippingLocation,
  "createdAt": "2007-12-03",
  "createdBy": "abc123",
  "customFields": [CustomFieldValue],
  "estimatedTimeOfArrival": "2007-12-03",
  "externalIdentifier": ExternalEntityIdentifier,
  "externalReferenceId": "xyz789",
  "fromStockLocationId": "abc123",
  "id": "abc123",
  "number": "abc123",
  "parentId": "abc123",
  "parentType": "abc123",
  "products": [ProductTransactionSpecifiers],
  "purchaseOrderNumber": "xyz789",
  "status": "archived",
  "toStockLocationId": "abc123",
  "type": "disposal",
  "updatedAt": "2007-12-03",
  "updatedBy": "abc123",
  "version": 987
}
Types

OrderFeatureToggles

Fields
Field Name Description
customer - Boolean
editProductsOnDisposal - Boolean
editProductsOnInbound - Boolean
editProductsOnMove - Boolean
editProductsOnOutbound - Boolean
estimatedTimeOfArrival - Boolean
externalReferenceId - Boolean
ignoreAvailableQuantity - Boolean
orders - Boolean!
picking - Boolean
processCompletedOrders - Boolean
productBasedApproach - Boolean
productSelectionFirst - Boolean
purchaseOrderNumber - Boolean
quickOrder - Boolean
sendMailOnAssigned - Boolean
supplier - Boolean
Example
{
  "customer": false,
  "editProductsOnDisposal": false,
  "editProductsOnInbound": true,
  "editProductsOnMove": true,
  "editProductsOnOutbound": true,
  "estimatedTimeOfArrival": false,
  "externalReferenceId": true,
  "ignoreAvailableQuantity": false,
  "orders": false,
  "picking": true,
  "processCompletedOrders": true,
  "productBasedApproach": true,
  "productSelectionFirst": true,
  "purchaseOrderNumber": false,
  "quickOrder": true,
  "sendMailOnAssigned": true,
  "supplier": false
}
Types

OrderStatus

Values
Enum Value Description

archived

arrived

cancelled

complete

created

disabled

draft

failed

inProgress

open

pickingComplete

released

shipped
Example
"archived"
Types

OrderType

Values
Enum Value Description

disposal

inbound

move

outbound

replenish
Example
"disposal"
Types

OrderUpdateNotification

Fields
Field Name Description
companyId - String!
date - Date!
entities - [Order!]!
topic - String!
Example
{
  "companyId": "abc123",
  "date": "2007-12-03",
  "entities": [Order],
  "topic": "xyz789"
}
Types

PaginatedCompany

Fields
Field Name Description
batchSize - Float!
data - [Company!]!
hasNext - Boolean!
page - Float!
pageSize - Float!
Example
{
  "batchSize": 123.45,
  "data": [Company],
  "hasNext": true,
  "page": 123.45,
  "pageSize": 123.45
}
Types

Price

Fields
Field Name Description
currency - Currency!
value - Float!
Example
{"currency": "AUD", "value": 987.65}
Types

Product

Fields
Field Name Description
binId - String!
companyId - String!
containerId - String
createdAt - Date
createdBy - String
externalIdentifier - ExternalEntityIdentifier
id - String
identifier - String
kitId - String
lotId - String
lpn - String
productMasterDataId - String
serial - String
stockLocationId - String!
unitQuantity - String!
updatedAt - Date
updatedBy - String
version - Int
Example
{
  "binId": "xyz789",
  "companyId": "abc123",
  "containerId": "xyz789",
  "createdAt": "2007-12-03",
  "createdBy": "xyz789",
  "externalIdentifier": ExternalEntityIdentifier,
  "id": "xyz789",
  "identifier": "abc123",
  "kitId": "xyz789",
  "lotId": "abc123",
  "lpn": "abc123",
  "productMasterDataId": "abc123",
  "serial": "abc123",
  "stockLocationId": "xyz789",
  "unitQuantity": "abc123",
  "updatedAt": "2007-12-03",
  "updatedBy": "xyz789",
  "version": 987
}
Types

ProductFeatureToggles

Fields
Field Name Description
container - Boolean
displayEmptyStock - Boolean
gs1Barcodes - Boolean
products - Boolean!
Example
{
  "container": false,
  "displayEmptyStock": false,
  "gs1Barcodes": false,
  "products": false
}
Types

ProductMasterData

Fields
Field Name Description
companyId - String!
countryOfOrigin - String
createdAt - Date
createdBy - String
customFields - [CustomFieldValue!]
dimensions - Dimensions
documents - [Document!]
expiryTracking - Boolean
externalIdentifier - ExternalEntityIdentifier
globalTradeItemNumber - String
grossWeight - Weight
handlingUnit - Boolean
id - String
image - String
kitManaged - Boolean
labels - [String!]
lotManaged - Boolean
lpnManaged - Boolean
manufacturer - String
netWeight - Weight
originalEquipmentManufacturer - String
productCategory - String
productImages - [ImageFile!]
productName - String!
productNumber - String!
purchasePrice - Price
reorderPoint - Float
sellingPrice - Price
serialManaged - Boolean
unitOfMeasure - UnitOfMeasure
updatedAt - Date
updatedBy - String
version - Int
Example
{
  "companyId": "xyz789",
  "countryOfOrigin": "abc123",
  "createdAt": "2007-12-03",
  "createdBy": "abc123",
  "customFields": [CustomFieldValue],
  "dimensions": Dimensions,
  "documents": [Document],
  "expiryTracking": false,
  "externalIdentifier": ExternalEntityIdentifier,
  "globalTradeItemNumber": "abc123",
  "grossWeight": Weight,
  "handlingUnit": true,
  "id": "abc123",
  "image": "abc123",
  "kitManaged": true,
  "labels": ["abc123"],
  "lotManaged": false,
  "lpnManaged": false,
  "manufacturer": "abc123",
  "netWeight": Weight,
  "originalEquipmentManufacturer": "xyz789",
  "productCategory": "xyz789",
  "productImages": [ImageFile],
  "productName": "abc123",
  "productNumber": "abc123",
  "purchasePrice": Price,
  "reorderPoint": 123.45,
  "sellingPrice": Price,
  "serialManaged": false,
  "unitOfMeasure": UnitOfMeasure,
  "updatedAt": "2007-12-03",
  "updatedBy": "abc123",
  "version": 123
}
Types

ProductMasterDataUpdateNotification

Fields
Field Name Description
companyId - String!
date - Date!
entities - [ProductMasterData!]!
topic - String!
Example
{
  "companyId": "abc123",
  "date": "2007-12-03",
  "entities": [ProductMasterData],
  "topic": "xyz789"
}
Types

ProductTransaction

Fields
Field Name Description
companyId - String!
containerTransactionId - String
createdAt - Date
createdBy - String
customFields - [CustomFieldValue!]
externalIdentifier - ExternalEntityIdentifier
id - String
kitTransactionId - String
metadata - ProductTransactionMetaData
parentId - String
parentType - ProductTransactionParentType
pickedAt - Date
pickedBy - String
processType - String
processedAt - Date
processedBy - String
product - ProductTransactionSpecifiers!
reasonForFailure - String
status - ProductTransactionStatus!
synced - Boolean
type - ProductTransactionType!
updatedAt - Date
updatedBy - String
version - Int
Example
{
  "companyId": "xyz789",
  "containerTransactionId": "abc123",
  "createdAt": "2007-12-03",
  "createdBy": "abc123",
  "customFields": [CustomFieldValue],
  "externalIdentifier": ExternalEntityIdentifier,
  "id": "xyz789",
  "kitTransactionId": "xyz789",
  "metadata": ProductTransactionMetaData,
  "parentId": "abc123",
  "parentType": "break",
  "pickedAt": "2007-12-03",
  "pickedBy": "abc123",
  "processType": "xyz789",
  "processedAt": "2007-12-03",
  "processedBy": "xyz789",
  "product": ProductTransactionSpecifiers,
  "reasonForFailure": "xyz789",
  "status": "archived",
  "synced": true,
  "type": "inbound",
  "updatedAt": "2007-12-03",
  "updatedBy": "abc123",
  "version": 987
}
Types

ProductTransactionFeatureToggles

Fields
Field Name Description
mobile - Boolean
productTransactions - Boolean!
quickActions - Boolean
scanRequired - Boolean
web - Boolean
Example
{
  "mobile": false,
  "productTransactions": false,
  "quickActions": true,
  "scanRequired": true,
  "web": true
}
Types

ProductTransactionMetaData

Fields
Field Name Description
assignedUser - User
container - Container
fromBin - Bin
fromContainer - Container
fromKit - Kit
fromStockLocation - StockLocation
handlingUnit - HandlingUnit
kitTemplate - KitTemplate
lot - Lot
order - Order
product - ProductTransactionProductMetaData
productMasterData - ProductMasterData
toBin - Bin
toContainer - Container
toKit - Kit
toStockLocation - StockLocation
user - User
Example
{
  "assignedUser": User,
  "container": Container,
  "fromBin": Bin,
  "fromContainer": Container,
  "fromKit": Kit,
  "fromStockLocation": StockLocation,
  "handlingUnit": HandlingUnit,
  "kitTemplate": KitTemplate,
  "lot": Lot,
  "order": Order,
  "product": ProductTransactionProductMetaData,
  "productMasterData": ProductMasterData,
  "toBin": Bin,
  "toContainer": Container,
  "toKit": Kit,
  "toStockLocation": StockLocation,
  "user": User
}
Types

ProductTransactionParentType

Values
Enum Value Description

break

bundle

order

quickAction

task

transaction

upload
Example
"break"
Types

ProductTransactionProductMetaData

Fields
Field Name Description
fromQuantity - Float
toQuantity - Float
Example
{"fromQuantity": 987.65, "toQuantity": 987.65}
Types

ProductTransactionSpecifiers

Fields
Field Name Description
containerComplete - Boolean
containerId - String
fromBinId - String
fromContainerId - String
fromCustomFields - [CustomFieldValue!]
fromProductId - String
fromStockLocationId - String
handlingUnitId - String
identifier - String
kit - KitSpecifiers
lotId - String
lpn - String
origin - String
originQuantity - Float
pmdId - String
processedQuantity - Float
quantity - Float!
serialNbr - String
toBinId - String
toContainerId - String
toCustomFields - [CustomFieldValue!]
toProductId - String
toStockLocationId - String
Example
{
  "containerComplete": false,
  "containerId": "abc123",
  "fromBinId": "xyz789",
  "fromContainerId": "xyz789",
  "fromCustomFields": [CustomFieldValue],
  "fromProductId": "abc123",
  "fromStockLocationId": "abc123",
  "handlingUnitId": "xyz789",
  "identifier": "abc123",
  "kit": KitSpecifiers,
  "lotId": "xyz789",
  "lpn": "xyz789",
  "origin": "abc123",
  "originQuantity": 123.45,
  "pmdId": "xyz789",
  "processedQuantity": 123.45,
  "quantity": 123.45,
  "serialNbr": "abc123",
  "toBinId": "xyz789",
  "toContainerId": "abc123",
  "toCustomFields": [CustomFieldValue],
  "toProductId": "xyz789",
  "toStockLocationId": "xyz789"
}
Types

ProductTransactionStatus

Values
Enum Value Description

archived

cancelled

created

picked

processed

rollback
Example
"archived"
Types

ProductTransactionType

Values
Enum Value Description

inbound

move

outbound

replenish
Example
"inbound"
Types

ProductTransactionUpdateNotification

Fields
Field Name Description
companyId - String!
date - Date!
entities - [ProductTransaction!]!
oldEntities - [ProductTransaction!]!
topic - String!
Example
{
  "companyId": "abc123",
  "date": "2007-12-03",
  "entities": [ProductTransaction],
  "oldEntities": [ProductTransaction],
  "topic": "xyz789"
}
Types

ProductUpdateNotification

Fields
Field Name Description
companyId - String!
date - Date!
entities - [Product!]!
topic - String!
Example
{
  "companyId": "abc123",
  "date": "2007-12-03",
  "entities": [Product],
  "topic": "abc123"
}
Types

RefillTaskOrderFeatureToggles

Fields
Field Name Description
ignoreOverstock - Boolean
refill - Boolean
Example
{"ignoreOverstock": false, "refill": true}
Types

SAPFeatureToggles

Fields
Field Name Description
allowUncounted - Boolean
Example
{"allowUncounted": true}
Types

ScanConfiguration

Fields
Field Name Description
barcodeFormat - BarcodeFormat!
regex - String!
regexOption - String
type - ScanConfigurationType!
typeId - String
Example
{
  "barcodeFormat": "all",
  "regex": "abc123",
  "regexOption": "xyz789",
  "type": "bin",
  "typeId": "abc123"
}
Types

ScanConfigurationType

Values
Enum Value Description

bin

container

coo

customField

lot

lotExpiryDate

lpn

manufacturingDate

productNumber

serial

stockLocation
Example
"bin"
Types

ScanFeatureToggles

Fields
Field Name Description
handleGS1LotSeparately - Boolean
handleGS1ProductNumberSeparately - Boolean
ignoreGS1Lot - Boolean
scanRequired - Boolean
scanRequiredWhitelist - [String!]
Example
{
  "handleGS1LotSeparately": false,
  "handleGS1ProductNumberSeparately": false,
  "ignoreGS1Lot": true,
  "scanRequired": false,
  "scanRequiredWhitelist": ["xyz789"]
}
Types

ShippingLocation

Fields
Field Name Description
address - Address
email - String
name - String!
stockLocationId - String
Example
{
  "address": Address,
  "email": "xyz789",
  "name": "abc123",
  "stockLocationId": "xyz789"
}
Types

StockLocation

Fields
Field Name Description
address - Address
administrators - [String!]
companyId - String!
createdAt - Date
createdBy - String
customFields - [CustomFieldValue!]
externalIdentifier - ExternalEntityIdentifier
id - String
identifier - String
image - String
mobile - Boolean
name - String!
refillId - String
updatedAt - Date
updatedBy - String
version - Int
Example
{
  "address": Address,
  "administrators": ["xyz789"],
  "companyId": "abc123",
  "createdAt": "2007-12-03",
  "createdBy": "xyz789",
  "customFields": [CustomFieldValue],
  "externalIdentifier": ExternalEntityIdentifier,
  "id": "xyz789",
  "identifier": "abc123",
  "image": "abc123",
  "mobile": false,
  "name": "abc123",
  "refillId": "xyz789",
  "updatedAt": "2007-12-03",
  "updatedBy": "xyz789",
  "version": 987
}
Types

StockLocationAggregateType

Values
Enum Value Description

all

allOf

any

anyOf
Example
"all"
Types

StockLocationUpdateNotification

Fields
Field Name Description
companyId - String!
date - Date!
entities - [StockLocation!]!
topic - String!
Example
{
  "companyId": "abc123",
  "date": "2007-12-03",
  "entities": [StockLocation],
  "topic": "xyz789"
}
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

Task

Fields
Field Name Description
additionalEmails - [String!]
assignedForRecount - [String!]
assignedTo - [String!]!
companyId - String!
completedOn - Date
createdAt - Date
createdBy - String
dueDate - Date
externalIdentifier - ExternalEntityIdentifier
externalReferenceId - String
id - String
identifiers - [TaskIdentifier!]
number - String
overdue - Boolean
parentId - String
parentType - String
status - TaskStatus!
stockLocationId - String!
type - TaskType!
updatedAt - Date
updatedBy - String
validation - TaskValidation!
version - Int
Example
{
  "additionalEmails": ["xyz789"],
  "assignedForRecount": ["xyz789"],
  "assignedTo": ["xyz789"],
  "companyId": "abc123",
  "completedOn": "2007-12-03",
  "createdAt": "2007-12-03",
  "createdBy": "xyz789",
  "dueDate": "2007-12-03",
  "externalIdentifier": ExternalEntityIdentifier,
  "externalReferenceId": "xyz789",
  "id": "abc123",
  "identifiers": [TaskIdentifier],
  "number": "abc123",
  "overdue": true,
  "parentId": "xyz789",
  "parentType": "xyz789",
  "status": "complete",
  "stockLocationId": "xyz789",
  "type": "blind",
  "updatedAt": "2007-12-03",
  "updatedBy": "abc123",
  "validation": TaskValidation,
  "version": 987
}
Types

TaskFeatureToggles

Fields
Field Name Description
allowStockUpdate - Boolean!
blindCount - Boolean
cycleCount - Boolean
quickCount - Boolean
taskOrders - TaskOrderFeatureToggles
tasks - Boolean!
Example
{
  "allowStockUpdate": false,
  "blindCount": true,
  "cycleCount": true,
  "quickCount": true,
  "taskOrders": TaskOrderFeatureToggles,
  "tasks": false
}
Types

TaskIdentifier

Fields
Field Name Description
ids - [String!]!
type - EntityType!
Example
{"ids": ["abc123"], "type": "asset"}
Types

TaskOrderFeatureToggles

Fields
Field Name Description
auto - Boolean
inbound - Boolean!
move - Boolean!
outbound - Boolean!
refill - RefillTaskOrderFeatureToggles
taskOrders - Boolean!
Example
{
  "auto": true,
  "inbound": true,
  "move": true,
  "outbound": true,
  "refill": RefillTaskOrderFeatureToggles,
  "taskOrders": true
}
Types

TaskProduct

Fields
Field Name Description
companyId - String!
countedAt - Date
countedBy - String
countedQuantity - Float
createdAt - Date
createdBy - String
customFields - [CustomFieldValue!]
externalIdentifier - ExternalEntityIdentifier
id - String
product - Product!
stockLocationId - String
taskId - String!
updatedAt - Date
updatedBy - String
version - Int
Example
{
  "companyId": "xyz789",
  "countedAt": "2007-12-03",
  "countedBy": "abc123",
  "countedQuantity": 123.45,
  "createdAt": "2007-12-03",
  "createdBy": "xyz789",
  "customFields": [CustomFieldValue],
  "externalIdentifier": ExternalEntityIdentifier,
  "id": "xyz789",
  "product": Product,
  "stockLocationId": "abc123",
  "taskId": "abc123",
  "updatedAt": "2007-12-03",
  "updatedBy": "xyz789",
  "version": 123
}
Types

TaskProductUpdateNotification

Fields
Field Name Description
companyId - String!
date - Date!
entities - [TaskProduct!]!
topic - String!
Example
{
  "companyId": "abc123",
  "date": "2007-12-03",
  "entities": [TaskProduct],
  "topic": "abc123"
}
Types

TaskStatus

Values
Enum Value Description

complete

created

failed

inProgress

processed
Example
"complete"
Types

TaskType

Values
Enum Value Description

blind

cycle
Example
"blind"
Types

TaskUpdateNotification

Fields
Field Name Description
companyId - String!
date - Date!
entities - [Task!]!
topic - String!
Example
{
  "companyId": "xyz789",
  "date": "2007-12-03",
  "entities": [Task],
  "topic": "abc123"
}
Types

TaskValidation

Fields
Field Name Description
quantity - Boolean
validationFields - [TaskValidationField!]
Example
{"quantity": true, "validationFields": ["container"]}
Types

TaskValidationField

Values
Enum Value Description

container

coo

lot

lpn

productNumber

serial
Example
"container"
Types

Trigger

Fields
Field Name Description
companyId - String!
createdAt - Date
createdBy - String
customFieldIds - [String!]
enabled - Boolean!
entityIds - [String!]!
entityParentType - TriggerEntityParentType
entityType - TriggerEntityType!
entityValue - String!
externalIdentifier - ExternalEntityIdentifier
id - String
notifyEntityAssignees - Boolean
stockLocationAggregateType - StockLocationAggregateType!
stockLocationIds - [String!]
types - [TriggerType!]!
updatedAt - Date
updatedBy - String
userIds - [String!]!
version - Int
Example
{
  "companyId": "xyz789",
  "createdAt": "2007-12-03",
  "createdBy": "abc123",
  "customFieldIds": ["abc123"],
  "enabled": false,
  "entityIds": ["xyz789"],
  "entityParentType": "order",
  "entityType": "customField",
  "entityValue": "xyz789",
  "externalIdentifier": ExternalEntityIdentifier,
  "id": "xyz789",
  "notifyEntityAssignees": true,
  "stockLocationAggregateType": "all",
  "stockLocationIds": ["xyz789"],
  "types": ["alert"],
  "updatedAt": "2007-12-03",
  "updatedBy": "xyz789",
  "userIds": ["xyz789"],
  "version": 123
}
Types

TriggerEntityParentType

Values
Enum Value Description

order
Example
"order"
Types

TriggerEntityType

Values
Enum Value Description

customField

lot

order

pmd

product

productTransaction

task
Example
"customField"
Types

TriggerType

Values
Enum Value Description

alert

email

pushNotification
Example
"alert"
Types

TriggerUpdateNotification

Fields
Field Name Description
companyId - String!
date - Date!
entities - [Trigger!]!
topic - String!
Example
{
  "companyId": "abc123",
  "date": "2007-12-03",
  "entities": [Trigger],
  "topic": "xyz789"
}
Types

Unit

Description

Unit for the Unit of Measure

Example
Unit
Types

UnitOfMeasure

Fields
Field Name Description
system - String!
unit - Unit!
unitType - String!
Example
{
  "system": "abc123",
  "unit": Unit,
  "unitType": "xyz789"
}
Types

UnitSystem

Values
Enum Value Description

metric
Example
"metric"
Types

UpdateCsvUploadConfigurationInput

Fields
Input Field Description
companyId - String!
createdAt - Date
createdBy - String
description - String
externalIdentifier - ExternalEntityIdentifierInput
headerMapping - [CsvUploadConfigurationMappingInput!]!
headerNames - [String!]!
id - String!
name - String!
type - CsvUploadType!
updatedAt - Date
updatedBy - String
version - Float!
Example
{
  "companyId": "abc123",
  "createdAt": "2007-12-03",
  "createdBy": "xyz789",
  "description": "abc123",
  "externalIdentifier": ExternalEntityIdentifierInput,
  "headerMapping": [CsvUploadConfigurationMappingInput],
  "headerNames": ["xyz789"],
  "id": "abc123",
  "name": "abc123",
  "type": "asset",
  "updatedAt": "2007-12-03",
  "updatedBy": "abc123",
  "version": 987.65
}
Types

User

Fields
Field Name Description
acceptedAgreements - Date
acceptedPrivacyPolicy - Date
acceptedTerms - Date
companyId - String
createdAt - Date
createdBy - String
email - String!
firstName - String!
id - String!
isOnboarded - Boolean
language - String
lastLogin - Date
lastName - String!
locale - String
notificationsToken - String
profilePicture - String
supportHMAC - String
type - String
unit - String
unitSetting - UnitSystem
updatedAt - Date
updatedBy - String
userId - String
verified - Boolean
version - Int!
Example
{
  "acceptedAgreements": "2007-12-03",
  "acceptedPrivacyPolicy": "2007-12-03",
  "acceptedTerms": "2007-12-03",
  "companyId": "abc123",
  "createdAt": "2007-12-03",
  "createdBy": "abc123",
  "email": "abc123",
  "firstName": "abc123",
  "id": "abc123",
  "isOnboarded": false,
  "language": "abc123",
  "lastLogin": "2007-12-03",
  "lastName": "abc123",
  "locale": "abc123",
  "notificationsToken": "xyz789",
  "profilePicture": "abc123",
  "supportHMAC": "abc123",
  "type": "xyz789",
  "unit": "xyz789",
  "unitSetting": "metric",
  "updatedAt": "2007-12-03",
  "updatedBy": "abc123",
  "userId": "abc123",
  "verified": false,
  "version": 123
}
Types

Weight

Fields
Field Name Description
unit - WeightUnit!
value - Float!
Example
{"unit": "gram", "value": 123.45}
Types

WeightUnit

Values
Enum Value Description

gram

kilogram

ounce

pound
Example
"gram"

Subscriptions

HandlingUnitNotification

Response

Returns a HandlingUnitUpdateNotification!

Arguments
Name Description
companyId - String!

Example

Query
subscription HandlingUnitNotification($companyId: String!) {
  HandlingUnitNotification(companyId: $companyId) {
    companyId
    date
    entities {
      ...HandlingUnitFragment
    }
    topic
  }
}
Variables
{"companyId": "xyz789"}
Response
{
  "data": {
    "HandlingUnitNotification": {
      "companyId": "xyz789",
      "date": "2007-12-03",
      "entities": [HandlingUnit],
      "topic": "xyz789"
    }
  }
}
Subscriptions

alertNotification

Response

Returns an AlertUpdateNotification!

Arguments
Name Description
companyId - String!

Example

Query
subscription alertNotification($companyId: String!) {
  alertNotification(companyId: $companyId) {
    companyId
    date
    entities {
      ...AlertWithEntityFragment
    }
    topic
  }
}
Variables
{"companyId": "abc123"}
Response
{
  "data": {
    "alertNotification": {
      "companyId": "abc123",
      "date": "2007-12-03",
      "entities": [AlertWithEntity],
      "topic": "xyz789"
    }
  }
}
Subscriptions

assetNotification

Response

Returns an AssetUpdateNotification!

Arguments
Name Description
companyId - String!

Example

Query
subscription assetNotification($companyId: String!) {
  assetNotification(companyId: $companyId) {
    companyId
    date
    entities {
      ...AssetFragment
    }
    topic
  }
}
Variables
{"companyId": "abc123"}
Response
{
  "data": {
    "assetNotification": {
      "companyId": "xyz789",
      "date": "2007-12-03",
      "entities": [Asset],
      "topic": "abc123"
    }
  }
}
Subscriptions

assetTransactionNotification

Response

Returns an AssetTransactionUpdateNotification!

Arguments
Name Description
companyId - String!

Example

Query
subscription assetTransactionNotification($companyId: String!) {
  assetTransactionNotification(companyId: $companyId) {
    companyId
    date
    entities {
      ...AssetTransactionFragment
    }
    topic
  }
}
Variables
{"companyId": "abc123"}
Response
{
  "data": {
    "assetTransactionNotification": {
      "companyId": "xyz789",
      "date": "2007-12-03",
      "entities": [AssetTransaction],
      "topic": "abc123"
    }
  }
}
Subscriptions

binNotification

Response

Returns a BinUpdateNotification!

Arguments
Name Description
companyId - String!

Example

Query
subscription binNotification($companyId: String!) {
  binNotification(companyId: $companyId) {
    companyId
    date
    entities {
      ...BinFragment
    }
    topic
  }
}
Variables
{"companyId": "xyz789"}
Response
{
  "data": {
    "binNotification": {
      "companyId": "abc123",
      "date": "2007-12-03",
      "entities": [Bin],
      "topic": "xyz789"
    }
  }
}
Subscriptions

binStatusNotification

Response

Returns a BinStatusUpdateNotification!

Arguments
Name Description
companyId - String!

Example

Query
subscription binStatusNotification($companyId: String!) {
  binStatusNotification(companyId: $companyId) {
    companyId
    date
    entities {
      ...BinStatusFragment
    }
    topic
  }
}
Variables
{"companyId": "xyz789"}
Response
{
  "data": {
    "binStatusNotification": {
      "companyId": "xyz789",
      "date": "2007-12-03",
      "entities": [BinStatus],
      "topic": "xyz789"
    }
  }
}
Subscriptions

commentNotification

Response

Returns a CommentUpdateNotification!

Arguments
Name Description
companyId - String!

Example

Query
subscription commentNotification($companyId: String!) {
  commentNotification(companyId: $companyId) {
    companyId
    date
    entities {
      ...CommentFragment
    }
    topic
  }
}
Variables
{"companyId": "xyz789"}
Response
{
  "data": {
    "commentNotification": {
      "companyId": "abc123",
      "date": "2007-12-03",
      "entities": [Comment],
      "topic": "xyz789"
    }
  }
}
Subscriptions

companyConnectionNotification

Response

Returns a CompanyConnectionUpdateNotification!

Arguments
Name Description
companyId - String!

Example

Query
subscription companyConnectionNotification($companyId: String!) {
  companyConnectionNotification(companyId: $companyId) {
    companyId
    date
    entities {
      ...CompanyConnectionFragment
    }
    topic
  }
}
Variables
{"companyId": "xyz789"}
Response
{
  "data": {
    "companyConnectionNotification": {
      "companyId": "xyz789",
      "date": "2007-12-03",
      "entities": [CompanyConnection],
      "topic": "xyz789"
    }
  }
}
Subscriptions

contactNotification

Response

Returns a ContactUpdateNotification!

Arguments
Name Description
companyId - String!

Example

Query
subscription contactNotification($companyId: String!) {
  contactNotification(companyId: $companyId) {
    companyId
    date
    entities {
      ...ContactFragment
    }
    topic
  }
}
Variables
{"companyId": "abc123"}
Response
{
  "data": {
    "contactNotification": {
      "companyId": "xyz789",
      "date": "2007-12-03",
      "entities": [Contact],
      "topic": "abc123"
    }
  }
}
Subscriptions

containerNotification

Response

Returns a ContainerUpdateNotification!

Arguments
Name Description
companyId - String!

Example

Query
subscription containerNotification($companyId: String!) {
  containerNotification(companyId: $companyId) {
    companyId
    date
    entities {
      ...ContainerFragment
    }
    topic
  }
}
Variables
{"companyId": "xyz789"}
Response
{
  "data": {
    "containerNotification": {
      "companyId": "abc123",
      "date": "2007-12-03",
      "entities": [Container],
      "topic": "xyz789"
    }
  }
}
Subscriptions

fileStatusNotification

Response

Returns a CsvFileStatusNotification!

Example

Query
subscription fileStatusNotification {
  fileStatusNotification {
    fileName
    progress
    row
  }
}
Response
{
  "data": {
    "fileStatusNotification": {
      "fileName": "xyz789",
      "progress": 123.45,
      "row": 987
    }
  }
}
Subscriptions

integrationSettingsNotification

Response

Returns an IntegrationSettingsUpdateNotification!

Arguments
Name Description
companyId - String!

Example

Query
subscription integrationSettingsNotification($companyId: String!) {
  integrationSettingsNotification(companyId: $companyId) {
    companyId
    date
    entities {
      ...IntegrationSettingsFragment
    }
    topic
  }
}
Variables
{"companyId": "abc123"}
Response
{
  "data": {
    "integrationSettingsNotification": {
      "companyId": "xyz789",
      "date": "2007-12-03",
      "entities": [IntegrationSettings],
      "topic": "xyz789"
    }
  }
}
Subscriptions

kitNotification

Response

Returns a KitUpdateNotification!

Arguments
Name Description
companyId - String!

Example

Query
subscription kitNotification($companyId: String!) {
  kitNotification(companyId: $companyId) {
    companyId
    date
    entities {
      ...KitFragment
    }
    topic
  }
}
Variables
{"companyId": "xyz789"}
Response
{
  "data": {
    "kitNotification": {
      "companyId": "abc123",
      "date": "2007-12-03",
      "entities": [Kit],
      "topic": "xyz789"
    }
  }
}
Subscriptions

kitTemplateNotification

Response

Returns a KitTemplateUpdateNotification!

Arguments
Name Description
companyId - String!

Example

Query
subscription kitTemplateNotification($companyId: String!) {
  kitTemplateNotification(companyId: $companyId) {
    companyId
    date
    entities {
      ...KitTemplateFragment
    }
    topic
  }
}
Variables
{"companyId": "abc123"}
Response
{
  "data": {
    "kitTemplateNotification": {
      "companyId": "abc123",
      "date": "2007-12-03",
      "entities": [KitTemplate],
      "topic": "abc123"
    }
  }
}
Subscriptions

lotNotification

Response

Returns a LotUpdateNotification!

Arguments
Name Description
companyId - String!

Example

Query
subscription lotNotification($companyId: String!) {
  lotNotification(companyId: $companyId) {
    companyId
    date
    entities {
      ...LotFragment
    }
    topic
  }
}
Variables
{"companyId": "xyz789"}
Response
{
  "data": {
    "lotNotification": {
      "companyId": "xyz789",
      "date": "2007-12-03",
      "entities": [Lot],
      "topic": "abc123"
    }
  }
}
Subscriptions

mobileStockLocationSessionNotification

Response

Returns a MobileStockLocationSessionNotification!

Arguments
Name Description
companyId - String!
stockLocationIds - [String!]

Example

Query
subscription mobileStockLocationSessionNotification(
  $companyId: String!,
  $stockLocationIds: [String!]
) {
  mobileStockLocationSessionNotification(
    companyId: $companyId,
    stockLocationIds: $stockLocationIds
  ) {
    companyId
    date
    entities {
      ...MobileStockLocationSessionFragment
    }
    topic
  }
}
Variables
{
  "companyId": "xyz789",
  "stockLocationIds": ["abc123"]
}
Response
{
  "data": {
    "mobileStockLocationSessionNotification": {
      "companyId": "abc123",
      "date": "2007-12-03",
      "entities": [MobileStockLocationSession],
      "topic": "abc123"
    }
  }
}
Subscriptions

orderNotification

Response

Returns an OrderUpdateNotification!

Arguments
Name Description
companyId - String!

Example

Query
subscription orderNotification($companyId: String!) {
  orderNotification(companyId: $companyId) {
    companyId
    date
    entities {
      ...OrderFragment
    }
    topic
  }
}
Variables
{"companyId": "xyz789"}
Response
{
  "data": {
    "orderNotification": {
      "companyId": "abc123",
      "date": "2007-12-03",
      "entities": [Order],
      "topic": "abc123"
    }
  }
}
Subscriptions

productMasterDataNotification

Response

Returns a ProductMasterDataUpdateNotification!

Arguments
Name Description
companyId - String!

Example

Query
subscription productMasterDataNotification($companyId: String!) {
  productMasterDataNotification(companyId: $companyId) {
    companyId
    date
    entities {
      ...ProductMasterDataFragment
    }
    topic
  }
}
Variables
{"companyId": "xyz789"}
Response
{
  "data": {
    "productMasterDataNotification": {
      "companyId": "xyz789",
      "date": "2007-12-03",
      "entities": [ProductMasterData],
      "topic": "xyz789"
    }
  }
}
Subscriptions

productNotification

Response

Returns a ProductUpdateNotification!

Arguments
Name Description
companyId - String!

Example

Query
subscription productNotification($companyId: String!) {
  productNotification(companyId: $companyId) {
    companyId
    date
    entities {
      ...ProductFragment
    }
    topic
  }
}
Variables
{"companyId": "abc123"}
Response
{
  "data": {
    "productNotification": {
      "companyId": "abc123",
      "date": "2007-12-03",
      "entities": [Product],
      "topic": "xyz789"
    }
  }
}
Subscriptions

productTransactionNotification

Response

Returns a ProductTransactionUpdateNotification!

Arguments
Name Description
companyId - String!

Example

Query
subscription productTransactionNotification($companyId: String!) {
  productTransactionNotification(companyId: $companyId) {
    companyId
    date
    entities {
      ...ProductTransactionFragment
    }
    oldEntities {
      ...ProductTransactionFragment
    }
    topic
  }
}
Variables
{"companyId": "abc123"}
Response
{
  "data": {
    "productTransactionNotification": {
      "companyId": "xyz789",
      "date": "2007-12-03",
      "entities": [ProductTransaction],
      "oldEntities": [ProductTransaction],
      "topic": "abc123"
    }
  }
}
Subscriptions

stockLocationNotification

Response

Returns a StockLocationUpdateNotification!

Arguments
Name Description
companyId - String!

Example

Query
subscription stockLocationNotification($companyId: String!) {
  stockLocationNotification(companyId: $companyId) {
    companyId
    date
    entities {
      ...StockLocationFragment
    }
    topic
  }
}
Variables
{"companyId": "abc123"}
Response
{
  "data": {
    "stockLocationNotification": {
      "companyId": "xyz789",
      "date": "2007-12-03",
      "entities": [StockLocation],
      "topic": "abc123"
    }
  }
}
Subscriptions

taskNotification

Response

Returns a TaskUpdateNotification!

Arguments
Name Description
companyId - String!

Example

Query
subscription taskNotification($companyId: String!) {
  taskNotification(companyId: $companyId) {
    companyId
    date
    entities {
      ...TaskFragment
    }
    topic
  }
}
Variables
{"companyId": "xyz789"}
Response
{
  "data": {
    "taskNotification": {
      "companyId": "xyz789",
      "date": "2007-12-03",
      "entities": [Task],
      "topic": "abc123"
    }
  }
}
Subscriptions

taskProductNotification

Response

Returns a TaskProductUpdateNotification!

Arguments
Name Description
companyId - String!

Example

Query
subscription taskProductNotification($companyId: String!) {
  taskProductNotification(companyId: $companyId) {
    companyId
    date
    entities {
      ...TaskProductFragment
    }
    topic
  }
}
Variables
{"companyId": "abc123"}
Response
{
  "data": {
    "taskProductNotification": {
      "companyId": "xyz789",
      "date": "2007-12-03",
      "entities": [TaskProduct],
      "topic": "abc123"
    }
  }
}
Subscriptions

triggerNotification

Response

Returns a TriggerUpdateNotification!

Arguments
Name Description
companyId - String!

Example

Query
subscription triggerNotification($companyId: String!) {
  triggerNotification(companyId: $companyId) {
    companyId
    date
    entities {
      ...TriggerFragment
    }
    topic
  }
}
Variables
{"companyId": "abc123"}
Response
{
  "data": {
    "triggerNotification": {
      "companyId": "xyz789",
      "date": "2007-12-03",
      "entities": [Trigger],
      "topic": "xyz789"
    }
  }
}
Documentation by Anvil SpectaQL