Shopworld Cloud Admin API Documentation

Introduction

API Documentation for eCommerce transactions and business administration.

Location

API	Description
POST Location/LocationTypes	Get all the LocationTypes
POST Location/Countries	Get system available Countries
POST Location/Country
POST Location/Regions	Get Regions
POST Location/Region
POST Location/Provinces	Get Provinces
POST Location/Province
POST Location/Localities	Get Localities for a postal code and country
POST Location/Locality
POST Location/Places	Get Districts for a postal code and country
POST Location/Place
POST Location/StoreCountries	Get StoreCountries
POST Location/AddStoreCountry	Adds a StoreCountry
DELETE Location/RemoveStoreCountry	Removes an existing StoreCountry.

Inventory

API	Description
POST Inventory/VariationInventories	Get all the Inventory associated to a Variation. This acts as a "History Log" of all inventory movement Table VariationStocks is not used
POST Inventory/AddVariationInventory	Adds a VariationInventory. Updates Variation and Product Quantity
POST Inventory/VariationStocks	Get all the Stock associated to a Variation. This is the SUM() of all VariationInventory
POST Inventory/OutOfStockProducts
POST Inventory/OutOfStockVariations	No documentation available.
POST Inventory/StockValue	No documentation available.
POST Inventory/StockValueByWarehouse	No documentation available.

Logistics

API	Description
POST Logistics/WarehouseSlugs	WarehouseSlugs
POST Logistics/Warehouse	GetWarehouses with same parentID
POST Logistics/Warehouses	Get all the Warehouses
POST Logistics/AddWarehouse	Adds a Warehouse.
PUT Logistics/ModifyWarehouse	Modifies an existing Warehouse.
DELETE Logistics/RemoveWarehouse	Removes an existing Warehouse.
POST Logistics/WarehouseContact	GetWarehouseContacts
POST Logistics/AddWarehouseContact	Adds a WarehouseContact.
PUT Logistics/ModifyWarehouseContact	ModifyWarehouseContact
DELETE Logistics/RemoveWarehouseContact	Removes an existing WarehouseContact.
PUT Logistics/ModifyWarehouseLocation	Adds a WarehouseLocation.
POST Logistics/AddWarehouseImageSet	No documentation available.
PUT Logistics/ModifyWarehouseImage	Modify metadata associated to an image
DELETE Logistics/RemoveWarehouseImageSet	No documentation available.
POST Logistics/AddDisabledWarehousePeriod	Adds a DisabledWarehousePeriod.
PUT Logistics/ModifyDisabledWarehousePeriod	Modifies an existing DisabledWarehousePeriod.
DELETE Logistics/RemoveDisabledWarehousePeriod	Removes an existing DisabledWarehousePeriod.
POST Logistics/ShippingOrder	GetShippingOrders
POST Logistics/ShippingOrders	Get all the ShippingOrders
POST Logistics/CreateShippingOrders	Creates pending ShippingOrders corresponding from to an order OrderShippings
POST Logistics/AddShippingOrder	Adds a ShippingOrder.
PUT Logistics/ModifyShippingOrder	ModifyShippingOrder
DELETE Logistics/RemoveShippingOrder	Removes an existing ShippingOrder.
POST Logistics/ShippingOrderStatus	Get ShippingOrderStatus
POST Logistics/ShippingOrderItem	GetShippingOrderItems
POST Logistics/ShippingOrderItems	Get all the ShippingOrderItems
POST Logistics/AddShippingOrderItem	Adds a ShippingOrderItem.
PUT Logistics/ModifyShippingOrderItem	ModifyShippingOrderItem
DELETE Logistics/RemoveShippingOrderItem	Removes an existing ShippingOrderItem.
POST Logistics/PrintPackageLabels	Returns PDF with the selected PackageLabels
POST Logistics/PackageLabel	GetPackageLabels
POST Logistics/PackageLabels	Get all the PackageLabels
POST Logistics/AddPackageLabel	Adds a PackageLabel.
PUT Logistics/ModifyPackageLabel	ModifyPackageLabel
DELETE Logistics/RemovePackageLabel	Removes an existing PackageLabel.
POST Logistics/ShippingOrderStatusLog	GetShippingOrderStatusLogs
POST Logistics/ShippingOrderStatusLogs	Get all the ShippingOrderStatusLogs
POST Logistics/AddShippingOrderStatusLog	Adds a ShippingOrderStatusLog.
PUT Logistics/ModifyShippingOrderStatusLog	ModifyShippingOrderStatusLog
DELETE Logistics/RemoveShippingOrderStatusLog	Removes an existing ShippingOrderStatusLog.
POST Logistics/ShippingOrderPublicStatus	GetShippingOrderPublicStatus
POST Logistics/GetShippingOrderPublicStatusList	Get all the ShippingOrderPublicStatus
POST Logistics/AddShippingOrderPublicStatus	Adds a ShippingOrderPublicStatus.
PUT Logistics/ModifyShippingOrderPublicStatus	ModifyShippingOrderPublicStatus
DELETE Logistics/RemoveShippingOrderPublicStatus	Removes an existing ShippingOrderPublicStatus.
POST Logistics/ShippingZone	GetShippingZones
POST Logistics/ShippingZones	Get all the ShippingZones
POST Logistics/AddShippingZone	Adds a ShippingZone.
PUT Logistics/ModifyShippingZone	ModifyShippingZone
DELETE Logistics/RemoveShippingZone	Removes an existing ShippingZone.
POST Logistics/ShippingZoneLocation	GetShippingZoneLocations
POST Logistics/ShippingZoneLocations	Get all the ShippingZoneLocations
POST Logistics/AddShippingZoneLocation	Adds a ShippingZoneLocation.
PUT Logistics/ModifyShippingZoneLocation	ModifyShippingZoneLocation
DELETE Logistics/RemoveShippingZoneLocation	Removes an existing ShippingZoneLocation.
POST Logistics/ShippingPrice	GetShippingPrices
POST Logistics/ShippingPrices	Get all the ShippingPrices
POST Logistics/AddShippingPrice	Adds a ShippingPrice.
PUT Logistics/ModifyShippingPrice	ModifyShippingPrice
DELETE Logistics/RemoveShippingPrice	Removes an existing ShippingPrice.
POST Logistics/LogisticsConfiguration	LogisticsConfigurations where a LogisticsConfiguration
POST Logistics/AddLogisticsConfiguration	Creates a reciproque bound between two LogisticsConfigurations.
PUT Logistics/ModifyLogisticsConfiguration	Modifies an existing LogisticsConfiguration.
POST Logistics/ShippingMeansBases	ShippingMeansBases
POST Logistics/ShippingMeans	Returns a ShippingMeans
POST Logistics/StoreShippingMeans	Returns a list of ShippingMeans
POST Logistics/AddShippingMeans	Adds a child ShippingMeans to a parent It's up to the front to set the ShippingMeans sortOrder.
PUT Logistics/ModifyShippingMeans	Modifies the ShippingMeans It's up to the front to call this method so many times as needed for ShippingMeans rearrangement.
DELETE Logistics/RemoveShippingMeans	Removes a ShippingMeans
POST Logistics/ShippingMeansWarehouses	All ShippingMeansWarehouses of a store
POST Logistics/AddShippingMeansWarehouse	Adds a warehouse to a shipping means
DELETE Logistics/RemoveShippingMeansWarehouse	Removes a warehouse from a shipping means
POST Logistics/ShippingCarrier	ShippingCarrier
POST Logistics/ShippingCarriers	ShippingCarriers
POST Logistics/AddShippingCarrier	Adds a child ShippingCarriers to a parent It's up to the front to set the ShippingCarriers sortOrder.
PUT Logistics/ModifyShippingCarrier	Modifies the ShippingCarriers It's up to the front to call this method so many times as needed for ShippingCarriers rearrangement.
DELETE Logistics/RemoveShippingCarrier	Removes a ShippingCarriers
POST Logistics/CorreosExpressProcessors	CorreosExpressProcessors
POST Logistics/AddCorreosExpressProcessors	Adds a child CorreosExpressProcessors to a parent It's up to the front to set the CorreosExpressProcessors sortOrder.
PUT Logistics/ModifyCorreosExpressProcessors	Modifies the CorreosExpressProcessors It's up to the front to call this method so many times as needed for CorreosExpressProcessors rearrangement.
DELETE Logistics/RemoveCorreosExpressProcessors	Removes a CorreosExpressProcessors
POST Logistics/MandalopProcessors	MandalopProcessors
POST Logistics/AddMandalopProcessors	Adds a child MandalopProcessors to a parent It's up to the front to set the MandalopProcessors sortOrder.
PUT Logistics/ModifyMandalopProcessors	Modifies the MandalopProcessors It's up to the front to call this method so many times as needed for MandalopProcessors rearrangement.
DELETE Logistics/RemoveMandalopProcessors	Removes a MandalopProcessors
POST Logistics/MensatransProcessors	MensatransProcessors
POST Logistics/AddMensatransProcessor	Adds a child MensatransProcessor to a parent It's up to the front to set the MensatransProcessor sortOrder.
PUT Logistics/ModifyMensatransProcessor	Modifies the MensatransProcessor It's up to the front to call this method so many times as needed for MensatransProcessor rearrangement.
DELETE Logistics/RemoveMensatransProcessor	Removes a MensatransProcessor

