ShopCtrl API - 3.15.7

Introduction

Provide a general description of your APIs here.

Activities

API	Description
GET v1/Activities/Categories	Returns actvity categories for current (api) user.
GET v1/Activities?fromDate={fromDate}&tillDate={tillDate}&changedSince={changedSince}&shopId={shopId}&pageSize={pageSize}&pageNumber={pageNumber}	Retrieve activity journal entries for current (api) user.
POST v1/Activities	Adds a new journal entry for the current (api) user
PUT v1/Activities/{id}	Updates a journal entry for the current (api) user
DELETE v1/Activities/{id}	Deletes a journal entry of the current (api) user

CarrierAccounts

API	Description
GET v1/ShopOwners/{shopOwnerId}/CarrierAccounts	Get a list with all CarrierAccounts.
GET v1/Shops/{shopId}/CarrierAccounts	Get a list with all available CarrierAccounts for this shop.
GET v1/CarrierAccounts/{carrierAccountId}	Get detailed information about a CarrierAccount.
POST v1/CarrierAccounts	Add a new CarrierAccount.
PUT v1/CarrierAccounts	Update an existing CarrierAccount.
DELETE v1/CarrierAccounts/{id}	Delete a given CarrierAccount.

Countries

API	Description
GET v1/Countries	Get a list with all available Countries.

Cultures

API	Description
GET v1/Cultures	Get a list with all available Cultures.

Currencies

API	Description
GET v1/Currencies	Get a list with all available Currencies.

CustomerContracts

API	Description
GET v1/Shops/{shopId}/CustomerContracts?active={active}&pageSize={pageSize}&pageNumber={pageNumber}	Get a list with all available CustomerContracts, for the given shop.
DELETE v1/CustomerContracts/{customerContractId}	Delete given CustomerContract. Note that this is no 'soft delete'.
GET v1/CustomerContracts/GetByCustomerId?id={id}	Gets the customer's customer contracts by customer id.
GET v1/CustomerContracts/GetByCustomerCode?shopOwnerId={shopOwnerId}&code={code}	Gets the customer's customer contracts by exact match of customer code.
GET v1/CustomerContracts/{id}	Get detailed information about the customer contract.
POST v1/CustomerContracts	Create a new CustomerContract.
PUT v1/CustomerContracts	Update an existing CustomerContract.
GET v1/CustomerContracts/{customerContractId}/Products	Get a list with all CustomerContract products for a given CustomerContract.
POST v1/CustomerContracts/{customerContractId}/Products	Adds the specified CustomerContract product.
PUT v1/CustomerContracts/{customerContractId}/Products	Update an existing CustomerContract product.
DELETE v1/CustomerContracts/{customerContractId}/Products/{customerContractProductId}	Delete given CustomerContract product.
POST v1/CustomerContracts/{id}/Orders?from={from}&till={till}	Generate an order for the given customer contract. If both from and till parameters are null, then it generates an order for the next scheduled period if any. Both from and till parameters must have values or both must be null. If only one is null it will throw an exception.
GET v1/CustomerContracts/{customerContractId}/Parameters	Get all CustomerContract Parameters.
GET v1/CustomerContracts/{customerContractId}/Parameters/{key}	Get a single CustomerContract Parameter.
POST v1/CustomerContracts/{customerContractId}/Parameters	Add an CustomerContract Parameter.
PUT v1/CustomerContracts/{customerContractId}/Parameters	Update an CustomerContract Parameter.
PUT v1/CustomerContracts/{customerContractId}/Parameters/{key}?value={value}	Update an CustomerContract Parameter.
DELETE v1/CustomerContracts/{customerContractId}/Parameters/{key}	Delete a specific CustomerContract Parameter.

Customers

API	Description
GET v1/ShopOwners/{shopOwnerId}/Customers?fromDateChanged={fromDateChanged}&untilDateChanged={untilDateChanged}&pageSize={pageSize}&pageNumber={pageNumber}&isActive={isActive}	Get a list with all Customers for specified Shop owner.
GET v1/ShopOwners/{shopOwnerId}/Customers/Search/{search}?isActive={isActive}	Get a list with all Customers for specified Shopowner and search in following fields: - FullName - CompanyName - EMail address - ContactRef
GET v1/ShopOwners/{shopOwnerId}/Customers/CustomerCode/{customerCode}	Get a list with all Customers for specified Shopowner and specific CustomerCode.
GET v1/Customers?isActive={isActive}	Get a list with all Customers available for the logged in user.
GET v1/Customers/{id}	Get detailed information about a Customer.
POST v1/Customers	Add a new Customer.
PUT v1/Customers	Update an existing Customer.
PUT v1/Customers/{customerId}/ReceiveNewsLetter/{value}	Set true if the Customer likes to receive a newsletter.
DELETE v1/Customers/{id}	Delete given Customer.
DELETE v1/Customers/{id}/Contacts/{contactId}	Delete the company contact.
GET v1/Customers/{id}/Contacts	Get the company contacts.
POST v1/Customers/{id}/Contacts	Add a new company contact.
PUT v1/Customers/{id}/Contacts	Update the company contact.

EMails

API	Description
GET v1/Shops/{shopId}/Emails?fromDate={fromDate}&untilDate={untilDate}&mailboxId={mailboxId}&pageSize={pageSize}&pageNumber={pageNumber}	Get a list with all available EMails, for given shop.
GET v1/EMails/{mailId}	Get detailed information about an EMail.
GET v1/Shops/{shopId}/EMailboxes	Get all EMailboxes which are available.
POST v1/Shops/{shopId}/SendMail?mailTemplateId={mailTemplateId}&orderId={orderId}&orderCode={orderCode}	Sends an email based on an email template. If the selected template contains a recipient, it will be used instead of the order contact.
POST v1/Shops/{shopId}/SendCustomMail	Sends an email based on custom email values.
POST v1/EMails/{mailId}/SendReply?includeOriginalMailthread={includeOriginalMailthread}&mailTemplateId={mailTemplateId}&keepAsDraft={keepAsDraft}	This endpoint can be used to create a reply mail.
GET v1/Shops/{shopId}/EmailTemplates	Gets the email templates of a Shop.
GET v1/ShopOwners/{shopOwnerId}/EmailTemplates	Gets the email templates of a Shop Owner.
GET v1/EmailTemplates	Gets the global email templates.
GET v1/Mail/Rate/{token}/{rating}	Sets the email rating.
GET v1/Mail/ShopCtrl/RN/{token}	Sets the Read Notify for an email
GET v1/MailTemplates/{mailTemplateId}	Get detailed information about an Mail Template.
PUT v1/EMails/{mailId}/MarkHandled	Mark an email as handled.
PUT v1/EMails/{mailId}/UpdateNote?employeeNote={employeeNote}	Update the Employee Note field of an email.
PUT v1/EMails/{mailId}/SetEmployee?employeeId={employeeId}	Assign the Handling Employee of an email.
PUT v1/EMails/{mailId}/AssignToCustomer?customerId={customerId}	Assign a Customer to an email.
PUT v1/EMails/{mailId}/AssignToTicket?ticketId={ticketId}	Assign a Ticket to an email.
PUT v1/EMails/{mailId}/AssignToOrder?orderId={orderId}	Assign an Order to an email.
PUT v1/EMails/{mailId}/AssignCategories	Assign categories to an email.

Employees

