For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.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
REST
GraphQL
MCP
- Overview

GraphQL B2B Mutations

productUpload

Example Query

1 mutation ExampleMutation($productListData: ProductUploadInputType) {
2   productUpload(productListData: $productListData) {
3     result {
4       errorFile
5       errorProduct
6       validProduct
7       stockErrorFile
8       stockErrorSkus
9     }
10   }
11 }

Variables

1 {
2   "productListData": {
3     "productList": [
4       {
5         "sku": "example",
6         "qty": "example"
7       }
8     ],
9     "currencyCode": "example",
10     "channelId": 0,
11     "isToCart": true,
12     "withModifiers": true
13   }
14 }

Example response

1 {
2   "data": {
3     "productUpload": {
4       "result": {
5         "errorFile": "example",
6         "errorProduct": "GenericScalar",
7         "validProduct": "GenericScalar",
8         "stockErrorFile": "example",
9         "stockErrorSkus": "GenericScalar"
10       }
11     }
12   }
13 }

CSV Upload. Requires either a B2B or BC Token.

Was this page helpful?

addressExtraFields

productAnonUpload

Arguments

productListDataProductUploadInputTypeRequired

The product list to upload. This field is required.

Returns

an optional ProductsUpload

resultProductUploadType