Builder external data component

Returns an external component

get/builder/externaldatacomponent/{externalDataComponentId}

Request

  • The document declares no server URL.
  • Auth
    API key in header TWN-InstanceKey and API key in header TWN-Authentication

Path parameters

externalDataComponentIdinteger required

Response

OK

PersonalMerchandisingExternalDataComponentIdinteger

Id of the component

Namestring

Name of the component

Urlstring

Source url for the external component data

RequestType'GET' | 'POST'
AttributeIdinteger

Id of the tweakwise attribute

JsonMappingstring nullable

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'
AuthorizationIdinteger nullable

Id of the authorization

RequestTimeoutMsinteger nullable

Maximum requesttime in milliseconds before timeout

PostBodyMappingstring nullable

POST requestbody payload mapping

Changes

No recorded changes to this operation across all 1 revision of this API.