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!

Example

Query

query companies {
  companies {
    batchSize
    data {
      ...CompanyFragment
    }
    hasNext
    page
    pageSize
  }
}

Response

{
  "data": {
    "companies": {
      "batchSize": 123.45,
      "data": [Company],
      "hasNext": true,
      "page": 987.65,
      "pageSize": 123.45
    }
  }
}

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
    settings {
      ...CompanySettingsFragment
    }
    updatedAt
    updatedBy
    version
  }
}

Variables

{"id": "abc123"}

Response

{
  "data": {
    "company": {
      "companyId": "abc123",
      "createdAt": "2007-12-03",
      "createdBy": "xyz789",
      "externalIdentifier": ExternalEntityIdentifier,
      "id": "xyz789",
      "name": "abc123",
      "settings": CompanySettings,
      "updatedAt": "2007-12-03",
      "updatedBy": "abc123",
      "version": 987
    }
  }
}

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
    requiredHeaders
    updatedAt
    updatedBy
    version
  }
}

Variables

{
  "companyId": "xyz789",
  "csvFileAsBase64Data": "abc123",
  "type": "xyz789"
}

Response

{
  "data": {
    "csvConfigurationsForFile": {
      "companyId": "xyz789",
      "configurations": [CsvUploadConfiguration],
      "createdAt": "2007-12-03",
      "createdBy": "xyz789",
      "externalIdentifier": ExternalEntityIdentifier,
      "fileHeaders": ["abc123"],
      "id": "xyz789",
      "optionalHeaders": ["abc123"],
      "requiredHeaders": ["abc123"],
      "updatedAt": "2007-12-03",
      "updatedBy": "xyz789",
      "version": 123
    }
  }
}

Queries

`getLastMobileStockLocationEvents`

Response

Returns [MobileStockLocationEvent!]!

Arguments

Name	Description
`companyId` - `String!`

Example

Query

query getLastMobileStockLocationEvents($companyId: String!) {
  getLastMobileStockLocationEvents(companyId: $companyId) {
    clientIdentifier
    companyId
    coordinates {
      ...CoordinatesFragment
    }
    stockLocationId
    timestamp
    type
    userId
  }
}

Variables

{"companyId": "abc123"}

Response

{
  "data": {
    "getLastMobileStockLocationEvents": [
      {
        "clientIdentifier": "xyz789",
        "companyId": "abc123",
        "coordinates": Coordinates,
        "stockLocationId": "xyz789",
        "timestamp": "2007-12-03",
        "type": "xyz789",
        "userId": "abc123"
      }
    ]
  }
}

Queries

`verifyMobileStockLocationLink`

Response

Returns a Boolean!

Arguments

Name	Description
`stockLocationId` - `String!`

Example

Query

query verifyMobileStockLocationLink($stockLocationId: String!) {
  verifyMobileStockLocationLink(stockLocationId: $stockLocationId)
}

Variables

{"stockLocationId": "abc123"}

Response

{"data": {"verifyMobileStockLocationLink": true}}

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": "xyz789",
        "description": "xyz789",
        "externalIdentifier": ExternalEntityIdentifier,
        "headerMapping": [CsvUploadConfigurationMapping],
        "headerNames": ["xyz789"],
        "id": "abc123",
        "name": "abc123",
        "type": "bin",
        "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": "xyz789",
        "companyId": "xyz789",
        "createdAt": "2007-12-03",
        "createdBy": "abc123",
        "externalIdentifier": ExternalEntityIdentifier,
        "id": "abc123",
        "inboundAllowed": false,
        "outboundAllowed": false,
        "status": "xyz789",
        "updatedAt": "2007-12-03",
        "updatedBy": "abc123",
        "version": 123
      }
    ]
  }
}

Mutations

`deleteContact`

Response

Returns [Contact!]!

Arguments

Name	Description
`contacts` - `[DeleteContactInput!]!`

Example

Query

mutation deleteContact($contacts: [DeleteContactInput!]!) {
  deleteContact(contacts: $contacts) {
    address {
      ...AddressFragment
    }
    companyId
    contactType
    createdAt
    createdBy
    email
    externalIdentifier {
      ...ExternalEntityIdentifierFragment
    }
    id
    name
    shippingLocations {
      ...ShippingLocationFragment
    }
    updatedAt
    updatedBy
    version
  }
}

Variables

{"contacts": [DeleteContactInput]}

Response

{
  "data": {
    "deleteContact": [
      {
        "address": Address,
        "companyId": "abc123",
        "contactType": "abc123",
        "createdAt": "2007-12-03",
        "createdBy": "xyz789",
        "email": "abc123",
        "externalIdentifier": ExternalEntityIdentifier,
        "id": "xyz789",
        "name": "abc123",
        "shippingLocations": [ShippingLocation],
        "updatedAt": "2007-12-03",
        "updatedBy": "xyz789",
        "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": "abc123",
        "description": "abc123",
        "externalIdentifier": ExternalEntityIdentifier,
        "headerMapping": [CsvUploadConfigurationMapping],
        "headerNames": ["xyz789"],
        "id": "abc123",
        "name": "xyz789",
        "type": "bin",
        "updatedAt": "2007-12-03",
        "updatedBy": "abc123",
        "version": 123
      }
    ]
  }
}

Mutations

`startMobileStockLocationLink`

Response

Returns a Boolean

Arguments

Name	Description
`clientIdentifier` - `String!`
`companyId` - `String!`
`coordinates` - `CoordinatesInput!`
`stockLocationId` - `String!`

Example

Query

