Przejdź do głównej zawartości

ShippingPickupConfig

Pickup-point selection config for a shipping method whose deliveryType is LOCKER or PICKUP_POINT. Contains ONLY public, browser-safe data — for InPost this is the domain-scoped Geowidget token, never the ShipX API secret. Use it to render the carrier map (selectionMode = WIDGET) or to drive a server-side point search (selectionMode = SEARCH).

type ShippingPickupConfig {
  provider: String!
  scriptUrl: String @deprecated
  selectionMode: PickupSelectionMode!
  widget: ShippingPickupWidget
  widgetToken: String
}

Fields​

ShippingPickupConfig.provider ● String! non-null scalar​

Carrier code this config belongs to (e.g. "inpost"). Matches carrier.serviceCode's provider.

ShippingPickupConfig.selectionMode ● PickupSelectionMode! non-null enum​

How to let the buyer pick a point — WIDGET (carrier map) or SEARCH (server-side point lookup).

ShippingPickupConfig.widget ● ShippingPickupWidget object​

Everything needed to mount the carrier map: which widget it is, its script and stylesheet, and the attributes to put on the mount element. Null for SEARCH mode. Prefer this over the flat widgetToken/scriptUrl fields — they cover only part of what a map needs.

ShippingPickupConfig.widgetToken ● String scalar​

PUBLIC widget token used to initialise the carrier map (InPost Geowidget domain-scoped token). Never the carrier API secret. Null for SEARCH mode and when the merchant has not configured the public token (do not render the map — offer SEARCH or hide the method).

Show deprecatedHide deprecated

ShippingPickupConfig.scriptUrl ● String deprecated scalar​

DEPRECATED

Use widget.scriptSrc, which is ready to load and covers every carrier.

CDN URL of the carrier widget script to load before rendering the map. Null for SEARCH mode.

Member Of​

AvailableShippingMethod object