APappdirect
checkoutItemDetails

Get item details

Changed on

Retrieves product details such as branding, pricing, and so on.

post/api/v3/checkout/items

Request

Request body

ownerUserIdstring required

The owner user ID. The owner owns the product after the purchase is complete.

ownerCompanyIdstring required

The owner's company's ID.

buyerUserIdstring required

The buyer user ID. The buyer is the person who is making the purchase. In assisted sales or reseller scenarios, the buyer can be different than the owner.

buyerCompanyIdstring required

The buyer's company's ID. In assisted sales or reseller scenarios, the buyer's company can be different than the owner's company.

currencystring required

Three-letter code, such as USD, that determines the currency in which to display item pricing details.

productIdsstring[] required

List of product IDs to retrieve details for.

pricingPlanIdsstring[]

List of pricing plan IDs to retrieve details for.

bundleIdsstring[]

List of bundle IDs to retrieve details for. (Currently not supported)

subscriptionIdsstring[]

List of subscription IDs to retrieve details for. (Currently not supported)

Example request

{
  "ownerUserId": "19d7343b-b8ab-464a-a893-8b107d77137d",
  "ownerCompanyId": "b0410709-8333-43e2-84d6-3228f6b9998b",
  "buyerUserId": "55144410-a14a-43a1-9e0a-062c6cf31770",
  "buyerCompanyId": "6e5a0af2-e6be-4a86-a1b0-ffabcc2c6324",
  "currency": "USD",
  "productIds": [
    "100",
    "200"
  ],
  "pricingPlanIds": [
    "a12bcf2e-d27e-4808-aae0-6099cc828664",
    "3e0a22d3-dafb-4b3d-a487-7f4e7a94b32a"
  ],
  "bundleIds": [
    "300",
    "400"
  ],
  "subscriptionIds": [
    "915a6558-5a1b-446a-8ec6-334cc60e3d37",
    "8569269e-4c7f-4238-807c-513c718be135"
  ]
}

Response

Item details retrieved successfully

idstring

Product ID

type'PRODUCT' | 'ADDON' | 'BUNDLE'

Checkout item type

stackedboolean

Indicates whether the product is stacked. Customers can have multiple subscriptions to stacked products.

Example response

{
  "id": "098357e5-7a88-45fe-82d3-843bfd6bcbd1",
  "type": "PRODUCT",
  "branding": {
    "name": "Sample Application",
    "vendor": "AppDirect",
    "desc": "Sample Application Description",
    "iconUrl": "https://appdirect.cloudfront.net/app_resources/1111/thumbs_64/img1111.png",
    "href": "https://marketplace.appdirect.com/api/marketplace/v1/products/1111",
    "storefrontUrl": "https://marketplace.appdirect.com/apps/1111"
  },
  "stacked": false,
  "editions": [
    {
      "id": "45b79e06-1ac6-11e5-90d8-ca7e16f380a7",
      "freeTrialTerms": {
        "freeTrialDuration": 1,
        "freeTrialDurationPeriod": "MONTH",
        "freeTrialGracePeriod": 10
      },
      "name": "Sample Edition",
      "revenueModel": "RECURRING",
      "pricingPlans": [
        {
          "id": "b794c2a1-69a7-40bc-9bf7-75a2f945a5fc",
          "currency": "USD",
          "pricingPeriod": "MONTHLY",
          "pricingSources": [
            {
              "source": "BASE_CATALOG",
              "pricingDefinitions": [
                {
                  "costTypeCategory": "RECURRING",
                  "costType": "RECURRING_PER_UNIT",
                  "pricingStrategy": "UNIT",
                  "unit": "USER",
                  "priceRanges": [
                    {
                      "min": 0,
                      "max": 5,
                      "salePrice": "4.0000000000",
                      "wholeSalePrice": null
                    }
                  ],
                  "unitAllowsDecimals": false,
                  "increment": 5,
                  "allowsMeteredUsage": true,
                  "displaysPricePerIncrement": true
                }
              ]
            },
            {
              "source": "CHANNEL_CATALOG",
              "pricingDefinitions": [
                {
                  "costTypeCategory": "ONE_TIME",
                  "costType": "ONE_TIME_FLAT",
                  "pricingStrategy": "FLAT",
                  "salePrice": "3.0000000000",
                  "wholeSalePrice": null
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Changes