Channel Categories

APIDescription
GET channel-categories Returns a list of the available Channel Categories used in StoreFeeder along with a description

Channels

APIDescription
GET channels Get all Channels.
GET channels/{channelid} Get Channel By ID

Channel Types

APIDescription
GET channel-types Returns a list of available Channel Types used in StoreFeeder along with their Channel Category.
GET channel-types/{channelcategory} Returns a list of available Channel Types for a given Channel Category

Company Identities

APIDescription
GET company-identities Get all company Identities
GET company-identities/{companyidentityid} Get a specific company identity by ID.

Countries

APIDescription
GET countries Returns a list of available Countries
GET countries/ISO/{isocode} Returns a specific country based on ISO code
GET countries/{countryid} Returns a specific country based on the country ID

Custom Attributes

APIDescription
POST customattributes/create-custom-attributes Create custom attributes in bulk. Max 50 at one time.
GET customattributes/{customAttributeID} Get a single Custom Attribute.
GET customattributes?CustomAttributeName={CustomAttributeName}&PageSize={PageSize}&Page={Page} Get a paged list of Custom attributes. Allows a wildcard filter on name.
POST customattributes Create a new Custom Attribute
PUT customattributes/{customAttributeID} Update a Custom Attribute by ID
DELETE customattributes/{customAttributeID} Delete Custom Attribute by ID you cannot delete a custom attribute that is associated to products.

Deliveries

APIDescription
GET deliveries/{purchaseOrderID}/book-in-all Books in all outstanding items on a single Purchase Order matching the purchase order ID provided.
POST deliveries/book-in-all Books in all outstanding items for multiple purchase orders
POST deliveries/{purchaseOrderID}/book-in Books in/Writes off items for a single purchase order
POST deliveries/book-in >No documentation available.
GET deliveries/{purchaseOrderID} >No documentation available.
GET deliveries?RaisedDateFrom={RaisedDateFrom}&RaisedDateTo={RaisedDateTo}&SentDateFrom={SentDateFrom}&SentDateTo={SentDateTo}&DueDateFrom={DueDateFrom}&DueDateTo={DueDateTo}&SupplierID={SupplierID}&WarehouseID={WarehouseID}&PurchaseOrderStatus={PurchaseOrderStatus}&PageSize={PageSize}&Page={Page} returns information about multiple delivery-ready purchase orders matching the supplied Purchase Order IDs

Orders

APIDescription
PUT orders/despatch-orders This allows you to despatch orders in bulk. You can only despatch a maximum of 50 orders at once.
POST orders/create-orders This allows you to import orders in bulk. You can only import a maximum of 5 orders at once.
PUT orders/mark-orders-as-downloaded This method allows you mark orders as Downloaded. You can only update up to 50 orders at once.
PUT orders/override-order-statuses This method allows you override order statuses. You can get a list of statuses that you are allowed to override to by going the OrderStatus endpoint and checking the UserCanOverrideToStatus flag. You can only update up to 50 orders at once.
PUT orders/mark-orders-as-not-downloaded This method allows you mark orders as not Downloaded. You can only update up to 50 orders at once.
GET orders?Downloaded={Downloaded}&ImportDateFrom={ImportDateFrom}&ImportDateTo={ImportDateTo}&LastStatusChangeDateFrom={LastStatusChangeDateFrom}&LastStatusChangeDateTo={LastStatusChangeDateTo}&OrderDateFrom={OrderDateFrom}&OrderDateTo={OrderDateTo}&WarehouseID={WarehouseID}&ChannelID={ChannelID}&OrderStatus={OrderStatus}&ChannelType={ChannelType}&ShippingMethodID={ShippingMethodID}&CompanyIdentityID={CompanyIdentityID}&ShippingTrackingNumber={ShippingTrackingNumber}&ChannelOrderRef={ChannelOrderRef}&PageSize={PageSize}&Page={Page} Get orders call. Allows multiple different filters. A common usage would be to filter by downloaded=false and orderStatusId=3 3 is complete read to pick. This would provide you with all orders which have not been marked as downloaded and are ready to be shipped.
GET orders/{ordernumber} Get a single order by Order Number.

Order Status

APIDescription
GET order-status Returns a list of available Order Statuses used in StoreFeeder along with a description of the status.

Packaging

APIDescription
GET packaging Get a all packaging sizes
GET packaging/{packagingID} Get a single packaging size by id.

Product Categories

APIDescription
GET productcategories/get-full-category-tree This call returns the root categories and all of their children. It can return a lot of data.
GET productcategories/{categoryID} This call allows you to return a single category and its immediate children.
GET productcategories This call allows you to return the root categories and their immediate children.
PUT productcategories/{categoryID} This call allows you to update a product category.
POST productcategories This call allows you to create a category.
DELETE productcategories/{categoryID}?deleteChildren={deleteChildren} This call allows you to delete a specific category. If you try to delete a category with children without specifying the delete children flag as true it will fail.

Product Inventory Log

APIDescription
GET products/{productid}/productinventorylogs?From={From}&To={To} This allows you to return a date filtered list of product inventorylogs

Product Stock Location Inventory

APIDescription
PUT products/stocklocationinventory This call allows you to update the inventory of products by either SKU or ProductID. You can only update a maximum of 50 products at once.
PUT products/{productid}/stocklocationinventory This call allows you to update the inventory of an individual product by Product ID

