• • GraphQL Reference

• Queries

  • Query
  • Mutation

• Objects

  • AccountUsage
  • AmountType
  • App
  • AppVersion
  • Article
  • ArticleConnection
  • ArticleEdge
  • ArticleItem
  • ArticleItemConnection
  • ArticleItemEdge
  • Attribute
  • BillingAccount
  • BillingAccountConnection
  • BillingAccountEdge
  • BulkOperationOutput
  • Carrier
  • CarrierAttribute
  • CarrierAttributeConnection
  • CarrierAttributeEdge
  • CarrierConnection
  • CarrierConsignment
  • CarrierConsignmentArticle
  • CarrierConsignmentArticleConnection
  • CarrierConsignmentArticleEdge
  • CarrierConsignmentConnection
  • CarrierConsignmentEdge
  • CarrierDetails
  • CarrierDetailsConnection
  • CarrierDetailsEdge
  • CarrierEdge
  • CatalogueLink
  • Category
  • CategoryConnection
  • CategoryEdge
  • Comment
  • CommentConnection
  • CommentEdge
  • Consignment
  • ConsignmentArticle
  • ConsignmentArticleConnection
  • ConsignmentArticleEdge
  • ConsignmentConnection
  • ConsignmentEdge
  • Control
  • ControlConnection
  • ControlEdge
  • ControlGroup
  • ControlGroupConnection
  • ControlGroupEdge
  • CreditMemo
  • CreditMemoConnection
  • CreditMemoEdge
  • CreditMemoItem
  • CreditMemoItemConnection
  • CreditMemoItemEdge
  • CreditMemoLink
  • Currency
  • CurrencyConnection
  • CurrencyEdge
  • CurrencyLink
  • Customer
  • CustomerAddress
  • CustomerAddressConnection
  • CustomerAddressEdge
  • CustomerConnection
  • CustomerEdge
  • CustomerLink
  • DateRangeType
  • FinancialTransaction
  • FinancialTransactionConnection
  • FinancialTransactionEdge
  • Fulfilment
  • FulfilmentChoice
  • FulfilmentChoiceConnection
  • FulfilmentChoiceEdge
  • FulfilmentConnection
  • FulfilmentEdge
  • FulfilmentItem
  • FulfilmentItemConnection
  • FulfilmentItemEdge
  • FulfilmentLink
  • FulfilmentOption
  • FulfilmentOptionAddress
  • FulfilmentOptionConnection
  • FulfilmentOptionEdge
  • FulfilmentOptionProduct
  • FulfilmentPlan
  • FulfilmentPlanConnection
  • FulfilmentPlanEdge
  • FulfilmentPlanException
  • FulfilmentPlanFulfilment
  • FulfilmentPlanFulfilmentItem
  • GroupProduct
  • GroupProductConnection
  • GroupProductEdge
  • InventoryCatalogue
  • InventoryCatalogueConnection
  • InventoryCatalogueEdge
  • InventoryDataFilter
  • InventoryDestination
  • InventoryDestinationAttribute
  • InventoryFeed
  • InventoryFeedConnection
  • InventoryFeedEdge
  • InventoryFeedRun
  • InventoryFeedRunConnection
  • InventoryFeedRunEdge
  • InventoryPosition
  • InventoryPositionAggregateOutput
  • InventoryPositionConnection
  • InventoryPositionEdge
  • InventoryQuantity
  • InventoryQuantityAggregateOutput
  • InventoryQuantityConnection
  • InventoryQuantityEdge
  • InventorySource
  • InventoryUsage
  • InventoryUsageItem
  • InventoryUsageRange
  • Invoice
  • InvoiceConnection
  • InvoiceEdge
  • InvoiceItem
  • InvoiceItemConnection
  • InvoiceItemEdge
  • Location
  • LocationConnection
  • LocationEdge
  • LocationLink
  • Manifest
  • ManifestConnection
  • ManifestEdge
  • MetricInstant
  • MetricInstantData
  • MetricRange
  • MetricRangeData
  • Network
  • NetworkConnection
  • NetworkEdge
  • OpeningSchedule
  • OpeningScheduleConnection
  • OpeningScheduleEdge
  • Order
  • OrderBillingAddress
  • OrderBillingAddressConnection
  • OrderBillingAddressEdge
  • OrderConnection
  • OrderEdge
  • OrderItem
  • OrderItemConnection
  • OrderItemEdge
  • OrderItemLink
  • OrderLink
  • PageInfo
  • Payment
  • PaymentConnection
  • PaymentEdge
  • PaymentLink
  • PaymentServiceProvider
  • PaymentServiceProviderConnection
  • PaymentServiceProviderEdge
  • PaymentTransaction
  • PaymentTransactionConnection
  • PaymentTransactionEdge
  • Permission
  • PermissionConnection
  • PermissionEdge
  • Price
  • PriceConnection
  • PriceEdge
  • ProductCatalogue
  • ProductCatalogueConnection
  • ProductCatalogueEdge
  • ProductConnection
  • ProductEdge
  • ProductLink
  • QuantityType
  • RemoveCategoriesFromGroupProductOutput
  • RemoveCategoriesFromStandardProductOutput
  • RemoveCategoriesFromVariantProductOutput
  • RemoveFulfilmentsFromWaveOutput
  • RemoveLocationsFromNetworkOutput
  • RemoveNetworksFromLocationOutput
  • RemovePermissionsFromRoleOutput
  • RemoveUserRolesFromUserOutput
  • Retailer
  • RetailerConnection
  • RetailerEdge
  • RetailerLink
  • ReturnFulfilment
  • ReturnFulfilmentConnection
  • ReturnFulfilmentEdge
  • ReturnFulfilmentItem
  • ReturnFulfilmentItemConnection
  • ReturnFulfilmentItemEdge
  • ReturnOrder
  • ReturnOrderConnection
  • ReturnOrderEdge
  • ReturnOrderItem
  • ReturnOrderItemConnection
  • ReturnOrderItemEdge
  • ReturnOrderItemLink
  • ReturnOrderLink
  • ReturnVerification
  • ReturnVerificationConnection
  • ReturnVerificationEdge
  • Role
  • RoleConnection
  • RoleContext
  • RoleEdge
  • Setting
  • SettingConnection
  • SettingEdge
  • SettingValueType
  • StandardProduct
  • StandardProductConnection
  • StandardProductEdge
  • StorageArea
  • StorageAreaConnection
  • StorageAreaEdge
  • StoreAddress
  • StoreAddressConnection
  • StoreAddressEdge
  • StreetAddress
  • TaxType
  • UpdateStatusOutput
  • User
  • UserConnection
  • UserEdge
  • UserRole
  • VariantProduct
  • VariantProductConnection
  • VariantProductEdge
  • VectorInstant
  • VectorRange
  • VirtualCatalogue
  • VirtualCatalogueConnection
  • VirtualCatalogueEdge
  • VirtualInventory
  • VirtualInventoryConnection
  • VirtualInventoryEdge
  • VirtualPosition
  • VirtualPositionConnection
  • VirtualPositionEdge
  • Wave
  • WaveConnection
  • WaveEdge
  • WaveItem
  • WaveItemConnection
  • WaveItemEdge
  • WorkflowLink
  • __Directive
  • __EnumValue
  • __Field
  • __InputValue
  • __Schema
  • __Type

