/doc/WebService.php

Description
Functions
Category_Create

Creates a new Category

  • return: The id of the newly created Category
int Category_Create (CategoryCreate $CategoryData)
  • CategoryCreate $CategoryData: The input in CategoryCreate Object format
Category_CreateOrUpdate

Creates or updates a Category. Assumes that only unique Category titles exist for a given level in the shop. If the Title supplied is not found on the level a new Category is created

  • return: The id of the created or updated Category
int Category_CreateOrUpdate (CategoryCreateUpdate $CategoryData)
Category_CreatePicture

Creates a new CategoryPicture

  • return: The id of the newly created CategoryPicture
int Category_CreatePicture (CategoryPictureCreate $CategoryPictureData)
Category_Delete

Deletes a Category

boolean Category_Delete (int $CategoryId)
  • int $CategoryId: The id of the Category to delete
Category_DeletePicture

Deletes a CategoryPicture

boolean Category_DeletePicture (int $CategoryPictureId)
  • int $CategoryPictureId: the id of the CategoryPicture to delete
Category_GetAll

Returns all Categories

  • return: An array of Category Objects
Category[] Category_GetAll ()
Category_GetById

Returns the indicated Category

  • return: A Category Object
Category Category_GetById (int $CategoryId)
  • int $CategoryId: The id of the Category
Category_GetPictures

Returns the CategoryPictures of the indicated Category

  • return: An array of CategoryPicture Objects
CategoryPicture[] Category_GetPictures (int $CategoryId)
  • int $CategoryId: The id of the Category of the wanted CategoryPictures
Category_Update

Updates a new Category

  • return: The id of the updated Category
int Category_Update (CategoryUpdate $CategoryData)
  • CategoryUpdate $CategoryData: The input in CategoryUpdate Object format
Category_UpdatePicture

Updates a CategoryPicture

  • return: The id of the updated CategoryPicture
int Category_UpdatePicture (CategoryPictureUpdate $CategoryPictureData)
Category_UpdateTitle

Updates the Title of a Category in the specified Language

  • return: true if the Title was updated, false at failure
boolean Category_UpdateTitle (int $CategoryId, string $Title, string $LanguageISO)
  • int $CategoryId: The id of the Category to update
  • string $Title: The new title
  • string $LanguageISO: The LanguageISO the new title should be set in
Currency_Create

Creates a new Currency

  • return: The id of the newly created Currency
int Currency_Create (CurrencyCreate $CurrencyData)
  • CurrencyCreate $CurrencyData: The input in CurrencyCreate Object format
Currency_Delete

Deletes a Currency

boolean Currency_Delete (int $CurrencyId)
  • int $CurrencyId: The id of the Currency to delete
Currency_GetAll

Returns all Currencies

  • return: An array of Currency Objects
Currency[] Currency_GetAll ()
Currency_GetByIso

Returns the indicated Currency

  • return: A Currency Object
Currency Currency_GetByIso (string $Iso)
  • string $Iso: The isocode of the wanted Currency
Currency_Update

Updates a Currency

  • return: The id of the Currency
int Currency_Update (CurrencyUpdate $CurrencyData)
  • CurrencyUpdate $CurrencyData: The input in CurrencyUpdate Object format
Delivery_GetAll

Returns all available Delivery Methods

  • return: An array of Delivery objects
Delivery[] Delivery_GetAll ()
Delivery_GetByLocation

Returns Deliveries available in the supplied region

  • return: An array of Delivery objects
Delivery[] Delivery_GetByLocation (int $Zip, string $CountryCode, double $Weight)
  • int $Zip: the Zip code of the region
  • string $CountryCode: the Countrycode of the region
  • double $Weight: the Weight of the order
Delivery_UpdateDropPoint

Updates a DropPointId of an OrderDelivery

boolean Delivery_UpdateDropPoint (int $OrderId, string $DropPointId)
  • int $OrderId: the OrderId of the OrderDelivery
  • string $DropPointId: the DropPointId of the OrderDelivery
DiscountGroupProduct_Create

Creates a new DiscountGroupProduct

  • return: The id of the newly created DiscountGroupProduct
int DiscountGroupProduct_Create (DiscountGroupProductCreate $DiscountGroupProductData)
DiscountGroupProduct_Delete

Deletes a DiscountGroupProduct

boolean DiscountGroupProduct_Delete (string $DiscounProducttGroupTitle)
  • string $DiscounProducttGroupTitle: The title of the DiscountGroup to delete
DiscountGroupProduct_GetAll

Returns all DiscountGroupProducts

  • return: An array of DiscountGroupProduct Objects
DiscountGroupProduct[] DiscountGroupProduct_GetAll ()
DiscountGroupProduct_GetById

Returns the indicated DiscountGroupProduct

  • return: A DiscountGroupProduct Object
DiscountGroupProduct DiscountGroupProduct_GetById (int $DiscountGroupProductId)
  • int $DiscountGroupProductId: The id of the wanted DiscountGroupProduct
DiscountGroupProduct_GetByTitle

Returns the indicated DiscountGroupProduct

  • return: A DiscountGroupProduct Object
DiscountGroupProduct DiscountGroupProduct_GetByTitle ( $DiscountGroupProductTitle, string $DiscountGroupProductId)
  • string $DiscountGroupProductId: The title of the wanted DiscountGroupProduct
  • $DiscountGroupProductTitle
DiscountGroupProduct_Update

Updates a DiscountGroupProduct

  • return: The id of the DiscountGroupProduct
int DiscountGroupProduct_Update (DiscountGroupProductUpdate $DiscountGroupProductData)
DiscountGroup_Create

Creates a new DiscountGroup

  • return: The id of the newly created DiscountGroup
int DiscountGroup_Create (DiscountGroupCreate $DiscountGroupData)
DiscountGroup_Delete

Deletes a DiscountGroup

boolean DiscountGroup_Delete (int $DiscountGroupId)
  • int $DiscountGroupId: The id of the DiscountGroup to delete
DiscountGroup_GetAll

Returns all DiscountGroups

  • return: An array of DiscountGroup Objects
DiscountGroup[] DiscountGroup_GetAll ()
DiscountGroup_GetById

Returns the indicated DiscountGroup

  • return: A DiscountGroup Object
DiscountGroup DiscountGroup_GetById (int $DiscountGroupId)
  • int $DiscountGroupId: The id of the wanted DiscountGroup
DiscountGroup_GetByTitle

Returns the indicated DiscountGroup

  • return: A DiscountGroup Object
DiscountGroup DiscountGroup_GetByTitle ( $DiscountGroupTitle, string $DiscountGroupId)
  • string $DiscountGroupId: The title of the wanted DiscountGroup
  • $DiscountGroupTitle
DiscountGroup_Update

Updates a DiscountGroup

  • return: The id of the DiscountGroup
int DiscountGroup_Update (DiscountGroupUpdate $DiscountGroupData)
Discount_Create

Creates a new Discount

  • return: The id of the newly created Discount
int Discount_Create (DiscountCreate $DiscountData)
  • DiscountCreate $DiscountData: The inputdata in DiscountCreate Object form
Discount_Delete

Deletes a Discount

boolean Discount_Delete (int $DiscountId)
  • int $DiscountId: The id of the Discount to delete
Discount_GetAll

Returns all Discounts.

  • return: An array of Discount Objects
Discount[] Discount_GetAll ()
Discount_GetById

Returns the indicated Discount.

  • return: A Discount Object
Discount Discount_GetById (int $DiscountId)
  • int $DiscountId