Product Suppliers

APIDescription
POST products/productsuppliers This call allows to update or create Supplier entries for products.
GET products/{productid}/productsuppliers This call gets all product suppliers for a given productid.
GET products/{productid}/productsuppliers/{supplierid} This call allows you to get a particular supplier entry for a particular product.
POST products/{productid}/productsuppliers This call allows you to create or update a product supplier for a given product id.
DELETE products/{productid}/productsuppliers/{supplierid} This call allows you to delete a supplier from a product. If there is only one supplier on the product then the default supplier for the account will automatically be added.
PUT products/{productid}/productsuppliers/{supplierid} This call allows you to update a product supplier for a given Product ID and supplier ID

Purchase Orders

APIDescription
POST purchase-orders/delete Bulk deletes all Purchase Orders sent in the request
GET purchase-orders/{purchaseOrderID}/confirm Confirms a Purchase Order that is awaiting completion as 'Confirmed by Supplier'
POST purchase-orders/confirm Confirms multiple Purchase Orders that are awaiting completion as 'Confirmed by Supplier'
GET purchase-orders/{purchaseOrderID}/mark-as-sent Marks a specific Purchase Order as having been sent
POST purchase-orders/mark-as-sent Marks each Purchase Order in a list as having been sent
GET purchase-orders/{purchaseOrderID} Returns information about the Purchase Order with the given Purchase Order ID
GET purchase-orders?RaisedDateFrom={RaisedDateFrom}&RaisedDateTo={RaisedDateTo}&SentDateFrom={SentDateFrom}&SentDateTo={SentDateTo}&DueDateFrom={DueDateFrom}&DueDateTo={DueDateTo}&SupplierID={SupplierID}&WarehouseID={WarehouseID}&PurchaseOrderStatus={PurchaseOrderStatus}&PageSize={PageSize}&Page={Page} Returns information about multiple Purchase Orders matching the filter information provided.
DELETE purchase-orders/{purchaseOrderID} Deletes a Purchase Order matching the supplied Purchase Order ID
POST purchase-orders Creates a new PurchaseOrder

Purchase Order Status

APIDescription
GET purchase-order-status Returns a list of available Purchase Order Statuses used in StoreFeeder

Shipping Methods

APIDescription
GET shipping-methods Get all shipping methods for an account.
GET shipping-methods/{shippingmethodid} Get a shipping method by ID for an account.

Stock Locations

APIDescription
POST stocklocations/create-transfers This call allows to create stock location transfers in bulk. This feature is only available to accounts who have multiple stock locations.
GET stocklocations?WarehouseID={WarehouseID}&HasProducts={HasProducts}&IsEmpty={IsEmpty}&KeepProduct={KeepProduct}&SKU={SKU}&LocationType={LocationType}&PageSize={PageSize}&Page={Page} Returns a list of Stock locations
GET stocklocations/{stockLocationID} Returns information about a single Stock Location
DELETE stocklocations/{stockLocationID} Deletes given stock Location
POST stocklocations Create a new Stock Location
PUT stocklocations/{stockLocationID} Update a Stock Location by ID

Suppliers

APIDescription
GET suppliers Get all suppliers.
GET suppliers/{supplierid} Get an individual supplier by ID
POST suppliers Create a new Supplier
PUT suppliers/{supplierid} Update a Supplier by ID
PATCH suppliers/{supplierid} Partially update a Supplier. Leave any fields null which you do not wish to update.
DELETE suppliers/{supplierid} Delete Supplier by ID you cannot delete a supplier that is associated to products.

Tax Classes

APIDescription
GET taxclasses Returns a list of available Tax Classes
GET taxclasses/{taxClassId} Returns a specific Tax Class
POST taxclasses Creates a new Tax Class
PUT taxclasses/{taxClassId} Update a Tax Class by ID
DELETE taxclasses/{taxClassId} Deletes a user defined Tax Class matching the supplied Tax Class Id

Tax Rate Countries

APIDescription
GET taxclasses/{taxclassid}/taxratecountries Returns a list of all available all Country specific tax rates for a Tax Class
GET taxclasses/{taxclassid}/taxratecountries/{taxratecountryid} Returns a single Country specific tax rate in a Tax Class
POST taxclasses/{taxclassid}/taxratecountries Creates a new Country specific tax rate in a Tax Class
PUT taxclasses/{taxclassid}/taxratecountries Updates a Country specific tax rate in a Tax class
DELETE taxclasses/{taxClassId}/taxratecountries/{taxRateCountryId} Deletes a Country specific tax rate

Warehouses

APIDescription
GET warehouses/{warehouseID}/inventory-report?PageSize={PageSize}&Page={Page} Returns all products within a warehouse and their current inventory. Max page size 10000
GET warehouses Returns a list of Warehouses
GET warehouses/{warehouseID} Returns information about a single Warehouse

Warehouse Zones

APIDescription
GET warehousezones?WarehouseID={WarehouseID}&Name={Name}&PageSize={PageSize}&Page={Page} Returns a list of Warehouse Zones
GET warehousezones/{warehouseZoneID} Returns information about a single Warehouse Zone
DELETE warehousezones/{warehouseZoneID} >No documentation available.
POST warehousezones Create/Update Warehouse Zones
PUT warehousezones/{warehouseZoneID} Update a Warehouse Zone by ID