Skip to main content
When your warehouse runs PeakWMS, your packers never have to open Zippendo. They pack a parcel in PeakWMS, PeakWMS asks Zippendo for the label, and the label comes out of the printer at the packing table. Zippendo sends the shipment to the carrier, follows the tracking and shows the shipment under Shipments like any other. This tutorial walks through the setup with screenshots. The reference page PeakWMS explains every PeakWMS setting and what to do when something goes wrong.
Nothing is installed in PeakWMS. You create a connection in Zippendo, copy an API token and a few web addresses into PeakWMS, and tell PeakWMS which carrier product each shipping method uses. It takes about twenty minutes, once.

​
Before you start

  • You can change settings in PeakWMS, and you know where its forwarders are. A forwarder is PeakWMS’s name for a shipping company setup.
  • Your webshop is connected to Zippendo, and checkout already shows Zippendo’s shipping methods. See Connect order channels.
  • At least one shipping rule exists in Zippendo.

​
1. Find PeakWMS in Zippendo

In the sidebar, click Apps & integrations, then the Catalog tab. Under Integrations you find the systems that connect to Zippendo and ask it to do something. PeakWMS is one of them, with a Connect button. Read more on the card opens PeakWMS’s own help pages.

​
2. Create the connection

1

Click Connect on PeakWMS

The Connect PeakWMS window asks for a Name and an Account ID (optional).
2

Name the connection after the warehouse

Something like “PeakWMS Køge warehouse”. If you run several warehouses, make one connection per warehouse and name each after its site, so you can tell later which one had a problem.
3

Account ID (optional)

If you plan to fill in an Account ID in PeakWMS, type the same value here. It is a safety net: when the two do not match, Zippendo refuses the request, so a forwarder set up with another warehouse’s web addresses cannot print labels on the wrong connection. You can leave it empty.
Connect PeakWMS window with a warehouse name and an example Account IDConnect PeakWMS window with a warehouse name and an example Account ID

The Connect PeakWMS window

4

Pick a brand (only with brands)

If your organization uses brands, the window also asks for the Brand this warehouse ships for.
5

Click Create connection

You see WMS connection created, and the new connection’s page opens.

​
3. Copy the API token while it is on screen

The connection’s page shows the API token exactly once, right after you create the connection. Click the copy button next to it now, and keep the token somewhere safe until you have put it into PeakWMS.
API token section on the connection page showing the API token once, with a copy buttonAPI token section on the connection page showing the API token once, with a copy button

The API token is shown once, with a copy button

If you leave the page without copying, the token cannot be shown again. Click Replace token to get a new one. The old one stops working the moment you do, so PeakWMS needs the new token before your packers can print again.
The API token only lets PeakWMS create and read shipments. It cannot see your carrier accounts, addresses, orders or billing.

​
4. Copy the web addresses into PeakWMS

Below the token, URLs for your WMS lists one web address for each thing PeakWMS can ask Zippendo to do. Each has its own copy button.
URLs for your WMS section listing Create shipping label, Create return label, QR code label, Tracking, Existing shipment and Label used with copy buttonsURLs for your WMS section listing Create shipping label, Create return label, QR code label, Tracking, Existing shipment and Label used with copy buttons

URLs for your WMS with a copy button next to each address

Now switch to PeakWMS. Everything in this step happens there, on a new forwarder:
1

Create a forwarder

In PeakWMS, add a new Forwarder and set Provider to Generic: the kind of forwarder that sends requests to web addresses you fill in. If you cannot find the screen, PeakWMS’s own help center walks through it. The setup is the same whichever shipping company you use.
2

Paste the web addresses

Copy each address from Zippendo into the PeakWMS field with the same name: Create shipping label (required), Tracking (recommended), and the optional ones you want, such as Create return label, QR code label, Existing shipment and Label used. Leave Cancel shipment empty. Zippendo shows “Not supported. Leave this field blank.” there, because it cannot cancel a label with the carrier.
3

Fill in the sign-in fields

API key is the API token you copied in step 3. Auth scheme is Bearer, which is simply how PeakWMS hands the token over. Account ID is the value you typed in Zippendo in step 2, if you used one.
The full table of forwarder fields, including which ones are optional, is on the PeakWMS page under “Put them into PeakWMS”.

