Collection Points
Checkout allows users to select Home Delivery or Collection Point for shipping. Collection points can be added in the SCAYLE Panel through API endpoints that retrieve available collection points based on carrier and location.
Example collection point selection in the Checkout front end
Add Collection Point
Collection Points are configured under Shops > Shop > Storefront > Checkout Settings > Collection Points.
Prerequisites
In order to configure collection points you will first need to ensure:
- At least one Shipping Option has been configured in
Shops > Storefront > Checkout Settings > Shipping Options - At least one Collection Point Type has been created in
Settings > General > Configuration > Collection Point Types(see Configurations)
Add Collection Point
To add a new collection point, click + Collection Point and complete the following:
- Delivery Option: Collection Point or Click & Collect
- Note: Collection Points are staffed locations whereas Click & Collect are self service stations where an id card is needed for customers to pick up their package.
- Collection Point Type (dropdown): Select from list of types (types are added in Configurations).
- Delegation Name (string): Key used for order delegation request. Some suggestions will be provided.
- Cloud Type (string): Type key for webhooks or Admin API responses, usually same as Collection Point Type but it can be customized if needed.
- Merchants (multiple selection): Allows you to whitelist merchants or keep it null (in the null case, all merchants will be allowed).
- Carrier Groups (multiple selection): Allows you to whitelist carriers or keep it null (in the null case, all carriers will be allowed).
- Visibility (switch): If Inactive the configured collection points will not display in the front end.
- API Search Type (string): Value used to generate a list from the provided API. See the extension api docs.
- Preferred Carrier Key (string): Used to generate list from the provided API. See the extension api docs.
- Customer Name (selection): Mandatory/Enabled
- Customer Number (selection): Mandatory/Enabled
- API Config: Option to enable search via an external API. If enabled, enter the following fields:
- Host
- Username
- Password
- Endpoint get Collection Point by ID
- Endpoint get Collection Point List
