Site service¶

Contains methods that are general, i.e. not specifically connected to order or customer objects.

GetBonusVouchers(CustomerId, LoginInfo)¶

Method retrieved a list of unused bonus vouchers (“värdecheck”) for a specified customer.

Parameter	Type	Max length	Description	Example
customerId	string	9 char	The customer id the order belongs to	123124332
LoginInfo	object		See section LoginInfo

Return value	Comment
A ListWrapper of BonusVoucher objects	See section BonusVoucher

GetGiftVoucher(voucherId, LoginInfo)¶

Method retrieves information about the specified gift voucher, with the help of the ID as argument. If the voucher id is empty or if it doesn’t exist (id is not valid) you will get an error message.

Note: Please note that although Id is a String Harmoney will only accept no characters except digits, unless the parameter “Alternative Gift Voucher Number” is active. The parameter allows gift voucher id to be numbers, letters and/or special characters. Please see your Pulsen contact for more information.

Note on usage: When saving an order, you add the GiftVoucher to Order.VoucherList and the amount will automatically be withdrawn from the order sum. If the value of the gift voucher value completely covers the order value no additional payment method is necessary. Remaining voucher value can be retrieved by a new call to GetGiftVoucher. If the value of the gift voucher does not cover the order value it can be combined with any other payment method. The value of the gift voucher will be withdrawn from the order sum before the other payment method

Parameter	Type	Max length	Description	Example
voucherId	string	16 char	The id of the voucher	123123948
LoginInfo	object		See section LoginInfo

Return value	Comment
A single GiftVoucher object	See section GiftVoucher

GetObligation(obligationId, LoginInfo)¶

Method retrieves information about the specified obligation. ObligationID is returned from GetPremiumOffer

Parameter	Type	Max length	Description	Example
ObligationId	string	5 char	ObligationId
LoginInfo	object		See section LoginInfo

Return value	Comment
A single Obligation	See section Obligation

GetPickUpLocations(zipCode, LoginInfo)¶

Method fetches current available pick up locations for a certain Zip Code

Parameter	Type	Max length	Description	Example
zipCode	string	9 char	The Zip code or postal code	50744
LoginInfo	object		See section LoginInfo

Return value	Comment
A ListWrapper of PickUplocation objects	See section PickUpLocation

GetPickUpLocationsByCountryAndZipCode(country, zipCode, LoginInfo)¶

Method retrieves current available pick up locations for a certain Zip Code in a specified country. Use this method if a sales channel holds more than one country e.g. the EU sales channel contains Denmark, Finland and Germany

Parameter	Type	Max length	Description	Example
country	Enums.Country		The country where the zip code/postal code is located. The parameter should be the English name of the country	Sweden
zipCode	string	9 char	The Zip code or postal code	50744
LoginInfo	object		See section LoginInfo

Return value	Comment
A ListWrapper of PickUplocation objects	See section PickUpLocation

GetPickUpLocationsByAddress(country, zipCode, streetAddress, paymentMethod, LoginInfo)¶

Method retrieves current available pick up locations for a certain zip code and street address in a specified country. Use this method if you are using delivery method Bring. Paymentmethod-parameter is needed because some pickup locations doesn’t accept all payment methods

Parameter	Type	Max length	Description	Example
country	Enums.Country		The country where the zip code/postal code is located. The parameter should be the English name of the country	Sweden
zipCode	string	9 char	The Zip code or postal code	50744
streetAddress	string	35 char	Street address	Main street 1
paymentMethod	Enums.PaymentMethod		See section PaymentMethod	Invoice
LoginInfo	object		See section LoginInfo

Return value	Comment
A ListWrapper of PickUplocation objects	See section PickUpLocation

GetPickUpLocationsByDeliveryMethod(deliveryMethod, LoginInfo)¶

Method fetches current available pick up locations for a certain delivery Method. Delivery method is input as the corresponding Harmoney delivery method ID. Please contact your technical support for a list of applicable codes

Parameter	Type	Max length	Description	Example
deliveryMethod	string	2 char	A delivery method code	02
LoginInfo	object		See section LoginInfo

Return value	Comment
A ListWrapper of PickUplocation objects	See section PickUpLocation

GetPickUpLocationsByAny(country, city, zipCode, seviceZipCode, deliveryMethodId, pickUpLocationId, customerCategory, LoginInfo)¶

Method retrieves current available pick up locations for a certain country, city zip code, service zip code, pick up location id, customer category or delivery method. Both city and zip Code is not to be used in the same method call, neither is zipCode and deliveryMethodId. The request will get a “Improper search: Zip code should not be combined” response

Parameter	Type	Max length	Description	Example
country	Enums.Country		The country where the zip code/postal code is located. The parameter should be the English name of the country	Sweden
city	string	35 char	City where the pick up location is situated	Mytown
zipCode	string	9 char	The Zip code or postal code	50744
serviceZipCode	string	9 char(depending on country e.g. Sweden has max length 5 char)	The zip code where the pick up location is situated	50432
deliveryMethodId	string	2 char	The delivery method id. If the method is called with an “empty” DeliveryMethod the SystemDefault delivery method will be used	07 = MyPack
pickUpLocationId	string	10 char	The specific pick up location id	00012
customerCategory	string	2 char	Customer category i.e. Employee, Special	04
LoginInfo	object		See section LoginInfo

Return value	Comment
A ListWrapper of PickUplocation objects	See section PickUpLocation

GetPremiumOffer(campaignId, subCampaignId, LoginInfo)¶

Method retrieves information about the specified premium offers for a main campaign, with the help of the CampaignID as argument. If you only have the subCampaign use can leave campagin blank and use subCampaignId.

Parameter	Type	Max length	Description	Example
campaignId	string	7 char	The id of the main campaign in Harmoney	GRUND
subCampaignId	string	7 char	The id of the sub campaign in Harmoney	SUBCAMP
LoginInfo	object		See section LoginInfo

Return value	Comment
A single PremiumOffer	See section PremiumOffer

GetSubCampaign(subCampaignId, LoginInfo)¶

Method retrieves information about the specified sub campaign, with the help of the ID as argument.

Parameter	Type	Max length	Description	Example
subCampaignId	string	7 char	The id of the sub campaign in Harmoney	GRUND
LoginInfo	object		See section LoginInfo

Return value	Comment
A single SubCampaign	See section SubCampaign

UseBonusVoucher(voucherId, customerId, LoginInfo)¶

Method marks an unused bonus voucher (“värdecheck”) as used.

Parameter	Type	Max length	Description	Example
voucherId	string	22 char	The bonus voucher id of an unused voucher	123123
customerId	string	9 char	The customer id the order belongs to	123124332
LoginInfo	object		See section LoginInfo

Return value	Comment
A ListWrapper of BonusVoucher objects	See section BonusVoucher