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.

Get a specific object using it's type (__typename) and id.

If you are only interacting with a single type, consider using the type specific query if it exists. E.g. Query { order(orderId: $id) }.

🤖: If you need to keep the object's state up to date, see Subscription.object.

Get a specific Allocation using it's Id.

The Allocation's .id

Get a specific AllocationLineItem using it's Id.

The AllocationLineItem's .id

Get a specific Backorder using it's Id.

The Backorder's .id

Get a specific Bill using it's Id.

The Bill's .id

Get a specific BillOfMaterials using it's Id.

The BillOfMaterials's .id

Get a specific Brand using it's Id.

The Brand's .id

Get a specific Channel using it's Id.

The Channel's .id

Get a specific ChannelProduct using it's Id.

The ChannelProduct's .id

Get a specific Collection using it's Id.

The Collection's .id

Get a specific Company using it's Id.

The Company's .id

Get a specific Contact using it's Id.

The Contact's .id

Get a specific Customer using it's Id.

The Customer's .id

Get a specific Entity using it's Id.

The Entity's .id

Get a specific FulfilmentCollect using it's Id.

The FulfilmentCollect's .id

Get a specific InventoryCostLayer using it's Id.

The InventoryCostLayer's .id

Get a specific InventoryIdentityScan using it's Id.

The InventoryIdentityScan's .id

Get a specific InventoryMovement using it's Id.

The InventoryMovement's .id

Get a specific JobConfigured using it's Id.

The JobConfigured's .id

Get a specific LineItem using it's Id.

The LineItem's .id

Get a specific Location using it's Id.

The Location's .id

Get a specific Note using it's Id.

The Note's .id

Get a specific Order using it's Id.

The Order's .id

Get a specific PriceBook using it's Id.

The PriceBook's .id

Get a specific Product using it's Id.

The Product's .id

Get a specific ProductType using it's Id.

The ProductType's .id

Get a specific PurchaseOrder using it's Id.

The PurchaseOrder's .id

Get a specific PurchaseOrderImport using it's Id.

The PurchaseOrderImport's .id

Get a specific PurchaseReturn using it's Id.

The PurchaseReturn's .id

Get a specific ReasonCode using it's Id.

The ReasonCode's .id

Get a specific ReceiveItem using it's Id.

The ReceiveItem's .id

Get a specific ReconciliationLine using it's Id.

The ReconciliationLine's .id

Get a specific Return using it's Id.

The Return's .id

Get a specific Supplier using it's Id.

The Supplier's .id

Get a specific TaxCode using it's Id.

The TaxCode's .id

Get a specific Transaction using it's Id.

The Transaction's .id

Get a specific Transfer using it's Id.

The Transfer's .id

Get currency information.

Get enabled currencies.

Debug & understand money behavior using this.

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

Events By default, returns the most recent events first.

The object whose timeline to fetch... matches events where this object is the subject or appears in any relationship of the event.

Filter, sort, paging. See EventsInput.

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.

Explore the known capabilities.

Retrieve a product by SKU.

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.

List integrations available to your selected account.

⚠️ DEPRECATED

Integrations will be accessed via search, or similar.

List connections to integrations already made.

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.

Order status information.

Provides information on known Order statuses.

Rolling 52-week history for a product: inventory on-hand and sales order volume, bucketed per week in the tenant's configured timezone.

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

Optional channel ID to filter inventory based on channel product configuration. If provided, quantities will be adjusted based on channel product settings (enabled, quantityAvailableMaximum).

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

List of assigned inventory at a Location

List of inventory items that can be used for assignment

This includes unassigned and items currently assigned

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

Retrieve a list of items to put away from a location, with more freedom on which item can be selected first.

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 summary of things that need replenishment in a location

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 (or a list of) recommended location to put away for a given item.

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

Preview what would be reserved for a wave/reserved pick.

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

List of purchase orders with incoming quantity for an SKU

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

What a search of the given types accepts — the fields it can filter, sort and count by.

Use it to build a search interface without knowing the types in advance; the answer comes from the same configuration a search itself is run with.

Types to describe. Any type that implements the Searchable interface is valid.

Counts the values of the given fields across everything a search matches.

Takes the same filters as search() and returns no records, so a set of counts can be refreshed as filters change without paying for results that are thrown away.

⚠️ DEPRECATED

Likely shouldn't use this long term?

Get daily statistics for a date range

Start date in ISO 8601 format (YYYY-MM-DD)

End date in ISO 8601 format (YYYY-MM-DD)

