API Reference
Knowledge Base

List all variants

get
https://api.katanamrp.com/v1/variants

Returns a list of variants you've previously created. The variants are returned in sorted order,
with the most recent variants appearing first.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
ids
array of integers

Filters variants by an array of IDs

ids
integer

Filters variants by a product id

integer

Filters variants by a material id

sku
array of strings

Filters variants by skus

sku
number

Filters variants by a sales price

number

Filters variants by a purchase price

string
length between 3 and 40

Filters variants by an internal barcode

string
length ≤ 120

Filters variants by a registered barcode

supplier_item_codes
array of strings

Filters variants by supplier item codes. Returns the variants that match with any of the codes in the array.

supplier_item_codes
extend
array of strings

Array of objects that need to be added to the response

extend
Allowed:
boolean

Soft-deleted data is excluded from result set by default. Set to true to include it.

boolean

Archived data is excluded from result set by default. Set to true to include it.

string

Used for pagination (default is 50)

string

Used for pagination (default is 1)

string

Minimum value for created_at range. Must be compatible with ISO 8601 format

string

Maximum value for created_at range. Must be compatible with ISO 8601 format

string

Minimum value for updated_at range. Must be compatible with ISO 8601 format

string

Maximum value for updated_at range. Must be compatible with ISO 8601 format

Headers
string
enum

Selects the representation of custom_fields on items, for both the request body and the response.

  • default — object keyed by custom field definition id (UUID).
  • legacy — the {field_name, field_value} array tied to custom fields collections.

Most accounts do not need this header: an account that has not moved to item custom fields always gets legacy, and an account that has moved and no longer uses collections always gets the object representation. The header matters only while both are available for the account, where legacy is the default and default opts into the object representation.

Requesting a representation the account does not have returns 422, as does sending a custom_fields body whose shape does not match the representation in force, mixing both shapes in one request, or combining custom_field_collection_id with the object representation — that field belongs to the legacy representation and is left out of responses entirely under the object one. Responses vary on this header.

Allowed:
Responses

Updated 5 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json

Updated 5 months ago

Did this page help you?