 |
vinSUITE
Web Services v2.00 API Documentation
|
|
vinSUITE
Web Services v2.00 API Documentation
|
EWS API web service entry point.
More...
Inheritance diagram for eWineryWS.EWSWebServices:EWS API web service entry point.
This class exposes all web methods available in API
| eWineryWS.EWSWebServices.EWSWebServices | ( | ) |
| AddGroupOrderResponse eWineryWS.EWSWebServices.AddGroupOrder | ( | AddGroupOrderRequest | Request | ) |
Add group order
This method is used to add multiple identical orders with different shipping addresses to a new group order.
| AddMemberTypeToWineryResponse eWineryWS.EWSWebServices.AddMemberTypeToWinery | ( | AddMemberTypeToWineryRequest | Request | ) |
Add member type to a winery
This method adds a new member type to a winery
| AddOrderResponse eWineryWS.EWSWebServices.AddOrder | ( | AddOrderRequest | Request | ) |
Add a single Order
This method adds a new order to the eWinery Solutions database. If any products within the order do not yet exist in the database, they will be added automatically as inactive SKUs. This is done to support reporting and features that require a product record be associated with every product in an order.
An additional parameter is passed in to tell the system whether or not the order should decrement inventory when the order is added. If you are using eWinery Solutions as your master inventory record, you should set this parameter to true. If you maintain a separate inventory for website orders, you should set this parameter to false. It is false by default. AddOrder is also capable of billing the newly added order by setting the bill order flag to true.
This method takes in a single order object, a collection of wine shipping options, and a single product shipping option.
Returns the order ID of the newly added order and the status of the call to BillOrder if applicable.
| AddOrderNoteResponse eWineryWS.EWSWebServices.AddOrderNote | ( | AddOrderNoteRequest | Request | ) |
Add order note
This method adds a note to an existing order
| AddOrdersToGroupResponse eWineryWS.EWSWebServices.AddOrdersToGroup | ( | AddOrdersToGroupRequest | Request | ) |
Add orders to group
This method is used to add one or more existing orders to a new or existing group.
| AddRemoveMemberTypesToMemberResponse eWineryWS.EWSWebServices.AddRemoveMemberTypesToMember | ( | AddRemoveMemberTypesToMemberRequest | Request | ) |
Add or remove multiple member types to/from a single member
This method adds or removes a member type to/from a single member.
If Action was set to CREATEANDADD then member type will be assigned to a winery if it is new.
| AddUpdateClubMembershipResponse eWineryWS.EWSWebServices.AddUpdateClubMembership | ( | AddUpdateClubMembershipRequest | Request | ) |
Add or Update a single club membership
This method takes in member and club information and updates a member’s existing club membership information or adds a member to a club if they are not already a member.
| AddUpdateCreditCardResponse eWineryWS.EWSWebServices.AddUpdateCreditCard | ( | AddUpdateCreditCardRequest | Request | ) |
Add or Update a single credit card
This method adds or updates a credit card record to an existing member record.
| AddUpdateMemberResponse eWineryWS.EWSWebServices.AddUpdateMember | ( | AddUpdateMemberRequest | Request | ) |
Add or update a single member record
This method takes in a single member object in the request and either adds or updates that member record in the eWinery Solutions database. Existence of a member record is determined first by trying to match the member ID. If no match is found or no member ID is provided, it will try to match on AltMemberID. This is typically the member ID associated with the record from an external system, such as an RMS member ID.
If no match is found or no AltMemberID is provided, it will try to match on e-mail address. Finally, if no match is found on e-mail address, it will add a new member record. Upon success, the method will return the member ID of the record that was either updated or added.
| AddUpdateProductWineResponse eWineryWS.EWSWebServices.AddUpdateProduct | ( | AddUpdateProductRequest | Request | ) |
Add or update first party product
This method takes in a single product in the request and adds it to the eWinery Solutions database. If a ProductID or sku is provided the corresponding product is updated, otherwise a new product is added to the database.
| AddUpdateSalesAssociateResponse eWineryWS.EWSWebServices.AddUpdateSalesAssociate | ( | AddUpdateSalesAssociateRequest | Request | ) |
Add or update sales associate
This method is used to create or update an existing sales associate for your winery.
| AddUpdateShippingAddressResponse eWineryWS.EWSWebServices.AddUpdateShippingAddress | ( | AddUpdateShippingAddressRequest | Request | ) |
Add or Update a single shipping address
This method takes in member address information and updates an existing address or adds a new address.
| AddUpdateThirdPartyProductResponse eWineryWS.EWSWebServices.AddUpdateThirdPartyProduct | ( | AddUpdateThirdPartyProductRequest | Request | ) |
Add or update third party product
This method takes in a single third party product in the request and adds it to the eWinery Solutions database. If a ThirdPartyProductID or ThirdPartyProductSKU is provided, the corresponding third party product is updated. Otherwise a new third party product is added to the database.
| AddUpdateThirdPartyWineResponse eWineryWS.EWSWebServices.AddUpdateThirdPartyWine | ( | AddUpdateThirdPartyWineRequest | Request | ) |
Add or update a third party wine
This method takes in a single third party wine in the request and adds it to the eWinery Solutions database. If a ThirdPartyProductWineID or ThirdPartyWineSKU is provided, the corresponding third party wine is updated. Otherwise a new third party wine is added to the database.
| AddUpdateProductWineResponse eWineryWS.EWSWebServices.AddUpdateWine | ( | AddUpdateWineRequest | Request | ) |
Add or update first party wine
This method takes in a single wine in the request and adds it to the eWinery Solutions database. If a ProductID or sku is passed the corresponding product is updated, otherwise a new product is added to the database.
| BillOrderResponse eWineryWS.EWSWebServices.BillOrder | ( | BillOrderRequest | Request | ) |
Bill and existing order
This method takes in an order ID and credit card payment information (CreditCardID) and bills the order. If your winery has order compliance checking enabled, the order will be checked for compliance first. The method returns success or an error code resulting from a failed compliance check or payment gateway transaction.
| CheckComplianceResponse eWineryWS.EWSWebServices.CheckOrderCompliance | ( | CheckComplianceRequest | Request | ) |
Check compliance of an existing order by using ShipCompliant services
This method takes in an order ID and returns success or any applicable compliance errors of failures associated with the order.
| GetClubDiscountsResponse eWineryWS.EWSWebServices.GetClubDiscounts | ( | GetClubDiscountsRequest | Request | ) |
Get a list of available discounts at a given club
This method takes in a member and returns the discounts available to them based on their club memberships.
| GetClubMembershipsResponse eWineryWS.EWSWebServices.GetClubMemberships | ( | GetClubMembershipsRequest | Request | ) |
Get a list of club memberships
This method takes in a member ID and/or a variety of date ranges and returns a collection of club membership objects.
| GetClubsResponse eWineryWS.EWSWebServices.GetClubs | ( | GetClubsRequest | Request | ) |
Get a list of winery clubs
This method returns information about wine clubs available for a winery.
| GetClubSignupsBySalesAssociateResponse eWineryWS.EWSWebServices.GetClubSignupsBySalesAssociate | ( | GetCubSignupsBySalesAssociateRequest | request | ) |
Get a list of sales associates and their club sign-ups
Retrieves the number of club sign-ups grouped by sales associate between a date range
| GetCompliantWinesResponse eWineryWS.EWSWebServices.GetCompliantWines | ( | GetCompliantWinesRequest | Request | ) |
Get a list of wines and their compliance statuses by state
This method retrieves a collection wine/state pairings along with the wine’s compliance status in that state. The results can be filtered by setting the value of show non-compliant wines. A value of false will return only compliant wines. A value of true will return only non-compliant wines. If the value is not specified, all wines and statuses will be returned for each state.
| GetCreditCardsResponse eWineryWS.EWSWebServices.GetCreditCards | ( | GetCreditCardsRequest | Request | ) |
Get a list of members
Retrieve a list of credit cards associated with a specific member in the system
| GetCreditCardTypesResponse eWineryWS.EWSWebServices.GetCreditCardTypes | ( | GetCreditCardTypesRequest | Request | ) |
Get credit card types
Get a list of all available credit card types
| GetHostEntriesResponse eWineryWS.EWSWebServices.GetHostEntries | ( | MasterAdminRequest | Request | ) |
Get the host file contents, Master Admins ONLY
Reserved for master admins
| GetLogResponse eWineryWS.EWSWebServices.GetLog | ( | GetLogRequest | Request | ) |
Get a list of log entries for your web service calls.
This method takes several search parameters and returns a collection of web service request and response logs as raw XML. All search parameters are optional. This service is especially useful for developers troubleshooting XML request structure.
| GetMemberAuthenticationResponse eWineryWS.EWSWebServices.GetMemberAuthentication | ( | GetMemberAuthenticationRequest | Request | ) |
Authenticate Member - J&M
This method Authenticates a Member using the Username and Password.
| GetMemberClubsAndTypesResponse eWineryWS.EWSWebServices.GetMemberClubsAndTypes | ( | GetMemberClubsAndTypesRequest | request | ) |
Get a list of club titles and member types associated with member email
This method calls GetMembers and parses the response
| request |
| GetMemberNotesResponse eWineryWS.EWSWebServices.GetMemberNotes | ( | GetMemberNotesRequest | Request | ) |
Get a list of member notes
This method takes in a member ID and/or date ranges and returns a collection of member notes.
Optionally, you can specify whether or not to include notes which were automatically generated by the eWinery Solutions admin panel.
| GetMembersResponse eWineryWS.EWSWebServices.GetMembers | ( | GetMembersRequest | Request | ) |
Get a list of members
This method takes in several search parameters and returns a collection of member objects that match the search criteria. All search parameters are optional and compounded. Passing in blank search criteria will result in all members being returned. You can also specify whether or not you would like the club and shipping information included with each member. Note that if there are many members in the database, it may be time consuming to pull down all of the information at once. Typically it makes sense to just pull the member data from this method then call GetclubMembership and GetShippingAddress on demand when required by your system.
| GetMemberTypesResponse eWineryWS.EWSWebServices.GetMemberTypes | ( | GetMemberTypesRequest | Request | ) |
Get a list of member types assigned to a member
This method takes in a member ID, alternate member ID, and email address, and returns a collection of member type objects associated with that member.
| GetMergedMembersResponse eWineryWS.EWSWebServices.GetMergedMembers | ( | GetMergedMembersRequest | Request | ) |
Get a list of merged members
This method takes in search criteria and retrieves a list of members who previously had multiple records in the system that were merged into a single record.
| GetOrderNotesResponse eWineryWS.EWSWebServices.GetOrderNotes | ( | GetOrderNotesRequest | Request | ) |
Get order notes
This method takes in an order ID, an order number, and/or a date range and returns a collection of order notes. Optionally, you may specify an order number prefix to differentiate between orders with the same order number. You may also specify whether or not to include notes which were automatically generated by the eWinery Solutions admin panel.
| GetOrdersResponse eWineryWS.EWSWebServices.GetOrders | ( | GetOrdersRequest | Request | ) |
Get orders
This method takes in several search parameters and returns a collection of order objects that match the search criteria. All search parameters are optional. Passing in blank search criteria will result in all orders being returned.
| GetPOSTastingsByCashierResponse eWineryWS.EWSWebServices.GetPOSTastingsByCashier | ( | GetPOSTastingsByCashierRequest | request | ) |
Get sum total of tasting room visitors grouped by cashier
This method is accessible to WINERY type users only.
| GetPOSWineSalesByCashierResponse eWineryWS.EWSWebServices.GetPOSWineSalesByCashier | ( | GetPOSWineSalesByCashierRequest | request | ) |
Get sum total of POS sales for each cashier in a winery
This method is accessible to WINERY type users only.
| GetPBMAResponse eWineryWS.EWSWebServices.GetPreferenceBasedMarketingAnswers | ( | GetPBMARequest | Request | ) |
Get a list of preference based marketing answers
This method takes in a member ID and/or date ranges and returns a collection of marketing questions and answers. Optionally, you can specify whether or not to return questions that have not answered.
| GetProductCategoriesResponse eWineryWS.EWSWebServices.GetProductCategories | ( | GetProductCategoriesRequest | Request | ) |
Get a list of all product categories for a winery (or multiple wineries for suppliers)
Use this method to return all the product categories set up in your winery or wineries.
| GetProductsResponse eWineryWS.EWSWebServices.GetProducts | ( | GetProductsRequest | Request | ) |
Get a list of products
This method takes several search parameters and returns a list of first party products. Search parameters include product name, product sku, and date ranges to limit results. All search parameters are optional. Passing in blank search criteria will result in all products being returned.
| GetSalesAssociatesResponse eWineryWS.EWSWebServices.GetSalesAssociates | ( | GetSalesAssociatesRequest | Request | ) |
Get sales associates
This method is used to retrieve an array of sales associates for your winery.
Sales associates returned from this method can be attached to an order when using AddOrder.
| GetSCLogsResponse eWineryWS.EWSWebServices.GetSCLog | ( | MasterAdminRequest | Request | ) |
Get the contents of the ShipCompliant log files, Master Admins ONLY
Reserved for master admins
| GetShippingAddressesResponse eWineryWS.EWSWebServices.GetShippingAddresses | ( | GetShippingAddressesRequest | Request | ) |
Get a list of member's shipping addresses
This method takes in a member ID, virtual member ID, and/or a variety of date ranges and returns a collection of shipping address objects.
| GetShippingOptionsResponse eWineryWS.EWSWebServices.GetShippingOptions | ( | GetShippingOptionsRequest | Request | ) |
Get shipping options
Retrieve a list of all available shipping options for a specific winery
| GetShipTaxResponse eWineryWS.EWSWebServices.GetShipTax | ( | GetShipTaxRequest | Request | ) |
Get shipping options and tax
This method takes in a zip code, a collection of wine information, and a weight. The wine information is used to determine available shipping options for those wines. The weight is used to determine the available shipping options for first party products. In order to properly calculate first party product shipping options, the combined weight off all products should be used. The method returns a collection of wine shipping options and product shipping options. These results can be passed back to the AddOrder method to automatically generate shipping information when an order is added. The method can optionally return a tax profile.
Tax profile contains information about how to calculate taxes, handling, and bottle deposit values for the state and zip code.
| GetThirdPartyProductsResponse eWineryWS.EWSWebServices.GetThirdPartyProducts | ( | GetProductsRequest | Request | ) |
Get a list of third party products
This method takes several search parameters and returns a list of third party products. Search parameters are identical to those of the GetProduct service. Passing in blank search criteria will result in all third party products being returned.
| GetThirdPartyWinesResponse eWineryWS.EWSWebServices.GetThirdPartyWines | ( | GetWinesRequest | Request | ) |
Get a list of third party wines
This method takes several parameters and returns a list of third party wines. Search parameters are identical to those of the GetWine service. Passing in blank search criteria will result in all third party wines being returned.
| GetVirtualMembersResponse eWineryWS.EWSWebServices.GetVirtualMembers | ( | GetVirtualMembersRequest | Request | ) |
Get a list of virtual members
This method takes in several search parameters and returns a collection of virtual members and their winery affiliations that match the criteria.
| GetWillCallLocationsResponse eWineryWS.EWSWebServices.GetWillCallLocations | ( | GetWillCallLocationsRequest | Request | ) |
Get will-call locations
Retrieve a list of all available will-call locations for a specific winery
| GetWineBrandsResponse eWineryWS.EWSWebServices.GetWineBrands | ( | GetWineBrandsRequest | Request | ) |
Get a list of all Wine Brands for the caller's winery ID
This is a WINERY level request.
| GetWineryMemberTypesResponse eWineryWS.EWSWebServices.GetWineryMemberTypes | ( | GetWineryMemberTypesRequest | Request | ) |
Get a list of available member types at a given winery
This method allows the caller to retrieve all the member types configured for their winery.
| GetWineryStatesResponse eWineryWS.EWSWebServices.GetWineryStates | ( | GetWineryStatesRequest | Request | ) |
Get winery states
This method retrieves all the states in which a winery is authorized to sell wine products.
| GetWinesResponse eWineryWS.EWSWebServices.GetWines | ( | GetWinesRequest | Request | ) |
Get a list of wines
This method takes search several parameters and returns a list of fist party wines. Search parameters include wine name, wine sku, vintage, vineyard designation, and date ranges to limit results. All search parameters are optional. Passing in blank search criteria will result in all wines being returned.
| GetWinesGlobalResponse eWineryWS.EWSWebServices.GetWinesGlobal | ( | GetWinesGlobalRequest | Request | ) |
Get a list of first and third party wines
Get 1st and 3rd party wines
| MarkOrderPickedUpResponse eWineryWS.EWSWebServices.MarkOrderPickedUp | ( | MarkOrderPickedUpRequest | Request | ) |
Set a picked up status for an existing order
This method takes in an order ID, a Boolean to tell if the order has been picked up or not, who picked up the order, and who it was picked up from. This information updates the order in the eWinery Solutions database accordingly.
| TestConnectionResponse eWineryWS.EWSWebServices.TestConnection | ( | TestConnectionRequest | Request | ) |
Test credentials
This method takes no parameters other than authentication credentials and returns success if they are valid.
Use this method if you would like to quickly test the availability of the web services or validity of your credentials.
| UpdateOrderResponse eWineryWS.EWSWebServices.UpdateOrder | ( | UpdateOrderRequest | Request | ) |
Update order billing and shipping information
This method allows the caller to update the shipping address and billing address of an order with an “Accepted” status.
| UpdateOrderStatusResponse eWineryWS.EWSWebServices.UpdateOrderStatus | ( | UpdateOrderStatusRequest | Request | ) |
Update status of an existing order
This method can be used to change the status of an existing order. Orders which have a status of ‘Completed’ cannot be changed.
| UpdateThirdPartyWineMasterInventoryResponse eWineryWS.EWSWebServices.UpdateThirdPartyWineMasterInventory | ( | UpdateThirdPartyWineMasterInventoryRequest | Request | ) |
Update an existing third party master wine record.
Request requirements:
Only SUPPLIERS can call UpdateThirdPartyWineMasterInventoryRequest.
WineSKU is required.
1.9.5 