Skip to main content
GET
Transaction COGS (paginated, read-only)

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Query Parameters

from_date
string<date>

Start of date range

to_date
string<date>

End of date range

product_name
string

Filter by product name

sku
string

Filter by SKU

channel
string

Filter by sales channel

order_number
string

Filter by order number

cost_per_unit
number

Filter by cost per unit

is_missed_cogs
boolean

When true, selects the missed COGS query path

recognition_basis
enum<string>
default:ship_date

Basis on which transaction COGS is recognized. order_date recognizes at the order date, ship_date at the ship date, and per_shipment per individual shipment. When omitted, the tenant's saved default is used (falling back to ship_date).

Available options:
order_date,
ship_date,
per_shipment
per_page
integer
default:10

Number of items per page (max 100)

Required range: x <= 100
page
integer
default:1

Page number for pagination

Required range: x >= 1
sortField
string

Field to sort by

sortDirection
string

Sort direction (asc or desc)

Response

Paginated transaction COGS rows

data
object[]
meta
object