Skip to content
English
  • There are no suggestions because the search field is empty.

Set up the Webshipper integration

Connect Webshipper to Sprii Checkout for one Page, and choose how your orders reach it.

What it does

Webshipper receives orders placed through Sprii Checkout on this Page. You can send them automatically when payment arrives or send an individual order yourself. Print the carrier labels in Webshipper.

Requirements

  • Administrator access to the Sprii Page
  • Sprii Checkout set up on the Page. See Set up Sprii Checkout.
  • Access to your Webshipper account and permission to create an API token
  • An order channel in Webshipper with your shipping rates configured. Sprii reads the available channels; saving credentials does not create one. If you need a channel, open Connect > Order channels > New order channel, select Custom and click Connect in Webshipper. Name it Webshipper API, or use a name you will recognize in Sprii. See Webshipper's custom order channel guide.
  • Prepare the channel's rates using your connected carrier agreement. In Connect > Order channels, open your channel and click Create shipping rate. Choose the outgoing carrier service, set its delivery countries and prices, then click Create shipping rate or Update shipping rate. See Webshipper's shipping-rate guide.

Connect Webshipper

  1. In Sprii, select your Page and go to Page settings Page settings selected in the Sprii menu > Sprii checkout > Shipping Shipping tab under Page settings > Sprii checkout
  2. Find Webshipper and click Configure.

    Webshipper shipping card with Configure
  3. Click Activate shipping Activate shipping button if it is inactive.
  4. Enter a Title, such as Delivery.

    Empty shipping Title field
  5. Log in to Webshipper and look at its address in your browser. Enter the part before .webshipper.io in Sprii's Account Name field. For example, if the address is sprii_demo.webshipper.io, enter sprii_demo.
  6. In Webshipper, go to Settings > Access and tokens, then click Create API token at the top right. For this Sprii connection, set the token to never expire and select all scopes.
  7. Click Save in Webshipper. Copy the token that appears and paste it into Token in Sprii.

    Empty Webshipper Account Name and Token fields
  8. Click Save Save button in Sprii to store the credentials. If required terms are shown, accept them before saving.
  9. Reopen Configure if the settings closed. Allow approximately three minutes for a newly prepared channel to become available, then click the circular refresh icon in Order Channel to fetch the list. This is an approximate wait for Webshipper, not a Sprii timer.
  10. Choose Webshipper API when it appears. If your channel has a different name, choose the channel you prepared for Sprii. If it is missing, check the channel in Webshipper and refresh again.

    Webshipper Order Channel picker with refresh control

Choose the options and save

  1. Set Freight SKU only if your Webshipper setup needs a particular SKU for the delivery line. Otherwise, leave it blank.

    Empty Freight SKU field in Webshipper configuration
  2. Choose how orders should be sent:
    • Export order when paid sends an order automatically when Sprii receives its payment event. Select it for automatic export; leave it off to send individual orders yourself. Export order when paid option selected
    • Patch after create (advanced) sends a second update immediately after Sprii creates the Webshipper order, using the latest Sprii order data. Enable it only if your integration setup requires that extra update. Patch after create option unselected
    • Add tax to shipping price adds tax to the delivery rates returned by Webshipper. Select it if those rates exclude tax; leave it off if they already include tax. Add tax to shipping price option selected


    The pictures illustrate the controls. Choose each setting for your own setup.
  3. Click Save Save button to store the selected channel and options.

These settings belong to the Page. Changing the channel does not move orders already sent to Webshipper. An order you send later uses the channel saved at that time.

Send an individual order

If automatic export is off, open the order in Orders Orders selected in the Sprii menu and use Create label in its Webshipper shipping controls to send it to Webshipper. Despite the button's name, print the carrier label in Webshipper.

Check the payment transaction before dispatching the order. Manual export does not require the order to have been paid.

In Webshipper, open the exported order. If a shipment already exists, open its Shipment ID to download or print the label. Otherwise, when the order is ready to ship, use Send Order, then open the resulting Shipment ID. Send Order processes the shipment and can send tracking emails and trigger enabled automatic fulfillment. Check for an existing shipment before sending the order again. See Webshipper's order and shipment guide.

Limitations

Important: Completed does not prove that the shopper paid. Sending an order to Webshipper can move it to Completed without confirming payment.

  • Batch export is unavailable for Webshipper. Use automatic export or send orders one at a time.
  • Configure delivery rates in Webshipper. This Sprii form has Title and Freight SKU, rather than a shipping-cost or free-shipping-threshold field.
  • This integration is for Sprii Checkout. Webshop-checkout campaigns use the webshop's delivery setup.


Need help? Contact Sprii Support