/Auth

get

Get a new token using an existing token. Essentially a token "refresh".

post

Create an API token

/Batches/CustomerGroups

post

Add multiple CustomerGroups

put

Update multiple CustomerGroups

delete

Delete multiple CustomerGroups

/Batches/Customers

post

Add multiple Customers

put

Update multiple Customers

/Batches/Orders

post

Add multiple Orders

put

Update multiple Orders

/Batches/Promotions

post

Add multiple Promotions

put

Update multiple Promotions

delete

Delete multiple Promotions

/Batches/Prices

post

Add multiple Prices

put

Update multiple Prices

delete

Delete multiple Prices

/Batches/Products

post

Add multiple Products

put

Update multiple Products

/CreditMemos

get

Get a list of Credit Memos

/Customers

get

Get a list of Customers

post

Add a new Customer

/Customers/{id}

get

Get a Customer

put

Update a Customers

delete

Delete a Customer - Not implemented , will return a HTTP 405

/CustomerGroups

get

Get a list of CustomerGroups

post

Add a new CustomerGroup

/CustomerGroups/{id}

get

Get a CustomerGroup

put

Update a CustomerGroup

delete

Delete a CustomerGroup

/DimensionalAttributes

get

Get a List of Dimensional Attributes (size, color, material, etc)

post

Add a new DimensionalAttribute.example:{"Code": "color","DisplayName": "Color"}

/DimensionalAttributes/{id}

get

Get a Dimensional Attribute

put

Update a Dimensional Attribute.example:{"Code": "color2","DisplayName": "Color2","DisplayOrder": 1}

delete

Delete a Dimensional Attribute

/DimensionalAttributes/{id}/VariationValues

This resource collection represents the Variation values of a DimensionalAttribute

get

Get a list of Variation Values

post

Add a new Variation Valueexample:{"VariationValue":"Red","VariationLabel":"Red","DisplayOrder":0,"PriceDelta":0.00,"IsDefault":false}

/DimensionalAttributes/{id}/VariationValues/{variationid}

Manage a specific variation value

get

Get an Variation Value

put

Update an Variation Value

delete

Delete an Variation Value

/DimensionalAttributeSets

get

Get a list of Dimensional Attribute Sets

post

Add a new Dimensional Attribute Set

/DimensionalAttributeSets/{id}

get

Get an DimensionalAttributeSet

put

Update an DimensionalAttributeSet

delete

Delete an DimensionalAttributeSet

/DimensionalAttributeSets/{id}/DimensionalAttributes

get

Get a list of DimensionaAttributes in this Set

post

Add a DimensionaAttribute to the Set.

/EventSubscriptions

get

Get a list of Event Subscriptions

post

/EventSubscriptions/{id}

get

Get the Event Subscription by {id}

put

Update an Event Subscription

delete

Does not actually delete the Event Subscription, it sets Enabled = false

/InventoryLots

get

Get a list of InventoryLots

post

Add a new InventoryLot

put

Update an InventoryLot - There is not an Id field in ProductBinLot, nor is there any other single primary key field that could be used, the primary key is actually productId, WarehouseBinId, and LotNumber

/Invoices

get

Get a list of Invoices

/Orders

get

Get a list of Orders

post

Add a new Order

/Orders/{id}

get

Get an Order

delete

Delete an Order - Not implemented , will return a HTTP 405

/Orders/{id}/Cancel

put

Cancel an Order. For whole order cancel, payload is required only if AdjustmentFee is specified. For partial order cancel, use the payload to specify OrderItems, ShippingAmount, TaxAmount, AdjustmentFee.

/Orders/{id}/RefundRMA

put

Process refund from RMA

/Orders/{id}/Shipments/{subid}

put

Update an Order

/Prices

get

Get a list of Prices

post

Add a new Price

/Prices/{id}

get

Get a Price

put

Update a Price

delete

Delete a Price

/ProductClassificationCodes

get

/Products

get

Get a list of Products

post

Add a new Product

/Products/{id}

get

Get a Product

put

Update a Product

delete

Delete a Product - Products are not actually deleted from the Freestyle database. Instead, the product status is changed to 'Removed'.

/Products/{product_id}/Prices

get

Get the list of Prices for Product with ProductId {product_id}

/Products/{product_id}/Prices/{id}

get

Get the Price with PriceId {id} for Product with ProductId {product_id}

/Promotions

get

Get a list of Promotions

post

Add a new Promotion

/Promotions/{id}

get

Get a Promotion

put

Update a Promotion

delete

Delete a Promotion

/Promotions/SwapSequence/{id1}

put

swap sequence numbers for the promotions indicated by the ids passed

/PurchaseOrders

get

Get a list of Purchase orders

/Refunds

get

Get a list of Refunds

/Refunds/{id}

get

Get a Refund

/Refunds/{id}/Process

put

Process a Refund

/Returns

get

Get a list of Returns

post

Add a new Return. ReturnItems is required.

/Returns/{id}

get

Get a Return

put

Modify a Return. Updateable fields are: ReturnExpectedBy, RefundAdjustment, RefundTax, and TotalShippingRefundAmount.

/Returns/{id}/ReturnItems

get

Get list of ReturnItems for a particular return. Filtering and sorting features are not supported.

/Returns/{id}/ReturnItems/{returnitemid}

get

Get a ReturnItem

put

Update a ReturnItem. Updateable fields are: QuantityToReturn and ReturnReason.

/Returns/{id}/ReceivedItems

get

Get a list of ReceivedItems for a particular Return. Filtering and sorting feature are not supported.

post

Add a new ReceivedItem

/ReturnReasons

get

List of valid Return Reasons

/SalesChannels

get

Get a list of Saleschannels

/Shipments

get

Get a list of Shipments

/Shipments/{id}

get

Get a Shipment

put

Modify a Shipment

/ShippingMethods

get

Get a list of Shipping methods

post

Add a Shipping Method

/ShippingMethods/{id}

get

Get a Shipping Method

put

Modify a Shipping Method

delete

Delete a Shipping Method - Not implemented , will return a HTTP 405

/SupplierBills

get

Get a list of Supplier Bills

/Suppliers

get

Get a list of Suppliers

/WarehouseBins

get

Get a list of Warehouse Bins

post

Add a Warehouse Bin

/WarehouseBins/{id}

get

Get a warehouse Bin

put

Modify a Warehouse Bin

delete

Delete a Warehouse Bins - Not implemented , will return a HTTP 405

/Warehouses

get

Get a list of Warehouses

post

Add a Warehouse

/Warehouses/{id}

get

Get a Warehouse

put

Modify a Warehouse

delete

Delete a Warehouse - Not implemented , will return a HTTP 405