GraphQL Reference
View reference documentation to learn about the data types available in the Jungle GraphQL API schema.
Below is reference of all queries, mutations, interfaces, types (objects), scalars (values), enums, unions and inputs in the Jungle.
Table of Contents
- Query
- Mutation
- Subscription
- Objects
- Account
- AccountListResult
- AccountListResultEdge
- AccountUser
- AccountUserCreateResult
- AccountUserListResult
- AccountUserListResultEdge
- Action
- Actioned
- AddressValidationResult
- Allocation
- AllocationAlreadyAssigned
- AllocationAlreadyReleased
- AllocationLineItem
- AllocationLineItemMoved
- AllocationLineItemResult
- AllocationLineItemResults
- AllocationLocationSet
- AllocationMethodSet
- AllocationNotFound
- AllocationPicked
- AllocationReadyToPack
- AllocationResult
- AllocationResultNode
- AllocationResults
- AllocationSelectedToPick
- AmxAllocationConnection
- ApiConnection
- AssignedInventory
- Attachment
- AttachmentListResult
- AttachmentListResultEdge
- AttachmentListV2Result
- AustraliaPostAccountAddress
- AustraliaPostAccountDetail
- AustraliaPostConnection
- AustraliaPostPostageProduct
- AustraliaPostPostageProductContract
- AustraliaPostPostageProductFeature
- AustraliaPostPostageProductFeatureAttribute
- AustraliaPostPostageProductOption
- AustraliaPostPostageProductShipmentFeature
- AuthKey
- AuthKeyAuthenticated
- AuthKeyInvalidPinError
- AuthKeyListResult
- AuthKeyListResultEdge
- AuthKeyNotFoundError
- AuthKeyPinReset
- AuthSwitchAccountAuthenticated
- AuthSwitchAccountDenied
- Backorder
- BackorderResults
- Barcode
- Brand
- Capability
- CapabilityConstraints
- CapabilityListResult
- CapabilityListResultEdge
- Channel
- ClickAndCollectCreated
- ClickAndCollectReadyEvent
- ClickAndCollectStateChanged
- CollectionListResult
- CollectionListResultEdge
- Configuration
- ContactPerson
- Country
- Created
- Currency
- CustomAttributeString
- Customer
- Defaults
- Deleted
- Device
- DeviceWeighReport
- Dimensions
- Documentation
- DocumentationNotAvailable
- DocumentationNotSupported
- DocumentationSupported
- DocumentationSupportedResult
- ExportCreated
- ExportFailure
- ExportSubmitted
- ExternalId
- ExternalIdResults
- File
- FulfillmentCreatedEvent
- FulfilmentCollect
- FulfilmentCollectChangeStateResult
- FulfilmentCollectCreateResult
- FulfilmentLineItem
- FulfilmentLineItemResult
- FulfilmentLineItemResults
- FulfilmentManual
- FulfilmentShipment
- FulfilmentShipmentCreateResult
- FulfilmentShipmentResult
- FulfilmentShipmentResults
- GeoCodePoint
- GeoCodeResult
- HandheldConfiguration
- Identity
- Image
- InsightEmbeddableDetails
- InsightEmbeddableResult
- InsightEmbeddableResults
- Integration
- IntegrationConnectionListResult
- IntegrationConnectionListResultEdge
- IntegrationConnectionSource
- IntegrationListResult
- IntegrationListResultEdge
- IntegrationPrivate
- Inventory
- InventoryAllocated
- InventoryAllocationsCleared
- InventoryAlreadyAllocated
- InventoryAlternative
- InventoryAlternativesResult
- InventoryAssignableResult
- InventoryAssignment
- InventoryAssignmentSummary
- InventoryByAllocation
- InventoryByPurchaseOrder
- InventoryCreateResult
- InventoryItem
- InventoryItemResultEdge
- InventoryListAssignedAtLocationResult
- InventoryListResult
- InventoryListResultEdge
- InventoryMoved
- InventoryMovement
- InventoryMovementReceivedListResult
- InventoryNotFound
- InventoryPreference
- InventoryPutAwayItemsByLocationResult
- InventoryPutAwayItemsByLocationResultNode
- InventoryPutAwayItemsResult
- InventoryPutAwayItemsResultNode
- InventoryReplenishablePickItemsResult
- InventoryReplenishablePickItemsResultNode
- InventoryReservedItemsListResult
- InventoryReservedPickItemsResult
- InventoryReservedPickItemsResultNode
- InventoryReservedPickResult
- InventorySetEvent
- InventorySummarizeResult
- InventorySummary
- InventoryUnassignedPickItemsResult
- InventoryUnassignedPickItemsResultNode
- InventoryUnassignedPickResult
- JobAllocationLimit
- JobAllocationNotFound
- JobAllocationToPack
- JobChangeStatusResult
- JobConfiguration
- JobConfigurationList
- JobConfigurationOperation
- JobConfigurationResultEdge
- JobConfigured
- JobConfiguredLocationsPutAwayResult
- JobConfiguredPickPreview
- JobConfiguredPickPreviewAllocation
- JobConfiguredPickPreviewResult
- JobConfiguredProduct
- JobConfiguredProductAssignedToAllocation
- JobConfiguredProductAttachmentUploadTokenCreateResult
- JobConfiguredProductIncrementInventory
- JobConfiguredProductPicked
- JobConfiguredProductPutaway
- JobConfiguredProductReceived
- JobListResult
- JobListResultEdge
- JobNotFound
- JobOperationArgument
- JobPack
- JobPackAllocationMarkFulfilledResult
- JobPackAllocationShippingAddressSet
- JobPackCreateResult
- JobPackItem
- JobPackPackageContent
- JobPackSkuResult
- JobPick
- JobPickCreateResult
- JobPickItem
- JobPickLocationAssignResult
- JobPickedSku
- JobSkuLimit
- JobStatusChanged
- JunglePrinter
- LineItem
- LineItemResultNode
- LineItemResults
- Location
- LocationCreateResult
- LocationListResult
- LocationListResultEdge
- LocationNotFound
- LocationSetParent
- Log
- McLeodConnection
- Modified
- Money
- MoneyAdjustment
- MoneyV1
- MutationFailure
- MutationSuccess
- Note
- NoteResultNode
- NoteResults
- ObjectCreated
- Order
- OrderAllocatedEvent
- OrderAllocationChangeForbidden
- OrderAllocationMoved
- OrderAllocationSetShippingAddress
- OrderCancellationForbidden
- OrderCancelled
- OrderConsumed
- OrderConsumedResult
- OrderLineItem
- OrderLineItemCancelled
- OrderListFromJobResult
- OrderListResult
- OrderListResultEdge
- OrderNotFound
- OrderSetStatusResult
- OrderSourceName
- OrderStatusInfo
- OrderStatusInfoResult
- Package
- PageInfo
- PartNumber
- PartNumberResultNode
- PartNumberResults
- PostalAddress
- PostalAddressChanged
- PrintSubmitted
- PrinterListResult
- PrinterListResultEdge
- PrinterNotFoundError
- Product
- ProductAttribute
- ProductDangerousGoods
- ProductShipsAsPackage
- PurchaseOrder
- PurchaseOrderImport
- PurchaseOrderImportResult
- PurchaseOrderImportState
- PurchaseOrderImportSummary
- PurchaseOrderInboundItem
- PurchaseOrderInboundItemBySkuResult
- PurchaseOrderLineItemResults
- PurchaseOrderReceiveItem
- PurchaseReturn
- ReasonCode
- ReceiveItem
- ReceiveItemResult
- ReceiveItemResults
- RelationshipGroupToMany
- RelationshipGroupsConnection
- RelationshipMemberEdge
- Relationships
- RetailExpressConnection
- RetailExpressCustomer
- RetailExpressCustomerListResult
- Return
- ReturnLineItem
- ReturnLineItemResult
- ReturnLineItemResults
- ReturnReceived
- ReturnResult
- ReturnResults
- Role
- SearchEdge
- SearchError
- SearchFieldSummaries
- SearchFieldSummary
- SearchPageInfo
- SearchResult
- SendleConnection
- Service
- ServiceListResult
- ServiceListResultEdge
- ServiceProvider
- Shipment
- ShipmentAcceptance
- ShipmentAddress
- ShipmentPackage
- ShipmentPackageConfirmed
- ShipmentPackageContent
- ShipmentReady
- ShipmentServicesResult
- ShipmentTracking
- ShipmentTrackingCheckpoint
- ShipmentTrackingUpdated
- ShipmentV2
- ShippitConnection
- SparesboxAllocationConnection
- StarshipitConnection
- StatusInfo
- Supplier
- TagListResult
- Transfer
- UploadToken
- User
- Webhook
- WhoAmIResult
- Inputs
- AccountUserCreateInput
- AccountUserDeleteInput
- AccountUserInviteInput
- AccountUserUpdateInput
- AccountUserUpgradeInput
- ActionInput
- AddressValidationInput
- AllocationCreateInput
- AllocationFulfilmentAllowInput
- AllocationFulfilmentHoldInput
- AllocationInput
- AllocationLineItemAssociateInput
- AllocationLineItemInput
- AllocationLineItemMoveInput
- AllocationLineItemQuantityInput
- AllocationMethodSetInput
- AllocationSplitUnassignedInput
- AllocationsConnectionInput
- AmxAllocationConnectEngineInput
- ApiKeyCreateInput
- AttachmentListInput
- AttachmentListV2Input
- AttachmentPrintInput
- AttachmentUploadFromBase64Input
- AttachmentUploadFromUrlInput
- AttachmentUploadTokenInput
- AttributesSetInput
- AustraliaPostCredentialsInput
- AuthKeyLoginInput
- AuthListKeysInput
- AuthSwitchAccountInput
- BackorderAssociatePurchaseOrderLineItemInput
- BackorderCancelInput
- BackorderCreateAllocationLineItemInput
- BackorderCreateInput
- BackorderDissociatePurchaseOrderLineItemInput
- BackorderQuantityUpdateInput
- BarcodeAddInput
- BarcodePrintInput
- BarcodeRemoveInput
- BrandCreateInput
- BrandSetNameInput
- CapabilitiesSetInput
- CapabilityConstraintsInput
- CapabilityConstraintsSetInput
- CapabilityWithConstraintsInput
- ChannelCreateInput
- ChannelSetCodeInput
- ChannelSetDescriptionInput
- ChannelSetNameInput
- CollectionGetInput
- CollectionListAtLocationInput
- ContactPersonInput
- CustomAttributeInput
- CustomerCreateInput
- CustomerUpdateInput
- DateRangeFilterInput
- DeviceReportWeighInput
- DimensionsInput
- DocumentationInput
- DocumentationPrintInput
- DocumentationSupportedInput
- EventsSubscriptionInput
- ExportColumn
- ExportInput
- ExternalIdAssignInput
- ExternalIdUnassignInput
- ExternalIdsInput
- FilterInput
- FulfilmentCollectChangeStateInput
- FulfilmentCollectCreateInput
- FulfilmentInput
- FulfilmentInventoryPolicyInput
- FulfilmentShipmentAddInput
- FulfilmentShipmentCreateInput
- GeoAddressInput
- GeoCodeInput
- GeoPointSetInput
- IdentityCreateInput
- IdentityUpdateInput
- ImageTransformInput
- ImageUrlInput
- InsightEmbeddableInput
- InsightEmbeddableListInput
- IntegrationConnectInput
- IntegrationCreateInput
- InventoryAllocateInput
- InventoryAllocationsClearInput
- InventoryAssignFromInput
- InventoryAssignInput
- InventoryAssignableFilterInput
- InventoryAssignableInput
- InventoryAssignmentAdjustInput
- InventoryByAllocationFilterInput
- InventoryByProductInput
- InventoryByPurchaseOrderInput
- InventoryFilterInput
- InventoryListAssignedAtLocationInput
- InventoryListAtLocationInput
- InventoryMoveInput
- InventoryMovementCreateInput
- InventoryMovementFromSubjectInput
- InventoryMovementReceivedListFilterInput
- InventoryMovementReceivedListInput
- InventoryMovementReceivedSortInput
- InventoryMovementToSubjectInput
- InventoryMovesInput
- InventoryMovesItemInput
- InventoryPreferenceUpdateInput
- InventoryPutAwayItemsInput
- InventoryReplenishablePickItemsInput
- InventoryReservedItemsListFilterInput
- InventoryReservedItemsListInput
- InventoryReservedPickInput
- InventoryReservedPickItemsInput
- InventoryReservedSequenceAdjustInput
- InventorySetAtLocationInput
- InventorySetAtLocationItemInput
- InventorySetByProductInput
- InventorySetBySkuInput
- InventorySummarizeByProductInput
- InventorySummarizeInput
- InventoryUnassignedPickInput
- InventoryUnassignedPickItemsInput
- InventoryUpdateBySkuInput
- JobAllocationInput
- JobChangeStatusInput
- JobConfigurationListInput
- JobConfiguredAddProductInput
- JobConfiguredCompleteInput
- JobConfiguredCreateInput
- JobConfiguredLocationPutAwayInput
- JobConfiguredPickCreateInput
- JobConfiguredPickLocationNextInput
- JobConfiguredPickPreviewInput
- JobConfiguredProductAllocationAssignInput
- JobConfiguredProductAttachmentUploadTokenCreateInput
- JobConfiguredProductIncrementInventoryInput
- JobConfiguredProductInventoryMoveInput
- JobConfiguredProductPickInput
- JobConfiguredProductPutawayInput
- JobConfiguredProductReasonCodeSetInput
- JobConfiguredProductReceivedInput
- JobConfiguredProductUpdateAllocationInput
- JobConfiguredProductUpdatePurchaseOrderInput
- JobConfiguredProductUpdateQuantityInput
- JobConfiguredProductUpdateSupplierInput
- JobConfiguredRemoveProductItemInput
- JobConfiguredUpdatePurchaseOrderInput
- JobConfiguredUpdateSupplierInput
- JobListForOrderInput
- JobPackAllocationMarkFulfilledInput
- JobPackAssignedAtLocationInput
- JobPackCreateInput
- JobPackSetAllocationShippingAddressInput
- JobPackSkuInput
- JobPackSkuToPackageInput
- JobPickCreateInput
- JobPickLocationAssignInput
- JobPickSkuInput
- JobSetPackageInfoInput
- KeyValueInput
- LineItemAddInput
- LineItemCancelInput
- LineItemCreateInput
- LineItemQuantityIncrementInput
- LineItemUpdateInput
- ListInput
- LocationChangeAddressInput
- LocationCreateInput
- LocationSequenceInput
- LocationSetDefaultInput
- LocationSetNameInput
- LocationSetParentInput
- LocationSetReferenceInput
- McLeodConnectAccountInput
- McLeodSendOrderInput
- MoneyAdjustmentInput
- MoneyInputV2
- NoteCreateInput
- NoteInput
- ObjectAttributeInput
- ObjectAttributesInput
- ObjectInput
- ObjectInputV2
- ObjectInputV3
- ObjectSubscriptionInput
- OrderAllocationCreateInput
- OrderAllocationInput
- OrderAllocationLineItemAssociateInput
- OrderAllocationLineItemMoveInput
- OrderAllocationSetLocationInput
- OrderAllocationSetMethodInput
- OrderAllocationSetShippingAddressInput
- OrderAllocationSplitInput
- OrderAllocationSplitToInput
- OrderAllocationSplitUnassignedInput
- OrderCancelInput
- OrderConsumeAllocatedInput
- OrderCustomAttributeInput
- OrderCustomerSetInput
- OrderLineItemAddInput
- OrderLineItemCancelInput
- OrderLineItemInput
- OrderLineItemsInput
- OrderListAtLocationInput
- OrderListFromJobInput
- OrderRouteInput
- OrderSetFulfilmentAllowedInput
- OrderSetStatusInput
- OrderStatusRefreshInput
- PackageInput
- PartNumberInput
- PingInput
- PostalAddressInput
- PrintRawInput
- PrinterSetDefaultInput
- ProductAttributeInput
- ProductCreateInput
- ProductDangerousGoodsInput
- ProductInventoryInput
- ProductSetDangerousGoodsInput
- ProductSetDimensionsInput
- ProductSetHsCodeInput
- ProductSetNameInput
- ProductSetSkuInput
- ProductSetWeightInput
- ProductShipsAsPackageInput
- ProductUpdateInput
- PurchaseOrderCreateInput
- PurchaseOrderDatesUpdateInput
- PurchaseOrderDescriptionUpdateInput
- PurchaseOrderImportCreateInput
- PurchaseOrderInboundItemBySkuFilterInput
- PurchaseOrderInboundItemBySkuInput
- PurchaseOrderLineItemAddInput
- PurchaseOrderLineItemRemoveInput
- PurchaseOrderLineItemUpdateInput
- PurchaseOrderLocationUpdateInput
- PurchaseOrderPriceUpdateInput
- PurchaseOrderReceiveItemAddInput
- PurchaseOrderReceiveItemRemoveInput
- PurchaseOrderReceiveItemUpdateInput
- PurchaseOrderReferenceUpdateInput
- PurchaseOrderSetStatusInput
- PurchaseOrderSplitUnreceivedLineItemsInput
- PurchaseOrderSupplierInvoiceReferenceUpdateInput
- PurchaseOrderSupplierUpdateInput
- PurchaseReturnApproveInput
- PurchaseReturnCreateInput
- PurchaseReturnLineItemReturningAddInput
- ReasonCodeCreateInput
- ReceiveItemAddInput
- ReceiveItemCreateInput
- ReceiveItemReconcileInput
- ReceiveItemUnreconcileInput
- RelationAddInput
- RelationRemoveInput
- RelationshipGroupsInput
- RetailExpressConnectAccountInput
- RetailExpressCustomerListInput
- RetailExpressSendOrderInput
- ReturnAcceptInput
- ReturnCancelInput
- ReturnCreateInput
- ReturnLineItemCreateInput
- ReturnLineItemInput
- ReturnTrackingUpdateInput
- SearchFilterEqualInput
- SearchFilterFullTextInput
- SearchFilterInInput
- SearchFilterInput
- SearchFilterRangeInput
- SearchFilterRegexInput
- SearchFilterValueFromInput
- SearchInput
- SearchSortInput
- SendleCredentialsInput
- ShipmentAddressInput
- ShipmentConfirmInput
- ShipmentCreateInput
- ShipmentInput
- ShipmentLabelInput
- ShipmentPackageAddInput
- ShipmentPackageContentInput
- ShipmentPackageInput
- ShipmentPackageRemoveInput
- ShipmentPackageUpdateInput
- ShipmentServiceUpdateInput
- ShipmentTrackInput
- ShipmentUpdateInput
- ShippitConnectInput
- SparesboxAllocationEngineVersionSetInput
- StarshipitConnectInput
- SupplierCreateInput
- SupplierProductUpdateInput
- SupplierRemoveRestrictionsInput
- SupplierSetBillingAddressInput
- SupplierSetCurrencyInput
- SupplierSetNameInput
- SupplierSetRestrictionsInput
- SupplierSetTaxNumberInput
- TagAddInput
- TagRemoveInput
- ToggleInput
- TransferCreateInput
- UserSetDisplayNameInput
- WebhookSubscribeInput
- WebhookUnsubscribeInput
- XIDPartsInput
- Enums
- AttachmentType
- AuTaxApplied
- BarcodeSymbology
- CollectionState
- CurrencyCode
- DeviceWeighStatus
- DocumentFormat
- EventSubscribable
- ExportFormat
- FulfilmentMethod
- ImageTransformFit
- InsightEmbedType
- IntegrationAudience
- InventoryMovementReceivedSortField
- InventoryMovementType
- InventoryPutAwayCollationMethod
- JobOperation
- JobOperationCondition
- JobOperationContext
- JobProductStatus
- JobStatus
- LogSeverity
- OrderingDirection
- PickMethod
- PrintFormat
- PurchaseOrderStatus
- SearchMethod
- SearchableType
- ServiceCategory
- ShipmentStatus
- ShipmentTrackingCheckpointStatus
- UnitDistance
- UnitMass
- WebhookEvent
- Scalars
- BarcodeInput
- Boolean
- CountryCode
- CustomAttributeInputId
- Date
- DateTime
- Decimal
- Duration
- Float
- GeoPoint
- HexColorCode
- HsCode
- ID
- IDFromClient
- Int
- IntegrationCreateInputId
- LocationCreateInputName
- MoneyInput
- NonNegativeInt
- NoteCreateInputContent
- NoteCreateInputTopic
- NoteInputContent
- NoteInputTopic
- ObjectID
- PositiveInt
- ProductAttributeInputId
- ProductCreateInputBarcode
- ProductDangerousGoodsInputUNNumber
- ProductName
- SKU
- ShipmentInputReference
- ShipmentRecipientInstructions
- ShipmentSenderInstructions
- String
- Tag
- TrackingNumber
- URL
- Weight
- XIDInput
- XIDPartsInputKey
- XIDPartsInputNamespace
- XIDPartsInputValue
- Interfaces
- IAction
- IAllocatableLineItem
- IAuthor
- ICapability
- ICapabilitySubject
- IContact
- ICustomAttribute
- IDoNotTrack
- IDocumentationSubject
- IDocumentationSupported
- IEvent
- IExternallyIdentifiable
- IFulfilment
- IGeoLocatable
- IIntegrationConnection
- IInventoryAssignTarget
- IInventoryMovementFrom
- IInventoryMovementTo
- IJob
- IJobConfiguredProductItem
- ILineItem
- IMutationResult
- INotesSubject
- IObject
- IObjectWithCustomAttributes
- IOrder
- IOrderSource
- IRelatable
- IReturn
- IService
- ITaggable
- IToggleable
- Scannable
- Searchable
- Unions
- AllocationSource
- AttachmentUploadTokenResult
- AuthKeyLoginResult
- AuthSwitchAccountResult
- DocumentationPrintResult
- DocumentationResult
- ExportResult
- InventoryAllocateResult
- InventoryAllocationsClearResult
- InventoryMoveResult
- JobConfiguredLocationPutAwayResult
- JobPackSetAllocationShippingAddressResult
- JobPackSkuResults
- JobPickSkuResult
- LineItemSource
- LocationRelatedListResult
- LocationSetParentResult
- OrderAllocationSetLocationResult
- OrderAllocationSetShippingAddressResult
- OrderCancelResult
- PrintResult
- ReceiveItemReceiveTarget
- ReceiveItemReconcileTarget
- ReceiveItemTarget
- RelationshipEdge
- ReturnSource
Query
Query for information. These will not change any data. See https://graphql.org/learn/queries/
Field | Argument | Type | Description |
---|---|---|---|
today | Date! | Tells you the date according to the server. Useful for debugging. | |
now | DateTime! | Tells you the time according to the server. Useful for debugging. | |
idEncode | ID! | Encode an ID. Generally used for composite IDs. | |
parts | [String!]! | ||
idDecode ⚠️ | [String!] | Decode an ID. Note: Not all IDs can decode. ⚠️ DEPRECATED
| |
id | ID! | ||
object | IObject | 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. 🤖: If you need to keep the object's state up to date, see | |
input | ObjectInput! | ||
tagList | TagListResult! | ||
allocation | Allocation | Get a specific | |
allocationId | ID! | The | |
backorder | Backorder | Get a specific | |
backorderId | ID! | The | |
brand | Brand | Get a specific | |
brandId | ID! | The | |
channel | Channel | Get a specific | |
channelId | ID! | The | |
customer | Customer | Get a specific | |
customerId | ID! | The | |
lineItem | LineItem | Get a specific | |
lineItemId | ID! | The | |
location | Location | Get a specific | |
locationId | ID! | The | |
note | Note | Get a specific | |
noteId | ID! | The | |
order | Order | Get a specific | |
orderId | ID! | The | |
product | Product | Get a specific | |
productId | ID! | The | |
purchaseOrder | PurchaseOrder | Get a specific | |
purchaseOrderId | ID! | The | |
purchaseOrderImport | PurchaseOrderImport | Get a specific | |
purchaseOrderImportId | ID! | The | |
purchaseReturn | PurchaseReturn | Get a specific | |
purchaseReturnId | ID! | The | |
reasonCode | ReasonCode | Get a specific | |
reasonCodeId | ID! | The | |
receiveItem | ReceiveItem | Get a specific | |
receiveItemId | ID! | The | |
return | Return | Get a specific | |
returnId | ID! | The | |
supplier | Supplier | Get a specific | |
supplierId | ID! | The | |
transfer | Transfer | Get a specific | |
transferId | ID! | The | |
currency | Currency! | Get currency information. | |
code | CurrencyCode! | ||
currencies | [Currency!]! | Get enabled currencies. | |
moneyDebug | Money | Debug & understand money behavior using this. | |
money | MoneyInput! | ||
geoCode | GeoCodeResult | Forward lookup to a lat/lng. Currently works on postal codes and localities in Australia. | |
input | GeoCodeInput! | ||
attachment ⚠️ | Attachment | Retrieve an attachment. ⚠️ DEPRECATED
| |
attachmentId | ID! | ||
attachmentList ⚠️ | AttachmentListResult | Retrieve attachments of a specific type for an object. ⚠️ DEPRECATED
| |
input | AttachmentListInput! | ||
attachmentListV2 | AttachmentListV2Result | List attachments of a specific object. | |
input | AttachmentListV2Input! | ||
attachmentUploadToken | AttachmentUploadTokenResult | Retrieve a URL to upload If NULL returns, you may not upload/attach against the given object. See | |
input | AttachmentUploadTokenInput! | ||
documentationSupported | DocumentationSupportedResult! | Discover what documentation is available for a type, or specified object. | |
input | DocumentationSupportedInput! | ||
whoami | WhoAmIResult | 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. | |
authKey | AuthKey | Retrieve an authkey | |
keyId | ID! | ||
authKeyList | AuthKeyListResult! | ||
input | AuthListKeysInput | ||
authKeyLogin | AuthKeyLoginResult! | Login with an auth key (name tag) and pin | |
input | AuthKeyLoginInput! | ||
authSwitchAccount | AuthSwitchAccountResult! | Switch to another account you have access to | |
input | AuthSwitchAccountInput! | ||
defaults | Defaults! | Useful user defaults | |
accountSelected | Account | Retrieve the current account, if one has been selected | |
accountList | AccountListResult! | Lists the accounts you currently have access to. Use it to know which accounts you can switch between | |
accountUser ⚠️ | AccountUser | Retrieve the current account user, if you have selected your account, this is your user with in that account ⚠️ DEPRECATED
| |
userId | ID! | ||
accountUserList ⚠️ | AccountUserListResult! | List your account's users ⚠️ DEPRECATED
| |
input | ListInput | ||
user ⚠️ | User | If authenticated, returns the current user/you. ⚠️ DEPRECATED
| |
addressValidate | AddressValidationResult! | ||
input | AddressValidationInput! | ||
addressCountryList | [Country!]! | List all the known countries. | |
capabilityList | CapabilityListResult! | Explore the known capabilities. | |
productBySku | Product | Retrieve a product by SKU. | |
sku | String! | ||
locationList ⚠️ | LocationListResult! | List your account's locations ⚠️ DEPRECATED
| |
input | ListInput | ||
locationListChildren | LocationRelatedListResult! | List a location's children | |
locationId | ID! | ||
locationListDescendants | LocationRelatedListResult! | List a location's descendants | |
locationId | ID! | ||
locationListOrphans | LocationListResult! | List locations with no parents | |
input | ListInput | ||
serviceList | ServiceListResult! | List the services available to you. | |
integrationList ⚠️ | IntegrationListResult! | List integrations available to your selected account. ⚠️ DEPRECATED
| |
integrationConnectionList | IntegrationConnectionListResult! | List connections to integrations already made. | |
input | ListInput | ||
orderList ⚠️ | OrderListResult! | List your account's orders ⚠️ DEPRECATED
| |
input | ListInput | ||
orderListAtLocation ⚠️ | OrderListResult! | List your account's' orders allocated to a location ⚠️ DEPRECATED
| |
input | OrderListAtLocationInput! | ||
orderStatusInfo | OrderStatusInfoResult | Order status information. Provides information on known Order statuses. | |
inventoryMovementsReceivedList | InventoryMovementReceivedListResult! | Retrieve inventory movements received | |
input | InventoryMovementReceivedListInput | ||
inventory | Inventory | Retrieve an inventory | |
inventoryId | ID! | ||
inventoryBySku | [Inventory!]! | Retrieve a SKUs inventory By default it will exclude the inventory of location's children | |
sku | String! | ||
children | Boolean | If account is enabled and children is | |
filter | InventoryFilterInput | 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 | |
inventoryByProduct | InventoryListResult! | Retrieve a product's inventory By default it will exclude the inventory of location's children | |
input | InventoryByProductInput! | ||
inventoryListAtLocation | InventoryListResult! | List inventory at a location! Provide the location Id, include the inventory of location's children | |
input | InventoryListAtLocationInput! | ||
inventorySummarize | InventorySummarizeResult! | 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. | |
input | InventorySummarizeInput! | ||
inventorySummarizeByProduct | InventorySummarizeResult! | Similar to | |
input | InventorySummarizeByProductInput! | ||
inventoryByAllocation | [InventoryByAllocation!]! | Retrieve an allocation's inventory By default it will not include the inventory of location's children
If children is | |
allocationId | String! | ||
children | Boolean | ||
filter | InventoryByAllocationFilterInput | ||
inventoryByPurchaseOrder | [InventoryByPurchaseOrder!] | List quantity inbound and received for a purchase order Only parent locations included in the list, quantity includes location's children | |
input | InventoryByPurchaseOrderInput! | ||
inventoryListAssignedAtLocation | InventoryListAssignedAtLocationResult! | List of assigned inventory at a Location | |
input | InventoryListAssignedAtLocationInput! | ||
inventoryAssignable | InventoryAssignableResult! | List of inventory items that can be used for assignment This includes unassigned and items currently assigned | |
input | InventoryAssignableInput! | ||
inventoryReservedPick | InventoryReservedPickResult! | Start, or continue to retrieve the next suggested pick location for a wave/reserved pick. | |
input | InventoryReservedPickInput! | ||
inventoryReservedPickItems | InventoryReservedPickItemsResult! | Retrieve a list of items to pick | |
input | InventoryReservedPickItemsInput! | ||
inventoryReservedItemsList | InventoryReservedItemsListResult! | Retrieve a list of items reserved for a specific wave | |
input | InventoryReservedItemsListInput! | ||
inventoryPutAwayItems | InventoryPutAwayItemsResult! | Retrieve a list of items to put away from a location | |
input | InventoryPutAwayItemsInput! | ||
inventoryPutAwayItemsByLocation | InventoryPutAwayItemsByLocationResult! | Retrieve a list of items to put away from a location, with more freedom on which item can be selected first. | |
input | InventoryPutAwayItemsInput! | ||
inventoryUnassignedPick | InventoryUnassignedPickResult! | Start, or continue to retrieve the next suggested pick location for a wave pick of unassigned items. | |
input | InventoryUnassignedPickInput! | ||
inventoryUnassignedPickItems | InventoryUnassignedPickItemsResult! | Retrieve a list of unassigned items to pick | |
input | InventoryUnassignedPickItemsInput! | ||
inventoryReplenishablePickItems | InventoryReplenishablePickItemsResult! | Retrieve a list of items for replenishment | |
input | InventoryReplenishablePickItemsInput! | ||
printer | JunglePrinter | Retrieve a printer | |
printerId | ID! | ||
printerList | PrinterListResult! | List your account's printers | |
jobListForOrder ⚠️ | JobListResult! | List jobs having the given order ID ⚠️ DEPRECATED
| |
input | JobListForOrderInput! | ||
orderListFromJob | OrderListFromJobResult! | List all orders that is part of a job | |
input | OrderListFromJobInput! | ||
jobConfigurationList | JobConfigurationList! | Retrieve list of available job configurations | |
input | JobConfigurationListInput! | ||
jobConfiguredLocationPutAway | JobConfiguredLocationPutAwayResult | Retrieve a (or a list of) recommended location to put away for a given item. | |
input | JobConfiguredLocationPutAwayInput! | ||
jobConfiguredPickLocationNext | InventoryReservedPickResult! | Retrieve next suggested pick location for a wave/reserved pick. | |
input | JobConfiguredPickLocationNextInput! | ||
jobConfiguredPickPreview | JobConfiguredPickPreviewResult! | Preview what would be reserved for a wave/reserved pick. | |
input | JobConfiguredPickPreviewInput! | ||
scan | Scannable | A quick way to look up something via a barcode. All kinds of things could return. Beware. | |
barcode | String! | ||
purchaseOrderInboundItemBySku | PurchaseOrderInboundItemBySkuResult! | List of purchase orders with incoming quantity for an SKU | |
input | PurchaseOrderInboundItemBySkuInput! | ||
search | SearchResult! | 🔍 Search on specific object types in Jungle. You must specify what types you are searching for. | |
input | SearchInput! | ||
collection ⚠️ | FulfilmentCollect | ⚠️ DEPRECATED
| |
input | CollectionGetInput! | ||
collectionList ⚠️ | CollectionListResult! | ⚠️ DEPRECATED
| |
input | ListInput | ||
collectionListAtLocation | CollectionListResult! | ||
input | CollectionListAtLocationInput! | ||
shipmentServices ⚠️ | ShipmentServicesResult! | ⚠️ DEPRECATED
| |
retailExpressCustomerList | RetailExpressCustomerListResult | List all customers from your Retail Express account | |
input | RetailExpressCustomerListInput! | ||
insightEmbeddable | InsightEmbeddableDetails | Get insight which can be embedded. | |
input | InsightEmbeddableInput! | ||
insightEmbeddableList | InsightEmbeddableResults! | List insights which can be embedded. | |
input | InsightEmbeddableListInput! |
Mutation
Mutations/commands that will change data. See https://graphql.org/learn/queries/#mutations
Field | Argument | Type | Description |
---|---|---|---|
tagAdd | IMutationResult! | Add tags to an object. | |
input | TagAddInput! | ||
tagRemove | IMutationResult! | Remove tags from an object. | |
input | TagRemoveInput! | ||
attributesSet | IMutationResult! | Set custom attributes on the target object. | |
input | AttributesSetInput! | ||
relationAdd | IMutationResult! | Add a relationship to an object. This can be blocked for various reasons (reserved names, relation limit etc), however most relationships are allowed. | |
input | RelationAddInput! | ||
relationRemove | IMutationResult! | 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. | |
input | RelationRemoveInput! | ||
toggleDisable | IMutationResult! | Disables an object. | |
input | ToggleInput! | ||
toggleEnable | IMutationResult! | Enables an object. | |
input | ToggleInput! | ||
ping | IMutationResult! | Ping the platform. This is useful for devices, integrations, connections, users etc. | |
input | PingInput | ||
xidAssign | IMutationResult! | Assign (either creates or alters) an external ID/alias against a Jungle object. 🤖: To remove an XID, see the | |
input | ExternalIdAssignInput! | ||
xidUnassign | IMutationResult! | Unassign an external ID/alias. Removes it from Jungle. 🤖: To add or restore an XID, see the | |
input | ExternalIdUnassignInput! | ||
geoPointSet | IMutationResult! | Set geo point (coordinates) on the target object. | |
input | GeoPointSetInput! | ||
attachmentUploadFromUrl | IMutationResult! | Given a URL, Jungle will download and save it as an attachment. Currently only | |
input | AttachmentUploadFromUrlInput! | ||
attachmentPrint | IMutationResult! | Attempt to send an attachment to a printer for printing. Note that the printer may not be able to print the specified attachment. | |
input | AttachmentPrintInput! | ||
export | ExportResult! | 🔍 Export data of a specific data type in Jungle. | |
input | ExportInput! | ||
barcodeAdd | IMutationResult! | ||
input | BarcodeAddInput! | ||
barcodeRemove | IMutationResult! | ||
input | BarcodeRemoveInput! | ||
barcodePrint ⚠️ | IMutationResult! | ⚠️ DEPRECATED
| |
input | BarcodePrintInput! | ||
documentationPrint | DocumentationPrintResult! | Attempt to send a document to a printer for printing. Note that the printer may not be able to print the specified documentation. | |
input | DocumentationPrintInput! | ||
noteCreate | IMutationResult! | 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 | |
input | NoteCreateInput! | Mutation input for | |
authKeyCreate ⚠️ | Boolean | ⚠️ DEPRECATED
| |
apiKeyCreate | String | ||
input | ApiKeyCreateInput! | ||
identityCreate | Identity | Create a new identity with web access | |
input | IdentityCreateInput! | ||
identityUpdate | Identity | Update an existing identity | |
input | IdentityUpdateInput! | ||
accountUserUpdate | AccountUserCreateResult | Upgrade an account user to a full user | |
input | AccountUserUpdateInput! | ||
accountUserCreate | AccountUserCreateResult | Create an account user | |
input | AccountUserCreateInput! | ||
accountUserDelete | Boolean | Remove user access to an account without destroying their identity | |
input | AccountUserDeleteInput! | ||
userSetDisplayName | Boolean | Update your display name. | |
input | UserSetDisplayNameInput! | ||
accountUserUpgrade | IMutationResult! | Upgrade account user to web user. | |
input | AccountUserUpgradeInput! | ||
accountUserInvite | IMutationResult! | Invite an existing user into your account. | |
input | AccountUserInviteInput! | ||
reasonCodeCreate | IMutationResult! | Create a new reason code. | |
input | ReasonCodeCreateInput! | ||
capabilitiesSet | IMutationResult! | Set capabilities on an object. | |
input | CapabilitiesSetInput! | ||
capabilityConstraintsSet | IMutationResult! | Set constraints on the capability in relation to the target object. | |
input | CapabilityConstraintsSetInput! | ||
productCreate | IMutationResult! | Create a new product. It can start with a just a barcode scan. | |
input | ProductCreateInput! | ||
productSetName | IMutationResult! | Update a products name and description. | |
input | ProductSetNameInput! | ||
productSetSku | IMutationResult! | Update a products SKU. Set sku NULL to remove. | |
input | ProductSetSkuInput! | ||
productSetDimensions | IMutationResult! | Update a product's dimensions. | |
input | ProductSetDimensionsInput! | ||
productSetWeight | IMutationResult! | Update a product's weight. | |
input | ProductSetWeightInput! | ||
productSetDangerousGoods | IMutationResult! | Update a product's dangerous goods details. | |
input | ProductSetDangerousGoodsInput! | ||
productSetHsCode | IMutationResult! | Set the Harmonised System Code of a product | |
input | ProductSetHsCodeInput! | ||
productUpdate | IMutationResult! | 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. | |
input | ProductUpdateInput! | ||
locationCreate | LocationCreateResult | Create a new location under your account. | |
input | LocationCreateInput! | ||
locationChangeAddress | Boolean | Changes the postal address of the location, if it exists | |
input | LocationChangeAddressInput! | ||
locationSetParent | LocationSetParentResult | ||
input | LocationSetParentInput! | ||
locationSetName | Boolean | ||
input | LocationSetNameInput! | ||
locationSetReference | Boolean | ||
input | LocationSetReferenceInput! | ||
locationSetDefault | Boolean | Set your (the current user's) default location | |
input | LocationSetDefaultInput! | ||
locationSequence | IMutationResult! | Modify the sequence of a location. | |
input | LocationSequenceInput! | ||
channelCreate | IMutationResult! | Create a new channel. | |
input | ChannelCreateInput! | ||
channelSetName | IMutationResult! | Change the name of a channel. | |
input | ChannelSetNameInput! | ||
channelSetDescription | IMutationResult! | Change the description of a channel. | |
input | ChannelSetDescriptionInput! | ||
channelSetCode | IMutationResult! | Change the code of a channel. | |
input | ChannelSetCodeInput! | ||
integrationConnect | IMutationResult! | Connect your account to an integration. | |
input | IntegrationConnectInput! | ||
integrationCreate | IMutationResult! | 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. | |
input | IntegrationCreateInput! | ||
lineItemCancel | IMutationResult! | Cancel a specific amount of the provided line item. | |
input | LineItemCancelInput! | ||
lineItemQuantityIncrement | IMutationResult! | Increment quantity of the provided line item. Only Order Line Item is supported at the moment. | |
input | LineItemQuantityIncrementInput! | ||
allocationCreate | IMutationResult! | Use this to create an allocation, which can be independent from any sales order or purchase order. | |
input | AllocationCreateInput! | ||
allocationLineItemAssociate | IMutationResult! | Associate an order line item with an allocation. | |
input | AllocationLineItemAssociateInput! | ||
allocationLineItemMove | IMutationResult! | Move items from an allocation or unallocated line item to another allocation, if possible. | |
input | AllocationLineItemMoveInput! | ||
allocationFulfilmentAllow | IMutationResult! | Allow fulfilment for the allocation. | |
input | AllocationFulfilmentAllowInput! | ||
allocationFulfilmentHold | IMutationResult! | Hold fulfilment for the allocation. | |
input | AllocationFulfilmentHoldInput! | ||
allocationMethodSet | IMutationResult! | Change the fulfilment method of an allocation | |
input | AllocationMethodSetInput! | ||
allocationSplitUnassigned | IMutationResult! | Split out unassigned items from an allocation into a new allocation. This is useful to have the target allocation ready to be packed. | |
input | AllocationSplitUnassignedInput! | ||
backorderCreate | IMutationResult! | Create a backorder against an allocation line. | |
input | BackorderCreateInput! | Input for | |
backorderAssociatePurchaseOrderLineItem | IMutationResult! | Associate a purchase order line with a backorder. | |
input | BackorderAssociatePurchaseOrderLineItemInput! | ||
backorderDissociatePurchaseOrderLineItem | IMutationResult! | Dissociate a backorder from it's linked purchase order line item. | |
input | BackorderDissociatePurchaseOrderLineItemInput! | ||
backorderCancel | IMutationResult! | Cancel a backorder. Must not have any Purchase Order lines associated to it. | |
input | BackorderCancelInput! | ||
backorderQuantityUpdate | IMutationResult! | Update quantity for a backorder. | |
input | BackorderQuantityUpdateInput! | ||
orderConsumeWithAllocations | OrderConsumedResult! | 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. | |
input | OrderConsumeAllocatedInput! | ||
orderLineItemAdd | IMutationResult! | Add a line item to an order. The added line item will be in a new allocation, with the most recently changed shipping address. | |
input | OrderLineItemAddInput! | ||
orderSetFulfilmentAllowed | IMutationResult! | Set an order's fulfilment allowed. | |
input | OrderSetFulfilmentAllowedInput! | ||
orderSetStatus | OrderSetStatusResult! | Set an order's status | |
input | OrderSetStatusInput! | ||
orderCancel | OrderCancelResult! | Cancels an order. You can cancel an order in the following situations:
The most common reasons for canceling an order include the following:
The cancellation will change the status of the order, record a note, and an event of who cancelled and why. | |
input | OrderCancelInput! | ||
orderAllocationCreate | IMutationResult! | Creates a new allocation against an Order | |
input | OrderAllocationCreateInput! | ||
orderAllocationLineItemAssociate ⚠️ | IMutationResult! | Associate an order line item with an allocation. ⚠️ DEPRECATED
| |
input | OrderAllocationLineItemAssociateInput! | ||
orderAllocationLineItemMove ⚠️ | IMutationResult! | Move items from an allocation to another allocation, if possible. ⚠️ DEPRECATED
| |
input | OrderAllocationLineItemMoveInput! | ||
orderAllocationSetShippingAddress | OrderAllocationSetShippingAddressResult! | Change the shipping address of an allocation | |
input | OrderAllocationSetShippingAddressInput! | ||
orderAllocationSetLocation | OrderAllocationSetLocationResult! | Set/override the location of an allocation. Be mindful, this can only be done if the allocation does not have fulfilments. | |
input | OrderAllocationSetLocationInput! | ||
orderAllocationSetMethod ⚠️ | IMutationResult! | Change the fulfilment method of an allocation ⚠️ DEPRECATED
| |
input | OrderAllocationSetMethodInput! | ||
orderRoute | IMutationResult! | Trigger routing logic for an order (if configured). | |
input | OrderRouteInput! | ||
orderCustomerSet | IMutationResult! | Set customer ID on an order. | |
input | OrderCustomerSetInput! | ||
orderLineItemCancel | IMutationResult! | 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 | |
input | OrderLineItemCancelInput! | ||
brandCreate | IMutationResult! | Create a new brand. | |
input | BrandCreateInput! | ||
brandSetName | IMutationResult! | Update brand name. | |
input | BrandSetNameInput! | ||
inventorySetByProduct | IMutationResult! | Set the inventory of a product at a location. This will assign the on hand quantity to the quantity provided. | |
input | InventorySetByProductInput! | ||
inventorySetBySku | InventoryCreateResult! | Set the inventory of a SKU at a location. This will assign the on hand quantity to the quantity provided. | |
input | InventorySetBySkuInput! | ||
inventorySetAtLocation | IMutationResult! | Set the inventory at a location. | |
input | InventorySetAtLocationInput! | ||
inventoryAllocate | InventoryAllocateResult! | Allocate inventory at a location. This is useful for holding inventory from ATP, but hasn't yet left your business. | |
input | InventoryAllocateInput! | ||
inventoryAllocationsClear | InventoryAllocationsClearResult! | 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. | |
input | InventoryAllocationsClearInput! | ||
inventoryAssign | IMutationResult! | 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. | |
input | InventoryAssignInput! | ||
inventoryMove | InventoryMoveResult! | Move inventory between locations. This will decrement from the source (from), and increment at the destination (to). | |
input | InventoryMoveInput! | ||
inventoryMoves | IMutationResult! | Move multiple inventory between locations. This will decrement from the source (from), and increment at the destination (to). | |
input | InventoryMovesInput! | ||
inventoryUpdateBySku | IMutationResult! | Update the inventory of a SKU at a location. This will increment/decrement the on hand quantity using the quantity provided. | |
input | InventoryUpdateBySkuInput! | ||
inventoryMovementCreate | IMutationResult! | Create an inventory movement request of a SKU | |
input | InventoryMovementCreateInput! | ||
inventoryAssignmentAdjust | IMutationResult! | 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. | |
input | InventoryAssignmentAdjustInput! | ||
inventoryReservedSequenceAdjust | IMutationResult! | 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. | |
input | InventoryReservedSequenceAdjustInput! | ||
inventoryPreferenceUpdate | IMutationResult! | Update inventory preference. | |
input | InventoryPreferenceUpdateInput! | ||
printRaw | PrintResult! | Send raw data to a printer. Be careful. | |
input | PrintRawInput! | ||
printerSetDefault | Boolean | Sets your default printer, null to remove. | |
input | PrinterSetDefaultInput! | ||
fulfilmentShipmentAdd ⚠️ | IMutationResult! | Create fulfilment from shipment Adds relation to the allocation and create fulfilment from confirmed shipment ⚠️ DEPRECATED
| |
input | FulfilmentShipmentAddInput! | ||
deviceReportWeigh | IMutationResult! | Device report weigh.
Used by scales & balances (weighing devices) to report recorded weights.
Using this on a device marks that device as having the | |
input | DeviceReportWeighInput! | ||
jobPickCreate | JobPickCreateResult! | Create a picking job | |
input | JobPickCreateInput! | ||
jobPackCreate | JobPackCreateResult! | Create a packing job | |
input | JobPackCreateInput! | ||
jobConfiguredCreate | IMutationResult! | Create a configured job | |
input | JobConfiguredCreateInput! | ||
jobConfiguredPickCreate | IMutationResult! | Create a configured job for picking | |
input | JobConfiguredPickCreateInput! | ||
jobPackSetAllocationShippingAddress | JobPackSetAllocationShippingAddressResult! | Change the shipping address on the packing job. | |
input | JobPackSetAllocationShippingAddressInput! | ||
jobPickLocationAssign | JobPickLocationAssignResult! | Assign a pick location to a picking job (applicable to wave) | |
input | JobPickLocationAssignInput! | ||
jobPickSku | JobPickSkuResult! | Add picked SKU to a pick job | |
input | JobPickSkuInput! | ||
jobUnpickSku | JobPickSkuResult! | Unpick a SKU in a pick job | |
input | JobPickSkuInput! | ||
jobPackSkuToPackage | JobPackSkuResults! | Add items to a package in a pack job. Support multiple packages. | |
input | JobPackSkuToPackageInput! | ||
jobPackAssignedAtLocation | IMutationResult! | Pack assigned inventory at a location. Useful there are multiple items already collated into ready-to-pack containers. | |
input | JobPackAssignedAtLocationInput! | ||
jobUnpackSkuFromPackage | JobPackSkuResults! | Remove items from a package in a pack job. Support multiple packages. | |
input | JobPackSkuToPackageInput! | ||
jobPackAllocationMarkFulfilled | JobPackAllocationMarkFulfilledResult! | Mark an allocation in a pack job as fulfilled | |
input | JobPackAllocationMarkFulfilledInput! | ||
jobChangeStatus | JobChangeStatusResult | ||
input | JobChangeStatusInput! | ||
jobSetPackageInfo | IMutationResult! | ||
input | JobSetPackageInfoInput! | ||
jobConfiguredComplete | IMutationResult! | Completes a configured job | |
input | JobConfiguredCompleteInput! | ||
jobConfiguredAddProduct | IMutationResult! | Add product by sku to a configured job | |
input | JobConfiguredAddProductInput! | ||
jobConfiguredRemoveProductItem | IMutationResult! | Remove a product item by sku from a configured job | |
input | JobConfiguredRemoveProductItemInput! | ||
jobConfiguredProductReceived | IMutationResult! | Received product to a configured job | |
input | JobConfiguredProductReceivedInput! | ||
jobConfiguredProductIncrementInventory | IMutationResult | Increment inventory using available product | |
input | JobConfiguredProductIncrementInventoryInput! | ||
jobConfiguredProductReasonCodeSet | IMutationResult | Set a reason code for the item | |
input | JobConfiguredProductReasonCodeSetInput! | ||
jobConfiguredProductAttachmentUploadTokenCreate | JobConfiguredProductAttachmentUploadTokenCreateResult | Upload attachment for the item (ie: Supporting documents, photo evidence, etc). | |
input | JobConfiguredProductAttachmentUploadTokenCreateInput! | ||
jobConfiguredProductUpdateQuantity | IMutationResult | Update quantity to a job product | |
input | JobConfiguredProductUpdateQuantityInput! | ||
jobConfiguredProductUpdateAllocation | IMutationResult | Assign available product to an allocation | |
input | JobConfiguredProductUpdateAllocationInput! | ||
jobConfiguredProductAllocationAssign | IMutationResult | Retrieve an allocation to assign for a given item. | |
input | JobConfiguredProductAllocationAssignInput! | ||
jobConfiguredProductPick | IMutationResult | Pick an item | |
input | JobConfiguredProductPickInput! | ||
jobConfiguredProductPutaway | IMutationResult | Putaway an item | |
input | JobConfiguredProductPutawayInput! | ||
jobConfiguredProductInventoryMove | IMutationResult | Move inventory between location | |
input | JobConfiguredProductInventoryMoveInput! | ||
supplierCreate | IMutationResult! | Create a new supplier. | |
input | SupplierCreateInput! | ||
supplierSetName | IMutationResult! | Set name on a supplier | |
input | SupplierSetNameInput! | ||
supplierSetTaxNumber | IMutationResult! | Set tax number on a supplier | |
input | SupplierSetTaxNumberInput! | ||
supplierSetCurrency | IMutationResult! | Set currency on a supplier | |
input | SupplierSetCurrencyInput! | ||
supplierSetBillingAddress | IMutationResult! | Set the billing address on a supplier | |
input | SupplierSetBillingAddressInput! | ||
supplierSetRestrictions | IMutationResult! | Set restricted locations for this supplier to operate in | |
input | SupplierSetRestrictionsInput! | ||
supplierRemoveRestrictions | IMutationResult! | Remove restricted locations for this supplier allowing it to be used anywhere | |
input | SupplierRemoveRestrictionsInput! | ||
jobConfiguredUpdateSupplier | IMutationResult! | Set a supplier to be used for the entire job | |
input | JobConfiguredUpdateSupplierInput! | ||
jobConfiguredProductUpdateSupplier | IMutationResult! | Override a supplier for a specific product in job | |
input | JobConfiguredProductUpdateSupplierInput! | ||
purchaseOrderCreate | IMutationResult! | Create a new purchase order. | |
input | PurchaseOrderCreateInput! | ||
purchaseOrderLineItemAdd | IMutationResult! | Add line item to purchase order. | |
input | PurchaseOrderLineItemAddInput! | ||
purchaseOrderLineItemUpdate | IMutationResult! | Update line item on existing purchase order. | |
input | PurchaseOrderLineItemUpdateInput! | ||
purchaseOrderLineItemRemove | IMutationResult! | Remove line item from purchase order. | |
input | PurchaseOrderLineItemRemoveInput! | ||
purchaseOrderReferenceUpdate | IMutationResult! | Update existing purchase order reference. | |
input | PurchaseOrderReferenceUpdateInput! | ||
purchaseOrderDatesUpdate | IMutationResult! | Update existing purchase order dates. | |
input | PurchaseOrderDatesUpdateInput! | ||
purchaseOrderDescriptionUpdate | IMutationResult! | Update existing purchase order description. | |
input | PurchaseOrderDescriptionUpdateInput! | ||
purchaseOrderSupplierUpdate | IMutationResult! | Update existing purchase order supplier. | |
input | PurchaseOrderSupplierUpdateInput! | ||
purchaseOrderSplitUnreceivedLineItems | IMutationResult! | Update existing purchase order supplier. | |
input | PurchaseOrderSplitUnreceivedLineItemsInput! | ||
purchaseOrderPriceUpdate | IMutationResult! | Update existing purchase order prices. | |
input | PurchaseOrderPriceUpdateInput! | ||
purchaseOrderLocationUpdate | IMutationResult! | Update existing purchase order locations. | |
input | PurchaseOrderLocationUpdateInput! | ||
purchaseOrderSetStatus | IMutationResult! | Update existing purchase order status. | |
input | PurchaseOrderSetStatusInput! | ||
purchaseOrderSupplierInvoiceReferenceUpdate | IMutationResult! | Update existing purchase order supplier invoice reference. | |
input | PurchaseOrderSupplierInvoiceReferenceUpdateInput! | ||
purchaseOrderReceiveItemAdd ⚠️ | IMutationResult! | Add receive item to purchase order. ⚠️ DEPRECATED
| |
input | PurchaseOrderReceiveItemAddInput! | ||
purchaseOrderReceiveItemUpdate ⚠️ | IMutationResult! | Update receive item on existing purchase order. ⚠️ DEPRECATED
| |
input | PurchaseOrderReceiveItemUpdateInput! | ||
purchaseOrderReceiveItemRemove ⚠️ | IMutationResult! | Remove receive item from purchase order. ⚠️ DEPRECATED
| |
input | PurchaseOrderReceiveItemRemoveInput! | ||
jobConfiguredUpdatePurchaseOrder | IMutationResult! | Set a purchase order to be used for the entire job | |
input | JobConfiguredUpdatePurchaseOrderInput! | ||
jobConfiguredProductUpdatePurchaseOrder | IMutationResult! | Override a purchase order for a specific product in job | |
input | JobConfiguredProductUpdatePurchaseOrderInput! | ||
purchaseOrderImportCreate | IMutationResult! | Import multiple purchase orders from CSV. Check on the progress of the import using the | |
input | PurchaseOrderImportCreateInput! | ||
purchaseReturnCreate | IMutationResult! | Create a new purchase return. | |
input | PurchaseReturnCreateInput! | ||
purchaseReturnLineItemReturningAdd | IMutationResult! | Add line item to purchase return. | |
input | PurchaseReturnLineItemReturningAddInput! | ||
purchaseReturnApprove | IMutationResult! | Approve a purchase return. | |
input | PurchaseReturnApproveInput! | ||
receiveItemCreate | IMutationResult! | 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. | |
input | ReceiveItemCreateInput! | ||
receiveItemReconcile | IMutationResult! | Reconcile a received item. | |
input | ReceiveItemReconcileInput! | ||
receiveItemUnreconcile | IMutationResult! | Un-reconcile a received item. | |
input | ReceiveItemUnreconcileInput! | ||
transferCreate | IMutationResult! | Transfer Create. Transfer products between two locations, as a request, and to be managed like a sales order etc. | |
input | TransferCreateInput! | ||
returnCreate | IMutationResult! | Create a new return. | |
input | ReturnCreateInput! | ||
returnAccept | IMutationResult! | Mark a return as accepted. | |
input | ReturnAcceptInput! | ||
returnCancel | IMutationResult! | Cancel a return. | |
input | ReturnCancelInput! | ||
returnTrackingUpdate | IMutationResult! | Set tracking details for a return. | |
input | ReturnTrackingUpdateInput! | ||
customerCreate | IMutationResult! | Create a new customer. | |
input | CustomerCreateInput! | ||
customerUpdate | IMutationResult! | 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. | |
input | CustomerUpdateInput! | ||
webhookSubscribe ⚠️ | Boolean | 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
| |
input | WebhookSubscribeInput! | ||
webhookUnsubscribe ⚠️ | Boolean | Removes any webhooks matching the given URL with in your account ⚠️ DEPRECATED
| |
input | WebhookUnsubscribeInput! | ||
orderAllocationSplitUnassigned ⚠️ | IMutationResult! | 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
| |
input | OrderAllocationSplitUnassignedInput! | ||
orderAllocationSplit | IMutationResult! | Split an allocation into two by breaking out quantities of its line items into a new allocation | |
input | OrderAllocationSplitInput! | ||
fulfilmentCollectCreate | FulfilmentCollectCreateResult | Creates a new fulfilment collection under an order | |
input | FulfilmentCollectCreateInput! | ||
fulfilmentCollectChangeState | FulfilmentCollectChangeStateResult | Change the state of a collection | |
input | FulfilmentCollectChangeStateInput! | ||
fulfilmentShipmentCreate ⚠️ | FulfilmentShipmentCreateResult! | Shipment creation, as part of fulfilling an order, and generally an allocation. ⚠️ DEPRECATED
| |
input | FulfilmentShipmentCreateInput! | ||
shipmentCreate | IMutationResult! | 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 | |
input | ShipmentCreateInput! | ||
shipmentUpdate | IMutationResult! | Updates a Draft shipment. 🤖: Use the | |
input | ShipmentUpdateInput! | ||
shipmentServiceUpdate | IMutationResult! | Updates the service on a Draft shipment. This will reject on shipments not in Draft. | |
input | ShipmentServiceUpdateInput! | ||
shipmentPackageAdd | IMutationResult! | Shipment package add. Adds a package to Draft shipment. | |
input | ShipmentPackageAddInput! | ||
shipmentPackageRemove | IMutationResult! | Shipment package remove. Removes a package from Draft shipment. | |
input | ShipmentPackageRemoveInput! | ||
shipmentPackageUpdate | IMutationResult! | Shipment package update. This updates the individual shipment package while shipment is Draft. 🤖: Use | |
input | ShipmentPackageUpdateInput! | ||
shipmentConfirm | IMutationResult! | 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. | |
input | ShipmentConfirmInput! | ||
shipmentLabel | IMutationResult! | Shipment label. Generate shipment label for confirmed shipment | |
input | ShipmentLabelInput! | ||
shipmentTrack | IMutationResult! | Shipment tracking. Start tracking a confirmed shipment. This mutation must be called before shipment tracking details can be retrieved. | |
input | ShipmentTrackInput! | ||
orderStatusRefresh ⚠️ | IMutationResult! | Refresh status of a single order ⚠️ DEPRECATED
| |
input | OrderStatusRefreshInput! | ||
australiaPostAccountAdd | IMutationResult! | Connect your Australia Post account | |
input | AustraliaPostCredentialsInput! | ||
retailExpressConnectAccount | IMutationResult! | Connects a RetailExpress account to your account | |
input | RetailExpressConnectAccountInput! | ||
retailExpressSendOrder | Boolean | Send an order to the connected Retail Express account | |
input | RetailExpressSendOrderInput! | ||
amxAllocationConnectEngine | IMutationResult! | Connects a AmxAllocation account to your account | |
input | AmxAllocationConnectEngineInput! | ||
mcLeodConnectAccount | IMutationResult! | Connects a McLeod account to your account | |
input | McLeodConnectAccountInput! | ||
mcLeodSendOrder | Boolean | Sends an order to McLeod, through a nominated connection | |
input | McLeodSendOrderInput! | ||
sendleConnect | IMutationResult! | Connect your Sendle account! This will fail if the credentials are invalid, or the sendle account is not set up. | |
input | SendleCredentialsInput! | ||
shippitConnect | IMutationResult! | Connect your Shippit account! Will reject if the credentials are invalid, or the account is not set up. | |
input | ShippitConnectInput! | ||
starshipitConnect | IMutationResult! | Connect your Starshipit account! Will reject if the credentials are invalid, or the account is not set up. | |
input | StarshipitConnectInput! | ||
sparesboxAllocationEngineVersionSet | IMutationResult! | Set the version of the Sparesbox allocation engine to use | |
input | SparesboxAllocationEngineVersionSetInput! | ||
supplierProductUpdate | IMutationResult! | 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. | |
input | SupplierProductUpdateInput! |
Subscription
Subscriptions, real-time object changes, notifications and events. The API will send data to the client.
Field | Argument | Type | Description |
---|---|---|---|
now | DateTime | Broadcasts the server time every ~sec. Useful to test your connection. | |
object | IObject | 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. | |
input | ObjectSubscriptionInput! | ||
events | IEvent | Triggered when the matching event occurs. | |
input | EventsSubscriptionInput! |
Objects
Account
An account, owns and holds authorized users, locations, orders, inventory etc
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | The accounts id | |
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
slug | String! | Used for URLs and other publicly shown unique identifiers of an account. The value is not guaranteed to stay the same over time. | |
name | String! | The name of the account. | |
createdAt | DateTime! | When the account was created. | |
configuration | Configuration | Configuration for this account. | |
gs1Prefix | String | 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 | |
attributes | [ICustomAttribute!]! | Custom attributes on the account.
🤖: Modify with | |
input | ObjectAttributesInput | ||
attributeValue | String | 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: | |
input | ObjectAttributeInput! |
AccountListResult
Result for accountList()
query.
Field | Argument | Type | Description |
---|---|---|---|
results | [AccountListResultEdge!]! |
AccountListResultEdge
Field | Argument | Type | Description |
---|---|---|---|
account | Account! |
AccountUser
When a user has access to an account they are given an account user record.
This is user relevant information in scope of the account.
A user will have one of these for each account they have access too.
Field | Argument | Type | Description |
---|---|---|---|
authKey | AuthKey | ||
id | ID! | ||
aid | ID! | ||
user | User | ||
roles | [String] | ||
defaults | Defaults | ||
createdAt | Date! | ||
createdBy | String! |
AccountUserCreateResult
Field | Argument | Type | Description |
---|---|---|---|
accountUser | AccountUser! |
AccountUserListResult
Field | Argument | Type | Description |
---|---|---|---|
results | [AccountUserListResultEdge!]! | ||
pageInfo | PageInfo! | Information on user list results |
AccountUserListResultEdge
Field | Argument | Type | Description |
---|---|---|---|
accountUser | AccountUser! |
Action
A simple action that can be performed by a user/client.
Field | Argument | Type | Description |
---|---|---|---|
name | String! | The action's human readable name/title. | |
code | ID! | A unique code for the action. Used to identify the action in logic/software. | |
priority | Int! | The higher the priority, the more important the action is, so show it sooner. | |
enabled | Boolean! | Whether the action is enabled or not. Disabled ( | |
reason | String | A reason why the action is disabled. Show to the user if they interact with the disabled action. |
Actioned
Field | Argument | Type | Description |
---|---|---|---|
action | String! | ||
subject | ID! | The object Id that was deleted. | |
subjectTypename | ID! | The | |
createdAt | DateTime! | When the object (subject) was deleted. | |
createdBy | String | The human, integration, device etc that deleted this object. | |
aid | ID | The account the object was deleted in. | |
DNT | Boolean! | If true, do not save/keep this event. | |
attributes | [ICustomAttribute!] | The event's custom attributes. These are optional, and are not always present. |
AddressValidationResult
Field | Argument | Type | Description |
---|---|---|---|
isValid | Boolean |
Allocation
Allocations assign subsets (or all) of an order's line items to a location to be fulfilled in a certain way.
This is how Orders can be split shipped, collected from multiple places, dropped shipped etc.
It can also be considered a fulfilment grouping.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | An ID for this allocation | |
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
name | String | The name of the allocation. e.g. #000001-A01 | |
method | FulfilmentMethod! | The desired fulfilment method for this allocation | |
shippingAddress | PostalAddress | The destination for these line items. | |
locationId ⚠️ | ID | ⚠️ DEPRECATED
| |
location | Location | ||
locationForPickup | Location | The explicit pick up location | |
lineItems ⚠️ | [OrderLineItem!]! | ⚠️ DEPRECATED
| |
lineItemsConnection | AllocationLineItemResults | ||
lineItemsQuantity | Float! | The total number of products within the allocation. | |
input | AllocationLineItemQuantityInput | ||
serviceCode | ID | The service code to use to fulfil the allocation with. | |
serviceCodeRequested | ID | The service code originally requested on the allocation. | |
fulfilmentAllowed | Boolean! | If false, prevent allocation to be fulfilled (if enabled for account). | |
isFulfilled | Boolean | Whether this allocation is fulfilled or not. | |
relations | Relationships | Relationships the allocation has. | |
fulfilments | [IFulfilment!] | ||
orderId ⚠️ | ID! | ⚠️ DEPRECATED
| |
source | AllocationSource | 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 | [IAction] | Actions the current user can perform on this allocation. | |
input | ActionInput | ||
tags | [Tag!] | Tags on the Allocation. | |
attributes | [ICustomAttribute!]! | Custom attributes on the object. | |
input | ObjectAttributesInput | ||
attributeValue | String | 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: | |
input | ObjectAttributeInput! | ||
createdAt | DateTime! | When the allocation was created. | |
modifiedAt | DateTime | When this allocation was modified. | |
canReallocate ⚠️ | Boolean | If the allocation can be moved/modified ⚠️ DEPRECATED
|
AllocationAlreadyAssigned
Field | Argument | Type | Description |
---|---|---|---|
message | String |
AllocationAlreadyReleased
Field | Argument | Type | Description |
---|---|---|---|
message | String |
AllocationLineItem
An individual line item in an allocation. Links an order line item to an allocation.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | The allocation line item ID. | |
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
quantity | Float! | The quantity of the referenced line item belonging to this allocation. | |
quantityFulfilled | Float | The quantity of the referenced line item that has been fulfilled, if known. | |
lineItem ⚠️ | OrderLineItem | The line item this allocation line item references (uses for source data) ⚠️ DEPRECATED
| |
lineItemV2 | IAllocatableLineItem | The line item this allocation line item references (uses for source data) | |
allocation | Allocation! | The allocation this allocation line item references (uses for source data) | |
actions | [IAction!] | Actions that can be performed on this allocation line item by the current user. | |
input | ActionInput | ||
createdAt | DateTime! | When this allocation line item was created. | |
modifiedAt | DateTime | When this allocation line item was modified. | |
tags | [Tag!] | Tags on the AllocationLineItem. | |
attributes | [ICustomAttribute!]! | Additional custom attributes on the allocation line item.
🤖: Modify with | |
input | ObjectAttributesInput | ||
attributeValue | String | 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: | |
input | ObjectAttributeInput! | ||
backorders | BackorderResults | The backorders for this allocation |
AllocationLineItemMoved
Triggered whenever an allocation line item finishes moving.
Field | Argument | Type | Description |
---|---|---|---|
subject | ID! | Allocation Line Item Id | |
allocationId | String! | Allocation Id | |
createdAt | DateTime! | When the event was emitted. | |
aid | ID | The Id of the account the event occurred within. | |
key | String! | An idempotency key for this event. This will be unique for each attempt for a allocation line item move. | |
createdBy | String | The human, integration, device etc that created this event. | |
amount | Float! | The amount changed. |
AllocationLineItemResult
Field | Argument | Type | Description |
---|---|---|---|
node | AllocationLineItem |
AllocationLineItemResults
Field | Argument | Type | Description |
---|---|---|---|
results | [AllocationLineItemResult!]! | ||
pageInfo | PageInfo! | Info on the number of allocations that can be listed |
AllocationLocationSet
Triggered when a allocation's assigned location is set.
Field | Argument | Type | Description |
---|---|---|---|
subject | ID! | The allocation Id. | |
createdAt | DateTime! | When the allocation method was set. | |
aid | ID | ||
createdBy | String | ||
allocationId ⚠️ | ID! | ⚠️ DEPRECATED
| |
orderId ⚠️ | ID! | ⚠️ DEPRECATED
| |
locationId | ID! | ||
reason | String! | ||
locationIdPrior | ID | ||
locationReference | String | ||
serviceCodeRequested | ID |
AllocationMethodSet
Triggered when the allocation method has changed.
Field | Argument | Type | Description |
---|---|---|---|
subject | ID! | The allocation Id. | |
createdAt | DateTime! | When the allocation method was set. | |
aid | ID | ||
createdBy | String | ||
orderId | ID! | ||
allocationId ⚠️ | ID! | ⚠️ DEPRECATED
| |
method | FulfilmentMethod! | The method the allocation was changed too. | |
methodPrior | FulfilmentMethod | ||
serviceCode | String | ||
serviceCodePrior | String | If the allocation had a service code, what is was prior. |
AllocationNotFound
The provided Allocation Id could not be found
Field | Argument | Type | Description |
---|---|---|---|
message | String | Might explain why the allocation was not found |
AllocationPicked
Emitted when all items of an allocation are picked.
AllocationReadyToPack
Emitted when all items of an allocation are received/have assigned inventory. This often results in a Packing Job being created.
Field | Argument | Type | Description |
---|---|---|---|
subject | ID! | ||
aid | ID | ||
createdAt | DateTime! | ||
createdBy | String | ||
locations | [ID!] | Locations to which items required by this allocation assigned. |
AllocationResult
Result for the Allocation
query
Field | Argument | Type | Description |
---|---|---|---|
order | Order | ||
allocation | Allocation |
AllocationResultNode
Field | Argument | Type | Description |
---|---|---|---|
node | Allocation |
AllocationResults
Field | Argument | Type | Description |
---|---|---|---|
results | [AllocationResultNode!]! | ||
pageInfo | PageInfo! |
AllocationSelectedToPick
Emitted when allocation is selected for picking.
AmxAllocationConnection
A connection to the AMX Allocation Engine
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | The AMX Allocation connection's Id. | |
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
name | String! | The AMX Allocation connection's name | |
retailExpressConnectionId | String | Connection ID for sending orders to Retail Express | |
mcLeodConnectionId | String | Connection ID for sending orders to McLeod | |
integration | Integration | This will always be AmxAllocation for AMX Allocation connections! | |
enabled | Boolean! | Toggle on if you want this connection to be enabled or not | |
connected | Boolean! | Is this connection working? | |
createdAt | DateTime! | When we connected to the engine for the first time | |
createdBy | String! | Who connected to the engine |
ApiConnection
A connection for simple integrations that only require connectivity to the Jungle API!
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | The connection's ID. | |
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
name | String! | The connection's name | |
integration | Integration | Integration details, for branding naming etc | |
enabled | Boolean! | If this connection is to be used or not. 🤖: Control with the | |
connected | Boolean! | Is the connection working, or not. | |
createdAt | DateTime! | ||
createdBy | String! |
AssignedInventory
Attachment
Some data that is attached to an Object in Jungle.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | Unique attachment Id. | |
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
type ⚠️ | AttachmentType! | ⚠️ DEPRECATED
| |
data ⚠️ | String! | Base64-encoded version of the attachment. ⚠️ DEPRECATED
| |
tags | [Tag!] | A list of tags. | |
asset ⚠️ | ID! | The asset this attachment belongs to. ⚠️ DEPRECATED
| |
createdAt | DateTime! | When the attachment was created (uploaded). | |
modifiedAt | DateTime | ||
name | String | The name. | |
file | File | File details of the attachment. If the attachment is a file. | |
attributes | [ICustomAttribute!]! | Custom attributes on the account.
🤖: Modify with | |
input | ObjectAttributesInput | ||
attributeValue | String | A single key from the attachment's custom attributes. Tip: Use GraphQL aliases to fetch attributes as your own properties. See https://graphql.org/learn/queries/#aliases
Usage: | |
input | ObjectAttributeInput! | ||
image | Image | Image details. If the attachment can be considered an image, or can be rendered as one this will not be NULL. |
AttachmentListResult
Field | Argument | Type | Description |
---|---|---|---|
results | [AttachmentListResultEdge!]! | Any attachments found | |
pageInfo | PageInfo! | Information on the number of attachments to be listed |
AttachmentListResultEdge
Field | Argument | Type | Description |
---|---|---|---|
cursor | ID | ||
attachment | Attachment! |
AttachmentListV2Result
Field | Argument | Type | Description |
---|---|---|---|
results | [AttachmentListResultEdge!]! | Any attachments found | |
pageInfo | PageInfo! | Information on the number of attachments to be listed |
AustraliaPostAccountAddress
Field | Argument | Type | Description |
---|---|---|---|
type | String! | The classification for the address | |
lines | [String!]! | The address lines for the address | |
suburb | String! | The suburb for the address | |
postcode | String! | The postcode for the address | |
state | String! | The state code for the address | |
country | String! | The country code for the address |
AustraliaPostAccountDetail
AustraliaPostConnection
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
name | String! | The connection's name | |
accountNumber | String! | Australia Post customer account number | |
integration | Integration | Integration details, for branding naming etc | |
apiKey | String! | ||
password | String! | ||
test | Boolean! | If this is test connection or not! | |
enabled | Boolean! | Toggle on if you want this connection to be enabled or not | |
connected | Boolean! | Is this connection working | |
createdAt | DateTime! | ||
createdBy | String! | ||
validFrom | String | The beginning validity date when the charge account can be used | |
validTo | String | The ending validity date when the charge account can be used | |
addresses | [AustraliaPostAccountAddress!] | One or more addresses associated with the account | |
details | [AustraliaPostAccountDetail!] | Additional information associated with the account | |
postageProducts | [AustraliaPostPostageProduct!] | The postage products and services that can be used with this account | |
expired | Boolean | Whether the charge account has an expired contract | |
merchantLocationId | String | The ID issued to a merchant as part of the setup process | |
creditBlocked | Boolean | Whether the merchant's account is credit blocked. Any account with this status will be forbidden from creating shipments or orders |
AustraliaPostPostageProduct
Field | Argument | Type | Description |
---|---|---|---|
type | String! | The name for the postage product | |
group | String | The product group name. Used for generating labels for items that reference the postage product | |
productId | String! | The code that Australia Post uses to reference the postage product | |
options | AustraliaPostPostageProductOption! | Options available for the postage product | |
contract | AustraliaPostPostageProductContract! | Specific information related to the location’s contract for this product | |
authorityToLeaveThreshold | Float | The limit on transit cover amounts when authority to leave is selected | |
shipmentFeatures | [AustraliaPostPostageProductShipmentFeature!] | Additional shipment features available for the product and its corresponding prices | |
features | [AustraliaPostPostageProductFeature!] | Additional item features available for the product and its corresponding prices |
AustraliaPostPostageProductContract
Field | Argument | Type | Description |
---|---|---|---|
validFrom | String! | The beginning validity date for when this product can be used | |
validTo | String! | The ending validity date for when this product can be used | |
expired | Boolean! | Whether the product can or cannot be used for this location | |
volumetricPricing | Boolean! | Whether volumetric pricing is applicable for this product | |
cubingFactor | Float | If volumetric pricing is applicable, the cubing factor to be applied in the calculation | |
maxItemCount | Int | The maximum number of items that can receive the discount price for the product |
AustraliaPostPostageProductFeature
Field | Argument | Type | Description |
---|---|---|---|
type | String! | A unique string that identifies the type of feature | |
attributes | [AustraliaPostPostageProductFeatureAttribute!] | Additional attributes relevant to the feature | |
bundled | Boolean! | Indicates whether the feature is automatically included with the product |
AustraliaPostPostageProductFeatureAttribute
AustraliaPostPostageProductOption
Field | Argument | Type | Description |
---|---|---|---|
authorityToLeaveOption | Boolean | Whether the option for 'authority to leave' is available for the postage product | |
signatureOnDeliveryOption | Boolean | Whether the option for 'signature on delivery' is available for the postage product | |
dangerousGoodsAllowed | Boolean | Whether Dangerous Goods can be sent with this postage product |
AustraliaPostPostageProductShipmentFeature
Field | Argument | Type | Description |
---|---|---|---|
type | String! | A unique string that identifies the type of feature | |
bundled | Boolean! | Indicates whether the feature is automatically included with the product |
AuthKey
Used for QR Code scan to login
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
barcode | String! | The raw barcode data | |
documentation | DocumentationResult! | Documents for this authkey | |
input | DocumentationInput! | ||
createdAt | DateTime! | When the name tag was created. |
AuthKeyAuthenticated
The authkey and pin are valid
Field | Argument | Type | Description |
---|---|---|---|
token | String! |
AuthKeyInvalidPinError
The authkey's pin does not match the provided pin.
Field | Argument | Type | Description |
---|---|---|---|
attemptsRemaining | Int! |
AuthKeyListResult
Field | Argument | Type | Description |
---|---|---|---|
results | [AuthKeyListResultEdge!]! |
AuthKeyListResultEdge
Field | Argument | Type | Description |
---|---|---|---|
authKey | AuthKey! |
AuthKeyNotFoundError
The authkey doe not exist
Field | Argument | Type | Description |
---|---|---|---|
message | String! |
AuthKeyPinReset
Field | Argument | Type | Description |
---|---|---|---|
reason | String! |
AuthSwitchAccountAuthenticated
Field | Argument | Type | Description |
---|---|---|---|
token | String! |
AuthSwitchAccountDenied
Field | Argument | Type | Description |
---|---|---|---|
reason | String! |
Backorder
A backorder against a order allocation line
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | The backorder's unique identifier. | |
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
orderAllocationLine ⚠️ | AllocationLineItem | The order allocation line this backorder belongs to. ⚠️ DEPRECATED
| |
allocationLineItem | AllocationLineItem | The allocation line item this backorder belongs to. | |
purchaseOrderLines | PurchaseOrderLineItemResults! | The purchase order lines this backorder relates to. | |
quantity | Float! | The quantity specified to backorder. | |
quantityOrdered | Float! | The quantity ordered via purchase order lines. | |
purchasable | Boolean! | Indicates if a backorder is a purchasing candidate or not. To list these:
| |
reason | String! | The reason specified for the backorder. | |
location | Location | The location of the backorder. | |
xids | ExternalIdResults! | The backorder's known external IDs. | |
input | ExternalIdsInput | ||
enabled | Boolean! | If this backorder is active. | |
draft | Boolean! | If this backorder is a draft. | |
deleted | Boolean! | If this backorder is deleted. | |
cancelled | Boolean! | If this backorder is cancelled. | |
tags | [Tag!] | Tags on the backorder. | |
createdBy | String! | The user who created the backorder. | |
modifiedAt | DateTime | When the backorder was modified last, if at all. | |
createdAt | DateTime! | When the backorder was created. |
BackorderResults
A paginated list of backorders associated with the parent object.
Field | Argument | Type | Description |
---|---|---|---|
nodes | [Backorder!]! | A list of backorders. if any. |
Barcode
Brand
Brand sources products for your business.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | The brand's identifier. | |
path ⚠️ | ID! | Full path to the brand. ⚠️ DEPRECATED
| |
name | String! | Brand's name. | |
shipmentSenderOverride | ContactPerson | Brand sender information. Used to override shipment sender information on orders with a channel using this brand. | |
createdAt | DateTime! | When the brand was created in Jungle. | |
modifiedAt | DateTime | When the brand was last modified. | |
xids | ExternalIdResults! | The brand's known external IDs. | |
input | ExternalIdsInput | ||
tags | [Tag!] | ||
enabled | Boolean! | If this brand is active, or not. | |
attributes | [ICustomAttribute!]! | Custom attributes on the brand.
🤖: Modify with | |
input | ObjectAttributesInput | ||
attributeValue | String | A single key from the brand's custom attributes. Tip: Use GraphQL aliases to fetch attributes as your own properties. See https://graphql.org/learn/queries/#aliases
Usage: | |
input | ObjectAttributeInput! |
Capability
A capability represents the ability to do something in the real world.
These represent skills/processes that are provided at certain locations or by products, people etc.
i.e. Pick up a fulfilment at a location.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
name | String! | The human friendly name of the capability. | |
noun | String! | The object or real world thing this capability relates too. Helps with finding capabilities. | |
description | String! | A clear description of what this capability represents. | |
constraints | CapabilityConstraints | Constraints applied to this capability. |
CapabilityConstraints
Represents constraints (limits/ranges) applied to a capability.
A capability can have constraints applied to it, which means that the capability can only be used in certain ways, or within limitations.
How the constraints are relevant and applied depends on the capability. Constraints not applicable to the capability are ignored, regardless of their value.
i.e. A capability to store items in a warehouse may have a constraint that the items must be at least 1m³ in volume. Meaning that the warehouse can only be used to store items that are at least 1m³ in volume. Items smaller than 1m³ cannot be stored in the warehouse. i.e. A capability to transport items may have a constraint that the items at most can be 1kg in weight. Meaning the transporter (a drone for example) can only be used to transport items that are at most 1kg in weight. Items heavier than 1kg cannot be transported.
Field | Argument | Type | Description |
---|---|---|---|
enabled | Boolean | If the capability can be toggled on/off, this can constrain its use to be enabled or disabled. | |
weightMin | Weight | 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. | |
weightMax | Weight | 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. | |
qtyMin | Int | If the capability subject is countable, this can constrain its minimum quantity. i.e. Need at least 3 labels. | |
qtyMax | Int | If the capability subject is countable, this can constrain its maximum quantity, instead of allowing Infinity. i.e. Can only store 20 items. | |
dimensionsInner | Dimensions | 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. | |
dimensionsOuter | Dimensions | 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. | |
dimensionsOuterMin | Dimensions | 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 20cm³. | |
priority | Int | If the capability subject can have ordering, this can constrain the priority of the capability. i.e. This is the last resort. |
CapabilityListResult
A list of matching capabilities.
Field | Argument | Type | Description |
---|---|---|---|
results | [CapabilityListResultEdge!]! | The capability edges that match the query. |
CapabilityListResultEdge
An edge in a capability list of results.
Field | Argument | Type | Description |
---|---|---|---|
capability | ICapability! | The capability node. |
Channel
A sales and/or purchasing channel.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | The channel's identifier. | |
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
tags | [Tag!] | Tags on the channel. | |
code | String! | A unique code for the channel. | |
name | String! | Name for the channel. | |
description | String | Description for the channel. | |
brand | Brand | Brand for the channel. | |
enabled | Boolean! | Is this channel active. | |
createdAt | DateTime! | When the channel was created in Jungle. | |
modifiedAt | DateTime | When the channel was last modified. | |
attributes | [ICustomAttribute!]! | Custom attributes on the account.
🤖: Modify with | |
input | ObjectAttributesInput | ||
attributeValue | String | A single key from the channel's custom attributes. Tip: Use GraphQL aliases to fetch attributes as your own properties. See https://graphql.org/learn/queries/#aliases
Usage: | |
input | ObjectAttributeInput! | ||
xids | ExternalIdResults! | The channel's known external IDs. | |
input | ExternalIdsInput |
ClickAndCollectCreated
Triggered when a FulfilmentCollect is created.
Field | Argument | Type | Description |
---|---|---|---|
subject | ID! | ||
createdAt | DateTime! | ||
aid | ID | ||
createdBy | String | ||
orderId | ID! | ||
fulfilmentCollectId | ID! | ||
allocationId | ID! |
ClickAndCollectReadyEvent
Triggered when a FulfilmentCollect's state becomes ReadyForPickup.
Field | Argument | Type | Description |
---|---|---|---|
subject | ID! | ||
createdAt | DateTime! | ||
aid | ID | ||
createdBy | String | ||
orderId | ID! | ||
fulfilmentCollectId | ID! | ||
locationId | ID! |
ClickAndCollectStateChanged
Triggered when a FulfilmentCollect's state changes.
Field | Argument | Type | Description |
---|---|---|---|
subject | ID! | ||
createdAt | DateTime! | ||
aid | ID | ||
createdBy | String | ||
orderId | ID! | ||
fulfilmentCollectId | ID! | ||
state | CollectionState! |
CollectionListResult
Field | Argument | Type | Description |
---|---|---|---|
pageInfo | PageInfo! | Info on the number of collections that can be listed | |
results | [CollectionListResultEdge!]! |
CollectionListResultEdge
Field | Argument | Type | Description |
---|---|---|---|
collection | FulfilmentCollect! |
Configuration
Field | Argument | Type | Description |
---|---|---|---|
handheld | HandheldConfiguration | Configuration applied to handheld devices. | |
shipmentAutoAcceptancePriceThresholds | [Money!] | 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. |
ContactPerson
Field | Argument | Type | Description |
---|---|---|---|
name | String | ||
firstName ⚠️ | String | ⚠️ DEPRECATED
| |
lastName ⚠️ | String | ⚠️ DEPRECATED
| |
String | |||
phone | String | ||
companyName | String |
Country
A Country, and basic information on it.
Field | Argument | Type | Description |
---|---|---|---|
code | CountryCode! | The ISO 3166-1 alpha-2 code for the country. | |
name | String! | The name of the country. | |
flag | String! | Unicode flag. 🏳️. E.g. 🇦🇺, 🇺🇸, 🇻🇳. | |
alpha3 | String! | The ISO 3166-1 alpha-3 code for the country. |
Created
Triggered when a new object is created in Jungle.
Field | Argument | Type | Description |
---|---|---|---|
subject | ID! | The object Id that was created. | |
subjectTypename | ID! | The | |
createdAt | DateTime! | When the object (subject) was created. | |
createdBy | String | The human, integration, device etc that created this object. | |
aid | ID | The account the object was created in. | |
DNT | Boolean! | If true, do not save/keep this event. | |
attributes | [ICustomAttribute!] | The event's custom attributes. These are optional, and are not always present. |
Currency
A known currency that Jungle can operate with.
Field | Argument | Type | Description |
---|---|---|---|
code | CurrencyCode! | The ISO 4217 code | |
symbol | String! | The currency's native symbol | |
name | String! | The currency's official name | |
decimalDigits | Int! | If the currency is a decimal currency, the number of significant digits/sub units | |
rounding | Int! | If a rounding currency, this is the significant digits we round too. |
CustomAttributeString
String valued attributes.
Customer
A customer is a person, business, or other legal entity that has a relationship with your business.
This relationship can include purchases, transfers, and other activities.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | The customer's ID. | |
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
displayName | String! | Display name of the customer. This is a made of the customer's name and company etc. | |
name | String | Customer's name | |
phone | String | The customer's phone number. | |
String | The customer's email address. | ||
point | GeoPoint | The geolocation of the customer. | |
pointAccuracy | Float | See | |
image | Image | An image of the customer. | |
tags | [Tag!] | A list of tags( | |
attributes | [ICustomAttribute!]! | Additional custom attributes on the customer. | |
input | ObjectAttributesInput | ||
attributeValue | String | A single key from the customer's custom attributes. Tip: Use GraphQL aliases to fetch attributes as your own properties. See https://graphql.org/learn/queries/#aliases
Usage: | |
input | ObjectAttributeInput! | ||
xids | ExternalIdResults! | The customer's known external IDs. | |
input | ExternalIdsInput | ||
createdAt | DateTime! | When the customer was first known to Jungle. | |
modifiedAt | DateTime | When the customer was last modified. |
Defaults
The current user's default values/configuration.
Is different for each account.
Field | Argument | Type | Description |
---|---|---|---|
id | ID | ||
locationId ⚠️ | ID | ⚠️ DEPRECATED
| |
printerId ⚠️ | ID | ⚠️ DEPRECATED
| |
locationDefault | Location | Your default location for the current account, if one is set. This will never work with out account context. | |
printerDefault | JunglePrinter | Your default printer for the current user, if one is set. This will never work with out account context. | |
weighDeviceDefault | Device | Your default scale for the current user, if one is set. This will never work with out account context. |
Deleted
Triggered when an object is deleted in Jungle.
Field | Argument | Type | Description |
---|---|---|---|
subject | ID! | The object Id that was deleted. | |
subjectTypename | ID! | The | |
createdAt | DateTime! | When the object (subject) was deleted. | |
createdBy | String | The human, integration, device etc that deleted this object. | |
aid | ID | The account the object was deleted in. | |
DNT | Boolean! | If true, do not save/keep this event. | |
attributes | [ICustomAttribute!] | The event's custom attributes. These are optional, and are not always present. |
Device
A device known to Jungle.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | The Device's ID. | |
path ⚠️ | ID! | The path(Id) of this device. ⚠️ DEPRECATED
| |
tags | [Tag!] | A list of tags( | |
name | String | The name of the device. | |
manufacturer | String | Who manufactured the device. | |
product | String | The product name of the device. | |
serial | String | The device serial number. | |
barcode ⚠️ | String | The barcode on the device. ⚠️ DEPRECATED
| |
capabilities | [ICapability!] | The capabilities of this device, managed mostly when the device reports back to Jungle. | |
point | GeoPoint | Where the device is on Earth. | |
pointAccuracy | Float | If known, how accurate the geo coordinates are. See | |
enabled | Boolean! | If enabled or not. | |
reportedAt | DateTime | The last time this device reported to Jungle. | |
createdAt | DateTime! | The creation time of this device. | |
weighReport | DeviceWeighReport | The last weigh report received for this device. Scale/balance weigh things and reports on its measurement. The weight on and stability of the balance/scale. If this is null, the device has not reported yet. | |
barcodes | [String] | Known barcode values, associated with the location. |
DeviceWeighReport
A weigh report from a weighing device.
Field | Argument | Type | Description |
---|---|---|---|
subject | ID! | ||
status | DeviceWeighStatus | The status of the weighing device / scales / balance. | |
grams | Weight | The amount of grams being reported. | |
createdAt | DateTime! | When this report was created, roughly when the weight was measured. | |
aid | ID | ||
createdBy | String | ||
DNT | Boolean! |
Dimensions
The physical dimensions of something. E.g. Parcel, Product, Cat.
Field | Argument | Type | Description |
---|---|---|---|
depth | PositiveInt! | The distance (length) from the front to the back of the object. | |
width | PositiveInt! | The distance (length) from the left to the right of the object. | |
height | PositiveInt! | The distance (length) from the top to the bottom of the object. | |
unit | UnitDistance! | The units the distance has been measured in. |
Documentation
An actual documentation file.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | The id of the documentation, generally a composite of the support doc and target object. | |
type | String! | The __typename of the parent object | |
typeId ⚠️ | ID! | The Id of the __typename this documentation belongs too ⚠️ DEPRECATED
| |
size | String! | The size of the documentation. | |
format | DocumentFormat! | The format of the documentation. | |
ready | Boolean | ||
createdAt | DateTime! | When the documentation was created. |
DocumentationNotAvailable
The requested documentation while supported, is not available.
Field | Argument | Type | Description |
---|---|---|---|
message | String |
DocumentationNotSupported
The requested documentation is not supported.
Field | Argument | Type | Description |
---|---|---|---|
message | String |
DocumentationSupported
Documentation supported, it is not actual documentation. It is used to describe what kinds of documentation is supported. Note that supported doesn't mean the documentation is available.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | Id of the documentation type. | |
name | String! | Name of the supported documentation. | |
description | String! | A desc | |
format | DocumentFormat! | The format of the supported documentation. | |
size | String! | The size of the supported documentation. |
DocumentationSupportedResult
Result for the documentationSupported
query.
Field | Argument | Type | Description |
---|---|---|---|
typeIsKnown | Boolean | ||
supported | [DocumentationSupported!]! |
ExportCreated
Field | Argument | Type | Description |
---|---|---|---|
downloadUrl | URL! | URL to download the export. |
ExportFailure
Field | Argument | Type | Description |
---|---|---|---|
message | String! | May explain why it fails |
ExportSubmitted
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ID of the report. Use this to retrieve the full content once the export process is done. |
ExternalId
External IDs are reference/aliases objects using a custom identifier that you provide.
XIDs allow you to store identifiers from your own or other systems against objects in Jungle. XIDs are made up of 3 parts: namespace, key, and value. XIDs fully formatted string can be used to directly reference objects in Jungle, and can be used in place of the Jungle ID!
🤖: It is important to note that an External ID must be unique.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | The external ID's ID. | |
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
tags | [Tag!] | A list of tags. | |
targetId | String! | The target's ID the xid is aliasing. | |
targetTypename | String! | The target's typename the xid is aliasing. | |
namespace | String! | The first part of the xid. | |
key | String! | The second part of the xid. | |
value | String! | The third part of the xid. | |
xid | String! | The formatted XID string.
e.g: xid:jungle/Product:acme/crate/101, xid:jungle/Order:namespace/key/value
🤖: If you want a substring value in the xid, use | |
createdAt | DateTime! | When the external ID was created in Jungle. |
ExternalIdResults
A paginated list of external ids associated with the parent object.
Field | Argument | Type | Description |
---|---|---|---|
nodes | [ExternalId!]! | A list of External IDs. If any. |
File
Field | Argument | Type | Description |
---|---|---|---|
name | String | The filename. | |
contentType | String | Content-Type of the file. | |
md5 | String | A base64 encoded md5 hash of the file contents. | |
crc32c | String | A base64 encoded crc32c checksum of the file contents. | |
etag | String | A base64 encoded etag of the file contents. | |
size | Int | If known, the size in bytes of the file. | |
url | URL | An URL to get access to the attachment. |
FulfillmentCreatedEvent
@DEPRECATED: Use Created
instead!
Field | Argument | Type | Description |
---|---|---|---|
subject | ID! | ||
aid | ID | ||
createdAt | DateTime! | ||
createdBy | String | ||
allocationId | String! | ||
orderId ⚠️ | String! | ⚠️ DEPRECATED
| |
shipmentId | String! |
FulfilmentCollect
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
state | CollectionState! | The current status of the pick up | |
reference | String | A merchant reference number | |
pickUpLocation | Location | The pick up location | |
order | Order | The order this fulfilment is for. | |
allocation | Allocation | The allocation this fulfilment relates to | |
lineItems ⚠️ | [OrderLineItem!]! | The line items to be picked up ⚠️ DEPRECATED
| |
lineItemsConnection | FulfilmentLineItemResults | The order line items to be picked up | |
service | IService | The service being provided to pick up order items. This will be Click and Collect/PICKUP! | |
createdAt | DateTime! | When the pick up was created | |
readyAt | DateTime | When the pick up was ready for collection | |
pickedUpAt | DateTime | When the pick up was collected | |
cancelledAt | DateTime | When the pick up was cancelled | |
collectBy | DateTime | When the pick up must be collected by | |
integrationReference | String | Any kind of useful value to an integration creating/managing this fulfilment | |
documentation | DocumentationResult! | Documents for this collection | |
input | DocumentationInput! | ||
tags | [Tag!] | A list of tags on the fulfilment. | |
attributes | [ICustomAttribute!]! | Additional custom attributes on the customer. | |
input | ObjectAttributesInput | ||
attributeValue | String | A single key from the fulfilment's custom attributes. Tip: Use GraphQL aliases to fetch attributes as your own properties. See https://graphql.org/learn/queries/#aliases | |
input | ObjectAttributeInput! | ||
xids | ExternalIdResults! | The customer's known external IDs. | |
input | ExternalIdsInput | ||
notes | NoteResults | The notes associated with the fulfilment. |
FulfilmentCollectChangeStateResult
Field | Argument | Type | Description |
---|---|---|---|
fulfilmentCollect | FulfilmentCollect |
FulfilmentCollectCreateResult
Field | Argument | Type | Description |
---|---|---|---|
fulfilmentCollect | FulfilmentCollect |
FulfilmentLineItem
A line item in a fulfilment.
This describes what has been fulfilled, and how much of it.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | The ID of the fulfilment line item. | |
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
quantity | Float! | ||
lineItem | OrderLineItem | ||
createdAt | DateTime! |
FulfilmentLineItemResult
Field | Argument | Type | Description |
---|---|---|---|
node | FulfilmentLineItem |
FulfilmentLineItemResults
Field | Argument | Type | Description |
---|---|---|---|
results | [FulfilmentLineItemResult!]! | ||
pageInfo | PageInfo! |
FulfilmentManual
Fulfilment that is not automatically created by Jungle, and is not a shipment, or collection.
When an order is fulfilled outside of shipment and collection fulfilment processes, this is the type to use.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | The fulfilment's ID. | |
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
reference | String | A custom reference for the fulfilment | |
order ⚠️ | Order | The Order this fulfilment relates to. ⚠️ DEPRECATED
| |
allocation | Allocation | The Allocation this fulfilment relates to. NOTE: This is not always available, and may be null even when the fulfilment relates to multiple allocations. | |
integrationReference ⚠️ | String | ⚠️ DEPRECATED
| |
lineItems ⚠️ | [OrderLineItem!]! | The line items in this fulfilment. ⚠️ DEPRECATED
| |
lineItemsConnection | FulfilmentLineItemResults | ||
serviceCode | String | The service code providing this fulfilment. | |
service | IService | The service providing this fulfilment. NOTE: The resolved service may not match the | |
fulfilledAt | DateTime! | When the fulfilment actually happened. Defaults to | |
tags | [Tag!] | A list of tags on the fulfilment. | |
attributes | [ICustomAttribute!]! | Additional custom attributes on the customer. | |
input | ObjectAttributesInput | ||
attributeValue | String | A single key from the fulfilment's custom attributes. Tip: Use GraphQL aliases to fetch attributes as your own properties. See https://graphql.org/learn/queries/#aliases | |
input | ObjectAttributeInput! | ||
xids | ExternalIdResults! | The customer's known external IDs. | |
input | ExternalIdsInput | ||
createdAt | DateTime! | When the fulfilment was created. | |
modifiedAt | DateTime | When the fulfilment was last modified. | |
notes | NoteResults | The notes associated with the fulfilment. |
FulfilmentShipment
A shipment that has fulfilled allocation line items.
It's important to be aware that a Shipment in Jungle is a standalone concept, and may not directly relate to an order or allocation etc. A FulfilmentShipment is a record of what line items were sent, and by which courier it was sent, and may link them to specific jungle shipments.
A FulfilmentShipment may not have .shipments
, as it may just record a shipment made in the past, or in a separate system.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | Id of the fulfilment | |
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
reference | String | A custom reference for the fulfilment. | |
order ⚠️ | Order | The order this fulfilment relates to. ⚠️ DEPRECATED
| |
allocation | Allocation | The allocation this fulfilment relates to | |
lineItems ⚠️ | [OrderLineItem!]! | The line items in this fulfilment ⚠️ DEPRECATED
| |
lineItemsConnection | FulfilmentLineItemResults | The order line items in this fulfilment. | |
service | IService | The service providing this fulfilment, it will be the shipment service | |
integrationReference | String | Integration reference. This is useful when the fulfilment comes from a integration and that integration requires a reference when communicating with the third party which would be different from a customer visible reference | |
shipments ⚠️ | [Shipment!]! | ⚠️ DEPRECATED
| |
shipmentsConnection | FulfilmentShipmentResults | The shipments in this fulfilment. Normally there is one shipment, but can be more, especially in situations where the carrier does not support multi package shipments. | |
documentation ⚠️ | DocumentationResult! | Documents for this fulfilment. ⚠️ DEPRECATED
| |
input | DocumentationInput! | ||
tags | [Tag!] | A list of tags on the fulfilment. | |
attributes | [ICustomAttribute!]! | Additional custom attributes on the customer. | |
input | ObjectAttributesInput | ||
attributeValue | String | A single key from the fulfilment's custom attributes. Tip: Use GraphQL aliases to fetch attributes as your own properties. See https://graphql.org/learn/queries/#aliases | |
input | ObjectAttributeInput! | ||
xids | ExternalIdResults! | The customer's known external IDs. | |
input | ExternalIdsInput | ||
createdAt | DateTime! | When the shipment fulfilment was created | |
modifiedAt | DateTime! | When the shipment fulfilment was last modified | |
notes | NoteResults | The notes associated with the fulfilment. |
FulfilmentShipmentCreateResult
Field | Argument | Type | Description |
---|---|---|---|
fulfilmentShipment ⚠️ | FulfilmentShipment | ⚠️ DEPRECATED
|
FulfilmentShipmentResult
Field | Argument | Type | Description |
---|---|---|---|
node | ShipmentV2 | A shipment. |
FulfilmentShipmentResults
Results for shipments on a fulfilment
Field | Argument | Type | Description |
---|---|---|---|
results | [FulfilmentShipmentResult!]! | The shipment results |
GeoCodePoint
Geo coordinates with an accuracy
Field | Argument | Type | Description |
---|---|---|---|
point | GeoPoint! | lat/lng | |
pointAccuracy | Float! | See |
GeoCodeResult
Field | Argument | Type | Description |
---|---|---|---|
found | GeoCodePoint | If found, a lat/lng for the given address. |
HandheldConfiguration
Field | Argument | Type | Description |
---|---|---|---|
forceAuthenticateAfterTime | PositiveInt | The maximum idle period (in minute) after which users are required to authenticate again. |
Identity
Field | Argument | Type | Description |
---|---|---|---|
id | ID | ||
String | |||
password ⚠️ | String | ⚠️ DEPRECATED
| |
displayName | String |
Image
An image.
Field | Argument | Type | Description |
---|---|---|---|
url | URL! | The URL to the image. If no input is provided, the original image URL is returned. If you want a smaller image, like a thumbnail, you can provide options to transform the image. e.g.:
NOTE: The example is using GraphQL aliases to return multiple image sizes. | |
input | ImageUrlInput |
InsightEmbeddableDetails
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
insightEmbedType | InsightEmbedType! | ||
name | String! | ||
url | URL |
InsightEmbeddableResult
Field | Argument | Type | Description |
---|---|---|---|
node | InsightEmbeddableDetails |
InsightEmbeddableResults
Field | Argument | Type | Description |
---|---|---|---|
results | [InsightEmbeddableResult!]! | ||
pageInfo | PageInfo! |
Integration
A 3rd party system or service provider known to Jungle
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | The integration's ID. | |
name | String! | The name of the integration | |
description | String! | A description of the integration | |
homeUrl | URL | The homepage URL of the integration provider. | |
logoUrl | URL | The URL to product/integration logo. | |
logoBg | String | An optional color code for background of the logo. | |
setupDescription | String | A description of the integrations setup | |
setupUrl | URL | The URl that begins the connection process, an integration may not have one, if it is manual / different process | |
connectionLimit | Int! | The number of connections that will be allowed to this integration, active or otherwise | |
awaitPngUrl | URL | A PNG image to show when the integration is being connected to, or when a process is happening that is awaiting integrated system. | |
features | [String!] |
IntegrationConnectionListResult
Field | Argument | Type | Description |
---|---|---|---|
results | [IntegrationConnectionListResultEdge!] | ||
pageInfo | PageInfo! |
IntegrationConnectionListResultEdge
Field | Argument | Type | Description |
---|---|---|---|
connection | IIntegrationConnection! |
IntegrationConnectionSource
When an object comes from a integration connection.
Field | Argument | Type | Description |
---|---|---|---|
name | String | This integration connection's name. | |
connection | IIntegrationConnection | The connection the object came from. |
IntegrationListResult
Field | Argument | Type | Description |
---|---|---|---|
results | [IntegrationListResultEdge!]! |
IntegrationListResultEdge
Field | Argument | Type | Description |
---|---|---|---|
integration | Integration! |
IntegrationPrivate
Private integration information.
This is for the integration and the account that manages it.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | This is the integration unique id. This must be DNS friendly. It can not be changed. | |
secret | String! | Keep this a secret. Use this verify data from the Jungle Platform. | |
apiKey | String! | Keep this a secret. Use this to communicate with the Jungle Platform as the integration. | |
audience | IntegrationAudience | The audience this integration is intended for. | |
createdAt | DateTime! |
Inventory
Inventory for a specific SKU at a location.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | Inventory Id | |
sku | String! | The stock keeping unit. This can be any unique identifier within your business. This is unique at each location where inventory is being tracked. | |
condition | String | Product condition, e.g. damaged, new, mislabeled | |
location | Location | The location this inventory is at. i.e A store, shelf, van etc. | |
quantity ⚠️ | Int! | A copy of ⚠️ DEPRECATED
| |
quantityOnHand | Int! | The quantity of this SKU currently on hand regardless of whether it is available for use. This number includes all inventory, including allocated inventory. This number reduces when the SKU is consumed, i.e. Fulfilled against an order. This number can go negative, if there are stock level mismatches (having more on hand than actually counted) etc. It is most likely used as a reference in picking processes, and not displayed in your shop. | |
quantityAllocated | Int! | The current quantity of this SKU that has been promised/sold, but has not yet been fulfilled. This number is updated when the SKU is allocated to a location (see | |
quantityAssigned | Int! | The current quantity of SKU in stock / on hand assigned for an allocation. This number is updated when allocated SKU is assigned to inventory on hand. This number represents the perceived quantity of the SKU sold and assigned. This number can not go negative and cannot go higher than on hand. | |
quantityAvailable | Float! | The quantity of this SKU currently available for use/sale. This number is derived from inventory on hand, minus the inventory allocated. In other words, it’s your current unassigned stock. This number can go negative, especially when over allocated. It is most likely the quantity to display in your sales processes. | |
quantityAvailableToPromise | Float! | The quantity of this SKU currently available to promise publicly to any given consumer. This number is derived from your available inventory. Plus any additional rules for limiting promised stock. This number can go negative, especially when you have over allocated. It is most likely the quantity to display in your shop. | |
quantityInbound | Float! | The current incoming quantity of this SKU. i.e. Ordered from a supplier, but has not yet been received. This number is updated when inbound inventory movement is created. This number can not go negative. It is mostly likely the quantity used in your warehouse management processes. | |
quantityOrdered | Float! | The total quantity of SKU on purchase orders that have not yet been received or reconciled. | |
quantityBackorder ⚠️ | Float! | The total quantity of SKU required for open sales order that have not yet been ordered. ⚠️ DEPRECATED
| |
quantityBackordered | Float! | The total quantity of SKU required for open sales order that have not yet been ordered. | |
quantityReconciled | Float! | The total quantity of SKU on purchase orders that have been reconciled. | |
quantityUnreconciled | Float! | The total quantity of SKU on purchase orders that have not yet been reconciled. | |
createdAt | DateTime! | When Jungle first started tracking this SKU at the location. | |
product | Product | The product (if there is one) associated with this inventory record |
InventoryAllocated
Triggered when inventory was successfully allocated inr the inventoryAllocate
mutation.
Field | Argument | Type | Description |
---|---|---|---|
subject | ID! | The inventory Id. | |
createdAt | DateTime! | ||
aid | ID | ||
createdBy | String | ||
sku | String! | ||
locationId ⚠️ | ID! | ⚠️ DEPRECATED
| |
allocationKey | ID! | This value can be used later for easy removal of the allocation, and decrement of on hand stock. It helps identify specific allocations. | |
quantityAllocated | Int! | This number or items allocated, -2, or 3 etc. |
InventoryAllocationsCleared
Result for the inventoryAllocationsClear
mutation
Field | Argument | Type | Description |
---|---|---|---|
cleared | Boolean! | True if allocations were cleared, regardless of if there were any to clear |
InventoryAlreadyAllocated
The inventory was allocated in previous inventoryAllocate
mutation!
Field | Argument | Type | Description |
---|---|---|---|
allocationKey | ID! | The inventory has already been allocated using the provided key! |
InventoryAlternative
An alternative location to pick the item from.
Field | Argument | Type | Description |
---|---|---|---|
location | Location |
InventoryAlternativesResult
Field | Argument | Type | Description |
---|---|---|---|
pageInfo | SearchPageInfo! | ||
results | [InventoryAlternative]! |
InventoryAssignableResult
Result for the inventoryAssignable
query.
Field | Argument | Type | Description |
---|---|---|---|
results | [InventoryItemResultEdge!]! | The matched inventory items. |
InventoryAssignment
Triggered when assigned inventory is modified in Jungle.
Field | Argument | Type | Description |
---|---|---|---|
subject | ID! | The Id of the what the inventory is assigned to, i.e, Allocation Id | |
subjectTypename | ID! | The __typename of the object, e.g. Allocation | |
inventoryAssignmentSummary | [InventoryAssignmentSummary!]! | A summary of the current inventory assigned to the subject | |
createdAt | DateTime! | When the inventory assigned to the subject was modified. | |
createdBy | String | The human, integration, device etc that modified this object. | |
aid | ID | The account the object was modified in. | |
DNT | Boolean! | If true, do not save/keep this event. | |
attributes | [ICustomAttribute!] | The event's custom attributes. |
InventoryAssignmentSummary
Field | Argument | Type | Description |
---|---|---|---|
sku | String! | The stock keeping unit. This can be any unique identifier within your business. This is unique at each location where inventory is being tracked. | |
quantityAssigned | Float! | The current quantity of SKU in stock / on hand assigned. | |
quantityAllocated | Float! | The number of the SKU allocated. |
InventoryByAllocation
Field | Argument | Type | Description |
---|---|---|---|
sku | String! | The stock keeping unit. This can be any unique identifier within your business. This is unique at each location where inventory is being tracked. | |
location | Location | The location this inventory is at. i.e A store, shelf, van etc. | |
quantityAssigned | Float! | The current quantity of SKU in stock / on hand assigned for this allocation. | |
quantityAllocated | Float! | The number of the SKU allocated. | |
alternatives | InventoryAlternativesResult |
InventoryByPurchaseOrder
Field | Argument | Type | Description |
---|---|---|---|
sku | String! | The stock keeping unit. This can be any unique identifier within your business. This is unique at each location where inventory is being tracked. | |
condition | String | Product condition, e.g. damaged, new, mislabeled | |
location | Location | The location this inventory is at. i.e A store, shelf, van etc. | |
quantityReceived | Float! | The current received quantity of this SKU. | |
quantityInbound | Float! | The current incoming quantity of this SKU. i.e. Ordered from a supplier, but has not yet been received. |
InventoryCreateResult
Result for the inventoryCreate
mutation
Field | Argument | Type | Description |
---|---|---|---|
ok | Boolean! | ||
inventory ⚠️ | Inventory | ⚠️ DEPRECATED
|
InventoryItem
Field | Argument | Type | Description |
---|---|---|---|
product | Product | The product associated with this inventory item. | |
location | Location! | The location this inventory is at. i.e A store, shelf, van etc. | |
quantity | Decimal! | The quantity of this inventory item. | |
assignment | IInventoryAssignTarget | The current target the inventory is assigned to. |
InventoryItemResultEdge
Edge for the InventoryAssignableResult
result.
Field | Argument | Type | Description |
---|---|---|---|
node | InventoryItem! | Found inventory item. |
InventoryListAssignedAtLocationResult
Field | Argument | Type | Description |
---|---|---|---|
sku | String! | ||
assigned | [AssignedInventory!]! |
InventoryListResult
Result for the inventoryList*
queries.
Field | Argument | Type | Description |
---|---|---|---|
results | [InventoryListResultEdge!]! | Any inventory found | |
pageInfo | PageInfo! | Information on the number of inventories to be listed |
InventoryListResultEdge
Edge for InventoryListResult
.
Field | Argument | Type | Description |
---|---|---|---|
cursor | ID | Cursor for the current inventory | |
inventory | Inventory! | An inventory in the results |
InventoryMoved
The inventory was moved from the location to the destination
InventoryMovement
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
type | InventoryMovementType! | ||
from | IInventoryMovementFrom | Source from which the Inventory comes, i.e. Allocation, Supplier, PurchaseOrder, Location. May not exist (i.e. Inbound movements, receiving from a truck) | |
to | IInventoryMovementTo | Destination to where the Inventory transferred to, i.e. Location, Allocation. May not exist (i.e. Outbound movements) | |
description | String | A description of the inventory movement in details. | |
sku | SKU! | Product SKU | |
condition | String | Product condition, e.g. damaged, new, mislabeled | |
qty | Float! | Quantity of SKU moved | |
createdAt | DateTime! | ||
modifiedAt | DateTime | ||
createdBy | String! | ||
location | Location | Location where the inventory movement happens | |
jobId | String | Job id related to inventory movement | |
unitCost | MoneyV1 | The cost of the product (per unit) associated with this movement at the time this movement occurred. |
InventoryMovementReceivedListResult
Field | Argument | Type | Description |
---|---|---|---|
pageInfo | SearchPageInfo! | ||
results | [InventoryMovement!]! |
InventoryNotFound
Result when inventory is not found.
Field | Argument | Type | Description |
---|---|---|---|
message | String |
InventoryPreference
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
product | Product! | ||
location | Location! | ||
capabilities | [ICapability!] | Preferences on the capabilities of the inventory given a product and a location pair. |
InventoryPutAwayItemsByLocationResult
Result for the inventoryPutAwayItemsByLocation
query.
Field | Argument | Type | Description |
---|---|---|---|
results | [InventoryPutAwayItemsByLocationResultNode!]! | Items to put away, if empty there is no more items to put away | |
location | Location | The location to put away from. | |
locationTransferable | Boolean | If true, it means you may simply transfer it, as the location contains all the items to be put away to any location |
InventoryPutAwayItemsByLocationResultNode
Field | Argument | Type | Description |
---|---|---|---|
sku | String! | Item's SKU | |
condition | String | Item's condition, e.g. damaged, new, mislabeled | |
quantity | Float! | Quantity of the item to put away | |
locationsTo | [Location!] | Suggested locations to put away the items to. If empty or not given, put away the items to any location | |
allocation | Allocation | Allocation the item is assigned to | |
allocationIsReadyToPack | Boolean | If true, the current allocation has all the items in the current location and could be packed immediately (therefore skipping storing and picking later) |
InventoryPutAwayItemsResult
Result for the inventoryPutAwayItems
query.
Field | Argument | Type | Description |
---|---|---|---|
results | [InventoryPutAwayItemsResultNode!]! | Items to put away, if empty there is no more items to put away | |
locationTransferable | Location | If a location, it means you may simply transfer it, as the location contains all the items to be put away | |
locationNext | Location | Suggested location to put away the items to. If empty, put away the items to any location | |
allocationIsReadyToPack | Boolean | If true, the current allocation has all the items in the current location and could be packed immediately (therefor skipping storing and picking later) |
InventoryPutAwayItemsResultNode
Field | Argument | Type | Description |
---|---|---|---|
allocation | Allocation | Allocation the item is assigned to | |
location | Location | Item's current location | |
sku | String! | Item's SKU | |
condition | String | Item's condition, e.g. damaged, new, mislabeled | |
quantity | Float! | Quantity of the item to put away |
InventoryReplenishablePickItemsResult
Result for the inventoryReplenishablePickItems
query.
Field | Argument | Type | Description |
---|---|---|---|
results | [InventoryReplenishablePickItemsResultNode!]! | The items that are replenishable |
InventoryReplenishablePickItemsResultNode
Field | Argument | Type | Description |
---|---|---|---|
location | Location | Location to replenish from | |
alternatives | InventoryAlternativesResult | ||
sku | String! | Item's SKU | |
quantity ⚠️ | Float! | Maximum quantity of the SKU that can be replenished ⚠️ DEPRECATED
| |
quantityInLocation | Float! | Quantity available of the SKU at the location | |
quantityToReplenish | Float! | Quantity of the SKU that needs to be replenished |
InventoryReservedItemsListResult
Result for the inventoryReservedItemsList
query.
Field | Argument | Type | Description |
---|---|---|---|
results | [InventoryReservedPickItemsResultNode!]! | ||
pageInfo | SearchPageInfo! |
InventoryReservedPickItemsResult
Result for the inventoryReservedPickItems
query.
Field | Argument | Type | Description |
---|---|---|---|
results | [InventoryReservedPickItemsResultNode!]! | The items that are ready to be picked, and moved to trolley, or packing area etc.. | |
locationTransferable | Location | If a location, it means you may simply transfer it, as the location contains all the items to be put away |
InventoryReservedPickItemsResultNode
Field | Argument | Type | Description |
---|---|---|---|
allocation | Allocation | ||
location | Location | ||
sku | String! | ||
quantity | Float! | ||
alternatives | InventoryAlternativesResult | ||
documentation | DocumentationResult! | Documents for this item. e.g. Pick label. | |
input | DocumentationInput! |
InventoryReservedPickResult
Result for the inventoryReservedPick
query.
Field | Argument | Type | Description |
---|---|---|---|
locationNext | Location | If the location is not null, it means the pick wave/reservation is still active, and the user should be directed to that location. |
InventorySetEvent
Field | Argument | Type | Description |
---|---|---|---|
subject | ID! | The allocation Id. | |
createdAt | DateTime! | ||
aid | ID | ||
createdBy | String | ||
locationId | ID! | ||
sku | String! | ||
quantityOnHand | Int! | ||
quantityAllocated | Int! | ||
quantityAvailableToPromise | Int! | ||
quantityAllocatedPrior | Int | ||
quantityOnHandPrior | Int | ||
attributes | [ICustomAttribute!] | The event's custom attributes. These are optional, and are not always present. |
InventorySummarizeResult
Result for the inventorySummarize
query
Field | Argument | Type | Description |
---|---|---|---|
locationIdsUsed | [ID!]! | Any location Id's that where found to have inventory, and rolled up. | |
locationIdsNotUsed | [ID!]! | Any location Id's the don't exist or don't hold the SKU. It is up to you to confirm if the summary result is valid or not for your use case. | |
summedQuantityOnHand | Int! | The summed quantity of the SKU currently in stock / on hand. It is most likely used as a reference in product UIs or inventory management, and not displayed in your shop. | |
summedQuantityAllocated | Int! | The summed quantity of the SKU currently allocated. It is most likely used as a reference to understand how much inventory is currently awaiting fulfilment. | |
summedQuantityAvailableToPromise | Int! | The summed quantity of the SKU currently available to sell. It is most likely the quantity to display in your shop. | |
locationSummaries | [InventorySummary!]! | Lists out the location specific quantities. This may not contain all requested locations, and may contain a location twice. |
InventorySummary
Summary for a location inventory used in the inventorySummarize
/inventorySummarizeByProduct
query
Field | Argument | Type | Description |
---|---|---|---|
locationId | ID! | The location Id | |
quantityOnHand | Int! | ||
quantityAllocated | Int! | ||
quantityAvailableToPromise | Int! |
InventoryUnassignedPickItemsResult
Result for the inventoryUnassignedPickItems
query.
Field | Argument | Type | Description |
---|---|---|---|
results | [InventoryUnassignedPickItemsResultNode!]! | The items that are unassigned | |
locationTransferable | Location | If provided, it means you may simply transfer it, as the location contains all the items to be put away |
InventoryUnassignedPickItemsResultNode
InventoryUnassignedPickResult
Result for the inventoryUnassignedPick
query.
Field | Argument | Type | Description |
---|---|---|---|
locationNext | Location | If the location is not null, it means the wave is still active, and the user should be directed to that location. |
JobAllocationLimit
JobAllocationNotFound
Result for when a given allocation Id does not map to any allocation in a Job
Field | Argument | Type | Description |
---|---|---|---|
message | String | Might explain why the allocation was not found |
JobAllocationToPack
A partial clone of order allocation, but records the packed state of the items to fulfill.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ID of the allocation to pack. This matches the original order allocation Id. | |
orderId ⚠️ | ID! | ID of the order to pack ⚠️ DEPRECATED
| |
reference | String | Reference of the Order to pack | |
method ⚠️ | FulfilmentMethod | ⚠️ DEPRECATED
| |
shippingAddress ⚠️ | PostalAddress | ⚠️ DEPRECATED
| |
serviceCode ⚠️ | ID | ⚠️ DEPRECATED
| |
itemsToPack | [JobPackItem] | List of items to pack | |
itemsNotYetPacked | [JobPackItem] | List of items not yet packed | |
itemsPacked | [JobPackItem] | List of items already packed | |
itemsPackedPerPackage | [JobPackPackageContent] | List of items already packed, group by package |
JobChangeStatusResult
JobConfiguration
Job configuration
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
name | String! | ||
enabled | Boolean! | ||
description | String! | ||
initialStatus | JobStatus! | Job will be created with the initial status | |
operations | [JobConfigurationOperation!]! | Configured operations for job |
JobConfigurationList
Field | Argument | Type | Description |
---|---|---|---|
results | [JobConfigurationResultEdge!] |
JobConfigurationOperation
Field | Argument | Type | Description |
---|---|---|---|
context | JobOperationContext! | ||
operation | JobOperation! | ||
mutations | [String!]! | Mutations for the operation | |
queries | [String!] | Queries for the operation | |
conditions | [JobOperationCondition!] | Condition for the operation | |
nextContext | JobOperationContext | ||
arguments | JobOperationArgument |
JobConfigurationResultEdge
Field | Argument | Type | Description |
---|---|---|---|
cursor | ID! | ||
jobConfiguration | JobConfiguration! |
JobConfigured
Configured Job
Job created from a job configuration
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | The Job's Id | |
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
idQR | ID | Contents for a Jungle QR code that identifies the job. | |
documentation | DocumentationResult! | Documentation for this job. | |
input | DocumentationInput! | ||
reference | String | The job reference number | |
status | JobStatus! | The status of this job | |
location | Location | The location where the job is happening | |
createdAt | DateTime! | When the job was created | |
isCancelable | Boolean | Whether the job can be cancelled | |
products | [JobConfiguredProduct!] | Products added to the job | |
configuration | JobConfiguration | Configuration for this job | |
completedAt | DateTime | When the job was completed | |
supplier | Supplier | The supplier assigned to this job by default | |
purchaseOrder | PurchaseOrder | The purchase order assigned to this job by default |
JobConfiguredLocationsPutAwayResult
Field | Argument | Type | Description |
---|---|---|---|
locations | [Location] |
JobConfiguredPickPreview
Field | Argument | Type | Description |
---|---|---|---|
itemsQuantity | Float! | The total quantity of items to be reserved for all allocations. | |
itemsCount | Int! | The number of items to be reserved for all allocations. | |
locationsCount | Int! | Number of unique locations to pick from | |
allocations | [JobConfiguredPickPreviewAllocation!] | The Allocations which would be included in the job |
JobConfiguredPickPreviewAllocation
Field | Argument | Type | Description |
---|---|---|---|
allocationId | ID! | The ID of the Allocation | |
itemsQuantity | Float! | The total quantity of items to be reserved for the allocation. | |
itemsCount | Int! | The number of items to be reserved for the allocation. |
JobConfiguredPickPreviewResult
Field | Argument | Type | Description |
---|---|---|---|
logs | [Log!] | ||
preview | JobConfiguredPickPreview | A preview of the Allocations and Products to be reserved |
JobConfiguredProduct
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | The job product's Id | |
barcode | String! | The product's barcode | |
product | Product | Product | |
quantityAvailable | Int! | The total quantity of product available | |
quantityAssigned | Int! | The total quantity of product assigned | |
quantityTotal | Int! | The total quantity of product for the job | |
items | [IJobConfiguredProductItem!]! | The list of product's items for this job |
JobConfiguredProductAssignedToAllocation
Product used to assign to an allocation
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
status | JobProductStatus! | ||
createdAt | DateTime | When the item was created | |
location | Location | The location where inventory is at. | |
quantity | Int! | Product quantity | |
allocation | Allocation | The allocation which product is assigned to. User can unset allocation, so this may be empty. | |
isDamaged | Boolean | Whether the product is damaged | |
lineItem | LineItem | The line item that was received against | |
isOversized | Boolean | Whether the product is oversized | |
supplier | Supplier | The supplier which product is assigned to | |
purchaseOrder | PurchaseOrder | The purchase order which product is assigned to |
JobConfiguredProductAttachmentUploadTokenCreateResult
Field | Argument | Type | Description |
---|---|---|---|
ok | Boolean! | True if the result is successful, false otherwise. | |
code | String | A machine code that can used to identity the failure. | |
reason | String | A sentence on what went wrong. | |
logs | [Log!] | ||
uploadToken | UploadToken |
JobConfiguredProductIncrementInventory
Product used to increment inventory
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
status | JobProductStatus! | ||
createdAt | DateTime | When the item was created | |
location | Location | The location where inventory is at. | |
quantity | Int! | Product quantity used to increment inventory | |
allocation | Allocation | The allocation which product is assigned to | |
lineItem | LineItem | The line item that was received against | |
isDamaged | Boolean | Whether the product is damaged | |
isOversized | Boolean | Whether the product is oversized | |
supplier | Supplier | The supplier which product is assigned to | |
purchaseOrder | PurchaseOrder | The purchase order which product is assigned to |
JobConfiguredProductPicked
Picked product
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
status | JobProductStatus! | ||
createdAt | DateTime | When the item was created | |
quantity | Int! | Product quantity available | |
location | Location | The location where product is picked to. | |
allocation | Allocation | The allocation which product is assigned to | |
lineItem | LineItem | The line item that was received against | |
isDamaged | Boolean | Whether the product is damaged | |
isOversized | Boolean | Whether the product is oversized | |
supplier | Supplier | ||
purchaseOrder | PurchaseOrder | ||
documentation | DocumentationResult! | Documents for this job configured product item | |
input | DocumentationInput! |
JobConfiguredProductPutaway
Product that was putaway
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
status | JobProductStatus! | ||
createdAt | DateTime | When the item was created | |
quantity | Int! | Product quantity available | |
location | Location | The location where product is putaway to. | |
allocation | Allocation | The allocation which product is assigned to | |
lineItem | LineItem | The line item that was received against | |
isDamaged | Boolean | Whether the product is damaged | |
isOversized | Boolean | Whether the product is oversized | |
supplier | Supplier | ||
purchaseOrder | PurchaseOrder |
JobConfiguredProductReceived
Quantity received
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
status | JobProductStatus! | ||
createdAt | DateTime | When the item was created | |
quantity | Int! | Product quantity available | |
location | Location | The location where product is received. | |
allocation | Allocation | The allocation which product is assigned to | |
lineItem | LineItem | The line item that was received against | |
isDamaged | Boolean | Whether the product is damaged | |
isOversized | Boolean | Whether the product is oversized | |
supplier | Supplier | The supplier which product is assigned to | |
purchaseOrder | PurchaseOrder | The purchase order which product is assigned to |
JobListResult
Field | Argument | Type | Description |
---|---|---|---|
results | [JobListResultEdge!]! | ||
pageInfo | PageInfo! | Info on the number of jobs that can be listed |
JobListResultEdge
JobNotFound
Result for when a given job Id does not map to a Job
Field | Argument | Type | Description |
---|---|---|---|
message | String | Might explain why the job was not found |
JobOperationArgument
Field | Argument | Type | Description |
---|---|---|---|
qtyMax | Int | The maximum quantity allowed for an operation. This number is the hard-limit. Specific operation can have its own logic which enforces a much lower value. | |
limit | PositiveInt | The limit allowed for an operation. If the operation has a limit, this will be used as the operation's input limit. This number is the hard-limit. Specific operation can have its own logic that uses this value. | |
inventoryAction | InventoryMovementType | The inventory movement incurred for an operation. If set, after the operation completes, a movement of this type will be created. Specific details for this movement depends on the context surrounding the operation. | |
collateBy | InventoryPutAwayCollationMethod | The collation method for the operation. Specific operation can have its own logic that uses this value. |
JobPack
Packing job.
The task to bundle 1 or more SKUs from an allocation into a fulfilment.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | The pack job's Id | |
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
idQR | ID | Contents for a Jungle QR code that identifies the job. | |
documentation | DocumentationResult! | Documentation for this job. | |
input | DocumentationInput! | ||
reference | String | The job reference number | |
status | JobStatus! | The status of this job | |
location | Location | The location where the job is happening | |
createdAt | DateTime! | When the job was created | |
allocations | [JobAllocationToPack] | ||
allocationsUnfulfilled | [ID!]! | List of allocations unfulfilled | |
allocationsFulfilled | [ID!]! | List of allocations fulfilled | |
allocationIds | [ID!] | List of allocations in this packing job | |
isCancelable | Boolean | If true, the job may be cancelled | |
completedAt | DateTime | When the job was completed |
JobPackAllocationMarkFulfilledResult
JobPackAllocationShippingAddressSet
Field | Argument | Type | Description |
---|---|---|---|
message | String |
JobPackCreateResult
Field | Argument | Type | Description |
---|---|---|---|
job | JobPack! |
JobPackItem
Field | Argument | Type | Description |
---|---|---|---|
sku | String! | ||
quantity | NonNegativeInt! | ||
product | Product |
JobPackPackageContent
Field | Argument | Type | Description |
---|---|---|---|
packageId | ObjectID! | ||
packageOfProduct | Product | Indicate whether this package is actually a package of a multi-part product. | |
description | String | Describe the packaging. | |
dimensions | Dimensions | Dimensions of the packaging. | |
items | [JobPackItem!]! |
JobPackSkuResult
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
itemsNotYetPacked | [JobPackItem!]! | List of items not yet packed | |
itemsPacked | [JobPackItem!]! | Summary of items already packed | |
itemsPackedPerPackage | [JobPackPackageContent]! | List of items already packed, group by package |
JobPick
Picking job.
The task is to collect 1 or more SKUs, from 1 or more locations, and collect the items together. The method may be different.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | The pick job's Id | |
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
idQR | ID | Contents for a Jungle QR code that identifies the job. | |
documentation | DocumentationResult! | Documentation for this job. | |
input | DocumentationInput! | ||
reference | String | The job reference number | |
status | JobStatus! | The status of this pick job | |
method | PickMethod! | Method of this pick job | |
location | Location | The location where the job is happening | |
pickLocation | Location | Location where items are picked to | |
createdAt | DateTime! | When the job was created | |
assignedTo | String | Name of the person this job is assigned to | |
itemsToPick | [JobPickItem] | List of items to pick | |
itemsNotYetPicked | [JobPickItem] | List of items not yet picked | |
itemsPicked | [JobPickItem] | List of items already picked | |
allocationIds | [ID!] | The Order allocations known to be assigned to this picking job. It may not have any (e.g, internal picking jobs to move stock), but generally will relate to an Order via 1 or more allocations. Limited to 100 allocations per job. | |
isCancelable | Boolean | If true, the job may be cancelled | |
completedAt | DateTime | When the job was completed |
JobPickCreateResult
Field | Argument | Type | Description |
---|---|---|---|
job | JobPick! |
JobPickItem
Field | Argument | Type | Description |
---|---|---|---|
sku | String! | ||
quantity | NonNegativeInt! |
JobPickLocationAssignResult
JobPickedSku
Field | Argument | Type | Description |
---|---|---|---|
itemsNotYetPicked | [JobPickItem!]! | List of items not yet picked | |
itemsPicked | [JobPickItem!]! | List of items already picked |
JobSkuLimit
JobStatusChanged
Field | Argument | Type | Description |
---|---|---|---|
subject | ID! | ||
aid | ID | ||
createdAt | DateTime! | ||
createdBy | String | ||
jobId ⚠️ | ID! | ⚠️ DEPRECATED
| |
orderRelatedIds | [ID!] | ||
status | JobStatus! |
JunglePrinter
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
name | String! | The name of the printer | |
location | Location | The location of this printer | |
createdAt | DateTime | ||
attributes | [ICustomAttribute!]! | Additional custom attributes on the printer.
🤖: Modify with | |
input | ObjectAttributesInput | ||
attributeValue | String | A single key from the printer's custom attributes. Tip: Use GraphQL aliases to fetch attributes as your own properties. See https://graphql.org/learn/queries/#aliases
Usage: | |
input | ObjectAttributeInput! |
LineItem
A line item is a product or service that is part of an order, transfer, return, or other object.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | The line item's ID. | |
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
name | String | The title or name of the line item. | |
quantity | Float! | The amount of units. e.g. Count, Hrs, Kilograms. | |
quantityFulfilled | Float | The number of units fulfilled/sent to customer. If NULL, it is not relevant. | |
quantityToReceive | Float | The number of units to receive. If NULL, it is not relevant. | |
quantityReceived | Float | The number of units received. If NULL, it is not relevant. | |
sku | SKU | The stock keeping unit. This associates this line item with your inventory. The value will be used to look up available inventory, and allocate inventory. | |
product | Product | The product (if there is one) associated with this line item. | |
productName ⚠️ | String | ⚠️ DEPRECATED
| |
allocate | Boolean! | If true, this means the line item can move into an allocation. | |
unitPrice | Money | The base price per unit of the line item. 🤖: We recommend recording taxation and other fees as adjustments. | |
discountPercentage | Decimal | The discount percentage applied to the line item. | |
auTaxApplied ⚠️ | AuTaxApplied | The tax code has been applied to this line item. ⚠️ DEPRECATED
| |
adjustments ⚠️ | [MoneyAdjustment!] | Adjustments applied to this line item's unitPrice. e.g. Tax, Handling, Fees. ⚠️ DEPRECATED
| |
subtotalPrice | Money | Line item's unitPrice multiplied by the quantity, excludes adjustments if provided. | |
totalPrice | Money | Line item's unit price (or discount price if provided) multiplied by the quantity, including adjustments if provided. | |
estimatedAt | DateTime | When the line item is predicted to be handled by. | |
targetedAt | DateTime | When the line item is targeted to be handled by. | |
cancelled | Boolean | Whether the line item was cancelled. | |
cancelledAt | DateTime | If cancelled, when the line item was cancelled. | |
cancelledReason | String | If cancelled, why the line item was cancelled. | |
order ⚠️ | IOrder | ⚠️ DEPRECATED
| |
actions | [IAction!] | Actions the current user can perform on this line item. | |
input | ActionInput | ||
source | LineItemSource | The source object of the line item. E.g. Order, Transfer, Return. | |
reason | String | The reason why this line was added, if one. | |
attributes | [ICustomAttribute!]! | Additional custom attributes on the line item.
🤖: Modify with | |
input | ObjectAttributesInput | ||
attributeValue | String | A single key from the line item's custom attributes. Tip: Use GraphQL aliases to fetch attributes as your own properties. See https://graphql.org/learn/queries/#aliases
Usage: | |
input | ObjectAttributeInput! | ||
tags | [Tag!] | A list of tags( | |
createdAt | DateTime! | When the line item was created. | |
modifiedAt | DateTime! | When the transfer was last modified. | |
notes | NoteResults | The notes associated with the line item. | |
backorders | BackorderResults | The backorders for this line item | |
receiveItems | ReceiveItemResults | List of items received against this line item. If any. | |
returning | ILineItem | The line item being returned |
LineItemResultNode
Field | Argument | Type | Description |
---|---|---|---|
node | LineItem |
LineItemResults
Field | Argument | Type | Description |
---|---|---|---|
results | [LineItemResultNode!]! | ||
pageInfo | PageInfo! |
Location
An important place that matters to your business.
Field | Argument | Type | Description |
---|---|---|---|
xids | ExternalIdResults! | The locations's known external IDs. | |
input | ExternalIdsInput | ||
id | ID! | ||
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
idQR | ID | Contents for a Jungle QR code that identifies the location. | |
name | String! | Identifying name for the location. | |
tags | [Tag!] | A list of tags. | |
reference | String | Allows the location to be given a reference (branch/store) code. E.g. 14, SYD-0.1. | |
sequence | Int | An optional number, describing the location's position in a sequence, useful to order locations for pick paths etc. | |
capabilities | [ICapability!] | The capabilities this location has! | |
isEnabled ⚠️ | Boolean | ⚠️ DEPRECATED
| |
enabled | Boolean! | Enabled or not. Disabled will prevent it from being used in activities | |
address | PostalAddress | The postal address of this location. | |
isAddressVerified | Boolean | Whether or not the address has been verified. | |
root | Location! | The location's root location e.g. warehouse | |
parent | Location | The location's parent, if nested. | |
lineage | String | Ancestry of the location, in the form | |
createdAt | DateTime! | When the location was created. | |
modifiedAt | DateTime! | When the location was modified. | |
point | GeoPoint | The location's coordinates (on Earth). | |
pointAccuracy | Float | The accuracy of location's coordinates, | |
relations | Relationships | Relationships the location has. | |
attributes | [ICustomAttribute!]! | Custom attributes on the account.
🤖: Modify with | |
input | ObjectAttributesInput | ||
attributeValue | String | A single key from the location's custom attributes. Tip: Use GraphQL aliases to fetch attributes as your own properties. See https://graphql.org/learn/queries/#aliases
Usage: | |
input | ObjectAttributeInput! | ||
documentation | DocumentationResult! | Documentation for this location. | |
input | DocumentationInput! | ||
printers ⚠️ | [JunglePrinter!] | The printers this location has! ⚠️ DEPRECATED
| |
barcode ⚠️ | String | ⚠️ DEPRECATED
| |
barcodes | [String] | Known barcode values, associated with the location. | |
collections | [FulfilmentCollect] | The pick up/click and collection fulfilments at this location. A location will need the Collect capability for collections to be assigned to it | |
state | CollectionState |
LocationCreateResult
Result for the locationCreate
mutation.
Field | Argument | Type | Description |
---|---|---|---|
location | Location | The location that was created. |
LocationListResult
Field | Argument | Type | Description |
---|---|---|---|
results | [LocationListResultEdge!]! | Any locations found | |
pageInfo | PageInfo! | Information on the number of locations to be listed |
LocationListResultEdge
LocationNotFound
Result for when a given location Id does not map to a Location
Field | Argument | Type | Description |
---|---|---|---|
message | String | Might explain why the location was not found |
LocationSetParent
Field | Argument | Type | Description |
---|---|---|---|
set | Boolean! | If true, the location had its parent set. |
Log
A message, or log of something that happened.
Field | Argument | Type | Description |
---|---|---|---|
severity | LogSeverity! | The severity of the log. | |
code | String! | ||
message | String! | ||
paths | [String!] | ||
at | DateTime! | When the log happened. |
McLeodConnection
A connection to the McLeod Accessories system
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
name | String! | The McLeod connection's name | |
locationIds | [String]! | For which locations should we send orders to McLeod? | |
url | String! | URL of the McLeod server (to which we send orders) | |
username | String! | Username for sending orders to McLeod | |
password | String! | Password for sending orders to McLeod | |
integration | Integration | This will always be McLeod for McLeod connections! | |
enabled | Boolean! | Toggle on if you want this connection to be enabled or not | |
connected | Boolean! | Is this connection working? | |
createdAt | DateTime! | When we connected to the system for the first time | |
createdBy | String! | Who connected to the system |
Modified
Triggered when an object is modified in Jungle.
Field | Argument | Type | Description |
---|---|---|---|
subject | ID! | The object Id that was modified. | |
subjectTypename | ID! | The | |
createdAt | DateTime! | When the object was modified. | |
createdBy | String | The human, integration, device etc that modified this object. | |
aid | ID | The account Id the object was modified in. | |
DNT | Boolean! | If true, do not save/keep this event. | |
attributes | [ICustomAttribute!] | The event's custom attributes. These are optional, and are not always present. |
Money
Amount of a specific currency. Used in payments, value, costs etc.
Field | Argument | Type | Description |
---|---|---|---|
currency | Currency! | The currency of the money | |
code | CurrencyCode! | The code of the currency | |
amount | Int! | The amount, whole number shifted by decimal places, if a decimal currency | |
amountAsFloat ⚠️ | Float! | Amount as float value, avoid using where possible ⚠️ DEPRECATED
| |
formatted ⚠️ | String! | The money as a formatted string. ⚠️ DEPRECATED
|
MoneyAdjustment
Adjustment applied to Money
Field | Argument | Type | Description |
---|---|---|---|
code | String! | Code for categorizing the adjustment. e.g. tax, discount, shipping. | |
name | String | Name of the adjustment. e.g. GST, VAT, Arizona state sales tax, 2021 member promotion, express courier. | |
description | String | Details on the adjustment. i.e. Why a certain carrier was picked, reason for taxation etc. | |
value | Money! | The adjustment cost/value/price. |
MoneyV1
Amount of a specific currency. Used in payments, value, costs etc.
Field | Argument | Type | Description |
---|---|---|---|
code | CurrencyCode! | The code of the currency. | |
amount | Decimal! | The amount of the currency. |
MutationFailure
Result when the mutation/command failed.
Field | Argument | Type | Description |
---|---|---|---|
ok | Boolean! | Will always be false. | |
code | String | A machine code that can used to identity the failure. | |
reason | String | A sentence on what went wrong. | |
logs | [Log!] |
MutationSuccess
Result when the mutation/command was successfully accepted.
Field | Argument | Type | Description |
---|---|---|---|
ok | Boolean! | Will always be true. | |
objects | [ObjectCreated!] | Created objects | |
logs | [Log!] |
Note
A note (comment) on an object in Jungle by a Jungle actor, user or integration.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | The note's unique identifier. | |
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
tags | [Tag!] | Tags on the note. | |
enabled | Boolean! | If visible/usable or not. | |
topic | String | A short summary/title/theme of the note. Optional. | |
contentType | String | The content type of the note. Usually text/plain. | |
content | String | The contents of the note. Do not trust this data | |
author | IAuthor | ||
object | IObject | The object the note was created against, if resolvable for the current user. | |
xids | ExternalIdResults! | The note's known external IDs. | |
input | ExternalIdsInput | ||
modifiedAt | DateTime | When the note was modified last, if at all. | |
createdAt | DateTime! | When the note was created. |
NoteResultNode
Field | Argument | Type | Description |
---|---|---|---|
node | Note |
NoteResults
Field | Argument | Type | Description |
---|---|---|---|
results | [NoteResultNode!]! | ||
pageInfo | SearchPageInfo! |
ObjectCreated
Describes a created object. Use the .id
, and the .typename
to fetch the object.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | The | |
typename | String! | The |
Order
A sales order... A request for items to be fulfilled to a customer.
Field | Argument | Type | Description |
---|---|---|---|
channel | Channel | The channel the sales order came from, if known. | |
id | ID! | The Order's ID. | |
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
reference | String! | A merchant or customer visible reference number. | |
source | IOrderSource | Where this sales order came from, if known | |
status | String | The order's current status. The status should be considered indicative, and not absolute. | |
statusInfo | OrderStatusInfo | The order's status info. Help with pretty labeling, custom naming for the order. | |
tags | [String!] | A list of tags( | |
billingAddress | PostalAddress | The billing address/contact information for the order | |
shippingAddresses | [PostalAddress!] | The shipping addresses and contact information for the order | |
customer | Customer | The customer who placed the order, if known. | |
lineItems | [OrderLineItem!]! | The items with in the order | |
input | OrderLineItemsInput | ||
lineItemsQuantity | Float! | The total number of products with in the order | |
orderedAt | DateTime! | When the order was created/confirmed. | |
receivedAt | DateTime! | When Jungle received the order. | |
closedAt | DateTime | When the order was closed, if the order still has fulfilments, and outstanding items it will not be closed | |
integrationReference ⚠️ | String | Integration reference. This is useful when the order comes from a integration and that integration requires a reference when communicating with the third party which would be different from a customer visible reference ⚠️ DEPRECATED
| |
isTest | Boolean | If the order is a test or not | |
noteFromCustomer ⚠️ | String | If a note/comment from the customer about the order was collected, store it here. Do not use this for internal notes. ⚠️ DEPRECATED
| |
priceTotal | Money | If supplied, the orders total price | |
allocations | [Allocation!] | Any allocations the order currently has. These will eventually turn into fulfilments. | |
input | AllocationsConnectionInput | ||
completedAt | DateTime | If known, when the order was completed. | |
cancelledAt | DateTime | The date and time when the order was cancelled. | |
cancelledReason | String | The reason the order was cancelled. | |
fulfilmentAllowed | Boolean! | If false, prevent order to be fulfilled (if enabled for account). | |
attributes | [ICustomAttribute!]! | Additional custom attributes on the order.
You may filter on the name.
🤖: Modify with | |
input | ObjectAttributesInput | ||
attributeValue | String | A single key from the order's custom attributes. Tip: Use GraphQL aliases to fetch attributes as your own properties. See https://graphql.org/learn/queries/#aliases
Usage: | |
input | ObjectAttributeInput! | ||
point | GeoPoint | If possible to know, this is coordinates of the order. | |
pointAccuracy | Float | The accuracy of the coordinates. See | |
createdAt | DateTime! | When the order was created in Jungle. | |
modifiedAt | DateTime | When the order was last modified in Jungle. | |
fulfilments | [IFulfilment!]! | Fulfilments (deliveries, collections, drop shippers, downloads etc) against this order. Orders can have many fulfilments, from a variety of services. NOTE: Only a maximum of 50 will return. An order may but generally wont have that many fulfilments. | |
lineItemsFulfilled | [OrderLineItem!]! | Line items in the Order that are fulfilled in someway. | |
lineItemsUnfulfilled | [OrderLineItem!]! | Line items in the Order that are not yet fulfilled. | |
returnQuantity | Int | Total number of returns against the order. | |
returnStatus | StatusInfo | Aggregated status of the order's returns. NULL if there is no returns, otherwise it will be the least complete status. | |
returns | ReturnResults | Returns against the order. |
OrderAllocatedEvent
Triggered when an Order is allocated to one or more locations.
Field | Argument | Type | Description |
---|---|---|---|
subject | ID! | The Order. | |
createdAt | DateTime! | When the order was allocated. | |
aid | ID | ||
createdBy | String | ||
orderId ⚠️ | ID | The Order's Id. ⚠️ DEPRECATED
|
OrderAllocationChangeForbidden
The allocation can not be modified.
Field | Argument | Type | Description |
---|---|---|---|
reason | String! | Why the allocation cannot be changed. |
OrderAllocationMoved
The allocation was moved/assigned a location.
Field | Argument | Type | Description |
---|---|---|---|
hadLocation | Boolean | True, if the allocation was assigned to a location previously. |
OrderAllocationSetShippingAddress
Field | Argument | Type | Description |
---|---|---|---|
message | String |
OrderCancellationForbidden
Outcome for the orderCancel
mutation.
The order can not be cancelled.
Field | Argument | Type | Description |
---|---|---|---|
reason | String! | Why the Order cannot be cancelled |
OrderCancelled
Triggered when an Order is cancelled.
Field | Argument | Type | Description |
---|---|---|---|
subject | ID! | The Order. | |
createdAt | DateTime! | When the order cancel mutation was called. | |
aid | ID | ||
createdBy | String | ||
cancelledAt | DateTime! | When the order was cancelled. This may be before Jungle was aware. | |
cancelledReason | String! | The reason for cancellation. | |
orderId ⚠️ | ID | The Order's Id. ⚠️ DEPRECATED
| |
alreadyCancelled | Boolean | True, if the order was already cancelled |
OrderConsumed
Triggered when Jungle is sent and consumes an Order from an external source.
Field | Argument | Type | Description |
---|---|---|---|
subject | ID! | The Order | |
createdAt | DateTime! | When the order was consumed. | |
aid | ID | ||
createdBy | String | The human, integration, device etc that sent the order. | |
orderId ⚠️ | ID | The Order's Id. ⚠️ DEPRECATED
|
OrderConsumedResult
Result for orderConsumeWithAllocations
mutation.
Field | Argument | Type | Description |
---|---|---|---|
orderId | ID | The jungle order id. |
OrderLineItem
An order item is a line item of an order
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | The order line item identifier. | |
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
tags | [Tag!] | Tags on the line item. | |
product | Product | The product associated with the line item. | |
productName | String | The item/product name | |
sku | SKU | The stock keeping unit. This associates this line item with your inventory. The value will be used to look up available inventory, and allocate inventory. | |
quantity | Float! | The amount of the product ordered | |
quantityFulfilled | Float | The number of units fulfilled/sent to customer. If NULL, it is not relevant. | |
weight | Weight | The line item weight, if known. | |
price | Money | The price of the individual line item. | |
unitPrice | Money | The price of an individual line item. | |
addedReason | String | The reason why this line was added, if one. | |
integrationReference ⚠️ | String | Integration reference. This is useful when the order comes from a integration and that integration requires a reference when communicating with the third party which would be different from a customer visible reference ⚠️ DEPRECATED
| |
actions | [IAction!] | Actions that may or may not be possible on a line item. | |
input | ActionInput | ||
attributes | [ICustomAttribute!]! | Additional custom attributes on the order line item.
🤖: Modify with | |
input | ObjectAttributesInput | ||
attributeValue | String | A single key from the order line item's custom attributes. Tip: Use GraphQL aliases to fetch attributes as your own properties. See https://graphql.org/learn/queries/#aliases
Usage: | |
input | ObjectAttributeInput! | ||
createdAt | DateTime! | When the order line item was created in Jungle. | |
modifiedAt | DateTime | When the order line item was last modified in Jungle. | |
cancelledAt | DateTime | If cancelled, when the line item was cancelled. | |
cancelledReason | String | If cancelled, why the line item was cancelled. |
OrderLineItemCancelled
Field | Argument | Type | Description |
---|---|---|---|
subject | ID! | The line item id | |
createdAt | DateTime! | When the order was cancelled. | |
aid ⚠️ | ID | ⚠️ DEPRECATED
| |
createdBy | String | The human, integration, device etc that sent the order. |
OrderListFromJobResult
Field | Argument | Type | Description |
---|---|---|---|
results | [OrderListResultEdge!]! | ||
pageInfo | PageInfo! | Info on the number of orders that can be listed |
OrderListResult
Field | Argument | Type | Description |
---|---|---|---|
results | [OrderListResultEdge!]! | ||
pageInfo | PageInfo! | Info on the number of orders that can be listed |
OrderListResultEdge
OrderNotFound
Field | Argument | Type | Description |
---|---|---|---|
message | String |
OrderSetStatusResult
OrderSourceName
A simple way to describe the source of the order
Field | Argument | Type | Description |
---|---|---|---|
name | String | Shopify, ERP, POS etc | |
reference | String | A potentially meaningful reference for the source, such as an ID |
OrderStatusInfo
Order Status Info
This provides optional information on a status.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | Status ID, matches the value seen in | |
name | String | Formatted name for the status | |
displayOrder ⚠️ | Int | The display order of the status. Lower numbers show first. ⚠️ DEPRECATED
| |
priority | Int | The display priority of the status. Higher numbers show first. | |
color | HexColorCode | An optional color for the status |
OrderStatusInfoResult
Result for the orderStatusInfo
query
Field | Argument | Type | Description |
---|---|---|---|
statuses | [OrderStatusInfo!] | Information on known account statuses. |
Package
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
reference | String | ||
weightGross | Weight | ||
articleId | String | ||
consignmentId | String | ||
barcodeId ⚠️ | String | ⚠️ DEPRECATED
| |
authorityToLeave | Boolean | ||
safeDropEnabled | Boolean | ||
allowPartialDelivery ⚠️ | Boolean | ⚠️ DEPRECATED
|
PageInfo
Explains paging information on the relating result set
Field | Argument | Type | Description |
---|---|---|---|
hasMore | Boolean! | If true, there are additional results available | |
limit | Int! | The current limit of results returned (replays the value you set, or it defaulted to) | |
nextCursor | ID | The next cursor to send to, send to next request |
PartNumber
PartNumberResultNode
Field | Argument | Type | Description |
---|---|---|---|
node | PartNumber |
PartNumberResults
Field | Argument | Type | Description |
---|---|---|---|
pageInfo | SearchPageInfo | ||
results | [PartNumberResultNode] |
PostalAddress
An address for retail shipments.
Field | Argument | Type | Description |
---|---|---|---|
countryCode | CountryCode! | The country code, provided as the two-letter ISO 3166-1 alpha-2 country code. E.g AU, US, CN. | |
postalCode | String! | The post or zip code. E.g. 90210, 3000, SW1W 0NY. | |
suburb | String! | Locality in which the address is in. E.g. Melbourne. | |
region | String | Administrative division of the address. States, provinces etc. E.g. NSW, Nagano, California | |
lines | [String!]! | The street number, name & other important specific addressing. | |
contactPerson | ContactPerson | The contact information of the person, organization, firm, company, or institution at the address. | |
country | Country | Country data, useful for showing country name, flag, other information. | |
point | GeoPoint | The geo point of the address, on earth | |
isVerified ⚠️ | Boolean | ⚠️ DEPRECATED
|
PostalAddressChanged
Field | Argument | Type | Description |
---|---|---|---|
subject | ID! | ||
aid | ID | ||
createdAt | DateTime! | ||
createdBy | String | ||
address | PostalAddress! | ||
addressPrior | PostalAddress |
PrintSubmitted
The print has been submitted
Field | Argument | Type | Description |
---|---|---|---|
submitted | Boolean |
PrinterListResult
Field | Argument | Type | Description |
---|---|---|---|
results | [PrinterListResultEdge!]! |
PrinterListResultEdge
Field | Argument | Type | Description |
---|---|---|---|
printer | JunglePrinter! |
PrinterNotFoundError
The printer does not exist
Field | Argument | Type | Description |
---|---|---|---|
message | String! |
Product
A thing that is in your business. Sold or used.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | Product's ID. | |
path ⚠️ | ID! | Full path to the product. ⚠️ DEPRECATED
| |
idQR | ID | Contents for a Jungle QR code that identifies the product. | |
name | String | The product title/name. | |
gtin | [String!] | Global Trade Item Numbers. Should be UPC, EAN, JAN, GS1 or ISBN. See https://www.gs1.org/standards/id-keys/gtin | |
sku | String | SKU for the product. Relates the product to inventory. This value will be used to look up and track available inventory. | |
tags | [String!] | A list of tags( | |
capabilities | [ICapability!] | The capabilities this product has! Things like the product can be used for packaging, or some other consumable. | |
brand | String | The product's brand. | |
description | String | A generic description on the product. | |
dimensions | Dimensions | The product's physical dimensions. | |
weight | Weight | The product's weight (in grams). | |
hsCode | HsCode | Harmonized System (HS) code for the product (if applicable). | |
dangerousGoods | ProductDangerousGoods | Dangerous goods details. | |
leadTime | Duration | General lead time. Used to generally indicate how long it takes to get the product from suppliers, manufacturers etc. e.g. P1D, P2W, P3M. | |
eta | DateTime | Estimated availability or arrival. Used to generally indicate a date when the product is expected to be available for use, or sales, etc. Useful when allowing preorders or a leadTime isn't specific enough. e.g. 2199-10-28. | |
preorder | Boolean! | Toggle if a product can be sold or promised before it is available. i.e. Allow selling when there is no stock currently available. e.g. true, false. | |
gst | Boolean | If the product is subject to GST. | |
cost | MoneyV1 | General cost of the product. Not applicable to any particular supplier, and is mostly informational. | |
costAverage | MoneyV1 | The average cost of the product, based on purchasing history with in the last year. If NULL, not yet calculated, can't be calculated (not been purchased), or the feature is not enabled. | |
costLandedAverage | MoneyV1 | The average cost of the product, including shipping, taxes, and other costs to get it to your locations. If NULL, not yet calculated, can't be calculated or the feature is not enabled. | |
attributes | [ICustomAttribute!]! | Additional custom attributes on the product. You can filter on the name. | |
input | ObjectAttributesInput | ||
attributeValue | String | A single key from the product's custom attributes. Tip: Use GraphQL aliases to fetch attributes as your own properties. See https://graphql.org/learn/queries/#aliases
Usage: | |
input | ObjectAttributeInput! | ||
createdAt | DateTime! | When the product was first known to Jungle. | |
modifiedAt | DateTime | When the product was last modified. | |
documentation | DocumentationResult! | Documentation for this product. | |
input | DocumentationInput! | ||
xids | ExternalIdResults! | The products's known external IDs. | |
input | ExternalIdsInput | ||
unitEachAlias | String | If set, the provided value will be used to describe the base unit of measure (instead of the word | |
partNumber | String | The unique identifier, assigned by the given supplier, to identify this product within their internal systems. | |
input | PartNumberInput | ||
partNumbers | PartNumberResults | A list of unique identifier, assigned by a supplier, to identify this product within their internal systems. | |
shipsAsPackages | [ProductShipsAsPackage!] | The packages this product is shipped in. E.g. A large product with a single SKU which is shipped in multiple separate packages. | |
inventory | InventoryListResult | ||
input | ProductInventoryInput | ||
barcode ⚠️ | String | ⚠️ DEPRECATED
| |
barcodes | [String] | Known barcode values, associated with the product. |
ProductAttribute
Custom attributes on the product
ProductDangerousGoods
Product's dangerous goods details.
Field | Argument | Type | Description |
---|---|---|---|
UNNumber | String! | UN number, a four-digit number that identifies hazardous materials, and articles in the framework of international transport. |
ProductShipsAsPackage
Field | Argument | Type | Description |
---|---|---|---|
description | String | The package's description. E.g. My Product - Box 1 of 3. | |
dimensionsOuter | Dimensions | The package's dimensions. | |
weight | Weight | The package's weight (in grams). | |
value | MoneyV1 | The package's value. | |
barcodes | [String] | Known barcode values, associated with the product package. All of these should also exist on the Product itself. |
PurchaseOrder
Field | Argument | Type | Description |
---|---|---|---|
supplier | Supplier | The selected supplier for the purchase. Will need to be set to place/send the PO. | |
id | ID! | ||
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
reference | String! | A merchant or customer visible reference number | |
number | String | The order number. | |
description | String | A useful description of what the purchase order is for. e.g. Automatic replenishment of under minimum inventory. | |
status | PurchaseOrderStatus! | Purchase order status The status should be considered indicative, and not absolute. | |
lineItemsCount | Int! | The number of line items in the purchase order. | |
lineItemsQuantity | Float! | The total quantity of items in the purchase order. Use for display purposes online. | |
lineItems | [LineItem!]! | The line items within the purchase order | |
receiveItems | [PurchaseOrderReceiveItem!]! | The receive items within the purchase order | |
price | Money | Purchase order price excluding adjustments | |
adjustments | [MoneyAdjustment!] | The adjustments applied to price | |
totalPrice | Money | Purchase order total price including adjustments | |
orderedAt | DateTime | When the PO was sent to the supplier. | |
estimatedAt | DateTime | If known, when this PO is estimated to be fulfilled. | |
closedAt | DateTime | When the PO was closed. | |
completedAt | DateTime | When the PO was completed | |
orderedFrom | Location | Location where the PO was ordered from | |
orderedTo | Location | Location where the PO ordered to | |
splitFrom | PurchaseOrder | The purchase order that this purchase order was split from. | |
splitFromRoot | PurchaseOrder | The root purchase order that this purchase order was split from. | |
attributes | [ICustomAttribute!]! | Additional custom attributes on the purchase order.
🤖: Modify with | |
input | ObjectAttributesInput | ||
attributeValue | String | A single key from the purchase order's custom attributes. Tip: Use GraphQL aliases to fetch attributes as your own properties. See https://graphql.org/learn/queries/#aliases
Usage: | |
input | ObjectAttributeInput! | ||
tags | [Tag!] | A list of tags( e.g. 🕔, ❗, urgent
🤖: Modify using the | |
createdAt | DateTime! | When the purchase order was created in Jungle. | |
modifiedAt | DateTime | When the PO was last modified. | |
enabled | Boolean! | If this purchase order is active, or not. | |
xids | ExternalIdResults! | The purchase order's known external IDs. | |
input | ExternalIdsInput | ||
supplierInvoiceReference | String | Reference to the supplier invoice corresponding to this purchase order |
PurchaseOrderImport
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | The ID of the purchase order import. | |
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
status | String | The status of the purchase order import. | |
completedAt | DateTime | When the purchase order import was completed. | |
state | PurchaseOrderImportState | The state of the purchase order import. | |
attributes | [ICustomAttribute!]! | Additional custom attributes on the purchase order import.
🤖: Modify with | |
input | ObjectAttributesInput | ||
attributeValue | String | A single key from the purchase order import's custom attributes. Tip: Use GraphQL aliases to fetch attributes as your own properties. See https://graphql.org/learn/queries/#aliases
Usage: | |
input | ObjectAttributeInput! | ||
tags | [Tag!] | A list of tags( | |
createdAt | DateTime! | When the purchase order import was created in Jungle. | |
modifiedAt | DateTime! | When the purchase order import was last modified in Jungle. |
PurchaseOrderImportResult
Field | Argument | Type | Description |
---|---|---|---|
csvOriginal | String | The original CSV uploaded. | |
csvSuccess | String | The original CSV with just the successful lines, with additional columns: purchaseOrderCreatedId, purchaseOrderCreatedReference and error | |
csvFailed | String | The original CSV with just the failed lines, with additional columns: error |
PurchaseOrderImportState
Field | Argument | Type | Description |
---|---|---|---|
result | PurchaseOrderImportResult | The result of the purchase order import. | |
summary | PurchaseOrderImportSummary | The summary of the purchase order import. |
PurchaseOrderImportSummary
Field | Argument | Type | Description |
---|---|---|---|
quantityTotalLines | Int! | The total number of lines in the CSV. | |
quantityPurchaseOrdersCreated | Int! | The number of successfully created purchase orders. | |
quantitySuccess | Int! | The number of lines successfully processed. | |
quantityPending | Int! | The number of lines pending to be processed. | |
quantityFailed | Int! | The number of lines failed to process. |
PurchaseOrderInboundItem
Field | Argument | Type | Description |
---|---|---|---|
order | PurchaseOrder | Source of which the inbound sku ordered from | |
quantityOrdered | Float! | The quantity ordered | |
quantityReceived | Float! | The current received quantity | |
quantityInbound | Float! | The current incoming quantity. i.e. Ordered from a supplier, but has not yet been received. |
PurchaseOrderInboundItemBySkuResult
Result for the purchaseOrderInboundItemBySku
query
Field | Argument | Type | Description |
---|---|---|---|
results | [PurchaseOrderInboundItem!]! | The list of objects that matched the search | |
pageInfo | SearchPageInfo! | Paging information on the number of results found |
PurchaseOrderLineItemResults
A paginated list of purchase order line items associated with the parent object.
Field | Argument | Type | Description |
---|---|---|---|
nodes | [LineItem!]! | A list of line items. if any. |
PurchaseOrderReceiveItem
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ID of the receive item | |
path ⚠️ | ID! | Path of the receive item ⚠️ DEPRECATED
| |
sku | SKU! | Product SKU | |
condition | String | Product condition, e.g. damaged, new, mislabeled | |
qty | Float! | Quantity received | |
to | Location | Receive location | |
description | String | Description of the receive item | |
createdAt | DateTime! | When the item was created in Jungle. | |
modifiedAt | DateTime | When the item was last modified. | |
inventoryMovement | InventoryMovement | Inventory movement for the receive item |
PurchaseReturn
A request to return items from a supplier.
Field | Argument | Type | Description |
---|---|---|---|
supplier | Supplier | The selected supplier for the purchase. Will need to be set to place/send the PO. | |
id | ID! | ||
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
reference | String! | A merchant visible reference | |
integrationReference | String | This is useful when the return comes from a integration and that integration requires a reference when communicating with the 3rd party which would be different from a customer visible reference. | |
approved | Boolean | ||
approvedAt | DateTime | When the return was approved in Jungle. | |
lineItemsCount | Int! | The number of line items in the return. | |
lineItemsQuantity | Float! | The total quantity of items in the return. 🤖: Use for display purposes online. | |
lineItemsReturning | ReturnLineItemResults | The line items to be returned. | |
allocations | AllocationResults | The allocations on the return. | |
locationFrom | Location | The location to return stock from, when the purchase return was first created. The actual "from" location is subject to changes at any time, by changing the corresponding allocation's location. | |
estimatedAt | DateTime | If known, when this return is estimated to be completed/sent. | |
completedAt | DateTime | When the return was sent | |
actions | [IAction!] | Actions the current user can perform on this purchase return. | |
input | ActionInput | ||
attributes | [ICustomAttribute!]! | Additional custom attributes on the purchase return.
🤖: Modify with | |
input | ObjectAttributesInput | ||
attributeValue | String | A single key from the supplier return's custom attributes. Tip: Use GraphQL aliases to fetch attributes as your own properties. See https://graphql.org/learn/queries/#aliases
Usage: | |
input | ObjectAttributeInput! | ||
tags | [Tag!] | A list of tags( | |
createdAt | DateTime! | When the return was created in Jungle. | |
modifiedAt | DateTime | When the return was last modified in Jungle. |
ReasonCode
Reason codes are prerecorded reasons for why something is being done.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | The reason code ID. | |
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
tags | [Tag!] | A list of tags. | |
attributes | [ICustomAttribute!]! | Custom attributes on the account.
🤖: Modify with | |
input | ObjectAttributesInput | ||
attributeValue | String | A single key from the reason code's custom attributes. Tip: Use GraphQL aliases to fetch attributes as your own properties. See https://graphql.org/learn/queries/#aliases
Usage: | |
input | ObjectAttributeInput! | ||
enabled | Boolean! | If the reason code can be used, or not. | |
code | String! | The internal code, used for reporting purposes. | |
scope | String! | The action that the reason code can be used for. | |
description | String | Description of the reason, when it's used etc. | |
reasonInput | String | A formatted version of the reason code to put in to reason input. | |
createdAt | DateTime! | When the reason code was created. | |
modifiedAt | DateTime | When the reason code was last modified. |
ReceiveItem
A receive item is a product that has been received into Jungle. The receive item records what was received, by who, when, where and what it was reconciled against.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | The receive item's ID. | |
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
product | Product | The product (if there is one) associated with this receive item. | |
sku ⚠️ | SKU! | The stock keeping unit. This associates this receive item with your inventory. The value will be used to look up available inventory, and allocate inventory. ⚠️ DEPRECATED
| |
name | String | The title or name of the receive item. | |
condition | String | The condition of the receive item. | |
description | String | The description of the receive item. | |
location | Location | The location the item received at. i.e A store, shelf, van etc. | |
quantity | Float! | The amount of units, must be greater than 0. e.g. 2 Each, 24 Hrs, 2.3 Kilograms. | |
quantityToReconcile | Float | The amount of unit remaining to reconcile. | |
to | ReceiveItemReceiveTarget | Optional initial target for receive. e.g. Supplier, PurchaseOrder, LineItem. Note that a receive item can be reconciled to different target then what it was received against. | |
reconciled | Boolean! | If the receive item has been reconciled. | |
reconciledAt | DateTime | When the receive item reconciled. | |
reconciledTo | ReceiveItemReconcileTarget | Optional target for reconciliation. e.g. PurchaseOrderLineItem, LineItem. | |
receivedAt | DateTime | When the receive item received. | |
targets | [ReceiveItemTarget!]! | Objects this receive item is associated with. | |
reasonCode | ReasonCode | Reason why this item was received. | |
reason | String | The reason why this line was received, if known. | |
attributes | [ICustomAttribute!]! | Additional custom attributes on the receive item.
🤖: Modify with | |
input | ObjectAttributesInput | ||
attributeValue | String | A single key from the receive item's custom attributes. Tip: Use GraphQL aliases to fetch attributes as your own properties. See https://graphql.org/learn/queries/#aliases
Usage: | |
input | ObjectAttributeInput! | ||
tags | [Tag!] | A list of tags( | |
createdAt | DateTime! | When the receive item was created. | |
modifiedAt | DateTime! | When the receive item was last modified. | |
createdBy | String! | Who created the receive item. |
ReceiveItemResult
Result for receive item results.
Field | Argument | Type | Description |
---|---|---|---|
node | ReceiveItem |
ReceiveItemResults
Results for received items.
Field | Argument | Type | Description |
---|---|---|---|
results | [ReceiveItemResult!]! | ||
pageInfo | PageInfo! | Paging information on the received item results. |
RelationshipGroupToMany
A relationship that can have more than one member.
Field | Argument | Type | Description |
---|---|---|---|
name | String! | The name of the relationship. | |
createdAt | DateTime | If known, when the relationship was created. | |
edges | [RelationshipMemberEdge!]! | Members of the relationship. |
RelationshipGroupsConnection
Field | Argument | Type | Description |
---|---|---|---|
edges | [RelationshipEdge!] |
RelationshipMemberEdge
A member of a relationship.
Field | Argument | Type | Description |
---|---|---|---|
path | ID | The | |
node | ObjectCreated | ||
createdAt | DateTime | If known, when the relation was created. |
Relationships
Field | Argument | Type | Description |
---|---|---|---|
groups | RelationshipGroupsConnection | A list of relationships this object has. i.e. Fulfilments related to an Order. You should consider the parent to be the source node in edge resolution. Be aware that relationships do not arbitrarily restrict member types.
You can and will find unexpected object types in a relationship, and the client is expected to handle it.
Though this can be as simple as ignore types not related to your workflow.
i.e. Under fulfilments there could be a | |
input | RelationshipGroupsInput |
RetailExpressConnection
A connection to a Retail Express account
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
name | String! | The Retail Express connection's name | |
integration | Integration | This will always be RetailExpress for Retail Express connections! | |
enabled | Boolean! | Toggle on if you want this connection to be enabled or not | |
connected | Boolean! | Is this connection working? | |
createdAt | DateTime! | When we connected to the account for the first time | |
createdBy | String! | Who connected to the account | |
clientId | String! | Retail Express Client ID | |
clientUrl | URL! | The Retail Express Client URL - used as a fallback when a more specific URL is not provided | |
orderUrl | URL! | The Retail Express URL to which we send orders - overrides the clientUrl | |
username | String! | Retail Express Username | |
password | String! | Retail Express Password | |
salesChannelId | String! | Retail Express Sales Channel ID | |
customerIdOverride | PositiveInt | Retail Express Customer ID Override. If set, this ID is sent with every order |
RetailExpressCustomer
Field | Argument | Type | Description |
---|---|---|---|
retailExpressCustomerId | PositiveInt! | ID of the customer, as stored in Retail Express | |
firstName | String | Customer's first name | |
lastName | String | Customer's last name | |
String | Customer's email address | ||
phone | String | Customer's phone number | |
companyName | String | Customer's company name |
RetailExpressCustomerListResult
Field | Argument | Type | Description |
---|---|---|---|
results | [RetailExpressCustomer!]! |
Return
A request to return items from a customer.
Field | Argument | Type | Description |
---|---|---|---|
receiveItems | ReceiveItemResults | List of items received against this return. If any. | |
id | ID! | The return's ID. | |
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
reference | String! | Human-readable reference for the return. | |
source | ReturnSource | Source of the return. | |
locationTo | Location | Location where the items are being returned to. | |
fromAddress | PostalAddress! | The postal address where order is returned from. | |
accepted | Boolean | Whether the customer return is accepted. | |
acceptedAt | DateTime | When the customer return was accepted. | |
status | StatusInfo | Derived status from the customer return state. | |
received | Boolean | Whether the line items for the return fully received. | |
receivedAt | DateTime | When the customer return was fully received. | |
cancelledAt | DateTime | When the customer return was cancelled. | |
cancelledReason | String | The reason why the return was cancelled. | |
lineItems | LineItemResults! | The line items being/to be returned. | |
estimatedAt | DateTime | If known, when this return is estimated to be completed/sent. | |
completedAt | DateTime | When the return was completed, had all items received and all items sent. | |
serviceProviderName | String | The name of the company, or person providing the shipment/delivery service. | |
trackingNumber | String | The tracking code / id / number assigned to this shipment by the carrier. | |
trackingUrl | URL | A URL to see tracking events on the shipment. | |
actions | [IAction!] | Actions the current user can perform on this purchase return. | |
input | ActionInput | ||
attributes | [ICustomAttribute!]! | Additional custom attributes on the purchase order.
🤖: Modify with | |
input | ObjectAttributesInput | ||
attributeValue | String | A single key from the return's custom attributes. Tip: Use GraphQL aliases to fetch attributes as your own properties. See https://graphql.org/learn/queries/#aliases
Usage: | |
input | ObjectAttributeInput! | ||
tags | [Tag!] | A list of tags( | |
xids | ExternalIdResults! | The returns's known external IDs. | |
input | ExternalIdsInput | ||
createdAt | DateTime! | When the return was created in Jungle. | |
modifiedAt | DateTime | When the return was last modified in Jungle. |
ReturnLineItem
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
quantity | Float! | The quantity of the referenced line item to be returned. | |
sku | SKU | ||
productName ⚠️ | String | ⚠️ DEPRECATED
| |
lineItem | ILineItem | The line item from the sale or purchase this return is for. | |
createdAt | DateTime! | When this return line item was created. | |
modifiedAt | DateTime | When this return line item was modified. | |
tags | [Tag!] | Tags on the ReturnLineItem. | |
attributes | [ICustomAttribute!]! | Additional custom attributes on the allocation line item.
🤖: Modify with | |
input | ObjectAttributesInput | ||
attributeValue | String | A single key from the return line item's custom attributes. Tip: Use GraphQL aliases to fetch attributes as your own properties. See https://graphql.org/learn/queries/#aliases
Usage: | |
input | ObjectAttributeInput! | ||
actions | [IAction!] | Actions that can be performed on this return line item by the current user. | |
input | ActionInput | ||
product | Product | The product associated with this return line item. |
ReturnLineItemResult
Field | Argument | Type | Description |
---|---|---|---|
node | ReturnLineItem |
ReturnLineItemResults
Results for line items to be returned.
Field | Argument | Type | Description |
---|---|---|---|
results | [ReturnLineItemResult!]! | ||
pageInfo | PageInfo! |
ReturnReceived
Triggered whenever a Return is marked as received.
Field | Argument | Type | Description |
---|---|---|---|
subject | ID! | Return ID | |
createdAt | DateTime! | When the event was emitted. | |
aid | ID | The Id of the account the event occurred within. | |
createdBy | String | The human, integration, device etc that created this event. |
ReturnResult
Field | Argument | Type | Description |
---|---|---|---|
node | Return |
ReturnResults
Field | Argument | Type | Description |
---|---|---|---|
pageInfo | PageInfo! | ||
results | [ReturnResult!]! |
Role
Field | Argument | Type | Description |
---|---|---|---|
name | String |
SearchEdge
A connection edge in which each node is a Searchable
object.
Field | Argument | Type | Description |
---|---|---|---|
node | Searchable! | The object found. Tip: Use https://graphql.org/learn/queries/#inline-fragments |
SearchError
Field | Argument | Type | Description |
---|---|---|---|
message | String |
SearchFieldSummaries
Result for SearchResult.summaries
.
Field | Argument | Type | Description |
---|---|---|---|
field | String! | The field name the summarized values are for. | |
summary | [SearchFieldSummary] | The summarized values, limited to the top 100 values. |
SearchFieldSummary
Result for SearchResult.summary
.
Field | Argument | Type | Description |
---|---|---|---|
value | String! | A value of in the summarized field. | |
total | Int! | Total of number of results having the field's value. |
SearchPageInfo
Page information on the relating search result set.
Field | Argument | Type | Description |
---|---|---|---|
hasMore | Boolean! | If true, there are additional results available. | |
limit | Int! | The current limit of results returned (replays the value you set, or it defaulted to). | |
nextAfter | PositiveInt | The next after to send to, send for next page. | |
total | Int! | The total results found. At very large numbers this will not be accurate. |
SearchResult
Result for the search
query.
Field | Argument | Type | Description |
---|---|---|---|
results | [SearchEdge!]! | The list of objects that matched the search | |
pageInfo | SearchPageInfo! | Paging information on the number of results found | |
errors | [SearchError!] | If there isn't any results, check the search errors for information | |
summary ⚠️ | [SearchFieldSummary] | If requested, field value summary. This is limited to 100 values. ⚠️ DEPRECATED
| |
summaries | [SearchFieldSummaries] | If requested in |
SendleConnection
A connection between Sendle and Jungle!
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | The connection's ID. | |
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
name | String! | The sendle connection's name. This is auto-generated when created. | |
integration | Integration | Integration details, for branding, naming, logos etc | |
enabled | Boolean! | Toggle on if you want this connection to be enabled or not. | |
connected | Boolean! | ||
createdAt | DateTime! | ||
createdBy | String! | ||
sendleId | String! | The Sendle ID (which is the sendle account id) for this connection. | |
sendleSandbox | Boolean! | If this is from the Sendle sandbox server, or not. See: https://developers.sendle.com/reference/sendles-sandbox-server for details! |
Service
A service provided by an organisation.
Such as delivery, sales, inventory and pack services.
The service's provider could be you (where ever it is not specified/null), us (Jungle Commerce), or a 3rd party (Courier, 3PL, etc).
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | Service Id | |
name | String! | The name of the service. | |
description | String! | A description of the service. | |
code | ID | The providers own service code/identifier for this service | |
provider | ServiceProvider | When a service does not nominate a provider, your organisation is required to provide the service | |
category ⚠️ | ServiceCategory | The category of the service ⚠️ DEPRECATED
| |
categories | [ServiceCategory!] | The service categories, if it's a Shipment, Test service, etc. | |
connectionId | ID | The connection Id this service came from. NOTE: This only happens when there isn't additional selection logic to use the service, or the service comes from an integration. This matters when the service provider operates on account per location, or person principles. | |
integrationId | ID | The integration ID of the provider |
ServiceListResult
Field | Argument | Type | Description |
---|---|---|---|
results | [ServiceListResultEdge!]! |
ServiceListResultEdge
Field | Argument | Type | Description |
---|---|---|---|
service | IService! |
ServiceProvider
A business that provides services.
Field | Argument | Type | Description |
---|---|---|---|
name | String! | The name of the service provider | |
description | String | A description of the service provider | |
brandDisclaimer | String | If the provider has any brand disclaimers, it will be here. Should be shown near the branding, if provided | |
url | String | URL of the service provider's website | |
contacts | [IContact!] | Support/inquiry contacts for the service's provide |
Shipment
deprecated, use ShipmentV2 instead.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | Id of the shipment. | |
reference | String | A client reference. | |
serviceCode | String | ||
origin | PostalAddress! | ||
destination | PostalAddress! | The delivery address for the shipment. | |
packages | [Package!] | The packages containing the line items. | |
createdAt | DateTime! | When the shipment was created. | |
shippedAt ⚠️ | DateTime | ⚠️ DEPRECATED
| |
price | Money | ||
documentationSupported | [ID!] | Supported documentation Ids on this shipment. | |
integrationReference | String | Useful when an integration requires a reference when communicating with the third party which would be different from a customer visible reference. | |
documentation | DocumentationResult! | Documents for this shipment. | |
input | DocumentationInput! | ||
serviceBrokerName | String | ||
serviceProviderName | String | ||
serviceName | String | ||
trackingNumber | String | ||
trackingUrl | URL | ||
weightGross | Weight |
ShipmentAcceptance
Sometimes a shipment needs an additional human acceptance before we continue on.
Field | Argument | Type | Description |
---|---|---|---|
logs | [Log!] | If the shipment needs manual acceptance, this will contain logs of the reasons why. | |
createdAt | DateTime! | When the acceptance was created/evaluated. |
ShipmentAddress
Shipment origin and destination address.
Field | Argument | Type | Description |
---|---|---|---|
country | CountryCode! | The country code. e.g. AU, US, VN. | |
region | String | Generally a first-level administrative division, like a state. e.g. NSW, California, Ho Chi Minh City. | |
lines | [String!]! | Address lines, up to 3. | |
locality | String! | A suburb, or prefecture. e.g. Sydney, Mountain View, District 11. | |
postalCode | String! | A postal code. e.g 4001, 94043, SW1Y 4HT. |
ShipmentPackage
A shipment parcel, box, container etc.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
path ⚠️ | ID! | Path of the shipment package. ⚠️ DEPRECATED
| |
createdAt | DateTime! | When the shipment package was created (or requested). | |
modifiedAt | DateTime | When the shipment package was modified | |
reference | String | An optional reference for the package. | |
dimensions | Dimensions | The size of the package. | |
weightGross | Weight! | The gross (total) weight of the package. | |
shippingCode | String | The package's logic unit, SSCC, or article identifier. | |
trackingNumber | String | The unique number or code assigned to this package by the service provide for the purposes of tracking. | |
contents | [ShipmentPackageContent!] | The contents of the package | |
tracking | ShipmentTracking | Tracking data for the package |
ShipmentPackageConfirmed
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
weightGross | Weight | The gross (total) weight of the package. | |
trackingNumber | String | The unique number or code assigned to this package by the service provide for the purposes of tracking. |
ShipmentPackageContent
Contents of a shipment package.
Mostly concerned with value, customs and dangerous goods classification info.
Field | Argument | Type | Description |
---|---|---|---|
quantity | PositiveInt! | How many of the product there is. | |
sku | String | SKU for the product | |
description | String | A generic description on the product. | |
dangerousGoods | ProductDangerousGoods | Product's dangerous goods details. | |
hsCode | HsCode | Product's HS code details. | |
price | Money | The price of the individual product |
ShipmentReady
Triggered when a shipment is ready
Field | Argument | Type | Description |
---|---|---|---|
subject | ID! | Shipment id To retrieve the subject use the | |
createdAt | DateTime! | When the shipment was set to ready. | |
aid | ID | The Id of the account the event occurred within. | |
createdBy | String | The human, integration, device etc that created this event. | |
status | ShipmentStatus! | The current status of the shipment. | |
packages | [ShipmentPackageConfirmed!]! | The packages in the shipment. | |
priceGross | Money | Total cost of the shipment, inc taxes, etc. | |
integrationReference | String | Useful when an integration requires a reference when communicating with the third party which would be different from a customer visible reference. | |
serviceBrokerName | String | The broker used to book the shipment/delivery. | |
serviceProviderName | String | The name of the company, or person providing the shipment/delivery service. | |
serviceName | String | The name of the service used. | |
serviceId | String | The service id selected for the shipment | |
trackingNumber | String | The tracking code / id / number assigned to this shipment by the carrier. | |
trackingUrl | URL | A URL to see tracking events on the shipment. | |
attributes | [ICustomAttribute!] | The event's custom attributes. |
ShipmentServicesResult
Field | Argument | Type | Description |
---|---|---|---|
services | [IService] |
ShipmentTracking
Field | Argument | Type | Description |
---|---|---|---|
checkpoints | [ShipmentTrackingCheckpoint!]! |
ShipmentTrackingCheckpoint
Field | Argument | Type | Description |
---|---|---|---|
timestamp | DateTime | ||
locationString | String | ||
message | String | ||
status | ShipmentTrackingCheckpointStatus |
ShipmentTrackingUpdated
Field | Argument | Type | Description |
---|---|---|---|
subject | ID! | ||
aid | ID | ||
createdAt | DateTime! | ||
createdBy | String | ||
trackingNumber | String | ||
tracking | ShipmentTracking |
ShipmentV2
A Shipment.
A record of a delivery service request to move one more packages (containers) between two places.
NOTE: This replaces the Shipment
type.
HINT: To begin the process of shipping some packages call the shipmentCreate
mutation.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | Id of the shipment. | |
path ⚠️ | ID! | Path of the shipment. ⚠️ DEPRECATED
| |
idQR | ID | Contents for a Jungle QR code that identifies the shipment. | |
status | ShipmentStatus! | The current status of the shipment. | |
statusActivity | String | A sentence on the current activity being done on the shipment. For walking ape or other human readable places. | |
cancellable | Boolean | If true the shipment can be cancelled. | |
connection | IIntegrationConnection | The connection used to fulfill this shipment if available | |
reference | String | A client reference. | |
origin | ShipmentAddress! | Where the shipment is being picked up from. | |
destination | ShipmentAddress! | The delivery address of the shipment. | |
senderInstructions | String | ||
recipientInstructions | String | ||
packages | [ShipmentPackage!]! | The packages in the shipment. | |
createdAt | DateTime! | When the shipment was created (or requested). | |
modifiedAt | DateTime | When the shipment was modified | |
shippedAt | DateTime | When the shipment left the origin | |
pickUpOn | Date | ||
pickedUpAt | DateTime | ||
deliveredAt | DateTime | ||
priceGross | Money | Total cost of the shipment, inc taxes, etc. | |
integrationReference | String | Useful when an integration requires a reference when communicating with the third party which would be different from a customer visible reference. | |
serviceBrokerName | String | The broker used to book the shipment/delivery. | |
serviceProviderName | String | The name of the company, or person providing the shipment/delivery service. | |
serviceName | String | The name of the service used. | |
service | IService | The service selected for the shipment | |
trackingNumber | String | The tracking code / id / number assigned to this shipment by the carrier. | |
trackingUrl | URL | A URL to see tracking events on the shipment. | |
tracking | ShipmentTracking | Tracking data for the shipment, if available. | |
weightGross | Weight | The gross weight of the shipment. | |
acceptance | ShipmentAcceptance | Any pending acceptances on the shipment, that must be accepted before the shipment can be completed. If null, it was automatically accepted. | |
acceptedAt | DateTime | When the shipment was accepted. | |
errors | [Log!] | Errors on this shipment. Confirming is not possible until the errors are fixed. | |
logs | [Log!] | Logs for this shipment. | |
relations | Relationships | Relationships the shipment has. |
ShippitConnection
A connection between Shippit and Jungle!
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | The connection Id | |
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
name | String! | The connection's name | |
integration | Integration | Integration details, for branding naming etc | |
enabled | Boolean! | If the connection is enabled. | |
connected | Boolean! | If it is actually connected. | |
createdAt | DateTime! | When the connection to Shippit was created. | |
createdBy | String! | Who connect to Shippit. | |
shippitStaging | Boolean! | If the connection is to Shippit staging or not. | |
relations | Relationships | relationships this connection has |
SparesboxAllocationConnection
A connection to the Sparesbox Allocation Engine
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
path ⚠️ | ID! | Identity of the connection. ⚠️ DEPRECATED
| |
name | String! | ||
integration | Integration | ||
enabled | Boolean! | Toggle on if you want this connection to be enabled or not | |
connected | Boolean! | Is this connection working? | |
createdAt | DateTime! | When we connected to the engine for the first time | |
createdBy | String! | Who connected to the engine | |
engineVersion | String | version of the engine to use defaults to 1.0 |
StarshipitConnection
A connection between Starshipit and Jungle!
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | The connection Id | |
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
name | String! | The connection's name | |
integration | Integration | Integration details, for branding naming etc | |
enabled | Boolean! | If the connection is enabled. | |
connected | Boolean! | If it is actually connected. | |
createdAt | DateTime! | When the connection was created. | |
createdBy | String! | Who connected the integration. | |
relations | Relationships | relationships this connection has |
StatusInfo
Provides information on an object status.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
name | String! | Human-readable name of the status | |
color | String | The color for the status | |
icon | String | An icon for the status |
Supplier
Supplier sources products for your business.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | Supplier's ID. | |
path ⚠️ | ID! | Full path to the supplier. ⚠️ DEPRECATED
| |
createdAt | DateTime! | When the supplier was created in Jungle. | |
modifiedAt | DateTime | When the supplier was last modified. | |
name | String! | Supplier's name. | |
enabled | Boolean! | If this supplier is active, or not. | |
restrictedSupply | Boolean | Toggle geo-restrictions for this supplier allowing it to only be used for purchase orders in the locations specified | |
allowedLocations | [Location]! | list of locations that this supplier can be used to order inventory for through purchase ordering, ignored if | |
taxNumber | String | Used to store a business number or identifier with the relevant national taxation office ie: such as an ABN | |
currency | CurrencyCode | The currency to operate in with this supplier for purchase ordering | |
billingAddressLines ⚠️ | [String!] | Address lines where supplier is located ⚠️ DEPRECATED
| |
billingAddressPostalCode ⚠️ | String | Postal code of supplier's location ⚠️ DEPRECATED
| |
billingAddressRegion ⚠️ | String | Region of the supplier's location e.g. QLD ⚠️ DEPRECATED
| |
billingAddressSuburb ⚠️ | String | Suburb of the supplier's locations e.g. Fortitude Valley ⚠️ DEPRECATED
| |
billingAddressCountryCode ⚠️ | String | Postals code of the supplier's location e.g. 4006 ⚠️ DEPRECATED
| |
billingAddress | PostalAddress | The billing address of the supplier | |
relations | Relationships | Relationships the supplier has. | |
tags | [Tag!] | A list of tags. | |
attributes | [ICustomAttribute!]! | Custom attributes on the account.
🤖: Modify with | |
input | ObjectAttributesInput | ||
attributeValue | String | A single key from the supplier's custom attributes. Tip: Use GraphQL aliases to fetch attributes as your own properties. See https://graphql.org/learn/queries/#aliases
Usage: | |
input | ObjectAttributeInput! |
TagListResult
Result for the tagList
query.
Field | Argument | Type | Description |
---|---|---|---|
tags | [Tag!]! |
Transfer
A transfer of products between two locations.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
path ⚠️ | ID! | ⚠️ DEPRECATED
| |
reference | String! | A merchant visible reference | |
idQR | ID | Contents for a Jungle QR code that identifies the transfer. | |
approved | Boolean! | If the transfer is approved. 🤖: Use for display purposes only. | |
approvedAt | DateTime | When the transfer was approved. | |
lineItems | LineItemResults | Line items on the transfer. These are the items to be transferred. | |
lineItemsCount | Int! | The number of line items in the transfer. 🤖: Use for display purposes only. | |
lineItemsQuantity | Float! | The total quantity of items in the transfer. 🤖: Use for display purposes only. | |
allocations | AllocationResults | The allocations against the transfer. | |
locationFrom | Location! | The location to transfer stock from, when the transfer was first created. The actual "from" location is subject to changes at any time, by changing the corresponding allocation's location. | |
locationTo | Location! | The location to transfer stock to. | |
orderedAt | DateTime! | When the transfer was requested. | |
estimatedAt | DateTime | If known, when this transfer is estimated to be completed/sent. | |
fulfilledAt | DateTime | When the transfer was fulfilled. | |
completedAt | DateTime | When the transfer was received in and processed by the destination location. | |
actions | [IAction!] | Actions the current user can perform on this transfer. | |
input | ActionInput | ||
attributes | [ICustomAttribute!]! | Additional custom attributes on the transfer.
🤖: Modify with | |
input | ObjectAttributesInput | ||
attributeValue | String | A single key from the transfer's custom attributes. Tip: Use GraphQL aliases to fetch attributes as your own properties. See https://graphql.org/learn/queries/#aliases
Usage: | |
input | ObjectAttributeInput! | ||
tags | [Tag!] | A list of tags( | |
createdAt | DateTime! | When the transfer was created in Jungle. | |
modifiedAt | DateTime! | When the transfer was last modified in Jungle. |
UploadToken
A one time upload token.
Provides a URL to perform a file upload too. For each file / blob to be uploaded, request a unique token.
Field | Argument | Type | Description |
---|---|---|---|
url | URL! | The URL to upload the file too. | |
expiresAt | DateTime! | Date and time the token is valid until. | |
bytesMax | Int! | The max byte size that will be accepted. This can be increased in higher paid plans etc. |
User
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
String | |||
emailVerified | Boolean | ||
phoneNumber | String | ||
displayName | String | ||
fullName | String | ||
photoUrl | URL |
Webhook
Webhooks configured to submit events to for your account.
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | The webhook's identifier. | |
path ⚠️ | ID! | Full path to the webhook. ⚠️ DEPRECATED
| |
url | URL! | The URL to call when a matching action happens. | |
event | WebhookEvent! | The event this webhook will called. InventorySet as an example. | |
attributes | [ICustomAttribute!]! | Custom attributes on the account.
🤖: Modify with | |
input | ObjectAttributesInput | ||
attributeValue | String | A single key from the webhook's custom attributes. Tip: Use GraphQL aliases to fetch attributes as your own properties. See https://graphql.org/learn/queries/#aliases
Usage: | |
input | ObjectAttributeInput! | ||
createdAt | DateTime! | When the webhook was created in Jungle. | |
modifiedAt | DateTime | When the webhook was last modified. | |
tags | [Tag!] | Tags on the webhook. | |
enabled | Boolean! | If this webhook is active, or not. |
WhoAmIResult
Result for the whoami()
query
Field | Argument | Type | Description |
---|---|---|---|
user | User | If you are authenticated, this will be populated | |
account | Account | If you are authenticated, and have selected an account, this will be populated | |
accountUser | AccountUser | If you are authenticated, and have selected an account, this will be populated |
Inputs
AccountUserCreateInput
Field | Type | Description | |
---|---|---|---|
id | ID | ||
displayName | String | ||
photoUrl | URL | ||
phoneNumber | String | ||
pin | String! | ||
roles | [String!]! | ||
fullName | String! | ||
locationId | ID | ||
printerId | ID | ||
weighDeviceId | ID |
AccountUserDeleteInput
Field | Type | Description | |
---|---|---|---|
id | ID! |
AccountUserInviteInput
AccountUserUpdateInput
Field | Type | Description | |
---|---|---|---|
id | ID! | ||
displayName | String | ||
photoUrl | URL | ||
phoneNumber | String | ||
pin | String | ||
roles | [String!] | ||
fullName | String | ||
locationId | ID | ||
printerId | ID | ||
weighDeviceId | ID |
AccountUserUpgradeInput
ActionInput
Input for .actions
queries.
Field | Type | Description | |
---|---|---|---|
enabled | Boolean | Filter for only enabled or disabled actions. |
AddressValidationInput
Field | Type | Description | |
---|---|---|---|
street | String |
AllocationCreateInput
Input for an Allocation
.
Field | Type | Description | |
---|---|---|---|
name | String | The name of the allocation. e.g. #000001-A01 | |
method | FulfilmentMethod | The fulfilment method that should be used on this allocation (grouping of line items) HINT: If the line items are already fulfilled, use | |
shippingAddress | PostalAddressInput | The address to which this allocation group should be shipped to. This is not needed if the line items are not being shipped. | |
locationId | ID | A Jungle location ID where this is has been allocated to. This tells Jungle where to ship from or pick up from. It is possible for Jungle to set this during automatic fulfilment, or during allocation. It should be set when the fulfilment method is pick up. | |
locationForPickupId | ID | The location to pick this allocation up from. Only set this if if the allocation explicitly needs to be picked up from a location. | |
serviceCode | ID | A service code to fulfil the line items with. Service codes that do not offer fulfilment will be ignored. See Query | |
fulfilmentAllowed | Boolean | If false, prevent allocation to be fulfilled (if enabled for account). | |
attributes | [CustomAttributeInput!] | Allocation's custom attributes. | |
tags | [Tag!] | Tags to add to the allocation. | |
xids | [XIDInput!] | An additional identity for this allocation from an external system. An external ID can associate with at most 1 allocation. |
AllocationFulfilmentAllowInput
Field | Type | Description | |
---|---|---|---|
allocationId | ID! | ID of the allocation |
AllocationFulfilmentHoldInput
Field | Type | Description | |
---|---|---|---|
allocationId | ID! | ID of the allocation |
AllocationInput
Field | Type | Description | |
---|---|---|---|
name | String | The name of the allocation. e.g. #000001-A01 | |
method | FulfilmentMethod | The fulfilment method that should be used on this allocation (grouping of line items) HINT: If the line items are already fulfilled, use | |
shippingAddress | PostalAddressInput | The address to which this allocation group should be shipped to. This is not needed if the line items are not being shipped. | |
locationId | ID | A Jungle location ID where this is has been allocated to. This tells Jungle where to ship from or pick up from. It is possible for Jungle to set this during automatic fulfilment, or during allocation. It should be set when the fulfilment method is pick up. | |
locationForPickupId | ID | The location to pick this allocation up from. Only set this if if the allocation explicitly needs to be picked up from a location. | |
serviceCode | ID | A service code to fulfil the line items with. Service codes that do not offer fulfilment will be ignored. See Query | |
fulfilmentAllowed | Boolean | If false, prevent allocation to be fulfilled (if enabled for account). | |
attributes | [CustomAttributeInput!] | Allocation's custom attributes. | |
tags | [Tag!] | Tags to add to the allocation. | |
xids | [XIDInput!] | An additional identity for this allocation from an external system. An external ID can associate with at most 1 allocation. |
AllocationLineItemAssociateInput
Input for the allocationLineItemAssociate
mutation.
Field | Type | Description | |
---|---|---|---|
allocationId | ID! | ID of the allocation | |
lineItemId | ID! | ID of the allocatable line item (IAllocatableLineItem). By default. an amount of 0 items will be allocated. |
AllocationLineItemInput
Field | Type | Description | |
---|---|---|---|
lineItemId | ID! | ID of the allocatable line item (IAllocatableLineItem), if allocating something unallocated. | |
quantity | Float | The quantity of the referenced line item belonging to this allocation, if not provided default to lineItem's quantity |
AllocationLineItemMoveInput
Input for the allocationLineItemMove
mutation.
Field | Type | Description | |
---|---|---|---|
fromAllocationLineItemId | ID | ID of the source allocation line item, if moving between allocations. | |
toAllocationLineItemId | ID | ID of the target allocation line item. If omitted, its quantity will be removed by the given amount. | |
quantity | Float | Quantity to assign/move/remove. If omitted the maximum, that can be moved, will be moved. | |
reason | String! | Why is the allocation line item being moved. Be specific, as this will show in the event history. | |
key | String | An optional unique identifier for the allocation line item move for the source/target allocation line item. If provided, will only execute allocation line item move for the source/target allocation line item once per unique identifier. |
AllocationLineItemQuantityInput
Field | Type | Description | |
---|---|---|---|
sku | SKU | If set, only return the total number of products having this SKU |
AllocationMethodSetInput
Field | Type | Description | |
---|---|---|---|
allocationId | ID! | ID of the allocation | |
method | FulfilmentMethod! | Fulfilment method you want to change to. | |
serviceCode | ID | Shipping service code. Required for most shipping services. Optional for Click & Collect orders. |
AllocationSplitUnassignedInput
AllocationsConnectionInput
Field | Type | Description | |
---|---|---|---|
fulfilled | Boolean | Filter allocations based on whether they are allocated or not. |
AmxAllocationConnectEngineInput
Field | Type | Description | |
---|---|---|---|
name | String! | The AMX Allocation engine connection name | |
retailExpressConnectionId | String | Connection ID for sending orders to Retail Express | |
mcLeodConnectionId | String | Connection ID for sending orders to McLeod |
ApiKeyCreateInput
Field | Type | Description | |
---|---|---|---|
connectionId | ID |
AttachmentListInput
Field | Type | Description | |
---|---|---|---|
asset | ID! | ID of the asset this attachment belongs to. | |
type | AttachmentType! | Type of the attachment. |
AttachmentListV2Input
Field | Type | Description | |
---|---|---|---|
object | ObjectInputV2! | Path of the object to list attachments for. |
AttachmentPrintInput
Input for the attachmentPrint
mutation.
AttachmentUploadFromBase64Input
Input for the attachmentUploadFromBase64
mutation.
Field | Type | Description | |
---|---|---|---|
content | String! | The base64string you wish to decode and upload | |
contentType | String | Content type of the base64 content you are uploading. Defaults to | |
filename | String! | The file name of the attachment |
AttachmentUploadFromUrlInput
Input for the attachmentUploadFromUrl
mutation.
Field | Type | Description | |
---|---|---|---|
object | ObjectInputV2! | The object the URL download is being attached too. | |
url | URL! | The URL to download the attachment from. | |
headers | [KeyValueInput!] | Headers to pass through into the HTTP request. | |
filename | String | Optionally, the file name of the attachment. If not provided, one is used from the url, or made up. |
AttachmentUploadTokenInput
Input for the attachmentUploadToken
query.
Field | Type | Description | |
---|---|---|---|
object | ObjectInputV2! | The object the upload is being attached too. | |
filename | String | Optionally, the file name of the attachment. If not provided, one is made. |
AttributesSetInput
Input for the attributesSet
mutation.
Field | Type | Description | |
---|---|---|---|
object | ObjectInput! | ||
attributes | [CustomAttributeInput!]! | The object's custom attributes. |
AustraliaPostCredentialsInput
AuthKeyLoginInput
AuthListKeysInput
Field | Type | Description | |
---|---|---|---|
userId | ID! |
AuthSwitchAccountInput
Field | Type | Description | |
---|---|---|---|
aid | String! | The account to switch too |
BackorderAssociatePurchaseOrderLineItemInput
Input for the backorderAssociatePurchaseOrderLineItem
mutation.
Field | Type | Description | |
---|---|---|---|
backorderId | ID! | The id of the backorder to associate the PO line item. | |
lineItemId | ID! | The PO line item id to associate to the backorder. |
BackorderCancelInput
Input for the backorderCancel
mutation.
Field | Type | Description | |
---|---|---|---|
backorderId | ID! | The id of the backorder to cancel. |
BackorderCreateAllocationLineItemInput
Input for the purchaseOrderLineItemAssociateToBackorder
Field | Type | Description | |
---|---|---|---|
lineItemId | ID! | The allocation line item to associate too. | |
quantity | Float! | The quantity on backorder |
BackorderCreateInput
Input for the backorderCreate
mutation.
Field | Type | Description | |
---|---|---|---|
orderAllocationLine | BackorderCreateAllocationLineItemInput! | The order allocation line that backorder relates to. | |
reason | String! | The reason for the backorder. |
BackorderDissociatePurchaseOrderLineItemInput
Input for the backorderDissociatePurchaseOrderLineItem
mutation.
Field | Type | Description | |
---|---|---|---|
backorderId | ID! | The id of the backorder to dissociate the PO line item. | |
lineItemId | ID! | The PO line item id to dissociate from the backorder. |
BackorderQuantityUpdateInput
Input for the backorderQuantityUpdate
mutation.
Field | Type | Description | |
---|---|---|---|
backorderId | ID! | The id of the backorder to update quantity for. | |
quantity | Float! | The new quantity on backorder |
BarcodeAddInput
Input for the barcodeAdd
mutation.
Field | Type | Description | |
---|---|---|---|
object | ObjectInput! | The Jungle object to add known barcodes to. | |
barcodes | [BarcodeInput!]! | The barcodes to add. |
BarcodePrintInput
Input for the barcodePrint
mutation.
Field | Type | Description | |
---|---|---|---|
value | String! | Value of the barcode | |
symbology | BarcodeSymbology | Symbology. Defaults to Code128 | |
printTo | ID! | ID of the printer |
BarcodeRemoveInput
Input for the barcodeRemove
mutation.
Field | Type | Description | |
---|---|---|---|
object | ObjectInput! | The Jungle object to remove barcodes from. | |
barcodes | [BarcodeInput!]! | The barcodes to remove.
🤖: If the value of |
BrandCreateInput
Input for the brandCreate
mutation.
Field | Type | Description | |
---|---|---|---|
name | String! | Unique name for the brand. |
BrandSetNameInput
Input for the brandSetName
mutation.
CapabilitiesSetInput
Input for the capabilitiesSet
mutation.
Field | Type | Description | |
---|---|---|---|
object | ObjectInput! | The Jungle object to set capabilities on. | |
capabilityIds | [ID!]! | The capability ID's of the object's capabilities |
CapabilityConstraintsInput
Input for CapabilityConstraintsSetInput.constraints
.
Field | Type | Description | |
---|---|---|---|
enabled | Boolean | Constrain the capability to be enabled or disabled. This is useful for toggling capabilities on/off. | |
weightMin | Weight | Constrain the minimum weight of something. This is useful for packaging, transport that have minimum weight requirement etc. | |
weightMax | Weight | Constrain the maximum weight of something. This is useful for packaging, transport that have a maximum weight they can hold etc. | |
qtyMin | Int | Constrain the minimum quantity. | |
qtyMax | Int | Constrain the maximum quantity. | |
dimensionsInner | DimensionsInput | Constrain the inner dimensions of something. This is useful for knowing the available space in storage volumes etc. | |
dimensionsOuter | DimensionsInput | Constrain the outmost dimensions of something. This is useful to know if it can fit in certain volumes. | |
dimensionsOuterMin | DimensionsInput | Constrain the minimum outmost dimensions of something. This is useful to know if it is suitable to store something. | |
priority | Int | Constrain the priority of the capability. This is useful for ordering, or if a selection between objects with capabilities is needed. |