GraphQL Reference

Tells you the date according to the server. Useful for debugging.

Tells you the time according to the server. Useful for debugging.

Encode an ID. Generally used for composite IDs.

Decode an ID. Note: Not all IDs can decode.

⚠️ DEPRECATED

unused. do not use.

Load a specific object using it's type (__typename) and id. 🤖: If you need to keep the object's state up to date, see Subscription.object.

Forward lookup to a lat/lng. Currently works on postal codes and localities in Australia.

Get currency information.

Debug & understand money behavior using this.

Retrieve an attachment.

⚠️ DEPRECATED

Use the object query instead.

Retrieve attachments of a specific type for an object.

⚠️ DEPRECATED

Use the search query with a parent filter instead.

List attachments of a specific object.

Retrieve a URL to upload PUT new attachments. You must specify the object you are attaching the file/blob to. Optionally, you may provide the filename. If no file name is provided, one is randomly generated.

If NULL returns, you may not upload/attach against the given object.

See /docs/usage/attachments for workflow details.

Discover what documentation is available for a type, or specified object.

Who am I?

Use this query to work out your current authorization status and context. If an object is returned, you are authenticated, however it's up to you to work out if have an account selected, account user or not.

Retrieve an authkey

Login with an auth key (name tag) and pin

Switch to another account you have access to

Useful user defaults

Retrieve the current account, if one has been selected

Lists the accounts you currently have access to. Use it to know which accounts you can switch between

Retrieve the current account user, if you have selected your account, this is your user with in that account

⚠️ DEPRECATED

To select a specific AccountUser, use object() query instead. To get the current account user, use whoami() query instead.

List your account's users

⚠️ DEPRECATED

Use search() query instead

If authenticated, returns the current user/you.

⚠️ DEPRECATED

Use whoami() query instead

List all the known countries.

Retrieve a location.

⚠️ DEPRECATED

Use the object() query instead.

List your account's locations

⚠️ DEPRECATED

Use the search() query with types: [Location] instead.

List a location's children

List a location's descendants

List locations with no parents

List the services available to you.

Explore the known capabilities.

List integrations available to your selected account.

⚠️ DEPRECATED

Integrations will be accessed via search, or similar.

List connections to integrations already made.

Retrieve a specific order

⚠️ DEPRECATED

Use the object() query instead.

List your account's orders

⚠️ DEPRECATED

Use the search query with types: [Order] instead.

List your account's' orders allocated to a location

⚠️ DEPRECATED

Use the search() query with types: [Order] and a location filter instead.

List your account's' orders at a location that are unassigned to any job

Retrieve a specific allocation

⚠️ DEPRECATED

Use the object() query instead.

Order status information.

Provides information on known Order statuses.

Retrieve a product by SKU.

Retrieve inventory movements received

Retrieve an inventory

Retrieve a SKUs inventory

By default it will exclude the inventory of location's children

If account is enabled and children is true, inventory of location's children will be included

Inventory with conditions, i.e. damaged excluded by default, set filter none to include inventory with conditions. Only applicable if account is enabled for inventory condition

Retrieve a product's inventory

By default it will exclude the inventory of location's children

List inventory at a location!

Provide the location Id, include the inventory of location's children

Summarize inventory for a given SKU, and location IDs.

This will return summed quantities of on hand & ATP inventory. This is very useful for checkout when finalizing.

Do note, this will not error based on input, and will best effort summarize inventory. This can lead to 0 sums. The result will indicate locations IDs not used in summing. If critical consider the result invalid if there are unused locations.

Similar to inventorySummarize, but accepts a product ID instead of SKU

Retrieve an allocation's inventory

By default it will not include the inventory of location's children If children is true, inventory of location's children will be included

List quantity inbound and received for a purchase order Only parent locations included in the list, quantity includes location's children

Start, or continue to retrieve the next suggested pick location for a wave/reserved pick.

Retrieve a list of items to pick

Retrieve a list of items reserved for a specific wave

Retrieve a list of items to put away from a location, sorted by:

• Items assigned to allocations which are ready to pack from the selected location
• Items assigned to allocations partly put away sorted by the latest inventory movement
• Unassigned items

