Get itemVariants

Important: Currently all requests to API v2.0 must append $schemaversion=2.0 to the request URL to work properly. This is to uptake the new improved $metadata model avaliable from Business Central 17. An update will be applied shortly to apply the schemaversion automatically to API v2.0. For all other APIs $schemaversion=1.0 will be the default, unless specified in the request URL with $schemaversion=2.0. A solution is being worked on, where the schemaversion will be defined in the extension.

Retrieve the properties and relationships of a itemVariant object for Dynamics 365 Business Central.

HTTP request

Replace the URL prefix for Dynamics 365 Business Central depending on environment following the guideline.

GET businesscentralPrefix/companies({id})/itemVariants({id})
GET businesscentralPrefix/companies({id})/items({id})/itemVariants({id})

Request headers

Header Value
Authorization Bearer {token}. Required.

Request body

Do not supply a request body for this method.


If successful, this method returns a 200 OK response code and an itemVariants object in the response body.



Here is an example of the request.

GET https://{businesscentralPrefix}/api/v2.0/companies({id})/itemVariants({id})


Here is an example of the response.

    "id": "c12af665-c1e3-ea11-aa60-000d3ad7cacb",
    "itemId": "fca5738a-44e3-ea11-bb43-000d3a2feca1",
    "itemNumber": "1896-S",
    "code": "TESTCRUD",
    "description": "test crud"

See also

Tips for working with the APIs
Delete itemvariant
Create itemvariant
Update itemvariant