​
5. Set the Host ID on each shipping method in PeakWMS

In PeakWMS, every shipping method has a Host ID. That is how PeakWMS tells Zippendo which carrier, carrier product and shipping rule to use when a parcel is packed. You set it in PeakWMS, on the shipping method itself, not in Zippendo.
1

Copy the Host ID from Zippendo

On the connection’s page in Zippendo, go to Host IDs for your shipping rules. Under Zippendo shipping rule, pick the rule the shipping method should use, then click the copy button next to its Host ID.
Host IDs for your shipping rules with a shipping rule picked and its Host ID next to a copy buttonHost IDs for your shipping rules with a shipping rule picked and its Host ID next to a copy button

Host IDs for your shipping rules: pick a rule and copy its Host ID

2

Paste it as the Host ID in PeakWMS

Open the matching shipping method in PeakWMS and paste the code into its Host ID field. Repeat for each shipping method your webshop offers. A rule for service points needs only this one Host ID, whichever service point your customer picks. There is nothing more to set up in Zippendo.
Changing a rule’s carrier or carrier product changes its Host ID. Zippendo shows the new one in the rule’s editor before you save. Paste it into PeakWMS afterwards, or PeakWMS stops recognizing orders that use the rule.
If a Host ID never matches, or the wrong carrier keeps being used, another app on your webshop may be filling an order field called peak_shipping_code, often a shipping app you used before. Whoever looks after your webshop can turn that app off and empty the field. If you use the service point picker in checkout, Zippendo fills this field too: turn off only the other app.

​
Using your own Host IDs instead

You only need to do anything in Zippendo when the Host ID is a code of your own rather than the one from a webshop order. That is the case when orders are typed straight into PeakWMS, or when you prefer codes like GLS_BUSINESS_PARCEL. In Zippendo, open the connection and go to Host ID mappings. Click Add mapping, type your code under Host ID in the WMS and pick the rule it should use under Zippendo shipping rule. Click Save mappings when the rows are complete. A row without a shipping rule cannot be saved.
Host ID mappings section with a row mapping GLS_BUSINESS_PARCEL to a GLS home delivery shipping ruleHost ID mappings section with a row mapping GLS_BUSINESS_PARCEL to a GLS home delivery shipping rule

A Host ID mapping: GLS_BUSINESS_PARCEL points at a GLS shipping rule for home delivery

​
6. Stop importing orders from that webshop

PeakWMS now owns the orders. If Zippendo kept importing them too, both systems would create shipments for the same order, and you would pay for two labels. Open Order channels, open the webshop, and under What Zippendo is used for turn off Import orders from this webshop.
Order channel settings with the What Zippendo is used for section and the import orders switchOrder channel settings with the What Zippendo is used for section and the import orders switch

Turn off order import on the webshop PeakWMS handles

Shipping prices and service point selection at checkout keep working exactly as before. Only the order import stops, and Zippendo no longer marks orders as shipped in your webshop, since PeakWMS does that now.

​
7. Check it works

Pack one order in your PeakWMS test environment and check three things: the label prints and shows the carrier you expected, the parcel appears under Shipments in Zippendo, and tracking shows up on the order in PeakWMS. Then switch the addresses in PeakWMS to your live setup. Back in Zippendo, the Connected tab under Apps & integrations shows your PeakWMS connection with when PeakWMS last asked for something, or “Not used yet”. When a request failed, it shows the message your packer saw.

​
Pausing or removing the connection

Open the connection by clicking its row on the PeakWMS card. Turn off Allow the WMS to create labels to stop PeakWMS creating labels without deleting anything, and turn it back on when you are ready. Delete connection at the bottom removes the connection and its API token for good. Shipments that were already created stay where they are.
Connection page with the Status section and the Allow the WMS to create labels switch turned onConnection page with the Status section and the Allow the WMS to create labels switch turned on

Allow the WMS to create labels is the switch for pausing a connection

​
Good to know

  • A packer who packs the same order twice does not get two labels. Zippendo hands back the label it already made.
  • Return labels work the same way. The address the parcel comes back to is always the sender address on your shipping rule, so the label is right even if PeakWMS has a different address on file.
  • Dangerous goods are refused rather than shipped without the papers they need. Send those through a different forwarder in PeakWMS.