Browse documentation

E-commerce API

3 endpoints for e-commerce workflows. Every call requires bearer authentication and uses the standard ToolsOnDuty response envelope.

Try it

Runs a real request from your browser to your own ToolsOnDuty account. Your key is only kept in this page and is never stored.

EndpointAPI key

sellingPrice *productCost *inboundShippingimportDutypackagingmarketplaceRatepaymentRatefixedFeefulfillmentoutboundShippingadvertisingotherCostreturnRatereturnHandlingrecoveryValuefeesOnGrossRevenue

POST/v1/commerce/product-profit1 credit / call

Product contribution profit

Calculate retained revenue, expected return effects, percentage fees, contribution profit, margin and break-even selling price.

Parameter	Type	Required	Description
sellingPrice	number	Yes	Before-tax selling price.
productCost	number	Yes	Product cost per placed order.
inboundShipping	number	No	Inbound shipping cost. Default: 0.
importDuty	number	No	Import duty allocated per order. Default: 0.
packaging	number	No	Packaging cost. Default: 0.
marketplaceRate	number	No	Marketplace fee percentage (0-100). Default: 0.
paymentRate	number	No	Payment fee percentage (0-100). Default: 0.
fixedFee	number	No	Fixed transaction fee. Default: 0.
fulfillment	number	No	Fulfilment cost. Default: 0.
outboundShipping	number	No	Outbound shipping cost. Default: 0.
advertising	number	No	Advertising cost allocated per order. Default: 0.
otherCost	number	No	Other variable cost. Default: 0.
returnRate	number	No	Expected return rate percentage (0-100). Default: 0.
returnHandling	number	No	Handling cost per returned order. Default: 0.
recoveryValue	number	No	Recovered value per returned unit. Default: 0.
feesOnGrossRevenue	boolean	No	Apply percentage fees to gross rather than expected retained revenue. Default: false.

Request

curl -X POST https://toolsonduty.com/api/v1/commerce/product-profit \
  -H "Authorization: ******" \
  -H "Content-Type: application/json" \
  -d '{"sellingPrice":79,"productCost":24,"marketplaceRate":14,"paymentRate":2.5,"returnRate":6,"fulfillment":5,"outboundShipping":4}'

Response

{
  "ok": true,
  "data": {
    "contributionProfit": 25.87,
    "contributionMargin": 34.85
  }
}

POST/v1/commerce/landed-cost1 credit / call

Landed cost calculator

Calculate shipment landed cost, duty and cost per ordered or sellable unit with an explicit duty base.

Parameter	Type	Required	Description
quantity	number	Yes	Ordered unit quantity.
supplierUnitCost	number	Yes	Supplier cost per ordered unit.
damagedUnits	number	No	Expected damaged or unsellable units. Default: 0.
freight	number	No	Shipment freight cost. Default: 0.
insurance	number	No	Shipment insurance cost. Default: 0.
dutyRate	number	No	Customs duty percentage (0-100). Default: 0.
dutyBase	string	No	goods \| cif. Default: goods.
clearance	number	No	Customs clearance cost. Default: 0.
domesticTransport	number	No	Domestic transport cost. Default: 0.
inspection	number	No	Inspection cost. Default: 0.
packaging	number	No	Packaging or relabelling cost. Default: 0.
otherCost	number	No	Other shipment cost. Default: 0.

Request

curl -X POST https://toolsonduty.com/api/v1/commerce/landed-cost \
  -H "Authorization: ******" \
  -H "Content-Type: application/json" \
  -d '{"quantity":500,"supplierUnitCost":8,"freight":900,"insurance":50,"dutyRate":10,"dutyBase":"cif","damagedUnits":10}'

Response

{
  "ok": true,
  "data": {
    "sellableUnits": 490,
    "costPerSellableUnit": 11.11
  }
}

POST/v1/commerce/break-even-roas1 credit / call

Break-even ROAS and ACOS

Calculate pre-ad contribution, maximum ad cost per order, break-even ROAS, ACOS and CPC.

Parameter	Type	Required	Description
averageOrderValue	number	Yes	Average order value before tax.
productAndFulfillmentCost	number	Yes	Product and fulfilment cost per order.
sellingFeeRate	number	No	Selling fee percentage (0-100). Default: 0.
returnRate	number	No	Expected return rate percentage (0-100). Default: 0.
conversionRate	number	No	Conversion rate percentage (0-100). Default: 0.
currentSpend	number	No	Current advertising spend. Default: 0.
attributedRevenue	number	No	Current attributed gross revenue. Default: 0.
attributedOrders	number	No	Current attributed order count. Default: 0.

Request

curl -X POST https://toolsonduty.com/api/v1/commerce/break-even-roas \
  -H "Authorization: ******" \
  -H "Content-Type: application/json" \
  -d '{"averageOrderValue":79,"productAndFulfillmentCost":35,"sellingFeeRate":16,"returnRate":6,"conversionRate":3.2}'

Response

{
  "ok": true,
  "data": {
    "breakEvenRoas": 2.89,
    "breakEvenAcos": 34.66
  }
}