API	Description
GET v1/Employees	Get a list with all available Employees for the logged in user.
GET v1/Employees/{employeeId}	Get detailed information about an Employee.
POST v1/Employees	Add a new Employee. Note: setting ShopRoles and EmployeeGroups are not supported by this URI. Please use specific URIs to add/remove ShopRoles and EmployeeGroups.
PUT v1/Employees	Update an existing Employee. Note: setting ShopRoles and EmployeeGroups are not supported by this URI. Please use specific URIs to add/remove ShopRoles and EmployeeGroups.
DELETE v1/Employees/{employeeId}	Delete the given Employee.
GET v1/Employees/{employeeId}/ShopRoles	Get a list with all ShopRoles for a given Employee.
GET v1/ShopRoles/{employeeId}	Get a list with all available ShopRoles for a given Employee.
POST v1/Employees/{employeeId}/ShopRoles/{shopId}/{shopRoleId}	Adds the ShopRole specified by id.
POST v1/Employees/{employeeId}/ShopRoles/{shopId}/{shopRoleName}	Adds the ShopRole specified by name.
DELETE v1/Employees/{employeeId}/ShopRoles/{shopId}/{shopRoleId}	Deletes the ShopRole specified by id.
DELETE v1/Employees/{employeeId}/ShopRoles/{shopId}/{shopRoleName}	Deletes the ShopRole specified by name.
GET v1/Employees/{employeeId}/EmployeeGroups	Get a list with all EmployeeGroups for a given Employee.
GET v1/EmployeeGroups/{employeeId}	Get a list with all available EmployeeGroups for a given Employee.
POST v1/Employees/{employeeId}/EmployeeGroups/{employeeGroupId}	Adds the EmployeeGroup specified by id.
POST v1/Employees/{employeeId}/EmployeeGroups/{employeeGroupName}	Adds the EmployeeGroup specified name.
DELETE v1/Employees/{employeeId}/EmployeeGroups/{employeeGroupId}	Deletes the EmployeeGroup specified by id.
DELETE v1/Employees/{employeeId}/EmployeeGroups/{employeeGroupName}	Deletes the EmployeeGroup specified by name.

ExchangeRates

API	Description
GET v1/ExchangeRates	Get a list with all available Exchange Rates.

Files

API	Description
GET v1/Files/{fileId}	Get a specified File object.
GET v1/Files/{fileId}/MetaData	Get a specified File object.
GET v1/Files/{fileId}/Stream	No documentation available.
POST v1/Files	Create a new file for ShopOwner (and optionally Shop)

Invoices

API	Description
GET v1/Shops/{shopId}/Invoices?fromDateChanged={fromDateChanged}&untilDateChanged={untilDateChanged}&mainStatusId={mainStatusId}&mainStatusBaseStatusId={mainStatusBaseStatusId}&fromDateDeleted={fromDateDeleted}&untilDateDeleted={untilDateDeleted}&pageSize={pageSize}&pageNumber={pageNumber}	Get a list with all available Invoices, for the given shop.
GET v1/Invoices/{invoiceId}?includeDeleted={includeDeleted}	Get detailed information about an Invoice.
GET v1/Shops/{shopId}/Invoices/{invoiceCode}	Get detailed information about an Invoice.
GET v1/Shops/{shopId}/Invoices/{invoiceCode}/InvoiceId	Get the ShopCtrl Invoice id based on the invoiceCode.
PUT v1/Invoices/{invoiceId}/MainStatus/{statusId}	No documentation available.
PUT v1/Invoices/{invoiceId}/SentStatus/{statusId}	No documentation available.
PUT v1/Invoices/{invoiceId}/CustomStatus/{statusId}	No documentation available.
PUT v1/Invoices/{invoiceId}/PaymentTerms/{paymentTermId}	No documentation available.
PUT v1/Invoices/{invoiceId}/PaymentType/{paymentTypeId}	No documentation available.
GET v1/Invoices/{invoiceId}/Rows	Get a list with all Invoice rows for a given Invoice.
GET v1/Invoices/{invoiceId}/MissingRows	Get a list of OrderRows that have not been invoiced yet.
POST v1/Invoices/{invoiceId}/AddRows	Add OrderRows to the Invoice based on the OrderRow identifiers.
POST v1/Invoices/{invoiceId}/RemoveRows	No documentation available.

InvoiceStatuses

API	Description
GET v1/BaseInvoiceStatuses	Get a list with the base invoice statuses.
GET v1/InvoiceStatusTypes	Get a list with the Invoice Status types.
GET v1/Shops/{shopId}/InvoiceStatuses	Get a list with all available Invoice Statuses, for given shop.
GET v1/ShopOwners/{shopOwnerId}/InvoiceStatuses	Get a list with all available Invoice Statuses, for given shop owner.
GET v1/InvoiceStatuses/{id}	Get detailed information about a OrderStatus.

MessageConversations

API	Description
GET v1/Shops/{shopId}/MessageConversations?pageSize={pageSize}&pageNumber={pageNumber}	Get a list with all available MessageConversations for the given ShopId.
GET v1/Shops/{shopId}/MessageConversations/{messageConversationId}	Get detailed information about a MessageConversation.
POST v1/Shops/{shopId}/MessageConversations	Creates a new MessageConversation.
PUT v1/Shops/{shopId}/MessageConversations/{messageConversationId}	Updates an MessageConversation

Messages

API	Description
GET v1/Shops/{shopId}/MessageConversations/{messageConversationId}/Messages?pageSize={pageSize}&pageNumber={pageNumber}	Get a list with all available Messages for the given ShopId and MessageConversationId.
GET v1/Shops/{shopId}/MessageConversations/{messageConversationId}/Messages/{messageId}	Get detailed information about a Message.
POST v1/Shops/{shopId}/MessageConversations/{messageConversationId}/Messages	Creates a new Message.
PUT v1/Shops/{shopId}/MessageConversations/{messageConversationId}/Messages/{messageId}	Updates a Message

Offers

API	Description
GET v1/Shops/{shopId}/Offers?fromDateChanged={fromDateChanged}&untilDateChanged={untilDateChanged}&mainStatusId={mainStatusId}&mainStatusBaseStatusId={mainStatusBaseStatusId}&emailAddress={emailAddress}&pageSize={pageSize}&pageNumber={pageNumber}	Get a list with all available Offers, for the given shop.
POST v1/Shops/{shopId}/Offers	Add a new Offer.
PUT v1/Offers	Update an existing Offer.
DELETE v1/Offers/{offerId}	Delete given Offer.
GET v1/Offers/{offerId}	Get detailed information about an Offer.
GET v1/Shops/{shopId}/Offers/{offerCode}	Get detailed information about an Offer.
GET v1/Shops/{shopId}/Offers/{offerCode}/offerId	Get the ShopCtrl Offer Id based on the offerCode.
GET v1/Offers/{offerId}/Rows	Get a list with all Offer rows for a given Offer.
POST v1/Offers/{offerId}/Rows	Adds the specified Offer row.
PUT v1/Offers/{offerId}/Rows	Update an existing Offer row.
DELETE v1/Offers/{offerId}/Rows/{offerRowId}	Delete given Offer row.
PUT v1/Offers/{offerId}/CarrierAccount/{carrierAccountId}	Update the Offer Carrier Account.
GET v1/Shops/{shopId}/OffersExists?offerCodes={offerCodes}	No documentation available.

Orders

