-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
DEVDOCS-6123 [new]: Shipping / MSF International Enhancements, add ch…
…annels (#556)
- Loading branch information
1 parent
7b62e73
commit 9669d08
Showing
1 changed file
with
75 additions
and
0 deletions.
There are no files selected for viewing
75 changes: 75 additions & 0 deletions
75
docs/store-operations/shipping/msf-international-enhancements.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
# Shipping - International Enhancements for Multi-Storefront | ||
|
||
When you sell internationally or to multiple customer segments, you may want the available shipping methods for a shipping zone to depend on the shopper's region or segment. | ||
|
||
To localize your storefront, you can have zones that display different methods depending on the storefront channel. | ||
When you create a method for a zone, specify which storefront channel(s) you want a shipping method to appear. Shoppers will only see the shipping method for the zone if it applies to a channel. | ||
|
||
## Limitations | ||
|
||
You can't assign the following to a specific channel: | ||
- The free shipping method on [static shipping quotes](https://support.bigcommerce.com/s/article/Shipping-Methods#static). | ||
- [Pickup methods](/docs/integrations/buy-online-pick-up-in-store#pickup-methods-api) on stores using Buy Online Pickup in Store. | ||
|
||
We don't support multiple accounts of the same carrier (e.g., using distinct accounts for UPS). | ||
|
||
## Settings | ||
|
||
Shipping methods have a `channels` setting. This setting determines which channels can display the shipping zone's method. Shipping methods are available on all channels by default. | ||
|
||
For reference, see the [Shipping method](/docs/rest-management/shipping-v2/shipping-method) endpoint of the REST Management API. | ||
|
||
## Example | ||
|
||
The following example creates a shipping method in a zone by sending a request to the [Create a shipping method](/docs/rest-management/shipping-v2/shipping-method#create-a-shipping-method) endpoint. | ||
|
||
<Tabs items={['Request', 'Response']}> | ||
<Tab> | ||
|
||
```http filename="Example request: Create a shipping method for a zone" showLineNumbers copy | ||
POST https://api.bigcommerce.com/stores/{{store_hash}}/v2/shipping/zones/{{zone_id}}/methods | ||
X-Auth-Token: {{ACCESS_TOKEN}} | ||
Accept: application/json | ||
Content-Type: application/json | ||
{ | ||
"name": "Per Order", | ||
"type": "perorder", | ||
"settings": { | ||
"rate": 8 | ||
}, | ||
"enabled": true, | ||
"handling_fees": { | ||
"fixed_surcharge": "3" | ||
}, | ||
"channels": [1, 3] | ||
} | ||
``` | ||
|
||
</Tab> | ||
<Tab> | ||
|
||
```json filename="Example response: Create a shipping method for a zone" showLineNumbers copy | ||
{ | ||
"id": 5, | ||
"name": "Per Order", | ||
"type": "perorder", | ||
"settings": { | ||
"rate": 8 | ||
}, | ||
"enabled": true, | ||
"handling_fees": { | ||
"fixed_surcharge": "3" | ||
}, | ||
"channels": [1, 3] | ||
} | ||
``` | ||
|
||
</Tab> | ||
</Tabs> | ||
|
||
|
||
## Additional resources | ||
|
||
- [Introduction to Multi-Storefront](/docs/storefront/multi-storefront) | ||
- [Shipping methods](/docs/rest-management/shipping-v2/shipping-method) endpoint reference |