For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Docs API Reference Learn Community Changelog

Docs API Reference Learn Community Changelog

- About Our APIs
- Download OpenAPI Specs
REST
GraphQL
MCP
Resources

GraphQL Admin Mutations

createBackorderMessages

Example Query

1 mutation ExampleMutation($input: CreateBackorderMessagesInput!) {
2   inventory {
3     createBackorderMessages(input: $input) {
4       errors {
5         errorDetails
6       }
7     }
8   }
9 }

Variables

1 {
2   "input": {
3     "messages": [
4       {
5         "name": "example",
6         "message": "example",
7         "isDefault": true
8       }
9     ]
10   }
11 }

Example response

1 {
2   "data": {
3     "inventory": {
4       "createBackorderMessages": {
5         "errors": [
6           {
7             "errorDetails": [
8               {
9                 "fieldName": null,
10                 "errorMessage": null,
11                 "errorCode": null
12               }
13             ]
14           }
15         ]
16       }
17     }
18   }
19 }

Creates backorder messages for the store.

Was this page helpful?

reassignMetafieldsOwner

deleteBackorderMessages

Arguments

inputCreateBackorderMessagesInputRequired

Returns

an optional CreateBackorderMessagesResult

errorslist of ErrorRecords

The list of errors that occurred while creating backorder messages.