Content Availability API

[1WSCGomez]

Content Availability API

The Content Availability API lets you check whether content exists for a given product. Use it to add logic to your site — for example, to display a dynamic tab only when content is present, or to set a product-level flag before calling the Rich Content Script.

Supported content types: Inline, DS, Logo, Logo Inline, and EU Energy Product Fiche.

---

URL structure

https://ws.cs.1worldsync.com/<SKey>/contentcheck/<ZoneID>?mf=<manufacturername>&pn=<PartNumber>&lang=<lang>&mode=<FORMAT>

• SKey — subscriber key
• ZoneID — script (hook) ID

Find your SKey and ZoneID in the Get Code section when configuring your Product Page Script. Click Get Code at the bottom-right of the Product Page, and a pop-up window will display both values. They are also provided by your Partner Advocate during implementation, or available in the portal under your account.

---

Parameters

Parameter	Description	Example
cpn	Customer Part Number — your internal SKU ID as defined in your catalog. Valid only if you upload product requests to your account; otherwise it is the SKUID of data pushed to you without product requests.	—
mf	Manufacturer name. Must be URL-encoded.	Lenovo, Cisco, Microsoft+Corp
pn	Manufacturer part number. Must be URL-encoded (e.g. 12345#ABA → 12345%23ABA).	4P6E5EA
upcean	UPC or EAN code. Note: may not be available for many products.	0196188064030
lang	2-letter ISO 639-1 language code, or language + country code separated by a hyphen.	en, fr, de, en-US, de-DE
market	2-letter ISO country code.	DE, FR, CH
mode	Response format. Accepts xml or json. Defaults to xml if not specified.	json

---

Three ways to run the check

Example product — HP, Part Number 4P6E5EA#UUZ (or 4P6E5EA), EAN 0196188064030. Substitute your own SKEY and ZoneID.

1. Part Number + Manufacturer Name

https://ws.cs.1worldsync.com/CUSTOMERSKEY/contentcheck/CUSTOMERZONEID?mf=HP&pn=4P6E5EA&lang=DE&market=CH&mode=json

Recommended for best coverage — use both Part Number and Manufacturer Name together.

2. EAN + Manufacturer Name

https://ws.cs.1worldsync.com/CUSTOMERSKEY/contentcheck/CUSTOMERZONEID?mf=HP&upcean=0196188064030&lang=DE&market=CH&mode=json

Use this when you don't have a manufacturer part number for a product, or for manufacturers where you only have the EAN.

3. Part Number + Manufacturer Name + EAN

https://ws.cs.1worldsync.com/CUSTOMERSKEY/contentcheck/CUSTOMERZONEID?mf=HP&pn=4P6E5EA&upcean=0196188064030&lang=DE&market=CH&mode=json

If you supply both PN and UPCEAN, the PN field takes priority and the EAN is not checked.

---

API response

JSON (&mode=json)

{
  "result": 0,
  "time": 4412,
  "data": {
    "ccs-tiled-gallery":  { "available": true },
    "ccs-gallery":        { "available": true },
    "ccs-standard-image": { "available": true },
    "ccs-inline-content": { "available": false },
    "ccs-logos":          { "available": false },
    "ccs-product-fiche":  { "available": false }
  }
}

XML (&mode=xml)

<response>
  <result>0</result>
  <time>11</time>
  <data>
    <ccs-tiled-gallery><available>true</available></ccs-tiled-gallery>
    <ccs-gallery><available>true</available></ccs-gallery>
    <ccs-standard-image><available>true</available></ccs-standard-image>
    <ccs-inline-content><available>false</available></ccs-inline-content>
    <ccs-logos><available>false</available></ccs-logos>
    <ccs-product-fiche><available>false</available></ccs-product-fiche>
  </data>
</response>

available: true means the content block exists for the given product.

If no accessible content exists for any block, or a block was disabled in your product page settings, every block returns false:

{
  "result": 0,
  "time": 4412,
  "data": {
    "ccs-tiled-gallery":  { "available": false },
    "ccs-gallery":        { "available": false },
    "ccs-standard-image": { "available": false },
    "ccs-inline-content": { "available": false },
    "ccs-logos":          { "available": false },
    "ccs-product-fiche":  { "available": false }
  }
}

---

Logo type reference

Look for these logo type values in the API response for each logo program:

Logo program	Response value
Dell Recommends	dell
Duracell	duracell
Energy Guide	energyGuide
Energy Star	energyStar
EPEAT	epeat
EPSON Recommends	epson
EU Energy	euEnergy
GameSpot	gamespot
HP Recommends	hpRecommends
HP Up Sells	hpUpSells
Intel vPro	intelvpro
Lenovo Recommends	lenovo
Office 2019	office2019
Office 365	ms365
Sony Recommends	sonyRecommends
Windows Server 2019	winServer2019
Windows Server 2019 CAL	winServer2019
Windows Server 2019 COEM	winServer2019
Xbox Recommends	xbox2019
Xerox Recommends	xerox