Sign in
Builder external data component

Get an external data component

Returns a single external data component with the specified id.

get/builder/externaldatacomponent/{externalDataComponentId}

Path parameters

externalDataComponentIdinteger required

Id of the External Data Component to retrieve

Response

OK

PersonalMerchandisingExternalDataComponentIdinteger

Id of the component

Namestring

Name of the component

Urlstring

Source url for the external component data

RequestType'GET' | 'POST'

Request type that the call should be to the url

AttributeIdinteger

Id of the tweakwise attribute

JsonMappingstring

Mapping in Json between external url attributes and tweakwise attributes

Icon'Bag' | 'BoxHeart' | 'Brand' | 'BrandHeart' | 'Diamond' | 'Eye' | 'EyePlus' | 'Fire' | 'Heart' | 'LabelNew' | 'New' | 'Person' | 'PersonHeart' | 'Repeat' | 'Star' | 'Stars' | 'Top' | 'Trending' | 'Basket' | 'BasketPlus' | 'Label' | 'AIPersonal'

Tweakwise icon that will be used for the component

AuthorizationIdinteger

Id of the authorization

RequestTimeoutMsinteger

Maximum requesttime in milliseconds before timeout

PostBodyMappingstring

POST requestbody payload mapping

Changes