mutation startMobileStockLocationLink(
  $clientIdentifier: String!,
  $companyId: String!,
  $coordinates: CoordinatesInput!,
  $stockLocationId: String!
) {
  startMobileStockLocationLink(
    clientIdentifier: $clientIdentifier,
    companyId: $companyId,
    coordinates: $coordinates,
    stockLocationId: $stockLocationId
  )
}

Variables

{
  "clientIdentifier": "xyz789",
  "companyId": "xyz789",
  "coordinates": CoordinatesInput,
  "stockLocationId": "abc123"
}

Response

{"data": {"startMobileStockLocationLink": true}}

Mutations

`stopMobileStockLocationLink`

Response

Returns a Boolean!

Arguments

Name	Description
`clientIdentifier` - `String!`
`companyId` - `String!`
`coordinates` - `CoordinatesInput!`
`stockLocationId` - `String!`

Example

Query

mutation stopMobileStockLocationLink(
  $clientIdentifier: String!,
  $companyId: String!,
  $coordinates: CoordinatesInput!,
  $stockLocationId: String!
) {
  stopMobileStockLocationLink(
    clientIdentifier: $clientIdentifier,
    companyId: $companyId,
    coordinates: $coordinates,
    stockLocationId: $stockLocationId
  )
}

Variables

{
  "clientIdentifier": "xyz789",
  "companyId": "xyz789",
  "coordinates": CoordinatesInput,
  "stockLocationId": "xyz789"
}

Response

{"data": {"stopMobileStockLocationLink": false}}

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": "xyz789",
        "createdAt": "2007-12-03",
        "createdBy": "xyz789",
        "description": "xyz789",
        "externalIdentifier": ExternalEntityIdentifier,
        "headerMapping": [CsvUploadConfigurationMapping],
        "headerNames": ["abc123"],
        "id": "abc123",
        "name": "abc123",
        "type": "bin",
        "updatedAt": "2007-12-03",
        "updatedBy": "abc123",
        "version": 123
      }
    ]
  }
}

Types

Address

Fields

Field Name	Description
`addressLine1` - `String`
`addressLine2` - `String`
`city` - `String`
`coordinates` - `Coordinates`
`countryCode` - `String`
`postalCode` - `String`
`region` - `String`

Example

{
  "addressLine1": "abc123",
  "addressLine2": "abc123",
  "city": "abc123",
  "coordinates": Coordinates,
  "countryCode": "abc123",
  "postalCode": "abc123",
  "region": "abc123"
}

Types

Alert

Fields

Field Name	Description
`companyId` - `String!`
`createdAt` - `Date`
`createdBy` - `String`
`entityType` - `TriggerEntityType!`
`entityValue` - `String!`
`externalIdentifier` - `ExternalEntityIdentifier`
`id` - `String!`
`stockLocationAggregateType` - `StockLocationAggregateType!`
`stockLocationIds` - `[String!]`
`triggerId` - `String!`
`triggeredStockLocation` - `String`
`triggeredValue` - `String!`
`updatedAt` - `Date`
`updatedBy` - `String`
`userId` - `String!`
`version` - `Int!`

Example

{
  "companyId": "abc123",
  "createdAt": "2007-12-03",
  "createdBy": "xyz789",
  "entityType": "lot",
  "entityValue": "abc123",
  "externalIdentifier": ExternalEntityIdentifier,
  "id": "abc123",
  "stockLocationAggregateType": "all",
  "stockLocationIds": ["abc123"],
  "triggerId": "xyz789",
  "triggeredStockLocation": "xyz789",
  "triggeredValue": "xyz789",
  "updatedAt": "2007-12-03",
  "updatedBy": "xyz789",
  "userId": "xyz789",
  "version": 987
}

Types

AlertFeatureToggles

Fields

Field Name	Description
`alerts` - `Boolean!`

Example

{"alerts": false}

Types

AlertUpdateNotification

Fields

Field Name	Description
`companyId` - `String!`
`date` - `Date!`
`entities` - `[Alert!]!`
`topic` - `String!`

Example

{
  "companyId": "xyz789",
  "date": "2007-12-03",
  "entities": [Alert],
  "topic": "abc123"
}

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`
`externalIdentifier` - `ExternalEntityIdentifier`
`id` - `String!`
`name` - `String!`
`stockLocationId` - `String!`
`updatedAt` - `Date`
`updatedBy` - `String`
`version` - `Int!`

Example

{
  "binStatusId": "abc123",
  "companyId": "abc123",
  "createdAt": "2007-12-03",
  "createdBy": "abc123",
  "externalIdentifier": ExternalEntityIdentifier,
  "id": "xyz789",
  "name": "xyz789",
  "stockLocationId": "abc123",
  "updatedAt": "2007-12-03",
  "updatedBy": "xyz789",
  "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": "xyz789",
  "externalIdentifier": ExternalEntityIdentifier,
  "id": "xyz789",
  "inboundAllowed": false,
  "outboundAllowed": false,
  "status": "abc123",
  "updatedAt": "2007-12-03",
  "updatedBy": "abc123",
  "version": 987
}

Types

BinStatusUpdateNotification

Fields

Field Name	Description
`companyId` - `String!`
`date` - `Date!`
`entities` - `[BinStatus!]!`
`topic` - `String!`

Example

{
  "companyId": "xyz789",
  "date": "2007-12-03",
  "entities": [BinStatus],
  "topic": "abc123"
}

Types

BinUpdateNotification

Fields

Field Name	Description
`companyId` - `String!`
`date` - `Date!`
`entities` - `[Bin!]!`
`topic` - `String!`

Example

{
  "companyId": "xyz789",
  "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": "xyz789",
  "createdAt": "2007-12-03",
  "createdBy": "abc123",
  "entityId": "abc123",
  "externalIdentifier": ExternalEntityIdentifier,
  "id": "abc123",
  "parentId": "abc123",
  "type": "bin",
  "updatedAt": "2007-12-03",
  "updatedBy": "xyz789",
  "userId": "abc123",
  "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!`
