Data Types

CreateOrderModel

Name	Description	Type	Additional Information
merchantOrderNumber	A string that identifies the order in the merchant’s systems. The merchantOrderNumber is unique per order. If using Vipps payment method, allowed values are any combination of: A-Z, a-z, 0-9, - and _ (underscore). Example for Vipps: abc-12d-efg-123	String	Max length: 32
countryCode		String
currency		String
mobilePhoneNumber		String
tags		Array of String
orderItems	The total cost of the order rows in the cart needs to be equal or higher than 0 but the cart must not be empty.	Order Items	Free order items/rows, like gift cards, can have a value of 0, denoting no cost
callbackUri	To receive a callback when an order status changes, you need a web server receiving HTTP POST calls.
termsUri	URI to a page with webshop terms.	String	Must be a valid URI Must be accessible by end customer Max length: 500
deferredDelivery	To flag an order with deferred delivery, set the "deferredDelivery" property to true (default: false) when creating the order.	Boolean	More Information
minutesUntilLinkExpires		Int32
presetValues		Collection of PresetValue
requireElectronicIdAuthentication		Boolean
merchantName
partnerKey	Provided by Svea to select partners.	Guid
merchantData	Metadata visible to the store	String	Max length: 6000 Cleaned up from Checkout database after 45 days.
identityFlags	Used to control what actions the user is able to perform	IdentityFlags

required field

Order Model

Name	Description	Type	Additional Information
smsSentSuccessfully	Status if the SMS was successfully sent to the operator.	Boolean	This status does not verify if the SMS was delivered to the mobile phone, only that the operator has received it
merchantOrderNumber	Order No from Merchant system	String
instoreUiUri	Instore URL generated	String
orderStatus	Status of the order. It can be Active, Completed or Canceled	String
paymentMethodType	Payment method type	String	Set when order is Completed
campaignCode	Showing campaign code (if used)	Long	Only available for PaymentPlan, Set when order is Completed
paymentType	Payment type	String	Set when order is Completed
paymentOrderId	Checkout Order Id which identifies an Order , which can be used for managing Orders	String	Use this when contacting Svea support if you experience any issues with an order
customerInformation	Information about the customer who completed the checkout	CustomerInformation
tags	Tags set on the order when it was created	Array of String
orderItems		Cart

Order Items

caution

Quantity, UnitPrice, DiscountPercent, DiscountAmount and VatPercent for each order row expected to be given in minor units.

Name	Description	Type	Additional Information	Examples
ArticleNumber	Article number	String	Max length: 256
Name	Article name.	String	Max length: 40
Quantity	Quantity of the product.	Int64	1-7 digits Minor Units.
UnitPrice	Price of the product including VAT.	Int64	1-13 digits Can be negative. Minor Units.
DiscountPercent	The discount percent of the order row. Cannot be used together with DiscountAmount	Int64	Min: 0 Max: 10000 No fractions Minor Units.	0 = 0% 100 = 1% 9900 = 99% 10000 = 100%
DiscountAmount	The total discount amount for this order row. Cannot be used together with DiscountPercent	Int64	Min: 0 Max: Order row total Minor Units.
VatPercent	The VAT percentage of the current product. Valid vat percentage for that country.	Int64	Minor Units.
Unit	The unit type, e.g., “st”, “pc”, “kg” etc.	String	Max length: 4
RowNumber	The row number the row will have in the Webpay system	Int32
MerchantData	Metadata visible to the store	String	Max length: 255 Cleaned up from Checkout database after 45 days.

required field

OrderRow

caution

Quantity, UnitPrice, DiscountPercent, DiscountAmount and VatPercent for each order row expected to be given in minor units.

caution

Maximum allowed number of rows per order is 1000.

Name	Description	Type	Additional Information	Examples
ArticleNumber	Article number	String	Max length: 256
Name	Article name.	String	Max length: 40
Quantity	Quantity of the product.	Int64	1-7 digits Minor Units.
UnitPrice	Price of the product including VAT.	Int64	1-13 digits Can be negative. Minor Units.
DiscountPercent	The discount percent of the order row. Cannot be used together with DiscountAmount	Int64	Min: 0 Max: 10000 No fractions Minor Units.	0 = 0% 100 = 1% 9900 = 99% 10000 = 100%
DiscountAmount	The total discount amount for this order row. Cannot be used together with DiscountPercent	Int64	Min: 0 Max: Order row total Minor Units.
VatPercent	The VAT percentage of the current product. Valid vat percentage for that country.	Int64	Minor Units.
Unit	The unit type, e.g., “st”, “pc”, “kg” etc.	String	Max length: 4
RowNumber	The row number the row will have in the Webpay system	Int32
MerchantData	Metadata visible to the store	String	Max length: 255 Cleaned up from Checkout database after 45 days.

required field

PresetValue

Name	Description	Type	Additional Information
TypeName	Name of the field you want to set (see limits below).	String
Value	See limits below.	String
IsReadonly	Set this to true if you don't want the end customer to be able to change the value in the Checkout.	Boolean

required field

List of presetvalue typenames

Name	Type	Additional Information
NationalId	String	Country-specific validation.
EmailAddress	String	Max 50 characters. Must be a valid email address.
PhoneNumber	String	1-18 digits, can include “+”, “-“s and space.
PostalCode	String	Country-specific validation.
IsCompany	Boolean	Required if nationalid is set to "read only"
PeppolId	String	Starts with four digits, followed by a colon, and alphanumeric characters.

Customer

Name	Description	Type
fullName		String
firstName		String
lastName		String
streetAddress		String
coAddress		String
postalCode		String
city		String
isGeneric		Boolean
addressLines		Array of String

CustomerInformation

Name	Description	Type	Additional Information
shippingAddress		Address
billingAddress		Address
emailAddress		String
mobilePhoneNumber		String

Address

Name	Description	Type	Additional Information
fullName		String
lastName		String
streetAddress		String
coAddress		String
postalCode		String
city		String
countryCode		String
isGeneric	A generic address does not include all of the fields above. Instead it has additional address lines. Used for e.g. international addresses	Boolean
addressLines	Address lines of generic addresses	Array of String

IdentityFlags

Name	Description	Type	Additional Information
HideNotYou		Boolean
HideChangeAddress		Boolean
HideAnonymous		Boolean