Skip to main content

Get Orders

GetOrders​

This method is used to fetch specific orders from the Svea Payments system and their order rows.

Input​

GetOrdersRequest​

FieldRTypeDescription
OrdersToRetrieve*Collection of GetOrderInformationInformation about the orders to retrieve

Output​

GetOrdersResponse​

FieldRTypeDescription
Orders-Collection of OrderThe orders that were requested

Structures

GetOrderInformation​

FieldRTypeDescription
SveaOrderId*Long(10)Unique ID for the created order. Used for any further order webservice requests.
OrderType-OrderTypeSee OrderType. Required for Legacy, ignored for EU-clients.
ClientId*Long(7)ID that identifies a client in the Svea Payments system.

Order​

FieldURTypeDescription
ClientOrderId--String(30)Order number from client’s ordersystem.
SveaOrderId**Long(10)Unique ID for the created order. Used for any further order webservice requests.
OrderDeliveryStatus-*(String)OrderDeliveryStatusSee OrderDeliveryStatus
OrderStatus-*(String)OrderStatusSee OrderStatus
OrderType-*(String)OrderTypeSee OrderType
CreatedDate-*DateTimeDate order was first created.
Customer-*CustomerIdentityShipping address.
CustomerId--Nullable<Long>Customer ID created by Svea Payments system.
CustomerReference--String(32)Customer Reference. (Gets printed on the invoice.)
ChangeDate--DateTimeDate when order status was changed, e.g., when order was delivered.
Currency-*String(3)Country currency.
SveaWillBuy-*BooleanDescribes whether Svea Payments will buy the order or just administrate it.
Notes-*String(200)Text on order created by client.
ClientId**Long(7)ID that identifies a client in the Svea Payments system.
PaymentPlanDetails--PaymentPlanDetailsOnly applicable for payment plan order type.
AccountCreditDetails--AccountCreditDetailsOnly applicable for account credit order type.
IsPossibleToAdminister-*Boolean
CreditReportStatus--CreditReportStatusTells if the order is approved or not. Not sent if no credit decision has been made (e.g., manual administration).
OrderRows-*Collection of NumberedOrderRowOrder rows for the order.
IsPossibleToCancel-*BooleanTells if the order can be cancelled.
PendingReasons--Collection of PendingReasonsReasons why the order is pending.

CustomerIdentity​

FieldURTypeDescription
NationalIdNumber*-StringField for entering unique identifiers for customers in certain countries. (Example: Personnummer & organisationsnummer in Sweden). Will not be returned for Finnish clients.
Email--StringA valid email address of the customer.
PhoneNumber--StringCustomer’s phone number.
IpAddress--StringCustomer’s IP-address.
FullName-*StringFull name of the customer. Either first name + family name or company name.
Street-*StringCustomer’s street address.
CoAddress--StringCustomer co-address.
ZipCode-*StringThe complete zip code of the Customer.
HouseNumber--StringHouse number (only applicable in certain countries).
Locality-*StringCustomer’s town of residence.
CountryCode-*String (2)A country code which defines where the customer is residing.
CustomerType-*CustomerTypeSee CustomerType.
IndividualIdentity--IndividualIdentityOnly if the CustomerType is Individual.
CompanyIdentity--CompanyIdentityOnly if the CustomerType is Company.

AccountCreditDetails​

FieldRTypeDescription
CampaignCode-DecimalThe campaign code for the account credit.

PaymentPlanDetails​

FieldRTypeDescription
ContractNumber*Nullable<Long>Contract number of a specific contract.
ContractLengthMonths-Integer
CampaignCode-DecimalThe campaign code.

CreditReportStatus​

FieldRTypeDescription
CreationDate*DateTimeDate of order credit decision.
Accepted*BooleanTrue if credit approval passed.

NumberedOrderRow​

FieldURTypeDescription
ArticleNumber--String(10)Article number of the product.
Description--String(40)Description of the product.
DiscountPercent-*Decimal(3,0)Discount in percent (0–100).
NumberOfUnits-*Decimal(7,2)
PriceIncludingVat--Nullable<Boolean>If true, PricePerUnit will be considered as including VAT. Recommended to be true if the customer is an individual and false if company.
PricePerUnit-*Decimal(18,2)Price per unit of product. (Excluding VAT if flag PriceIncludingVat is not set to true)
RowType--RowTypeSee RowType.
Unit--String(3)Short description of unit (e.g., "ea.").
VatPercent-*Decimal(2,0)Percent of VAT (0–99).
CreditInvoiceId*-Nullable<Long>Reference to invoice to credit.
InvoiceId*-Nullable<Long>ID to invoice if order has been delivered.
RowNumber-*Long(3)
Status--(String)OrderRowStatusSee OrderRowStatus.
DiscountAmount--Nullable<Decimal(18,2)>The discount amount. If set, the amount will be deducted from the amount to pay.
DiscountAmountIncludingVat--Nullable<Boolean>If true, the discount amount will be deducted after VAT is added (use for individual end-customers). If false, deducted before VAT is added (use for business end-customers).

Note: The fields must be set in the specified order. Optional fields in a different order may not be used by the service.

PendingReason​

The following table describes the structure for PendingReason.

PendingReason​

FieldRTypeDescription
PendingType*(String) PendingTypeSee PendingType.
CreatedDate*String(10)Date when the reason was created.

Enumerations​

OrderType​

ValueDescription
Invoice-
PaymentPlan-
AccountCredit-

OrderDeliveryStatus​

ValueDescription
Created-
PartiallyDelivered-
Delivered-
Cancelled-

OrderStatus​

ValueDescription
Created-
Pending-
Active-
Denied-
Closed-
Error-

OrderRowStatus​

ValueDescription
NotDelivered-
Delivered-
Cancelled-

CustomerType​

ValueDescription
Individual-
Company-

RowType​

ValueDescription
AdjustmentRowDeprecated
GiftCardDeprecated
InvoiceFeeUsed to specify the type of fee associated with an invoice payment. Required if Invoice fee is applied.
Last updated on