Skip to main content

List Source Code Mappings

GET 
/api/veracore/integration-instances/:integration_instance/source-code-mappings

All source code mappings for a Veracore integration instance.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

A source code mapping determines the Veracore source code stamped on orders submitted to Veracore, based on the sales channel the order came from. A mapping with a sub_sales_channel_id applies only to orders from that sub channel; a mapping with sub_sales_channel_id: null is the catch-all for the whole sales channel.

The feed is paginated (page, per_page, default 15) and filtered server-side.

Search filter[search] runs a fuzzy LIKE across source_code, the sales channel's name and the subchannel's name.

Filters Every filterable column takes an operator suffix, e.g. filter[sku.contains]=WID. The bare form (filter[sku]=WID-BLU-12) is equivalent to .is.

  • Text operators: is, is_not, contains, does_not_contain, is_one_of, is_not_one_of, starts_with, does_not_start_with, ends_with, does_not_end_with, is_empty, is_not_empty.
  • Numeric operators: is, is_not, is_one_of, is_not_one_of, greater_than, less_than, greater_than_or_equal, less_than_or_equal, between, is_empty, is_not_empty.
  • Datetime operators: is, is_not, before, after, on_or_before, on_or_after, between, is_empty, is_not_empty, plus the relative operators today, yesterday, tomorrow, past_week, past_month, past_year, next_week, next_month, next_year.

Advanced filter groups Instead of flat keys, clients may send a base64-encoded filter_groups tree, nesting AND/OR groups over the same columns. Unregistered columns inside the tree are silently ignored.

  • Text columns: source_code, sales_channel_integration_instance_name, sub_sales_channel_name.
  • Numeric columns: id, sales_channel_integration_instance_id, sub_sales_channel_id.
  • Datetime columns: created_at, updated_at.
  • filter[is_catch_all] takes true or false. "Applies to every order from this channel" is the absence of a subchannel rather than a value anyone can type, so it is offered as a filter of its own.

The two relationship name columns filter through their relationships and are not registered as sort columns — sort by sales_channel_integration_instance_id / sub_sales_channel_id instead.

Sorting sort accepts id, sales_channel_integration_instance_id, sub_sales_channel_id, source_code, created_at, updated_at (prefix with - for descending). Default sort is source_code.

Errors

  • 404 when the integration instance does not exist or is not a Veracore instance.

Authentication: Requires Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type