Integration: A Typical Implementation - ChrisMavrommatis/Binacle.Net GitHub Wiki

Integrating Binacle.Net requires custom development or the creation of a module within your backend system. Here’s a detailed implementation process:

1. Set Up Binacle.Net

  • Run Binacle.Net: Deploy the Binacle.Net Docker image on your infrastructure. If you have multiple environments for testing, you can use a single instance of Binacle.Net, provided the presets are consistent across environments.
  • Configure Presets: Customize your bin presets according to your packaging requirements. Follow the guide on Customizing Presets to define the dimensions and capacities of the bins you will be using.

2. Add Locker Shipping Provider

  • Integration: Implement the locker provider's APIs. This typically includes calls for locker availability, shipment orders, and displaying lockers as pins on a map for user selection.
  • UI/UX Design: Clearly present the locker shipping option to users at checkout, with appropriate messaging about availability and conditions for using locker shipping.

3. Import Product Dimensions

  • Data Management: Import and manage product dimensions in your backend system, ensuring that dimensions are accurate and consistently formatted as 3D rectangles (length, width, height).
  • Automation: Automate the measurement entry process to minimize errors and maintain consistency across your inventory.

4. Call Binacle.Net at Checkout

  • API Call: When a user visits the checkout page, make an API call to Binacle.Net with the dimensions of the items in the cart. This call will determine if the items fit into the available bins.
  • Consider Weight Limitations: If the Locker provider has weight limitations on the lockers you can perform a quick check to determine if the items in the cart exceed the weight limits before calling Binacle.Net.
  • Response Handling: Based on the response from Binacle.Net, enable or disable the locker shipping option. If the items do not fit into the bins, disable the locker option and provide alternative shipping methods. Optionally, store the response from Binacle.Net for use during order completion.

5. Order Completion

  • Shipping: Use the stored response after the user finalizes their order to determine which locker to ship to. This ensures that the correct locker is reserved and ready for the shipment.
  • Order Confirmation: If the provider notifies you about the locker details upon order completion, include the locker assignment details in the order confirmation email sent to the customer, ensuring they are informed about the delivery method and locker location. If the locker provider notifies the customer directly, ensure this process is seamless to provide a pleasant experience.

By following these steps, you can effectively integrate Binacle.Net into your system, enhancing your shipping and packaging operations.