Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated formatting for FAQs #80

Merged
merged 10 commits into from
Dec 30, 2022
10 changes: 5 additions & 5 deletions auditing/audit-and-correct-shopify-pre-order-details.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,19 @@ Merchants can audit and correct pre-order items details right from the view prod

*Customer quote*

## FAQs
### FAQs

#### Question 1: When pre-order details are corrected in HotWax, how will changes be synced in Shopify?
**Question 1: When pre-order details are corrected in HotWax, how will changes be synced in Shopify?**

Answer: Corrections in pre-order items details will be synced in Shopify via Rest API.

#### Question 2: In case of multiple Shopify stores, how will we audit pre-order items statuses?
**Question 2: In case of multiple Shopify stores, how will we audit pre-order items statuses?**

Answer: View product page will display pre-order item’s status for each Shopify config so the status can be validated for all the Shopify stores at once.

## Internal FAQs
### Internal FAQs

#### Question 1: Will HotWax identify the exact cause of pre-order item’s status variations?
**Question 1: Will HotWax identify the exact cause of pre-order item’s status variations?**

Answer: The product view page will display the most recent records of HotWax’s product category decision reason table. These details help users identify when and why a pre-order item has been added or removed from the pre–order category. GraphQL logs for the selected variant will also be shown for each Shopify store selling the product to help easily check recent relevant API calls from HotWax to list or delist the product for pre-order.

Expand Down
6 changes: 3 additions & 3 deletions auditing/shopify-graphql-api-log-auditing.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,17 @@ Merchants using HotWax Commerce will already receive the feature to audit GraphQ

### FAQs

#### Question 1: How would API logs account for partially failed mutations?
**Question 1: How would API logs account for partially failed mutations?**

Answer: Developers can check the files pushed by HotWax and can also verify how the file has been processed by Shopify. API logs display “error” as the response message in a specific row pinpointing which particular operation has been failed.

### Internal FAQs

#### Question 1: Is it possible to look up an operation for a product?
**Question 1: Is it possible to look up an operation for a product?**

Answer: Yes, users can go to the find look up screen and search API logs by Product ID and other keywords.

#### Question 2: Would API logs also show jobs with the running status?
**Question 2: Would API logs also show jobs with the running status?**

Answer: Yes, jobs that are currently being processed will be displayed with a running status.

9 changes: 5 additions & 4 deletions brokering/shipt-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,22 @@ Merchants using ShipT as their shipping carrier for last mile deliveries will be

### FAQs

#### Question 1: How is an order processed if it is only partially eligible for same or next day delivery?
**Question 1: How is an order processed if it is only partially eligible for same or next day delivery?**

Answer: Currently, HotWax does not support split orders with ShipT. Therefore, shopping carts will be evaluated based on availability of all order items.

#### Question 2: How will we communicate to ShipT about order cancellations?
**Question 2: How will we communicate to ShipT about order cancellations?**

Answer: Orders cannot be canceled once they are under the processing status. Customers need to contact the support reps for order cancellations. CSRs would then contact ShipT to convey about the order cancellation requests.

#### Question 3: If an order’s expected ship date differs from the delivery date confirmed by ShipT, how would we communicate to customers about changes?
**Question 3: If an order’s expected ship date differs from the delivery date confirmed by ShipT, how would we communicate to customers about changes?**

Answer: HotWax reads order updates from ShipT and triggers an email update to customers if there are any changes in the delivery dates confirmed by ShipT.

### Internal FAQs

#### Question 1: Which ShipT updates will be supported using webhooks?
**Question 1: Which ShipT updates will be supported using webhooks?**

Answer: HotWax reads fulfillment updates from ShipT webhooks for complete and canceled.


8 changes: 4 additions & 4 deletions import/custom-date-format-in-po-upload.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,21 @@ Date formats can be configured and mapped before uploading in the settings page

### FAQs

#### Question 1: Do we need to select the date format every time before uploading a PO?
**Question 1: Do we need to select the date format every time before uploading a PO?**

Answer: No, the selected date formats will be saved at the company level. If users want to switch to some other date format, they may also update their existing date format and save the new format.

#### Question 2: Is it possible to change the date format after uploading a PO?
**Question 2: Is it possible to change the date format after uploading a PO?**