Discount_Update

Updates a Discount

  • return: The id of the Discount
int Discount_Update (DiscountUpdate $DiscountData)
  • DiscountUpdate $DiscountData: The input in DiscountUpdate Object format
Newsletter_CreateCustomField

Creates a new NewsletterCustomField

  • return: The id of the newly created NewsletterCustomField
int Newsletter_CreateCustomField (NewsletterCustomFieldCreate $CustomFieldData)
Newsletter_DeleteCustomField

Deletes a NewsletterCustomField

boolean Newsletter_DeleteCustomField (int $CustomFieldId)
  • int $CustomFieldId: The id of the NewsletterCustomField to delete
Newsletter_GetCustomFieldByGroup

Returns the NewsletterCustomFields of the indicated UserGroup and Type (1: Mailmarketing)

  • return: An array of NewsletterCustomField Objects
NewsletterCustomField[] Newsletter_GetCustomFieldByGroup (int $UserGroupId, int $ServiceId)
  • int $UserGroupId: The id of the UserGroup
  • int $ServiceId: The id of the mail service
Newsletter_GetCustomFieldById

Returns the indicated NewsletterCustomField

  • return: A NewsletterCustomField Object
NewsletterCustomField Newsletter_GetCustomFieldById (int $CustomFieldId, int $ServiceId)
  • int $CustomFieldId: The id of the NewsletterCustomField
  • int $ServiceId: The id of the mail service
Newsletter_UpdateCustomField

Updates a NewsletterCustomField

  • return: The id of the NewsletterCustomField
int Newsletter_UpdateCustomField (NewsletterCustomFieldUpdate $CustomFieldData)
Order_CancelTransaction

Cancels a transaction in the paymentgateway

  • return: the status from the payment gateway, ok if success
string Order_CancelTransaction (string $TransactionCode, int $OrderId)
  • string $TransactionCode: the transactioncode of the transaction to cancel
  • int $OrderId: the id of the Order of the transaction
Order_CompleteTransaction

Completes a transaction in the paymentgateway

  • return: the status from the payment gateway, ok if success
string Order_CompleteTransaction (string $TransactionCode, int $OrderId)
  • string $TransactionCode: the transactioncode of the transaction to complete
  • int $OrderId: the id of the Order of the transaction
Order_Create

Creates a new Order

  • return: The id of the newly create Order
int Order_Create (OrderCreate $OrderData)
  • OrderCreate $OrderData: The input in OrderCreate Object format
Order_CreateInvoice

Creates an invoice with a maturity date for an Order

  • return: true on success, false on failure
bool Order_CreateInvoice (int $OrderId, int $MaturityDayInterval)
  • int $OrderId: OrderId The id of the Order
  • int $MaturityDayInterval: MaturityDayInterval the amount of days from today's date to set the maturity date for the Invoice (0, 8, 14 or 30 days)
Order_GetAll

Returns information about all Orders. The output format can be set with Order_SetFields

  • return: An array of Order Objects
Order[] Order_GetAll ()
Order_GetByDate

Returns information about orders. The output format can be set with Order_SetFields

  • return: An array of Order Objects
Order[] Order_GetByDate (string $Start, string $End, string $Status)
  • string $Start: the start date of the query in 'yyyy-mm-dd' or 'yyyy-mm-dd hh:mm:ss' format. Null to fetch orders from first entry
  • string $End: the end date of the query in 'yyyy-mm-dd' or 'yyyy-mm-dd hh:mm:ss' format. Null to fetch orders to current date
  • string $Status: A comma separated list of Status ids (0: Not Received, 1: Order Received, 2: Processing, 3: Order Sent, 4: Reopen, 5: Cancelled, 6: Ready for pickup, 7: Partially sent, 8: Picked up, 99: Draft, 100: Credit note)
Order_GetByDateAndUser

Returns information about orders. The output format can be set with Order_SetFields

  • return: An array of Order Objects
Order[] Order_GetByDateAndUser (string $Start, string $End, string $Status, int $UserId)
  • string $Start: the start date of the query in 'yyyy-mm-dd' format. Null to fetch orders from first entry
  • string $End: the end date of the query in 'yyyy-mm-dd' format. Null to fetch orders to current date
  • string $Status: A comma separated list of Status ids (0: Not Received, 1: Order Received, 2: Processing, 3: Order Sent, 4: Reopen, 5: Cancelled, 6: Ready for pickup, 7: Partially sent, 8: Picked up, 99: Draft, 100: Credit note)
  • int $UserId: the id of the User who must have made the orders
Order_GetByDateUpdated

Returns information about orders. The output format can be set with Order_SetFields

  • return: An array of Order Objects
Order[] Order_GetByDateUpdated (string $Start, string $End, string $Status)
  • string $Start: the start date of the query in 'yyyy-mm-dd' or 'yyyy-mm-dd hh:mm:ss' format. Null to fetch orders from first entry
  • string $End: the end date of the query in 'yyyy-mm-dd' or 'yyyy-mm-dd hh:mm:ss' format. Null to fetch orders to current date
  • string $Status: A comma separated list of Status ids (0: Not Received, 1: Order Received, 2: Processing, 3: Order Sent, 4: Reopen, 5: Cancelled, 6: Ready for pickup, 7: Partially sent, 8: Picked up, 99: Draft, 100: Credit note)
Order_GetById

Returns the indicated Order. The output format can be set with Order_SetFields

  • return: An Order Object
Order Order_GetById (int $OrderId)
  • int $OrderId: The id of the wanted Order
Order_GetByNumber

Returns information about orders. The output format can be set with Order_SetFields

  • return: An array of Order Objects
Order[] Order_GetByNumber (int $Start, int $End)
  • int $Start: the start number of the query
  • int $End: the end number of the query
Order_GetBySite

Returns information about orders. The output format can be set with Order_SetFields

  • return: An array of Order Objects
Order[] Order_GetBySite (int $Site)
  • int $Site: The site of the order
Order_GetByStatus

Returns information about orders. The output format can be set with Order_SetFields

  • return: An array of Order Objects
Order[] Order_GetByStatus (string $Status)
  • string $Status: A comma separated list of Status ids (0: Not Received, 1: Order Received, 2: Processing, 3: Order Sent, 4: Reopen, 5: Cancelled, 6: Ready for pickup, 7: Partially sent, 8: Picked up, 99: Draft, 100: Credit note)
Order_GetCurrency

Returns the indicated OrderCurrency

  • return: An OrderCurrency Object
OrderCurrency Order_GetCurrency (int $CurrencyId)
  • int $CurrencyId: The id of the wanted Currency
Order_GetCustomer

Returns the indicated OrderCustomer

  • return: An OrderCustomer Object
OrderCustomer Order_GetCustomer (int $CustomerId)
  • int $CustomerId: The id of the wanted OrderCustomer
Order_GetDelivery

Returns the indicated OrderDelivery

  • return: An OrderDelivery Object
OrderDelivery Order_GetDelivery (int $DeliveryId)
  • int $DeliveryId: The id of the wanted Delivery
Order_GetDiscountCodes

Returns the OrderDiscountCodes for the indicated Order

  • return: An array of OrderDiscountCode Objects
OrderDiscountCode[] Order_GetDiscountCodes (int $OrderId)
  • int $OrderId: The id of the Order of the DiscountCodes
Order_GetFileDownload

Returns the indicated OrderFileDownload

  • return: An OrderFileDownload Object
