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

deleteBackorderMessages

Example Query

1 mutation ExampleMutation($filter: DeleteBackorderMessagesFilterInput) {
2   inventory {
3     deleteBackorderMessages(filter: $filter) {
4       errors {
5         errorDetails
6       }
7     }
8   }
9 }

Variables

1 {
2   "filter": {
3     "messageIds": [
4       "example"
5     ],
6     "messageNames": [
7       "example"
8     ]
9   }
10 }

Example response

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

Deletes backorder messages for the store.

Was this page helpful?

createBackorderMessages

updateBackorderMessages

Arguments

filterDeleteBackorderMessagesFilterInputOptional

Filter criteria to specify which backorder messages to delete.

Returns

an optional DeleteBackorderMessagesResult

errorslist of ErrorRecords

The list of errors that occurred while deleting backorder messages.