Class OrderManagementStore

The Order Management API is used for handling an order after the customer has completed the purchase. It is used for updating, capturing and refunding an order as well as to see the history of events that have affected this order.

Inheritance

System.Object

BaseRestClient

BaseStore

OrderManagementStore

Inherited Members

BaseStore.ApiControllerUri

BaseRestClient.ApiSession

BaseRestClient.Post(String, Object, IDictionary<String, String>, Ref<HttpResponseMessage>)

BaseRestClient.Post<T>(String, Object, IDictionary<String, String>, Ref<HttpResponseMessage>)

BaseRestClient.Patch(String, Object, IDictionary<String, String>, Ref<HttpResponseMessage>)

BaseRestClient.Delete(String, Object, IDictionary<String, String>, Ref<HttpResponseMessage>)

BaseRestClient.Delete<T>(String, Object, IDictionary<String, String>, Ref<HttpResponseMessage>)

BaseRestClient.Put<T>(String, Object, IDictionary<String, String>, Ref<HttpResponseMessage>)

BaseRestClient.Put(String, Object, IDictionary<String, String>, Ref<HttpResponseMessage>)

BaseRestClient.Get<T>(String, IDictionary<String, String>, Ref<HttpResponseMessage>)

BaseRestClient.Get(String, IDictionary<String, String>, Ref<HttpResponseMessage>)

BaseRestClient.GetStream(String)

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Klarna.Rest.Core.Store

Assembly: Klarna.Rest.Core.dll

Syntax

public class OrderManagementStore : BaseStore

Methods

| Improve this Doc View Source

AcknowledgeOrder(String)

Acknowledge order https://developers.klarna.com/api/#order-management-api-acknowledge-order

Declaration

public Task AcknowledgeOrder(string orderId)

Parameters

Type	Name	Description
System.String	orderId	Id of order to acknowledge

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

AddShippingInfoToCapture(String, String, OrderManagementAddShippingInfo)

Add shipping info to a capture https://developers.klarna.com/api/#order-management-api-add-shipping-info-to-a-capture

Declaration

public Task AddShippingInfoToCapture(string orderId, string captureId, OrderManagementAddShippingInfo shippingInfo)

Parameters

Type	Name	Description
System.String	orderId	Id of order to add shipping info
System.String	captureId	Id of capture to add shipping info
OrderManagementAddShippingInfo	shippingInfo	The OrderManagementAddShippingInfo object

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

CancelOrder(String)

Cancel order https://developers.klarna.com/api/#order-management-api-cancel-order

Declaration

public Task CancelOrder(string orderId)

Parameters

Type	Name	Description
System.String	orderId	Id of order to cancel

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

CreateAndFetchCapture(String, OrderManagementCreateCapture)

Create capture and follow the Location header to fetch the data https://developers.klarna.com/api/#order-management-api-create-capture

Declaration

public Task<OrderManagementCapture> CreateAndFetchCapture(string orderId, OrderManagementCreateCapture capture)

Parameters

Type	Name	Description
System.String	orderId	Id of order to create capture
OrderManagementCreateCapture	capture	The OrderManagementCapture object

Returns

Type	Description
System.Threading.Tasks.Task<OrderManagementCapture>	Object of OrderManagementCapture

| Improve this Doc View Source

CreateAndFetchRefund(String, OrderManagementRefund)

Create a refund and follow the Location header to fetch the data https://developers.klarna.com/api/#order-management-api-create-a-refund

Declaration

public Task<OrderManagementGetRefundResponse> CreateAndFetchRefund(string orderId, OrderManagementRefund refund)

Parameters

Type	Name	Description
System.String	orderId	Id of order to create a refund
OrderManagementRefund	refund	The OrderManagementRefund object

Returns

Type	Description
System.Threading.Tasks.Task<OrderManagementGetRefundResponse>

| Improve this Doc View Source

CreateCapture(String, OrderManagementCreateCapture)

Create capture https://developers.klarna.com/api/#order-management-api-create-capture

Declaration

public Task CreateCapture(string orderId, OrderManagementCreateCapture capture)

Parameters

Type	Name	Description
System.String	orderId	Id of order to create capture
OrderManagementCreateCapture	capture	The OrderManagementCapture object

Returns

Type	Description
System.Threading.Tasks.Task	Object of OrderManagementCapture

| Improve this Doc View Source

CreateRefund(String, OrderManagementRefund)

Create a refund https://developers.klarna.com/api/#order-management-api-create-a-refund

Declaration