OrderFileDownload Order_GetFileDownload (int $FileDownloadId)
  • int $FileDownloadId: The id of the wanted OrderFileDownload
Order_GetLineAddresses

Returns the OrderLineAddresses of the indicated OrderLine.

  • return: An array of OrderLineAddress Objects
OrderLineAddress[] Order_GetLineAddresses (int $OrderLineId)
  • int $OrderLineId: The id of the OrderLine of the Order
Order_GetLines

Returns the OrderLines of the indicated Order. The output format can be set with Order_SetOrderLineFields

  • return: An array of OrderLine Objects
OrderLine[] Order_GetLines (int $OrderId, int $LineId)
  • int $OrderId: The id of the Order of the OrderLines
  • int $LineId: if specified returns the Line of the Order specified by the LineId
Order_SetTransactionCode

Creates a new Order Transaction

  • return: The id of the newly create Order Transaction
int Order_SetTransactionCode (OrderSetTransactionCode $TransactionData)
Order_GetPacking

Returns the indicated OrderPacking

  • return: An OrderPacking Object
OrderPacking Order_GetPacking (int $PackingId)
  • int $PackingId: The id of the OrderPacking
Order_GetPayment

Returns the indicated OrderPayment

  • return: An OrderPayment Object
OrderPayment Order_GetPayment (int $PaymentId)
  • int $PaymentId: The id of the OrderPayment
Order_GetTransactions

Returns the OrderTransactions of the indicated Order

  • return: An array of OrderTransaction Objects
OrderTransaction[] Order_GetTransactions (int $OrderId)
  • int $OrderId: The id of the Order of the OrderTransactions
Order_LowerTransaction

Lowers a transaction in the payment gateway

string Order_LowerTransaction (string $TransactionCode, int $Amount, int $OrderId)
  • string $TransactionCode: the transactioncode of the transaction to cancel
  • int $Amount: The new amount of the translation in 1/100 of the currency. That is, and Amount of 150 equals 1.50
  • int $OrderId: the id of the Order of the transaction
Order_SetFields

Sets the output format for all methods returning Order Objects. If not set, the output format includes the Id

boolean Order_SetFields (string $Fields)
  • string $Fields: Comma separated list of fieldnames. Must match the fields in the Order Object
Order_SetOrderLineFields

Sets the outputformat for all methods returning OrderLine Objects. If not set, the output format includes only the Id

boolean Order_SetOrderLineFields (string $Fields)
  • string $Fields: A comma separated list of Fieldnames. Must Match fieldnames of the OrderLine Object
Order_UpdateComment

Updates the comment of the order

boolean Order_UpdateComment (int $OrderId, string $Text)
  • int $OrderId: The id of the Order to update
  • string $Text: The new text of the internal note
Order_UpdateLineServiceType

Updates the service type of an order line

boolean Order_UpdateLineServiceType (int $OrderLineId, string $ServiceType)
  • int $OrderLineId: The id of the orderline to update
  • string $ServiceType: The id of the new ServiceType of the orderline
Order_UpdateLineStatus

Updates the status of an order line

boolean Order_UpdateLineStatus (int $OrderLineId, int $Status)
  • int $OrderLineId: The id of the orderline to update
  • int $Status: The new status of the orderline
Order_UpdateLineTrackingCode

Updates the trackingcode of an order line

boolean Order_UpdateLineTrackingCode (int $OrderLineId, string $TrackingCode)
  • int $OrderLineId: The id of the orderline to update
  • string $TrackingCode: The new trackingCode of the orderline
Order_UpdateServiceType

Updates the service type of an order

boolean Order_UpdateServiceType (int $OrderId, string $ServiceType)
  • int $OrderId: The id of the orderline to update
  • string $ServiceType: The id of the new ServiceType of the Order
Order_UpdateSite

Updates the order site

boolean Order_UpdateSite (int $OrderId, int $Site)
  • int $OrderId: The id of the Order to update
  • int $Site: The new site of the Order
Order_UpdateStatus

Updates the order status

boolean Order_UpdateStatus (int $OrderId, int $Status)
  • int $OrderId: The id of the Order to update
  • int $Status: The new status of the Order
Order_UpdateTrackingCode

Updates the order trackingcode

boolean Order_UpdateTrackingCode (int $OrderId, string $TrackingCode)
  • int $OrderId: The id of the Order to update
  • string $TrackingCode: The new trackingCode of the Order
OrderStatusCode_GetAll

Returns information about OrderStatusCode.

  • return: An array of OrderStatusCode Objects
OrderStatusCode[] OrderStatusCode_GetAll() ()
PageText_Create

Creates a new PageText.

  • return: the id of the created PageText
int PageText_Create (PageTextCreate $PageTextData)
  • PageTextCreate $PageTextData: The input in PageTextCreate Object format
PageText_Delete

Deletes a PageText

boolean PageText_Delete (int $PageTextId)
  • int $PageTextId: The id of the PageText to delete
PageText_GetByFolder

Returns the PageTexts of the indicated folder. The output format can be set with PageText_SetFields

  • return: An array of PageText Objects
PageTex[]t PageText_GetByFolder (int $FolderId)
  • int $FolderId: the id of the folder
PageText_GetById

Returns the indicated PageText. The output format can be set with PageText_SetFields

  • return: A PageText Object
PageText PageText_GetById (int $PageTextId)
  • int $PageTextId
PageText_GetByIds

Returns the indicated PageTexts. The output format can be set with PageText_SetFields

  • return: An array of PageText Objects
PageText[] PageText_GetByIds (string $PageTextIds)
  • string $PageTextIds: A comma separated list of ids.
PageText_GetByLink

Returns the indicated PageText. The output format can be set with PageText_SetFields

  • return: A PageText Object
PageText PageText_GetByLink (string $PageTextLink)
  • string $PageTextLink
PageText_SetFields

Sets the outputformat for all methods returning PageText Objects. If not set, the output format includes only the Id

boolean PageText_SetFields (string $Fields)
  • string $Fields: A comma separated list of Fieldnames. Must Match fieldnames of the PageText Object
PageText_SetThumbOptions

Sets the format for the thumbnails returned in PageText objects

bool PageText_SetThumbOptions (int $ThumbWidth, int $ThumbHeight, bool $Crop, bool $Greyscale, bool $Watermark)
  • int $ThumbWidth: the width of the thumbnail
  • int $ThumbHeight: the height of the thumbnail
  • bool $Crop: wether or not to crop
  • bool $Greyscale: wether or not to greyscale
  • bool $Watermark: wether or not to watermark the thumbnail
PageText_Update

Updates a PageText.

  • return: the id of the updated PageText
int PageText_Update (PageTextUpdate $PageTextData)
  • PageTextUpdate $PageTextData: The input in PageTextUpdate Object format
Page_DeletePicture

Deletes a PagePicture

boolean Page_DeletePicture (int $PagePictureId)
  • int $PagePictureId: The id of the PagePicture to delete
Page_GetPictures

Returns the PagePictures of the indicated Page.

  • return: An array of PagePicture Object
PagePicture[] Page_GetPictures (int $PageId)
  • int $PageId
Page_GetPictureThumbnails

Returns the PagePictures of the indicated Page.

  • return: An array of PagePicture Objects
PagePicture[] Page_GetPictureThumbnails (int $PageId, int $ThumbWidth, int $ThumbHeight, bool $Crop, bool $Greyscale, bool $Watermark)
  • int $PageId: the id of the Page of the PagePictures
  • int $ThumbWidth: the width of the thumbnail
  • int $ThumbHeight: the height of the thumbnail
  • bool $Crop: wether or not to crop
  • bool $Greyscale: wether or not to greyscale
  • bool $Watermark: wether or not to watermark the thumbnail
