Mutations

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

globalPropertyConfigurationCreate

Create a new global property configuration.

Output

Type	Description
GlobalPropertyConfiguration	The created global property configuration.

Example

mutation {
    globalPropertyConfigurationCreate {
        id
    }
}

globalPropertyConfigurationUpdate

Update an existing global property configuration.

Arguments

Name	Type	Description
id	String!	ID of the global property configuration to update.
name	String	Human-readable name for this configuration.
aspects	[GlobalPropertyConfigurationAspectInput]!	New values for the configuration's list of aspects.

Output

Type	Description
GlobalPropertyConfiguration	The updated global property configuration.

Example

mutation {
    globalPropertyConfigurationUpdate(id: "00000000-0000-0000-0000-000000000000", aspects: []) {
        id
    }
}

globalPropertyStateCreate

Create a new global property state.

Arguments

Name	Type	Description
bundleId	String	ID of a bundle that has shared state.

Output

Type	Description
GlobalPropertyState	The created global property state.

Example

mutation {
    globalPropertyStateCreate(bundleId: "00000000-0000-0000-0000-000000000000") {
        id
    }
}

globalPropertyStateUpdate

Update an existing global property state.

Arguments

Name	Type	Description
id	String!	ID of the global property state to update.
aspects	[GlobalPropertyConfigurationStateInput]!	New values for the state's list of aspects.

Output

Type	Description
GlobalPropertyState	The updated global property state.

Example

mutation {
    globalPropertyStateUpdate(
        id: "00000000-0000-0000-0000-000000000000"
        aspects: [{ name: "text", value: "Happy birthday!" }]
    ) {
        id
    }
}

metafieldConfigurationCreate

Create a new metafield configuration.

Arguments

Name	Type	Description
name	String!	The name of the new configuration.
entityType	String!	The type of entity that the new configuration is for. Supported types: Asset, Integration, Product, Variant, Workflow, WorkflowStep
metafieldType	String!	The type of value that metafields for the new configuration may accept. Supported Types: Boolean, Integer, Text
description	String	A description of the new configuration.

Output

Type	Description
MetafieldConfiguration	The created metafield configuration.

Example

mutation {
    metafieldConfigurationCreate(
        name: "Size"
        entityType: "Product"
        metafieldType: "Text"
        description: "The size of this product"
    ) {
        id
    }
}

metafieldConfigurationDelete

Delete a metafield configuration.

Arguments

Name	Type	Description
id	String!	The ID of the configuration to delete.

Output

Type	Description
String	The ID of the deleted configuration.

Example

mutation {
    metafieldConfigurationDelete(id: "00000000-0000-0000-0000-000000000000")
}

metafieldConfigurationUpdate

Update an existing metafield configuration.

Arguments

Name	Type	Description
id	String!	The ID of the configuration to update.
name	String	An updated name for the configuration.
description	String	An updated description of the configuration.

Output

Type	Description
MetafieldConfiguration	The updated configuration.

Example

mutation {
    metafieldConfigurationUpdate(id: "00000000-0000-0000-0000-000000000000", name: "outdated") {
        id
    }
}

metafieldCreate

Create a new metafield.

Arguments

Name	Type	Description
entityId	String!	The ID of the entity to add a metafield to.
metafieldConfigurationId	String!	The ID of the metafield configuration to use for this metafield.
value	String!	The serialized JSON of the value for this metafield.

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 created metafield.

Example

mutation {
    metafieldCreate(
        entityId: "00000000-0000-0000-0000-000000000000"
        metafieldConfigurationId: "00000000-0000-0000-0000-000000000000"
        value: "\"small\""
    ) {
        id
    }
}

metafieldDelete

Delete a metafield.

Arguments

Name	Type	Description
id	String!	The ID of the metafield to delete.

Output

Type	Description
String	The ID of the deleted metafield.

Example

mutation {
    metafieldDelete(id: "00000000-0000-0000-0000-000000000000")
}

metafieldUpdate

Update an existing metafield.

Arguments

Name	Type	Description
id	String!	The ID of the metafield to update.
value	String!	The serialized JSON of the new value for the given metafield.

Output

Type	Description
Metafield	The updated metafield.

Example

mutation {
    metafieldUpdate(id: "00000000-0000-0000-0000-000000000000", value: "\"medium\"") {
        id
    }
}

orderCreate

