Class ShippingResource

Index

Constructors

Methods

getOptions getPickupLocations getProductOptions

Constructors

constructor

new ShippingResource(http: HttpClient): ShippingResource
Parameters
- http: HttpClient
Returns ShippingResource
- Defined in services/api/packages/storefront-sdk/src/resources/shipping.ts:5

Methods

getOptions

getOptions(params: ShippingOptionsParams): Promise<ShippingOption[]>
Get shipping options for a cart or postal code
Parameters
- params: ShippingOptionsParams
Returns Promise<ShippingOption[]>
- Defined in services/api/packages/storefront-sdk/src/resources/shipping.ts:18

getPickupLocations

getPickupLocations(params?: { cartId?: string }): Promise<PickupLocation[]>
The warehouses/stores the customer may pick goods up at. Pass a cartId to get an advisory per-location stock availability for the cart's lines. Pair with shipping options of type pickup-instore / pickup-warehouse; send the chosen location's id as pickupWarehouseId on cart.setShipping.
Parameters
- Optionalparams: { cartId?: string }
Returns Promise<PickupLocation[]>
- Defined in services/api/packages/storefront-sdk/src/resources/shipping.ts:13

getProductOptions

getProductOptions(
sku: string,
params: { countryCode?: string; postalCode: string; quantity?: number },
): Promise<ShippingOption[]>
Get shipping options for a specific product
Parameters
- sku: string
- params: { countryCode?: string; postalCode: string; quantity?: number }
Returns Promise<ShippingOption[]>
- Defined in services/api/packages/storefront-sdk/src/resources/shipping.ts:26