Payment_GetAll

Returns all available PaymentMethods

  • return: An array of PaymentMethod Objects
PaymentMethod[] Payment_GetAll ()
Payment_GetByCountry

Returns the available PaymentMethods for the given country code

  • return: An array of PaymentMethod Objects
PaymentMethod[] Payment_GetByCountry (string $CountryCode)
  • string $CountryCode: the CountryCode
Product_AddAdditionalType

Adds an existing ProductAdditionalType to the indicated Product

boolean Product_AddAdditionalType (int $ProductId, int $AdditionalTypeId)
  • int $ProductId: The id of the Product to add the ProductAdditionalType to
  • int $AdditionalTypeId: The id of the ProductAdditionalType
Product_AddCustomData

Adds an existing ProductCostumData to the indicated Product

boolean Product_AddCustomData (int $ProductId, int $CustomDataId)
  • int $ProductId: The id of the Product to add the ProductCustomData to
  • int $CustomDataId: The id of the ProductCustomData
Product_Create

Creates a new Product

  • return: The id of the newly create Product
int Product_Create (ProductCreate $ProductData)
  • ProductCreate $ProductData: The input in ProductCreate Object format
Product_CreateCustomData

Creates a new ProductCustomData

  • return: The id of the newly created ProductCustomData
int Product_CreateCustomData (ProductCustomDataCreate $ProductCustomData)
Product_CreateCustomDataType

Creates a new ProductCustomDataType

  • return: The id of the newly created ProductCustomDataType
int Product_CreateCustomDataType ( $ProductCustomDataType, ProductCustomDataTypeCreate $ProductCustomData)
Product_CreateDeliveryCountry

Creates a new ProductDeliveryCountry

  • return: The id of the newly created ProductDeliveryCountry
int Product_CreateDeliveryCountry (ProductDeliveryCountryCreate $DeliveryCountryData)
Product_CreateDeliveryTime

Creates a new ProductDeliveryTime

  • return: The id of the newly created ProductDeliveryTime
int Product_CreateDeliveryTime (ProductDeliveryTimeCreate $DeliveryTimeData)
Product_CreateDiscount

Creates a new ProductDiscount

  • return: The id of the newly created ProductDiscount
int Product_CreateDiscount (ProductDiscountCreate $ProductDiscountData)
Product_CreateDiscountAccumulative

Creates a ProductDiscountAccumulative

  • return: The id of the newly created ProductDiscountAccumulative
int Product_CreateDiscountAccumulative (ProductDiscountAccumulativeCreate $ProductDiscountAccumulativeData)
Product_CreateExtraBuyCategory

Creates a new ProductExtraBuyCategory

  • return: The id of the newly created ProductExtraBuyCategory
int Product_CreateExtraBuyCategory (ProductExtraBuyCategoryCreate $ExtraBuyCategoryData)
Product_CreateExtraBuyRelation

Creates a new ProductExtraBuyRelation

  • return: The id of the newly created ProductExtraBuyRelation
int Product_CreateExtraBuyRelation (ProductExtraBuyRelationCreate $ExtraBuyRelationData)
Product_CreateFile

Creates a new ProductFile

  • return: The id of the newly created ProductFile
int Product_CreateFile (ProductFileCreate $FileData)
Product_CreateOrUpdate

Creates or Updates a Product using its ItemNumber as key. Assumes that only unique ItemNumbers exist in the shop. If the Itemnumber supplied is not found a new product is created

  • return: the id of the updated Product
int Product_CreateOrUpdate (ProductCreateUpdate $ProductData)
Product_CreateOrUpdateVariant

Creates or Updates a ProductVariant using its ItemNumber as key. Assumes that only unique ItemNumbers exist in the shop. If the Itemnumber supplied is not found a new ProductVariant is created

  • return: the id of the created or updated ProductVariant
int Product_CreateOrUpdateVariant (ProductVariantCreateUpdate $VariantData)
Product_CreateOrUpdateVariantType

Creates or Updates a ProductVariantType using Title as key. Assumes that only unique ProductVariantType Titles in a given language exist in the shop. If the Title supplied is not found a new ProductVariantType is created

  • return: The id of the created or updated ProductVariantType
int Product_CreateOrUpdateVariantType (ProductVariantTypeCreateUpdate $VariantTypeData)
Product_CreateOrUpdateVariantTypeValue

Creates or Updates a ProductVariantTypeValue using Title and ProductVariantType id as keys. If the Title supplied is not found a new ProductVariantTypeValue is created

  • return: The id of the updated ProductVariantTypeValue
int Product_CreateOrUpdateVariantTypeValue (ProductVariantTypeValueCreateUpdate $VariantTypeValueData)
Product_CreatePicture

Creates a new ProductPicture

  • return: The id of the newly created ProductPicture
int Product_CreatePicture (ProductPictureCreate $PictureData)
Product_CreateUnit

Creates a new ProductUnit

  • return: The id of the newly created ProductUnit
int Product_CreateUnit (ProductUnitCreate $ProductUnitData)
Product_CreateVariant

Creates a new ProductVariant

  • return: The id of the newly created ProductVariant
int Product_CreateVariant (ProductVariantCreate $VariantData)
Product_Delete

Deletes a Product

boolean Product_Delete (int $ProductId)
  • int $ProductId: The id of the Product to delete
Product_DeleteAdditional

Deletes a ProductAdditional

boolean Product_DeleteAdditional (int $ProductAdditionalId)
  • int $ProductAdditionalId: The id of the ProductAdditional to delete
Product_DeleteAllDiscountAccumulativeByProductGroup

Deletes all ProductDiscountAccumulatives of a DiscountGroupProduct

boolean Product_DeleteAllDiscountAccumulativeByProductGroup (string $DiscountGroupProductTitle)
  • string $DiscountGroupProductTitle: The Title of the DiscountGroupProduct
Product_DeleteAllDiscountAccumulatives

Deletes all ProductDiscountAccumulatives of a Product

boolean Product_DeleteAllDiscountAccumulatives (string $ProductItemNumber)
  • string $ProductItemNumber: The Itemnumber of the Product
Product_DeleteAllDiscounts

Deletes all ProductDiscounts of a Product

boolean Product_DeleteAllDiscounts (string $ProductItemNumber)
  • string $ProductItemNumber: The Itemnumber of the Product
Product_DeleteCustomData

Deletes a ProductCustomData

boolean Product_DeleteCustomData (int $ProductCustomDataId)
  • int $ProductCustomDataId: The id of the ProductCustomData to delete
Product_DeleteCustomDataType

Deletes a ProductCustomDataType

boolean Product_DeleteCustomDataType (int $ProductCustomDataTypeId)
  • int $ProductCustomDataTypeId: The id of the ProductCustomDataType to delete
Product_DeleteDeliveryCountry

Deletes a ProductDeliveryCountry

boolean Product_DeleteDeliveryCountry (int $ProductDeliveryCountryId)
  • int $ProductDeliveryCountryId: The id of the ProductDeliveryCountry to delete
Product_DeleteDeliveryTime

Deletes a ProductDeliveryTime

boolean Product_DeleteDeliveryTime (int $ProductDeliveryTimeId)
  • int $ProductDeliveryTimeId: The id of the ProductDeliveryTime to delete
Product_DeleteDiscount

