plan: Pro plan only (R6)
screens: Left menu "Connect(Pro Plan)" ("Format Settings for Integration Format", "Customize shipping options at checkout") / the settings per delivery method (slot) in "Settings"
verified_from: The admin implementation, the Function that shows/hides checkout delivery options (delivery-customization), the definition of the integration defaults + human-facing manual
ui_verified: Field names were confirmed from the code. Visual confirmation on the real screen has not been done
SUMMARY
- Customizing shipping methods at checkout: according to the “delivery method (slot)” chosen in the widget, Shopify’s delivery options at checkout (ship, local delivery, store pickup, etc.) are shown or hidden. Using the cart attribute
__ccSlot as the marker, unneeded delivery options are hidden at checkout.
- External system integration: the “label” and “format” of the delivery date and time that the widget writes into the order’s “Additional details” are matched to the import format of the destination (NextEngine, Openlogi, Ship&Co, GoQSystem).
Customizing shipping methods at checkout
FACTS
SC-1 Pro plan only. As a prerequisite, a "delivery method (slot)" must be set in the widget (see the delivery method steps on another page).
SC-2 The delivery method number and group number chosen in the widget are put into the cart attribute __ccSlot in the form "delivery method number::group number".
(the delivery method number when delivery methods are not used is -1, and the group number when groups are not used is -1)
SC-3 At checkout, if there is a setting that corresponds to __ccSlot, only the delivery options that are "checked" are shown and the others are hidden.
Delivery options are matched by the kind of delivery method (ship / local delivery / pickup) and the name of the delivery option (the rate name of the shipping profile).
SC-4 When __ccSlot is absent, there is no corresponding setting, or the setting is empty, nothing is hidden (everything is shown as usual).
SC-5 Shopify's shipping settings ("Settings" → "Shipping and delivery") cannot be created from the app. Create the shipping profiles and rate names first in the Shopify admin.
SC-6 Shopify's "Customized delivery" has a limit of 5 per store. When the limit is reached, updating the settings fails.
SC-7 To hide store pickup, there is a way to add a shipping rate such as "Store pickup (free)" to the Shopify shipping profile and treat it the same as "Ship".
In this case Shopify's "Ready for pickup" email can no longer be sent (human-facing manual).
SC-8 "Update shipping profile" re-fetches the shipping profiles from Shopify and brings the list on the settings screen up to date.
PROC-SC1 Show/hide checkout delivery options per delivery method
Where: App left menu "Connect(Pro Plan)" > "Customize shipping options at checkout" > "Start to custome settings" -> App left menu "Settings" > the settings screen of each delivery method (slot)
Prerequisites:
- The Pro plan is active
- Delivery methods (slots) are set in the widget (example: "Ship", "Store Pick up")
- Shipping profiles and rate names are created in Shopify's "Settings" → "Shipping and delivery"
Steps:
1. Open the left menu "Connect(Pro Plan)" and press "Start to custome settings" for "Customize shipping options at checkout"
2. On the settings screen of each delivery method (slot) in "Settings", for each delivery method check only the shipping profiles (rate names) you want to show at checkout
("Only checked delivery profiles will be displayed.")
3. If you added or changed a shipping profile on the Shopify side, press "Update shipping profile"
4. Save with "Save" at the top of the screen
Result: at checkout only the delivery options corresponding to the delivery method chosen in the widget are shown. __ccSlot is attached to the order's "Additional details"
QA (customizing shipping methods)
- Q: __ccSlot is attached to the order’s additional details. Can it be removed? A: It is a value needed for this feature to work (SC-2). If you only do not want to keep it, remove it after the order with “Remove internal attributes from the order’s additional details” in “Write to orders automatically” under “Option” (symptom page SYM-3). Turning the feature OFF stops it being attached, but the showing/hiding stops working too.
- Q: I set it but the delivery options are not hidden at checkout. A: Check in order: (1) did the customer choose a delivery method in the widget and purchase (SC-4: without __ccSlot nothing is hidden), (2) was it not through dynamic checkout (Buy it now, etc.), (3) does the name of the delivery option match the rate name of the Shopify shipping profile, and was it refreshed with “Update shipping profile”, (4) was it saved. Do not assert; ask for the information in ESCALATE.
- Q: “Update shipping profile” gives an error. A: Shopify’s “Customized delivery” may have reached the limit of 5 (SC-6). Delete unneeded ones from the customized delivery in the Shopify admin and try again.
- Q: I want to remove the store pickup option. A: Show/hide it with the shipping method customization (PROC-SC1), or use the way in SC-7. In the way of SC-7, always tell them that the “Ready for pickup” email can no longer be sent.
- Q: I want to set Shopify’s shipping rates themselves. A: They cannot be set from the app. Set them in Shopify’s “Settings” → “Shipping and delivery” (SC-5).
External system integration
FACTS
K-1 Available on the Pro plan. The "label" and "format" of the delivery date and time that the widget writes into the order's "Additional details" are matched to the import format of the destination.
K-2 Choices of destination: "None", "NextEngine", "Openlogi", "Ship & Co", "GoQSystem". Choosing one fills in the labels and formats below automatically.
K-3 They can also be changed individually ("Connect Label", "Connect Format", "No Setting connected items"). Even for a format the destination does not list, labels and formats can be set freely.
K-4 When groups (grouping products) or delivery methods are used, each needs its own integration setting. The destination (carrier) can be changed per group or per delivery method.
K-5 When "Concat Delivery Date & Time" is enabled, the date and time can be made one value (example: 2023-11-22-13:00). The shape can be adjusted with the text between the date and time and "Swap the date and time".
K-6 Combined with "detailed delivery time" (generating times automatically at intervals of 10 to 240 minutes), the time can be given an exact format.
K-7 The widget's display label (the text the customer sees) and the label for integration (the key in the order's "Additional details") can be held separately.
Defaults per destination
| Destination | Delivery date label | Date format | Delivery time label | Note |
|---|
| NextEngine | delivery_date | YYYY/MM/DD | delivery_time | On the NextEngine side, the “order slip import setting” (main feature 2-3) is needed |
| Openlogi | openlogi_delivery_date | YYYY-MM-DD | openlogi_delivery_time_slot | No setting needed on the Openlogi side |
| Ship & Co | shipandco-配達希望日 | YYYY-MM-DD | shipandco-配達希望時間帯 | For the time slot choose the value of each carrier |
| GoQSystem | deliveryDate | YYYY-MM-DD | deliveryTime | |
- The values are written as the key and value of the order’s “Additional details”. The destination refers to this key in its import settings.
PROC-K1 Set it to match the destination
Where: App left menu "Connect(Pro Plan)" > "Format Settings for Integration Format" > "Start to custome settings"
Steps:
1. Open the left menu "Connect(Pro Plan)" and activate the Pro plan (you move to the approval screen)
2. In "Format Settings for Integration Format", turn ON "Start to custome settings"
3. In "Settings for Integration Format" ("Setting up Integration Format") choose the destination. The labels and formats are filled in automatically
4. Change "Connect Label" and "Connect Format" as needed. To combine date and time, enable "Concat Delivery Date & Time"
5. When groups or delivery methods are used, set the same destination in each of their settings too (K-4)
6. Save with "Save" at the top of the screen and reflect it on the online store
7. Do the settings on the destination side (NextEngine, etc.)
QA (external system integration)
- Q: The delivery date is not imported into NextEngine. A: Check that on the NextEngine side the “order slip import setting” refers to
delivery_date / delivery_time. On the app side, check that “NextEngine” was chosen as the destination and saved / reflected. Also ask them to see whether delivery_date is in the order’s “Additional details”.
- Q: I want to change the date format (example: YYYYMMDD). A: It can be changed with “Connect Format” (K-3).
- Q: I want to make the date and time one value. A: Enable “Concat Delivery Date & Time” (K-5).
- Q: The destination differs per group. A: You can choose the destination in each group’s settings (K-4).
- Q: I want to integrate with Logiless. A: There is no “Logiless” among the destination choices (K-2). In Logiless’s admin “attribute value of the order memo”, set the item name (label) that this app writes into the order’s “Additional details”. Point to the human-facing manual “Integration with Logiless” for the steps.
- Q: I want to integrate with Ship & Co. A: Choose “Ship & Co” in the integration settings and save (K-2). Ship & Co’s own setup pages may change, so if a link is broken, guide only the steps of this choice.
- Q: I want to change the date format imported into microLogi (yyyymmdd, etc.). A: It can be changed with “Connect Format” (K-3).
- Q: Can it integrate with BOSS (Hungreed) or CrossMall? A: This app does not integrate with them. BOSS has been confirmed not to import the order’s “Additional details” (order.customAttributes) (a past check). There is no official integration with CrossMall. Ask them to check on the destination side whether it can import “Additional details”.
- Q: In NextEngine the delivery time goes into the “remarks field” instead of “delivery time”. A: If
delivery_time is in the order’s “Additional details”, it is a problem with NextEngine’s import settings. Ask them to check NextEngine’s “order slip import setting”.
- Q: When imported into NextEngine the carrier automatically becomes Yu-Pack. A: How the carrier is decided depends on NextEngine’s settings. Ask them to check on the NextEngine side the conditions under which it becomes Yu-Pack after import. What this app writes are items such as the delivery date and time.
- Q: The fulfillment information (carrier, inquiry number) shipped from NextEngine does not appear in Shopify. A: Outside the scope of this app’s features (the fulfillment integration from NextEngine to Shopify). Ask them to check the settings on the NextEngine side.
- Q: An item of the destination collides with the item name of a subscription app (delivery_date). A: Change “Connect Label” to another name (K-3 / X-4).
ESCALATE
| Situation | Information to request |
|---|
| Delivery options are not shown/hidden | Store URL, the value of __ccSlot in the order’s “Additional details”, the screen of the checks set, the rate names of Shopify’s shipping profile, whether dynamic checkout is used |
| An error occurs when updating the settings | The wording of the error screen, the number of Shopify’s “Customized delivery” |
| The delivery date and time are not imported into the destination | Destination name, a screenshot of the order’s “Additional details”, the app’s integration settings screen, the import settings on the destination side |
| Want to match a format the destination does not list | The destination’s import specification (key names, date and time formats). It is an individual setting, so draft an inquiry to the developer |
SEE