Timezone for date calculations (e.g., 'Australia/Brisbane')

Order statistics for the past 180 days, one row per calendar day.

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.

Set geo point (coordinates) on the target object.

Report an event into the Jungle platform.

This is useful for recording events that happen in external systems, or that are triggered by user actions in client apps but don't correspond to a specific platform state change. Reported events are persisted to the timeline alongside platform-emitted events, but they are observational only and do not change platform state directly.

Additionally, reported events can be published to downstream consumers (webhooks, event bus subscribers, partner integrations) when publish is true. This also allows external systems to react to application events, even if they don't have a direct integration.

Rate limit: approximately 1 event per second per actor.

On success returns MutationSuccess with the created (or, on idempotent retry, the prior) event in objects.

Possible MutationFailure.code values:

• IDEMPOTENCY_CONFLICT — same idExternal already exists with different content.
• NOT_FOUND — direct subject doesn't exist or the caller isn't permitted to see it.
• UNAUTHORIZED_SUBJECT — caller isn't authorised to post events against this subject.
• INVALID_TYPE — type violates the CloudEvents URI pattern or uses a reserved namespace.
• INVALID_RELATIONSHIPS — relationships contains an entry with an unknown typename or invalid shape.
• TOO_MANY_RELATIONSHIPS — relationships exceeds 16 entries.
• TOO_MANY_EVENTS — batch input exceeds 5 events.
• DATA_TOO_LARGE — data exceeds 64 KiB serialised.

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.

Given base64-encoded content, Jungle will decode and save it as an attachment.

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.

Parameters for creating a new account.

Restore the geographic point on an object's postal address from a previously computed geocoding result, when one is available. This never performs new geocoding: when no previously computed point is available for the address, no change is made.

Supported addresses: Order.billingAddress, Allocation.shippingAddress, Location.address, Supplier.address, Supplier.billingAddress, Supplier.returnAddress, Return.fromAddress.

On success, objects contains the updated object when a point was restored, and is empty when no change was made (see logs for the outcome).

Create a new reason code.

Set capabilities on an object.

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

Set the tax profile for a supported subject.

The tax profile details to set.

Set the active tax registration under a supported subject's tax profile.

The tax registration details to set.

Remove the active tax registration of a given type and country from a supported subject's tax profile.

The tax registration to remove.

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

Update a products name and description.

⚠️ DEPRECATED

Use productUpdate() instead.

Update a products SKU. Set sku NULL to remove.

Update a product's dimensions.

⚠️ DEPRECATED

Use productUpdate() instead.

Update a product's weight.

⚠️ DEPRECATED

Use productUpdate() instead.

Update a product's dangerous goods details.

⚠️ DEPRECATED

Use productUpdate() instead.

Set the Harmonised System Code of a product

⚠️ DEPRECATED

Use productUpdate() instead.

Update a product.

🤖: Optional fields that are not defined in the input will not be changed. ⚠️: Setting an input field to NULL will remove the value where possible. It is STRONGLY recommended you only explicitly set the fields you want to change.

Set cost figures for a product within a single entity.

🤖: Optional fields that are not defined in the input will not be changed. ⚠️: Setting an input field to NULL will remove the value.

Create a supplier preference for a product, optionally scoped to a location.

A product can have at most one preference per supplier and location (including the product-wide case where no location is given); creating an exact duplicate fails.

Update the priority of a product's supplier preference.

Delete a product's supplier preference.

Create a new collection.

Update an existing Collection.

Add Products to a Collection. Adding a Product that is already in the Collection changes nothing.

Remove Products from a Collection. Removing a Product that is not in the Collection changes nothing.

Create a new location under your account.

Changes the postal address of the location, if it exists

Update mutable properties of a location (dimensions, volume, floor, and geometry). Only provided fields are changed; provide null to clear a nullable field.

