- v1.0.0-latest-prod
See main Shipping Service Docs for service features.
POST /rate
Retreive a shipping rate quote for a specific shipping method.
POST /rates
Get a list of shipping rates for a fulfillment order.
POST /label/status
Retrieve information about whether a label can be printed or has been printed for this fulfillment.
POST /label/purchase
Purchase a shipping label from an existing rate quote.
POST /label/reprint
Reprint a shipping label that has already been purchased.
| Old Property | New Property | Description | Old Module |
|---|---|---|---|
broadleaf.ship.fixed.configPath |
broadleaf.shipping.service.fixed.configPath |
Path to configuration file for fixed fulfillment options. |
CartOps |
broadleaf.ship.banded.configPath |
broadleaf.shipping.service.banded.configPath |
Path to configuration file for banded fulfillment options. |
CartOps |
broadleaf.ship.virtual.configPath |
broadleaf.shipping.service.virtual.configPath |
Path to configuration file for virtual fulfillment options. |
CartOps |
Ensure any json configuration files for the included shipping providers (fixed, banded, virtual) are available to Shipping Services. Those shipping provider configs were used by CartOps in previous releases.
New permissions are needed for the CartOps client to be able to access Shipping Services. The OpenApi client also needs permissions for the "Try it out" feature. Permissions and scopes can be added via admin or sql script.
| Auth Server | Service | Service ID | New Scopes | New Permissions |
|---|---|---|---|---|
Services |
Cart Ops Service Client |
cartopsclient |
SHIPPING_RATES |
READ_SHIPPING_RATES |
Admin |
OpenAPI Client |
openapi |
SHIPPING_RATES, SHIPPING_LABEL |
ALL_SHIPPING_RATES, ALL_SHIPPING_LABEL |