Documentation

Ucommerce includes full API reference documentation and lots of helpful articles to help you build your e-commerce site as effortlessly as possible.

Topics Payment Providers
v7.18

TransactionLibrary

Ucommerce.Api.ITransactionLibrary

description

Methods


HasBasket

  • Return type Boolean
  • Arguments
    • This method is called without any arguments

GetBasket

  • Return type Ucommerce.EntitiesV2.PurchaseOrder
  • Arguments
    • Boolean create

NewBasket

  • Return type Ucommerce.EntitiesV2.Basket
  • Arguments
    • String catalogName

GetPurchaseOrderByPaymentReference

  • Return type Ucommerce.EntitiesV2.PurchaseOrder
  • Arguments
    • String paymentReferenceId

GetPurchaseOrder

  • Return type Ucommerce.EntitiesV2.PurchaseOrder
  • Arguments
    • String orderNumber
    • Boolean validateForCurrentMember

GetPurchaseOrder

  • Return type Ucommerce.EntitiesV2.PurchaseOrder
  • Arguments
    • Guid guid

AddToBasket

  • Return type Ucommerce.EntitiesV2.OrderLine
  • Arguments
    • int quantity
    • Guid productId
    • Guid? variantId
    • Decimal? unitPrice
    • Guid? priceGroupId
    • Boolean addToExistingLine
    • Boolean executeBasketPipeline
    • IDictionary<String, Object> properties

AddToBasket

  • Return type Ucommerce.EntitiesV2.OrderLine
  • Arguments
    • int quantity
    • String sku
    • String variantSku
    • Decimal? unitPrice
    • Guid? priceGroupId
    • Boolean addToExistingLine
    • Boolean executeBasketPipeline
    • IDictionary<String, Object> properties

UpdateLineItemByOrderLineId

  • Return type Void
  • Arguments
    • int orderLineId
    • int newQuantity

UpdateLineItem

  • Return type Void
  • Arguments
    • int lineItemIndex
    • int newQuantity

DeleteLineItem

  • Return type Void
  • Arguments
    • int lineItemIndex

ClearBasket

  • Return type Void
  • Arguments
    • This method is called without any arguments

Checkout

  • Return type Ucommerce.EntitiesV2.PurchaseOrder
  • Arguments
    • This method is called without any arguments

AssignOrderNumber

  • Return type String
  • Arguments
    • String orderNumber

ExecuteOrderPipeline

  • Return type Void
  • Arguments
    • String pipelineName

ExecuteBasketPipeline

  • Return type Void
  • Arguments
    • This method is called without any arguments

SetPurchaseOrderNote

  • Return type Void
  • Arguments
    • String note

SetOrderProperty

  • Return type Void
  • Arguments
    • int lineItemIndex
    • String key
    • String value

SetOrderProperty

  • Return type Void
  • Arguments
    • String key
    • String value

EditBillingInformation

  • Return type Void
  • Arguments
    • String firstName
    • String lastName
    • String emailAddress
    • String phoneNumber
    • String mobilePhoneNumber
    • String company
    • String line1
    • String line2
    • String postalCode
    • String city
    • String state
    • String attention
    • int countryId

EditShippingInformation

  • Return type Void
  • Arguments
    • String firstName
    • String lastName
    • String emailAddress
    • String phoneNumber
    • String mobilePhoneNumber
    • String company
    • String line1
    • String line2
    • String postalCode
    • String city
    • String state
    • String attention
    • int countryId

EditShipmentInformation

  • Return type Void
  • Arguments
    • String addressName
    • String firstName
    • String lastName
    • String emailAddress
    • String phoneNumber
    • String mobilePhoneNumber
    • String company
    • String line1
    • String line2
    • String postalCode
    • String city
    • String state
    • String attention
    • int countryId

EditCustomerAddress

  • Return type Void
  • Arguments
    • String addressName
    • String firstName
    • String lastName
    • String emailAddress
    • String phoneNumber
    • String mobilePhoneNumber
    • String company
    • String line1
    • String line2
    • String postalCode
    • String city
    • String state
    • String attention
    • int countryId

