Skip to content
docs
Guides
ES
CatalogVariants
2 permissions

Get a variant spreadsheet page

Returns one page of an open variant bulk edit session.

GET/v1/catalog/variants/spreadsheet/{id}

Returns one page of an open variant bulk edit session.

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Path Parameters

id*string

Unique identifier of the resource.

Query Parameters

limit?integer

Maximum number of results to return.

Formatint32
cursor?string

Opaque cursor from the previous response. Omit it on the first page.

search?string

Free-text filter. Which fields it covers depends on the resource.

sortBy?string

Field to sort by. Accepted values depend on the resource.

sortDirection?string

Sort direction: asc or desc.

Value in

  • "asc"
  • "desc"

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.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/catalog/variants/spreadsheet/7204558912004325301" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
{  "data": [    {      "productId": "7204558912004325301",      "productName": "Example resource",      "productStatus": "draft",      "productTags": [        "example"      ],      "type": "product",      "categoryId": "7204558912004325301",      "categoryName": "Example resource",      "brandId": "7204558912004325301",      "brandName": "Example resource",      "vendor": "example",      "description": "Example description.",      "isFeatured": false,      "metaTitle": "Example title",      "metaDescription": "Example description.",      "variantId": "7204558912004325301",      "variantName": "Example resource",      "version": 1,      "values": {        "sku": "SKU-001",        "price": 1,        "trackInventory": false,        "allowBackorders": false,        "lowStockThreshold": 1,        "weight": 1,        "width": 1,        "height": 1,        "length": 1,        "unitOfMeasure": "kilogram",        "options": {          "key": "example"        }      },      "inventories": [        {          "locationId": "7204558912004325301",          "onHand": 1,          "committed": 1,          "unavailable": 1,          "available": 1,          "incoming": 1,          "version": 1        }      ]    }  ],  "hasNextPage": false,  "nextCursor": "example",  "totalCount": 1}