Answer: Yes, date formats can be updated after uploading and while reviewing. Users can also access the list of all the available date formats directly from the Import App.

### Internal FAQs

#### Question 1: Where will HotWax Commerce store merchant-specific custom date formats?
**Question 1: Where will HotWax Commerce store merchant-specific custom date formats?**

Answer: HotWax will create a product store setting to save the custom date format data selected at the company level.

#### Question 2: Which tool will provide the data on date formats supported by HotWax?
**Question 2: Which tool will provide the data on date formats supported by HotWax?**

Answer: Import App users can check the [Luxon date time format](https://moment.github.io/luxon/#/formatting?id=table-of-tokens) to view the list of all available date formats right from the settings page.

Expand Down
4 changes: 2 additions & 2 deletions import/identify-duplicate-po-id.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Merchandisers using HotWax Commerce Import App for managing their purchase order

### FAQs

**Question1: Do we need to remap the PO fields after receiving a warning message for uploading PO with the same reference ID?**
**Question 1: Do we need to remap the PO fields after receiving a warning message for uploading PO with the same reference ID?**

Answer: No, Import App users can directly rename the PO without having to remap the PO fields.

Expand All @@ -30,6 +30,6 @@ Answer: Currently the feature is not available but HotWax can implement auto-nam

### Internal FAQs

**Question1: Which APIs will be used to identify the duplicate PO ID and display the warning message?**
**Question 1: Which APIs will be used to identify the duplicate PO ID and display the warning message?**

Answer: The app will run a SOLR query to identify a duplicate PO ID. The query looks up if a PO ID already exists in its index and reads the results. If the search response hits a matching PO ID, the Import App displays the warning message.
11 changes: 5 additions & 6 deletions integration/generic-webhook-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,21 @@ To start using standardized naming conventions users will need to re-subscribe t

### FAQs

#### Question 1: Is it possible to edit the parameters once they are defined in the system?
**Question 1: Is it possible to edit the parameters once they are defined in the system?**

Answer: Yes, HotWax may edit existing parameters to define new standardized naming conventions.

### Internal FAQs

#### Question 1: Where would we save URL naming conventions?
**Question 1: Where would we save URL naming conventions?**

Answer: URL naming conventions will be saved in a data configuration table.

#### Question 2: How would we decouple integration and end points?
**Question 2: How would we decouple integration and end points?**

Answer: All the URLs are saved and mapped in a data configuration table. Instead of managing hardcoded URLs, we are mapping the action and config with the transformation ID.
The abstraction in the table allows updating the current action and config without changing the URL.
Answer: All the URLs are saved and mapped in a data configuration table. Instead of managing hardcoded URLs, we are mapping the action and config with the transformation ID. The abstraction in the table allows updating the current action and config without changing the URL.

#### Question 3: How would we add a new location when integrating a new system with OMS?
**Question 3: How would we add a new location when integrating a new system with OMS?**

Answer: Data management configuration in HotWax allows editing of the existing URL framework. A new URL/location will be supported by defining the required action and attaching a transformation.

Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,16 @@ Merchants using HotWax Commerce will automatically be switched to using webhook

### FAQs

#### Question 1: If multiple jobs are scheduled at the same time, in what order HotWax will push GraphQL files to Shopify?
**Question 1: If multiple jobs are scheduled at the same time, in what order HotWax will push GraphQL files to Shopify?**

Answer: HotWax Commerce pushes GraphQL files to Shopify on the basis of first come first serve.

#### Question 2: Does Shopify’s file processing status webhook let HotWax Commerce know about failed operations too?
**Question 2: Does Shopify’s file processing status webhook let HotWax Commerce know about failed operations too?**

Answer: Yes, Shopify’s file processing status webhook will let HotWax know about canceled or failed operations. The decision to push the next GraphQL file can be taken based on this information.

### Internal FAQs

#### Question 1: What would be the scenario in case an operation fails? Will HotWax automatically request the next GraphQL file for processing?
**Question 1: What would be the scenario in case an operation fails? Will HotWax automatically request the next GraphQL file for processing?**

Answer: If an operation fails, HotWax Commerce will push the next queued GraphQL file for processing to Shopify.
11 changes: 6 additions & 5 deletions job-manager/advanced-job-parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,24 +16,25 @@ Merchants using the Job Manager App will already receive the feature to add opti

### FAQs

#### Question 1: Can all the Job Manager users pass custom parameters in the job run time data?
**Question 1: Can all the Job Manager users pass custom parameters in the job run time data?**

Answer: Only admins will be allowed to pass their special parameters for a higher security clearance, ensuring unaware users do not unknowingly input wrong keys or values.

#### Question 2: What would be the outcome in case a user inputs the wrong key or value?
**Question 2: What would be the outcome in case a user inputs the wrong key or value?**

Answer: The job fails if a wrong key or value is entered. Failed jobs are visible in the history page.

#### Question 3: How many custom parameters can be passed in a service?
**Question 3: How many custom parameters can be passed in a service?**

Answer: Admins may pass as many optional parameters as required to configure jobs as per the need.

#### Question 4: How can we ensure if the user defined parameters were actually considered and accepted by the service?
**Question 4: How can we ensure if the user defined parameters were actually considered and accepted by the service?**

Answer: Users can review the passed parameters in the job dataset, however, it is not possible to monitor their impact on a service.

### Internal FAQs

#### Question 1: Is it completely a self-serve feature or do we need to provide some type mappings in the job dataset?
**Question 1: Is it completely a self-serve feature or do we need to provide some type mappings in the job dataset?**

Answer: It’s a self-serve tool, users need to insert the specific key and values.

6 changes: 3 additions & 3 deletions job-manager/bulk-scheduling-jobs.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,17 @@ Merchants using HotWax Commerce already have access to the Job Manager App. To b

### FAQs

#### Question 1: Is it possible to schedule a job only for some specific Shopify stores?
**Question 1: Is it possible to schedule a job only for some specific Shopify stores?**

Answer: Users have the flexibility to select their preferred Shopify stores and jobs that they’d want to schedule for them. The selected jobs will be scheduled for all the chosen Shopify stores, users cannot schedule those selected jobs only for a subset of the selected configs.

#### Question 2: What would be the scenario if each Shopify store has a different product catalog?
**Question 2: What would be the scenario if each Shopify store has a different product catalog?**

Answer: Bulk scheduling works at a product store level with multiple Shopify configs. If a brand has multiple product stores and a unique product catalog for each of its connected Shopify stores, users must schedule jobs for each product store separately.

### Internal FAQs

#### Question 1: Would we allow bulk scheduling miscellaneous jobs as well?
**Question 1: Would we allow bulk scheduling miscellaneous jobs as well?**

Answer: Yes, all the jobs in the Job Manager App, including miscellaneous jobs, are eligible for bulk scheduling.

10 changes: 5 additions & 5 deletions pre-order/filter-sales-order-by-purchase-orders.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,24 +16,24 @@ Merchants using HotWax Commerce will already receive the feature to filter sales

### FAQs

#### Question 1: Would the list of orders also include canceled orders?
**Question 1: Would the list of orders also include canceled orders?**

Answer: Yes, all sales orders associated with a PO, including canceled orders, will be displayed.

#### Question 2: If a customer has placed a mixed cart order, would the results only reflect the pre-order item or would it also include the regular item?
**Question 2: If a customer has placed a mixed cart order, would the results only reflect the pre-order item or would it also include the regular item?**

Answer: Only the order item associated with the PO is visible in the search results, however, on clicking into an order, all of the items in the order are displayed.

#### Question 3: Is it still possible to view all the sales orders received against a PO, even after the on-order inventory has been received?
**Question 3: Is it still possible to view all the sales orders received against a PO, even after the on-order inventory has been received?**

Answer: Yes, PO allocations can be viewed even after the on-order inventory has been physically received because the PO association is saved as a corresponding PO on the sales order item.

#### Question 4: Would it be possible to search PO allocations directly from the find order page?
**Question 4: Would it be possible to search PO allocations directly from the find order page?**

Answer: No, users must go to the purchase order find page, select the purchase order for which they want to check the received sales orders, and then click on the link to view all PO allocations.

### Internal FAQs

#### Question 1: How would we identify sales orders based on the associated POs?
**Question 1: How would we identify sales orders based on the associated POs?**

Answer: To uniquely identify and filter sales orders based on the associated POs, we link orders with the corresponding PO ID.