Store

API	Description
GET Stores/Stores	No documentation available.
GET Stores/StoreID?domain={domain}	No documentation available.
GET Stores/Store	No documentation available.
POST Stores/AddStore	Retrieves an existing Store.
PUT Stores/ModifyStore	Retrieves an existing Store.
DELETE Stores/RemoveStore	Retrieves an existing Store.
POST Stores/Languages	No documentation available.
POST Stores/StoreLanguages	No documentation available.
POST Stores/AddStoreLanguage	No documentation available.
DELETE Stores/RemoveStoreLanguage	No documentation available.
POST Stores/ImageSizes	Get ImageSizes
POST Stores/SalesStockPolicies	Get SalesStockPolicys
POST Stores/StoreConfiguration	StoreConfigurations where a StoreConfiguration
POST Stores/AddStoreConfiguration	Creates a reciproque bound between two StoreConfigurations.
PUT Stores/ModifyStoreConfiguration	Modifies an existing StoreConfiguration.
POST Stores/StoreContacts	StoreContacts where a StoreContact
POST Stores/StoreContact	StoreContact
POST Stores/AddStoreContact	Creates a reciproque bound between two StoreContacts.
PUT Stores/ModifyStoreContact	Modifies an existing StoreContact.
DELETE Stores/RemoveStoreContact	Removes a StoreContact
POST Stores/GoogleShoppingConfiguration	GoogleShoppingConfigurations where a GoogleShoppingConfiguration
POST Stores/AddGoogleShoppingConfiguration	No documentation available.
PUT Stores/ModifyGoogleShoppingConfiguration	Modifies an existing GoogleShoppingConfiguration.

Booking

