Installation

Part of the Bring Shipping documentation. Next: Configuration.

Before you start: your Bring access

The add-on uses your own Bring access. You need three things:

1. A Mybring user. Register at mybring.com if you have none. A user dedicated to the API is fine.
2. An API key for that user. Create it on the Mybring API page (Mybring > Settings > API). The key works together with the user’s e-mail address. If you change or delete the key, enter the new one on the Connection page.
3. A Bring customer number linked to the user. Your company gets the customer number from Bring with its agreement. In Mybring > Customer numbers and rights, give the user access to the number with:
   • the booking right (needed to book shipments),
   • the financial right (needed for your agreement prices at the checkout; without it, Bring returns list prices).

For testing, Bring offers test customer numbers: 5 for Parcel Norway domestic and 6 for Parcel Sweden, Denmark, Finland and cross-border. To get access, write to [email protected] (Norway) or [email protected] (Sweden, Denmark, Finland) and ask for the test customer number with financial rights. Use dummy phone numbers and e-mail addresses in test orders: real ones can still trigger Bring notifications.

Install

1. Download the add-on package (kv_bring-1.0.0.zip).
2. In the admin panel, go to Add-ons > Manage add-ons, click the gear icon, choose Manual installation, and upload the zip.
3. Bring Shipping installs active. It adds four shipping services (Pickup Parcel, Home Delivery, Home Mailbox Parcel and Business Parcel), the Orders > Bring shipments page, and a Bring tab on the order page.
4. Enter your license key in the add-on settings, on the License tab. If you bought on the CS-Cart Marketplace, the Marketplace license number entered on install is enough.

First test (about 10 minutes)

1. Open Orders > Bring shipments > Connection. Choose your sender country and Test mode.
2. Under Test mode, enter the Mybring login (the e-mail address), the API key and the customer number (your own, or the test customer number 5 or 6).
3. Enter the sender address and a phone number. Bring requires the sender phone for outgoing services.
4. Click Save and test. The result line shows the customer numbers your user may use.
5. To use Bring prices, make sure the currency of the answer exists in your store: NOK for Norway, SEK for Sweden, DKK for Denmark. Add it under Administration > Currencies with a correct rate. It can stay hidden on the storefront.
6. Create a shipping method with a Bring service (see Configuration), place a test order with a Norwegian address, and book it from the order’s Bring tab. A test booking is marked Test, and Bring returns a label but creates no shipment.
7. When the labels look right, switch the connection to Live, enter the live customer number, and click Save and test again.

Cron

The job queue (automatic bookings, tracking, lookups) runs from cron. Add one of the two lines shown in the add-on settings (Cron row) to your server’s scheduler, every 5 to 15 minutes:

• php /path/to/store/admin.php --dispatch=kv_bring.cron
• or the secret web address shown there.

Uninstall

Uninstalling removes the add-on’s tables, settings and shipping services, including the shipping methods that use them. Bookings already made at Bring stay at Bring, and you can still see them in Mybring.

Updating

Upload the new zip the same way. The add-on brings its database and settings up to date on the next admin page view; your connection and bookings are kept.