Queries

See Types for further information regarding complex objects specified in any of our interfaces.

customers

Returns the customers corresponding to the given IDs.

Arguments

Name	Type	Description
ids	[String!]!	A list of customer IDs.

Output

Type	Description
[Customer]	The customers corresponding to the provided IDs.

Example

{
    customers(ids: ["00000000-0000-0000-0000-000000000000"]) {
        id
        emailAddress
        firstName
        lastName
    }
}

globalPropertyConfigurations

Returns the global property configurations corresponding to the given IDs.

Arguments

Name	Type	Description
ids	[String]!	A list of global property configuration IDs.

Output

Type	Description
[GlobalPropertyConfiguration]	The global property configurations corresponding to the provided IDs.

Example

{
    globalPropertyConfigurations(ids: ["00000000-0000-0000-0000-000000000000"]) {
        id
        aspects {
            name
            type
        }
    }
}

globalPropertyConfigurationsFeed

Returns a feed object that contains global property configurations.

Output

Type	Description
GlobalPropertyConfigurationsFeed	The feed object.

Example

{
    globalPropertyConfigurationsFeed {
        items {
            id
            aspects {
                name
                type
            }
        }
    }
}

globalPropertyState

Returns the global property state corresponding to the given ID of an object with shared state.

Arguments

Name	Type	Description
bundleId	GlobalPropertyState	ID of a bundle.

Output

Type	Description
GlobalPropertyState	The corresponding global property state.

Example

{
    globalPropertyState(bundleId: "00000000-0000-0000-0000-000000000000") {
        id
        aspects {
            name
            value
        }
    }
}

integrations

Returns the integrations corresponding to the given IDs.

Arguments

Name	Type	Description
ids	[String!]!	A list of integration IDs.

Output

Type	Description
[Integration]	The integrations corresponding to the provided IDs.

Example

{
    integrations(ids: ["00000000-0000-0000-0000-000000000000"]) {
        id
        type
        enabled
    }
}

metafieldConfigurationsFeed

Returns the metafield configurations corresponding to the given entity type.

Arguments

Name	Type	Description
entityType	String!	The type of entity to get metafields for. Supported types: Asset, Integration, Product, Variant, Workflow, WorkflowStep

Output

Type	Description
MetafieldConfigurationsFeed	The metafield configurations corresponding to the given entity type.

Example

{
    metafieldConfigurationsFeed(entityType: "Asset") {
        items {
            id
        }
    }
}

metafields

Returns the metafields belonging to the given entity.

Arguments

Name	Type	Description
entityId	String!	The ID of the entity to get metafields for.

note

IDs for entities of type WorkflowStep must be formed by combining the ID of the workflow and the step name with an underscore, e.g. for a step aaaabbbb-aaaa-aaaa-aaaa-aaaabbbbcccc inside workflow ddddeeee-dddd-dddd-dddd-ddddeeeeffff the entity ID would be ddddeeee-dddd-dddd-dddd-ddddeeeeffff_aaaabbbb-aaaa-aaaa-aaaa-aaaabbbbcccc.

Output

Type	Description
[Metafield]	The metafields belonging to the given entity.

Example

{
    metafields(entityId: "00000000-0000-0000-0000-000000000000") {
        id
    }
}

orders

Returns the orders corresponding to the given IDs.

Arguments

Name	Type	Description
ids	[String]	A list of order IDs.

Output

Type	Description
[Order]	The orders corresponding to the provided IDs.

Example

{
    orders(ids: ["00000000-0000-0000-0000-000000000000"]) {
        id
        createdAt
        externalId
        lineItems {
            id
        }
    }
}

orderStatusesFeed

Returns a feed of the authenticated partner's order statuses.

Output

Type	Description
OrderStatusesFeed	The feed for the authenticated partner.

Example

{
    orderStatusesFeed {
        items {
            id
            name
        }
        total
    }
}

outputData

Returns the output data corresponding to the given transaction IDs.

Arguments

Name	Type	Description
transactionIds	[String]	A list of transaction IDs.

Output

Type	Description
[OutputData]	The output data corresponding to the provided IDs.

Example

{
    outputData(transactionIds: ["00000000-0000-0000-0000-000000000000"]) {
        transactionId
        sku
        variantSelection {
            stepTitle
            variantName
        }
    }
}