Deletes a ProductDiscount

boolean Product_DeleteDiscount (int $ProductDiscountId)
  • int $ProductDiscountId: The id of the ProductDiscount to delete
Product_DeleteDiscountAccumulative

Deletes a ProductDiscountAccumulative

boolean Product_DeleteDiscountAccumulative (int $ProductDiscountAccumulativeId)
  • int $ProductDiscountAccumulativeId: The id of the ProductDiscountAccumulative to delete
Product_DeleteExtraBuyCategory

Deletes a ProductExtraBuyCategory

boolean Product_DeleteExtraBuyCategory (int $ProductExtraBuyCategoryId)
  • int $ProductExtraBuyCategoryId: The id of the ProductExtraBuyCategory to delete
Product_DeleteExtraBuyRelation

Deletes a ProductExtraBuyRelation

boolean Product_DeleteExtraBuyRelation (int $ProductExtraBuyRelationId)
  • int $ProductExtraBuyRelationId: The id of the ProductExtraBuyRelation to delete
Product_DeleteFile

Deletes a ProductPicture

boolean Product_DeleteFile ( $FileId, int $PictureId)
  • int $PictureId: The id of the ProductPicture to delete
  • $FileId
Product_DeletePicture

Deletes a ProductPicture

boolean Product_DeletePicture (int $PictureId)
  • int $PictureId: The id of the ProductPicture to delete
Product_DeleteTag

Deletes a ProductTag

boolean Product_DeleteTag (int $ProductTagId)
  • int $ProductTagId: The id of the ProductTag to delete
Product_DeleteUnit

Deletes a ProductUnit

boolean Product_DeleteUnit (int $ProductUnitId)
  • int $ProductUnitId: The id of the ProductUnit to delete
Product_DeleteVariant

Deletes a ProductVariant

boolean Product_DeleteVariant (int $VariantId)
  • int $VariantId: The id of the ProductVariant to delete
Product_GetAdditionals

Returns the ProductAdditionals of the indicated ProductAdditionalType

  • return: An array of ProductAdditional Objects
ProductAdditional[] Product_GetAdditionals (int $AdditionalTypeId)
  • int $AdditionalTypeId: The id of the ProductAdditionalType of the wanted ProductAdditionals
Product_GetAdditionalTypes

Returns the ProductAdditionalTypes of the indicated Product

  • return: An array of ProductAdditionalType Objects
ProductAdditionalType[] Product_GetAdditionalTypes (int $ProductId)
  • int $ProductId: The id of the Product of the wanted ProductAdditionalTypes
Product_GetAdditionalTypesAll

Returns all ProductAdditionalTypes of the solution

  • return: An array of ProductAdditionalType Objects
ProductAdditionalType[] Product_GetAdditionalTypesAll ()
Product_GetAll

Returns information about Products. The output format can be set with Product_SetFields

  • return: An array of Product Objects
Product[] Product_GetAll ()
Product_GetAllExtraBuyCategory

Returns all ProductExtraBuyCategories

  • return: An Array of ProductExtraBuyCategory Objects
ProductExtraBuyCategory[] Product_GetAllExtraBuyCategory ()
Product_GetAllWithLimit

Equal to Product_GetAll, however it returns only $Length amount of products starting as index $Start. The output format can be set with Product_SetFields

  • return: An array of Product Objects
Product[] Product_GetAllWithLimit ( $Start,  $Length)
  • $Start
  • $Length
Product_GetByBrand

Returns the products with this brand. The output format can be set with Product_SetFields

  • return: An array of Product Objects
Product[] Product_GetByBrand (int $BrandId)
  • int $BrandId: The id of the Brand of the wanted Products
Product_GetByCategory

Returns the products with this category as their main category. The output format can be set with Product_SetFields

  • return: An array of Product Objects
Product[] Product_GetByCategory (int $CategoryId)
  • int $CategoryId: The id of the Category of the wanted Products
Product_GetByCategoryAndSecondary

Returns the products with this category as their main or secondary category. The output format can be set with Product_SetFields

  • return: An array of Product Objects
Product[] Product_GetByCategoryAndSecondary (int $CategoryId)
  • int $CategoryId: The id of the Category of the wanted Products
Product_GetById

Returns the indicated Product. The output format can be set with Product_SetFields

  • return: A Product Object
Product Product_GetById (int $ProductId)
  • int $ProductId: The id of the wanted Product
Product_GetByIds

Returns the indicated Product. The output format can be set with Product_SetFields

  • return: A Product Object
Product Product_GetByIds ( $ProductIds, int $ProductId)
  • int $ProductId: The id of the wanted Product
  • $ProductIds
Product_GetByItemNumber

Returns the indicated Product. The output format can be set with Product_SetFields

  • return: An array of Product Objects
Product[] Product_GetByItemNumber (string $ItemNumber)
  • string $ItemNumber: The itemnumber of the wanted Product
Product_GetByUpdatedDate

Returns information about Products that have been updated within the supplied start- and end dates. The output format can be set with Product_SetFields

  • return: An array of Product Objects
Product[] Product_GetByUpdatedDate (string $Start, string $End)
  • string $Start: The startdate of the query in 'yyyy-mm-dd' or 'yyyy-mm-dd hh:mm:ss' format. Null to fetch products from first entry
  • string $End: The enddate of the query in 'yyyy-mm-dd' or 'yyyy-mm-dd hh:mm:ss' format. Null to fetch products to this day
Product_GetCustomData

Returns the ProductCustomData of the indicated Product

  • return: An array of ProductCustomData Objects
ProductCustomData[] Product_GetCustomData (int $ProductId)
  • int $ProductId: The id of the Product of the wanted ProductCostumData's
Product_GetCustomDataAll

Returns all ProductCustomData of the solution

  • return: An array of ProductCustomData Objects
ProductCustomData[] Product_GetCustomDataAll ()
Product_GetCustomDataById

Returns the indicated ProductCustomData

  • return: A ProductCustomData Object
ProductCustomData Product_GetCustomDataById (int $CustomDataId)
  • int $CustomDataId: The id of ProductCostumData
Product_GetCustomDataByType

Returns the ProductCustomDatas of the indicated ProductCustomDataType

  • return: An array of ProductCustomData Objects
ProductCustomData[] Product_GetCustomDataByType (int $CustomDataTypeId)
  • int $CustomDataTypeId: The id of ProductCostumDataType
Product_GetCustomDataType

Returns the indicated ProductCustomDataType

  • return: A ProductCustomDataType Object
ProductCustomDataType Product_GetCustomDataType (int $CustomDataTypeId)
  • int $CustomDataTypeId: The id of the wanted ProductCustomDataType
Product_GetCustomDataTypeAll

Returns all ProductCustomDataTypes

  • return: An array of ProductCustomDataType Objects
ProductCustomDataType[] Product_GetCustomDataTypeAll ()
Product_GetDeliveryCountry

Returns the indicated ProductDeliveryCountry

  • return: A ProductDeliveryCountry Object
ProductDeliveryCountry Product_GetDeliveryCountry (int $DeliveryCountryId)
  • int $DeliveryCountryId: The id of the wanted ProductDeliveryCountry
Product_GetDeliveryCountryAll

Returns all ProductDeliveryCountries

  • return: An array of ProductDeliveryCountry Objects
ProductDeliveryCountry[] Product_GetDeliveryCountryAll ()
Product_GetDeliveryCountryByCode

Returns the indicated ProductDeliveryCountry

  • return: A ProductDeliveryCountry Object
