---
title: "POST /vendor-api/get-entitlements"
method: POST
path: "/vendor-api/get-entitlements"
---

# POST /vendor-api/get-entitlements

`POST /vendor-api/get-entitlements`

## Request

- Base URL: `http://localhost:2000`
- URL: `http://localhost:2000/vendor-api/get-entitlements`
- Auth: none declared
- TypeScript: <https://skmtc.dev/synopsys/apis/synopsys-cloud-openlink-api-specification/docs/vendor-api/get-entitlements/post.ts> (a function with typed inputs; its response is checked against the schema)

## Headers

- `x-api-key` string

## Request body

- EntitlementsRequestDto
  - `customer` Customer, required
    - `name` string, required: Customer Name
    - `dunsNumber` string, required: Customer DUNS Number
    - `synopsysCustomerId` string, required: Synopsys Customer Id
    - `vendorCustomerInfo` object: Vendor Specific Customer Details

## Response `200`

- EntitlementsResponse
  - `customer` Customer, required
    - `name` string, required: Customer Name
    - `dunsNumber` string, required: Customer DUNS Number
    - `synopsysCustomerId` string, required: Synopsys Customer Id
    - `vendorCustomerInfo` object: Vendor Specific Customer Details
  - `provides` LicenseEntitlements[], required
    - `title` string, required: Title
    - `description` string: Description
    - `kind` 'ProvideLicense', required: Provide kind
    - `licenseRequestApi` ApiBase, required
      - `url` string, required: Remote Url (POST) to trigger item action
      - `header` object: Fixed header to be send on item url request
      - `staticBody` object: Fixed body parameters merged into the body to be send on item url request
    - `licenseEntitlements` LicenseEntitlementItem[]: List of license entitlements
      - `title` string, required: Title of the entitlement
      - `aux` object: Internal identification of the entitlement
      - `qtyMax` number: Maximum available quantity
      - `termEndDate` string: License term end date as ISO date string

## Other responses

- `400`

---

[API](https://skmtc.dev/synopsys/apis/synopsys-cloud-openlink-api-specification.md) - [All operations](https://skmtc.dev/synopsys/apis/synopsys-cloud-openlink-api-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/synopsys/apis/synopsys-cloud-openlink-api-specification/revisions/20d9e4dbf0ed?raw)