Shop Service


http://webservices.gr8pay.com/v2/Shop.svc
The shop service will give you all the tools to build your next ecommerce solution – from digital delivery to inventory management the service will give you all the access you need to build your solution.

Download Method

The system enables merchants to create products to deliver a digital file – If you want to access the relevant file you can enter the transaction ID to download the attached file.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
itemIdNoint
asPlainDataNoboolean

Response Fields

Field NameField TypeDescription
DownloadResultBase64Binary
C#JavaScriptPHP

DownloadUnauthorized Method

The system enables merchants to create products with the purpose of delivering digital files. This method is designed to give customers ability to download such files after buying relevant products.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
fileKeyNoString
asPlainDataNoboolean

Response Fields

Field NameField TypeDescription
DownloadUnauthorizedResultBase64Binary
C#JavaScriptPHP

GetActiveCarts Method

The service will return the active carts for the user (requires login) – if a user logs in from a different device the products in the cart will be visible.

Request Fields

Field NameField TypeDescription
GetActiveCarts

Response Fields

FieldNameMandatory?Field TypeDescriptionSample
GetActiveCartsResultNoArrayOfShop.Cart
Shop.CartNo
ChangedTotalNoDecimal
CheckoutUrlNoString
CookieNoString
CurrencyIsoNoString
InstallmentsNounsignedByte
IsChangedNoBoolean
ItemsNoArrayOfShop.CartItem
Shop.CartItemNoShop.CartItem
ChangedCurrecyIsoCodeNoString
ChangedPriceNoDecimal
ChangedTotalNoDecimal
CurrencyFXRateNoDecimal
CurrencyISOCodeNoString
DownloadMediaTypeNoString
GuestDownloadUrlNoString
IDNoInt
InsertDateNodateTime
IsAvailableNoBoolean
IsChangedNoBoolean
ItemPropertiesNoArrayOfShop.CartItemProperty
Shop.CartItemPropertyNoShop.CartItemProperty
NameNoString
PropertyIDNoInt
ValueNoString
MaxQuantityNoInt
MinQuantityNoInt
NameNoString
PriceNoDecimal
ProductIdNoInt
ProductImageUrlNoString
ProductStockIdNoInt
QuantityNoShort
ReceiptLinkNoString
ReceiptTextNoString
ShippingFeeNoDecimal
StepQuantityNoInt
TotalNoDecimal
TotalProductNoDecimal
TotalShippingNoDecimal
TypeNounsignedByte
VATPercentNoDecimal
MaxInstallmentsNounsignedByte
MerchantNoShop.Merchant
AddressNoServiceAddress
AddressLine1NoString
AddressLine2NoString
CityNoString
CountryIsoNoString
PostalCodeNoString
StateIsoNoString
CurrenciesNoArrayOfstring
EmailNoString
FaxNumberNoString
GroupNoString
LanguagesNoArrayOfstring
NameNoString
NumberNoString
PhoneNumberNoString
WebsiteUrlNoString
MerchantNumberNoString
MerchantReferenceNoString
ShopIdNoInt
TotalNodecimal
C#JavaScriptPHP

GetCart Method

With the cart ID the service will return all of the product still available in the cart and all the relevant info for the cart.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
CookieNoString

Response Fields

FieldNameMandatory?Field TypeDescriptionSample
GetCartResultNoShop.Cart
ChangedTotalNoDecimal
CheckoutUrlNoString
CookieNoString
CurrencyIsoNoString
InstallmentsNounsignedByte
IsChangedNoBoolean
ItemsNoArrayOfShop.CartItem
Shop.CartItemNoShop.CartItem
ChangedCurrecyIsoCodeNoString
ChangedPriceNoDecimal
ChangedTotalNoDecimal
CurrencyFXRateNoDecimal
CurrencyISOCodeNoString
DownloadMediaTypeNoString
GuestDownloadUrlNoString
IDNoInt
InsertDateNodateTime
IsAvailableNoBoolean
IsChangedNoBoolean
ItemPropertiesNoArrayOfShop.CartItemProperty
Shop.CartItemPropertyNoShop.CartItemProperty
NameNoString
PropertyIDNoInt
ValueNoString
MaxQuantityNoInt
MinQuantityNoInt
NameNoString
PriceNoDecimal
ProductIdNoInt
ProductImageUrlNoString
ProductStockIdNoInt
QuantityNoShort
ReceiptLinkNoString
ReceiptTextNoString
ShippingFeeNoDecimal
StepQuantityNoInt
TotalNoDecimal
TotalProductNoDecimal
TotalShippingNoDecimal
TypeNounsignedByte
VATPercentNoDecimal
MaxInstallmentsNounsignedByte
MerchantNoShop.Merchant
AddressNoServiceAddress
AddressLine1NoString
AddressLine2NoString
CityNoString
CountryIsoNoString
PostalCodeNoString
StateIsoNoString
CurrenciesNoArrayOfstring
EmailNoString
FaxNumberNoString
GroupNoString
LanguagesNoArrayOfstring
NameNoString
NumberNoString
PhoneNumberNoString
WebsiteUrlNoString
MerchantNumberNoString
MerchantReferenceNoString
ShopIdNoInt
TotalNodecimal
C#JavaScriptPHP