ProductDeliveryCountry Product_GetDeliveryCountryByCode ( $DeliveryCountryCode, int $DeliveryCountryId)
  • int $DeliveryCountryId: The code of the wanted ProductDeliveryCountry
  • $DeliveryCountryCode
Product_GetDeliveryCountryByIso

Returns the indicated ProductDeliveryCountry

  • return: A ProductDeliveryCountry Object
ProductDeliveryCountry Product_GetDeliveryCountryByIso ( $DeliveryCountryIso, int $DeliveryCountryId)
  • int $DeliveryCountryId: The iso of the wanted ProductDeliveryCountry
  • $DeliveryCountryIso
Product_GetDeliveryTime

Returns the indicated ProductDeliveryTime

  • return: A ProductDeliveryTime Object
ProductDeliveryTime Product_GetDeliveryTime (int $DeliveryTimeId)
  • int $DeliveryTimeId: The id of the wanted ProductDeliveryTime
Product_GetDeliveryTimeAll

Returns all ProductDeliveryTimes

  • return: An array of ProductDeliveryTime Objects
ProductDeliveryTime[] Product_GetDeliveryTimeAll ()
Product_GetDiscount

Returns a ProductDiscount

  • return: a ProductDiscount Object
ProductDiscount Product_GetDiscount (int $DiscountId)
  • int $DiscountId: DiscountId the id of the ProductDiscount
Product_GetDiscountAccumulative

Returns a ProductDiscountAccumulative

  • return: a ProductDiscountAccumulative Object
ProductDiscountAccumulative Product_GetDiscountAccumulative (int $DiscountId)
  • int $DiscountId: DiscountId the id of the ProductDiscountAccumulative
Product_GetDiscountGroup

Returns the indicated DiscountGroup

  • return: A DiscountGroup Object
DiscountGroup Product_GetDiscountGroup (int $DiscountGroupId)
  • int $DiscountGroupId: The id of the wanted DiscountGroup
Product_GetDiscounts

Returns the ProductDiscounts of a product

  • return: An array of ProductDiscount Objects
ProductDiscount[] Product_GetDiscounts (int $ProductId)
  • int $ProductId: ProductId the id of the Product
Product_GetDiscountsAccumulative

Returns the ProductDiscountAccumulatives of a Product

  • return: an array of ProductDiscountAccumulative Objects
ProductDiscountAccumulative[] Product_GetDiscountsAccumulative (int $ProductId)
  • int $ProductId: ProductId the id of the Product
Product_GetDiscountsAccumulativeAll

Returns All ProductDiscountAccumulatives

  • return: an array of ProductDiscountAccumulative Objects
ProductDiscountAccumulative[] Product_GetDiscountsAccumulativeAll ()
Product_GetDiscountsAccumulativeByProductGroup

Returns the ProductDiscountAccumulatives of a DiscountGroupProduct

  • return: an array of ProductDiscountAccumulative Objects
ProductDiscountAccumulative[] Product_GetDiscountsAccumulativeByProductGroup (int $DiscountGroupProductId)
  • int $DiscountGroupProductId: DiscountGroupProductId the id of the DiscountGroupProduct
Product_GetDiscountsAccumulativeByUser

Returns the ProductDiscountAccumulatives of a User

  • return: an array of ProductDiscountAccumulative Objects
ProductDiscountAccumulative[] Product_GetDiscountsAccumulativeByUser (int $UserId)
  • int $UserId: UserId the id of the User
Product_GetDiscountsAccumulativeByUserGroup

Returns the ProductDiscountAccumulatives of a UserDiscountGroup

  • return: an array of ProductDiscountAccumulative Objects
ProductDiscountAccumulative[] Product_GetDiscountsAccumulativeByUserGroup (int $UserDiscountGroupId)
  • int $UserDiscountGroupId: UserDiscountGroupId the id of the User
Product_GetExtraBuyCategory

Returns the indicated ProductExtraBuyCategory

  • return: A ProductExtraBuyCategory Object
ProductExtraBuyCategory Product_GetExtraBuyCategory (int $ExtraBuyCategoryId)
  • int $ExtraBuyCategoryId: The id of the wanted ExtraBuyCategory
Product_GetExtraBuyRelations

Returns the ProductExtraBuyRelations of the indicated Product

  • return: An array of ProductExtraBuyRelation Objects
ProductExtraBuyRelation[] Product_GetExtraBuyRelations (int $ProductId)
  • int $ProductId: The id of the Product of the wanted ProductExtraBuyRelations
Product_GetFiles

Returns the ProductFiles of the indicated Product

  • return: An array of ProductFile Objects
ProductFile[] Product_GetFiles (int $ProductId)
  • int $ProductId: The id of the Product of the wanted ProductFiles
Product_GetPictures

Returns the ProductPictures of the indicated Product

  • return: An array of ProductPicture Objects
ProductPicture[] Product_GetPictures (int $ProductId)
  • int $ProductId: The id of the Product of the wanted ProductPictures
Product_GetSecondaryCategories

Returns the secondary Categories of the indicated Product

  • return: An array of Category Objects
Category[] Product_GetSecondaryCategories (int $ProductId)
  • int $ProductId: The id of the Product of the wanted Categories
Product_GetTags

Returns the ProductTags of the indicated Product

  • return: an array of ProductTag Objects
ProductTag[] Product_GetTags (int $ProductId)
  • int $ProductId: The id of the Product of the wanted ProductTags
Product_GetUnitAll

Returns all ProductUnits.

  • return: An array of ProductUnit Objects
ProductUnit[] Product_GetUnitAll ()
Product_GetUnitById

Returns the indicated ProductUnit.

  • return: A ProductUnit Object
ProductUnit Product_GetUnitById (int $ProductUnitId)
  • int $ProductUnitId
Product_GetVariantById

Returns the ProductVariant with the indicated id

  • return: a ProductVariant Object
ProductVariant Product_GetVariantById (string $VariantId)
  • string $VariantId: The ItemNumber of the wanted ProductVariant
Product_GetVariants

Returns the ProductVariants of the indicated Product

  • return: An array of ProductVariant Objects
ProductVariant[] Product_GetVariants (int $ProductId)
  • int $ProductId: The id of the Product of the wanted ProductVariants
Product_GetVariantsByItemNumber

Returns the ProductVariant(s) with the indicated ItemNumber

  • return: An array of ProductVariant Objects
ProductVariant[] Product_GetVariantsByItemNumber (string $ItemNumber)
  • string $ItemNumber: The ItemNumber of the wanted ProductVariant
Product_GetVariantsSorted

Returns the ProductVariants of the indicated Product in Sorted order

  • return: An array of ProductVariant Objects
ProductVariant[] Product_GetVariantsSorted (int $ProductId)
  • int $ProductId: The id of the Product of the wanted ProductVariants
Product_GetVariantType

Returns the indicated ProductVariantType

  • return: A ProductVariantType Object
ProductVariantType Product_GetVariantType (int $VariantTypeId)
  • int $VariantTypeId: The id of the wanted ProductVariantType
Product_GetVariantTypeValue

Returns the ProductVariantTypeValue

  • return: A ProductVariantTypeValue Object
ProductVariantTypeValue Product_GetVariantTypeValue (int $TypeValueId)
  • int $TypeValueId: The id of the ProductVariantTypeValue
Product_GetVariantTypeValues

Returns the ProductVariantTypeValues of the indicated Variant

  • return: An array of ProductVariantTypeValue Objects