public Task CreateRefund(string orderId, OrderManagementRefund refund)

Parameters

Type	Name	Description
System.String	orderId	Id of order to create a refund
OrderManagementRefund	refund	The OrderManagementRefund object

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

ExtendAuthorizationTime(String)

Extend authorization time https://developers.klarna.com/api/#order-management-api-extend-authorization-time

Declaration

public Task ExtendAuthorizationTime(string orderId)

Parameters

Type	Name	Description
System.String	orderId	Id of order to extend

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

GetCapture(String, String)

Get one capture https://developers.klarna.com/api/#order-management-api-get-one-capture

Declaration

public Task<OrderManagementCapture> GetCapture(string orderId, string captureId)

Parameters

Type	Name	Description
System.String	orderId	Id of order that contains the capture
System.String	captureId	Id of capture to retrieve

Returns

Type	Description
System.Threading.Tasks.Task<OrderManagementCapture>	OrderManagementCapture

| Improve this Doc View Source

GetCapturesForOrder(String)

Get all captures for one order https://developers.klarna.com/api/#order-management-api-get-all-captures-for-one-order

Declaration

public Task<ICollection<OrderManagementCapture>> GetCapturesForOrder(string orderId)

Parameters

Type	Name	Description
System.String	orderId	Id of order to retrieve captures

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<OrderManagementCapture>>	Collection of OrderManagementCapture

| Improve this Doc View Source

GetOrder(String)

Get order https://developers.klarna.com/api/#order-management-api-get-order

Declaration

public Task<OrderManagementOrder> GetOrder(string orderId)

Parameters

Type	Name	Description
System.String	orderId	Id of order to retrieve

Returns

Type	Description
System.Threading.Tasks.Task<OrderManagementOrder>	OrderManagementOrder

| Improve this Doc View Source

GetRefundForOrder(String, String)

Get refund https://developers.klarna.com/api/#order-management-api-get-refund

Declaration

public Task<OrderManagementGetRefundResponse> GetRefundForOrder(string orderId, string refundId)

Parameters

Type	Name	Description
System.String	orderId	Id of order to get refund
System.String	refundId	Id of refund

Returns

Type	Description
System.Threading.Tasks.Task<OrderManagementGetRefundResponse>

| Improve this Doc View Source

ReleaseRemainingAuthorization(String)

Release remaining authorization https://developers.klarna.com/api/#order-management-api-release-remaining-authorization

Declaration

public Task ReleaseRemainingAuthorization(string orderId)

Parameters

Type	Name	Description
System.String	orderId	Id of order to release

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

SetNewOrderAmountAndOrderLines(String, OrderManagementSetNewOrderAmountAndLines)

Set new order amount and order lines https://developers.klarna.com/api/#order-management-api-set-new-order-amount-and-order-lines

Declaration

public Task SetNewOrderAmountAndOrderLines(string orderId, OrderManagementSetNewOrderAmountAndLines newOrderAmountAndLines)

Parameters

Type	Name	Description
System.String	orderId	Id of order to update
OrderManagementSetNewOrderAmountAndLines	newOrderAmountAndLines	The OrderManagementSetNewOrderAmountAndLines object

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

TriggerResendOfCustomerCommunication(String, String)

Trigger resend of customer communication https://developers.klarna.com/api/#order-management-api-trigger-resend-of-customer-communication

Declaration

public Task TriggerResendOfCustomerCommunication(string orderId, string captureId)

Parameters

Type	Name	Description
System.String	orderId	Id of order that contains the capture
System.String	captureId	Id of capture to resend

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

UpdateCustomerAddresses(String, OrderManagementCustomerAddresses)

Update customer addresses https://developers.klarna.com/api/#order-management-api-update-customer-addresses

Declaration

public Task UpdateCustomerAddresses(string orderId, OrderManagementCustomerAddresses customerAddresses)

Parameters

Type	Name	Description
System.String	orderId	Id of order to update
OrderManagementCustomerAddresses	customerAddresses	The UpdateCustomerAddresses(String, OrderManagementCustomerAddresses) object

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

UpdateMerchantReferences(String, OrderManagementMerchantReferences)

Update merchant references https://developers.klarna.com/api/#order-management-api-update-merchant-references

Declaration

public Task UpdateMerchantReferences(string orderId, OrderManagementMerchantReferences merchantReferences)

Parameters

Type	Name	Description
System.String	orderId	Id of order to update
OrderManagementMerchantReferences	merchantReferences	The OrderManagementMerchantReferences object

Returns

Type	Description
System.Threading.Tasks.Task