Start, or continue to retrieve the next suggested pick location for a wave pick of unassigned items.

Retrieve a list of unassigned items to pick

Retrieve a list of items for replenishment

Retrieve a printer

List your account's printers

List jobs having the given order ID

⚠️ DEPRECATED

Use the search() query instead.

List all orders that is part of a job

Retrieve list of available job configurations

Retrieve a recommended location to put away for a given item.

Retrieve next suggested pick location for a wave/reserved pick.

A quick way to look up something via a barcode. All kinds of things could return. Beware.

🔍 Search on specific object types in Jungle. You must specify what types you are searching for.

List of purchase orders with incoming quantity for an SKU

⚠️ DEPRECATED

Use the object() query with the collection .path instead.

⚠️ DEPRECATED

Use the search() query instead.

⚠️ DEPRECATED

Likely shouldn't use this long term?

⚠️ DEPRECATED

Use the shipment* mutations instead.

⚠️ DEPRECATED

Use the shipment* mutations instead.

List all customers from your Retail Express account

Get insight which can be embedded.

List insights which can be embedded.

Add tags to an object.

Remove tags from an object.

Set custom attributes on the target object.

Add a relationship to an object. This can be blocked for various reasons (reserved names, relation limit etc), however most relationships are allowed.

Remove a specific relationship from an object. If the target is the last member of a relationship group, the group is likely to be removed.

Disables an object.

Enables an object.

Ping the platform. This is useful for devices, integrations, connections, users etc.

Assign (either creates or alters) an external ID/alias against a Jungle object. 🤖: To remove an XID, see the xidUnassign mutation.

Unassign an external ID/alias. Removes it from Jungle. 🤖: To add or restore an XID, see the xidAssign mutation.

Create a backorder against an allocation line.

Input for backorderCreate.

Associate a purchase order line with a backorder.

Dissociate a backorder from it's linked purchase order line item.

Cancel a backorder. Must not have any Purchase Order lines associated to it.

Update quantity for a backorder.

Set geo point (coordinates) on the target object.

Given a URL, Jungle will download and save it as an attachment.

Currently only GET HTTP requests are supported, and Jungle will follow redirects twice.

Attempt to send an attachment to a printer for printing. Note that the printer may not be able to print the specified attachment.

🔍 Export data of a specific data type in Jungle.

⚠️ DEPRECATED

Do not use.

Attempt to send a document to a printer for printing. Note that the printer may not be able to print the specified documentation.

Create a note against an object in Jungle.

🤖: If you are trying to bring in comments, snippets or notes from another system, you should use the .xids field to store the external ID of the comment.

Mutation input for noteCreate

⚠️ DEPRECATED

not implemented. do not use

Create a new identity with web access

Update an existing identity

Upgrade an account user to a full user

Create an account user

Remove user access to an account without destroying their identity

Update your display name.

Upgrade account user to web user.

Invite an existing user into your account.

Create a new reason code.

Create a new channel.

Change the name of a channel.

Change the description of a channel.

Change the code of a channel.

Creates a new location under your account

Changes the postal address of the location, if it exists

