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

Methods


HasBasket

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

GetBasket

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

NewBasket

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

GetPurchaseOrderByPaymentReference

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

GetPurchaseOrder

  • Arguments
    • string orderNumber
    • Boolean validateForCurrentMember = False
  • Return type Ucommerce.EntitiesV2.PurchaseOrder

GetPurchaseOrder

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

AddToBasket

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

AddToBasket

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

UpdateLineItemByOrderLineId

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

UpdateLineItem

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

DeleteLineItem

  • Arguments
    • int lineItemIndex
  • Return type Void

ClearBasket

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

Checkout

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

AssignOrderNumber

  • Arguments
    • string orderNumber = null
  • Return type string

ExecuteOrderPipeline

  • Arguments
    • string pipelineName
  • Return type Void

ExecuteBasketPipeline

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

SetPurchaseOrderNote

  • Arguments
    • string note
  • Return type Void

SetOrderProperty

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

SetOrderProperty

  • Arguments
    • string key
    • string value
  • Return type Void

EditBillingInformation

  • 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
  • Return type Void

EditShippingInformation

  • 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
  • Return type Void

EditShipmentInformation

  • 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
  • Return type Void

EditCustomerAddress

  • 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
  • Return type Void

EditOrderAddress

  • 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
  • Return type Void

GetPaymentMethods

  • Arguments
    • string shippingAddressName = null
  • Return type ICollection<Ucommerce.EntitiesV2.PaymentMethod>

GetPaymentMethods

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

GetPaymentMethods

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

CreatePayment

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

CreatePayment

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

CreatePayment

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

CreatePayment

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

RenderPaymentForm

  • Arguments
    • string paymentIdentifier
  • Return type string

RequestPayments

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

RequestPayment

  • Arguments
    • int paymentId
  • Return type Void

GetPaymentPageUrl

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

GetCountries

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

GetShippingMethods

  • Arguments
    • string shippingAddressName = null
  • Return type ICollection<Ucommerce.EntitiesV2.ShippingMethod>

GetShippingMethod

  • Arguments
    • string addressName = null
  • Return type Ucommerce.EntitiesV2.ShippingMethod

GetShippingMethods

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

GetShippingMethods

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

CreateShipment

  • Arguments
    • int shippingMethodId
    • string addressName
    • Boolean overwriteExisting = True
  • Return type Void

DeleteShipment

  • Arguments
    • int shipmentId
  • Return type Void

GetShippingInformation

  • Arguments
    • string addressName = null
  • Return type Ucommerce.EntitiesV2.OrderAddress

GetBillingInformation

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

GetMemberOrderHistory

  • Arguments
    • string statusName = null
    • Boolean allCatalogGroups = False
  • Return type ICollection<Ucommerce.EntitiesV2.PurchaseOrder>

SendEmail

  • Arguments
    • string emailTypeName
    • string orderNumber
  • Return type Void

SendEmail

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

FormatCurrency

  • Arguments
    • string amount
  • Return type string

FormatCurrency

  • Arguments
    • Decimal? amount
  • Return type string

FormatCurrency

  • Arguments
    • string amount
    • string cultureCode
  • Return type string

FormatCurrency

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