API	Description
GET v1/Shops/{shopId}/Orders?fromDateChanged={fromDateChanged}&untilDateChanged={untilDateChanged}&mainStatusId={mainStatusId}&mainStatusBaseStatusId={mainStatusBaseStatusId}&emailAddress={emailAddress}&fromDateDeleted={fromDateDeleted}&untilDateDeleted={untilDateDeleted}&pageSize={pageSize}&pageNumber={pageNumber}	Get a list with all available Orders, for given shop.
POST v1/Shops/{shopId}/Orders	Add a new Order.
PUT v1/Orders	Update an existing Order.
DELETE v1/Orders/{orderId}	Delete given Order.
GET v1/Orders/{orderId}?includeDeleted={includeDeleted}	Get detailed information about an Order.
GET v1/DetailedOrders/{orderId}?includeDeleted={includeDeleted}	Get very detailed information about an Order.
GET v1/Shops/{shopId}/Orders/{orderCode}	Get detailed information about an Order.
GET v1/Shops/{shopId}/Orders/{orderCode}/OrderId	Get the ShopCtrl Order Id based on the OrderCode.
GET v1/Shops/{shopId}/OrdersByExternalOrderKey/{externalOrderKey}	Get detailed information about an Order.
GET v1/Orders/{orderId}/Parameters	Get all Order Parameters.
GET v1/Orders/{orderId}/Parameters/{key}	Get a single Order Parameter.
POST v1/Orders/{orderId}/Parameters	Add an Order Parameter.
PUT v1/Orders/{orderId}/Parameters	Update an Order Parameter.
PUT v1/Orders/{orderId}/Parameters/{key}?value={value}	Update an Order Parameter.
DELETE v1/Orders/{orderId}/Parameters/{key}	Delete a specific Order Parameter.
GET v1/Orders/{orderId}/Rows	Get a list with all order rows for a given order.
POST v1/Orders/{orderId}/Rows	Adds the specified order row.
PUT v1/Orders/{orderId}/Rows	Update an existing order row.
DELETE v1/Orders/{orderId}/Rows/{orderRowId}	Delete given order row.
GET v1/Orders/{orderId}/ShippableOrderRows	Returns orderrows that are ready for fulfilment, but were not yet assigned to an shipment.
GET v1/Orders/{orderId}/ProductRegistrations	Get the ProductRegistration entries registered to an order.
GET v1/Orders/{orderId}/Rows/{orderRowId}/ProductRegistrations	Get all ProductRegistrations registered to an orderrow.
POST v1/Orders/{orderId}/Rows/{orderRowId}/ProductRegistrations	Add a new ProductRegistration.
PUT v1/Orders/{orderId}/Rows/{orderRowId}/ProductRegistrations	Updates a ProductRegistration.
DELETE v1/Orders/{orderId}/Rows/{orderRowId}/ProductRegistrations/{productRegistrationId}	Delete a given ProductRegistration.
GET v1/Orders/{orderId}/OrderComments	Get a list with all order comments of a given order.
POST v1/Orders/{orderId}/OrderComments	Adds the specified order comment.
PUT v1/Orders/{orderId}/OrderComments	Updates the specified order comment.
DELETE v1/Orders/{orderId}/OrderComments/{orderCommentId}	Delete the given OrderComment.
GET v1/Orders/{orderId}/Payments	Get a list with all payments for a given order.
POST v1/Orders/{orderId}/Payments	Adds the specified payment.
PUT v1/Orders/{orderId}/Payments	Update an existing Payment.
PUT v1/Orders/{orderId}/MainStatus/{statusId}	Update the Main Order status.
PUT v1/Orders/{orderId}/MainStatus	Update the Main Order status.
PUT v1/Orders/{orderId}/FulfilmentStatus/{statusId}	Update the Fulfillment Order status.
PUT v1/Orders/{orderId}/FulfilmentStatus	Update the Fulfilment Order status.
PUT v1/Orders/{orderId}/ShipmentStatus/{statusId}	Update the Shipment Order status.
PUT v1/Orders/{orderId}/ShipmentStatus	Update the Shipment Order status.
PUT v1/Orders/{orderId}/StockStatus/{statusId}	Update the Stock Order status.
PUT v1/Orders/{orderId}/StockStatus	Update the Stock Order status.
PUT v1/Orders/{orderId}/PaymentStatus/{statusId}	Update the Payment Order status.
PUT v1/Orders/{orderId}/PaymentStatus	Update the Payment Order status.
PUT v1/Orders/{orderId}/CustomStatus/{statusId}	Update the Custom Order status.
PUT v1/Orders/{orderId}/CustomStatus	Update the Custom Order status.
PUT v1/Orders/{orderId}/CustomerRating/{rating}	Update the Customer Rating value of an Order.
PUT v1/Orders/{orderId}/Allocate	No documentation available.
PUT v1/Orders/{orderId}/Deallocate	No documentation available.
GET v1/Orders/{orderId}/Parcels	Get a list with all Parcel for a given order.
POST v1/Orders/{orderId}/Parcels	Adds the specified Parcel.
PUT v1/Orders/{orderId}/Parcels	Update an existing Parcel.
GET v1/Orders/{orderId}/Shipments	Get a list with all Shipments for a given order.
POST v1/Orders/{orderId}/Shipments	Creates a new shipment for an order.
GET v1/Orders/{orderId}/Returns	Get a list with all Returns for a given order.
GET v1/Orders/{orderId}/Invoices	Get a list with all Invoices for a given order.
POST v1/Orders/{orderId}/Invoices	Auto create an Invoice for given order. An Invoice will be created for all order rows which are not invoiced yet. When there are no order rows to invoice, null will be returned.
PUT v1/Orders/{orderId}/CarrierAccount/{carrierAccountID}	Update the Order Carrier Account.
GET v1/OrderRows/{orderRowId}/Parameters	Get all Order Row Parameters.
GET v1/Shops/{shopId}/Orders/{orderCode}/{orderRowKey}/Parameters	Get all Order Row Parameters.
GET v1/OrderRows/{orderRowId}/Parameters/{key}	Get a single Order Row Parameter.
GET v1/Shops/{shopId}/Orders/{orderCode}/{orderRowKey}/Parameters/{key}	Get a single Order Row Parameter.
POST v1/OrderRows/{orderRowId}/Parameters	Add an Order Row Parameter.
POST v1/Shops/{shopId}/Orders/{orderCode}/{orderRowKey}/Parameters	Add an Order Row Parameter.
PUT v1/OrderRows/{orderRowId}/Parameters	Update an Order Row Parameter.
PUT v1/OrderRows/{orderRowId}/Parameters/{key}?value={value}	Update an Order Row Parameter.
PUT v1/Shops/{shopId}/Orders/{orderCode}/{orderRowKey}/Parameters	Update an Order Row Parameter.
PUT v1/Shops/{shopId}/Orders/{orderCode}/{orderRowKey}/Parameters/{key}?value={value}	Update an Order Row Parameter.
DELETE v1/OrderRows/{orderRowId}/Parameters/{key}	Delete a specific Order Row Parameter.
DELETE v1/Shops/{shopId}/Orders/{orderCode}/{orderRowKey}/Parameters/{key}	Delete a specific Order Row Parameter.
GET v1/Orders/{orderId}/Files	Gets Order files.
POST v1/Orders/{orderId}/Files	Adds the file. The action expects the file as binary data in the request body. The action requires the "filename" header to be defined, with the correct file extension. The action sets up the "FileID" response header.
DELETE v1/Orders/{orderId}/Files/{fileId}	Deletes the Order file.
GET v1/Orders/{orderId}/StockItems	Returns a list of StockItems for the given OrderID
PUT v1/Orders/{orderId}/StockItems	Update advanced properties of StockItem (LotNumber, ExpiryDate, SerialNumber) assigned to an OrderRow
GET v1/Shops/{shopId}/OrdersExists?orderCodes={orderCodes}	No documentation available.

OrderStatuses

API	Description
GET v1/BaseOrderStatuses	Get a list with the base order statuses.
GET v1/OrderStatusTypes	Get a list with the Order Status types.
GET v1/Shops/{shopId}/OrderStatuses	Get a list with all available Orders Statuses, for given shop.
GET v1/ShopOwners/{shopOwnerId}/OrderStatuses	Get a list with all available Order Statuses, for given shop owner.
GET v1/OrderStatuses/{id}	Get detailed information about a OrderStatus.
POST v1/OrderStatuses	Add a new OrderStatus.
PUT v1/OrderStatuses	Update an existing OrderStatus.
DELETE v1/OrderStatuses/{id}	Delete a given OrderStatus.

Parcels