Set your (the current user's) default location

Modify the sequence of a location.

Migrate location to a new root location or location under different root location.

This will disable the location and create a new location with the same details in the destination location. Existing inventory and barcode will be moved to the new location.

Create a new channel.

Change the name of a channel.

Change the description of a channel.

Change the code of a channel.

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.

Cancel a specific amount of the provided line item.

Increment quantity of the provided line item. Only Order Line Item is supported at the moment.

Set line items for a line item source.

Decrement the quantity to receive of a line item by a certain amount. Useful when items will never arrive, or will not ever be received by conventional means, i.e: lost in transit, etc. Only Transfer Line Item is supported at the moment.

Increment the quantity to receive of a line item by a certain amount. Useful to restore the quantity previously marked as "will never receive". Only Transfer Line Item is supported at the moment.

Create a new Transaction

Update an Transaction.

This allows updating an Transaction.

Note, not every field on an Transaction is updatable.

🤖: Optional fields that are not defined in the input will not be changed. ⚠️: Setting an input field to NULL will remove the value where possible. It is STRONGLY recommended you only explicitly set the fields you want to change.

Create an identity scan

Update an identity scan.

🤖: Optional fields that are not defined in the input will not be changed. ⚠️: Setting an input field to NULL will remove the value where possible. It is STRONGLY recommended you only explicitly set the fields you want to change.

Use this to create an allocation, which can be independent from any allocation source

Associate an order line item with an allocation.

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

Allow fulfilment for the allocation.

Hold fulfilment for the allocation.

Change the fulfilment method of an allocation

Split out unassigned items from an allocation into a new allocation. This is useful to have the target allocation ready to be packed.

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.

Create a new Order.

⚠️: Calling orderCreate without any input will create an empty, Intent to sell Order in the system.

Update an Order.

This allows updating an Order.

Note, not every field on an Order is updatable.

🤖: Optional fields that are not defined in the input will not be changed. ⚠️: Setting an input field to NULL will remove the value where possible. It is STRONGLY recommended you only explicitly set the fields you want to change.

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.

Set an order's fulfilment allowed.

This will allow or disallow future fulfilment for the order.

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

⚠️ DEPRECATED

Use allocationMethodSet instead.

Trigger routing logic for an order (if configured).

Set customer ID on an order.

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 brand.

Update brand name.

⚠️ DEPRECATED

Use brandUpdate instead.

Update a brand.

Create a new Entity.

Update an Entity.

This allows updating an Entity.

Note, not every field on an Entity is updatable.

🤖: Optional fields that are not defined in the input will not be changed. ⚠️: Setting an input field to NULL will remove the value where possible. It is STRONGLY recommended you only explicitly set the fields you want to change.

Create a new price book.

Update a price book.

Note, not every field on a price book is updatable.

🤖: Optional fields that are not defined in the input will not be changed. ⚠️: Setting an input field to NULL will remove the value where possible. It is STRONGLY recommended you only explicitly set the fields you want to change.

Set the price for a product in a price book.

Creates the line when the product is not yet priced in the book, updates it when it is. Setting unitPrice to NULL removes the product's line from the book.

Set the quantity price breaks for a product's line in a price book.

Atomically replaces the line's full break list; an empty list removes all breaks. Each break must have a unique quantityMinimum of at least 2, and exactly one of unitPrice (in the book's currency) or percentOff.

Assign a price book to a supplier, making the book's prices applicable to that supplier.

Only purchasing books can be assigned to suppliers. A supplier may have multiple applicable books; assigning the same book to the same supplier twice fails.

Update a price book supplier assignment, reassigning the book to a different supplier or changing its priority.

🤖: Optional fields that are not defined in the input will not be changed.

Delete a price book supplier assignment, making the book no longer applicable to the supplier.

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.

Assign list of inventory to a target If inventory to to take from is provided it will be reassigned from it's current target if exist, to the new target.

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.

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.

Adjust the sequence number on SKU at a location level.

This will affect the order in which the inventory is listed for sequence-dependent operations (i.e: wave picking) whilst location sequencing is still in effect. Useful for overriding the default sequence of inventory, while respecting the location sequence (i.e: deferring an item to the end of a wave pick).

Only works when the inventory is reserved for an operation.

Update inventory preference.

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.

Update a device.

Sets your default device per capability.

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.

⚠️ DEPRECATED

Use orderAllocationSetShippingAddress instead.

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.

Pack assigned inventory at a location. Useful there are multiple items already collated into ready-to-pack containers.

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

Set a reason code for the item

Upload attachment for the item (ie: Supporting documents, photo evidence, etc).

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

Set a purchase order to be used for the entire job

Override a purchase order for a specific product in job

Set a supplier to be used for the entire job

Override a supplier for a specific product in job

Create a new supplier.

Set name on a supplier

⚠️ DEPRECATED

Use supplierUpdate instead.

Set tax number on a supplier

⚠️ DEPRECATED

Use supplierUpdate instead.

Set currency on a supplier

⚠️ DEPRECATED

Use supplierUpdate instead.

Set the billing address on a supplier

⚠️ DEPRECATED

Use supplierUpdate instead.

