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

updateBackorderMessages

Example Query

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

Variables

1 {
2   "input": {
3     "messageUpdates": [
4       {
5         "messageId": "example",
6         "messageData": {
7           "name": "example",
8           "message": "example",
9           "isDefault": true
10         }
11       }
12     ]
13   }
14 }

Example response

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

Updates one or more backorder messages for the store.

Was this page helpful?

deleteBackorderMessages

Arguments

inputUpdateBackorderMessagesInputRequired

The input containing the backorder message updates to apply.

Returns

an optional UpdateBackorderMessagesResult

errorslist of ErrorRecords

The list of errors that occurred while updating backorder messages.