API	Description
GET v1/Shops/{shopId}/Parcels?fromDateChanged={fromDateChanged}&untilDateChanged={untilDateChanged}&parcelStatusId={parcelStatusId}&carrierAccountId={carrierAccountId}&pageSize={pageSize}&pageNumber={pageNumber}	Get a list with available Parcels, for given shop.
GET v1/Parcels/{parcelId}?forceUpdateDeliveryStatus={forceUpdateDeliveryStatus}	Get detailed information about a Parcel.
GET v1/Shops/{shopId}/Parcels/{trackingCode}?forceUpdateDeliveryStatus={forceUpdateDeliveryStatus}	Get detailed information about a Parcel, based on the unique tracking code.
POST v1/Parcels	Add a new Parcel with tracking info.
DELETE v1/Parcels/{parcelId}	Delete given Parcel.
PUT v1/Parcels/{parcelId}	Update parcel
PUT v1/Parcels/{parcelId}/Status/{statusId}	Update status of parcel
GET v1/Parcels/{trackingCode}/ProductInfo	Return available product and invoice info for given trackingcode.
POST v1/Parcels/{parcelId}/ShippingLabelFile	Upload the Shipping Label (The file must be a PDF)
GET v1/Parcels/{parcelId}/ShippingLabelFile	Download the Shipping Label
GET v1/Parcels/{parcelId}/CarrierParameters	Get all Parcel's Carrier Parameters.
POST v1/Parcels/{parcelId}/CarrierParameters/{key}	Adds or updates the specified Parcel's Carrier Parameter.
GET v1/Shops/{shopId}/ParcelsExists?parcelCodes={parcelCodes}	No documentation available.

Payments

API	Description
GET v1/Shops/{shopId}/PaymentTypes	Get a list with all available PaymentTypes for given shop.
GET v1/Shops/{shopId}/PaymentTerms	Get a list with all available PaymentTerms for given shop.
DELETE v1/Payments/{paymentId}	Delete given Payment.

Ppg1pWarehouseAppModule

API	Description
POST v1/Ppg1pWarehouses/{warehouseId}/Shops/{shopId}/PickOrder	Creates sync request to pick the order with the provided products.
POST v1/Ppg1pWarehouses/{warehouseId}/Shops/{shopId}/PackOrder	Creates sync request to pack the order with the provided order codes, pallets, cartons and products.

ProductGroups

API	Description
GET v1/ShopGroups/{shopGroupId}/ProductGroups	Get a list with all available Product groups, for given shop group.
GET v1/ShopGroups/{shopGroupId}/RootProductGroups	Get a list with all Root Product groups, for given shop group.
GET v1/ProductGroups/{productGroupId}/Childs	Get a list with all Childs Product groups, for given Product Group.
GET v1/ProductGroups/{productGroupId}	Get detailed information about a Product group.
POST v1/ProductGroups	Add a new Product group.
PUT v1/ProductGroups	Update an existing Product group.
DELETE v1/ProductGroups/{productGroupId}	Delete given Product group. The children of the Product group will also be deleted.
GET v1/ProductGroups/{productGroupId}/Image	Get the Product group image.
DELETE v1/ProductGroups/{productGroupId}/Image	Delete the Product group image.
POST v1/ProductGroups/{productGroupId}/Image	Post a new image for given Product group.
GET v1/ProductGroups/{productGroupId}/Products?pageSize={pageSize}&pageNumber={pageNumber}	Get a list with all Products in given ProductGroup.

Products

API	Description
GET v1/ShopGroup/{shopGroupId}/Products?changedAfter={changedAfter}&search={search}&published={published}&isLocked={isLocked}&includeQuantities={includeQuantities}&pageSize={pageSize}&pageNumber={pageNumber}	Get a list with all available Products, for given shop group.
GET v1/ShopGroup/{shopGroupId}/Products/{productCode}	Get detailed information about a product, based on the unique ProductCode (SKU).
GET v1/Products/{productId}	Get detailed information about a product.
POST v1/Products	Add a new Product.
PUT v1/Products	Update an existing Product.
POST v1/Products/ReplaceableParts/ServiceProducts	Retrieves a list of ServiceProducts where the ReplaceablePart are based on the given ProductIDs
POST v1/Products/ServiceProducts	Retrieves the ServiceProducts for the provided ProductIDs
GET v1/Products/{id}/ProductGroups	Get all ProductGroups Assinged to the Product
POST v1/Products/{id}/ProductGroups/{productGroupId}	Adds or updates a ProductGroup to given Product.
DELETE v1/Products/{id}/ProductGroups/{productGroupId}	Removes a ProductGroup from given Product.
DELETE v1/Products/{productId}	Delete given Product.
POST v1/Products/{productId}/Lock	No documentation available.
POST v1/Products/{productId}/Unlock	No documentation available.
POST v1/Products/{productId}/ConvertToGroupedProduct	Converts a product to a GroupedProduct. Currently, we only have a bare minimum implementation where we only calculate stock for a grouped product based on available quantities of underlying (ProductRelation contains) products
GET v1/Shops/{shopId}/Products/{code}	Get product projection for a shop. This is a simplified shop view of a product. Most important changes compared to Full product view: <list type="bullet"><item>Product Properties are already translated for the shop (Caption and Value)</item><item>Published is True when both Product.Punlished and ProductSelectionProduct.Active are True</item><item>Product Stock quantities are already filtered based on warehouses for shop</item><item>Prices are copied from ProductSelectionProduct</item></list>
GET v1/Shops/{shopId}/Products/{productId}	Get product projection for a shop. This is a simplified shop view of a product. Most important changes compared to Full product view: <list type="bullet"><item>Product Properties are already translated for the shop (Caption and Value)</item><item>Published is True when both Product.Punlished and ProductSelectionProduct.Active are True</item><item>Product Stock quantities are already filtered based on warehouses for shop</item><item>Prices are copied from ProductSelectionProduct</item></list>
GET v1/Shops/{shopId}/ProductsByCode/{code}	Get product projection for a shop. This is a simplified shop view of a product. Most important changes compared to Full product view: <list type="bullet"><item>Product Properties are already translated for the shop (Caption and Value)</item><item>Published is True when both Product.Punlished and ProductSelectionProduct.Active are True</item><item>Product Stock quantities are already filtered based on warehouses for shop</item><item>Prices are copied from ProductSelectionProduct</item></list>
GET v1/ShopGroups/{shopGroupId}/ShopProduct/{productId}	No documentation available.
GET v1/ShopGroups/{shopGroupId}/ShopProduct/{code}	No documentation available.
GET v1/ShopGroups/{shopGroupId}/ShopProductByCode/{code}	No documentation available.
GET v1/Warehouse/{warehouseId}/GetExpectedBackInStock	Get a list with all products currently not available in the warehouse, and try to determine the expected back in stock date based on Purchase Orders. Also current backorders will be taken into account (will be allocated first). If there are no PurchaseOrders for the product, the product will not be returned.
GET v1/Products/{productId}/StockPerLocation	Get a list with all available stock per WarehouseLocation.
GET v1/ShopOwners/{shopOwnerId}/ProductPropertyDefinitions	Get all Product Property definitions.
GET v1/ShopOwners/{shopOwnerId}/ProductPropertyDefinitions/{productPropertyDefId}	No documentation available.
GET v1/Products/{productId}/Properties	Get all Product Properties.
GET v1/Products/{productId}/ProductSelectionProducts	Get all Product Selection Products.
PUT v1/Products/{productId}/Properties	Update a Product Property.
POST v1/Products/{productId}/Properties/{code}	Add or update the Product Property implicitly creating a Product Property Definition if not found by the specified code.
POST v1/Products/{productId}/Properties	Add a Product Property.
DELETE v1/Products/{productId}/Properties	Delete a specific Product Property.
GET v1/Products/{productId}/Suppliers	Get a list with all Suppliers who supply given product.
GET v1/Products/{productId}/Suppliers/{productSupplierId}	Get detailed information about the ProductSupplier.
POST v1/Products/{id}/Suppliers	Adds or updates ProductSupplier
DELETE v1/Products/{productId}/Suppliers/{productSupplierId}	Removes given ProductSupplier.
GET v1/PurchaseProduct/{purchaseProductId}	Get detailed information about a PurchaseProduct.
PUT v1/PurchaseProduct	Update an existing PurchaseProduct.
DELETE v1/PurchaseProduct/{purchaseProductId}	Remove given PurchaseProduct.
GET v1/ShopGroup/{shopGroupId}/ProductBrands	Get a list with all available Product Brands, for given shop group.
GET v1/Shopgroups/{shopGroupId}/ProductsExists?productCodes={productCodes}	No documentation available.
POST v1/Products/{productId}/Image	Upload the Product image
GET v1/Products/{productId}/Resources	Get detailed information about the Product's Resources.
GET v1/Products/{productId}/Resources/{productResourceId}	Get detailed information about the Product's Resource
DELETE v1/Products/{productId}/Resources/{productResourceId}	Delete the specified Product's Resource
PUT v1/Products/{productId}/Resources/{productResourceId}/Upload	Update the file of the specified Product's Resource. The action requires the "filename" header to be defined, with the correct file extension.
POST v1/Products/{productId}/Resources/Upload	Create a Product's Resource with the file. The action requires the "filename" header to be defined, with the correct file extension.
GET v1/Products/{productId}/Resources/{productResourceId}/Download	Downloads the specified Product's Resource file
POST v1/Products/{productId}/Resources/Link	Add the Product Resource Link
PUT v1/Products/{productId}/Resources/{productResourceId}/MetaData	Add the Product Resource's meta data. The meta data CultureId parameter is required - if not set, the Resource's CultureId will be set to null. All other parameters are optional and are applied only if set in a request.
POST v1/Products/{productId}/Resources/SharedFile?fileId={fileId}	Add a shared file as Product Resource
GET v1/Products/{productId}/Packages	Gets a list with all Product Packanges.
GET v1/Products/{productId}/Packages/{productPackageId}	Get detailed information about the Product Package.
POST v1/Products/{id}/Packages	Adds or updates ProductPackage
DELETE v1/Products/{productId}/Packages/{productPackageId}	Removes given ProductPackage.
GET v1/Products/{productId}/AveragePriceExVat	Get average price (ex VAT).

