Shipping pipelines

Current version: 10.2

GetShippingOptions pipeline

Name:

GetShippingOptions

Description:

The pipeline is responsible for performing a search against all shipping options in the external commerce system.

Usage:

Called via the GetShippingOptions method on the Connect API when searching for shipping options.

Args:

Request - Contains the search criteria: Cart. Is set prior to calling the pipeline.

Response - Contains a collection of ShippingOption and LineShippingOption objects. Is read after the pipeline is executed.

Processors:

No default processors

GetShippingMethod pipeline

Name:

GetShippingMethod

Description:

The pipeline is responsible for performing a query against the ECS to retrieve full details for a shipping method in the external commerce system.

Usage:

Called via the GetShippingMethod method on the Connect API when requesting details for a shipping method.

Args:

Request - Contains the search criteria: ShopName and ExternalId (Shipping method ID).

Response - A ShippingMethod object. Is read after the pipeline is executed.

Processors:

No default processors

GetShippingMethods pipeline

Name:

GetShippingMethods

Description:

The pipeline is responsible for performing a search against all shipping methods in the external commerce system.

Usage:

Called via the GetShippingMethods method on the Connect API when searching for shipping methods.

Args:

Request - Contains the search criteria: ShippingOption, Party. Is set prior to calling the pipeline.

Response - Contains a collection of ShippingMethod objects. Is read after the pipeline is executed.

Processors:

No default processors

GetPricesForShipments pipeline

Name:

GetPricesForShipments

Description:

The pipeline is responsible for getting the shipment pricing for a cart and a select group of shipping and methods and options from the external commerce system.

Usage:

Called via the GetPricesForShipments method on the Connect API when searching for shipping methods.

Args:

Request - Contains the search criteria: ShopName, ShippingLookups, and Cart. Is set prior to calling the pipeline.

Response - Contains a list of ShippingPrice objects. Is read after the pipeline is executed.

Processors:

No default processors

Do you have some feedback for us?

If you have suggestions for improving this article,