GetCartOfTransaction Method

The service call will return the cart items from a specific transaction. This will be used mainly in history screens, where full item details can be seen

Request Fields

Field NameField TypeDescription
transactionIdInt

Response Fields

FieldNameMandatory?Field TypeDescriptionSample
GetCartOfTransactionResultNoShop.Cart
ChangedTotalNoDecimal
CheckoutUrlNoString
CookieNoString
CurrencyIsoNoString
InstallmentsNounsignedByte
IsChangedNoBoolean
ItemsNoArrayOfShop.CartItem
Shop.CartItemNoShop.CartItem
ChangedCurrecyIsoCodeNoString
ChangedPriceNoDecimal
ChangedTotalNoDecimal
CurrencyFXRateNoDecimal
CurrencyISOCodeNoString
DownloadMediaTypeNoString
GuestDownloadUrlNoString
IDNoInt
InsertDateNodateTime
IsAvailableNoBoolean
IsChangedNoBoolean
ItemPropertiesNoArrayOfShop.CartItemProperty
Shop.CartItemPropertyNoShop.CartItemProperty
NameNoString
PropertyIDNoInt
ValueNoString
MaxQuantityNoInt
MinQuantityNoInt
NameNoString
PriceNoDecimal
ProductIdNoInt
ProductImageUrlNoString
ProductStockIdNoInt
QuantityNoShort
ReceiptLinkNoString
ReceiptTextNoString
ShippingFeeNoDecimal
StepQuantityNoInt
TotalNoDecimal
TotalProductNoDecimal
TotalShippingNoDecimal
TypeNounsignedByte
VATPercentNoDecimal
MaxInstallmentsNounsignedByte
MerchantNoShop.Merchant
AddressNoServiceAddress
AddressLine1NoString
AddressLine2NoString
CityNoString
CountryIsoNoString
PostalCodeNoString
StateIsoNoString
CurrenciesNoArrayOfstring
EmailNoString
FaxNumberNoString
GroupNoString
LanguagesNoArrayOfstring
NameNoString
NumberNoString
PhoneNumberNoString
WebsiteUrlNoString
MerchantNumberNoString
MerchantReferenceNoString
ShopIdNoInt
TotalNodecimal
C#JavaScriptPHP

GetCategorisedProducts Method

<<Description>>

Request Fields

Field NameField TypeDescription

Response Fields

FieldName Mandatory?Field TypeDescriptionSample
C#JavaScriptPHP

GetDownloads Method

Get downloads will return only transactions with the product type “download” – Thereafter you will be able to call the service to return the downloadable file (mp3/mp4/pdf).

Request Fields

Field NameField TypeDescription
sortAndPageSortAndPage
PageNumberIntPage Number
PageSizeIntPage Size

Response Fields

FieldNameMandatory?Field TypeDescriptionSample
GetDownloadsResultNoArrayOfSHop.CartItem
Shop.CartItemNoShop.CartItem
ChangedCurrencyIsoCodeNoString
ChangedPriceNoDecimal
ChangedTotalNoDecimal
CurrencyFXRateNoDecimal
CurrencyISOCodeNoString
DownloadMediaTypeNoString
GuestDownloadUrlNoString
IDNoInt
InsertDateNodateTime
IsAvailableNoBoolean
IsChangedNoBoolean
ItemPropertiesNoArrayOfShop.CartItemProperty
Shop.CartItemPropertyNoShop.CartItemProperty
NameNoString
PriceNoDecimal
ProductIdNoInt
ProductImageUrlNoString
ProductStockIdNoInt
QuantityNoShort
ReceiptLinkNoString
ReceiptTextNoString
ShippingFeeNoDecimal
StepQuantityNoInt
TotalNoDecimal
C#JavaScriptPHP