Set your (the current user's) default location

Modify the sequence of a location.

Set capabilities on an object.

Set constraints on the capability in relation to the target object.

Connect your account to an integration.

Create an integration with Jungle.

At first only the account this integration was created within may connect to this integration. For other accounts to connect to this integration, the integration will need to go though validation and publishing. You may only have a maximum of 10 unpublished / private integrations.

Use this to create an allocation, which can be independent from any sales order or purchase order.

Associate an order line item with an allocation.

Move items from an allocation or unallocated line item to another allocation, if possible.

Push an Order into Jungle with allocation groupings.

This allows you to specify how the order is split for fulfilment purposes.

If you're just sending all the items to one place, only send through one allocation with the all the line items.

Add a line item to an order. The added line item will be in a new allocation, with the most recently changed shipping address.

Only Order Line Item is supported at the moment.

Set an order's status

Cancels an order.

You can cancel an order in the following situations:

• There are no in progress fulfilments on the order.
• A reason is provided.

The most common reasons for canceling an order include the following:

• The payment was fraudulent.
• The customer changed their mind.
• The products order are not available.
• Shipping or handling faults leading to a refund.

The cancellation will change the status of the order, record a note, and an event of who cancelled and why.

Creates a new allocation against an Order

Associate an order line item with an allocation.

⚠️ DEPRECATED

Use allocationLineItemAssociate instead.

Move items from an allocation to another allocation, if possible.

⚠️ DEPRECATED

Use allocationLineItemMove instead.

Change the shipping address of an allocation

Set/override the location of an allocation. Be mindful, this can only be done if the allocation does not have fulfilments.

Change the fulfilment method of an allocation

Trigger routing logic for an order (if configured).

Cancel a quantity of a line item on an order. If partial cancellation (only some of the line item qty), the line item will be split in two with the target line item having the remaining quantity, and a new line item being created with the cancelled quantity.

🤖: If you cannot cancel the line item, the mutation will fail. To know the reason, refer to the line item's .actions.

Create a new product. It can start with a just a barcode scan.

Update a products name and description.

Update a products SKU. Set sku NULL to remove.

Update a product's dimensions.

Update a product's weight.

Update a product's dangerous goods details.

Create a new brand.

Update brand name.

Set the inventory of a product at a location.

This will assign the on hand quantity to the quantity provided.

Set the inventory of a SKU at a location.

This will assign the on hand quantity to the quantity provided.

Set the inventory at a location.

Allocate inventory at a location.

This is useful for holding inventory from ATP, but hasn't yet left your business.

Clear SKU allocations at a location.

This will reset the quantityAllocated to 0, clearing known allocations. As this can have process consequences, a reason MUST be provided for doing this.

Move inventory between locations.

This will decrement from the source (from), and increment at the destination (to).

Move multiple inventory between locations.

This will decrement from the source (from), and increment at the destination (to).

Update the inventory of a SKU at a location.

This will increment/decrement the on hand quantity using the quantity provided.

Increment the inventory of a SKU at a location, if it can be assigned to allocations(s).

This will increment the on hand quantity using the quantity provided and assign the quantity to allocations(s). If the QTY (in full) cannot be ASSIGNed to any allocation(s). It will reject.

Create an inventory movement request of a SKU

Adjust assignment of a SKU at a location.

With the right quantity, it will potentially make the provided allocation eligible for automated allocation assignment again the next time it executes. As this can have process consequences, a reason MUST be provided for doing this.

Send raw data to a printer.

Be careful.

Sets your default printer, null to remove.

Create fulfilment from shipment

Adds relation to the allocation and create fulfilment from confirmed shipment

⚠️ DEPRECATED

This is to be handled as part of "shipmentCreate" mutation.

Device report weigh. Used by scales & balances (weighing devices) to report recorded weights. Using this on a device marks that device as having the weigh capability.

Create a picking job

Create a packing job

Create a configured job

Create a configured job for picking

Change the shipping address on the packing job.

Assign a pick location to a picking job (applicable to wave)

Add picked SKU to a pick job

Unpick a SKU in a pick job

Add items to a package in a pack job. Support multiple packages.

Remove items from a package in a pack job. Support multiple packages.

Mark an allocation in a pack job as fulfilled

Completes a configured job

Add product by sku to a configured job

Remove a product item by sku from a configured job

Received product to a configured job

Increment inventory using available product

Update quantity to a job product

Assign available product to an allocation

Retrieve an allocation to assign for a given item.

Pick an item

Putaway an item

Move inventory between location

Split out unassigned items from an allocation into a new allocation.

This is useful to have the target allocation ready to be packed.

NOTE: Nothing will happen if all items are assigned.

Split an allocation into two by breaking out quantities of its line items into a new allocation

Create a new supplier.

Set name on a supplier

Set tax number on a supplier

Set currency on a supplier

Set the billing address on a supplier

Set restricted locations for this supplier to operate in

Remove restricted locations for this supplier allowing it to be used anywhere

Set a supplier to be used for the entire job

Override a supplier for a specific product in job

Create a new purchase order.

Add line item to purchase order.

Update line item on existing purchase order.

Remove line item from purchase order.

Update existing purchase order reference.

Update existing purchase order dates.

Update existing purchase order description.

Update existing purchase order supplier.

Update existing purchase order prices.

Update existing purchase order locations.

Update existing purchase order status.

Add receive item to purchase order.

Update receive item on existing purchase order.

Remove receive item from purchase order.

Set a purchase order to be used for the entire job

Override a purchase order for a specific product in job

Create a new purchase return.

Add line item to purchase return.

Approve a purchase return.

Creates a webhook subscription to the given action. Whenever the even type happens, we'll call the URL. On failure retry in +1min, +10min, +1hr, +6hr, then once per day for 7 days

Removes any webhooks matching the given URL with in your account

Creates a new fulfilment collection under an order

Change the state of a collection

Shipment creation, as part of fulfilling an order, and generally an allocation.

⚠️ DEPRECATED

Use the shipmentCreate() mutation instead.

Creates a Draft shipment.

While in Draft, the shipment can be built/updated out to be valid.

Normally a part of fulfilling an order, and generally an allocation.

Once the Shipment no longer has errors. Call the shipmentConfirm mutation.

Updates a Draft shipment.

🤖: Use the shipmentPackageUpdate mutation to update shipment packages.

Updates the service on a Draft shipment.

This will reject on shipments not in Draft.

Shipment package add.

Adds a package to Draft shipment.

Shipment package remove.

Removes a package from Draft shipment.

Shipment package update.

This updates the individual shipment package while shipment is Draft.

🤖: Use shipmentPackageAdd mutation to add new packages.

Shipment confirmation.

Can only be successfully called if the shipment is Draft, and with out errors. This will lock in the shipment, and attempt to send it to 3rd party service provider. If it fails, the shipment will error (Draft), and be available for editing once again.

Shipment label.

Generate shipment label for confirmed shipment

Shipment tracking.

Start tracking a confirmed shipment. This mutation must be called before shipment tracking details can be retrieved.

Refresh status of a single order

⚠️ DEPRECATED

Order statuses are refreshed based on events in the Jungle platform

Connects a RetailExpress account to your account

Send an order to the connected Retail Express account

Connects a AmxAllocation account to your account

Connects a McLeod account to your account

Sends an order to McLeod, through a nominated connection

Connect your Sendle account! This will fail if the credentials are invalid, or the sendle account is not set up.

Connect your Shippit account! Will reject if the credentials are invalid, or the account is not set up.

Set the version of the Sparesbox allocation engine to use

The accounts id

The name of the account.

When the account was created.

Configuration for this account.

GS1 Company Prefix If the company has a prefix, used for GLN, and other GS1 compatibilities. https://www.gs1.org/standards/id-keys/company-prefix

Custom attributes on the account. 🤖: Modify with attribute* mutations.

Information on user list results

The action's human readable name/title.

A unique code for the action. Used to identify the action in logic/software.

The higher the priority, the more important the action is, so show it sooner.

Whether the action is enabled or not. Disabled (false) actions should show as disabled in the UI.

A reason why the action is disabled. Show to the user if they interact with the disabled action.

An ID for this allocation

⚠️ DEPRECATED

Use .id instead.

The name of the allocation. e.g. #000001-A01

The desired fulfilment method for this allocation

The destination for these line items.

⚠️ DEPRECATED

Use location instead.

⚠️ DEPRECATED

Use lineItemsConnection instead.

The total number of products within the allocation.

The service code originally requested on the allocation.

Whether this allocation is fulfilled or not.

Relationships the allocation has.

ID of the order this allocation belongs to.

⚠️ DEPRECATED

Do not use. This will return @deprecated in most cases.

Where this allocation came from. e.g. a sales order, or a supplier return etc. Use this to find the order the allocation belongs to.

Actions the current user can perform on this allocation.

Tags on the Allocation.

When the allocation was created.

When this allocation was modified.

Custom attributes on the object.

If the allocation can be moved/modified

⚠️ DEPRECATED

Use .actions to know what you can and can not do with this allocation.

The backorders for this allocation

The allocation line item ID.

⚠️ DEPRECATED

Use .id instead.

The quantity of the referenced line item belonging to this allocation.

The quantity of the referenced line item that has been fulfilled, if known.

The line item this allocation line item references (uses for source data)

⚠️ DEPRECATED

Do not use. Use .lineItemV2 instead.

The line item this allocation line item references (uses for source data)

The allocation this allocation line item references (uses for source data)

When this allocation line item was created.

When this allocation line item was modified.

Tags on the AllocationLineItem.

Additional custom attributes on the allocation line item. 🤖: Modify with attribute* mutations.

Actions that can be performed on this allocation line item by the current user.

Allocation Line Item Id

Allocation Id

When the event was emitted.

The Id of the account the event occurred within.

An idempotency key for this event. This will be unique for each attempt for a allocation line item move.

The human, integration, device etc that created this event.

The amount changed.

Info on the number of allocations that can be listed

The allocation Id.

When the allocation method was set.

⚠️ DEPRECATED

Use .subject instead.

⚠️ DEPRECATED

Use .subject instead.

The allocation Id.

When the allocation method was set.

⚠️ DEPRECATED

Use .subject instead.

The method the allocation was changed too.

If the allocation had a service code, what is was prior.

Might explain why the allocation was not found

Locations to which items required by this allocation assigned.

The AMX Allocation connection's Id.

⚠️ DEPRECATED

Use .id instead.

The AMX Allocation connection's name

Connection ID for sending orders to Retail Express

Connection ID for sending orders to McLeod

This will always be AmxAllocation for AMX Allocation connections!

Toggle on if you want this connection to be enabled or not

Is this connection working?

When we connected to the engine for the first time

Who connected to the engine

The connection's ID.

⚠️ DEPRECATED

Use .id instead.

The connection's name

Integration details, for branding naming etc

If this connection is to be used or not. 🤖: Control with the toggle* mutations.

Is the connection working, or not.

Unique attachment Id.

⚠️ DEPRECATED

Use .id instead.

⚠️ DEPRECATED

Type will no longer be an enum, instead rely on the content type of the file.

Base64-encoded version of the attachment.

⚠️ DEPRECATED

Obtaining attachment data via the API will no longer be possible. This will return "", and then later removed.

A list of tags.

The asset this attachment belongs to.

⚠️ DEPRECATED

Use relations.parent instead.

When the attachment was created (uploaded).

The name.

File details of the attachment. If the attachment is a file.

Custom attributes on the account. 🤖: Modify with attribute* mutations.

Any attachments found

Information on the number of attachments to be listed

Any attachments found

Information on the number of attachments to be listed

The classification for the address

The address lines for the address

The suburb for the address

The postcode for the address

The state code for the address

The country code for the address

⚠️ DEPRECATED

Use .id instead.

The connection's name

Australia Post customer account number

Integration details, for branding naming etc

If this is test connection or not!

Toggle on if you want this connection to be enabled or not

Is this connection working

The beginning validity date when the charge account can be used

The ending validity date when the charge account can be used

One or more addresses associated with the account

Additional information associated with the account

The postage products and services that can be used with this account

Whether the charge account has an expired contract

The ID issued to a merchant as part of the setup process

Whether the merchant's account is credit blocked. Any account with this status will be forbidden from creating shipments or orders

The name for the postage product

The product group name. Used for generating labels for items that reference the postage product

The code that Australia Post uses to reference the postage product

Options available for the postage product

Specific information related to the location’s contract for this product

The limit on transit cover amounts when authority to leave is selected

Additional shipment features available for the product and its corresponding prices

Additional item features available for the product and its corresponding prices

The beginning validity date for when this product can be used

The ending validity date for when this product can be used

Whether the product can or cannot be used for this location

Whether volumetric pricing is applicable for this product

If volumetric pricing is applicable, the cubing factor to be applied in the calculation

The maximum number of items that can receive the discount price for the product

A unique string that identifies the type of feature

Additional attributes relevant to the feature

Indicates whether the feature is automatically included with the product

Whether the option for 'authority to leave' is available for the postage product

Whether the option for 'signature on delivery' is available for the postage product

Whether Dangerous Goods can be sent with this postage product

A unique string that identifies the type of feature

Indicates whether the feature is automatically included with the product

The raw barcode data

Documents for this authkey

When the name tag was created.

See https://firebase.google.com/docs/auth/admin/create-custom-tokens#sign_in_using_custom_tokens_on_clients

See https://firebase.google.com/docs/auth/admin/create-custom-tokens#sign_in_using_custom_tokens_on_clients

The backorder's unique identifier.

⚠️ DEPRECATED

Use .id instead.

The order allocation line this backorder belongs to.

The purchase order lines this backorder relates to.

The quantity specified to backorder.

The quantity ordered via purchase order lines.

Indicates if a backorder is a purchasing candidate or not. To list these:

search(
  input: {
    types: Backorder
    filter: [{ field: "purchasable", eq: { value: "true" } }]
  }
) ...

The reason specified for the backorder.

The location of the backorder.

The backorder's known external IDs.

If this backorder is active.

If this backorder is a draft.

If this backorder is deleted.

If this backorder is cancelled.

Tags on the backorder.

The user who created the backorder.

When the backorder was modified last, if at all.

When the backorder was created.

A list of backorders. if any.

Raw data in the barcode

symbology

The brand's identifier.

Full path to the brand.

⚠️ DEPRECATED

Use .id instead.

Brand's name.

Custom attributes on the account. 🤖: Modify with attribute* mutations.

When the brand was created in Jungle.

When the brand was last modified.

The brand's known external IDs.

If this brand is active, or not.

The human friendly name of the capability.

The object or real world thing this capability relates too. Helps with finding capabilities.

A clear description of what this capability represents.

Constraints applied to this capability.

If the capability is physical in nature, this can constrain its use to a minimum weight. i.e. Need to put at least 10KG in to tank for transport.

If the capability is physical in nature, this can constrain its use to a maximum weight. i.e. Can only put 4kg in this cardboard box.

If the capability subject is countable, this can constrain its minimum quantity. i.e. Need at least 3 labels.

If the capability subject is countable, this can constrain its maximum quantity, instead of allowing Infinity. i.e. Can only store 20 items.

If the capability is physical in nature, this can constrain its use to non-euclidean space (the outer volume). i.e. It cannot provide more then 1m³. Useful for packaging, storing items etc.

If the capability is physical in nature, this can constrain its volume with in euclidean space (our universe). i.e The outer dimensions of a shipping container.

If the capability is physical in nature, this can constrain the minimum volume allowed with in euclidean space (our universe). i.e Only provide storage for items larger than 1m³.

The channel's identifier.

⚠️ DEPRECATED

Use .id instead.

Tags on the channel.

A unique code for the channel.

Name for the channel.

Description for the channel.

Brand for the channel.

Is this channel active.

When the channel was created in Jungle.

When the channel was last modified.

Custom attributes on the account. 🤖: Modify with attribute* mutations.

The channel's known external IDs.

Info on the number of collections that can be listed

Configuration applied to handheld devices.

If the shipment auto-acceptance price threshold of the matching currency is exceeded, the shipment price requires manual acceptance. Otherwise, all prices are auto accepted.

⚠️ DEPRECATED

Use name instead

⚠️ DEPRECATED

Use name instead

The ISO 3166-1 alpha-2 code for the country.

The name of the country.

Unicode flag. 🏳️. E.g. 🇦🇺, 🇺🇸, 🇻🇳.

The ISO 3166-1 alpha-3 code for the country.

The object Id that was created.

The .__typename of the object the was created.

When the object (subject) was created.

The human, integration, device etc that created this object.

The account the object was created in.

If true, do not save/keep this event.

The event's custom attributes. These are optional, and are not always present.

The ISO 4217 code

The currency's native symbol

The currency's official name

If the currency is a decimal currency, the number of significant digits/sub units

If a rounding currency, this is the significant digits we round too.

⚠️ DEPRECATED

secret squirrel

⚠️ DEPRECATED

secret squirrel

Your default location for the current account, if one is set. This will never work with out account context.

Your default printer for the current user, if one is set. This will never work with out account context.

Your default scale for the current user, if one is set. This will never work with out account context.

The Device's ID.

The path(Id) of this device.

⚠️ DEPRECATED

Use .id instead.

A list of tags(Tag). Use them for classification. You can tag devices with letters, and emojis! 🖨️, ⚖️, 📏, broken etc.

The name of the device.

Who manufactured the device.

The product name of the device.

The device serial number.