ProductSelections

API	Description
GET v1/Shops/{shopId}/ProductSelections	Get a list with all available Product selections for given shop.
GET v1/Shops/{shopId}/DefaultProductSelection	Get the default Product selection for given shop
GET v1/ProductSelections/{productSelectionId}/ProductSelectionProducts	Get a list with all Products in given Product selection.
GET v1/Shops/{shopId}/ActiveProductSelectionProducts?onlyPublishedProducts={onlyPublishedProducts}	Get a list with all Products which are available for given Shop.
GET v1/Shops/{shopId}/GetProductSelectionProductsForShopWithSupplierInfo?onlyPublishedProducts={onlyPublishedProducts}	Get a list with all Products which are available for given Shop. This info is extended with the Supplier info.
GET v1/ProductSelectionProducts/{id}	Get detailed information about a Product in the ProductSelection.
POST v1/ProductSelections/{productSelectionId}/ProductSelectionProducts	Add a new Product to the Product selection.
PUT v1/ProductSelectionProducts	Update an existing Product from a Product selection.
DELETE v1/ProductSelectionProducts/{id}	Remove given Product from the Product selection.

Purchasing

API	Description
GET v1/ShopOwners/{shopOwnerId}/PurchaseOrders?fromDateChanged={fromDateChanged}&untilDateChanged={untilDateChanged}&mainStatusId={mainStatusId}&mainStatusBaseStatusId={mainStatusBaseStatusId}&warehouseId={warehouseId}&isHandover={isHandover}&fromDateDeleted={fromDateDeleted}&untilDateDeleted={untilDateDeleted}&pageSize={pageSize}&pageNumber={pageNumber}	Get a list with all available PurchaseOrders, for given shop owner.
GET v1/ShopOwners/{shopOwnerId}/GetPurchaseOrders?purchaseOrderIds={purchaseOrderIds}&includeDeleted={includeDeleted}	Returns a list of purchase orders, based on their ID, for the given shop owner.
POST v1/ShopOwners/{shopOwnerId}/PurchaseOrders	Add a new Purchase Order.
PUT v1/PurchaseOrders	Update an existing Purchase Order.
DELETE v1/PurchaseOrders/{purchaseOrder}?purchaseOrderId={purchaseOrderId}	Delete given Purchase Order.
GET v1/PurchaseOrders/{purchaseOrderId}?includeDeleted={includeDeleted}	Get detailed information about a Purchase Order.
GET v1/ShopOwners/{shopOwnerId}/PurchaseOrders/{purchaseOrderCode}	Get detailed information about a Purchase Order.
POST v1/PurchaseOrders/{purchaseOrderId}/Provision	Provision the PurchaseOrder
POST v1/PurchaseOrders/{purchaseOrderId}/AdvancedProvision	Provision the PurchaseOrder with Advanced StockItems
POST v1/PurchaseOrders/{purchaseOrderId}/Deliveries/{deliveryId}/Provision	Provision the PurchaseOrder's Delivery
POST v1/PurchaseOrders/{purchaseOrderId}/Deliveries/{deliveryId}/AdvancedProvision	Provision the PurchaseOrder's Delivery with Advanced StockItems
GET v1/PurchaseOrders/{purchaseOrderId}/Rows	Get a list with all order rows for a given order.
POST v1/PurchaseOrders/{purchaseOrderId}/Rows	Adds the specified order row.
PUT v1/PurchaseOrders/{purchaseOrderId}/Rows	Update an existing order row.
DELETE v1/PurchaseOrders/{purchaseOrderId}/Rows/{purchaseOrderRowId}	Delete given order row.
PUT v1/PurchaseOrders/{purchaseOrderId}/SetHandOver?timestamp={timestamp}	Mark the PurchaseOrder as Handed over to external fulfilment party.
PUT v1/PurchaseOrders/{purchaseOrderId}/SetReceived?timestamp={timestamp}	Mark the PurchaseOrder as Received (DateReceived is set) by external fulfilment party.
PUT v1/PurchaseOrders/{purchaseOrderId}/MainStatus/{statusId}	Update the Main purchase order status.
PUT v1/PurchaseOrders/{purchaseOrderId}/SubmitStatus/{statusId}	Update the Submit purchase order status.
PUT v1/PurchaseOrders/{purchaseOrderId}/ProvisionStatus/{statusId}	Update the Provision purchase order status.
PUT v1/PurchaseOrders/{purchaseOrderId}/CustomStatus/{statusId}	Update the Custom purchase order status.
GET v1/ShopOwners/{shopOwnerId}/PurchaseOrderStatuses	Get a list with all available PurchaseOrders Statuses, for given shop owner.
GET v1/BasePurchaseOrderStatuses	Get a list with the base order statuses.
GET v1/PurchaseOrderStatusTypes	Get a list with the Purchase Order Status types.
GET v1/PurchaseOrders/{purchaseOrderId}/TrackingInfo	Get a list with all tracking info for a given PurchaseOrder.
GET v1/PurchaseOrders/{purchaseOrderId}/TrackingInfo/{trackingInfoId}	Get the specified Tracking Info.
POST v1/PurchaseOrders/{purchaseOrderId}/TrackingInfo	Adds the specified tracking info.
PUT v1/PurchaseOrders/{purchaseOrderId}/TrackingInfo	Update an existing tracking info.
DELETE v1/PurchaseOrders/{purchaseOrderId}/TrackingInfo/{trackingInfoId}	Delete the given tracking info.

Reports

API	Description
GET v1/Reports	Get a list with all available reports.
POST v1/Reports/{reportId}	Retrieve a generated report for the specified reportId and parameters

Returns