API	Description
POST Booking/BookingConfiguration	BookingConfigurations where a BookingConfiguration
POST Booking/BookingConfigurations	BookingConfigurations where a BookingConfiguration
POST Booking/AddBookingConfiguration	Creates a reciproque bound between two BookingConfigurations.
PUT Booking/ModifyBookingConfiguration	Modifies an existing BookingConfiguration.
DELETE Booking/RemoveBookingConfiguration	Removes a BookingConfiguration
POST Booking/ShippingBookingConfigurations	All ShippingBookingConfigurations of a store
POST Booking/AddShippingBookingConfiguration	Adds a warehouse to a shipping BookingConfiguration
DELETE Booking/RemoveShippingBookingConfiguration	Removes a warehouse from a shipping BookingConfiguration
POST Booking/ABusinessHours	BusinessHours where a BusinessHours
POST Booking/BusinessHours	BusinessHours where a BusinessHours
POST Booking/AddBusinessHours	Creates a reciproque bound between two BusinessHours.
PUT Booking/ModifyBusinessHours	Modifies an existing BusinessHours.
DELETE Booking/RemoveBusinessHours	Removes a BusinessHours
POST Booking/ShippingBusinessHours	All ShippingBusinessHours of a store
POST Booking/AddShippingBusinessHours	Adds a warehouse to a shipping BusinessHours
DELETE Booking/RemoveShippingBusinessHours	Removes a warehouse from a shipping BusinessHours
POST Booking/ShippingSlot	ShippingSlots where a ShippingSlot
POST Booking/ShippingSlots	ShippingSlots where a ShippingSlot
POST Booking/AddShippingSlot	Creates a reciproque bound between two ShippingSlots.
PUT Booking/ModifyShippingSlot	Modifies an existing ShippingSlot.
DELETE Booking/RemoveShippingSlot	Removes a ShippingSlot
POST Booking/ShippingAppointment	ShippingAppointments where a ShippingAppointment
POST Booking/ShippingAppointments	ShippingAppointments where a ShippingAppointment
POST Booking/AddShippingAppointment	Creates a reciproque bound between two ShippingAppointments.
PUT Booking/ModifyShippingAppointment	Modifies an existing ShippingAppointment.
DELETE Booking/RemoveShippingAppointment	Removes a ShippingAppointment

Marketing

API	Description
POST Marketing/Coupon	GetCoupons with same parentID
POST Marketing/Coupons	Get all the Coupons
POST Marketing/CouponableTypes	Get all the CouponableTypes
POST Marketing/AddCoupon	No documentation available.
PUT Marketing/ModifyCoupon	No documentation available.
DELETE Marketing/RemoveCoupon	Removes an existing Coupon.
POST Marketing/PromotionSlugs	PromotionSlugs
POST Marketing/Promotion	GetPromotions with same parentID
POST Marketing/Promotions	Get all the Promotions
POST Marketing/AddPromotion	No documentation available.
PUT Marketing/ModifyPromotion	No documentation available.
DELETE Marketing/RemovePromotion	Removes an existing Promotion.
POST Marketing/PromotionableTypes	Get all the PromotionableTypes
POST Marketing/PromotionItem	GetPromotionItems with same parentID
POST Marketing/PromotionItems	Get all the PromotionItems
POST Marketing/AddPromotionItem	No documentation available.
PUT Marketing/ModifyPromotionItem	No documentation available.
DELETE Marketing/RemovePromotionItem	Removes an existing PromotionItem.
POST Marketing/PromotedItem	GetPromotedItems with same parentID
POST Marketing/PromotedItems	Get all the PromotedItems
POST Marketing/AddPromotedItem	No documentation available.
PUT Marketing/ModifyPromotedItem	No documentation available.
DELETE Marketing/RemovePromotedItem	Removes an existing PromotedItem.
POST Marketing/UnpromotedItem	GetUnpromotedItems with same parentID
POST Marketing/UnpromotedItems	Get all the UnpromotedItems
POST Marketing/AddUnpromotedItem	No documentation available.
PUT Marketing/ModifyUnpromotedItem	No documentation available.
DELETE Marketing/RemoveUnpromotedItem	Removes an existing UnpromotedItem.
POST Marketing/ProductReviews	ProductReviews where a Product is bound as a principal or child
POST Marketing/AddProductReview	Creates a reciproque bound between two Products.
PUT Marketing/ModifyProductReview	Modifies an existing ProductReview.
DELETE Marketing/RemoveProductReview	Removes a ProductReview
POST Marketing/NewsletterIssueSlugs	NewsletterIssueSlugs
POST Marketing/Newsletter	GetNewsletters with same parentID
POST Marketing/Newsletters	Get all the Newsletters
POST Marketing/AddNewsletter	No documentation available.
PUT Marketing/ModifyNewsletter	No documentation available.
DELETE Marketing/RemoveNewsletter	Removes an existing Newsletter.
POST Marketing/SendNewsletterIssue	SendNewsletterIssue to the Subscribers of the Newsletter
POST Marketing/NewsletterIssue	GetNewsletterIssues with same parentID
POST Marketing/NewsletterIssues	Get all the NewsletterIssues
POST Marketing/AddNewsletterIssue	No documentation available.
PUT Marketing/ModifyNewsletterIssue	No documentation available.
DELETE Marketing/RemoveNewsletterIssue	Removes an existing NewsletterIssue.
POST Marketing/NewsletterTemplate	GetNewsletterTemplates with same parentID
POST Marketing/NewsletterTemplates	Get all the NewsletterTemplates
POST Marketing/AddNewsletterTemplate	No documentation available.
PUT Marketing/ModifyNewsletterTemplate	No documentation available.
DELETE Marketing/RemoveNewsletterTemplate	Removes an existing NewsletterTemplate.
POST Marketing/SendPushNotification	Send Push Notification to all users that have accepted to receive push notifications
POST Marketing/PushNotification	Gets a Push Notification
POST Marketing/PushNotifications	Get all the Push Notifications
POST Marketing/AddPushNotification	Send Push Notification to all users that have accepted to receive push notifications
PUT Marketing/ModifyPushNotification	No documentation available.
DELETE Marketing/RemovePushNotification	Removes an existing Push Notification.
POST Marketing/LoyaltyConfiguration	LoyaltyConfiguration where a LoyaltyConfiguration
POST Marketing/AddLoyaltyConfiguration	No documentation available.
PUT Marketing/ModifyLoyaltyConfiguration	Modifies an existing LoyaltyConfiguration.
POST Marketing/AddCustomerTypeLoyaltyConfiguration	No documentation available.
DELETE Marketing/RemoveCustomerTypeLoyaltyConfiguration	Removes an existing CustomerTypeLoyaltyConfiguration.
POST Marketing/NewsletterSubscriptions	GetNewsletters with same parentID
POST Marketing/AddNewsletterSubscription	No documentation available.
PUT Marketing/ModifyNewsletterSubscription	No documentation available.
DELETE Marketing/RemoveNewsletterSubscription	No documentation available.
POST Marketing/NewsletterSubscribers	GetNewsletters with same parentID
POST Marketing/AddNewsletterSubscriber	No documentation available.
PUT Marketing/ModifyNewsletterSubscriber	No documentation available.
DELETE Marketing/RemoveNewsletterSubscriber	No documentation available.
POST Marketing/RewardTypes	Retrieves existing RewardTypes
POST Marketing/Reward	GetRewards with same parentID
POST Marketing/Rewards	Get all the Rewards
POST Marketing/AddReward	No documentation available.
PUT Marketing/ModifyReward	No documentation available.
DELETE Marketing/RemoveReward	Removes an existing Reward.
POST Marketing/RewardExchangeRate	GetRewardExchangeRates with same parentID
POST Marketing/RewardExchangeRates	Get all the RewardExchangeRates
POST Marketing/AddRewardExchangeRate	No documentation available.
PUT Marketing/ModifyRewardExchangeRate	No documentation available.
DELETE Marketing/RemoveRewardExchangeRate	Removes an existing RewardExchangeRate.
POST Marketing/AddCustomerTypeRewardExchangeRate	No documentation available.
DELETE Marketing/RemoveCustomerTypeRewardExchangeRate	Removes an existing CustomerTypeRewardExchangeRate.
POST Marketing/RedemptionExchangeRate	GetRedemptionExchangeRates with same parentID
POST Marketing/RedemptionExchangeRates	Get all the RedemptionExchangeRates
POST Marketing/AddRedemptionExchangeRate	No documentation available.
PUT Marketing/ModifyRedemptionExchangeRate	No documentation available.
DELETE Marketing/RemoveRedemptionExchangeRate	Removes an existing RedemptionExchangeRate.
POST Marketing/AddCustomerTypeRedemptionExchangeRate	No documentation available.
DELETE Marketing/RemoveCustomerTypeRedemptionExchangeRate	Removes an existing CustomerTypeRedemptionExchangeRate.
POST Marketing	No documentation available.