Create a new order in our system. This will display on the orders page of the relevant partner & fire any configured fulfillment logic as well.

Arguments

Name	Type	Description
externalId	String	An identifier used to reference an order in an external order management platform.
internalId	String	An internal identifier useful for situations where you need additional granularity over order ID when viewing orders in our backend portal.
orderItems	[OrderItemInput]	A list of OrderItemInput objects.
externalData	ExternalDataInput	A special metadata object references any additional information that may have been provided by an external system and should be bundled with the order itself
paid	Boolean	Whether to mark the newly created order as having been paid for by the customer.

Output

Type	Description
Order	The newly created order.

Example

mutation {
    orderCreate(
        externalId: "ext-123"
        orderItems: [{ amountToOrder: 2, transactionId: "00000000-0000-0000-0000-000000000000" }]
        internalId: "int-123"
        externalData: { orderNumber: "123" }
    ) {
        id
        lineItems {
            id
            quantity
            createdAt
        }
    }
}

orderCreateSimpleAsync

Create a new order, without needing to create separate transactions beforehand, by specifying all the information about the order in one request.

Arguments

Name	Type	Description
bundle	OrderSimpleBundleInput	If present, details of the bundle to create and add the line items to.
externalId	String	An identifier used to reference an order in an external order management platform.
orderItems	[OrderSimpleItemInput]!	A list of OrderSimpleItemInput items.
orderStatusId	String	The ID of an order status to assign to the newly created order.
paid	Boolean	Whether to mark the newly created order as having been paid for by the customer.
tags	String	A string of comma-separated tags.

Output

Type	Description
Boolean	Whether the request to place the order was made successfully.

Example

mutation {
    orderCreateSimpleAsync(externalId: "ext-123", orderItems: [])
}

orderStatusCreate

Create an order status.

Arguments

Name	Type	Description
name	String!	The name of the new order status.

Output

Type	Description
OrderStatus	The created order status.

Example

mutation {
    orderStatusCreate(name: "Ready") {
        id
        name
    }
}

orderStatusDelete

Delete an order status.

Arguments

Name	Type	Description
id	String!	The ID of the order status.

Output

Type	Description
String	The ID of the deleted order.

Example

mutation {
    orderStatusDelete(id: "00000000-0000-0000-0000-000000000000")
}

orderStatusUpdate

Update an order status.

Arguments

Name	Type	Description
id	String!	The ID of the order status.
name	String!	The new name of the order status.

Output

Type	Description
OrderStatus	The updated order status.

Example

mutation {
    orderStatusUpdate(id: "00000000-0000-0000-0000-000000000000", name: "Ready") {
        id
        name
    }
}

orderTogglePaid

Mark or unmark an order as paid.

Arguments

Name	Type	Description
id	String!	The ID of the order.

Output

Type	Description
Order	The updated order.

Example

mutation {
    orderTogglePaid(id: "00000000-0000-0000-0000-000000000000") {
        id
        paid
    }
}

processExecutionCreate

Launch a flow in flight.

Arguments

| Name | Type | Description | | ------------- | -------- | ------------------------------------------------- | ---------------------------------------------- | | inputs | [String] | The values to feed to the flow's start terminals. | | internalId | | String | A user-supplied ID for the new flow in flight. | | processFlowId | String! | The flow to execute. |

Output

Type	Description
ProcessExecution	The created flow in flight.

Example

mutation {
    processExecutionCreate(processFlowId: "00000000-0000-0000-0000-000000000000", inputs: []) {
        id
    }
}

processExecutionManualOperationConfirm

Confirm a manual operation node in a flow in flight.

Arguments

Name	Type	Description
nodeId	String!	ID of the manual operation node.
processExecutionId	String!	ID of the flow in flight.

Output

Type	Description
ProcessExecution	The flow in flight.

Example

mutation {
    processExecutionManualOperationConfirm(
        processExecutionId: "00000000-0000-0000-0000-000000000000"
        nodeId: "00000000-0000-0000-0000-000000000000"
    ) {
        id
    }
}

processFlowContextCreate

Create a new custom flow context.

Arguments

Name	Type	Description
description	String	A human-readable description of the flow context.
inputs	[ProcessFlowContextTerminalInput]!	Specifications for the start terminals.
name	String!	A human-readable name for the flow context.
outputs	[ProcessFlowContextTerminalInput]!	Specifications for the end terminals.

