Salesforce Docs Portal

Configuring & Printing Shipping Labels via Point of Sale SPI

Select and integrate various shipping services, configure prepopulated item weights and box dimensions, and create multiple boxes during packing.

Point of Sale's SPI offers integration capabilities for shipping aggregators. This extensible solution allows merchants to select and integrate various shipping services, including options like ProShip. With this feature, merchants can configure to have prepopulated item weights and box dimensions or make selections during the app flow. Additionally, merchants can create multiple boxes as needed during the packing process.

This feature is available for Buy Online, Fulfill In-Store (BOFIS), Store to Store (STS) Transfer, Return to Vendor (RTV) Transfer, and Corporate Transfer (CTS) order flows.

Prerequisites

  • Modern POS App Build:
    • 9.7.1 and later for BOFIS flow
    • 9.8.1 and later for STS/RTV flows and label generating via deep link
    • 10.4.1 and later for CTS flows
  • Platform Support: iPhone & iPad
  • Offline Support: No

Set up Point of Sale CMS for Configuring and Printing Shipping Labels

Configure Point of Sale CMS to generate and print shipping labels. Select applicable flows and configure a deep link to generate shipping labels outside defined flows.

Selecting Applicable Flows

You can multiselect which flows to turn on this feature.

  1. Go to Store Management > Store Settings > Store Fulfillment.
  2. Expand Shipment.
  3. Edit Shipment Aggregation.
  4. Turn on applicable flows. A window showing Shipment Aggregator Settings in Point of Sale CMS

Set Box Dimensions

Add and configure a list of available shipping boxes on the POS app.

  1. Go to Advanced > Shipping Packages Configuration.
  2. Select Create in the upper right.
  3. Under General Settings, enter the package details, which include the barcode ID and any relevant notes.
  4. Under Package Dimensions provide the package's length, height, and width measurements. The Edit Package section on the Shipping Packages Configuration screen in Point of Sale CMS. Edit a package's dimensions, name, and barcode ID.
  5. After the configuration is saved, the list of shipping boxes on the main screen will be automatically sorted alphabetically in the CMS. The same sorting applies to the POS app, but only for app builds 10.8.1 or greater.List of packages sorted and ready for shipping.

SPI Integrations

To receive the shipping options, shipping method, and shipping label, configure the SPIs. The diagram illustrates the Buy Online, Fulfill in Store (BOFIS) flow in relation to the Shipping Options and Shipping Labels SPIs.

The BOFIS flow in relation to the shipping options and shipping label SPIs diagramed.

This SPI is required for enabling shipping aggregators.

  1. Go to Integrations > Customer Connectors.
  2. Create a connector by selecting Create in the upper right.
  3. Under Connector Type, select "SPI".
  4. Under Endpoint Name, select "SHIPPING_OPTIONS".
  5. Configure the rest of the fields by referring to Point of Sale API, SPI, and Webhook Specs.
  6. Save your changes.The Custom Connection Configuration section in Point of Sale CMS that shows the Shipping Options endpoint.

Shipping Methods

This SPI is required to enable cart flows. If "Enable External Shipping Provider" is enabled, the SPI must be set up and integrated along with the Shipping Options and Shipping Labels SPIs. If the flag is disabled, only the Shipping Options and Shipping Labels SPIs are needed. In this case, Point of Sale will use the shipping methods configured in CMS during the checkout flow and external shipping methods during the shipment flow.

This SPI is required for enabling shipping aggregators.

  1. Go to Integrations > Customer Connectors.
  2. Create a connector by selecting Create in the upper right.
  3. Under Connector Type, select "SPI".
  4. Under Endpoint Name, select "SHIPPING_OPTIONS".
  5. Configure the rest of the fields by referring to Point of Sale API, SPI, and Webhook Specs.
  6. Save your changes.The Custom Connection Configuration section in Point of Sale CMS that shows the Shipping Methods endpoint.

Shipping Label

