Shopworld Cloud Web API Documentation

Introduction

API Documentation for eCommerce direct sales channels.

Location

API	Description
POST Location/StoreCountries	Get Countries
POST Location/Countries	Get Countries
POST Location/Regions	Get Regions
POST Location/Provinces	Get Provinces
POST Location/Localities	Get Localities for a postal code and country
POST Location/Places	Get Districts for a postal code and country

Inventory

API	Description
POST Inventory/VariationStocks	VariationStocks

Logistics

API	Description
POST Logistics/Warehouses	Get all the Warehouses
POST Logistics/ShippingMeansWarehouses	Warehouses that can be used as a destination for when selecting a ShippingMeans

Booking

API	Description
POST Booking/ShippingSlots	Get all the Slots for a period range
POST Booking/ShippingSlot	Get information about a ShippingSlot
POST Booking/AddShippingAppointment	Adds a ShippingAppointment to the order
DELETE Booking/RemoveShippingAppointment	Removes a ShippingAppointment from the order

Store

API	Description
POST Store/StoreConfiguration	Get Store Configuration

Marketing

API	Description
POST Marketing/FreeShippingRates	Free Shipping Rates
POST Marketing/Newsletters	No documentation available.
POST Marketing/AddNewsletterSubscriber	No documentation available.
PUT Marketing/ModifyNewsletterSubscriber	No documentation available.
POST Marketing/AddNewsletterSubscription	No documentation available.
DELETE Marketing/RemoveNewsletterSubscription	No documentation available.
POST Marketing/ApplicablePromotions	No documentation available.
POST Marketing/GetPromotion	No documentation available.
POST Marketing/Rewards	No documentation available.
POST Marketing/LoyaltyConfiguration	No documentation available.

Account

API	Description
POST Account/ChangePassword	No documentation available.
PUT Account/ModifyUserName	No documentation available.
PUT Account/DeleteUser	No documentation available.
POST Account/IsRegistered	Checks if username is an existing Customer
POST Account/Register	Registers a Customer.
POST Account/ForgotPassword	The returned url may contain character "+" encoded as a space by web browsers. The front app must handle this case.
POST Account/PasswordRecovery	No documentation available.

Orders

API	Description
POST Orders/Orders	No documentation available.
POST Orders/PromotedItems	No documentation available.
POST Orders/Order	No documentation available.
POST Orders/AddOrder	No documentation available.
PUT Orders/ModifyOrder
DELETE Orders/RemoveOrder	Cancels an open or confirmed order. Customer needs to be logged in for cancelling confirmed orders.
PUT Orders/ModifyOrderShipping	ModifyOrderShipping
PUT Orders/ModifyOrderShippingContactPlace	ModifyOrderShippingContactPlace only for anonymous users
PUT Orders/ModifyOrderShippingContact	ModifyOrderShippingContact
PUT Orders/ModifyOrderBillingContact	ModifyOrderBillingContact
POST Orders/AddCoupon	Adds a Coupon to the order
DELETE Orders/RemoveCoupon	Removes a Coupon from the order
POST Orders/AddOrderItem
POST Orders/AddOrderItemComponent
PUT Orders/ModifyOrderItem	throw new HttpResponseException(HttpStatusCode.Unauthorized); ModifyOrderItem
DELETE Orders/RemoveOrderItem	No documentation available.
DELETE Orders/RemoveOrderItemComponent	No documentation available.

Feature

API	Description
POST Feature/FeatureTypes	Get all the FeatureTypes
POST Feature/Feature	GetFeatures with same parentID
POST Feature/Features	No documentation available.
POST Feature/FeatureValues	No documentation available.
POST Feature/FeatureImages	No documentation available.
POST Feature/FeatureOption	GetFeatureOptions with same parentID
POST Feature/FeatureOptions	No documentation available.
POST Feature/FeatureOptionImages	No documentation available.

Customers

API	Description
POST Customers/Customer	Retrieves an existing Customer
PUT Customers/ModifyCustomer	Updates an existing Customer. Requires ID of customer. {"DateOfBirth":"2000-02-15","Name":"David","FirstSurname":"Sanchez","SecondSurname":"Sanchez","Gender":1,"LanguageID":1,"OrganizationName":"Shopworld", "TypeID":1}
POST Customers/AddContact	Create a new Customer Contact.
POST Customers/AddCustomerQuery	Gets automatically associated to a CustomerID, if logged in
PUT Customers/ModifyContact	Modify a new Customer Contact.
DELETE Customers/RemoveContact	Delete a new Customer Contact.
POST Customers/AddQuickPayment	Add for a customer allowing for quickPayment
DELETE Customers/RemoveQuickPayment	Remove for a customer not allowing for quickPayment anymore
POST Customers/CustomerTypes	Retrieves existing CustomerTypes
POST Customers/FavoriteProducts	Gets the favorite products of a customer
POST Customers/AddFavoriteProduct	Adds favoriteProduct to a Customer
DELETE Customers/RemoveFavoriteProduct	Removes favoriteProduct from a Customer

Business

API	Description
POST Business/Business	Retrieves a Business
POST Business/Businesses	Retrieves all existing Businesses.
POST Business/BusinessContact	Retrieves a BusinessContact
POST Business/BusinessContacts

Catalog

API	Description
POST Catalog/MemoryCacheDelete	No documentation available.
POST Catalog/CacheDelete	No documentation available.
POST Catalog/CacheAllStores	No documentation available.
POST Catalog/CacheCatalog	No documentation available.
POST Catalog/Slug	Gets the Entity related to a Slug. If Slug is not active, then returns a redirect Returns product or classification and corresponding language
POST Catalog/Slugs	Gets all the Slugs
POST Catalog/SlugByID	Gets the Slug related to a Entity and language. Returns slug. Used by Shopworld CMS.
POST Catalog/ProductByID	Get a Product
POST Catalog/ProductTariffsByID	Gets tariff price for a Product
POST Catalog/ProductTariffsByIDs	Gets tariff price for a group of Products
POST Catalog/ProductStockByID	Gets stock quantity for a Product
POST Catalog/ProductComponents	Get ProductComponents
POST Catalog/Variation	Get a Variation
POST Catalog/Brand	No documentation available.
POST Catalog/Brands	No documentation available.
POST Catalog/Collection	No documentation available.
POST Catalog/Collections	No documentation available.
POST Catalog/Products	Get Products
POST Catalog/BoundProducts	Get the list of boundProducts
POST Catalog/BoundTypes	No documentation available.
POST Catalog/ClassificationSiblings	GetSiblingClassifications Use null ID to get top classifications
POST Catalog/AttributeSiblings	GetSiblingAttributes Use null ID to get top attributes
POST Catalog/ClassificationAttributes	Get attributes associated to a product classification and, optionally, a parent attribute
POST Catalog/ClassificationBrands	Get brands associated to a product classification
POST Catalog/RelatedSales	Gets which other Products are usually bought together with the provided product.
POST Catalog/ProductFeatures	Return product feature definitions. Filter by featureIDs, productIDs or classificationIDs

Localization

API	Description
POST Localization	Get Languages

Invoices

API	Description
POST Invoices	No documentation available.