From 502f11e6cb0848bd37a37c539cf029b0c08fd611 Mon Sep 17 00:00:00 2001 From: Sonam Vohra <145959451+svohra1206@users.noreply.github.com> Date: Thu, 28 Sep 2023 11:57:23 +0530 Subject: [PATCH 01/27] Create Get Shopify Customer Default Store API.md --- Shopify /Get Shopify Customer Default Store API.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 Shopify /Get Shopify Customer Default Store API.md 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..8b1378917 --- /dev/null +++ b/Shopify /Get Shopify Customer Default Store API.md @@ -0,0 +1 @@ + From db93984853260cbb6ca8e345d1051a1db543148d Mon Sep 17 00:00:00 2001 From: Sonam Vohra <145959451+svohra1206@users.noreply.github.com> Date: Thu, 28 Sep 2023 14:28:56 +0530 Subject: [PATCH 02/27] Updated Get Shopify Customer Default Store API.md --- .../Get Shopify Customer Default Store API.md | 78 +++++++++++++++++++ 1 file changed, 78 insertions(+) diff --git a/Shopify /Get Shopify Customer Default Store API.md b/Shopify /Get Shopify Customer Default Store API.md index 8b1378917..c43795c2b 100644 --- a/Shopify /Get Shopify Customer Default Store API.md +++ b/Shopify /Get Shopify Customer Default Store API.md @@ -1 +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** | +| --- | + +``` +{ +    "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 -** + +``` +{ + "customer": { + "customerId": "", + "result": "error", + "errorMessage": "Unable to get customer information." + } +} +``` + +| **Parameters** | **Description** | +| --- | --- | +| `errorMessage` | The details of the error. | From aedc94b179772ed30bc7bc0b43796a2a11ecd057 Mon Sep 17 00:00:00 2001 From: Sonam Vohra <145959451+svohra1206@users.noreply.github.com> Date: Thu, 28 Sep 2023 14:43:53 +0530 Subject: [PATCH 03/27] Update Get Shopify Customer Default Store API.md --- Shopify /Get Shopify Customer Default Store API.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Shopify /Get Shopify Customer Default Store API.md b/Shopify /Get Shopify Customer Default Store API.md index c43795c2b..91bb935be 100644 --- a/Shopify /Get Shopify Customer Default Store API.md +++ b/Shopify /Get Shopify Customer Default Store API.md @@ -1,6 +1,6 @@ ## **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. +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** From 3b0e3c08ab722a430e68969e6917484bab986212 Mon Sep 17 00:00:00 2001 From: Sonam Vohra <145959451+svohra1206@users.noreply.github.com> Date: Thu, 28 Sep 2023 14:44:19 +0530 Subject: [PATCH 04/27] Create Set Shopify Customer default Store.md --- .../Set Shopify Customer default Store.md | 77 +++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 Shopify /Set Shopify Customer default Store.md diff --git a/Shopify /Set Shopify Customer default Store.md b/Shopify /Set Shopify Customer default Store.md new file mode 100644 index 000000000..a817bcb30 --- /dev/null +++ b/Shopify /Set Shopify Customer default Store.md @@ -0,0 +1,77 @@ +## **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. From 88a024d9c4d304484c1e9a49aac1535ac3b3ceda Mon Sep 17 00:00:00 2001 From: Sonam Vohra <145959451+svohra1206@users.noreply.github.com> Date: Thu, 28 Sep 2023 14:46:49 +0530 Subject: [PATCH 05/27] Update Set Shopify Customer default Store.md --- Shopify /Set Shopify Customer default Store.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/Shopify /Set Shopify Customer default Store.md b/Shopify /Set Shopify Customer default Store.md index a817bcb30..769a4e1d3 100644 --- a/Shopify /Set Shopify Customer default Store.md +++ b/Shopify /Set Shopify Customer default Store.md @@ -1,22 +1,22 @@ -## **Set Shopify Customer Default Store API** +# **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** +## **Request** -#### End Point +### End Point | https://\/api/setShopifyCustomerDefaultStore | | --- | Example: https://demo-oms.hotwax.io/api/setShopifyCustomerDefaultStore -#### Header +### Header | Content-Type:​ application/json | | --- | -Body: +### Body: ``` { "customerId": "", @@ -37,19 +37,19 @@ Example : ``` -### **Response** +## **Response** -#### Status Code +### Status Code | HTTP/1.1 200 OK | | --- | -#### Headers +### Headers | Content-Type: application/json | | --- | -Body: +### Body: ``` { "result": "success", From de83ebad0068b46d9742734fb8f4597b14ddc043 Mon Sep 17 00:00:00 2001 From: Sonam Vohra <145959451+svohra1206@users.noreply.github.com> Date: Thu, 28 Sep 2023 14:49:13 +0530 Subject: [PATCH 06/27] Update Get Shopify Customer Default Store API.md --- .../Get Shopify Customer Default Store API.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/Shopify /Get Shopify Customer Default Store API.md b/Shopify /Get Shopify Customer Default Store API.md index 91bb935be..27cf153fc 100644 --- a/Shopify /Get Shopify Customer Default Store API.md +++ b/Shopify /Get Shopify Customer Default Store API.md @@ -1,16 +1,16 @@ -## **Get Shopify Customer Default Store API** +# **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** +## **Request** -#### End Point +### End Point `https://\/api/getShopifyCustomerDefaultStore?customerId=\&shopifyShopId=\` Example: https://demo-oms.hotwax.io/api/getShopifyCustomerDefaultStore?customerId=637245368996&shopifyShopId=672 -#### Header +### Header | Content-Type:​ application/json | | --- | @@ -26,18 +26,20 @@ Example: https://demo-oms.hotwax.io/api/getShopifyCustomerDefaultStore?customerI ### -### **Response** +## **Response** -#### Status Code +### Status Code | HTTP/1.1 200 OK | | --- | -#### Headers +### Headers | **Content-Type: application/json** | | --- | +### Body + ``` {     "customer": { @@ -64,6 +66,7 @@ An error may occur in case the data such as - Customer ID or Shopify ID is not f **Sample Code Snippet -** +### Body ``` { "customer": { From 95f9a39b416c973f0f91e538afe241645bb8776a Mon Sep 17 00:00:00 2001 From: Sonam Vohra <145959451+svohra1206@users.noreply.github.com> Date: Thu, 28 Sep 2023 14:55:44 +0530 Subject: [PATCH 07/27] Update Set Shopify Customer default Store.md --- Shopify /Set Shopify Customer default Store.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/Shopify /Set Shopify Customer default Store.md b/Shopify /Set Shopify Customer default Store.md index 769a4e1d3..7cf2567a6 100644 --- a/Shopify /Set Shopify Customer default Store.md +++ b/Shopify /Set Shopify Customer default Store.md @@ -6,15 +6,13 @@ Stores the default Shopify store selected by the customer in their Shopify store ### End Point -| https://\/api/setShopifyCustomerDefaultStore | -| --- | +`https://\/api/setShopifyCustomerDefaultStore` Example: https://demo-oms.hotwax.io/api/setShopifyCustomerDefaultStore ### Header -| Content-Type:​ application/json | -| --- | +Content-Type:​ application/json ### Body: ``` @@ -41,13 +39,11 @@ Example : ### Status Code -| HTTP/1.1 200 OK | -| --- | +HTTP/1.1 200 OK ### Headers -| Content-Type: application/json | -| --- | +Content-Type: application/json ### Body: ``` From 97dc4ed88414670866e0af8ff4b93865a52e2bf3 Mon Sep 17 00:00:00 2001 From: Sonam Vohra <145959451+svohra1206@users.noreply.github.com> Date: Thu, 28 Sep 2023 14:56:44 +0530 Subject: [PATCH 08/27] Update Get Shopify Customer Default Store API.md --- Shopify /Get Shopify Customer Default Store API.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/Shopify /Get Shopify Customer Default Store API.md b/Shopify /Get Shopify Customer Default Store API.md index 27cf153fc..323b0b50b 100644 --- a/Shopify /Get Shopify Customer Default Store API.md +++ b/Shopify /Get Shopify Customer Default Store API.md @@ -12,8 +12,7 @@ Example: https://demo-oms.hotwax.io/api/getShopifyCustomerDefaultStore?customerI ### Header -| Content-Type:​ application/json | -| --- | +Content-Type:​ application/json | **Parameters** | **Description** | **Required (Y/N)** | | --- | --- | --- | @@ -30,13 +29,11 @@ Example: https://demo-oms.hotwax.io/api/getShopifyCustomerDefaultStore?customerI ### Status Code -| HTTP/1.1 200 OK | -| --- | +HTTP/1.1 200 OK ### Headers -| **Content-Type: application/json** | -| --- | +**Content-Type: application/json** ### Body From deb2266f614e10a303d243da32158cb2e53911a1 Mon Sep 17 00:00:00 2001 From: Sonam Vohra <145959451+svohra1206@users.noreply.github.com> Date: Fri, 29 Sep 2023 12:31:08 +0530 Subject: [PATCH 09/27] Update Post code lookup.md --- Facility/Post code lookup.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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 From ae9d28b9c2c203e5670cc45bcd053dc50aaa7c58 Mon Sep 17 00:00:00 2001 From: Sonam Vohra <145959451+svohra1206@users.noreply.github.com> Date: Fri, 29 Sep 2023 12:32:11 +0530 Subject: [PATCH 10/27] Update Store lookup.md --- Facility/Store lookup.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) 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
    • From d5f32a3b4ed8e359e159f6729c014b4c15465637 Mon Sep 17 00:00:00 2001 From: Sonam Vohra <145959451+svohra1206@users.noreply.github.com> Date: Fri, 29 Sep 2023 12:33:14 +0530 Subject: [PATCH 11/27] Update Add shipment box.md --- Fulfillment/APIs/Add shipment box.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) 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 From c84296472de0f62a07302676da5e39d8b736fff7 Mon Sep 17 00:00:00 2001 From: Sonam Vohra <145959451+svohra1206@users.noreply.github.com> Date: Fri, 29 Sep 2023 12:34:17 +0530 Subject: [PATCH 12/27] Update Create picklist.md --- Fulfillment/APIs/Create picklist.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Fulfillment/APIs/Create picklist.md b/Fulfillment/APIs/Create picklist.md index c5fc80be7..79a0ea909 100644 --- a/Fulfillment/APIs/Create picklist.md +++ b/Fulfillment/APIs/Create picklist.md @@ -1,16 +1,16 @@ # 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 -### Endpoint +#### Endpoint `https:///api/createPicklist` Example: https://demo-oms.hotwax.io/api/createPicklist -### Header +#### Header #### Body @@ -51,7 +51,7 @@ Note: Pass the data in form format. ## Response -### Header +#### Header #### Body From d795c6560e117ab87f9949da000b0b96d40ca2f1 Mon Sep 17 00:00:00 2001 From: Sonam Vohra <145959451+svohra1206@users.noreply.github.com> Date: Fri, 29 Sep 2023 12:35:30 +0530 Subject: [PATCH 13/27] Update In progress orders.md --- Fulfillment/APIs/In progress orders.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Fulfillment/APIs/In progress orders.md b/Fulfillment/APIs/In progress orders.md index db55b43f2..0f49b1c6e 100644 --- a/Fulfillment/APIs/In progress orders.md +++ b/Fulfillment/APIs/In progress orders.md @@ -1,16 +1,16 @@ # 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 -### Endpoint +#### Endpoint `https:///api/solr-query` Example: https://demo-oms.hotwax.io/api/solr-query -### Header +#### Header #### Body @@ -71,7 +71,7 @@ Example: https://demo-oms.hotwax.io/api/solr-query ## Response -### Header +#### Header #### Body From 3b0a7088ed118c4be878910a87cca1d11a4d8735 Mon Sep 17 00:00:00 2001 From: Sonam Vohra <145959451+svohra1206@users.noreply.github.com> Date: Fri, 29 Sep 2023 12:36:19 +0530 Subject: [PATCH 14/27] Update Outstanding orders.md --- Fulfillment/APIs/Outstanding orders.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Fulfillment/APIs/Outstanding orders.md b/Fulfillment/APIs/Outstanding orders.md index 65db0a70b..e66417cd2 100644 --- a/Fulfillment/APIs/Outstanding orders.md +++ b/Fulfillment/APIs/Outstanding orders.md @@ -1,16 +1,16 @@ # 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 -### Endpoint +#### Endpoint `https:///api/solr-query` Example: https://demo-oms.hotwax.io/api/solr-query -### Header +#### Header #### Body @@ -62,7 +62,7 @@ Example: https://demo-oms.hotwax.io/api/solr-query ## Response -### Header +#### Header #### Body From aa322b86350a1ac5e7bf0513ce92720effd92d15 Mon Sep 17 00:00:00 2001 From: Sonam Vohra <145959451+svohra1206@users.noreply.github.com> Date: Fri, 29 Sep 2023 12:36:55 +0530 Subject: [PATCH 15/27] Update Packing slip PDF.md --- Fulfillment/APIs/Packing slip PDF.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 From de60cf8fa59481033cd595a9fe97932def3c2ed2 Mon Sep 17 00:00:00 2001 From: Sonam Vohra <145959451+svohra1206@users.noreply.github.com> Date: Fri, 29 Sep 2023 12:37:28 +0530 Subject: [PATCH 16/27] Update Ready-to-ship items.md --- Fulfillment/APIs/Ready-to-ship items.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 From d88c8244646c6d2cbb601b0d029f4d60c09ceee6 Mon Sep 17 00:00:00 2001 From: Sonam Vohra <145959451+svohra1206@users.noreply.github.com> Date: Fri, 29 Sep 2023 12:38:10 +0530 Subject: [PATCH 17/27] Update Outstanding orders.md --- Fulfillment/APIs/Outstanding orders.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Fulfillment/APIs/Outstanding orders.md b/Fulfillment/APIs/Outstanding orders.md index e66417cd2..6acb6e452 100644 --- a/Fulfillment/APIs/Outstanding orders.md +++ b/Fulfillment/APIs/Outstanding orders.md @@ -4,13 +4,13 @@ Fetches a comprehensive list of all orders that are brokered at a facility for f ## Request -#### Endpoint +### Endpoint `https:///api/solr-query` Example: https://demo-oms.hotwax.io/api/solr-query -#### Header +### Header #### Body @@ -62,7 +62,7 @@ Example: https://demo-oms.hotwax.io/api/solr-query ## Response -#### Header +### Header #### Body From eabdfabecc37160e2b777a718e616fd24408bc52 Mon Sep 17 00:00:00 2001 From: Sonam Vohra <145959451+svohra1206@users.noreply.github.com> Date: Fri, 29 Sep 2023 12:38:44 +0530 Subject: [PATCH 18/27] Update In progress orders.md --- Fulfillment/APIs/In progress orders.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Fulfillment/APIs/In progress orders.md b/Fulfillment/APIs/In progress orders.md index 0f49b1c6e..763799d46 100644 --- a/Fulfillment/APIs/In progress orders.md +++ b/Fulfillment/APIs/In progress orders.md @@ -4,13 +4,13 @@ Fetches a comprehensive list of all orders which are in process of pickup for fu ## Request -#### Endpoint +### Endpoint `https:///api/solr-query` Example: https://demo-oms.hotwax.io/api/solr-query -#### Header +### Header #### Body @@ -71,7 +71,7 @@ Example: https://demo-oms.hotwax.io/api/solr-query ## Response -#### Header +### Header #### Body From 96aa70af648d63e505db2c0b87ab13aaf14f4027 Mon Sep 17 00:00:00 2001 From: Sonam Vohra <145959451+svohra1206@users.noreply.github.com> Date: Fri, 29 Sep 2023 12:39:28 +0530 Subject: [PATCH 19/27] Update Create picklist.md --- Fulfillment/APIs/Create picklist.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Fulfillment/APIs/Create picklist.md b/Fulfillment/APIs/Create picklist.md index 79a0ea909..28d96fd49 100644 --- a/Fulfillment/APIs/Create picklist.md +++ b/Fulfillment/APIs/Create picklist.md @@ -4,13 +4,13 @@ Creates a picklist of the order items to be picked up. To create a picklist, you ## Request -#### Endpoint +### Endpoint `https:///api/createPicklist` Example: https://demo-oms.hotwax.io/api/createPicklist -#### Header +### Header #### Body @@ -51,7 +51,7 @@ Note: Pass the data in form format. ## Response -#### Header +### Header #### Body From 95b22f7cd7808623bb0a4f72e6e3ea5eea8e6bdd Mon Sep 17 00:00:00 2001 From: Sonam Vohra <145959451+svohra1206@users.noreply.github.com> Date: Fri, 29 Sep 2023 12:39:51 +0530 Subject: [PATCH 20/27] Update Retry shipping label.md --- Fulfillment/APIs/Retry shipping label.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 From 008a5170ad8ad99e0f8b53e67a11f85710ed2786 Mon Sep 17 00:00:00 2001 From: Sonam Vohra <145959451+svohra1206@users.noreply.github.com> Date: Fri, 29 Sep 2023 12:40:31 +0530 Subject: [PATCH 21/27] Update Shipping label PDF..md --- Fulfillment/APIs/Shipping label PDF..md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 From 3ea45d581384132730481bf0fc064c861ea67375 Mon Sep 17 00:00:00 2001 From: Sonam Vohra <145959451+svohra1206@users.noreply.github.com> Date: Fri, 29 Sep 2023 12:40:50 +0530 Subject: [PATCH 22/27] Update Shipping label and packing slip.md --- Fulfillment/APIs/Shipping label and packing slip.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 From cb739334b3c588089d65dc2bd694982cb9e87eaa Mon Sep 17 00:00:00 2001 From: Sonam Vohra <145959451+svohra1206@users.noreply.github.com> Date: Fri, 29 Sep 2023 12:42:18 +0530 Subject: [PATCH 23/27] Update Update orders.md --- Fulfillment/APIs/Update orders.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) 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: , From f729df2fbc69edeb54190413f6741a6799b51c36 Mon Sep 17 00:00:00 2001 From: Sonam Vohra <145959451+svohra1206@users.noreply.github.com> Date: Fri, 29 Sep 2023 12:42:46 +0530 Subject: [PATCH 24/27] Update Upload and Import file.md --- Fulfillment/APIs/Upload and Import file.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 From d844c84e2985643e8c5569dede1da20fee354b2c Mon Sep 17 00:00:00 2001 From: Sonam Vohra <145959451+svohra1206@users.noreply.github.com> Date: Fri, 29 Sep 2023 12:43:30 +0530 Subject: [PATCH 25/27] Update Check inventory.md --- Inventory/Check inventory.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) 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 ``` { From 9851a337ec88797c6b139d8b57bac10d719fa51e Mon Sep 17 00:00:00 2001 From: Sonam Vohra <145959451+svohra1206@users.noreply.github.com> Date: Fri, 29 Sep 2023 12:44:58 +0530 Subject: [PATCH 26/27] Update Update Inventory.md --- Inventory/Update Inventory.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) 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 ``` { From 4c1b9210b2e25730b36d603566e3272b12f43d83 Mon Sep 17 00:00:00 2001 From: Sonam Vohra <145959451+svohra1206@users.noreply.github.com> Date: Fri, 29 Sep 2023 12:58:06 +0530 Subject: [PATCH 27/27] Update BOPIS PDP Experience.md --- Journeys/BOPIS PDP Experience.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) 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 ``` {