`settings` - `CompanySettings`
`updatedAt` - `Date`
`updatedBy` - `String`
`version` - `Int!`

Example

{
  "companyId": "xyz789",
  "createdAt": "2007-12-03",
  "createdBy": "abc123",
  "externalIdentifier": ExternalEntityIdentifier,
  "id": "xyz789",
  "name": "abc123",
  "settings": CompanySettings,
  "updatedAt": "2007-12-03",
  "updatedBy": "abc123",
  "version": 987
}

Types

CompanyFeatureToggles

Fields

Field Name	Description
`ventoryVisionAR` - `Boolean`

Example

{"ventoryVisionAR": false}

Types

CompanySettings

Fields

Field Name	Description
`companyImage` - `String`
`companyLogo` - `String`
`featureToggles` - `FeatureToggles!`
`mobileConfiguration` - `MobileConfigurationType!`
`primaryColor` - `String`
`scanConfigurations` - `[ScanConfiguration!]!`
`secondaryColor` - `String`

Example

{
  "companyImage": "abc123",
  "companyLogo": "xyz789",
  "featureToggles": FeatureToggles,
  "mobileConfiguration": "current",
  "primaryColor": "abc123",
  "scanConfigurations": [ScanConfiguration],
  "secondaryColor": "xyz789"
}

Types

Contact

Fields

Field Name	Description
`address` - `Address`
`companyId` - `String!`
`contactType` - `String`
`createdAt` - `Date`
`createdBy` - `String`
`email` - `String`
`externalIdentifier` - `ExternalEntityIdentifier`
`id` - `String!`
`name` - `String!`
`shippingLocations` - `[ShippingLocation!]`
`updatedAt` - `Date`
`updatedBy` - `String`
`version` - `Int!`

Example

{
  "address": Address,
  "companyId": "xyz789",
  "contactType": "abc123",
  "createdAt": "2007-12-03",
  "createdBy": "abc123",
  "email": "abc123",
  "externalIdentifier": ExternalEntityIdentifier,
  "id": "xyz789",
  "name": "xyz789",
  "shippingLocations": [ShippingLocation],
  "updatedAt": "2007-12-03",
  "updatedBy": "abc123",
  "version": 987
}

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`
`externalIdentifier` - `ExternalEntityIdentifier`
`id` - `String!`
`identifier` - `String!`
`stockLocationId` - `String!`
`updatedAt` - `Date`
`updatedBy` - `String`
`version` - `Int!`

Example

{
  "binId": "abc123",
  "companyId": "xyz789",
  "containerTypeId": "xyz789",
  "createdAt": "2007-12-03",
  "createdBy": "abc123",
  "externalIdentifier": ExternalEntityIdentifier,
  "id": "abc123",
  "identifier": "abc123",
  "stockLocationId": "abc123",
  "updatedAt": "2007-12-03",
  "updatedBy": "abc123",
  "version": 987
}

Types

Coordinates

Fields

Field Name	Description
`latitude` - `Float!`
`longitude` - `Float!`

Example

{"latitude": 987.65, "longitude": 987.65}

Types

CoordinatesInput

Fields

Input Field	Description
`latitude` - `Float!`
`longitude` - `Float!`

Example

{"latitude": 987.65, "longitude": 987.65}

Types

CreateCsvUploadConfigurationInput

Fields

Input Field	Description
`companyId` - `String!`
`description` - `String`
`headerMapping` - `[CsvUploadConfigurationMappingInput!]!`
`headerNames` - `[String!]!`
`name` - `String!`
`type` - `CsvUploadType!`

Example

{
  "companyId": "abc123",
  "description": "abc123",
  "headerMapping": [CsvUploadConfigurationMappingInput],
  "headerNames": ["abc123"],
  "name": "abc123",
  "type": "bin"
}

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": "xyz789",
  "createdAt": "2007-12-03",
  "createdBy": "xyz789",
  "description": "xyz789",
  "externalIdentifier": ExternalEntityIdentifier,
  "headerMapping": [CsvUploadConfigurationMapping],
  "headerNames": ["abc123"],
  "id": "xyz789",
  "name": "abc123",
  "type": "bin",
  "updatedAt": "2007-12-03",
  "updatedBy": "xyz789",
  "version": 123
}

Types

CsvUploadConfigurationMapping

Fields

Field Name	Description
`customField` - `String!`
`field` - `String!`

Example

{
  "customField": "xyz789",
  "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!]`
`requiredHeaders` - `[String!]`
`updatedAt` - `Date`
`updatedBy` - `String`
`version` - `Int!`

Example

{
  "companyId": "abc123",
  "configurations": [CsvUploadConfiguration],
  "createdAt": "2007-12-03",
  "createdBy": "abc123",
  "externalIdentifier": ExternalEntityIdentifier,
  "fileHeaders": ["abc123"],
  "id": "xyz789",
  "optionalHeaders": ["abc123"],
  "requiredHeaders": ["abc123"],
  "updatedAt": "2007-12-03",
  "updatedBy": "abc123",
  "version": 987
}

Types

CsvUploadType

Values

Enum Value	Description
`bin`
`lot`
`product`
`productMasterData`
`stockLocation`
`user`