API	Description
GET v1/Shops/{shopId}/Returns?orderId={orderId}&code={code}&fromDateCreated={fromDateCreated}&untilDateCreated={untilDateCreated}&fromDateChanged={fromDateChanged}&untilDateChanged={untilDateChanged}&mainStatusId={mainStatusId}&pageSize={pageSize}&pageNumber={pageNumber}	Get a list with all available Returns, for given shop.
GET v1/Returns/{id}	Get detailed information about a Return.
POST v1/Returns	Add a new OrderReturn.
PUT v1/Returns	Update an existing OrderReturn.
POST v1/Returns/{id}/RegisterOrderRows	Register new return rows based on sales order rows.
POST v1/Returns/{id}/Rows/{rowId}/Refund	Set action to refund for return row
POST v1/Returns/{id}/Rows/{rowId}/Exchange	Set action to exchange for return row
POST v1/Returns/{id}/Rows/{rowId}/Repair	Set action to repair for return row
POST v1/Returns/{id}/Rows/{rowId}/Resend	Set action to resend for return row
DELETE v1/Returns/{id}	Delete the given OrderReturn.
PUT v1/Returns/{id}/SetReceived?timestamp={timestamp}	Sets received timestamp on OrderReturn
PUT v1/Returns/{id}/SetFollowUp?timestamp={timestamp}	Sets follow up timestamp on OrderReturn
PUT v1/Returns/{id}/SetClosed?timestamp={timestamp}	Sets closed timestamp on OrderReturn
PUT v1/Returns/{id}/Finalize?createCreditInvoice={createCreditInvoice}&createPaymentForRefund={createPaymentForRefund}	Finalize the OrderReturn
GET v1/Returns/{id}/Rows	Get a list with all OrderReturnRows for a given OrderReturn.
POST v1/Returns/{id}/Rows	Adds the specified OrderReturnRow.
PUT v1/Returns/{id}/Rows	Update an existing OrderReturnRow.
DELETE v1/Returns/{id}/Rows/{orderReturnRowId}	Delete given OrderReturnRow

ServiceContracts

API	Description
GET v1/ServiceContract/GetByCustomerId?id={id}	Gets the customer's service contracts by customer id.
GET v1/ServiceContract/GetByCustomerCode?shopOwnerId={shopOwnerId}&code={code}	Gets the customer's service contracts by exact match of customer code.
GET v1/ServiceContract/GetByCustomerEmail?shopOwnerId={shopOwnerId}&email={email}&onlyActiveContracts={onlyActiveContracts}	Gets the customer's service contracts by exact match of email. It uses the customer's main email only, not the customer's company contacts.
GET v1/ServiceContract/{id}	Get detailed information about the service contract.
POST v1/ServiceContract	Create a new ServiceContract.
PUT v1/ServiceContract	Update an existing ServiceContract.
DELETE v1/ServiceContract/{serviceContractId}/DeliveryAddress	No documentation available.
GET v1/ServiceContract/ServiceDatesInPeriod?shopOwnerId={shopOwnerId}&from={from}&till={till}	Gets a list of all planned service dates in a period.
PUT v1/ServiceContract/Appointment	Update the existing service appointment.
GET v1/ServiceContract/AvailableLoanProductsInPeriodPerDay?shopOwnerId={shopOwnerId}&from={from}&till={till}&reservationDaysMarginBefore={reservationDaysMarginBefore}&reservationDaysMarginAfter={reservationDaysMarginAfter}	This endpoint will return the available LoanProducts for each day in the given period.
GET v1/ServiceContract/ScheduledServicesAppointmentsPerDay?shopOwnerId={shopOwnerId}&periodFrom={periodFrom}&periodTill={periodTill}	Return the scheduled services per day in given period.
GET v1/ServiceContract/Appointment/{id}	Gets detailed information about the appointment
GET v1/ServiceContract/{id}/MailConfig?template={template}	Gets mail config flag for a specific template. Mail target flag values: 0 - none, 1 - customer, 2 - location, 3 - customer, location, 4 - delivery address, 5 - customer, delivery address, 6 - location, delivery address, 7 - customer, location, delivery address, null - if a config was never set.
GET v1/ServiceContract/{id}/MailConfigs	Gets mail config flags for all templates. Mail target flag values: 0 - none, 1 - customer, 2 - location, 3 - customer, location, 4 - delivery address, 5 - customer, delivery address, 6 - location, delivery address, 7 - customer, location, delivery address, null - if a config was never set.
POST v1/ServiceContract/{id}/MailConfig?template={template}&mailTarget={mailTarget}	Gets mail config flag for template
GET v1/ServiceContract/GetContactInfoByEmailAddress?emailAddress={emailAddress}	Try to find all Customer/ServiceContract information based on the provided email address.
GET v1/ServiceContract/{serviceContractId}/Comments	Get a list with all Comments for a ServiceContract.
POST v1/ServiceContract/{serviceContractId}/Comments	Adds the specified ServiceContractComment.
PUT v1/ServiceContract/{serviceContractId}/Comments	Updates the specified ServiceContractComment.
DELETE v1/ServiceContract/{serviceContractId}/Comments/{serviceContractCommentId}	Delete the given ServiceContractComment.
GET v1/ServiceProduct/GetServiceProducts?searchField={searchField}&pageSize={pageSize}&pageNumber={pageNumber}	Get list of ServiceProductInfo for all available employee's shop groups. Pagination info included into response header.
GET v1/ServiceProduct/{id}	Get detailed information about ServiceProduct.
POST v1/ServiceProducts/ReplaceableParts/Products	Retrieves a list of Products that the linked ReplaceableParts for the given ServiceProductIDs are based on
POST v1/ServiceProducts/Products	Retrieves a list of Products that are linked to the provided ServiceProductIDs

Shipments

API	Description
GET v1/Shops/{shopId}/Shipments?fromDateChanged={fromDateChanged}&untilDateChanged={untilDateChanged}&isPicked={isPicked}&isPacked={isPacked}&isShipped={isShipped}&isHandedOver={isHandedOver}&pageSize={pageSize}&pageNumber={pageNumber}	Get a list with available Shipments, for given shop.
GET v1/Warehouses/{warehouseId}/Shipments?fromDateChanged={fromDateChanged}&untilDateChanged={untilDateChanged}&isPicked={isPicked}&isPacked={isPacked}&isShipped={isShipped}&isHandedOver={isHandedOver}&pageSize={pageSize}&pageNumber={pageNumber}	Get a list with available Shipments, for given Warehouse.
GET v1/Shipments/{shipmentId}	Get detailed information about a Shipment.
GET v1/Shops/{shopId}/Shipments/{shippingCode}	Get detailed information about a Shipment.
GET v1/Shops/{shopId}/Shipments/{shippingCode}/ShipmentId	Get the ShopCtrl Shipment Id based on the ShipmentCode.
POST v1/Shipments	Creates a new shipment for an order.
DELETE v1/Shipments/{shipmentId}	Deletes a shipment from the system.
PUT v1/Shipments/{shipmentId}/AddOrderRows	Add one or multiple orderrows to an existing 'open' shipment.
PUT v1/Shipments/{shipmentId}/RemoveOrderRows	Remove one or multiple OrderRows from an 'open' shipment.
PUT v1/Shipments/{shipmentId}/GeneratePickList	Creates (or updates if it already exists) the picklist for the shipment
PUT v1/Shipments/{shipmentId}/GeneratePackingSlip	Creates (or updates if it already exists) the packingslip for the shipment
PUT v1/Shipments/{shipmentId}/SetPicked?timestamp={timestamp}	Mark the Shipment as Picked.
POST v1/Shipments/{shipmentId}/SetPicked/AdvancedStockItem?acceptStockItemAsIs={acceptStockItemAsIs}	Mark an advanced stock item as picked
POST v1/Shipments/{shipmentId}/SetPicked/AdvancedStockItems?acceptStockItemAsIs={acceptStockItemAsIs}	Mark an advanced stock items as picked
POST v1/Shipments/{shipmentId}/SetUnpicked	Mark the Shipment as unpicked. The associated stock items will be set to 'Reserved'.
PUT v1/Shipments/{shipmentId}/AddParameter	Add a parameter to the OrderShipment. If the key already exists, value if overritten, otherwise key is created.
PUT v1/Shipments/{shipmentId}/AddParameters	Add multiple parameters to the OrderShipment. If the key already exists, value if overritten, otherwise key is created.
DELETE v1/Shipments/{shipmentId}/RemoveParameter/{key}	Removes a parameter from the OrderShipment parameter collection.
POST v1/Shipments/{shipmentId}/Parcel	Add parcel to the shipment. You can only set 1 parcel per shipment. If you want to replace the parcel, you should first delete the existing parcel on the shipment.
DELETE v1/Shipments/{shipmentId}/Parcel	Removes parcel from OrderShipment. The parcel itself will also be deleted from the system.
GET v1/Shipments/{shipmentId}/Picklist	Returns the picklist for this Shipment
PUT v1/Shipments/{shipmentId}/SetRowsPicked	Marks orderrows as picked
GET v1/Shipments/{shipmentId}/Packlist	Returns the packlist for this Shipment
PUT v1/Shipments/{shipmentId}/SetPacked?timestamp={timestamp}	Mark the Shipment as Packed.
POST v1/Shipments/{shipmentId}/SetUnpacked	Mark the Shipment as unpacked.
PUT v1/Shipments/{shipmentId}/SetShipped?timestamp={timestamp}	Mark the Shipment as Shipped.
PUT v1/Shipments/{shipmentId}/SetHandOver?timestamp={timestamp}	Mark the Shipment as Handed over to external fulfilment party.
GET v1/Shops/{shopId}/ShipmentsExists?shipmentCodes={shipmentCodes}	No documentation available.

