To build a Buy Online, Pick up in Store solution, you must first create a location for pickup. You can then manage inventory for a location, configure inventory settings such as stock warning levels. Last, you must create a method for pickup. You can define collection instructions and assign the method to a location.
Create one or more locations using the Create locations endpoint. Include a pickup location from which customers can pick up their orders.
After you create a location, you can update its details using the Update locations endpoint.
After you create one or more locations, use the Get locations endpoint to retrieve location details.
Buy Online, Pick up in Store uses the Inventory API to manage inventory quantities in two ways:
Before setting inventory quantity to a location, check the inventory tracking configurations that have been enabled. There are three inventory tracking configurations:
It’s important to know the type of tracking when making absolute or relative adjustments, as this will ultimately determine how you author your API request to set inventory quantity.
You can make absolute adjustments for inventory tracked by product. To make absolute adjustments, send a request to the Absolute adjustment endpoint.
You can make absolute adjustments for inventory tracked by variant.
You can make relative adjustments to inventory tracked by product. To make relative adjustments, send a request to the Relative inventory adjustments endpoint.
You can also make relative adjustments to inventory tracked by variant.
In addition to making absolute or relative adjustments to inventory quantities, other inventory settings can also be set, including:
inventory_warning_level attribute in the Catalog APITo do so, send a request to the Update inventory settings for a location endpoint.
You can configure inventory settings for inventory tracked by product.
You can configure inventory settings for inventory tracked by variant.
At this point you may want to view inventory by location. To do so, send a request to the Get inventory at a location endpoint.
Alternatively, you can view aggregate inventory information for a product, across all locations that stock it. Send a request to the Get inventory at locations endpoint and filter by product_id, variant_id, or sku.
Once locations have been created, you can create pickup methods and assign them to a location. To do so, send a request to the Create pickup methods endpoint.
Some merchants offer multiple pickup options at a single location. For example, a merchant might offer both in-store pickup and curbside pickup. To achieve this, send a request to the Create pickup methods endpoint to create another pickup method and assign it to the same location.
If you need to update the original pickup method details, you can use the Pickup Methods API. Update any of the following details using the Update pickup methods endpoint:
location_iddisplay_namecollection_instructionscollection_time_descriptionOnce you have assigned the pickup methods to the location(s), you can check what you’ve configured. To do so, send a request to the Get pickup methods endpoint.