Introduction to the Blue Yonder WMS Integration

Blue Yonder WMS (formerly known as Blue Yonder Discrete) is a warehouse management system that can be integrated with the MetapackMetapack Shipping SOAP API v5.

Important

This integration cannot be used with the Metapack REST Shipping API.

Which versions of Blue Yonder WMS are covered by this integration?

  • 2016 9.1.2-9.1.4

  • 2017-2017.2

  • 2018-2018.2

  • 2019

What does this integration cover?

  • Rate shopping

  • Outbound and return labels at packing benches

    • PDF and ZPL labels

    • Home, business, and PUDO service options

    • Imperial and metric measurement units

  • Customs documentation

  • Multi-parcel support

  • Consignment deletion

  • End-of-day manifesting, including printing a manifest document

What does this integration not support?

What are the benefits of this integration?

  • Provides access to the Metapack label library.

  • Enables you to pick by carrier/service level.

  • Uses the Metapack allocation engine to determine best carrier through the fulfilment process.

Which shipping workflows are supported by this integration?

  • Rate shopping (at pick) is optional. If activated, you can use the response to pick by carrier and to validate any data errors, such as weight or postcode errors, before you get to a packing bench.

  • Consignments are marked as “ready to manifest” at label printing.

  • If you ship multi-parcel consignments, the integration will use the appendParcelsToConsignments method of the Shipping SOAP API. This method is not supported by all carriers, so a new consignment is created if the method fails.

  • Manifest documents (optional).

Are there any constraints or assumptions that affect how this integration works?

When rate shopping, the exact number of parcels and parcel weight and dimensions might not be known, so the integration assumes a single order until a consignment gets to a packing bench.

Which Shipping SOAP API methods are supported this integration?

Service

Method

Description

Allocation

despatchConsignmentWithBookingCode

Allocate a consignment to the selected carrier and returns the label.

deallocate

Deallocate a consignment prior to its deletion.

findDeliveryOptionsWithBookingCode

Find the cheapest costs and associated delivery options for a proposed consignment if a particular booking code was used.

Consignment

appendParcelsToConsignment

Add additional parcels to an existing consignment (if carriers support it).

createPaperworkForCarton

Create the label and other documents for an appended parcel.

createPaperworkForConsignments

Reprint all documents for a consignment.

deleteParcelFromConsignmentWithCartonId

Delete an individual parcel from a consignment.

deleteConsignment

Delete a consignment.

Manifest

createManifestForFutureDespatch

Add “ready-to-manifest” consignments to a post-dated manifest and clear the consignments from the current transactional flow.

createManifestAsPdf

Create a printed manifest.

What must I do before I acquire this integration?

  • Determine whether the use-cases and workflows supported by the integration meet your requirements.

  • Determine whether your version of the Blue Yonder WMS is supported by the integration.