There are several concepts and actions that are available to the majority of Jungle objects. Because they are applied consistently across object types, once you learn them you can use them almost anywhere in the API.
Tags are free-form labels you can apply to objects to group, organise, and filter them. Add and remove tags with the tagAdd and tagRemove mutations, and read them from an object's tags field.
See the Tagging guide for examples.
Attributes let you store your own custom key/value data against an object — useful for carrying information from your own systems that Jungle doesn't model directly. Set them with the attributesSet mutation, and read them back from an object's attributes field, or fetch a single value with attributeValue.
Almost anything in Jungle can be barcoded and scanned. Add and remove barcodes with the barcodeAdd and barcodeRemove mutations.
See Barcodes for more detail.
Notes let you record free-text commentary against an object, such as context for an order or a reminder for a warehouse operator. Create a note with the noteCreate mutation.
External IDs (XIDs) let you reference Jungle objects using identifiers from your own — or other third-party — systems. Assign and remove them with the xidAssign and xidUnassign mutations.
See External IDs for the full guide.
Many objects can be enabled or disabled. A disabled object is retained but excluded from the workflows it would normally participate in. Use the toggleEnable and toggleDisable mutations, and read an object's current state from its enabled field.
Objects that have a physical position, such as locations, can carry a geographic point. Set it with the geoPointSet mutation.
Relationships let you link objects together to express how they relate. Create a relationship between two objects with the relationAdd mutation.
GraphQL Reference
The types, inputs, interfaces available in the Jungle GraphQL API schema.
Node.js
Learn about and how to get started with our Node.js SDK