Example

"bin"

Types

Currency

Values

Enum Value	Description
`AUD`
`CAD`
`CHF`
`CNY`
`EUR`
`GBP`
`HKD`
`JPY`
`NZD`
`USD`

Example

"AUD"

Types

CustomFieldType

Values

Enum Value	Description
`bool`
`date`
`listOfValues`
`text`

Example

"bool"

Types

CustomFieldValue

Fields

Field Name	Description
`external` - `Boolean`
`id` - `String!`
`mandatory` - `Boolean!`
`name` - `String!`
`type` - `CustomFieldType!`
`value` - `String!`

Example

{
  "external": false,
  "id": "abc123",
  "mandatory": false,
  "name": "xyz789",
  "type": "bool",
  "value": "xyz789"
}

Types

Date

Example

"2007-12-03"

Types

DeleteBinStatusInput

Fields

Input Field	Description
`companyId` - `String!`
`externalIdentifier` - `ExternalEntityIdentifierInput`
`id` - `String!`
`version` - `Float!`

Example

{
  "companyId": "abc123",
  "externalIdentifier": ExternalEntityIdentifierInput,
  "id": "xyz789",
  "version": 987.65
}

Types

DeleteContactInput

Fields

Input Field	Description
`companyId` - `String!`
`externalIdentifier` - `ExternalEntityIdentifierInput`
`id` - `String!`
`version` - `Float!`

Example

{
  "companyId": "abc123",
  "externalIdentifier": ExternalEntityIdentifierInput,
  "id": "abc123",
  "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": 123.45
}

Types

Dimensions

Fields

Field Name	Description
`depth` - `Float!`
`height` - `Float!`
`unit` - `LengthUnit!`
`width` - `Float!`

Example

{"depth": 987.65, "height": 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": "xyz789",
  "name": "xyz789",
  "url": "xyz789"
}

Types

EntityClass

Fields

Field Name	Description
`clientIdentifier` - `String!`
`companyId` - `String!`
`coordinates` - `Coordinates!`
`stockLocationId` - `String!`
`timestamp` - `Date!`
`type` - `String!`
`userId` - `String!`

Example

{
  "clientIdentifier": "abc123",
  "companyId": "xyz789",
  "coordinates": Coordinates,
  "stockLocationId": "abc123",
  "timestamp": "2007-12-03",
  "type": "abc123",
  "userId": "abc123"
}

Types

EntityType

Values

Enum Value	Description
`bin`
`lot`
`order`
`pmd`
`product`
`serial`
`stockLocation`
`task`

Example

"bin"

Types

ExternalEntityIdentifier

Fields

Field Name	Description
`additionalInfo` - `String!`
`externalId` - `String!`
`settingsId` - `String!`
`type` - `String`

Example

{
  "additionalInfo": "abc123",
  "externalId": "xyz789",
  "settingsId": "abc123",
  "type": "xyz789"
}

Types

ExternalEntityIdentifierInput

Fields

Input Field	Description
`additionalInfo` - `String!`
`externalId` - `String!`
`settingsId` - `String!`
`type` - `String`

Example

{
  "additionalInfo": "xyz789",
  "externalId": "xyz789",
  "settingsId": "abc123",
  "type": "xyz789"
}

Types

FeatureToggles

Fields

Field Name	Description
`alerts` - `AlertFeatureToggles!`
`company` - `CompanyFeatureToggles!`
`orders` - `OrderFeatureToggles!`
`productTransactions` - `ProductTransactionFeatureToggles!`
`products` - `ProductFeatureToggles!`
`tasks` - `TaskFeatureToggles!`

Example

{
  "alerts": AlertFeatureToggles,
  "company": CompanyFeatureToggles,
  "orders": OrderFeatureToggles,
  "productTransactions": ProductTransactionFeatureToggles,
  "products": ProductFeatureToggles,
  "tasks": TaskFeatureToggles
}

Types

Float

Description

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

Example

123.45

Types

GS1ApplicationIdentifierMap

Description

Map of GS1 Application Identifiers

Example

GS1ApplicationIdentifierMap

Types

ILot

Fields

Field Name	Description
`expirationDate` - `String`
`number` - `String!`
`productMasterDataId` - `String!`

Possible Types

ILot Types
`Lot`

Example

{
  "expirationDate": "xyz789",
  "number": "xyz789",
  "productMasterDataId": "abc123"
}

Types

ImageFile

Fields

Field Name	Description
`createdAt` - `String!`
`index` - `Float`
`quality` - `ImageQuality`
`url` - `String!`

Example

