Skip to content
Guides
ES
API reference
stable2 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

cursor?string

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

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/string"
{  "data": [    {      "productId": "string",      "productName": "string",      "productStatus": "string",      "productTags": [        "string"      ],      "variantId": "string",      "variantName": "string",      "version": 0,      "imageUrl": null,      "values": {        "sku": "string",        "barcode": null,        "price": 0.1,        "compareAtPrice": null,        "costPrice": null,        "trackInventory": true,        "allowBackorders": true,        "lowStockThreshold": 0,        "weight": 0.1,        "width": 0.1,        "height": 0.1,        "length": 0.1,        "unitOfMeasure": "string",        "countryOfOrigin": null,        "hsCode": null,        "options": {          "property1": "string",          "property2": "string"        }      },      "inventories": [        {          "locationId": "string",          "onHand": 0,          "committed": 0,          "unavailable": 0,          "available": 0,          "incoming": 0,          "version": 0        }      ]    }  ],  "hasNextPage": true,  "nextCursor": null,  "totalCount": null}