> For the complete documentation index, see [llms.txt](https://docs.hotwax.co/documents/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hotwax.co/documents/integrate-with-hotwax/journeys/buy-online-pickup-in-store/bopis-pdp-experience.md). # BOPIS PDP Experience Discover HotWax Commerce's BOPIS PDP experience enabling customers to browse all pickup store options for desired products on Shopify's PDP. HotWax Commerce's Buy Online Pick-Up In Store (BOPIS) PDP experience lets customers browse pickup stores that have the selected product available on the Shopify product detail page (PDP). ## Integrate the BOPIS PDP experience ### Step 1: Obtain the customer's latitude and longitude To show available pickup facilities near the customer, the latitude and longitude coordinates of the customer are required. There are two ways to obtain these coordinates: 1. If the customer inputs their postal code, * Use the postcodeLookup API to convert the postal code into latitude and longitude coordinates 2. If the customer allows access to their system location, * Obtain the latitude and longitude coordinates directly from their device #### Sample Method: `POST` **Request** ``` { "json": { "query": "postcode: 10007" } } ``` **Response** ``` { "responseHeader": { "status": 0, "QTime": 2, "params": { "json": "{\"query\":\"postcode:10007\"}" } }, "response": { "numFound": 1, "start": 0, "numFoundExact": true, "docs": [ { "postcode": "10007", "latitude": "40.713858", "longitude": "-74.007777", "country": "USA", "country-code-id": "10007-USA", "location": "40.713858,-74.007777", "_version_": 1752733529047826432 } ] } } ``` ### Step 2: Fetch all stores allowing BOPIS Using the latitude and longitude coordinates, call the storeLookup API to fetch all the facilities within a given distance that allow BOPIS. Note: The distance parameter is configurable to narrow down the search results. You can allow customers to input their preferred distance or set a default value. #### Sample Method: `POST` **Request** ``` { "viewSize": 40, "filters": ["storeType: RETAIL_STORE"], "point": "40.713858,-74.007777", "distance": 50 } ``` **Response** ``` { "responseHeader": { "status": 0, "QTime": 5, "params": { "d": "50", "pt": "40.713858,-74.007777", "fl": "*,dist:geodist()", "start": "0", "json": "{\"filter\":[\"docType: STORE\",\"storeType: RETAIL_STORE\"],\"query\":\"*:*\",\"sort\":\"geodist() asc\"}", "q.op": "AND", "fq": "{!geofilt}", "rows": "40", "sfield": "latlon" } }, "response": { "numFound": 3, "start": 0, "docs": [ { "identifier": "STORE_15", "country": "United States", "docType": "STORE", "externalId": "DC_STORE_15", "storeName": "Facility", "countryCode": "USA", "city": "New York", "latlon": "40.72,-74", "postalCode": "10012", "storePhone": "", "storeCode": "STORE_15", "docType-identifier": "STORE-STORE_15", "stateCode": "NY", "state": "New York", "address1": "10 Times Square", "storeType": "RETAIL_STORE", "_version_": 1735068683092361221, "dist": 0.9465923971374126 }, { "identifier": "STORE_20", "country": "United States", "docType": "STORE", "externalId": "DC_STORE_20", "storeName": "New facility", "countryCode": "USA", "city": "New York", "latlon": "40.72,-74", "postalCode": "10012", "storePhone": "", "storeCode": "STORE_20", "docType-identifier": "STORE-STORE_20", "stateCode": "NY", "state": "New York", "address1": "4 Broadway", "storeType": "RETAIL_STORE", "_version_": 1735068683093409793, "dist": 0.9465923971374126 }, { "identifier": "STORE_9", "country": "United States", "docType": "STORE", "externalId": "DC_STORE_9", "storeName": "Broadway", "countryCode": "USA", "city": "New York", "latlon": "40.72,-74", "postalCode": "10012", "storePhone": "1212555-5555", "storeCode": "STORE_9", "docType-identifier": "STORE-STORE_9", "stateCode": "NY", "state": "New York", "address1": "540 Broadway", "storeType": "RETAIL_STORE", "_version_": 1735068683094458369, "dist": 0.9465923971374126 } ] } } ``` ### Step 3: Check inventory at each store allowing BOPIS Use the [BOPIS Check Inventory](/documents/integrate-with-hotwax/hotwax-commerce-api-and-data-feeds/inventory/bopis-check-inventory.md) API to check pickup availability for the selected product at the stores returned by the store lookup. Send the OMS product store ID, the channel's inventory group ID, and the OMS facility IDs. Identify products with either `productIds` or `internalNames`. An internal name is the value of `Product.internalName` in OMS; do not assume it is the Shopify variant ID or SKU without checking the product mapping. The facility must belong to the product store, a pickup facility group, and the requested channel's inventory group. Pickup must also be allowed for the product at the facility and in any channel-level configuration. Use `computedAtp`, which accounts for safety stock, to display locations with a positive quantity available for pickup. A zero result can include a `decisionReason` and `decisionReasonDesc` explaining a failed eligibility check. Note: Displaying a location with zero pickup inventory for a Ship-to-store experience requires a separate Ship-to-store workflow. #### Sample Method: `POST` Endpoint: `https:///rest/s1/ofbiz-oms-usl/checkBopisInventory` Header: `Content-Type: application/json` **Request** Replace the example identifiers with the values configured in OMS. ```json { "productStoreId": "STORE", "inventoryGroupId": "SHOPIFY_FAC_GRP", "internalNames": ["MSH02-32-Black"], "facilityIds": ["STORE_15", "STORE_20", "STORE_9"] } ``` **Response** Illustrative response for the requested product and three eligible stores: ```json { "resultList": [ { "facilityId": "STORE_15", "productId": "10001", "internalName": "MSH02-32-Black", "atp": 5, "safetyStock": 2, "computedAtp": 3 }, { "facilityId": "STORE_20", "productId": "10001", "internalName": "MSH02-32-Black", "atp": 10, "safetyStock": 2, "computedAtp": 8 }, { "facilityId": "STORE_9", "productId": "10001", "internalName": "MSH02-32-Black", "atp": 16, "safetyStock": 2, "computedAtp": 14 } ] } ``` ### Handle cases when customer location is not available In case the customer's location is not available, you can display all the available store pickup locations for the product using the storeLookup API and checkBopisInventory API. Here's how to handle this scenario: * Step 1: Call the storeLookup API without passing latitude and longitude coordinates to retrieve all facilities allowing BOPIS * Step 2: Use the facility IDs returned in the response of the storeLookup API with the [BOPIS Check Inventory](/documents/integrate-with-hotwax/hotwax-commerce-api-and-data-feeds/inventory/bopis-check-inventory.md) API to get the facilities having inventory for the product. * Step 3: Display locations with positive `computedAtp` on the PDP #### Sample **Request** ``` { "viewSize": 40, "filters": ["storeType: RETAIL_STORE"] } ``` ## Additional information **Identifying In-Store Pickup Orders:** When customers add qualifying items for in-store pickup, HotWax OMS will require the order to have the line item property `_pickupstore` prefilled with the pickup store location. Note: The line item property can be added by the merchant development team. **Order Download Process:** BOPIS orders placed on Shopify are downloaded into HotWax Commerce alongside regular orders via the 'New Import' job. HotWax Commerce checks the line item property and sends the order to the customer's selected pickup location without brokering. Store associates access BOPIS orders through their BOPIS fulfillment app, preparing orders for customer pickup. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.hotwax.co/documents/integrate-with-hotwax/journeys/buy-online-pickup-in-store/bopis-pdp-experience.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.