---
title: "POST /api/v1/AgreementProducts"
method: POST
path: "/api/v1/AgreementProducts"
tags: ["AgreementProducts"]
---

# POST /api/v1/AgreementProducts

`POST /api/v1/AgreementProducts`

## Request body

- AgreementProductFilter
  - `agreementTypeIds` AgreementType[], nullable
  - `page` integer
  - `pageSize` integer
  - `search` string, nullable
  - `priceListId` integer
  - `organizationId` integer
  - `customerTenantId` integer
  - `agreementId` integer
  - `isTrial` boolean, nullable
  - `agreementIds` integer[], nullable
  - `searchDate` string, date-time, nullable
  - `include` AgreementProductsSubFilter
    - `partNumbers` string[], nullable
    - `publisherIds` integer[], nullable
    - `publisherNames` string[], nullable
    - `poolNames` string[], nullable
    - `operatingSystemNames` string[], nullable
    - `levelNames` string[], nullable
    - `languageNames` string[], nullable
    - `licenseAgreementTypeNames` string[], nullable
    - `licenseTypeNames` string[], nullable
    - `productFamilyNames` string[], nullable
    - `productTypeNames` string[], nullable
    - `programNames` string[], nullable
    - `offeringNames` string[], nullable
    - `purchasePeriodNames` string[], nullable
    - `purchaseUnitNames` string[], nullable
    - `versionNames` string[], nullable
    - `regionNames` string[], nullable
    - `productCategoryNames` string[], nullable
    - `catalogNames` string[], nullable
    - `billingCycles` string[], nullable
    - `attributesRegions` string[], nullable
    - `attributesVCpus` string[], nullable
    - `attributesRams` string[], nullable
    - `attributesCores` string[], nullable
    - `attributesCategories` string[], nullable
    - `attributesDiskSizes` string[], nullable
    - `attributesGroupNames` string[], nullable
  - `exclude` AgreementProductsSubFilter
    - `partNumbers` string[], nullable
    - `publisherIds` integer[], nullable
    - `publisherNames` string[], nullable
    - `poolNames` string[], nullable
    - `operatingSystemNames` string[], nullable
    - `levelNames` string[], nullable
    - `languageNames` string[], nullable
    - `licenseAgreementTypeNames` string[], nullable
    - `licenseTypeNames` string[], nullable
    - `productFamilyNames` string[], nullable
    - `productTypeNames` string[], nullable
    - `programNames` string[], nullable
    - `offeringNames` string[], nullable
    - `purchasePeriodNames` string[], nullable
    - `purchaseUnitNames` string[], nullable
    - `versionNames` string[], nullable
    - `regionNames` string[], nullable
    - `productCategoryNames` string[], nullable
    - `catalogNames` string[], nullable
    - `billingCycles` string[], nullable
    - `attributesRegions` string[], nullable
    - `attributesVCpus` string[], nullable
    - `attributesRams` string[], nullable
    - `attributesCores` string[], nullable
    - `attributesCategories` string[], nullable
    - `attributesDiskSizes` string[], nullable
    - `attributesGroupNames` string[], nullable
  - `sortKey` string, nullable
  - `includeProductInformation` boolean
  - `includeProductVariantInformation` boolean
  - `includeEndOfSale` boolean, nullable
  - `sortOrder` 0 | 1

## Response `200`

Success

- AgreementProduct[]
  - `uniqueId` string, nullable
  - `productType` 0 | 1 | 2 | 3
  - `productVariant` ProductVariant
    - `id` integer
    - `product` ProductReference
      - `id` integer
      - `partNumber` string, nullable
      - `publisherProductId` string, nullable
      - `itemLegalName` string, nullable
      - `itemName` string, nullable
    - `partNumber` string, nullable
    - `productName` string, nullable
    - `publisher` ObjectReference
      - `id` integer
      - `name` string, nullable
    - `program` ObjectReference
      - `id` integer
      - `name` string, nullable
    - `productFamily` ObjectReference
      - `id` integer
      - `name` string, nullable
    - `language` ObjectReference
      - `id` integer
      - `name` string, nullable
    - `level` ObjectReference
      - `id` integer
      - `name` string, nullable
    - `productType` ObjectReference
      - `id` integer
      - `name` string, nullable
    - `pool` ObjectReference
      - `id` integer
      - `name` string, nullable
    - `licenseType` ObjectReference
      - `id` integer
      - `name` string, nullable
    - `licenseAgreementType` ObjectReference
      - `id` integer
      - `name` string, nullable
    - `operatingSystem` ObjectReference
      - `id` integer
      - `name` string, nullable
    - `offering` ObjectReference
      - `id` integer
      - `name` string, nullable
    - `minimumCommitment` MinimumCommitmentLight
      - `id` integer
      - `months` integer
      - `name` string, nullable
    - `unitCount` integer
    - `version` string, nullable
    - `purchaseUnit` string, nullable
    - `purchasePeriod` string, nullable
    - `addDate` string, date-time
    - `deleteDate` string, date-time
    - `productCategory` string, nullable
    - `region` string, nullable
    - `isTrial` boolean
    - `defaultBillingCycleId` integer
    - `availableBillingCycleIds` integer[], nullable
    - `attributes` object, nullable
    - `minimumQuantity` number, double
    - `maximumQuantity` number, double, nullable
    - `provisioningVariables` string[], nullable
  - `agreement` ObjectReference
    - `id` integer
    - `name` string, nullable
  - `name` string, nullable
  - `priceId` integer
  - `recommendedRetailPrice` Price
    - `value` number, double
    - `currencyCode` string, nullable
  - `salesPrice` Price
    - `value` number, double
    - `currencyCode` string, nullable
  - `alternativeSalesPrice` Price
    - `value` number, double
    - `currencyCode` string, nullable
  - `endOfSale` EndOfSale
    - `endOfSaleStartDate` string, date-time, nullable
    - `endOfSaleEndDate` string, date-time, nullable
  - `priceListId` integer
  - `priceListName` string, nullable
  - `monthMultiplier` integer
  - `priceCalculationType` 0 | 1 | 2 | 3 | 4
  - `agreementType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13
  - `productInformation` ProductInformation
    - `externalProductId` integer
    - `cultureCode` string, nullable
    - `description` string, nullable
    - `learnMoreLink` string, nullable
  - `minimumQuantity` integer
  - `maximumQuantity` integer, nullable
  - `catalog` ObjectReference
    - `id` integer
    - `name` string, nullable
  - `productVariantInformation` ProductVariantInformation
    - `description` string, nullable

---

[API](https://skmtc.net/crayon/apis/crayon-group-customer-api.md) · [All operations](https://skmtc.net/crayon/apis/crayon-group-customer-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/crayon/crayon-group-customer-api/revisions/a04494a78f65/schema)