SKU Map Search

GET{{api_url}}/shop/products/sku_map/search?search_term=map

Lists the SKU Maps on the account. A SKU Map is a named list of SKU pairs that translates your SKUs into the SKUs a fulfillment partner uses. Each pair has a source_sku, the SKU as it appears on your orders, and a dest_sku, the SKU the 3PL, fulfillment service, or drop shipper knows. A fulfillment connection chooses which map it uses in its settings, and InfiPlex applies that map when exchanging SKUs with the connection, so one map can serve several connections and a connection can switch maps without changing any products. A SKU Map does not change inventory. Maps are created at Inventory > SKU Maps in the OMS or by CSV upload.

Parameters

All parameters are optional.

ParameterTypeDescription
search_termstringPartial match against the map name.
just_countintegerSet to 1 to return only a count of matching maps instead of the maps themselves.
limitintegerMaximum number of maps to return.
limit_startintegerNumber of leading results to skip, for paging. With limit 100 and limit_start 100 you get maps 101 through 200.

Examples

All maps:

{{api_url}}/shop/products/sku_map/search

Maps whose name contains "fulfillment":

{{api_url}}/shop/products/sku_map/search?search_term=fulfillment

How many maps exist:

{{api_url}}/shop/products/sku_map/search?just_count=1

Response

A JSON array, one object per map. The SKU pairs themselves are not included here; use SKU Map Get for those.

[
    {
        "shop_sku_map_id": "5",
        "shop_sku_map_siteareaid": "16",
        "map_name": "Fulfillment Testing Map",
        "total_skus_mapped": "11"
    },
    {
        "shop_sku_map_id": "2",
        "shop_sku_map_siteareaid": "16",
        "map_name": "Map 2",
        "total_skus_mapped": "4"
    }
]
FieldTypeDescription
shop_sku_map_idstringThe map id. Pass this to SKU Map Get.
shop_sku_map_siteareaidstringThe InfiPlex site area the map belongs to.
map_namestringThe map name as shown in the OMS and in a fulfillment connection's settings.
total_skus_mappedstringNumber of SKU pairs in the map.

Authorization

Bearer token, sent in the Authorization header. Inherited from the collection.

Query Parameters

KeyValueDescription
just_count optionalSet to 1 to return only a count of matching sku maps instead of the sku maps themselves.
limit optionalMaximum number of sku maps to return
limit_start optionalNumber of leading results to skip, for paging. With limit 100 and limit_start 100 you get sku maps 101 through 200
search_termmapPartial match against the map name

Example Request

curl --location --request GET '{{api_url}}/shop/products/sku_map/search?search_term=map' \
--header 'Authorization: Bearer {{auth_token}}'

Example Responses

SKU Map Search

Request

curl --location --request GET '{{api_url}}/shop/products/sku_map/search?search_term=map' \
--header 'Authorization: Bearer YOUR_API_KEY'

Response 200 OK

[
    {
        "shop_sku_map_id": "5",
        "shop_sku_map_siteareaid": "16",
        "map_name": "Fulfillment Testing Map",
        "total_skus_mapped": "11"
    },
    {
        "shop_sku_map_id": "2",
        "shop_sku_map_siteareaid": "16",
        "map_name": "Map 2",
        "total_skus_mapped": "4"
    }
]