ProductVariantTypeValue[] Product_GetVariantTypeValues (int $VariantId)
  • int $VariantId: The id of the ProductVariant of the wanted ProductVariantTypeValues
Product_GetVariantTypeValuesByType

Returns the ProductVariantTypeValues of the indicated ProductVariantType

  • return: An array of ProductVariantTypeValue Objects
ProductVariantTypeValue[] Product_GetVariantTypeValuesByType ( $VariantTypeId)
  • $VariantTypeId
Product_RemoveAdditionalType

Removes a ProductAdditionalType from the indicated Product

boolean Product_RemoveAdditionalType (int $ProductId, int $AdditionalTypeId)
  • int $ProductId: The id of the Product to remove the ProductAdditionalType from
  • int $AdditionalTypeId: The id of the ProductAdditionalType
Product_RemoveCustomData

Removes a ProductCostumData from the indicated Product

boolean Product_RemoveCustomData (int $ProductId, int $CustomDataId)
  • int $ProductId: The id of the Product to remove the ProductCustomData from
  • int $CustomDataId: The id of the ProductCustomData
Product_Search

Searches for products relevant for the given searchstring

Product[] Product_Search (string $SearchString)
  • string $SearchString: the string to search for
Product_SetFields

Sets the outputformat for all methods returning Product Objects. If not set, the output format includes the Id

boolean Product_SetFields (string $Fields)
  • string $Fields: A comma separated list of Fieldnames. Must Match fieldnames of the Product Object
Product_SetVariantFields

Sets the output format for all methods returning ProductVariant Objects. If not set, the output format includes the Id

boolean Product_SetVariantFields (string $Fields)
  • string $Fields: Comma separated list of fieldnames. Must match the fields in the ProductVariant Object
Product_Update

Updates a Product. Either Id or Itemnumber can be used as identifier. If Itemnumber is used, this call might update several Products in case they have the same Itemnumber. If the Itemnumber supplied is not found a new product is created

  • return: The ids of the updated Products
int[] Product_Update (ProductUpdate $ProductData)
  • ProductUpdate $ProductData: The input in ProductUpdate Object format
Product_UpdateCustomData

Upates a ProductCustomData

  • return: The id of the updated ProductCustomData
int Product_UpdateCustomData (ProductCustomDataUpdate $ProductCustomData)
Product_UpdateCustomDataType

Upates a ProductCustomDataType

  • return: The id of the updated ProductCustomDataType
int Product_UpdateCustomDataType ( $ProductCustomDataType, ProductCustomDataTypeUpdate $ProductCustomData)
Product_UpdateCustomTextData

Updates the text of a 'textype' ProductCostumData for the indicated Product

boolean Product_UpdateCustomTextData (int $ProductId, int $CustomDataTypeId, string $Text)
  • int $ProductId: The id of the Product for which to update the ProductCustomData
  • int $CustomDataTypeId: The id of the ProductCustomDateType of the ProductCustomData Object
  • string $Text: The new text of the ProductCustomData
Product_UpdateDeliveryCountry

Updates a ProductDeliveryCountry

  • return: The id of the ProductDeliveryCountry
int Product_UpdateDeliveryCountry (ProductDeliveryCountryUpdate $DeliveryCountryData)
Product_UpdateDeliveryTime

Updates a ProductDeliveryTime

  • return: The id of the ProductDeliveryTime
int Product_UpdateDeliveryTime (ProductDeliveryTimeUpdate $DeliveryTimeData)
Product_UpdateDiscount

Updates a ProductDiscount

  • return: The id of the updated ProductDiscount
int Product_UpdateDiscount (ProductDiscountUpdate $ProductDiscountData)
Product_UpdateDiscountAccumulative

Updates a ProductDiscountAccumulative

  • return: The id of the updated ProductDiscountAccumulative
int Product_UpdateDiscountAccumulative (ProductDiscountAccumulativeUpdate $ProductDiscountAccumulativeData)
Product_UpdateExtraBuyCategory

Updates a ProductExtraBuyCategory

  • return: The id of the updated ProductExtraBuyCategory
int Product_UpdateExtraBuyCategory (ProductExtraBuyCategoryUpdate $ExtraBuyCategoryData)
Product_UpdateExtraBuyRelation

Updates a ProductExtraBuyRelation

  • return: The id of the updated ProductExtraBuyRelation
int Product_UpdateExtraBuyRelation (ProductExtraBuyRelationUpdate $ExtraBuyRelationData)
Product_UpdateFile

Updates a ProductFile

  • return: The id of the updated ProductFile
int Product_UpdateFile (ProductPictureUpdate $FileData)
Product_UpdatePicture

Updates a ProductPicture

  • return: The id of the updated ProductPicture
int Product_UpdatePicture (ProductPictureUpdate $PictureData)
Product_UpdateUnit

Updates a ProductUnit

  • return: The id of the ProductUnit
int Product_UpdateUnit (ProductUnitUpdate $ProductUnitData)
Product_UpdateVariant

Updates a ProductVariant. Either Id or Itemnumber can be used as identifier. If Itemnumber is used, this call might update several variants in case they have the same Itemnumber.

  • return: The ids of the updated ProductVariants
int[] Product_UpdateVariant (ProductVariantUpdate $VariantData)
Product_UpdateVariantType

Updates a ProductVariantType

  • return: The id of the updated ProductVariantType
int Product_UpdateVariantType (ProductVariantTypeUpdate $VariantTypeData)
Product_UpdateVariantTypeValue

Updates a ProductVariantTypeValue

  • return: The id of the created or updated ProductVariantTypeValue
int Product_UpdateVariantTypeValue ( $VariantTypeValueData, ProductVariantTypeValueUpdate $VariantTypeData)
SEORedirect_Delete

Deletes a SEORedirect

boolean SEORedirect_Delete (int $SEORedirectId)
  • int $SEORedirectId: The id of the SEORedirect to delete
SEORedirect_GetAll

Returns all SEORedirects.

  • return: An array of SEORedirect Objects
SEORedirect[] SEORedirect_GetAll ()
SEORedirect_GetById

Returns the indicated SEORedirect.

  • return: A SEORedirect Object
SEORedirect SEORedirect_GetById (int $SEORedirectId)
  • int $SEORedirectId
Sites_GetAll

Returns the Sites of the solution

  • return: An Array of Site objects
Site[] Sites_GetAll ()
Sites_GetById

Returns the Sites of the solution

  • return: An Array of Site objects
Site[] Sites_GetById (int $SiteId)
  • int $SiteId: the id of the site
Solution_Connect

Connects to a Solution

boolean Solution_Connect (string $Username, string $Password)
  • string $Username: The name of the solution
  • string $Password: The password for the solution
Solution_CreateThumb

Creates a thumbnail of an image and returns its path (if the thumbnail already exists the path is returned without other actions)

string Solution_CreateThumb (string $ImagePath, int $ThumbWidth, int $ThumbHeight, bool $Crop, bool $Greyscale, bool $Watermark)
  • string $ImagePath: the path and name of the image
  • int $ThumbWidth: the width of the thumbnail
  • int $ThumbHeight: the height of the thumbnail
  • bool $Crop: wether or not to crop
  • bool $Greyscale: wether or not to greyscale
  • bool $Watermark: wether or not to watermark the thumbnail
Solution_CreateThumbs

Creates thumbnails of images and returns their paths (if the thumbnail already exists the path is returned without other actions)