{
  "createdAt": "xyz789",
  "index": 123.45,
  "quality": "high",
  "url": "abc123"
}

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

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`
`expirationDate` - `String`
`externalIdentifier` - `ExternalEntityIdentifier`
`id` - `String!`
`number` - `String!`
`productMasterDataId` - `String!`
`updatedAt` - `Date`
`updatedBy` - `String`
`version` - `Int!`

Example

{
  "companyId": "abc123",
  "createdAt": "2007-12-03",
  "createdBy": "xyz789",
  "expirationDate": "xyz789",
  "externalIdentifier": ExternalEntityIdentifier,
  "id": "abc123",
  "number": "xyz789",
  "productMasterDataId": "xyz789",
  "updatedAt": "2007-12-03",
  "updatedBy": "abc123",
  "version": 987
}

Types

MobileConfigurationType

Values

Enum Value	Description
`current`
`legacy`

Example

"current"

Types

MobileStockLocationEvent

Fields

Field Name	Description
`clientIdentifier` - `String!`
`companyId` - `String!`
`coordinates` - `Coordinates!`
`stockLocationId` - `String!`
`timestamp` - `Date!`
`type` - `String!`
`userId` - `String!`

Example

{
  "clientIdentifier": "xyz789",
  "companyId": "abc123",
  "coordinates": Coordinates,
  "stockLocationId": "abc123",
  "timestamp": "2007-12-03",
  "type": "abc123",
  "userId": "xyz789"
}

Types

MobileStockLocationNotification

Fields

Field Name	Description
`companyId` - `String!`
`date` - `Date!`
`entities` - `[EntityClass!]!`
`topic` - `String!`

Example

{
  "companyId": "abc123",
  "date": "2007-12-03",
  "entities": [EntityClass],
  "topic": "xyz789"
}

Types

Order

Fields

Field Name	Description
`assignedTo` - `[String!]`
`companyId` - `String!`
`contactId` - `String`
`contactLocation` - `ShippingLocation`
`createdAt` - `Date`
`createdBy` - `String`
`customFields` - `[CustomFieldValue!]`
`estimatedTimeOfArrival` - `Date`
`externalIdentifier` - `ExternalEntityIdentifier`
`externalReferenceId` - `String`
`id` - `String!`
`number` - `String`
`parentId` - `String`
`parentType` - `String`
`products` - `[ProductTransactionSpecifiers!]!`
`purchaseOrderNumber` - `String`
`status` - `OrderStatus!`
`stockLocationId` - `String!`
`type` - `OrderType!`
`updatedAt` - `Date`
`updatedBy` - `String`
`version` - `Int!`

Example

{
  "assignedTo": ["xyz789"],
  "companyId": "xyz789",
  "contactId": "abc123",
  "contactLocation": ShippingLocation,
  "createdAt": "2007-12-03",
  "createdBy": "abc123",
  "customFields": [CustomFieldValue],
  "estimatedTimeOfArrival": "2007-12-03",
  "externalIdentifier": ExternalEntityIdentifier,
  "externalReferenceId": "xyz789",
  "id": "xyz789",
  "number": "abc123",
  "parentId": "xyz789",
  "parentType": "xyz789",
  "products": [ProductTransactionSpecifiers],
  "purchaseOrderNumber": "xyz789",
  "status": "archived",
  "stockLocationId": "xyz789",
  "type": "inbound",
  "updatedAt": "2007-12-03",
  "updatedBy": "abc123",
  "version": 123
}

Types

OrderFeatureToggles

Fields

Field Name	Description
`customer` - `Boolean`
`editProductsOnInbound` - `Boolean`
`editProductsOnOutbound` - `Boolean`
`estimatedTimeOfArrival` - `Boolean`
`externalReferenceId` - `Boolean`
`orders` - `Boolean!`
`productSelectionFirst` - `Boolean`
`purchaseOrderNumber` - `Boolean`
`sendMailOnAssigned` - `Boolean`
`supplier` - `Boolean`

Example

{
  "customer": false,
  "editProductsOnInbound": false,
  "editProductsOnOutbound": true,
  "estimatedTimeOfArrival": false,
  "externalReferenceId": true,
  "orders": false,
  "productSelectionFirst": true,
  "purchaseOrderNumber": true,
  "sendMailOnAssigned": true,
  "supplier": true
}

Types

OrderStatus

Values

Enum Value	Description
`archived`
`arrived`
`cancelled`
`complete`
`created`
`disabled`
`draft`
`failed`
`inProgress`
`open`
`released`
`shipped`

Example

"archived"

Types

OrderType

Values

Enum Value	Description
`inbound`
`outbound`

Example

"inbound"

Types

OrderUpdateNotification

Fields

Field Name	Description
`companyId` - `String!`
`date` - `Date!`
`entities` - `[Order!]!`
`topic` - `String!`

Example

{
  "companyId": "xyz789",
  "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": 987.65,
  "data": [Company],
  "hasNext": true,
  "page": 123.45,
  "pageSize": 123.45
}

Types

Price

Fields

Field Name	Description
`currency` - `Currency!`
`value` - `Float!`

Example

{"currency": "AUD", "value": 123.45}

Types

Product

Fields

Field Name	Description
`binId` - `String!`
`companyId` - `String!`
`containerId` - `String`
`countryOfOrigin` - `String`
`createdAt` - `Date`
`createdBy` - `String`
`externalIdentifier` - `ExternalEntityIdentifier`
`gs1ApplicationIdentifiers` - `GS1ApplicationIdentifierMap`
`id` - `String!`
`lotId` - `String`
`lpn` - `String`
`productMasterDataId` - `String!`
`quantity` - `String!`
`quantityString` - `String`
`serialNbr` - `String`
`stockLocationId` - `String!`
`updatedAt` - `Date`
`updatedBy` - `String`
`version` - `Int!`

Example

{
  "binId": "xyz789",
  "companyId": "abc123",
  "containerId": "abc123",
  "countryOfOrigin": "xyz789",
  "createdAt": "2007-12-03",
  "createdBy": "xyz789",
  "externalIdentifier": ExternalEntityIdentifier,
  "gs1ApplicationIdentifiers": GS1ApplicationIdentifierMap,
  "id": "abc123",
  "lotId": "abc123",
  "lpn": "xyz789",
  "productMasterDataId": "abc123",
  "quantity": "abc123",
  "quantityString": "xyz789",
  "serialNbr": "abc123",
  "stockLocationId": "xyz789",
  "updatedAt": "2007-12-03",
  "updatedBy": "xyz789",
  "version": 987
}

Types

ProductFeatureToggles

Fields

Field Name	Description
`container` - `Boolean`
`gs1Barcodes` - `Boolean`
`products` - `Boolean!`

Example

{"container": true, "gs1Barcodes": true, "products": false}

Types

ProductMasterData

Fields

Field Name	Description
`companyId` - `String!`
`countryOfOrigin` - `String`
`createdAt` - `Date`
`createdBy` - `String`
`dimensions` - `Dimensions`
`documents` - `[Document!]`
`externalIdentifier` - `ExternalEntityIdentifier`
`grossWeight` - `Weight`
`id` - `String!`
`lotManaged` - `Boolean`
`lpnManaged` - `Boolean`
`manufacturer` - `String`
`netWeight` - `Weight`
`originalEquipmentManufacturer` - `String`
`productCategory` - `String`
`productImages` - `[ImageFile!]`
`productName` - `String!`
`productNumber` - `String!`
`purchasePrice` - `Price`
`reorderPoint` - `Int`
`sellingPrice` - `Price`
`serialManaged` - `Boolean`
`unitOfMeasure` - `UnitOfMeasure`
`updatedAt` - `Date`
`updatedBy` - `String`
`version` - `Int!`

Example

{
  "companyId": "xyz789",
  "countryOfOrigin": "abc123",
  "createdAt": "2007-12-03",
  "createdBy": "xyz789",
  "dimensions": Dimensions,
  "documents": [Document],
  "externalIdentifier": ExternalEntityIdentifier,
  "grossWeight": Weight,
  "id": "abc123",
  "lotManaged": false,
  "lpnManaged": false,
  "manufacturer": "abc123",
  "netWeight": Weight,
  "originalEquipmentManufacturer": "xyz789",
  "productCategory": "xyz789",
  "productImages": [ImageFile],
  "productName": "abc123",
  "productNumber": "xyz789",
  "purchasePrice": Price,
  "reorderPoint": 987,
  "sellingPrice": Price,
  "serialManaged": true,
  "unitOfMeasure": UnitOfMeasure,
  "updatedAt": "2007-12-03",
  "updatedBy": "xyz789",
  "version": 123
}

Types

ProductMasterDataUpdateNotification

Fields

Field Name	Description
`companyId` - `String!`
`date` - `Date!`
`entities` - `[ProductMasterData!]!`
`topic` - `String!`

Example

{
  "companyId": "xyz789",
  "date": "2007-12-03",
  "entities": [ProductMasterData],
  "topic": "abc123"
}

Types

ProductTransaction

Fields

Field Name	Description
`companyId` - `String!`
`createdAt` - `Date`
`createdBy` - `String`
`externalIdentifier` - `ExternalEntityIdentifier`
`id` - `String!`
`metadata` - `ProductTransactionMetaData`
`parentId` - `String`
`parentType` - `ProductTransactionParentType`
`processedAt` - `Date`
`processedBy` - `String`
`product` - `ProductTransactionSpecifiers!`
`reasonForFailure` - `String`
`status` - `ProductTransactionStatus!`
`type` - `ProductTransactionType!`
`updatedAt` - `Date`
`updatedBy` - `String`
`version` - `Int!`

Example

{
  "companyId": "abc123",
  "createdAt": "2007-12-03",
  "createdBy": "abc123",
  "externalIdentifier": ExternalEntityIdentifier,
  "id": "xyz789",
  "metadata": ProductTransactionMetaData,
  "parentId": "xyz789",
  "parentType": "container",
  "processedAt": "2007-12-03",
  "processedBy": "xyz789",
  "product": ProductTransactionSpecifiers,
  "reasonForFailure": "xyz789",
  "status": "cancelled",
  "type": "inbound",
  "updatedAt": "2007-12-03",
  "updatedBy": "xyz789",
  "version": 123
}

Types

ProductTransactionFeatureToggles

Fields

Field Name	Description
`mobile` - `Boolean`
`productTransactions` - `Boolean!`
`quickActions` - `Boolean`
`web` - `Boolean`

Example

{
  "mobile": false,
  "productTransactions": false,
  "quickActions": false,
  "web": true
}

Types

ProductTransactionMetaData

Fields

Field Name	Description
`fromBin` - `Bin`
`fromContainer` - `Container`
`lot` - `Lot`
`product` - `ProductTransactionProductMetaData`
`productMasterData` - `ProductMasterData`
`toBin` - `Bin`
`toContainer` - `Container`

Example

{
  "fromBin": Bin,
  "fromContainer": Container,
  "lot": Lot,
  "product": ProductTransactionProductMetaData,
  "productMasterData": ProductMasterData,
  "toBin": Bin,
  "toContainer": Container
}

Types

ProductTransactionParentType

Values

Enum Value	Description
`container`
`order`
`quickAction`
`task`
`transaction`
`upload`

Example

"container"

Types

ProductTransactionProductMetaData

Fields

Field Name	Description
`fromQuantity` - `Float`
`toQuantity` - `Float`

Example

{"fromQuantity": 123.45, "toQuantity": 987.65}

Types

ProductTransactionSpecifiers

Fields

Field Name	Description
`countryOfOrigin` - `String`
`fromBinId` - `String`
`fromContainerId` - `String`
`fromProductId` - `String`
`fromStockLocationId` - `String`
`gs1ApplicationIdentifiers` - `GS1ApplicationIdentifierMap`
`lotId` - `String`
`lpn` - `String`
`pmdId` - `String`
`processedQuantity` - `Float`
`quantity` - `Float!`
`serialNbr` - `String`
`toBinId` - `String`
`toContainerId` - `String`
`toProductId` - `String`
`toStockLocationId` - `String`

Example

{
  "countryOfOrigin": "xyz789",
  "fromBinId": "xyz789",
  "fromContainerId": "xyz789",
  "fromProductId": "xyz789",
  "fromStockLocationId": "xyz789",
  "gs1ApplicationIdentifiers": GS1ApplicationIdentifierMap,
  "lotId": "abc123",
  "lpn": "abc123",
  "pmdId": "abc123",
  "processedQuantity": 987.65,
  "quantity": 987.65,
  "serialNbr": "xyz789",
  "toBinId": "xyz789",
  "toContainerId": "xyz789",
  "toProductId": "xyz789",
  "toStockLocationId": "abc123"
}

Types

ProductTransactionStatus

Values

Enum Value	Description
`cancelled`
`created`
`failed`
`processed`
`rollback`

Example

"cancelled"

Types

ProductTransactionType

Values

Enum Value	Description
`inbound`
`move`
`outbound`

Example

"inbound"

Types

ProductTransactionUpdateNotification

Fields

Field Name	Description
`companyId` - `String!`
`date` - `Date!`
`entities` - `[ProductTransaction!]!`
`topic` - `String!`

Example

{
  "companyId": "xyz789",
  "date": "2007-12-03",
  "entities": [ProductTransaction],
  "topic": "abc123"
}

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

ScanConfiguration

Fields

Field Name	Description
`barcodeFormat` - `BarcodeFormat!`
`regex` - `String!`
`regexOption` - `String`
`type` - `ScanConfigurationType!`

Example

{
  "barcodeFormat": "all",
  "regex": "xyz789",
  "regexOption": "abc123",
  "type": "bin"
}

Types

ScanConfigurationType

Values

Enum Value	Description
`bin`
`container`
`coo`
`lot`
`lotExpiryDate`
`lpn`
`manufacturingDate`
`productNumber`
`serial`
`stockLocation`

Example

"bin"

Types

ShippingLocation

Fields

Field Name	Description
`address` - `Address`
`email` - `String`
`name` - `String!`
`stockLocationId` - `String`

Example

{
  "address": Address,
  "email": "xyz789",
  "name": "abc123",
  "stockLocationId": "abc123"
}

Types

StockLocation

Fields

Field Name	Description
`address` - `Address`
`companyId` - `String!`
`createdAt` - `Date`
`createdBy` - `String`
`externalIdentifier` - `ExternalEntityIdentifier`
`id` - `String!`
`identifier` - `String`
`image` - `String`
`mobile` - `Boolean`
`name` - `String!`
`updatedAt` - `Date`
`updatedBy` - `String`
`version` - `Int!`

Example

{
  "address": Address,
  "companyId": "xyz789",
  "createdAt": "2007-12-03",
  "createdBy": "xyz789",
  "externalIdentifier": ExternalEntityIdentifier,
  "id": "abc123",
  "identifier": "xyz789",
  "image": "abc123",
  "mobile": false,
  "name": "xyz789",
  "updatedAt": "2007-12-03",
  "updatedBy": "abc123",
  "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": "abc123"
}

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

"abc123"

Types

Task

Fields

Field Name	Description
`additionalEmails` - `[String!]`
`assignedTo` - `[String!]!`
`binIds` - `[String!]`
`companyId` - `String!`
`completedOn` - `Date`
`containerIds` - `[String!]`
`createdAt` - `Date`
`createdBy` - `String`
`dueDate` - `Date`
`externalIdentifier` - `ExternalEntityIdentifier`
`externalReferenceId` - `String`
`id` - `String!`
`lotIds` - `[String!]`
`parentId` - `String`
`parentType` - `String`
`productMasterDataIds` - `[String!]`
`status` - `TaskStatus!`
`stockLocationId` - `String!`
`type` - `TaskType!`
`updatedAt` - `Date`
`updatedBy` - `String`
`validation` - `TaskValidation!`
`version` - `Int!`

Example

{
  "additionalEmails": ["xyz789"],
  "assignedTo": ["xyz789"],
  "binIds": ["xyz789"],
  "companyId": "xyz789",
  "completedOn": "2007-12-03",
  "containerIds": ["xyz789"],
  "createdAt": "2007-12-03",
  "createdBy": "abc123",
  "dueDate": "2007-12-03",
  "externalIdentifier": ExternalEntityIdentifier,
  "externalReferenceId": "xyz789",
  "id": "xyz789",
  "lotIds": ["abc123"],
  "parentId": "abc123",
  "parentType": "xyz789",
  "productMasterDataIds": ["xyz789"],
  "status": "complete",
  "stockLocationId": "abc123",
  "type": "blind",
  "updatedAt": "2007-12-03",
  "updatedBy": "xyz789",
  "validation": TaskValidation,
  "version": 987
}

Types

TaskFeatureToggles

Fields

Field Name	Description
`allowStockUpdate` - `Boolean!`
`blindCount` - `Boolean`
`cycleCount` - `Boolean`
`tasks` - `Boolean!`

Example

{
  "allowStockUpdate": false,
  "blindCount": false,
  "cycleCount": true,
  "tasks": true
}

Types

TaskProduct

Fields

Field Name	Description
`binId` - `String!`
`companyId` - `String!`
`containerId` - `String`
`countedAt` - `Date`
`countedBy` - `String`
`countedQuantity` - `Float`
`countryOfOrigin` - `String`
`createdAt` - `Date`
`createdBy` - `String`
`externalIdentifier` - `ExternalEntityIdentifier`
`hasAnomaly` - `Boolean`
`id` - `String!`
`lotId` - `String`
`lotNumber` - `String`
`lpn` - `String`
`pmdId` - `String!`
`productId` - `String`
`productNumber` - `String`
`quantity` - `Float!`
`serialNbr` - `String`
`stockLocationId` - `String`
`taskId` - `String!`
`updatedAt` - `Date`
`updatedBy` - `String`
`version` - `Int!`

Example

{
  "binId": "xyz789",
  "companyId": "abc123",
  "containerId": "xyz789",
  "countedAt": "2007-12-03",
  "countedBy": "xyz789",
  "countedQuantity": 987.65,
  "countryOfOrigin": "xyz789",
  "createdAt": "2007-12-03",
  "createdBy": "abc123",
  "externalIdentifier": ExternalEntityIdentifier,
  "hasAnomaly": true,
  "id": "xyz789",
  "lotId": "abc123",
  "lotNumber": "xyz789",
  "lpn": "xyz789",
  "pmdId": "xyz789",
  "productId": "abc123",
  "productNumber": "abc123",
  "quantity": 123.45,
  "serialNbr": "abc123",
  "stockLocationId": "xyz789",
  "taskId": "xyz789",
  "updatedAt": "2007-12-03",
  "updatedBy": "xyz789",
  "version": 987
}

Types

TaskProductUpdateNotification

Fields

Field Name	Description
`companyId` - `String!`
`date` - `Date!`
`entities` - `[TaskProduct!]!`
`topic` - `String!`

Example

{
  "companyId": "xyz789",
  "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": "xyz789"
}

Types

TaskValidation

Fields

Field Name	Description
`quantity` - `Boolean`
`validationFields` - `[TaskValidationField!]`

Example

{"quantity": false, "validationFields": ["container"]}

Types

TaskValidationField

Values

Enum Value	Description
`container`
`coo`
`lot`
`lpn`
`productNumber`
`serial`

Example

"container"

Types

TriggerEntityType

Values

Enum Value	Description
`lot`
`pmd`

Example

"lot"

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

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": "abc123",
  "description": "xyz789",
  "externalIdentifier": ExternalEntityIdentifierInput,
  "headerMapping": [CsvUploadConfigurationMappingInput],
  "headerNames": ["xyz789"],
  "id": "abc123",
  "name": "abc123",
  "type": "bin",
  "updatedAt": "2007-12-03",
  "updatedBy": "xyz789",
  "version": 987.65
}

Types

Weight

Fields

Field Name	Description
`unit` - `WeightUnit!`
`value` - `Float!`

Example

{"unit": "gram", "value": 987.65}

Types

WeightUnit

Values

Enum Value	Description
`gram`
`kilogram`
`ounce`
`pound`

Example

"gram"

Subscriptions

`alertNotification`

Response

Returns an AlertUpdateNotification!

Arguments

Name	Description
`companyId` - `String!`

Example

Query

subscription alertNotification($companyId: String!) {
  alertNotification(companyId: $companyId) {
    companyId
    date
    entities {
      ...AlertFragment
    }
    topic
  }
}

Variables

{"companyId": "abc123"}

Response

{
  "data": {
    "alertNotification": {
      "companyId": "xyz789",
      "date": "2007-12-03",
      "entities": [Alert],
      "topic": "xyz789"
    }
  }
}

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": "xyz789",
      "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": "abc123"}

Response

{
  "data": {
    "binStatusNotification": {
      "companyId": "abc123",
      "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

`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": "xyz789"}