ShopOwners

API	Description
GET v1/ShopOwners	Get a list with all available ShopOwners for the logged in user.
GET v1/ShopOwners/{shopOwnerId}	Get detailed information about a ShopOwner.
POST v1/ShopOwners	Add a new ShopOwner.
PUT v1/ShopOwners	Update an existing ShopOwner.
GET v1/ShopOwners/{shopOwnerId}/ShopGroups	Get all ShopGroups for the ShopOwner.
GET v1/ShopGroups/{shopGroupId}	Get detailed information about a ShopGroup.
POST v1/ShopGroups	Add a new ShopGroup for a ShopOwner.
PUT v1/ShopGroups	Update an existing ShopGroup.
DELETE v1/ShopGroups/{shopGroupId}	Delete given ShopGroup.
GET v1/ShopOwners/{shopOwnerId}/Affiliates	Get all ShopGroups for the ShopOwner.

Shops

API	Description
GET v1/Shops	Get a list with all available Shops for the logged in user.
GET v1/ShopGroups/{shopGroupId}/Shops	Get a list with all available Shops, for given shop group.
GET v1/Shops/{shopId}	Get detailed information about a Shop.
POST v1/Shops	Add a new Shop for a ShopOwner.
PUT v1/Shops	Update an existing Shop.
DELETE v1/Shops/{shopId}	Delete given Shop.
GET v1/Shops/ShopStatus	Get a list with all available Shops for the logged in user. The status info contains info about last mail/order synchronization.
GET v1/Shops/LastOrderSyncTimestamp	Gets the last order synchronize timestamps.
PUT v1/Shops/{shopId}/Product/ForeignPriceIncVAT	Update the Product price for a Shop. The price is in the default Shop currency, and is specified including VAT. An existing Product must be specified.
PUT v1/Shops/{shopId}/Product/ForeignPricesIncVAT	Update a collection Product prices for a Shop. The price is in the default Shop currency, and is specified including VAT. An existing Product must be specified.
GET v1/Shops/{shopId}/Parameters	Get all Shop's Parameters.
PUT v1/Shops/{shopId}/Parameters	Updates or adds a Shop Parameter.
POST v1/Shops/{shopId}/Parameters	Updates or adds a Shop Parameter.
PUT v1/Shops/{shopId}/Parameters/{key}	Updates or adds the Shop Parameter.
POST v1/Shops/{shopId}/Parameters/{key}	Updates or adds the Shop Parameter.
DELETE v1/Shops/{shopId}/Parameters/{key}	Delete a specific Shop's Parameter.
POST v1/Shops/{shopId}/SetOrderStatusesManagedByShopCtrl	Sets the Order's statuses managed by ShopCtrl.
POST v1/Shops/{shopId}/Logo	Upload the Shop logo
POST v1/Shops/{shopId}/Icon	Upload the Shop icon

StockCount

API	Description
GET v1/Warehouses/{warehouseId}/StockCountGroup	Return list of stock count groups for a warehouse
GET v1/Warehouses/{warehouseId}/StockCountGroup/{stockCountGroupId}	Get details of stock count group
POST v1/Warehouses/{warehouseId}/StockCountGroup	Create new stock count group
PUT v1/Warehouses/{warehouseId}/StockCountGroup/{stockCountGroupId}	Update details of stock count group
DELETE v1/Warehouses/{warehouseId}/StockCountGroup/{stockCountGroupId}	Delete stock count group
GET v1/Warehouses/{warehouseId}/StockCount?PageSize={PageSize}&PageNumber={PageNumber}&StockCountGroupId={StockCountGroupId}&IsPlanned={IsPlanned}&IsStarted={IsStarted}&IsClosed={IsClosed}&IsFinalized={IsFinalized}&IsHandover={IsHandover}	Search for stock counts
GET v1/Warehouses/{warehouseId}/StockCount/{stockCountId}	No documentation available.
OPTIONS v1/Warehouses/{warehouseId}/StockCount/{stockCountId}/Item/{stockCountItemId}	No documentation available.
POST v1/Warehouses/{warehouseId}/StockCount	Creates a StockCount
POST v1/Warehouses/{warehouseId}/StockCount/{stockCountId}	No documentation available.
POST v1/Warehouses/{warehouseId}/StockCount/{stockCountId}/Item/{stockCountItemId}/{actualCount}	No documentation available.
POST v1/Warehouses/{warehouseId}/StockCount/{stockCountId}/finalize	No documentation available.
POST v1/Warehouses/{warehouseId}/StockCount/{stockCountId}/Item/{stockCountItemId}/Action/DoNothing	No documentation available.
POST v1/Warehouses/{warehouseId}/StockCount/{stockCountId}/Item/{stockCountItemId}/Action/CreateStockItems	No documentation available.
POST v1/Warehouses/{warehouseId}/StockCount/{stockCountId}/Item/{stockCountItemId}/Action/MarkMissing	No documentation available.
POST v1/Warehouses/{warehouseId}/StockCount/{stockCountId}/Item/{stockCountItemId}/Action/MoveToHere	No documentation available.

Suppliers

API	Description
GET v1/ShopOwners/{shopOwnerId}/Suppliers?isActive={isActive}	Get a list with all Suppliers for specified Shop owner.
GET v1/ShopOwners/{shopOwnerId}/Suppliers/Search/{search}?isActive={isActive}	Get a list with all Suppliers for specified Shop owner and search in following fields: - FullName - CompanyName - EMail address
GET v1/Suppliers?isActive={isActive}	Get a list with all Suppliers available for the logged in user.
GET v1/Suppliers/{id}	Get detailed information about a Supplier.
POST v1/Suppliers	Add a new Supplier.
PUT v1/Suppliers	Update an existing Supplier.
DELETE v1/Suppliers/{id}	Delete given Supplier.
GET v1/Suppliers/{id}/Products	Get a list with all Products available by the Supplier.

System

API	Description
GET v1/Me	Get current API user info
GET v1/Me/Shops	Returns available shops for current user
GET v1/System/AppModules	Returns a list of (enabled) AppModules
GET v1/System/AppModules/Feature/{feature}	Returns a list of (enabled) AppModules
GET v1/System/AppModuleFeatures	No documentation available.
GET v1/System/Version	No documentation available.
GET v1/System/Time	Return the current DateTime of the server
POST v1/SyncSystemRequests	Creates a sync system request.