Account

API	Description
GET Account/User	Gets own User info. to be deprecated.
POST Account/User	Get a specific User. (as long as it is not a Customer/SysAdmin role) userId null to get Own User
POST Account/Users	Returns Users of a Store that are not Customer/SysAdmin roles
GET Account/Roles	Gets all admin Roles.
POST Account/AddUserRole	Add Role to a User.
DELETE Account/RemoveUserRole	Removes a UserRole.
POST Account/UserRoles	Gets UserRoles.
POST Account/AddUser	Registers a User for administration purposes.
PUT Account/ModifyUser	Modifies a User for administration purposes.
PUT Account/ModifyUserPassword	No documentation available.
DELETE Account/RemoveUser	Removes a User for administration purposes.
POST Account/ChangePassword	No documentation available.
GET Account/OAuthorize?code={code}&scope={scope}	No documentation available.
POST Account/OAuthorize?code={code}&scope={scope}	No documentation available.

Finance

API	Description
POST Finance/TaxRates	Get all the TaxRates
POST Finance/AddTaxRate	Retrieves an existing TaxRate.
PUT Finance/ModifyTaxRate	Retrieves an existing TaxRate.
DELETE Finance/RemoveTaxRate	Retrieves an existing TaxRate.
POST Finance/DecodeRedsysResponse	Decode Redsys Response for debug operations
POST Finance/RedsysProcessors	Get all the RedsysProcessors
POST Finance/AddRedsysProcessor	Adds a RedsysProcessor.
PUT Finance/ModifyRedsysProcessors	Modifies an existing RedsysProcessor.
DELETE Finance/RemoveRedsysProcessors	Removes an existing RedsysProcessor.
POST Finance/PayPalPaymentsStandardProcessors	Get all the PayPalPaymentsStandardProcessors
POST Finance/AddPayPalProcessor	Adds a PayPalProcessor.
PUT Finance/ModifyPayPalPaymentsStandardProcessors	Modifies an existing PayPalProcessor.
DELETE Finance/RemovePayPalPaymentsStandardProcessors	Removes an existing PayPalProcessor.
POST Finance/PaymentMeans	Get all the PaymentMeans
POST Finance/AddPaymentMean	Adds a PaymentMeans.
PUT Finance/ModifyPaymentMeans	Modifies an existing PaymentMeans.
DELETE Finance/RemovePaymentMeans	Removes an existing PaymentMeans.
POST Finance/AddPaymentMeansBankAccount	Adds a bank account to a payment means
DELETE Finance/RemovePaymentMeansBankAccount	Removes a bank account from a payment means
POST Finance/StoreBankAccounts	Get all the StoreBankAccounts
POST Finance/AddStoreBankAccount	Adds a StoreBankAccount.
PUT Finance/ModifyStoreBankAccount	Modifies an existing StoreBankAccount.
DELETE Finance/RemoveStoreBankAccount	Removes an existing StoreBankAccount.
POST Finance/InvoicePDF	No documentation available.
POST Finance/Invoice	GetInvoice
POST Finance/GetInvoices	Get all the Invoices
POST Finance/InvoiceConfiguration	InvoiceConfigurations where a InvoiceConfiguration
POST Finance/AddInvoiceConfiguration	Creates a reciproque bound between two InvoiceConfigurations.
PUT Finance/ModifyInvoiceConfiguration	Modifies an existing InvoiceConfiguration.
POST Finance/FinanceConfiguration	FinanceConfigurations where a FinanceConfiguration
POST Finance/AddFinanceConfiguration	No documentation available.
PUT Finance/ModifyFinanceConfiguration	Modifies an existing FinanceConfiguration.
POST Finance/AddPaymentMeansCustomerExclusion
POST Finance/ModifyPaymentMeansCustomerExclusion
DELETE Finance/RemovePaymentMeansCustomerExclusion
POST Finance/PaymentMeansCustomerExclusions

Orders

