Enumerations¶
Enumerations are used for setting common static values. List below shows valid values.
AccountType¶
Used for setting the account type on a customer user. A customer can have only one user account with the administrator permission.
| Name in WsPCL | Name in Harmoney | Description | Comment |
|---|---|---|---|
| Administrator | 01 | Administrator | Are able to create new user accounts. There can only be on administrator. |
| Regular | 02 | Regular user | Have access to login, but can’t create new user account |
AddressType¶
Used for the Address object to indicate the type of address.
| Name in WsPCL | Name in Harmoney | Description |
|---|---|---|
| Invoice | FaktAdr | Invoice address |
| Delivery | LevAdr | Delivery address |
| TemporaryDelivery | TillfLevAdr | Temporary delivery address |
| TemporaryInvoice | TillfAdr | Temporary invoice address |
Bool¶
Some values in Harmoney has three states. Used for when values can be True, False or Unknown.
| Name in WsPCL | Name in Harmoney | Description |
|---|---|---|
| UnKnown | Empty string or not set | |
| True | 01 | True or set to positive |
| False | 02 | False or set to negative |
ChangeItemType¶
Used with method GetChangedItems to indicate which kind of changes to return. GetChangedItems is only available if activated for your company. Please contact your sales contact for more information.
| Name in WsPCL | Name in Harmoney | Description |
|---|---|---|
| AllTypes | All types | Returns all types of changes |
| BaseProductData | Art | Returns changes related to base product data. |
| ProductName | ArtBen | Returns changes related to product name |
| ProductDescription | ArtBeskr | Returns changes related to product description |
| RelatedProduct | ArtRel | Returns changes related to related products |
| ReferenceProduct | ArtRef | Returns changes related to references products |
| BaseItem | ArtVar | Returns changes related to base item |
| BaseItemDate | ArtVarDat | Returns changes related to item date |
| ProductPrice | ArtPr | Returns changes related to product price |
| ProductPriceGroup | ArtPrGrp | Returns changes related to product price group |
| ProductBrand | ArVaruMarke | Returns changes related to product brand |
| WarehouseProduct | LagArt | Returns changes related to storage/warehouse product |
| WarehouseItem | LagArtVar | Returns changes related to storage/warehouse item |
| WarehouseSupplier | LagArtLev | Returns changes related to storage/warehouse product supplier |
| AlternateProduct | ArtAlt | Returns changes related to storage/warehouse product supplier |
| ProductPredictor | ArtPred | Returns changes related to storage/warehouse product supplier |
| ProductStatisticsDate | ArtStatDag | Returns changes related to storage/warehouse product supplier |
| DeleteBaseProductData | Art | Returns changes related to deleting base product data |
| DeleteProductName | ArtBen | Returns changes related to deleting product name |
| DeleteProductDescription | ArtBeskr | Returns changes related to deleting product description |
| DeleteRelatedProduct | ArtRel | Returns changes related to deleting related products |
| DeleteReferencedProduct | ArtRef | Returns changes related to deleting referenced products |
| DeleteBaseItem | ArtVar | Returns changes related to deleting items |
| DeleteProductPrice | ArtPr | Returns changes related to deleting product prices |
| DeleteProductPriceGroup | ArtPrGrp | Returns changes related to deleting product price group |
| DeleteWarehouseProduct | LagArt | Returns changes related to deleting storage/warehouse products |
| DeleteWarehouseItem | LagArtVar | Returns changes related to deleting storage/warehouse item. |
| DeleteWarehouseSupplier | LagArtLev | Returns changes related to deleting storage/warehouse product supplier |
| DeleteAlternateProduct | ArtAlt | Returns changes related to deleting alternate products. |
| DeleteProductPredictor | ArtPred | Returns changes related to deleting predicted products. |
| ShowableOrderablde | Visbar/Bestbar | Returns changes related a products showable or orderable field |
| Unkown | Unkown | Default value, function as AllTypes |
ControlStatusValueType¶
The response on ValidateOrder/SaveOrder requests. The order can be stopped due to different reasons e.g. an order has been placed and the customers address doesn’t match the address present in Harmoney, this gives an OrderInControl response. The order needs to be processed by customer support.
| Name in WsPCL | Description | Comment |
|---|---|---|
| OrderStopped | The order has been accepted, but it will not be converted to an invoice | Value “91” equals OrderStopped |
| OrderInControl | The order is stopped and needs to be processed by customer support | Value “90” equals OrderInControl |
| NoControlStatus | Default value, the order has been processed with no control status |
Country¶
The Country enum is used to specify country. All available countries are listed in the enum, however only selected countries are applicable. Please refer to documentation supplied by client.
CreditCardType¶
The method used to save the order to Harmoney.
| Name in WsPCL | Description | Value In Harmoney | Comment |
|---|---|---|---|
| Visa | Visa | 01 | Default value |
| Eurocard | Eurocard | 02 | |
| Diners | Diners | 03 | |
| AMEX | AMEX | 04 | |
| Dancard | Dancard | 05 | |
| MasterCard | MasterCard | 06 | |
| VisaElectron | VisaElectron | 07 | |
| VisaDelta | VisaDelta | 08 | |
| Maestro | Maestro | 09 | |
| DancardVisa | DancardVisa | 10 | |
| Solo | Solo | 11 | |
| Lasercard | Lasercard | 12 | |
| DancardGenuine | DancardGenuine | 15 | |
| Masterpass | Masterpass | 16 | |
| MobilePay | MobilePay | 17 | |
| Swish | Swish | 18 | |
| Vipps | Vipps | 19 | |
| Avarda | Avarda | 20 | |
| KlarnaV3 | KlarnaV3 | 21 |
CreditCheckResult¶
Used when validating or saving an order to indicate if a credit check was successful.
| Name in WsPCL | Description |
|---|---|
| None | Default value, only acceptable when not using a credit card payment method |
| Passed | Credit check was accepted |
| ControlNeeded | Further credit check or manual handling is needed |
| Failed | Credit checka was not accepted |
CreditCheckStatus¶
Used when validating or saving an order to indicate if credits check has to been done for the current customer.
| Name in WsPCL | Description |
|---|---|
| NoCreditCheckConducted | No credit check has yet been done. A new credit check should be performed |
| LastCreditCheckExpired | The previous accepted credit check has expired. A new credit check should be performed |
| CreditCheckDenied | The current credit check was denied. A new credit check should be performed. |
| CreditCheckApproved | Credit check was accepted. No new credit check needs to be done at this time |
CreditCheckType¶
Indicates which type of credit check to perform. Currently Decidas and Business Check are available through Harmoney.
| Name in WsPCL | Description |
|---|---|
| None | Default value, credit checks will not be performed |
| Decidas | Credit checks will be performed through Decidas |
| BusinessCheck | Credit checks will be performed through Business Check. |
DeliveryMethod¶
Delivery methods in Harmoney (each one must be activated in Harmoney, consult customer which options thats available)
| Name in WsPCL | Value in Harmoney | Description |
|---|---|---|
| None | No Delivery method is sent | |
| SystemDefault | Sets the default of the system | |
| PostenLogistic | 01 | Posten Logistik |
| PostenMail | 02 | Posten Brev |
| PostenClaim | 03 | Posten Krav |
| PostenMechandizeMail | 04 | Posten Brev |
| CityMail | 05 | City mail |
| Schenker | 06 | Schenker |
| MyPack | 07 | Posten MyPack |
| RegisteredLetter | 08 | |
| Privpak | 11 | Posten Privpak |
| BringPostBox | 13 | Bring brevlådepaket |
| UPS_14 | 14 | UPS 14 |
| Bring | 15 | Bring |
| Interlink | 18 | Interlink |
| Spring | 19 | Spring |
| Bilfrakt | 20 | Bilfrakt |
| DHLParcel | 21 | DHL Parcel |
| DHLMail | 22 | DHL Mail |
| DAO | 23 | DAO |
| Itella | 24 | Itella |
| SwissPost | 26 | Swiss post |
| Kiala | 28 | Kiala |
| ByBoat | 31 | By boat |
| ByAir | 32 | By air |
| EestiPost | 33 | Estonian Postal Service |
| ItellaSmartPost | 34 | Itella Smart Post |
| LatviaPost | 35 | Latvian Postal Service |
| CzechPost | 36 | Czech Postal Service |
| SlovenskaPosta | 37 | Slovenian Postal Service |
| PocztaPolska | 38 | Polish Postal Service |
| PostaSlovenije | 39 | Slovenian Postal Service |
| PickUpInStore | 40 | Pick up in store |
| PPL | 41 | |
| DPD | 42 | |
| UPS | 43 | UPS |
| Post24 | 44 | Estonian Postal Service |
| SmartPostEstonia | 45 | Estonian Postal Service |
| EestiPost_NotPostOffice | 46 | Eesti post not postoffice |
| PostNord | 47 | PostNord |
| MyPack_GL_FO | 48 | MyPack (Grönland, Färöarna) |
| MyPack_FI_Parcel | 50 | My pack/Matkahuolto Paket |
| Mypack_FI_COD | 51 | My pack/Matkahuolto Brev/PF |
| BringHomeDelivery | 55 | Bring home delivery |
| BudBee | 56 | Budfirma storstäder |
| Centiro | 60 | Centiro |
| Internal | 90 | Internal post |
| Consignor | CO | Consignor |
DeliveryState¶
The current status of an order delivery.
| Name in WsPCL | Value in Harmoney | Name in Harmoney | Description |
|---|---|---|---|
| None | (Empty string) | No status set. Usually because order hasn’t been finished. | |
| Immediate | 01 | Omgående | Will be sent immediately as soon as the order is packed. |
| Pending | 02 | Restnoterad | Order is delayed pending inbound delivery. |
| TemporarilyOutOfStock | 03 | Tillfälligt slut | Order is delayed because product/item is currently out of stock. |
| OutOfStock | 04 | Slut | Order is delayed or cancelled because product/item is no longer in stock. |
| Delivered | 05 | Levererad | Order is delivered. |
| RecievedLater | 06 | Inkommer senare | Order is delayed pending inbound delivery later on. |
EmailBounce¶
The current bounce state of an email address
| Name in WsPCL | Value in Harmoney | Name in Harmoney | Description |
|---|---|---|---|
| None | N/A | N/A | Default value. Indicates no bounce or the value has not been set |
| Hard | 3 | Email attribut Indicates that bounce state for an email address is hard bounce |
ElectronicInvoice¶
What type of electronic invoice is used.
| Name in WsPCL | Value in Harmoney | Name in Harmoney | Description |
|---|---|---|---|
| None | 00 | ||
| EAN | 01 | GLN(EAN) | |
| OrgNr | 02 | OrgNr |
ErrorLevel¶
Used to indicate the severity of a call to WsPCL if it returns with error messages
| Name in WsPCL | Description |
|---|---|
| None | Default value, nothing to report |
| Warning | Warning message, something is incorrect in sent data. |
| Error | Error message, was not able to complete call because of an error |
| Critical | Unable to reach Harmoney or Harmoney is currently offline |
ExternalPartners¶
External partner used to differentiate between external web services
| Name in WsPCL | Value in Harmoney | Description |
|---|---|---|
| None | 00 | Default value |
| Klarna | 01 | |
| Allektum | 02 | |
| Damco | 03 | |
| StroedeRalton | 04 | |
| Decidas | 06 | |
| PulsenRoc | 09 | Pulsen retail online connector |
| Dibs | 26 | |
| DibsD2 | 27 | |
| KlarnaCheckOut | 35 | |
| Qliro | 40 | |
| PaymentGateway | 50 | |
| Amazon | 51 | |
| Adyen | 52 | |
| CDONMarketplace | 53 | |
| Vipps | 55 | |
| Avarda | 56 | |
| KlarnaV3 | 57 | |
| Megasol | 60 | |
| Collector | 62 | |
| Titan | 63 |
Gender¶
Gender of a customer
| Name in WsPCL | Value in Harmoney | Name in Harmoney | Description |
|---|---|---|---|
| None | (Empty string) | Default value, gender is unknown | |
| Male | 01 | Man | Male |
| Female | 02 | Kvinna | Female |
| Company | 03 | Företag | Company, used mainly for B2B sales |
| Unknown | 00 | Okänd | Gender is unknown or irrelevant |
Language¶
Language, used primarily in LoginInfo object.
| Name in WsPCL | Value in Harmoney | Name in Harmoney |
|---|---|---|
| None | (Empty string) | (Empty string) |
| Danish | DA | Dansk |
| English | EN | English |
| Finnish | FI | Suomi |
| German | DE | Deutsch |
| Norwegian | NO | Norsk |
| Swedish | SV | Svenska |
| French | FR | Franska |
ObligationFulfilled¶
Displays if an obligation is fulfilled or not.
| Name in WsPCL | Comment |
|---|---|
| Yes | Obligation fulfilled |
| No | Obligation not fulfilled |
| HasNoObligation | If a customer has no obligation |
OrderMethod¶
The method used to save the order to Harmoney.
| Name in WsPCL | Description | Value In Harmoney | Comment |
|---|---|---|---|
| Internet | Order was sent via the internet | 08 | Default value |
| Order was sent via mail | 01 | ||
| Phone | Order was place by phone to customer services | 02 | |
| Sms | Order was sent from a SMS | 03 | |
| Order was sent to customer services via email. | 05 | ||
| Coupon | Order placed out of an Coupon | 04 | |
| Voice | Order sent from Voice | 06 | |
| MobileWeb | Order was sent to customer services via mobile web site | 23 | Not a default order method. Please contact your sales representative for further information |
| SmartPhone | Order was sent via a smartphone | 22 | Not a default order method. Please contact your sales representative for further information |
| ClickAndCollect | 21 | Not a default order method. Please contact your sales representative for further information | |
| Promotion | 24 | Not a default order method. Please contact your sales representative for further information |
OrderState¶
The order status
| Name in WsPCL | Value in Harmoney | Name in Harmoney | Description |
|---|---|---|---|
| None | (Empty string) | Default value, status is not set yet | |
| Expired | 01 | Ny order | Order has expired |
| WaitOrder | 02 | Väntorder | Order is pending |
| PartOrder | 03 | Restorder (delleverans) | Order partially delivered |
| Revoked | 06 | Annullerad | Order is revoked |
| SoonToBeRevoked | 07 | Annullerad inom X timmar | Order will be revoked within X hours |
| RevokedByInvoiceOrReplacement | 08 | Annullerad vid fakturering(slut) | Order was revoked during invoicing |
| Delivered | 99 | Levererad | Order is delivered |
PaymentMethod¶
Payment method to use when saving the order to Harmoney.
| Name in WsPCL | Value in Harmoney | Name in Harmoney | Description |
|---|---|---|---|
| COD_Invoice | 00 | Postförskott/Inb.faktura | |
| Invoice | 01 | Inbetalningsfaktura | |
| COD | 02 | Postförskott | |
| SeparateInvoice | 03 | Faktura | Receive the invoice separately |
| Account | 06 | Konto | |
| Voucher | 08 | Presentkort/värdecheck | |
| E_Invoice | 10 | E-faktura | |
| MonthlyInvoice | 12 | Månadsfaktura | |
| CreditCard | 26 | Betalkort | |
| ExternalInvoice | 27 | Extern faktura | Example: Klarna |
| ExternalAccount | 28 | Externt konto | |
| DirectPayment | 30 | Direktbetalning | |
| Paypal | 31 | Paypal | |
| Skrill | 33 | Skrill | |
| KlarnaAdvanced | 35 | KlarnaAdvanced/Klarna checkout | |
| ExternalWeb | 60 | Extern web | |
| ExternalInvoiceAccount | 62 | Externt fakturakonto | |
| GenericCreditCard | 67 | Generiskt betalkort | |
| GenericDirectPayment | 68 | Generisk direktbetalning | |
| GenericInvoice | 69 | Generisk faktura | Primarly used with Adyen |
| Default | Empty | Empty. Can only be sent in | The system decides the payment method |
PhoneNumberType¶
There are three different phone number types in Harmoney.
| Name in WsPCL | Value in Harmoney | Description |
|---|---|---|
| Home | 01 | Home phone number, usually a fixed line |
| Work | 02 | Work phone number |
| Mobile | 03 | Mobile phone number |
PriceGroup¶
Used to indicate if a ProductPrice is a current price or a previous price.
| Name in WsPCL | Description |
|---|---|
| Now | Price currently set on product/item. |
| Then | Price previously set on product/item. |
PriceType¶
Used to indicate the type of ProductPrice.
| Name in WsPCL | Value in Harmoney | Name in Harmoney | Description |
|---|---|---|---|
| From | 01 | Från | Price is valid from a specified date |
| To | 02 | Till | Price is valid to a specified date |
| Now | 03 | Nu | Price is currently valid |
| FromNow | 04 | Nu(från) | Price is valid from now |
| Before | 05 | Förr | Earlier price. |
| Price | 06 | Pris | Current price |
Pricing¶
Setting for how prices and fees are set.
| Name in WsPCL | Description | Comment |
|---|---|---|
| PriceAndFeeSetByHarmoney | Prices and fees on order are set by Harmoney, client accepts returned values. | Default and recommended setting. |
| PriceAndFeeSetByClient | Prices and fees on order are set by client, Harmoney accepts values | Should only be set after discussion with Pulsen |
| PriceSetByClientFeeSetByHarmoney | Prices set on order by client, fees set by Harmoney on return | Should only be set after discussion with Pulsen |
PrintType¶
Setting for what type of message should be sent to a customer.
| Name in WsPCL | Description | Comment |
|---|---|---|
| InquiryConsentMessage | Used to send a request for consent to a customer. | Default setting. |
| ConfirmationConsentMessage | Used to send a confirmation message of a approved consent. | |
| CustomerMessage | Used to send a message to the customer |
ProcessType¶
What type of process the order should be
| Name in WsPCL | Description | Comment |
|---|---|---|
| NormalOrder | NormalOrder with usual fees | Default value. |
| SplitOrder | Split the order if there is rows that will be part delivered | |
| SplitOrderRemovee | Remove orderrows from the order if they will be part delivered | |
| ExpressOrder | Send the order as soon as possible. It will be placed first in queue. | Extra fee will be charged if set. |
| CompleteOrder | Send the order when all the items is in stock |
ProductStatus¶
The status of an order depending on product status.
| Name in WsPCL | Value in Harmoney | Name in Harmoney | Description |
|---|---|---|---|
| Active | 01 | Aktiv(ok att leverera) | Active, order is ok to deliver |
| RemoveRegardlessOfStock | 04 | Stryk order oavsett | Order is removed regardless if product(s) has available stock |
| StopDeliveriesTemprarily | 05 | Stoppa utleveranser tillfälligt | Order is delayed for delivery temporarily |
| RemoveOnLowStock | 70 | Stryk order vid brist | Order is removed if product is low on available stock |
SavedOrderStatus¶
The current order status.
| Name in WsPCL | Description |
|---|---|
| None | Default value. Status is not set |
| Immediate | Order is delivered immediately |
| Pending | Order is pending delivery |
| TemporarilyOutOfStock | Order is delayed because product is temporarily out of stock |
| OutOfStock | Order is delayed because product is out of stock |
| Delivered | Order is delivered |
| RecievedLater | Order is delayed because of waiting for inbound delivery |
| RecievedByWareHouse | Order is received by warehouse for packing |
| Packed | Order is packed |
| Cancelled80 | Order is cancelled with orderstate 80 |
| Cancelled | Order is cancelled |
SortType¶
Used to decide how a returning list of products should be sorted.
| Name in WsPCL | Description |
|---|---|
| Popularity | Products are sorted by popularity |
| Name | Products are sorted by product name |
| ArticleNumber | Products are sorted by product id |
| Price | Products are sorted by product price |
SavedOrderType¶
The type of an SavedOrder
| Name in WsPCL | Description |
|---|---|
| Order | The order is not delivered. Look at SavedOrder.Order.Properties.Status to see the status of the order (waitorder, partorder, revoked) |
| Invoice | Invoice. The order is delivered or in WMS-system. |
| Undetermined | The type is unknown |
StorageProductStatus¶
The status of the storage product.
| Name in WsPCL | Description |
|---|---|
| Active | Product is active, available for sale |
| Passive | Product is passive, available stock will be sold but no inbound deliveries |
| Discontinued | Product is passive, not available for sale |
MiscInfoType¶
Displays the type of miscellaneous information.
| Name in WsPCL | Value in Harmoney | Description |
|---|---|---|
| FirstInvoiceDateForSegmenting | 10 | Customers first invoicedate for segmenting |
| AchievedValueForSegmenting | 11 | Achieved value for segmenting |
| ActiveForSegmenting | 13 | Customer active for segmenting |
| BITag | 20 | BI/QV Tag |
| FirstDeliveryDate | 25 | First deliveryDate |
| Voyado | 27 | Voyado external system type |
| WebCustomerNumber | 28 | Possibility to send information to Harmoney about a customer web account. |
| Unknown | 00 | If no type or invalid type is provided. Type is mandatory. |
InvoiceType¶
Displays the type of invoices.
| Name in WsPCL | Value in Harmoney | Description |
|---|---|---|
| None | 00 | No invoiceType, is set on orders |
| Delivery | 01 | Delivery |
| Compensation_invoice_unclaimed | 10 | Compensation invoice unclaimed |
| Compensation_invoice_obligation | 11 | Compensation invoice obligation |
| Compensation_invoice_too_many_returns | 12 | Compensation invoice too many returns |
| compensation_return_part_of_package | 13 | Compensation return part of package |
| Invoice_created_from_purchase_order | 14 | Invoice created from purchase order |
| Return_fee | 15 | Return fee |
| Credit_sales | 20 | Credit sales |
| Consolidated invoice | 22 | Consolidated invoice |
| Manual_invoice | 30 | Manual invoice |
| Automatic_invoice | 31 | Automatic invoice |
| Credit_invoice | 32 | Credit invoice |
| Credit_invoice_CC | 33 | Credit invoice CC |
| Interest_invoice | 34 | Interest invoice |
| Advance | 40 | Advance |
| Store | 50 | Store |
| Credit_from_premium | 60 | Credit from premium |
| Loyalty_invoice | 70 | Loyalty invoice |
| Fully_cancelled_order | 99 | Fully cancelled order |