Tickets

API	Description
GET v1/Shops/{shopId}/Tickets?fromDateChanged={fromDateChanged}&untilDateChanged={untilDateChanged}&mainStatusId={mainStatusId}&mainStatusBaseStatusId={mainStatusBaseStatusId}&pageSize={pageSize}&pageNumber={pageNumber}	Get a list with all Tickets, for given shop.
GET v1/Tickets/{id}	Get detailed information about the Ticket.
GET v1/Shops/{shopId}/Tickets/{code}	Get detailed information about the Ticket.
GET v1/Shops/{shopId}/Tickets/{code}/TicketId	Get the ShopCtrl Ticket Id based on the TicketCode.
PUT v1/Tickets/{id}/MainStatus/{statusId}	Update the Main Ticket status.
GET v1/Shops/{shopId}/TicketStatuses	Get a list with all TicketStatuses, for the given shop.
GET v1/Shops/{shopId}/TicketTypes	Get a list with all TicketTypes, for the given shop.
PUT v1/Shops/{shopId}/Ticket	Add a new ticket.
GET v1/Tickets/{id}/Messages?includeMail={includeMail}&includeVoip={includeVoip}&includeChat={includeChat}	Get a list of the Ticket messages.
GET v1/Tickets/{id}/Comments	Get a list with all comments of a given ticket.
POST v1/Tickets/{id}/Comments	Adds the specified comment.
PUT v1/Tickets/{id}/Comments	Updates the specified comment.
DELETE v1/Tickets/{id}/Comments/{commentId}	Delete the specified comment.
PUT v1/Tickets/{ticketId}/AssignCategories	Assign categories to a ticket.
PUT v1/Tickets/{ticketId}/RemoveCategories	Removes categories from a ticket.
GET v1/Tickets/{ticketId}/Files	Gets Ticket files.
POST v1/Tickets/{ticketId}/Files	Adds the file. The action expects the file as binary data in the request body. The action requires the "filename" header to be defined, with the correct file extension. The action sets up the "FileID" response header.
DELETE v1/Tickets/{ticketId}/Files/{fileId}	Deletes the Ticket file.

TransportCategories

API	Description
GET v1/TransportCategories	Get a list with all available TransportCategories for the logged in user.
GET v1/TransportCategories/{transportCategoryId}	Get detailed information about a TransportCategory.
GET v1/TransportCategoryPrices/{transportCategoryId}	Get price information about a TransportCategory.
GET v1/TransportCategoryPrices	Get all price information about all TransportCategories.

Triggers

API	Description
GET v1/ShopOwners/{shopOwnerId}/Triggers	Get a list with all Triggers.
GET v1/Shops/{shopId}/Triggers	Get a list with all available Triggers for this shop.
GET v1/Triggers/{id}	Get detailed information about a Trigger.
POST v1/Triggers	Add a new Trigger.
PUT v1/Triggers	Update an existing Trigger.
DELETE v1/Triggers/{id}	Delete a given Trigger.
GET v1/TriggerActionDefinitions	Get a list with all TriggerActionDefinitions.

UOM

API	Description
GET v1/Uoms	Get a list with all available UOMs.

VATTariffs

API	Description
GET v1/Shops/{shopId}/VATTariffs	Get a list with all VAT tariffs which are available for given Shop.

VoipCalls

API	Description
GET v1/Shops/{shopId}/VoipCalls?fromDate={fromDate}&untilDate={untilDate}&dispostionId={dispostionId}&pageSize={pageSize}&pageNumber={pageNumber}	Get a list with all available VoipCalls, for given shop.
GET v1/VoipCalls/{VoipCallId}	Get detailed information about an VoipCall.
POST v1/Shops/{shopId}/VoipCalls	Creates new VoipCall. VoipServer needs to be of type 'Generic', can't be used with ShopCtrl managed Asterisk calls.
PUT v1/Shops/{shopId}/VoipCalls/{voipCallId}	Updates an unmanaged VoipCall. VoipServer needs to be of type 'Generic', can't be used with ShopCtrl managed Asterisk calls.
POST v1/Shops/{shopId}/VoipCalls/{voipCallId}/SetHandled	Sets a voip call handled. Can be used on managed and unmanaged voipcalls.

Warehouses

API	Description
GET v1/ShopOwners/{shopOwnerId}/Warehouses?enabled={enabled}	Get a list with all Warehouses.
GET v1/Shops/{shopId}/Warehouses	Get a list with all Warehouses.
PUT v1/Warehouses/{warehouseId}/Shops/{shopId}	Enable the specified Warehouse for the specified Shop.
DELETE v1/Warehouses/{warehouseId}/Shops/{shopId}	Disable the specified Warehouse for the specified Shop.
GET v1/Warehouses	Get a list with all available Warehouses for the logged in user.
GET v1/Warehouses/{warehouseId}	Get detailed information about a Warehouse.
POST v1/Warehouses	Add a new Warehouse.
PUT v1/Warehouses	Update an existing Warehouse.
DELETE v1/Warehouses/{warehouseId}	Delete given Warehouse.
GET v1/Warehouses/{warehouseId}/Stock	Get a list with all product stock available in the Warehouse, grouped by ProductCode.
GET v1/Warehouses/{warehouseId}/StockPerLocation	Get a list with all location product stock available in the Warehouse, grouped by ProductCode.
GET v1/Warehouses/{warehouseId}/Locations	Get all locations in the Warehouse.
GET v1/Warehouses/Locations/{warehouseLocationId}	Get detailed information about a WarehouseLocation.
POST v1/Warehouses/Locations	Add a new WarehouseLocation for a Warehouse.
PUT v1/Warehouses/Locations	Update an existing WarehouseLocation.
DELETE v1/Warehouses/Locations/{warehouseLocationId}	Delete given WarehouseLocation. Keep in mind that a location can only be deleted when there is no stock available.
GET v1/Warehouses/Locations/{warehouseLocationId}/Stock	Get a list with all product stock available in the WarehouseLocation.
PUT v1/Warehouses/{warehouseId}/Product/QtyAvailable	No documentation available.
PUT v1/Warehouses/{warehouseId}/Product/QtyOnHand	No documentation available.
PUT v1/Warehouses/{warehouseId}/Product/{productCode}/QtyOnHand/{qty}	Changes the quantity on hand, the absolute value. For the default location.
PUT v1/Warehouses/{warehouseId}/Product/{productCode}/Location/{locationName}/QtyOnHand/{qty}	Changes the quantity on hand, the absolute value.
PUT v1/Warehouses/{warehouseId}/Product/{productCode}/Location/{locationId}/AddQtyOnHand/{qty}	Adds or reduces the quantity on hand.
PUT v1/Warehouses/Stock/Move	Moves stock
PUT v1/Warehouses/Stock/MoveAdvanced	Moves advanced stock
GET v1/Warehouses/{warehouseId}/Parameters	Get all Warehouse's Parameters.
PUT v1/Warehouses/{warehouseId}/Parameters	Updates or adds a Warehouse Parameter.
POST v1/Warehouses/{warehouseId}/Parameters	Updates or adds a Warehouse Parameter.
PUT v1/Warehouses/{warehouseId}/Parameters/{key}	Updates or adds the Warehouse Parameter.
POST v1/Warehouses/{warehouseId}/Parameters/{key}	Updates or adds the Warehouse Parameter.
DELETE v1/Warehouses/{warehouseId}/Parameters/{key}	Delete a specific Warehouse's Parameter.

Webhook

API	Description
POST v1/System/AppModule/{appModuleId}/{consumerLevel}/{consumerId}/Webhook/{webhookKey}	Queue a post of a webhook action for handling by the appropriate AppModule. The HTTP header of the request will be stored in the SyncRequest as RequestParameters.