diff --git a/Facility/Post code lookup.md b/Facility/Post code lookup.md
index 5a701ecbe..13a7fdc07 100644
--- a/Facility/Post code lookup.md
+++ b/Facility/Post code lookup.md
@@ -11,7 +11,7 @@ The Post Code Lookup API provides developers with the ability to fetch informati
## Fetch Postal Code for Latitude Longitude in a Given Range
-Fetches the postal code for a specific location based on its latitude and longitude. The API can also return postal codes for locations within a specified distance range from the provided latitude and longitude. To get the postal code, you will need to call /postcodeLookup endpoint with the POST method.
+Fetches the postal code for a specific location based on its latitude and longitude. The API can also return postal codes for locations within a specified distance range from the provided latitude and longitude. To get the postal code, you will need to call /postcodeLookup endpoint with the `/POST` method.
### Request
@@ -172,7 +172,7 @@ Content-Type: application/json
## Fetch latitude longitude for a partial postal code
-Fetches the latitude longitude for a partial postal code. This API fetches all the latitude and longitude matching the partial postal code. To look up the latitude longitude for a partial postal code you will need to call the endpoint with the POST method.
+Fetches the latitude longitude for a partial postal code. This API fetches all the latitude and longitude matching the partial postal code. To look up the latitude longitude for a partial postal code you will need to call the endpoint with the `/POST` method.
### Request
diff --git a/Facility/Store lookup.md b/Facility/Store lookup.md
index dd1e3fe88..c8390f7e8 100644
--- a/Facility/Store lookup.md
+++ b/Facility/Store lookup.md
@@ -1,19 +1,19 @@
# Store Lookup API
-The API allows to look up the stores accepting BOPIS orders near the customer’s location using the POST method.
+The API allows to look up the stores accepting BOPIS orders near the customer’s location using the `/POST` method.
## Request
-### Endpoint
+#### Endpoint
`https://< host >/api/storeLookup`
Example: Host: https://demo-oms.hotwax.io/api/storeLookup
-### Header
+#### Header
Content-Type: application/json
-### Body
+#### Body
```
{
"viewSize": 40,
@@ -26,7 +26,7 @@ Content-Type: application/json
}
```
-### Parameters
+#### Parameters
| Parameter | Description | Required (Y/N) |
|---------------|-----------------------------------------------------------|----------|
@@ -40,13 +40,13 @@ Content-Type: application/json
## Response
-### Status Code
+#### Status Code
HTTP/1.1 200 OK
-### Headers
+#### Headers
Content-Type: application/json
-### Body
+#### Body
```
"response":
@@ -125,8 +125,8 @@ Content-Type: application/json
-## Note:
-### Filters
+### Note:
+#### Filters
Filter is a parameter that allows you to narrow down the results of a query or search to only include items that meet specific criteria. For storeLookup API, users can filter results for each parameter given in the response:
@@ -146,7 +146,7 @@ Filter is a parameter that allows you to narrow down the results of a query or s
| `latlon` | The latitude and longitude of the facility |
-### Valid values of storeType
+#### Valid values of storeType
- RETAIL
diff --git a/Fulfillment/APIs/Add shipment box.md b/Fulfillment/APIs/Add shipment box.md
index 9822be9e1..d3d2b2bae 100644
--- a/Fulfillment/APIs/Add shipment box.md
+++ b/Fulfillment/APIs/Add shipment box.md
@@ -1,16 +1,16 @@
# Add shipment box API
-Adds a shipment box for the order for fulfillment. To add a shipment box, you will need to call the /addShipmentPackage endpoint with the POST method.
+Adds a shipment box for the order for fulfillment. To add a shipment box, you will need to call the /addShipmentPackage endpoint with the `/POST` method.
## Request
-### Endpoint
+#### Endpoint
`https:///api/addShipmentPackage`
Example: https://demo-oms.hotwax.io/api/addShipmentPackage
-### Header
+#### Header
#### Body
@@ -29,7 +29,7 @@ Example: https://demo-oms.hotwax.io/api/addShipmentPackage
## Response
-### Header
+#### Header
#### Body
diff --git a/Fulfillment/APIs/Create picklist.md b/Fulfillment/APIs/Create picklist.md
index c5fc80be7..28d96fd49 100644
--- a/Fulfillment/APIs/Create picklist.md
+++ b/Fulfillment/APIs/Create picklist.md
@@ -1,6 +1,6 @@
# Create picklist API
-Creates a picklist of the order items to be picked up. To create a picklist, you will need to call the /createPicklist endpoint with the POST method.
+Creates a picklist of the order items to be picked up. To create a picklist, you will need to call the /createPicklist endpoint with the `/POST` method.
## Request
diff --git a/Fulfillment/APIs/In progress orders.md b/Fulfillment/APIs/In progress orders.md
index db55b43f2..763799d46 100644
--- a/Fulfillment/APIs/In progress orders.md
+++ b/Fulfillment/APIs/In progress orders.md
@@ -1,6 +1,6 @@
# In progress Orders API
-Fetches a comprehensive list of all orders which are in process of pickup for fulfillment. To get in progress orders, you will need to call the /solr-query endpoint with the POST method.
+Fetches a comprehensive list of all orders which are in process of pickup for fulfillment. To get in progress orders, you will need to call the /solr-query endpoint with the `/POST` method.
## Request
diff --git a/Fulfillment/APIs/Outstanding orders.md b/Fulfillment/APIs/Outstanding orders.md
index 65db0a70b..6acb6e452 100644
--- a/Fulfillment/APIs/Outstanding orders.md
+++ b/Fulfillment/APIs/Outstanding orders.md
@@ -1,6 +1,6 @@
# Outstanding Orders API
-Fetches a comprehensive list of all orders that are brokered at a facility for fulfillment. To get the outstanding orders, you will need to call the /solr-query endpoint with the POST method.
+Fetches a comprehensive list of all orders that are brokered at a facility for fulfillment. To get the outstanding orders, you will need to call the /solr-query endpoint with the `/POST` method.
## Request
diff --git a/Fulfillment/APIs/Packing slip PDF.md b/Fulfillment/APIs/Packing slip PDF.md
index d587e86e9..f315322df 100644
--- a/Fulfillment/APIs/Packing slip PDF.md
+++ b/Fulfillment/APIs/Packing slip PDF.md
@@ -1,6 +1,6 @@
# Packing slip PDF API
-Downloads a packing slip in PDF format for the shipment. To download the shipping label PDF, you will need to call the /PackingSlip.pdf endpoint with the POST method.
+Downloads a packing slip in PDF format for the shipment. To download the shipping label PDF, you will need to call the /PackingSlip.pdf endpoint with the `/POST` method.
## Request
diff --git a/Fulfillment/APIs/Ready-to-ship items.md b/Fulfillment/APIs/Ready-to-ship items.md
index db713c7e6..9d0d1a636 100644
--- a/Fulfillment/APIs/Ready-to-ship items.md
+++ b/Fulfillment/APIs/Ready-to-ship items.md
@@ -1,6 +1,6 @@
# Ready to ship order items
-Fetches a comprehensive list of all orders items which are picked, packed and ready to ship to customers. To get ready to ship orders, you will need to call the /solr-query endpoint with the POST method.
+Fetches a comprehensive list of all orders items which are picked, packed and ready to ship to customers. To get ready to ship orders, you will need to call the /solr-query endpoint with the `/POST` method.
## Request
diff --git a/Fulfillment/APIs/Retry shipping label.md b/Fulfillment/APIs/Retry shipping label.md
index d7c1939b0..b1c11f910 100644
--- a/Fulfillment/APIs/Retry shipping label.md
+++ b/Fulfillment/APIs/Retry shipping label.md
@@ -1,6 +1,6 @@
# Retry shipping label PDF API
-Redownlaods shipping label in PDF format for the completed shipment. To redownload the shipping label PDF, you will need to call the /retryShippingLabel endpoint with the GET method.
+Redownlaods shipping label in PDF format for the completed shipment. To redownload the shipping label PDF, you will need to call the /retryShippingLabel endpoint with the `/GET` method.
## Request
diff --git a/Fulfillment/APIs/Shipping label PDF..md b/Fulfillment/APIs/Shipping label PDF..md
index 6a84588e8..840c38662 100644
--- a/Fulfillment/APIs/Shipping label PDF..md
+++ b/Fulfillment/APIs/Shipping label PDF..md
@@ -1,6 +1,6 @@
# Shipping label PDF API
-Downloads a shipping label in PDF format for the shipment. To download the shipping label PDF, you will need to call the /ShippingLabel.pdf endpoint with the POST method.
+Downloads a shipping label in PDF format for the shipment. To download the shipping label PDF, you will need to call the /ShippingLabel.pdf endpoint with the `/POST` method.
## Request
diff --git a/Fulfillment/APIs/Shipping label and packing slip.md b/Fulfillment/APIs/Shipping label and packing slip.md
index 8061f3a39..bdc08a1e5 100644
--- a/Fulfillment/APIs/Shipping label and packing slip.md
+++ b/Fulfillment/APIs/Shipping label and packing slip.md
@@ -1,6 +1,6 @@
# Label and packing slip API
-Downloads a shipping label in PDF format for the shipment. To download the shipping label PDF, you will need to call the /LabelAndPackingSlip.pdf endpoint with the POST method.
+Downloads a shipping label in PDF format for the shipment. To download the shipping label PDF, you will need to call the /LabelAndPackingSlip.pdf endpoint with the `/POST` method.
## Request
diff --git a/Fulfillment/APIs/Update orders.md b/Fulfillment/APIs/Update orders.md
index 773c8545f..587b04455 100644
--- a/Fulfillment/APIs/Update orders.md
+++ b/Fulfillment/APIs/Update orders.md
@@ -1,6 +1,6 @@
# Update Order API
-Updates orders that are currently in progress and have not yet been shipped, to update the orders, you will need to call the `updateOrder` endpoint with the POST method. There are two main reasons for updating orders: changing the shipment box and rejecting specific order items.
+Updates orders that are currently in progress and have not yet been shipped, to update the orders, you will need to call the `updateOrder` endpoint with the `/POST` method. There are two main reasons for updating orders: changing the shipment box and rejecting specific order items.
## Request
@@ -14,7 +14,7 @@ Example: https://demo-oms.hotwax.io/api/updateOrder
#### For Order Item rejection:
-##### Body
+#### Body
```
facilityId: ,
@@ -42,7 +42,7 @@ rej_rejectionReason_0: item.rejectReason
#### For Shipment Package Change:
-##### Body
+#### Body
```
facilityId: ,
@@ -73,7 +73,7 @@ rtp_newShipmentId_1: shipmentPackage.shipmentId
#### For Order Item rejection:
-##### Body
+#### Body
```
facilityId: ,
@@ -89,7 +89,7 @@ _EVENT_MESSAGE_: "Order updated successfully"
#### For Shipment Package Change:
-##### Body
+#### Body
```
facilityId: ,
diff --git a/Fulfillment/APIs/Upload and Import file.md b/Fulfillment/APIs/Upload and Import file.md
index 21836c202..4066cd2a6 100644
--- a/Fulfillment/APIs/Upload and Import file.md
+++ b/Fulfillment/APIs/Upload and Import file.md
@@ -1,6 +1,6 @@
# Upload and Import file API
-Imports shipped order details with the tracking code. To import file, you will need to call the /uploadAndImportfile endpoint with the POST method.
+Imports shipped order details with the tracking code. To import file, you will need to call the /uploadAndImportfile endpoint with the `/POST` method.
## Request
diff --git a/Inventory/Check inventory.md b/Inventory/Check inventory.md
index 5e4563ba8..dd812bb48 100644
--- a/Inventory/Check inventory.md
+++ b/Inventory/Check inventory.md
@@ -1,6 +1,6 @@
# Check Inventory API
-Get the stock details of the product on the specific locations. To get the stock details, you will need to call the `/checkInventory` endpoint with the GET method.
+Get the stock details of the product on the specific locations. To get the stock details, you will need to call the `/checkInventory` endpoint with the `/GET` method.
## Request
@@ -13,7 +13,7 @@ Example: https://demo-oms.hotwax.io/api/checkInventory
Content-Type: application/json
-### Body
+#### Body
```
{
"filters": {
@@ -41,7 +41,7 @@ HTTP/1.1 200 OK
Content-Type: application/json
-### Body
+#### Body
```
{
diff --git a/Inventory/Update Inventory.md b/Inventory/Update Inventory.md
index 4b2e84bb5..5f8660110 100644
--- a/Inventory/Update Inventory.md
+++ b/Inventory/Update Inventory.md
@@ -1,6 +1,6 @@
# Update Inventory API
-Updates the inventory of products in HotWax by logging a variance of the inputted amount. To update inventory you will need to call the endpoint with the POST method.
+Updates the inventory of products in HotWax by logging a variance of the inputted amount. To update inventory you will need to call the endpoint with the `/POST` method.
Example:
@@ -29,7 +29,7 @@ To access this endpoint, you need to include the authorization token in the requ
To learn more about Bearer token authentication, read this [document](https://github.com/hotwax/oms-documentation/blob/oms1.0/API%20authentication.md)
-### Body
+#### Body
```
{
{
@@ -89,7 +89,7 @@ HTTP/1.1 200 OK
Content-Type: application/json
-### Body
+#### Body
```
{
diff --git a/Journeys/BOPIS PDP Experience.md b/Journeys/BOPIS PDP Experience.md
index 57ec6c30a..33e0dec7e 100644
--- a/Journeys/BOPIS PDP Experience.md
+++ b/Journeys/BOPIS PDP Experience.md
@@ -1,8 +1,8 @@
# Getting started with BOPIS PDP experience
-### HotWax's BOPIS PDP experience allows customers to browse all available pickup stores (facilities) for their desired products on the Shopify product detail page (PDP)
+HotWax's BOPIS PDP experience allows customers to browse all available pickup stores (facilities) for their desired products on the Shopify product detail page (PDP)
-## To integrate this feature, follow these steps:
+### **To integrate this feature, follow these steps:**
### Step 1: Obtain the customer's latitude and longitude
@@ -16,9 +16,9 @@ To show available pickup facilities near the customer, the latitude and longitud
#### Sample:
-Method: `POST`
+Method: `/POST`
-##### Request
+## Request
```
{
"json": {
@@ -27,7 +27,7 @@ Method: `POST`
}
```
-##### Response
+## Response
```
{
"responseHeader": {
@@ -63,9 +63,9 @@ Note: The distance parameter is configurable to narrow down the search results.
#### Sample:
-Method: `POST`
+Method: `/POST`
-##### Request
+## Request
```
{
"viewSize": 40,
@@ -76,7 +76,7 @@ Method: `POST`
```
-##### Response
+## Response
```
{
"responseHeader": {
@@ -171,14 +171,14 @@ Note: If a facility has 0 inventory for the product, you can still display it fo
#### Sample:
-Method: `GET`
+Method: `/GET`
-##### Request
+## Request
```
https://dev-apps.hotwax.io/api/checkInventory?productId=10249&facilityId=STORE_9&facilityId=STORE_20&facilityId=STORE_15
```
-##### Response
+## Response
```
{
"count": "1",
@@ -210,7 +210,7 @@ In case the customer's location is not available, you can display all the availa
#### Sample:
-##### Request
+## Request
```
{
diff --git a/Shopify /Get Shopify Customer Default Store API.md b/Shopify /Get Shopify Customer Default Store API.md
new file mode 100644
index 000000000..323b0b50b
--- /dev/null
+++ b/Shopify /Get Shopify Customer Default Store API.md
@@ -0,0 +1,79 @@
+# **Get Shopify Customer Default Store API**
+
+Fetches the default store selected by the customer during the initial Shopify store account setup. To fetch the customer's default Shopify store ID you will need to call the endpoint with the `/GET` method.
+
+## **Request**
+
+### End Point
+
+`https://\/api/getShopifyCustomerDefaultStore?customerId=\&shopifyShopId=\`
+
+Example: https://demo-oms.hotwax.io/api/getShopifyCustomerDefaultStore?customerId=637245368996&shopifyShopId=672
+
+### Header
+
+Content-Type: application/json
+
+| **Parameters** | **Description** | **Required (Y/N)** |
+| --- | --- | --- |
+| `customerId` | The Unique Shopify account ID of the customer | Y |
+| `shopId` | The ID of the virtual Shopify store where the customer is operating. | Y |
+
+###
+
+
+###
+
+
+## **Response**
+
+### Status Code
+
+HTTP/1.1 200 OK
+
+### Headers
+
+**Content-Type: application/json**
+
+### Body
+
+```
+{
+ "customer": {
+ "customerId": "6327128850623",
+ "result": "success",
+ "facilityId": "672}
+}
+```
+
+| **Parameters** | **Description** |
+| --- | --- |
+| `result` | The response generated when the request was processed. |
+| `facilityId` | The unique identification of the default retail location selected by the customer. |
+
+###
+
+
+###
+
+
+### **Error Handling**
+
+An error may occur in case the data such as - Customer ID or Shopify ID is not found in the database.
+
+**Sample Code Snippet -**
+
+### Body
+```
+{
+ "customer": {
+ "customerId": "",
+ "result": "error",
+ "errorMessage": "Unable to get customer information."
+ }
+}
+```
+
+| **Parameters** | **Description** |
+| --- | --- |
+| `errorMessage` | The details of the error. |
diff --git a/Shopify /Set Shopify Customer default Store.md b/Shopify /Set Shopify Customer default Store.md
new file mode 100644
index 000000000..7cf2567a6
--- /dev/null
+++ b/Shopify /Set Shopify Customer default Store.md
@@ -0,0 +1,73 @@
+# **Set Shopify Customer Default Store API**
+
+Stores the default Shopify store selected by the customer in their Shopify store. To set the Shopify store as default store you will need to call the endpoint with the `/POST` method.
+
+## **Request**
+
+### End Point
+
+`https://\/api/setShopifyCustomerDefaultStore`
+
+Example: https://demo-oms.hotwax.io/api/setShopifyCustomerDefaultStore
+
+### Header
+
+Content-Type: application/json
+
+### Body:
+```
+{
+ "customerId": "",
+ "shopifyShopId": "",
+ "facilityId": ""
+}
+
+```
+
+Example :
+
+```
+{
+ "customerId": "67893726937",
+ "shopifyShopId": "3537098370",
+ "facilityId": "138"
+}
+
+```
+
+## **Response**
+
+### Status Code
+
+HTTP/1.1 200 OK
+
+### Headers
+
+Content-Type: application/json
+
+### Body:
+```
+{
+ "result": "success",
+ "customerId": "",
+ "response": "Customer information updated successfully."
+}
+
+```
+
+Example :
+
+```
+{
+ "result": "success",
+ "customerId": "67893726937",
+ "response": "Customer information updated successfully."
+}
+
+```
+
+### **Error Handling**
+
+Incase Customer ID or Shopify Shop Id is not sent at the time of API call an error may occur.
+
+**Error message -**"Unable to update customer information" or any other message would be displayed.