Build delivery profiles
You can use delivery profiles to manage advanced shipping information in Shopify. Shops that use delivery profiles gain the ability to create shipping rates per product variant and location.
This guide shows you how to manage delivery profiles for pre-orders and Try before you buy (TBYB).
Requirements
Anchor link to section titled "Requirements"- Your app can make authenticated requests to the GraphQL Admin API.
Your app has the following access scopes:
write_products
read_all_orders
read_customer_payment_methods
read_purchase_options
write_purchase_options
read_payment_mandate
write_payment_mandate
Learn how to configure your access scopes using Shopify CLI.
You've completed the Create and manage pre-orders and TBYB options guide.
Step 1: Create delivery profiles
Anchor link to section titled "Step 1: Create delivery profiles"A delivery profile is a set of shipping rates scoped to a set of products or variants that can be shipped from selected locations to zones. You can associate the DeliveryProfile
with the SellingPlanGroup
object to do the following tasks:
- Set free shipping for all orders with pre-orders or TBYB
- Restrict shipping to specific countries
- Set a flat shipping rate by country for all orders with pre-orders or TBYB
Set free shipping
Anchor link to section titled "Set free shipping"You can set free shipping for all orders with a pre-order or TBYB. The following example uses the deliveryProfileCreate
mutation to set free shipping.
Restrict shipping to specific countries
Anchor link to section titled "Restrict shipping to specific countries"You can restrict pre-orders and TBYB shipping to specific countries regardless of which delivery zones you have configured in the Shopify admin. The following example restricts shipping to North America (Canada, United States, Mexico):
Set a flat shipping rate by country
Anchor link to section titled "Set a flat shipping rate by country"You can set a flat shipping rate by delivery zone for all orders with pre-orders and TBYB. The following example defines free shipping to Canada and defines a $15.00 flat shipping rate for the rest of the world:
Step 2: Retrieve delivery profiles
Anchor link to section titled "Step 2: Retrieve delivery profiles"You can use the deliveryProfiles
query to retrieve a list of delivery profiles.
The following query returns a delivery profile with its ID, name, and default setting. Product variants stay in the default profile until they are added to another delivery profile. The example response indicates that the default profile is returned.
Step 3: Update delivery profiles
Anchor link to section titled "Step 3: Update delivery profiles"You can use the deliveryProfileUpdate
mutation to update existing delivery profiles. The following example adds the United States delivery zone:
Step 4 (Optional): Remove a delivery profile
Anchor link to section titled "Step 4 (Optional): Remove a delivery profile"You can asynchronously remove a delivery profile by using the deliveryProfileRemove
mutation, and passing in the ID of the delivery profile that you want to remove. The response returns a job ID that you can use to check on the job status and determine whether the operation is complete:
- If
done
istrue
, then the removal of the delivery profile has completed. - If
done
isfalse
, then removal of the delivery profile is still in progress.
- Learn how to set up required access scopes and pages for your pre-orders and TBYB app.