Vipconnector v1.0 | OneTeg Documentation

Version 1.0

Connector Overview: This page documents all 10 actions for the Vipconnector v1.0.

Brand-controller (2)

GET listBrandsV1

/brands

Retrieve a list of all brands available in the system.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldlist`	Field List
`Start`	Start row number
`Limit`	Records to return
`Allrecords`	Fetch all records?
`Filter`	Filter Json
`Sort`	Sort Json
`Response Type`	The response format expected from the API (e.g. application/json).

GET readBrandV1

/brands/{vipBrandId}

Retrieve detailed information for a specific brand by its unique identifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Vipbrandid`	VIP Brand ID
`Fieldlist`	Field List
`Response Type`	The response format expected from the API (e.g. application/json).

Item-catalog-supplier-controller (2)

GET listItemCatalogSuppliersV1

/item-catalog-suppliers

Retrieve a list of all item catalog suppliers.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldlist`	Field List
`Start`	Start row number
`Limit`	Records to return
`Allrecords`	Fetch all records?
`Filter`	Filter Json
`Sort`	Sort Json
`Response Type`	The response format expected from the API (e.g. application/json).

GET readItemCatalogSupplierV1

/item-catalog-suppliers/{vipSourceId}

Retrieve detailed information for a specific item catalog supplier by its unique identifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Vipsourceid`	VIP Source ID
`Fieldlist`	Field List
`Response Type`	The response format expected from the API (e.g. application/json).

Item-controller (2)

GET listItemsV1

/items

Retrieve a list of all items in the catalog.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldlist`	Field List
`Start`	Start row number
`Limit`	Records to return
`Allrecords`	Fetch all records?
`Filter`	Filter Json
`Sort`	Sort Json
`Response Type`	The response format expected from the API (e.g. application/json).

GET readItemV1

/items/{vipItemId}

Retrieve detailed information for a specific item by its unique identifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Vipitemid`	VIP Item ID
`Fieldlist`	Field List
`Response Type`	The response format expected from the API (e.g. application/json).

Package-controller (2)

GET listPackagesV1

/packages

Retrieve a list of all packages available.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldlist`	Field List
`Start`	Start row number
`Limit`	Records to return
`Allrecords`	Fetch all records?
`Filter`	Filter Json
`Sort`	Sort Json
`Response Type`	The response format expected from the API (e.g. application/json).

GET readPackageV1

/packages/{vipItemId}

Retrieve detailed information for a specific package by its unique identifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Vipitemid`	VIP Item ID
`Fieldlist`	Field List
`Response Type`	The response format expected from the API (e.g. application/json).

Product-controller (2)

GET listProductsV1

/products

Retrieve a list of all products available.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fieldlist`	Field List
`Start`	Start row number
`Limit`	Records to return
`Allrecords`	Fetch all records?
`Filter`	Filter Json
`Sort`	Sort Json
`Response Type`	The response format expected from the API (e.g. application/json).

GET readProductV1

/products/{vipProductId}

Retrieve detailed information for a specific product by its unique identifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Vipproductid`	VIP Product ID
`Fieldlist`	Field List
`Response Type`	The response format expected from the API (e.g. application/json).