Response

{
  "data": {
    "contactNotification": {
      "companyId": "abc123",
      "date": "2007-12-03",
      "entities": [Contact],
      "topic": "xyz789"
    }
  }
}

Subscriptions

`mobileStockLocationNotification`

Response

Returns a MobileStockLocationNotification!

Arguments

Name	Description
`companyId` - `String!`

Example

Query

subscription mobileStockLocationNotification($companyId: String!) {
  mobileStockLocationNotification(companyId: $companyId) {
    companyId
    date
    entities {
      ...EntityClassFragment
    }
    topic
  }
}

Variables

{"companyId": "abc123"}

Response

{
  "data": {
    "mobileStockLocationNotification": {
      "companyId": "abc123",
      "date": "2007-12-03",
      "entities": [EntityClass],
      "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": "xyz789",
      "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": "abc123",
      "date": "2007-12-03",
      "entities": [ProductMasterData],
      "topic": "abc123"
    }
  }
}

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": "xyz789",
      "date": "2007-12-03",
      "entities": [Product],
      "topic": "abc123"
    }
  }
}

Subscriptions

`productTransactionNotification`

Response

Returns a ProductTransactionUpdateNotification!

Arguments

Name	Description
`companyId` - `String!`

Example

Query

subscription productTransactionNotification($companyId: String!) {
  productTransactionNotification(companyId: $companyId) {
    companyId
    date
    entities {
      ...ProductTransactionFragment
    }
    topic
  }
}

Variables

{"companyId": "abc123"}

Response

{
  "data": {
    "productTransactionNotification": {
      "companyId": "xyz789",
      "date": "2007-12-03",
      "entities": [ProductTransaction],
      "topic": "xyz789"
    }
  }
}

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": "abc123"}

Response

{
  "data": {
    "taskNotification": {
      "companyId": "xyz789",
      "date": "2007-12-03",
      "entities": [Task],
      "topic": "xyz789"
    }
  }
}

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": "abc123",
      "date": "2007-12-03",
      "entities": [TaskProduct],
      "topic": "xyz789"
    }
  }
}

Documentation by Anvil SpectaQL