This SPI is required for retrieving and printing shipping labels.

  1. Go to Integrations > Customer Connectors.
  2. Create a connector by clicking Create in the upper right.
  3. Under Connector Type, select "SPI".
  4. Under Endpoint Name, select "SHIPPING_LABEL".
  5. Configure the rest of the fields by referring to Point of Sale API, SPI, and Webhook Specs.
  6. Save your changes.The Custom Connection Configuration section in Point of Sale CMS that shows the Shipping Methods endpoint.

Configure and Print Shipping Labels for BOFIS Orders

Initiate the Buy Online, Fulfill In-Store (BOFIS) flow on the Point of Sale (POS) app, pack items into multiple boxes, and generate shipment labels with predefined box options to complete the fulfillment process.

Packing Items

Initiate the BOFIS flow on the POS app and select the New Orders deep link.

The New Orders deep link in the POS app.

Locate the order and tap Pack to the right of it. You'll be directed to the order details screen, which lists the items to be packed.

The Pack button next to the order in the POS app.

During the pack flow, you can pack multiple boxes by scanning or selecting items. Tap Pack Box and the selected items and quantities will be moved into a sequential box (for example Box 1, Box 2) and be shown at the bottom of the screen. To pack the next box, repeat the process by scanning or selecting the items and tap Pack Box again. Boxes can always be unpacked by tapping Unpack this box.

Items listed as to be packed and already packed, y box, in the POS app.

After all items are packed in boxes, tap Complete Packing. If there are any products not selected during packing, you will have to select a Reason Code and then proceed with a refund or cancellation flow.A window in the POS app where you can select a reason that you're unpacking the box.

Generating Shipment Label

To ship packed boxes, tap the Store Fulfill Orders Ready to Ship deep link.The drrp link that allows you to start generating a label.

Locate the order and tap Ship to the right of it.

The Ship button next to the order in the POS app.

On the next screen, the number of boxes is shown on the list of ready-to-ship orders. Tap Generate Label.

The POS app showing the option to generate a label or enter tracing for an order.

The window shows. At the top is a dropdown with the option to select predefined boxes. The window also allows editing of weight and dimensions.

Select and configure the shipping box information in the POS app.

Tap Done and the next screen allows you to select a shipping option.

A window in the POS app where you select shipping options for an order and select Confirm.

Select Confirm and you can print the shipment label.

Completing Order

After the shipment label has been generated and printed, complete the order by adding a tracking number.

A window where you enter the tracking number of the order and select Done in the POS app.

Scanning or entering the tracking number marks that box as shipped. If multiple boxes are to ship, the order status changes to Partially Shipped. After all boxes are designated as shipped, the order status changes to Shipped.

Order History

Tap the Store Fulfilled Order History deep link to view a list of shipped orders. This list can be filtered by order number, customer phone number, or customer name.

The Order History deep link in the POS app.

Access an order to view its packed boxes, and explore each box's contents.

BOFIS order details showing in the POS app.

Configure and Print Shipping Labels for Store-to-Store, Return to Vendor, and Corporate Transfers

Scan and pack items for Store to Store (STS) Transfer, Return to Vendor (RTV) Transfer, and Corporate Transfer (CTS) in the Point of Sale (POS) app. View transfer details, add a tracking number, and print a packing slip.

For STS, RTV, and CTS flows, after all items are scanned and packed, you can tap Close Transfer and you'll see the option to generate a shipping label.

The Generate Shipping Label option in the Print Packing Slip window on the POS app.

After generating a label, the app updates the transfer's status to Shipped. The app displays a successful message along with a tracking number. Tap OK to view the list of transfers.

The Order Shipped window with the order ID number and tracking number in the POS app.

On the transfer list, you can view the details of a shipped transfer along with the options to generate a label, add a tracking number, or print a packing slip.

The Shipping Options window in the POS app, where you can generate a abel or add a tracking number.

You can update the tracking number, and the transfer reflects this change, visible on both the transfer list screen and in the transfer details.

The Add Tracking Number window in the POS app.The Successfully Shipped window in the POS app.