string[] Solution_CreateThumbs (string[] $ImagePaths, int $ThumbWidth, int $ThumbHeight, bool $Crop, bool $Greyscale, bool $Watermark)
  • string[] $ImagePaths: the paths and name of the images
  • int $ThumbWidth: the width of the thumbnail
  • int $ThumbHeight: the height of the thumbnail
  • bool $Crop: wether or not to crop
  • bool $Greyscale: wether or not to greyscale
  • bool $Watermark: wether or not to watermark the thumbnail
Solution_DeleteCustomData

Deletes a CustomData

boolean Solution_DeleteCustomData (int $CustomDataId)
  • int $CustomDataId: The id of the CustomData to delete
Solution_GetLanguages

Returns the utilized languages of this system

  • return: An array of SolutionLanguage Objects
SolutionLanguage[] Solution_GetLanguages ()
Solution_GetWebinfo

Returns the web information for the solution

  • return: A ShopWebinfo object
ShopWebinfo Solution_GetWebinfo ()
Solution_HasModule

Checks whether or not the solution has the module

  • return: true if the solution has the module, false if not
boolean Solution_HasModule (string $module)
  • string $module: the name of the module
Solution_SetCaseSensitiveItemNumber

Enables or disables case sensitive matching of ItemNumbers for alle methods using these as keys. Default is non-case-sensitive mode

boolean Solution_SetCaseSensitiveItemNumber (bool $Enabled)
  • bool $Enabled: Wether or not case sensitive mode is enabled
Solution_SetEncoding

Sets the encoding of all outgoing textfields, and the expected encoding of all incomming fields. It is recommended to stick to the same encoding for input and output functions.

  • return: true at success
bool Solution_SetEncoding (string $Encoding)
  • string $Encoding: either ISO-8859-1, UTF-8, HTML-ENTITIES (HTML-ENTITIES for all special characters)
Solution_SetLanguage

Sets the SolutionLanguage of this shop instance. This affects all Objects with language specific text

boolean Solution_SetLanguage (string $LanguageISO)
  • string $LanguageISO: if no language is set, the primary ShopLanguage is selected
Solution_UpdateCustomData

Upates a CustomData

  • return: The id of the updated CustomData
int Solution_UpdateCustomData (CustomDataUpdate $CustomData)
User_Create

Creates a new User

  • return: The id of the newly created User
int User_Create (UserCreate $UserData)
  • UserCreate $UserData: The inputdata in UserCreate Object form
User_CreateGroup

Creates a new UserGroup

  • return: The id of the newly created UserGroup
int User_CreateGroup (UserGroupCreate $UserGroupData)
  • UserGroupCreate $UserGroupData: The input in UserGroupCreate Object format
User_CreateOrUpdate

* Creates or Updates a User using Username as key. Assumes that only unique Usernames exist in the shop. If the Username supplied is not found a new User is created

  • return: The id of the updated User
int User_CreateOrUpdate (UserCreateUpdate $UserData)
User_Delete

Deletes a User

boolean User_Delete (int $UserId)
  • int $UserId: The id of the User to delete
User_DeleteGroup

Deletes a UserGroup

boolean User_DeleteGroup (int $UserGroupId)
  • int $UserGroupId: The id of the UserGroup to delete
User_GetAll

Returns all Users. The output format can be set with User_SetFields

  • return: An Array of User Objects
User[] User_GetAll ()
User_GetAllByDate

Returns all Users created or updated in a given timespan. The output format can be set with User_SetFields

  • return: An Array of User Objects
User[] User_GetAllByDate (string $Start, string $End)
  • string $Start: the start date of the query in 'yyyy-mm-dd' or 'yyyy-mm-dd hh:mm:ss' format. Null to fetch users from current date and on
  • string $End: the end date of the query in 'yyyy-mm-dd' or 'yyyy-mm-dd hh:mm:ss' format. Null to fetch users to current date and before
User_GetAllNewsletter

Returns all Newsletter Users. The output format can be set with User_SetFields

  • return: An Array of User Objects
User[] User_GetAllNewsletter (bool $isNotSyncedOnly, bool $unsubscribeOnly)
  • bool $isNotSyncedOnly: Return only users that are not synced
  • bool $unsubscribeOnly: Return only users that are synced and not subscribed
User_GetAllNewsletterByDate

Returns all Newsletter Users created or updated in a given timespan. The output format can be set with User_SetFields

  • return: An Array of User Objects
User[] User_GetAllNewsletterByDate (string $Start, string $End)
  • string $Start: the start date of the query in 'yyyy-mm-dd' or 'yyyy-mm-dd hh:mm:ss' format. Null to fetch users from current date and on
  • string $End: the end date of the query in 'yyyy-mm-dd' or 'yyyy-mm-dd hh:mm:ss' format. Null to fetch users to current date and before
User_GetByGroup

Returns Users of the incidated UserGroup. The output format can be set with User_SetFields

  • return: An Array of User Objects
User[] User_GetByGroup (int $UserGroupId)
  • int $UserGroupId: The id of the UserGroup
User_GetById

Returns the indicated User. The output format can be set with User_SetFields

  • return: A User Object
User User_GetById (int $UserId)
  • int $UserId
User_GetByName

Returns users with a full or partial match of the supplied name. The output format can be set with User_SetFields

  • return: An Array of User Objects
User[] User_GetByName (string $UserName)
  • string $UserName: The name to match against
User_GetGroupAll

Returns all UserGroups of the solution

  • return: An array of UserGroup Objects
UserGroup[] User_GetGroupAll ($withInterests $withInterests)
  • $withInterests $withInterests: wether or not interests should be returned with interest fields included
User_GetGroupById

Returns the indicated UserGroup

  • return: A UserGroup Object
UserGroup User_GetGroupById (int $UserGroupId)
  • int $UserGroupId: The id of the UserGroup
User_SetFields

Sets the outputformat for all methods returning User Objects. If not set, the output format includes only the Id

boolean User_SetFields (string $Fields)
  • string $Fields: A comma separated list of Fieldnames. Must Match fieldnames of the User Object
User_Update

Updates a User

  • return: The id of the updated User
int User_Update (UserUpdate $UserData)
  • UserUpdate $UserData: The inputdata in UserUpdate Object form
User_UpdateGroup

Updates a UserGroup

  • return: The id of the UserGroup
int User_UpdateGroup (UserGroupUpdate $UserGroupData)
  • UserGroupUpdate $UserGroupData: The input in UserGroupUpdate Object format
VatGroup_Create

Creates a new VatGroup

  • return: The id of the newly created VatGroup
int VatGroup_Create (VatGroupCreate $VatGroupData)
  • VatGroupCreate $VatGroupData: The inputdata in VatGroupCreate Object form
VatGroup_Delete

Deletes a VatGroup

boolean VatGroup_Delete (int $VatGroupId)
  • int $VatGroupId: The id of the VatGroup to delete
VatGroup_GetAll

Returns the VatGroups of the solution

  • return: An Array of VatGroup objects
VatGroup[] VatGroup_GetAll ()
VatGroup_GetById

Returns the indicated VatGroup

  • return: A VatGroup Object
VatGroup VatGroup_GetById (int $VatGroupId)
  • int $VatGroupId: The id of the wanted VatGroup
VatGroup_Update

Updates a User

  • return: The id of the updated VatGroup
int VatGroup_Update (VatGroupUpdate $VatGroupData)
  • VatGroupUpdate $VatGroupData: The inputdata in VatGroupUpdate Object form

Documentation generated on Tue, 18 Jul 2017 10:17:27 +0200 by phpDocumentor 1.4.4