EditOrderAddress

  • Return type Void
  • Arguments
    • String addressName
    • String firstName
    • String lastName
    • String emailAddress
    • String phoneNumber
    • String mobilePhoneNumber
    • String company
    • String line1
    • String line2
    • String postalCode
    • String city
    • String state
    • String attention
    • int countryId

GetPaymentMethods

  • Return type ICollection<Ucommerce.EntitiesV2.PaymentMethod>
  • Arguments
    • String shippingAddressName

GetPaymentMethods

  • Return type ICollection<Ucommerce.EntitiesV2.PaymentMethod>
  • Arguments
    • Ucommerce.EntitiesV2.Country country

GetPaymentMethods

  • Return type ICollection<Ucommerce.EntitiesV2.PaymentMethod>
  • Arguments
    • Ucommerce.Search.Models.ProductCatalogGroup productCatalogGroup
    • Ucommerce.EntitiesV2.Country country

CreatePayment

  • Return type Ucommerce.EntitiesV2.Payment
  • Arguments
    • int paymentMethodId

CreatePayment

  • Return type Ucommerce.EntitiesV2.Payment
  • Arguments
    • int paymentMethodId
    • Decimal amount

CreatePayment

  • Return type Ucommerce.EntitiesV2.Payment
  • Arguments
    • int paymentMethodId
    • Decimal amount
    • Boolean requestPayment

CreatePayment

  • Return type Ucommerce.EntitiesV2.Payment
  • Arguments
    • int paymentMethodId
    • Decimal amount
    • Boolean requestPayment
    • Boolean overwriteExisting

RenderPaymentForm

  • Return type String
  • Arguments
    • String paymentIdentifier

RequestPayments

  • Return type Void
  • Arguments
    • This method is called without any arguments

RequestPayment

  • Return type Void
  • Arguments
    • int paymentId

GetPaymentPageUrl

  • Return type String
  • Arguments
    • Ucommerce.EntitiesV2.Payment payment

GetCountries

  • Return type ICollection<Ucommerce.EntitiesV2.Country>
  • Arguments
    • This method is called without any arguments

GetShippingMethods

  • Return type ICollection<Ucommerce.EntitiesV2.ShippingMethod>
  • Arguments
    • String shippingAddressName

GetShippingMethod

  • Return type Ucommerce.EntitiesV2.ShippingMethod
  • Arguments
    • String addressName

GetShippingMethods

  • Return type ICollection<Ucommerce.EntitiesV2.ShippingMethod>
  • Arguments
    • Ucommerce.EntitiesV2.Country country

GetShippingMethods

  • Return type ICollection<Ucommerce.EntitiesV2.ShippingMethod>
  • Arguments
    • Ucommerce.Search.Models.ProductCatalogGroup productCatalogGroup
    • Ucommerce.EntitiesV2.Country country

CreateShipment

  • Return type Void
  • Arguments
    • int shippingMethodId
    • String addressName
    • Boolean overwriteExisting

DeleteShipment

  • Return type Void
  • Arguments
    • int shipmentId

GetShippingInformation

  • Return type Ucommerce.EntitiesV2.OrderAddress
  • Arguments
    • String addressName

GetBillingInformation

  • Return type Ucommerce.EntitiesV2.OrderAddress
  • Arguments
    • This method is called without any arguments

GetMemberOrderHistory

  • Return type ICollection<Ucommerce.EntitiesV2.PurchaseOrder>
  • Arguments
    • String statusName
    • Boolean allCatalogGroups

SendEmail

  • Return type Void
  • Arguments
    • String emailTypeName
    • String orderNumber

SendEmail

  • Return type Void
  • Arguments
    • String receiverEmailAddress
    • String emailTypeName
    • String orderNumber

FormatCurrency

  • Return type String
  • Arguments
    • String amount

FormatCurrency

  • Return type String
  • Arguments
    • Decimal? amount

FormatCurrency

  • Return type String
  • Arguments
    • String amount
    • String cultureCode

FormatCurrency

  • Return type String
  • Arguments
    • Decimal? amount
    • String cultureCode