Set restricted locations for this supplier to operate in

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

Update a supplier.

🤖: Optional fields that are not defined in the input will not be changed. ⚠️: Setting an input field to NULL will remove the value where possible. It is STRONGLY recommended you only explicitly set the fields you want to change.

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.

Split the unreceived line items of a purchase order into a new purchase order.

The new purchase order inherits the source's description, supplier, locations, dates, tags, and currency details, with a reference derived from the source's reference. Prices and captured document totals (subtotalTaxExclusive, discountTotal, taxTotal, totalTaxInclusive) are not inherited and remain unset on the new purchase order, as the source's values describe the full original document rather than the split portion. The unreceived quantity is split off into newly created line items on the new purchase order that retain their tax code, discount, and price fields, while the source line items keep their remaining quantity.

A purchase order that has captured tax or totals — document-level totals, or per-line tax, discount, or total amounts — cannot be split until those captured values are cleared, because splitting would leave them describing the wrong quantities.

Update existing purchase order prices.

Update existing purchase order locations.

Update existing purchase order status.

Update existing purchase order supplier invoice reference.

Add receive item to purchase order.

⚠️ DEPRECATED

Use receiveItemReconcile instead.

Update receive item on existing purchase order.

⚠️ DEPRECATED

Use receiveItemReconcile instead.

Remove receive item from purchase order.

⚠️ DEPRECATED

Use receiveItemUnreconcile instead.

Import multiple purchase orders from CSV. Check on the progress of the import using the purchaseOrderImport query.

Create a new purchase return.

Add line item to purchase return.

Approve a purchase return, this sets the fulfilment allowed for associated allocations to true.

Cancel a purchase return.

Cancels all remaining line item quantities, releases allocated inventory and unassigns any assigned inventory back to its source locations, cancels open pack jobs once emptied, prevents further fulfilment and records the cancellation reason. The purchase return's status becomes cancelled and the return can no longer be approved, updated or fulfilled.

A purchase return cannot be cancelled when any quantity has been fulfilled, or while any quantity is packed in a pack job — cancel the pack job first. Cancelling an already-cancelled purchase return makes no further changes.

Set purchase return's fulfilment allowed.

This will allow or disallow future fulfilment for the purchase return.

Update a purchase return.

🤖: Optional fields that are not defined in the input will not be changed. ⚠️: Setting an input field to NULL will remove the value where possible. It is STRONGLY recommended you only explicitly set the fields you want to change.

Receive items into inventory.

The locations must have the store capability enabled, and must be child locations. Note that if any of the items are reconcilable, and cannot be reconciled, the creation will be rejected.

Reconcile a received item for inventory purpose, this will also associate the receive item with the target.

Un-reconcile a received item for inventory purpose, this will not remove the association between the receive item and the target.

Transfer Create.

Transfer products between two locations, as a request, and to be managed like a sales order etc.

Create a new return.

Mark a return as accepted.

Cancel a return.

Set tracking details for a return.

Create a new customer.

Update a customer.

🤖: Optional fields that are not defined in the input will not be changed. ⚠️: Setting an input field to NULL will remove the value. It is STRONGLY recommended you only explicitly set the fields you want to change.

Create a new company.

Update a company.

🤖: Optional fields that are not defined in the input will not be changed. ⚠️: Setting an input field to NULL will remove the value. It is STRONGLY recommended you only explicitly set the fields you want to change.

Associate a customer with a company.

Disassociate a customer from a company.

Create or update a channel product configuration.

If a configuration already exists for the product/channel/location combination, it will be updated. Otherwise, a new configuration is created.

Delete a channel product configuration.

After deletion, the product will use default availability rules (fully available with actual inventory).

Update a contact.

🤖: Optional fields that are not defined in the input will not be changed. ⚠️: Setting an input field to NULL will remove the value where possible. It is STRONGLY recommended you only explicitly set the fields you want to change.

Create a new bill.

Update a bill.

🤖: Optional fields that are not defined in the input will not be changed. ⚠️: Setting an input field to NULL will remove the value where possible. It is STRONGLY recommended you only explicitly set the fields you want to change.

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.

⚠️ DEPRECATED

Use allocationSplitUnassigned instead.

Split an allocation into two by breaking out quantities of its line items into a new allocation. Works for any allocation source (Order, Transfer, PurchaseReturn, etc.).

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

⚠️ DEPRECATED

Use allocationSplit instead.

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 and ready shipment. This 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

Update a supplier product.

