Skip to main content

Update Cost Category

PUT 
/api/cost-categories/:cost_category

Update an existing cost category.

Required scope: settings:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token.

Request body fields:

  • name (required, string, max:255) — unique category name (ignores this record for the uniqueness check)
  • default_nominal_code_id (optional, integer, nullable) — default posting nominal code; must exist in nominal_codes. Send null to clear it and fall back to the nominal code mapping settings.

Note: the name of a system cost category cannot be changed (returns 422).

cogs_nominal_code_id (integer, optional, nullable) — the account this category's share of cost of goods sold posts to. When a shipped unit's landed cost includes this category (e.g. customs duty or inbound freight), that portion is expensed to this account instead of the order's COGS account, and a restocked return reverses it from the same account. Null keeps the share in the order's COGS account. Orders whose product or sub-sales channel has its own COGS account post the whole cost there. Omit the field to leave the current value unchanged.

cogs_accounts (array, optional) — per-channel COGS accounts for this category. Each item has nominal_code_id (required) and exactly one of sales_channel_id or sub_sales_channel_id. For an order, the most specific account wins: its sub-sales channel, then its sales channel, then cogs_nominal_code_id. A sub-sales channel that has its own COGS account posts the whole cost there unless it is listed here. Get the channel ids from List Cost Category COGS Channels. Sending the array replaces the current list; omit it to leave the list unchanged.

Request​

Responses​

OK

Response Headers
    Content-Type