Get default product catalog
curl --request GET \
--url https://apiv2.example.com/product-catalogs/default{
"productOfferingGroups": [
{
"productOfferingGroupId": "mobile-plans",
"name": "Mobile Plans",
"category": "PRODUCT_CATEGORY_SUBSCRIPTION_CELL",
"description": "Bundled cell subscriptions with unlimited calls and SMS with ILD enabled.",
"internalDescription": "Core mobile offerings targeting consumer and business segments"
}
],
"productOfferings": [
{
"productOfferingId": "<string>",
"status": "AVAILABLE",
"name": "Seamless 10GB",
"product": {
"productId": "<string>",
"internalName": "<string>",
"type": "SUBSCRIPTION",
"category": "PRODUCT_CATEGORY_SUBSCRIPTION_CELL",
"networkProviderId": "tmobile-us",
"features": {
"dataMb": 2048,
"includedCallSeconds": 1000,
"includedSms": 500,
"validityDays": 30,
"countries": [
"US",
"CA",
"MX"
],
"regions": [
"NORTH_AMERICA"
],
"activationType": "INSTANT"
}
},
"price": {
"currency": "USD",
"discount": 5,
"netPrice": 5,
"boundMonths": 12,
"billingCycle": {
"period": "MONTHLY",
"interval": 1
},
"currencyOptions": {}
},
"description": "Basic mobile plan with 5GB data and unlimited calls",
"richContent": "<h3>Features</h3><ul><li>5GB monthly data</li><li>Unlimited calls & texts</li><li>No setup fees</li></ul>",
"group": {
"productOfferingGroupId": "mobile-plans",
"name": "Mobile Plans",
"category": "PRODUCT_CATEGORY_SUBSCRIPTION_CELL",
"description": "Bundled cell subscriptions with unlimited calls and SMS with ILD enabled.",
"internalDescription": "Core mobile offerings targeting consumer and business segments"
},
"addonCategories": [
"PRODUCT_CATEGORY_SUBSCRIPTION_CELL"
],
"internalDescription": "seamless_cell_10gb_us",
"imageUrl": "https://cdn.example.com/images/mobile-basic.png",
"metadata": {}
}
],
"bundles": [
{
"bundleId": "a1b2c3d4-e5f6-4a5b-8c9d-0e1f2a3b4c5d",
"name": "Phone + Plan Bundle",
"offerings": [
{
"productOfferingId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"role": "BUNDLE_OFFERING_ROLE_SUBSCRIPTION",
"quantity": 1,
"recurringDiscount": 10,
"oneTimeDiscount": 5,
"offering": {
"productOfferingId": "<string>",
"name": "<string>",
"price": {
"currency": "USD",
"discount": 5,
"netPrice": 5,
"boundMonths": 12,
"billingCycle": {
"period": "MONTHLY",
"interval": 1
},
"currencyOptions": {}
},
"group": {
"productOfferingGroupId": "mobile-plans",
"name": "Mobile Plans",
"category": "PRODUCT_CATEGORY_SUBSCRIPTION_CELL",
"description": "Bundled cell subscriptions with unlimited calls and SMS with ILD enabled.",
"internalDescription": "Core mobile offerings targeting consumer and business segments"
},
"imageUrl": "https://cdn.example.com/images/mobile-basic.png",
"category": "PRODUCT_CATEGORY_SUBSCRIPTION_CELL"
}
}
],
"description": "Get a flagship phone and a data plan together at a special price.",
"richContent": "<h3>What's included</h3><ul><li>Latest flagship device</li><li>30GB monthly data</li></ul>",
"imageUrl": "https://cdn.example.com/images/bundle-phone-plan.png",
"internalDescription": "seamless_bundle_phone_30gb",
"groupId": "f7e6d5c4-b3a2-4150-9e8d-7c6b5a4f3e2d",
"discount": {
"type": "DISCOUNT_TYPE_PERCENTAGE",
"amount": 10
},
"validity": {
"forever": false,
"time": 12,
"unit": "month"
}
}
],
"volumeDiscounts": [
{
"discountId": "b5d63d72-87e9-4536-8476-360e01598ad1",
"name": "Multi-line discount",
"type": "DISCOUNT_TYPE_FIXED",
"productOfferingIds": [
"<string>"
],
"tiers": [
{
"fromUnit": 1,
"amount": 2,
"toUnit": 4,
"receiptDescription": "Additional line savings"
}
],
"receiptDescription": "Multi-line savings"
}
]
}Product Catalogs
Get default product catalog
Returns the default public product catalog for consumer customers.
Includes both individual product offerings and bundles. The response does not require authentication and is suitable for use in public storefronts.
GET
/
product-catalogs
/
default
Get default product catalog
curl --request GET \
--url https://apiv2.example.com/product-catalogs/default{
"productOfferingGroups": [
{
"productOfferingGroupId": "mobile-plans",
"name": "Mobile Plans",
"category": "PRODUCT_CATEGORY_SUBSCRIPTION_CELL",
"description": "Bundled cell subscriptions with unlimited calls and SMS with ILD enabled.",
"internalDescription": "Core mobile offerings targeting consumer and business segments"
}
],
"productOfferings": [
{
"productOfferingId": "<string>",
"status": "AVAILABLE",
"name": "Seamless 10GB",
"product": {
"productId": "<string>",
"internalName": "<string>",
"type": "SUBSCRIPTION",
"category": "PRODUCT_CATEGORY_SUBSCRIPTION_CELL",
"networkProviderId": "tmobile-us",
"features": {
"dataMb": 2048,
"includedCallSeconds": 1000,
"includedSms": 500,
"validityDays": 30,
"countries": [
"US",
"CA",
"MX"
],
"regions": [
"NORTH_AMERICA"
],
"activationType": "INSTANT"
}
},
"price": {
"currency": "USD",
"discount": 5,
"netPrice": 5,
"boundMonths": 12,
"billingCycle": {
"period": "MONTHLY",
"interval": 1
},
"currencyOptions": {}
},
"description": "Basic mobile plan with 5GB data and unlimited calls",
"richContent": "<h3>Features</h3><ul><li>5GB monthly data</li><li>Unlimited calls & texts</li><li>No setup fees</li></ul>",
"group": {
"productOfferingGroupId": "mobile-plans",
"name": "Mobile Plans",
"category": "PRODUCT_CATEGORY_SUBSCRIPTION_CELL",
"description": "Bundled cell subscriptions with unlimited calls and SMS with ILD enabled.",
"internalDescription": "Core mobile offerings targeting consumer and business segments"
},
"addonCategories": [
"PRODUCT_CATEGORY_SUBSCRIPTION_CELL"
],
"internalDescription": "seamless_cell_10gb_us",
"imageUrl": "https://cdn.example.com/images/mobile-basic.png",
"metadata": {}
}
],
"bundles": [
{
"bundleId": "a1b2c3d4-e5f6-4a5b-8c9d-0e1f2a3b4c5d",
"name": "Phone + Plan Bundle",
"offerings": [
{
"productOfferingId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"role": "BUNDLE_OFFERING_ROLE_SUBSCRIPTION",
"quantity": 1,
"recurringDiscount": 10,
"oneTimeDiscount": 5,
"offering": {
"productOfferingId": "<string>",
"name": "<string>",
"price": {
"currency": "USD",
"discount": 5,
"netPrice": 5,
"boundMonths": 12,
"billingCycle": {
"period": "MONTHLY",
"interval": 1
},
"currencyOptions": {}
},
"group": {
"productOfferingGroupId": "mobile-plans",
"name": "Mobile Plans",
"category": "PRODUCT_CATEGORY_SUBSCRIPTION_CELL",
"description": "Bundled cell subscriptions with unlimited calls and SMS with ILD enabled.",
"internalDescription": "Core mobile offerings targeting consumer and business segments"
},
"imageUrl": "https://cdn.example.com/images/mobile-basic.png",
"category": "PRODUCT_CATEGORY_SUBSCRIPTION_CELL"
}
}
],
"description": "Get a flagship phone and a data plan together at a special price.",
"richContent": "<h3>What's included</h3><ul><li>Latest flagship device</li><li>30GB monthly data</li></ul>",
"imageUrl": "https://cdn.example.com/images/bundle-phone-plan.png",
"internalDescription": "seamless_bundle_phone_30gb",
"groupId": "f7e6d5c4-b3a2-4150-9e8d-7c6b5a4f3e2d",
"discount": {
"type": "DISCOUNT_TYPE_PERCENTAGE",
"amount": 10
},
"validity": {
"forever": false,
"time": 12,
"unit": "month"
}
}
],
"volumeDiscounts": [
{
"discountId": "b5d63d72-87e9-4536-8476-360e01598ad1",
"name": "Multi-line discount",
"type": "DISCOUNT_TYPE_FIXED",
"productOfferingIds": [
"<string>"
],
"tiers": [
{
"fromUnit": 1,
"amount": 2,
"toUnit": 4,
"receiptDescription": "Additional line savings"
}
],
"receiptDescription": "Multi-line savings"
}
]
}Response
Default product catalog.
The product offering groups in this catalog.
Show child attributes
Show child attributes
The individual product offerings in this catalog.
Show child attributes
Show child attributes
The bundles available in this catalog.
Show child attributes
Show child attributes
Automatically applied volume discounts active for this catalog.
Show child attributes
Show child attributes
⌘I