• Mutations

  • createArticle
  • createBillingAccount
  • createCarrier
  • createCarrierConsignment
  • createCategory
  • createComment
  • createConsignment
  • createControl
  • createControlGroup
  • createCreditMemo
  • createCreditMemoItem
  • createCustomer
  • createCustomerAddress
  • createFinancialTransaction
  • createFulfilment
  • createFulfilmentChoice
  • createFulfilmentOption
  • createFulfilmentPlan
  • createFulfilmentPlans
  • createGroupProduct
  • createInventoryCatalogue
  • createInventoryFeed
  • createInventoryFeedRun
  • createInventoryPosition
  • createInventoryQuantity
  • createInvoice
  • createInvoiceItem
  • createLocation
  • createManifest
  • createNetwork
  • createOrder
  • createOrderAndCustomer
  • createOrderItem
  • createPayment
  • createPaymentServiceProvider
  • createPaymentTransaction
  • createProductCatalogue
  • createRetailer
  • createReturnFulfilment
  • createReturnFulfilmentItem
  • createReturnOrder
  • createReturnOrderItem
  • createRole
  • createSetting
  • createStandardProduct
  • createStorageArea
  • createStoreAddress
  • createUser
  • createVariantProduct
  • createVirtualCatalogue
  • createVirtualPosition
  • createWave
  • removeCategoriesFromGroupProduct
  • removeCategoriesFromStandardProduct
  • removeCategoriesFromVariantProduct
  • removeFulfilmentsFromWave
  • removeLocationsFromNetwork
  • removeNetworksFromLocation
  • removePermissionsFromRole
  • removeUserRolesFromUser
  • updateArticle
  • updateBillingAccount
  • updateCarrier
  • updateCarrierConsignment
  • updateCategory
  • updateComment
  • updateConsignment
  • updateControl
  • updateControlGroup
  • updateCreditMemo
  • updateCustomer
  • updateCustomerAddress
  • updateFinancialTransaction
  • updateFulfilment
  • updateFulfilmentChoice
  • updateFulfilmentOption
  • updateFulfilmentPlan
  • updateGroupProduct
  • updateInventoryCatalogue
  • updateInventoryFeed
  • updateInventoryFeedRun
  • updateInventoryPosition
  • updateInventoryPositionsStatusByLocation
  • updateInventoryQuantitiesStatus
  • updateInventoryQuantity
  • updateInvoice
  • updateLocation
  • updateLocationPrimaryAddress
  • updateManifest
  • updateNetwork
  • updateOpeningSchedule
  • updateOrder
  • updatePayment
  • updatePaymentServiceProvider
  • updateProductCatalogue
  • updateRetailer
  • updateReturnFulfilment
  • updateReturnOrder
  • updateRole
  • updateSetting
  • updateStandardProduct
  • updateStorageArea
  • updateStoreAddress
  • updateUser
  • updateVariantProduct
  • updateVirtualCatalogue
  • updateVirtualPosition
  • updateVirtualPositionsStatusByGroup
  • updateWave

