Back to API overview

WebGrid Purchase RESTful Services

WebGrid Purchase RESTful services provides a interface to perform WebShop tasks such as retrieve and product statistics, gift certificates, refund information, delivery methods, web orders.

WebGrid Web service URL information

Url for this web service is http://admin.webgrid.com/API/Client/PurchaseService.svc?singleWsdl.

[This is preliminary documentation and is subject to change.]

Method: AddProductMatrixToBasket

Add a product with properties to basket.

Input parameters
FieldTypeDescription
languageidintWebGrid Language for this method.
matrixidintProduct matrix identifier. Used by product supporting properties.
Output parameters
FieldTypeDescription
AddProductMatrixToBasketResultstring

Method: AddGiftCard

Adds a gift card.

Input parameters
FieldTypeDescription
giftvaluestringThe giftvalue.
giftemailstringThe giftemail.
gifttostringThe giftto.
giftfromstringThe giftfrom.
giftcommentstringThe giftcomment.
countrycodestringA two-letter country code (ISO 3166-1)
languageidintWebGrid language type.
Output parameters
FieldTypeDescription
AddGiftCardResultstring

Method: ActivateGiftCard

Activates the gift card.

Input parameters
FieldTypeDescription
keystringKey identifier for this method.
languageidintWebGrid Language for this method.
Output parameters
FieldTypeDescription
ActivateGiftCardResultstring

Method: PayActionType

Pay action type.

Input parameters
FieldTypeDescription
inputdatastringThe inputdata.
cartdatastringThe cartdata.
countrycodestringA two-letter country code (ISO 3166-1)
deliveryidintThe deliveryid.
provideridint
languageidintWebGrid language type.
Output parameters
FieldTypeDescription
PayActionTypeResultstring

Method: DeliveryDetails

Delivery details.

Input parameters
FieldTypeDescription
deliveryidintThe deliveryid.
languageidintWebGrid language type.
clientkeystringThe clientkey.
deliverydatestringThe deliverydate.
Output parameters
FieldTypeDescription
DeliveryDetailsResultstring

Method: RegisterWebReturn

Registers the web return.

Input parameters
FieldTypeDescription
swapitemsstringThe swapitems.
returnitemsstringThe returnitems.
trackingidstringThe trackingid.
returnreasonstringThe returnreason.
confirmreturnbooleantrue to confirmreturn.
autoorderidintWebGrid auto order identifier. (This is not OrderID)
countrycodestringA two-letter country code (ISO 3166-1)
clientkeystringThe clientkey.
languageidintWebGrid language type.
Output parameters
FieldTypeDescription
RegisterWebReturnResultstring

Method: WebReturn

Web return.

Input parameters
FieldTypeDescription
autoorderidintWebGrid auto order identifier. (This is not OrderID)
languageidintWebGrid language type.
clientkeystringThe clientkey.
Output parameters
FieldTypeDescription
WebReturnResultstring

Get straight to growing your business

Focus on your business while we take care of the rest with our apps that help you get more sales, get paid, shipping, support your customers and make your business more productive.



No credit card required. No commitments, just awesomeness.

While you’ve been reading this page, more then 1,200 business has been using WebGrid to handle everything from marketing, payments, shipping, projecting and customer communication.
shadow