Output

Type	Description
ProcessFlowContext	The created flow context.

Example

mutation {
    processFlowContextCreate(name: "my-new-context", inputs: [], outputs: []) {
        id
    }
}

processFlowContextDelete

Delete a custom flow context.

Arguments

Name	Type	Description
id	String!	The ID of the flow context to delete.

Output

Type	Description
String	The ID of the deleted flow context.

Example

mutation {
    processFlowContextDelete(id: "00000000-0000-0000-0000-000000000000")
}

processFlowContextUpdate

Update an existing custom flow context.

Arguments

Name	Type	Description
description	String	A human-readable description of the flow context.
id	String!	The ID of the flow context to update.
inputs	[ProcessFlowContextTerminalInput]!	Specifications for the start terminals.
name	String!	A human-readable name for the flow context.
outputs	[ProcessFlowContextTerminalInput]!	Specifications for the end terminals.

Output

Type	Description
ProcessFlowContext	The updated flow context.

Example

mutation {
    processFlowContextUpdate(
        id: "00000000-0000-0000-0000-000000000000"
        name: "my-updated-context"
        inputs: []
        outputs: []
    ) {
        id
    }
}

processFlowCreate

Create a new flow.

Arguments

Name	Type	Description
entityId	String	An optional ID that may be used for conditional operation.
entityType	String	The type of entity that owns this flow's entityId.
name	String	A human-readable name for the flow.
processFlowContextId	String!	The flow context of this flow.

Output

Type	Description
ProcessFlow	The created flow.

Example

mutation {
    processFlowCreate(processFlowContextId: "00000000-0000-0000-0000-000000000000", name: "my-flow") {
        id
    }
}

processFlowDelete

Delete a flow.

Arguments

Name	Type	Description
id	String!	The ID of the flow to delete.

Output

Type	Description
String	The ID of the deleted flow.

Example

mutation {
    processFlowDelete(id: "00000000-0000-0000-0000-000000000000")
}

processFlowUpdate

Update an existing flow.

Arguments

Name	Type	Description
edges	[ProcessFlowEdgeInput]!	The edges of the flow.
entityId	String	An optional ID that may be used for conditional operation.
entityType	String	The type of entity that owns this flow's entityId.
id	String!	The ID of the flow to update.
name	String	A human-readable name for the flow.
nodes	[ProcessFlowNodeInput]!	The nodes of the flow.

Output

Type	Description
ProcessFlow	The updated flow.

Example

mutation {
    processFlowUpdate(id: "00000000-0000-0000-0000-000000000000", nodes: [], edges: [], name: "my-updated-flow") {
        id
    }
}

tagCreate

Create a new tag.

Arguments

Name	Type	Description
entityId	String!	The ID of the entity to tag.
entityType	String!	The type of entity to tag. Supported types: Asset, Integration, Product, Variant, Workflow, WorkflowStep
name	String!	The name of the tag.

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 created tag.

Example

mutation {
    tagCreate(entityId: "00000000-0000-0000-0000-000000000000", entityType: "Product", name: "t-shirt") {
        id
    }
}

tagDelete

Delete a tag.

Arguments

Name	Type	Description
id	String!	The ID of the tag to delete.

Output

Type	Description
String	The ID of the deleted tag.

Example

mutation {
    tagDelete(id: "00000000-0000-0000-0000-000000000000")
}

transactionCreate

Create a new transaction.

Arguments

Name	Type	Description
integrationProductId	String	ID of the integration product to use.
bulk	Boolean	Whether this is a bulk transaction.

Output

Type	Description
Transaction	The newly created transaction.

Example

mutation {
    transactionCreate(integrationProductId: "00000000-0000-0000-0000-000000000000", bulk: false) {
        id
    }
}

transactionUpdate

Updates an existing transaction.

Arguments

Name	Type	Description
designName	String	A name to save against the transaction.
id	String!	The ID of the transaction to update.
quantity	Int	The quantity of the transaction.
workflowId	String	The ID of the workflow used by this transaction.
workflowState	String	The new state of the transaction.

Output

Type	Description
Transaction	The updated transaction.

Example

mutation {
    transactionUpdate(id: "00000000-0000-0000-0000-000000000000", workflowId: "00000000-0000-0000-0000-000000000000") {
        id
    }
}