Skip to content
Guides
CatalogVariants
2 permissions

Create a variant spreadsheet session

Creates a temporary bulk-edit session scoped to variants. Use the returned session ID to page through its rows.

POST/v1/catalog/variants/spreadsheet

Creates a temporary bulk-edit session scoped to variants. Use the returned session ID to page through its rows.

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Header Parameters

x-Store-Id?string

Store the request acts on. Not needed when the token is bound to a store.

Authorization*string

OAuth 2.0 bearer token.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/catalog/variants/spreadsheet" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>" \  -H "Content-Type: application/json" \  -d '{    "variantIds": [      "example"    ],    "productIds": [      "example"    ],    "inventoryItems": [      {        "variantId": "7204558912004325301",        "locationId": "7204558912004325301"      }    ],    "filters": {      "source": "products",      "search": "polo",      "channelId": "7204558912004325301",      "productStatus": [        "draft"      ],      "excludeProductStatus": [        "draft"      ],      "includeArchived": false,      "locationIds": [        "example"      ],      "categoryIds": [        "example"      ]    },    "locationIds": [      "example"    ],    "pageSize": 1  }'
{  "id": "7204558912004325301",  "totalCount": 1,  "expiresAt": "2026-08-01T15:30:00Z"}