Skip to main content

List Shipping Method Mappings

GET 
/api/veracore/integration-instances/:integration_instance/shipping-methods

Every carrier + service combination observed on this instance's Veracore orders, joined with its mapping to a SKU.io shipping method.

Not yet available to API tokens

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

Each row has a code in the form Carrier|Service Description (e.g. UPS|UPS Ground), how many orders were seen with that combination, and the current mapping (or null when unmapped). Combinations that were mapped previously but no longer appear on any order are still included with order_count: 0.

All data is read from locally stored orders; no call is made to the Veracore API. The list is assembled from those orders and then paginated in memory (page, per_page, default 15), so it carries pagination metadata like any other record feed.

Use the returned code values with the map and unmap endpoints.

Search and filters Because the rows are derived from order payloads rather than a table, this list supports one combined search and one mapped/unmapped filter — not the per-column operator syntax used elsewhere.

  • filter[search] matches across carrier, carrier description, code, and the mapped SKU.io shipping method name.
  • filter[is_mapped] takes true or false.

Sorting sort accepts code, carrier, carrier_description, order_count, shipping_method_name (prefix with - for descending). Anything else falls back to -order_count.

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