• Interfaces

  • Address
  • Extendable
  • Node
  • Orchestrateable
  • Product
  • Referenceable

• Enums

  • AppType
  • ExecutionMode
  • InventoryDataFormat
  • InventoryDataType
  • InventoryDestinationKey
  • InventoryDestinationType
  • InventoryFilterName
  • InventoryOperator
  • UsageGranularity
  • __DirectiveLocation
  • __TypeKind

• Unions

• Input Objects

  • AddressId
  • AmountTypeInput
  • ArticleId
  • AttributeInput
  • BaseLocationInput
  • BillingAccountKey
  • CarrierConsignmentArticleId
  • CarrierConsignmentKey
  • CarrierId
  • CarrierKey
  • CategoryKey
  • CommentId
  • ConsignmentArticleId
  • ConsignmentId
  • ControlGroupKey
  • ControlKey
  • CreateArticleInput
  • CreateArticleItemWithArticleInput
  • CreateBillingAccountInput
  • CreateCarrierConsignmentInput
  • CreateCarrierInput
  • CreateCategoryInput
  • CreateCommentInput
  • CreateConsignmentArticleWithConsignmentInput
  • CreateConsignmentInput
  • CreateControlGroupInput
  • CreateControlInput
  • CreateCreditMemoInput
  • CreateCreditMemoItemInput
  • CreateCreditMemoItemWithCreditMemoInput
  • CreateCustomerAddressInput
  • CreateCustomerInput
  • CreateFinancialTransactionInput
  • CreateFinancialTransactionWithOrderInput
  • CreateFulfilmentChoiceInput
  • CreateFulfilmentChoiceWithOrderInput
  • CreateFulfilmentInput
  • CreateFulfilmentItemWithFulfilmentInput
  • CreateFulfilmentOptionAddressInput
  • CreateFulfilmentOptionInput
  • CreateFulfilmentOptionProductInput
  • CreateFulfilmentPlanExceptionInput
  • CreateFulfilmentPlanFulfilmentInput
  • CreateFulfilmentPlanFulfilmentItemInput
  • CreateFulfilmentPlanInput
  • CreateFulfilmentPlansInput
  • CreateGroupProductInput
  • CreateInventoryCatalogueInput
  • CreateInventoryFeedInput
  • CreateInventoryFeedRunInput
  • CreateInventoryPositionInput
  • CreateInventoryQuantityInput
  • CreateInvoiceInput
  • CreateInvoiceItemInput
  • CreateInvoiceItemWithInvoiceInput
  • CreateLocationInput
  • CreateManifestInput
  • CreateNetworkInput
  • CreateNetworkWithRetailerInput
  • CreateOpeningScheduleInput
  • CreateOrderAndCustomerInput
  • CreateOrderBillingAddressInput
  • CreateOrderInput
  • CreateOrderItemInput
  • CreateOrderItemWithOrderInput
  • CreatePaymentInput
  • CreatePaymentServiceProviderInput
  • CreatePaymentTransactionInput
  • CreatePaymentTransactionWithPaymentInput
  • CreateProductCatalogueInput
  • CreateRetailerInput
  • CreateReturnFulfilmentInput
  • CreateReturnFulfilmentItemInput
  • CreateReturnFulfilmentItemWithReturnFulfilmentInput
  • CreateReturnOrderInput
  • CreateReturnOrderItemInput
  • CreateReturnOrderItemWithReturnOrderInput
  • CreateReturnVerificationInput
  • CreateReturnVerificationWithReturnOrderInput
  • CreateRoleInput
  • CreateSettingInput
  • CreateStandardProductInput
  • CreateStorageAreaInput
  • CreateStorageAreaWithLocationInput
  • CreateStoreAddressInput
  • CreateUserInput
  • CreateVariantProductInput
  • CreateVirtualCatalogueInput
  • CreateVirtualPositionInput
  • CreateWaveInput
  • CreditMemoItemKey
  • CreditMemoKey
  • CreditMemoLinkInput
  • CurrencyKey
  • CurrencyLinkInput
  • CustomerAddressId
  • CustomerId
  • CustomerKey
  • CustomerLinkInput
  • DateRange
  • FinancialTransactionKey
  • FulfilmentChoiceId
  • FulfilmentChoiceKey
  • FulfilmentId
  • FulfilmentKey
  • FulfilmentLinkInput
  • FulfilmentOptionId
  • FulfilmentPlanId
  • GeoCoordinateInput
  • GroupProductKey
  • InventoryCatalogueKey
  • InventoryDataFilterInput
  • InventoryDestinationAttributeInput
  • InventoryDestinationInput
  • InventoryFeedKey
  • InventoryFeedRunKey
  • InventoryPositionKey
  • InventoryPositionsLocationFilterInput
  • InventoryQuantityFilterInput
  • InventoryQuantityKey
  • InventorySourceInput
  • InvoiceItemKey
  • InvoiceKey
  • LocationId
  • LocationKey
  • LocationLinkInput
  • ManifestKey
  • NetworkId
  • NetworkKey
  • OrderId
  • OrderItemId
  • OrderItemLinkInput
  • OrderKey
  • OrderLinkInput
  • PaymentKey
  • PaymentLinkInput
  • PaymentServiceProviderKey
  • PaymentTransactionKey
  • PermissionKey
  • PriceInput
  • ProductCatalogueKey
  • ProductCatalogueLinkInput
  • ProductKey
  • ProductLinkInput
  • ProductQuantityInput
  • QuantityTypeInput
  • RemoveCategoriesFromGroupProductInput
  • RemoveCategoriesFromStandardProductInput
  • RemoveCategoriesFromVariantProductInput
  • RemoveFulfilmentsFromWaveInput
  • RemoveLocationsFromNetworkInput
  • RemoveNetworksFromLocationInput
  • RemovePermissionsFromRoleInput
  • RemoveUserRolesFromUserInput
  • RetailerId
  • RetailerLinkInput
  • ReturnFulfilmentItemKey
  • ReturnFulfilmentKey
  • ReturnOrderItemKey
  • ReturnOrderItemLinkInput
  • ReturnOrderKey
  • ReturnOrderLinkInput
  • RoleContextInput
  • RoleContextKey
  • RoleKey
  • SettingValueTypeInput
  • StandardProductKey
  • StatusInput
  • StorageAreaId
  • StoreAddressId
  • StreetAddressInput
  • TaxTypeInput
  • UpdateArticleInput
  • UpdateArticleItemWithArticleInput
  • UpdateBillingAccountInput
  • UpdateCarrierConsignmentInput
  • UpdateCarrierInput
  • UpdateCategoryInput
  • UpdateCommentInput
  • UpdateConsignmentInput
  • UpdateControlGroupInput
  • UpdateControlInput
  • UpdateCreditMemoInput
  • UpdateCreditMemoItemWithCreditMemoInput
  • UpdateCustomerAddressInput
  • UpdateCustomerInput
  • UpdateFinancialTransactionInput
  • UpdateFulfilmentChoiceInput
  • UpdateFulfilmentInput
  • UpdateFulfilmentItemWithFulfilmentInput
  • UpdateFulfilmentOptionInput
  • UpdateFulfilmentPlanInput
  • UpdateGroupProductInput
  • UpdateInventoryCatalogueInput
  • UpdateInventoryFeedInput
  • UpdateInventoryFeedRunInput
  • UpdateInventoryPositionInput
  • UpdateInventoryQuantityInput
  • UpdateInvoiceInput
  • UpdateInvoiceItemWithInvoiceInput
  • UpdateLocationInput
  • UpdateLocationPrimaryAddressInput
  • UpdateManifestInput
  • UpdateNetworkInput
  • UpdateOpeningScheduleInput
  • UpdateOrderBillingAddressInput
  • UpdateOrderInput
  • UpdateOrderItemWithOrderInput
  • UpdatePaymentInput
  • UpdatePaymentServiceProviderInput
  • UpdateProductCatalogueInput
  • UpdateRetailerInput
  • UpdateReturnFulfilmentInput
  • UpdateReturnFulfilmentItemInput
  • UpdateReturnFulfilmentItemWithReturnFulfilmentInput
  • UpdateReturnOrderInput
  • UpdateReturnOrderItemWithReturnOrderInput
  • UpdateReturnVerificationWithReturnOrderInput
  • UpdateRoleInput
  • UpdateSettingInput
  • UpdateStandardProductInput
  • UpdateStorageAreaInput
  • UpdateStorageAreaWithLocationInput
  • UpdateStoreAddressInput
  • UpdateUserInput
  • UpdateVariantProductInput
  • UpdateVirtualCatalogueInput
  • UpdateVirtualPositionInput
  • UpdateWaveInput
  • UserId
  • UserKey
  • UserRoleInput
  • UserRoleKey
  • VariantProductKey
  • VirtualCatalogueKey
  • VirtualPositionInput
  • VirtualPositionKey
  • VirtualPositionsGroupFilterInput
  • WaveId
  • WaveKey
  • WorkflowLinkInput

• Scalars

  • Boolean
  • DateTime
  • Float
  • ID
  • Int
  • Json
  • String

• Directives

  • deprecated
  • include
  • skip

CurrencyLink

Fields