Product Variant

the Product-Variant API

Find an existing Resource by identifier

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

*/*

404

Resource with given ID was not found

*/*

get

/erp/product-variants/{id}

HTTPcURLJavaScriptPython

GET /api/erp/product-variants/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T15:56:01.879Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T15:56:01.879Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "description": "text",
  "attributeRefs": [
    {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  ],
  "variantValueRefs": [
    {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  ],
  "active": true
}

Update existing Resource

put

Path parameters

idinteger · int64Required

an identifier

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

descriptionstringRequired

Beschreibung

activebooleanRead-onlyOptional

Aktiv?

Default: true

Responses

200

successful operation

*/*

404

Resource was not found

*/*

422

Resource was not valid to process

*/*

put

/erp/product-variants/{id}

HTTPcURLJavaScriptPython

PUT /api/erp/product-variants/{id} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 128

{
  "version": "text",
  "info": {},
  "id": "text",
  "description": "text",
  "attributeRefs": [
    {
      "id": "text"
    }
  ],
  "variantValueRefs": [
    {
      "id": "text"
    }
  ]
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T15:56:01.879Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T15:56:01.879Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "description": "text",
  "attributeRefs": [
    {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  ],
  "variantValueRefs": [
    {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  ],
  "active": true
}

Delete an existing Resource

delete

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

*/*

404

Resource was not found

*/*

409

unable to delete Resource, due to constraints, existing references or internal state

*/*

delete

/erp/product-variants/{id}

HTTPcURLJavaScriptPython

DELETE /api/erp/product-variants/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "context": "text",
  "messageValue": "text"
}

deaktiviert eine bestehende Resource

put

Path parameters

idinteger · int64Required

identifier

Responses

200

successful operation

*/*

404

Resource was not found

*/*

422

Resource was not valid to process

*/*

put

/erp/product-variants/{id}/deactivate

HTTPcURLJavaScriptPython

PUT /api/erp/product-variants/{id}/deactivate HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T15:56:01.879Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T15:56:01.879Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "description": "text",
  "attributeRefs": [
    {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  ],
  "variantValueRefs": [
    {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  ],
  "active": true
}

aktiviert eine bestehende Resource

put

Path parameters

idinteger · int64Required

identifier

Responses

200

successful operation

*/*

404

Resource was not found

*/*

422

Resource was not valid to process

*/*

put

/erp/product-variants/{id}/activate

HTTPcURLJavaScriptPython

PUT /api/erp/product-variants/{id}/activate HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T15:56:01.879Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T15:56:01.879Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "description": "text",
  "attributeRefs": [
    {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  ],
  "variantValueRefs": [
    {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  ],
  "active": true
}

Create new Resource

post

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

descriptionstringRequired

Beschreibung

activebooleanRead-onlyOptional

Aktiv?

Default: true

Responses

200

successful operation

*/*

422

Resource was not valid to process

*/*

post

/erp/product-variants

HTTPcURLJavaScriptPython

POST /api/erp/product-variants HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 128

{
  "version": "text",
  "info": {},
  "id": "text",
  "description": "text",
  "attributeRefs": [
    {
      "id": "text"
    }
  ],
  "variantValueRefs": [
    {
      "id": "text"
    }
  ]
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T15:56:01.879Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T15:56:01.879Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "description": "text",
  "attributeRefs": [
    {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  ],
  "variantValueRefs": [
    {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  ],
  "active": true
}

Create a Job according to the Request

post

Body

application/json

Request zur Erstellung von Product Varianten

productTypestring · enumOptional

Artikelarten

Possible values:

Responses

200

OK

*/*

post

/erp/product-variants/productVariantCreationJob

HTTPcURLJavaScriptPython

POST /api/erp/product-variants/productVariantCreationJob HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "mainArticleRef": {
    "id": "text"
  },
  "combinations": [
    [
      1
    ]
  ],
  "blackListedCombinations": [
    [
      1
    ]
  ],
  "productType": "WITH_STOCK"
}

200

OK

{
  "context": "text",
  "messageValue": "text"
}

get

Path parameters

mainVariantArticleIdinteger · int64Required

Responses

200

OK

*/*

get

/erp/product-variants/{mainVariantArticleId}/combinations

HTTPcURLJavaScriptPython

GET /api/erp/product-variants/{mainVariantArticleId}/combinations HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

{
  "mainProductVariant": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T15:56:01.879Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T15:56:01.879Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "description": "text",
    "attributeRefs": [
      {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      }
    ],
    "variantValueRefs": [
      {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      }
    ],
    "active": true
  },
  "attributes": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T15:56:01.879Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T15:56:01.879Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "description": "text",
      "active": true,
      "labels": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T15:56:01.879Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T15:56:01.879Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "label": "text",
          "languageCode": "text"
        }
      ],
      "listings": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T15:56:01.879Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T15:56:01.879Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "attributeRef": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          },
          "salesChannelRef": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          },
          "custom": {}
        }
      ]
    }
  ],
  "values": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T15:56:01.879Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T15:56:01.879Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "productVariantAttributeRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "sortOrder": 1,
      "active": true,
      "abbreviation": "text",
      "labels": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T15:56:01.879Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T15:56:01.879Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "label": "text",
          "languageCode": "text"
        }
      ],
      "listings": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T15:56:01.879Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T15:56:01.879Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "attributeValueRef": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          },
          "salesChannelRef": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          },
          "custom": {}
        }
      ]
    }
  ],
  "usedCombinations": [
    {
      "article": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "combination": [
        {
          "id": "text",
          "label": "text",
          "description": "text",
          "active": true
        }
      ]
    }
  ]
}

get

Path parameters

idinteger · int64Required

Responses

200

OK

*/*

get

/erp/product-variants/{id}/attributes

HTTPcURLJavaScriptPython

GET /api/erp/product-variants/{id}/attributes HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

[
  {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T15:56:01.879Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T15:56:01.879Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "description": "text",
    "active": true,
    "labels": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T15:56:01.879Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T15:56:01.879Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "label": "text",
        "languageCode": "text"
      }
    ],
    "listings": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T15:56:01.879Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T15:56:01.879Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "attributeRef": {
          "id": "text",
          "label": "text",
          "description": "text",
          "active": true
        },
        "salesChannelRef": {
          "id": "text",
          "label": "text",
          "description": "text",
          "active": true
        },
        "custom": {}
      }
    ]
  }
]