Skip to main content

List Shopify Partner Locations

GET 

/api/shopify/:integrationInstance/partner-locations

List the store's partner locations: Shopify locations that a partner ships from rather than the store itself. A partner location is a Shopify Collective supplier's location (named "<Supplier> via Shopify Collective"), a location managed by a fulfillment-service app, or a location the merchant marked as a partner (see Update Shopify Location Partner Kind).

Required scope: integrations:read

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

Shipments from a partner location must not deduct the store's own stock, so each one belongs on a supplier drop-ship warehouse whose purchase orders are recorded but never sent to the supplier (record only). Each row shows how the location is mapped now and what SKU.io suggests.

Fields:

  • partner_kind: collective, fulfillment_service or manual. partner_kind_label is its display name.
  • partner_name: the location name with the "via Shopify Collective" suffix removed.
  • warehouse: the SKU.io warehouse the location is mapped to (null when unmapped), with its type (for example direct, 3pl or supplier) and, for a supplier warehouse, supplier_id and dropship_po_mode.
  • is_mapped_to_supplier_warehouse: true once the location is mapped to a supplier warehouse.
  • store_stock_shipments: partner shipments at this location that were recorded against one of the store's own warehouses, so they deducted store stock.
  • warning: why the current mapping needs attention, or null.
  • suggestion.action: use_supplier (an existing supplier matched the partner's name; supplier_id and, when it has one, its drop-ship warehouse_id are set), create_supplier (no supplier matched; supplier_name is the name a new supplier would get) or none (already mapped to a supplier drop-ship warehouse).
  • auto_apply: true for Shopify Collective locations. A Collective location that is new and unmapped is mapped automatically after each location sync; one already mapped to a store warehouse is only suggested, with a warning.

meta: total (rows), unmapped_to_supplier (rows not yet on a supplier warehouse) and store_stock_shipments (the sum across rows).

Not paginated.

Authentication: Requires Bearer token (integrations:read).

Request​

Responses​

OK

Response Headers
    Content-Type