API	Description
POST Orders/OrderPublicStatus	GetOrderPublicStatus
POST Orders/GetOrderPublicStatusList	Get all the OrderPublicStatus
POST Orders/AddOrderPublicStatus	Adds a OrderPublicStatus.
PUT Orders/ModifyOrderPublicStatus	ModifyOrderPublicStatus
DELETE Orders/RemoveOrderPublicStatus	Removes an existing OrderPublicStatus.
POST Orders/Orders	Get Orders
POST Orders/Order	No documentation available.
GET Orders/OrderPDF?OrderID={OrderID}&type={type}	No documentation available.
POST Orders/Annotations	No documentation available.
POST Orders/Items	No documentation available.
POST Orders/OrderBillingContact	No documentation available.
POST Orders/OrderShippingContact	No documentation available.
POST Orders/AddOrder	No documentation available.
PUT Orders/ModifyOrder
PUT Orders/ModifyOrderBillingContact	ModifyOrderBillingContact
POST Orders/AddOrderAnnotation	Only for admin Role
PUT Orders/ModifyOrderAnnotation	Only for admin Role
DELETE Orders/DeleteOrderAnnotation	Only for admin Role
POST Orders/SendOrderAnnotation	SendOrderAnnotation to the Customer
POST Orders/AddOrderItem	Creates a new OrderItem. To modify, use ModifyOrderItem.
PUT Orders/ModifyOrderItem	No documentation available.
DELETE Orders/RemoveOrderItem	No documentation available.
POST Orders/AddOrderItemComponent
DELETE Orders/RemoveOrderItemComponent	No documentation available.
POST Orders/Payment	GetPayments
POST Orders/Payments	Get all the Payments
POST Orders/AddPayment	Adds a Payment.
PUT Orders/ModifyPayment	ModifyPayment
PUT Orders/ModifyPaymentObservations	ModifyPayment
DELETE Orders/RemovePayment	Removes an existing Payment.
POST Orders/OrderRefund	Refunds an Amount for an Order using the original Payment Mean.
POST Orders/OrderConfiguration	OrderConfigurations where a OrderConfiguration
POST Orders/AddOrderConfiguration	Creates a reciproque bound between two OrderConfigurations.
PUT Orders/ModifyOrderConfiguration	Modifies an existing OrderConfiguration.
POST Orders/OrderShipping	GetOrderShippings
POST Orders/OrderShippings	Get all the OrderShippings
POST Orders/AddOrderShipping	Adds a OrderShipping.
PUT Orders/ModifyOrderShipping	ModifyOrderShipping
PUT Orders/ModifyOrderShippingContact	ModifyOrderShippingContact
DELETE Orders/RemoveOrderShipping	Removes an existing OrderShipping.
POST Orders/OrderShippingItem	GetOrderShippingItems
POST Orders/OrderShippingItems	Get all the OrderShippingItems
POST Orders/ValidateOrderCoupon	Validates if a Coupon can be applied to the Order
POST Orders/AddOrderCoupon	Adds a Coupon to the order
DELETE Orders/RemoveOrderCoupon	Removes a Coupon from the order
POST Orders/ShippingPolicies	ShippingPolicies
POST Orders/OrderStatusLogs	OrderStatusLogs from an order
POST Orders/CloneOrder	No documentation available.
GET Orders/DeliveryNotePDF?OrderShippingID={OrderShippingID}&type={type}	No documentation available.
POST Orders	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/AddFeature	Adds a child Feature to a parent It's up to the front to set the Feature sortOrder.
PUT Feature/ModifyFeature	Modifies the Feature It's up to the front to call this method so many times as needed for Feature rearrangement.
DELETE Feature/RemoveFeature	Removes a Feature
POST Feature/FeatureImages	No documentation available.
POST Feature/AddFeatureImageSet	No documentation available.
PUT Feature/ModifyFeatureImage	Modify metadata associated to an image
DELETE Feature/RemoveFeatureImageSet	No documentation available.
POST Feature/FeatureOption	GetFeatureOptions with same parentID
POST Feature/FeatureOptions	No documentation available.
POST Feature/AddFeatureOption	Adds a child FeatureOption to a parent
PUT Feature/ModifyFeatureOption	Modifies the FeatureOption It's up to the front to call this method so many times as needed for FeatureOption rearrangement.
DELETE Feature/RemoveFeatureOption	Removes a FeatureOption
POST Feature/FeatureOptionImages	No documentation available.
POST Feature/AddFeatureOptionImageSet	No documentation available.
PUT Feature/ModifyFeatureOptionImage	Modify metadata associated to an image
DELETE Feature/RemoveFeatureOptionImageSet	No documentation available.

Stats

Statistics. These endpoints do not modify the Data.