processExecutions

Returns the flows in flight corresponding to the given IDs.

Arguments

Name	Type	Description
ids	[String]!	A list of IDs of flows in flight.

Output

Type	Description
[ProcessExecution]	The corresponding flows in flight.

Example

{
    processExecutions(ids: ["00000000-0000-0000-0000-000000000000"]) {
        id
        createdAt
    }
}

processExecutionsFeed

Returns a feed object that contains flows in flight matching the given criteria.

Arguments

Name	Type	Description
endDate	String!	The latest date that a returned item may have been created.
limit	Int!	The maximum amount of items to return.
offset	Int!	The amount of pages by which to offset the returned items.
startDate	String!	The earliest date that a returned item may have been created.

Output

Type	Description
ProcessExecutionsFeed	The corresponding feed object.

Example

{
    processExecutionsFeed(limit: 10, offset: 0, startDate: "2023-01-01", endDate: "2023-01-31") {
        items {
            id
            createdAt
        }
        total
    }
}

processFlowContexts

Returns the flow contexts corresponding to the given IDs.

Arguments

Name	Type	Description
ids	[String]	A list of IDs of flow contexts.

Output

Type	Description
[ProcessFlow]	The corresponding flow contexts.

Example

{
    processFlowContexts(ids: ["00000000-0000-0000-0000-000000000000"]) {
        id
        name
        description
    }
}

processFlowContextsFeed

Returns a feed object that contains flow contexts.

Output

Type	Description
ProcessFlowContextsFeed	The feed object.

Example

{
    processFlowContextsFeed {
        items {
            id
            name
            description
        }
    }
}

processFlows

Returns the flows corresponding to the given IDs.

Arguments

Name	Type	Description
ids	[String]!	A list of IDs of flows.

Output

Type	Description
[ProcessFlow]	The corresponding flows.

Example

{
    processFlows(ids: ["00000000-0000-0000-0000-000000000000"]) {
        id
        name
    }
}

processFlowsFeed

Returns a feed object that contains flows matching the given criteria.

Arguments

Name	Type	Description
limit	Int!	The maximum amount of items to return.
offset	Int!	The amount of pages by which to offset the returned items.
processFlowContextId	String	An optional flow context ID to filter by.

Output

Type	Description
ProcessFlowsFeed	The corresponding feed object.

Example

{
    processFlowsFeed(limit: 10, offset: 0) {
        items {
            id
            name
        }
        total
    }
}

products

Returns the products corresponding to the given IDs.

Arguments

Name	Type	Description
ids	[String]	A list of product IDs.

Output

Type	Description
[Product]	The products corresponding to the provided IDs.

Example

{
    products(ids: ["00000000-0000-0000-0000-000000000000"]) {
        id
        name
        profanities {
            word
        }
    }
}

tags

Returns the tags belonging to the given entity.

Arguments

Name	Type	Description
entityId	String!	The ID of the entity to get tags for.

note

IDs for entities of type WorkflowStep must be formed by combining the ID of the workflow and the step name with an underscore, e.g. for a step aaaabbbb-aaaa-aaaa-aaaa-aaaabbbbcccc inside workflow ddddeeee-dddd-dddd-dddd-ddddeeeeffff the entity ID would be ddddeeee-dddd-dddd-dddd-ddddeeeeffff_aaaabbbb-aaaa-aaaa-aaaa-aaaabbbbcccc.

Output

Type	Description
[Tag]	The tags belonging to the entity.

Example

{
    tags(id: "00000000-0000-0000-0000-000000000000") {
        id
    }
}

tagsFeed

Returns all existing tags for the given type of entity.

Arguments

Name	Type	Description
entityType	String!	The type of entity to get tags for. Supported types: Asset, Integration, Product, Variant, Workflow, WorkflowStep

Output

Type	Description
TagsFeed	The tags corresponding to the given entity type.

Example

{
    tagsFeed(entityType: "Asset") {
        items {
            id
        }
    }
}

transactions

Returns the transactions corresponding to the given IDs.

Arguments

Name	Type	Description
ids	[String]	A list of transaction IDs.

Output

Type	Description
[Transaction]	The transactions corresponding to the provided IDs.

Example

{
    transactions(ids: ["00000000-0000-0000-0000-000000000000"]) {
        id
        createdAt
        isOrdered
    }
}