⚠️: Setting an input field to NULL will remove the value. It is STRONGLY recommended you only explicitly set the fields you want to change.

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

⚠️ DEPRECATED

Disabled. Contact us for alternatives.

Removes any webhooks matching the given URL with in your account

⚠️ DEPRECATED

Disabled. Contact us for alternatives.

Connect your Australia Post account

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.

Connect your Starshipit 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

Update purchasing details configuration for a supplier. Creates the purchasing detail record if it doesn't exist.

⚠️: Setting an input field to NULL will remove the value. It is STRONGLY recommended you only explicitly set the fields you want to change.

Update only the purchase order distribution settings for a supplier. Creates the purchasing detail record if it doesn't exist. Allows granular control over automated purchase order delivery configuration.

⚠️: Setting any input field to NULL will remove the value.

Update only the outstanding items distribution settings for a supplier. Creates the purchasing detail record if it doesn't exist. Allows granular control over automated outstanding items reporting configuration.

⚠️: Setting any input field to NULL will remove the value.

Update only the purchase returns distribution settings for a supplier. Creates the purchasing detail record if it doesn't exist. Allows granular control over purchase return policy and notification distribution.

⚠️: Setting any input field to NULL will remove the value.

Broadcasts the server time every ~sec.

Useful to test your connection.

Triggered when the matching object changes in some way. 🤖: This a useful way to keep state synchronized. ❗: You may be notified of changed state even when the changed data is not what you're requesting from the API.

Stream events as they happen for a given object and event-type set.

The accounts id

⚠️ DEPRECATED

Use .id instead.

Used for URLs and other publicly shown unique identifiers of an account. The value is not guaranteed to stay the same over time.

The name of the account.

An image representing the account, usually a logo, if available.

When the account was created.

When the account was last modified.

Configuration for this account.

If the account has finished the onboarding/creation process.

Account billing status.

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.

A single key from the account's custom attributes.

Tip: Use GraphQL aliases to fetch attributes as your own properties. See https://graphql.org/learn/queries/#aliases Usage: companyWebsite: attributeValue(input: { attributeId: "website" }).

The entities this user may work in.

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.

The action verb (e.g. Cancel, Submit, Receive).

The id of the object the action was performed on.

The typename of the object the action was performed on.

When the event was created.

The actor that performed the action.

The account the event belongs to.

When true, downstream consumers should not retain a copy of the event.

Custom attributes attached to the event. Optional.

The connection Id

⚠️ DEPRECATED

Use .id instead.

The connection's name

Integration details, for branding naming etc

If the connection is enabled.

If it is actually connected.

When the connection was created.

Who connected the integration.

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.

The explicit pick up location

⚠️ DEPRECATED

Use lineItemsConnection instead.

The number of line items within the allocation.

The total number of products within the allocation.

The service code to use to fulfil the allocation with.

The service code originally requested on the allocation.

If false, prevent allocation to be fulfilled.

If and when this allocation was fulfilled.

Whether this allocation is fulfilled or not.

Relationships the allocation has.

⚠️ 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.

Custom attributes on the object.

A single key from the allocation's custom attributes.

Tip: Use GraphQL aliases to fetch attributes as your own properties. See https://graphql.org/learn/queries/#aliases Usage: accountingApproved: attributeValue(input: { attributeId: "approvedbyaccounting" }).

When the allocation was created.

The user or integration that created the allocation.

When this allocation was modified.

When the allocation last processed some action that either directly or indirectly relates to this allocation being acted upon towards completion.

If the allocation can be moved/modified

⚠️ DEPRECATED

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

Serial number / identity scans associated with this line item.

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 quantity of the referenced line item that is currently allocated, if known.

The quantity of the referenced line item that is currently assigned, if known.

The quantity of the referenced line item that is currently packed, if known.

The inventory held for this line item, by location: the locations holding assigned or allocated inventory and the quantities held at each.

When the same SKU is referenced by multiple line items of an allocation, the quantities at each location are apportioned across those line items, so that each line item's inventory sums to its own quantityAssigned and quantityAllocated.

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)

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

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.

A single key from the allocation line item's custom attributes.

Tip: Use GraphQL aliases to fetch attributes as your own properties. See https://graphql.org/learn/queries/#aliases Usage: plasticColor: attributeValue(input: { attributeId: "pcolor" }).

The backorders for this allocation

The location holding the inventory.

The quantity assigned to the line item at this location.

The quantity allocated to the line item at this location.

Allocation Line Item Id

Allocation Id

When the event was emitted.

The Id of the account the event occurred within.