API	Description
POST Stats/Stats	Get Statistics for the Dashboard
POST Stats/DashboardPlot	No documentation available.
POST Stats/Customers	Statistics about Customers with Finished Orders inside Period (Amount, #Orders, DaysSinceLastOrder...)
POST Stats/GhostCustomers	Get which Customers, create longer than a month ago, have never placed an Order. DateFrom/DateUntil parameters are ignored.
POST Stats/Products	Statistics about Products
POST Stats/Brands	Statistics about Brands
POST Stats/Providers	Statistics about Providers
POST Stats/Classifications	Statistics about Classifications. Only the top ones (without Parents)
POST Stats/ProductOpenAbandonments	Statistics about Products in abandoned Orders. The cart is consider "Abandoned" whenever it is Open (even if 5 mins ago) or was not Paid before "PaymentDue"
POST Stats/ProductConfirmedAbandonments	No documentation available.
POST Stats/AbandonmentsByMonth	Both Open Orders, and Confirmed Orders with an expired Payment Due Date are considered as Abandoned
POST Stats/OrderPriceHistogram	Statistics about Products
POST Stats/OrderStatusLogs	Histogram of the time passed between Orders' Status change. Without Filters, to speed things up
POST Stats/OrderStatusLogsBin	Returns which Orders are inside the Nth Histogram Bin
POST Stats/ShippingOrderStatusLogs	Histogram of the time passed Shipping Orders' Status change. Without Filters, to speed things up
POST Stats/ShippingOrderStatusLogsBin	Returns which Shipping Orders are inside the Nth Histogram Bin
POST Stats/CustomerAges	Histogram of the time passed Shipping Orders' Status change. Without Filters, to speed things up There are always 20 bins, going from 0 to 100 years
POST Stats/SalesByDayOfTheWeek
POST Stats/SalesHeatmap
POST Stats/Newsletters	No documentation available.
POST Stats/UsedCoupons	No documentation available.
POST Stats/UsedCouponsList	No documentation available.

Tariff

API	Description
POST Tariff/Tariffs	Get all the Tariffs
POST Tariff/AddTariff	Adds a Tariff.
PUT Tariff/ModifyTariff	Modifies an existing Tariff.
DELETE Tariff/RemoveTariff	Removes an existing Tariff.
POST Tariff/VariationPrices	Get all the prices associated to a Variation
POST Tariff/AddVariationPrice	Adds a VariationPrice.
PUT Tariff/ModifyVariationPrice	Modifies an existing VariationPrice.
DELETE Tariff/RemoveVariationPrice	Removes an existing VariationPrice.
POST Tariff/ProductPrices	Get all the Tariffs of a Product
POST Tariff/AddProductPrice	Adds a ProductPrice.
PUT Tariff/ModifyProductPrice	Modifies an existing ProductPrice.
DELETE Tariff/RemoveProductPrice	Removes an existing ProductPrice.
POST Tariff/VariationCosts	VariationCosts where a Variation is bound as a principal or child
POST Tariff/AddVariationCost	Creates a reciproque bound between two Variations.
PUT Tariff/ModifyVariationCost	Modifies an existing VariationCost.
DELETE Tariff/RemoveVariationCost	Removes a VariationCost
POST Tariff/ProductCosts	ProductCosts where a Product is bound as a principal or child
POST Tariff/AddProductCost	Creates a reciproque bound between two Products.
PUT Tariff/ModifyProductCost	Modifies an existing ProductCost.
DELETE Tariff/RemoveProductCost	Removes a ProductCost
POST Tariff/ComponentPrices	Get all the prices associated to a Component
POST Tariff/AddComponentPrice	Adds a ComponentPrice.
PUT Tariff/ModifyComponentPrice	Modifies an existing ComponentPrice.
DELETE Tariff/RemoveComponentPrice	Removes an existing ComponentPrice.
POST Tariff/ComponentProductPrices	Get all the prices associated to a ComponentProduct
POST Tariff/AddComponentProductPrice	Adds a ComponentProductPrice.
PUT Tariff/ModifyComponentProductPrice	Modifies an existing ComponentProductPrice.
DELETE Tariff/RemoveComponentProductPrice	Removes an existing ComponentProductPrice.
POST Tariff/ComponentClassificationPrices	Get all the prices associated to a ComponentClassification
POST Tariff/AddComponentClassificationPrice	Adds a ComponentClassificationPrice.
PUT Tariff/ModifyComponentClassificationPrice	Modifies an existing ComponentClassificationPrice.
DELETE Tariff/RemoveComponentClassificationPrice	Removes an existing ComponentClassificationPrice.

Customers

API	Description
PUT Customers/ModifyUserName	No documentation available.
PUT Customers/ModifyPassword	No documentation available.
POST Customers/CustomerTypes	Retrieves existing CustomerTypes
POST Customers/AddCustomerType	Retrieves an existing CustomerType.
PUT Customers/ModifyCustomerType	Retrieves an existing CustomerType.
DELETE Customers/RemoveCustomerType	Retrieves an existing CustomerType.
POST Customers/Customer	Retrieves a Customer
POST Customers/Customers	Retrieves all existing Customers.
POST Customers/AddCustomer	Registers a Customer and Sends a notification to the Customer
PUT Customers/ModifyCustomer	Registers a Customer.
POST Customers/CustomerContact	Retrieves a CustomerContact
POST Customers/CustomerContacts
POST Customers/CustomerFromCustomerContacts	Retrieves all existing Customer Contacts.
POST Customers/AddCustomerContact	Registers a Customer.
PUT Customers/ModifyCustomerContact	Registers a CustomerContact.
DELETE Customers/RemoveCustomerContact	RmoveS a CustomerContact.
POST Customers/CustomerAnnotation	Retrieves a CustomerAnnotation
POST Customers/CustomerAnnotations
POST Customers/AddCustomerAnnotation	Registers a Customer.
PUT Customers/ModifyCustomerAnnotation	Registers a CustomerAnnotation.
DELETE Customers/RemoveCustomerAnnotation	RmoveS a CustomerAnnotation.
POST Customers/CustomerPoints	Retrieves existing CustomerPoints
POST Customers/AddCustomerPoints	Retrieves an existing CustomerPoints.
PUT Customers/ModifyCustomerPoints	Retrieves an existing CustomerPoints.
DELETE Customers/RemoveCustomerPoints	Retrieves an existing CustomerPoints.
POST Customers/CustomerQueries	Get queries from one customer
POST Customers/CustomersQueries	Get queries from all customers
POST Customers/ProductReviews
POST Customers/FavoriteProducts	FavoriteProducts where a Product is bound as a principal or child
POST Customers/Coupons
POST Customers/Orders

Providers

API	Description
POST Providers/Provider	Retrieves an existing Provider.
POST Providers/AddProvider	Retrieves an existing Provider.
PUT Providers/ModifyProvider	Retrieves an existing Provider.
DELETE Providers/RemoveProvider	Retrieves an existing Provider.
POST Providers/AddProviderContact	Adds a ProviderContact.
PUT Providers/ModifyProviderContact	ModifyProviderContact
DELETE Providers/RemoveProviderContact	Removes an existing ProviderContact.
POST Providers/AddProviderContactPerson	Adds a ProviderContactPerson.
PUT Providers/ModifyProviderContactPerson	ModifyProviderContactPerson
DELETE Providers/RemoveProviderContactPerson	Removes an existing ProviderContactPerson.
POST Providers	Retrieves all existing Providers.

Utilities

API	Description
POST Utilities/ValidateObject	Validates an Object

AI

API	Description
POST ArtificialIntelligence/AIDescription	Makes a prompt to OpenAI API to get a description for an item.
POST ArtificialIntelligence/AskToDatabase	Make questions to your database using natural language.

Business

API	Description
POST Business/Business	Retrieves a Business
POST Business/Businesses	Retrieves all existing Businesses.
POST Business/AddBusiness	Registers a Business and Sends a notification to the Business
PUT Business/ModifyBusiness	Registers a Business.
DELETE Business/RemoveBusiness	RmoveS a Business.
POST Business/BusinessContact	Retrieves a BusinessContact
POST Business/BusinessContacts
POST Business/AddBusinessContact	Registers a Business.
PUT Business/ModifyBusinessContact	Registers a BusinessContact.
DELETE Business/RemoveBusinessContact	RmoveS a BusinessContact.
POST Business/BusinessSlugs	BusinessSlugs
POST Business/BusinessImages	No documentation available.
POST Business/AddBusinessImageSet	No documentation available.
PUT Business/ModifyBusinessImage	Modify metadata associated to an image
DELETE Business/RemoveBusinessImageSet	No documentation available.

Reports

API	Description
POST Reports/OrderItems	No documentation available.
POST Reports/OrderItemsCSV	No documentation available.
POST Reports/SalesAmountByCustomer	No documentation available.
POST Reports/SalesAmountByCustomerCSV	No documentation available.

Catalog

API	Description
POST Catalog/Classification	GetClassifications with same parentID
POST Catalog/Classifications	No documentation available.
POST Catalog/AddClassification	Adds a Classification child to a parent
PUT Catalog/ModifyClassification	Modifies the classification name
DELETE Catalog/RemoveClassification	Removes a classification with no children
POST Catalog/Attribute	GetAttributes with same parentID
POST Catalog/Attributes	No documentation available.
POST Catalog/AddAttribute	Adds a child attribute to a parent It's up to the front to set the attribute sortOrder.
PUT Catalog/ModifyAttribute	Modifies the attribute
PUT Catalog/ModifyAttributeSortOrder	Modifies the attribute sort order
DELETE Catalog/RemoveAttribute	Removes a attribute with no children
POST Catalog/GoogleTaxonomies	Get GoogleTaxonomies
POST Catalog/GUIdentifierTypes	Get all the GUIdentifierTypes
POST Catalog/AttributeImages	No documentation available.
POST Catalog/AddAttributeImageSet	No documentation available.
PUT Catalog/ModifyAttributeImage	Modify metadata associated to an image
DELETE Catalog/RemoveAttributeImageSet	No documentation available.
POST Catalog/ClassificationImages	No documentation available.
POST Catalog/AddClassificationImageSet	No documentation available.
PUT Catalog/ModifyClassificationImage	Modify metadata associated to an image
DELETE Catalog/RemoveClassificationImageSet	No documentation available.
POST Catalog/Product	Get a Product
POST Catalog/Products	Get all the Products
POST Catalog/AddProduct	Only for admin Role
PUT Catalog/ModifyProduct	Only for admin Role
DELETE Catalog/RemoveProduct	Removes an existing Product.
POST Catalog/CloneProduct	No documentation available.
POST Catalog/BoundProducts	BoundProducts where a Product is bound as a principal or child
POST Catalog/BoundTypes	Get all the BoundTypes
POST Catalog/AddBoundProduct	Creates a reciproque bound between two products.
DELETE Catalog/RemoveBoundProduct	Removes a boundProduct
POST Catalog/Brand	No documentation available.
POST Catalog/Brands	No documentation available.
POST Catalog/AddBrand	No documentation available.
PUT Catalog/ModifyBrand	Modifies the Brand It's up to the front to call this method so many times as needed for Brand rearrangement.
DELETE Catalog/RemoveBrand	No documentation available.
POST Catalog/BrandImages	No documentation available.
POST Catalog/AddBrandImageSet	No documentation available.
PUT Catalog/ModifyBrandImage	Modify metadata associated to an image
DELETE Catalog/RemoveBrandImageSet	No documentation available.
POST Catalog/Collection	No documentation available.
POST Catalog/Collections	No documentation available.
POST Catalog/AddCollection	No documentation available.
PUT Catalog/ModifyCollection	Modifies the Collection It's up to the front to call this method so many times as needed for Collection rearrangement.
DELETE Catalog/RemoveCollection	No documentation available.
POST Catalog/ProductSlugs	ProductSlugs
POST Catalog/ClassificationSlugs	ClassificationSlugs
POST Catalog/BrandSlugs	BrandSlugs
POST Catalog/CMSEntitySlugs	CMSEntitySlugs
POST Catalog/Slugs	Gets all slugs for a Store.
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/AddSlug	Adds a slug It can be also used to check if a slug is valid candidate for a Store
PUT Catalog/ModifySlug	No documentation available.
DELETE Catalog/RemoveSlug	Removes a Slug
POST Catalog/ProductClassifications	ProductClassifications where a Product is bound as a principal or child
POST Catalog/ProductsClassifications	Gets a list of ProductsClassifications
PUT Catalog/ModifyProductClassification	Modify the sortOrder of a ProductClassification
POST Catalog/AddProductClassification	Creates a reciproque bound between two products.
DELETE Catalog/RemoveProductClassification	Removes a ProductClassification
POST Catalog/ProductGoogleClassifications	ProductGoogleClassifications where a Product is bound as a principal or child
POST Catalog/AddProductGoogleClassification	Creates a reciproque bound between two products.
PUT Catalog/ModifyProductGoogleClassification	Modifies an existing ProductGoogleClassification.
DELETE Catalog/RemoveProductGoogleClassification	Removes a ProductGoogleClassification
POST Catalog/ProductAttributes	ProductAttributes where a Product is bound as a principal or child
POST Catalog/AddProductAttribute	Creates a reciproque bound between two products.
DELETE Catalog/RemoveProductAttribute	Removes a ProductAttribute
POST Catalog/Variations	Get Variations from a Product
POST Catalog/Variation	Get a Variation
POST Catalog/VariationBySku	Get a Variation by his SKU
POST Catalog/AddVariation	Only for admin Role
PUT Catalog/ModifyVariation	Only for admin Role
DELETE Catalog/RemoveVariation	Removes an existing Variation.
DELETE Catalog/DestroyVariation	Removes an existing variation and all its dependent objects
POST Catalog/VariationAttributes	VariationAttributes where a Variation is bound as a principal or child
POST Catalog/AddVariationAttribute	Creates a reciproque bound between two Variations.
DELETE Catalog/RemoveVariationAttribute	Removes a VariationAttribute
POST Catalog/GVUIdentifiers	GVUIdentifiers where a Variation is bound as a principal or child
POST Catalog/AddGVUIdentifier	Creates a reciproque bound between two Variations.
DELETE Catalog/RemoveGVUIdentifier	Removes a GVUIdentifier
POST Catalog/ProductImages	No documentation available.
POST Catalog/AddProductImageSet	No documentation available.
PUT Catalog/ModifyProductImage	Modify metadata associated to an image
DELETE Catalog/RemoveProductImageSet	No documentation available.
POST Catalog/VariationImages	No documentation available.
POST Catalog/AddVariationImageSet	No documentation available.
PUT Catalog/ModifyVariationImage	Modify metadata associated to an image
DELETE Catalog/RemoveVariationImageSet	No documentation available.
POST Catalog/AddPackProduct	Adds a product to a pack.
PUT Catalog/ModifyPackProduct	Only for admin Role
DELETE Catalog/RemovePackProduct	Removes a packProduct
POST Catalog/Component	GetComponents with same parentID
POST Catalog/Components	No documentation available.
POST Catalog/AddComponent	Adds a Component child to a parent
PUT Catalog/ModifyComponent	Modifies the Component name
DELETE Catalog/RemoveComponent	Removes a Component with no children
POST Catalog/AddComponentProduct	Add a component-product relation
PUT Catalog/ModifyComponentProduct	Modify a component-product relation
DELETE Catalog/RemoveComponentProduct	Removes a ProductClassification
POST Catalog/AddComponentClassification	Add a component-product relation
PUT Catalog/ModifyComponentClassification	Modify a component-product relation
DELETE Catalog/RemoveComponentClassification	Removes a ProductClassification
POST Catalog/ComponentImages	No documentation available.
POST Catalog/AddComponentImageSet	No documentation available.
PUT Catalog/ModifyComponentImage	Modify metadata associated to an image
DELETE Catalog/RemoveComponentImageSet	No documentation available.
POST Catalog/GenerateSitemaps	Creates
POST Catalog/SitemapIndex	No documentation available.
POST Catalog/ProductFeatureValue	GetProductFeatureValues with same parentID
POST Catalog/ProductFeatureValues	No documentation available.
POST Catalog/AddProductFeatureValue	Adds a child ProductFeatureValue to a parent It's up to the front to set the ProductFeatureValue sortOrder.
PUT Catalog/ModifyProductFeatureValue	Modifies the ProductFeatureValue It's up to the front to call this method so many times as needed for ProductFeatureValue rearrangement.
DELETE Catalog/RemoveProductFeatureValue	Removes a ProductFeatureValue
POST Catalog/ProductFeatureValueImages	No documentation available.
POST Catalog/AddProductFeatureValueImageSet	No documentation available.
PUT Catalog/ModifyProductFeatureValueImage	Modify metadata associated to an image
DELETE Catalog/RemoveProductFeatureValueImageSet	No documentation available.
POST Catalog/PublishStoreProductsToGoogle	Publishes all Variations of a Store to Google Content API for Shopping. Used for an "initialization".
POST Catalog/SendCatalogToSearchEngine	Publishes all Products to the internal Search Engine search.shopworld.cloud
POST Catalog/DeleteCatalogInSearchEngine	Deletes all Products in the internal Search Engine search.shopworld.cloud

Communication

API	Description
POST Communications/SmtpClientConfigurations	SmtpClientConfigurations where a SmtpClientConfiguration
POST Communications/SmtpClientConfiguration	SmtpClientConfiguration
POST Communications/AddSmtpClientConfiguration	Creates a reciproque bound between two SmtpClientConfigurations.
PUT Communications/ModifySmtpClientConfiguration	Modifies an existing SmtpClientConfiguration.
POST Communications/NotificationConfiguration	No documentation available.
POST Communications/NotificationConfigurations	No documentation available.
POST Communications/AddNotificationConfiguration	No documentation available.
POST Communications/ModifyNotificationConfiguration	No documentation available.
DELETE Communications/RemoveNotificationConfiguration	No documentation available.

PaymentProcessors

Listener to receive notifications from a PaymentProcessor

API	Description
POST PaymentProcessors/PayPalIPNListener/{id}	Listener for Paypal notifications
POST PaymentProcessors/RedsysNotificationListener/{id}	Listener for Redsys notifications
POST PaymentProcessors/SequraIPNListener	Listener for Sequra notifications
GET PaymentProcessors/AlmaPayIPNListener?pId={pId}	Listener for AlmaPay notifications

Gallery

API	Description
POST Gallery/Gallery	GetGalleries with same parentID
POST Gallery/Galleries	No documentation available.
POST Gallery/AddGallery	Adds a child Gallery to a parent It's up to the front to set the Gallery sortOrder.
PUT Gallery/ModifyGallery	Modifies the Gallery It's up to the front to call this method so many times as needed for Gallery rearrangement.
DELETE Gallery/RemoveGallery	Removes a Gallery
POST Gallery/GalleryImages	No documentation available.
POST Gallery/AddGalleryImageSet	No documentation available.
PUT Gallery/ModifyGalleryImage	Modify metadata associated to an image
DELETE Gallery/RemoveGalleryImageSet	No documentation available.