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

Created documentation for Get and Set Shopify Customer Default Store API #34

Closed
wants to merge 27 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
502f11e
Create Get Shopify Customer Default Store API.md
svohra1206 Sep 28, 2023
db93984
Updated Get Shopify Customer Default Store API.md
svohra1206 Sep 28, 2023
aedc94b
Update Get Shopify Customer Default Store API.md
svohra1206 Sep 28, 2023
3b0e3c0
Create Set Shopify Customer default Store.md
svohra1206 Sep 28, 2023
88a024d
Update Set Shopify Customer default Store.md
svohra1206 Sep 28, 2023
de83eba
Update Get Shopify Customer Default Store API.md
svohra1206 Sep 28, 2023
95f9a39
Update Set Shopify Customer default Store.md
svohra1206 Sep 28, 2023
97dc4ed
Update Get Shopify Customer Default Store API.md
svohra1206 Sep 28, 2023
deb2266
Update Post code lookup.md
svohra1206 Sep 29, 2023
ae9d28b
Update Store lookup.md
svohra1206 Sep 29, 2023
d5f32a3
Update Add shipment box.md
svohra1206 Sep 29, 2023
c842964
Update Create picklist.md
svohra1206 Sep 29, 2023
d795c65
Update In progress orders.md
svohra1206 Sep 29, 2023
3b0a708
Update Outstanding orders.md
svohra1206 Sep 29, 2023
aa322b8
Update Packing slip PDF.md
svohra1206 Sep 29, 2023
de60cf8
Update Ready-to-ship items.md
svohra1206 Sep 29, 2023
d88c824
Update Outstanding orders.md
svohra1206 Sep 29, 2023
eabdfab
Update In progress orders.md
svohra1206 Sep 29, 2023
96aa70a
Update Create picklist.md
svohra1206 Sep 29, 2023
95b22f7
Update Retry shipping label.md
svohra1206 Sep 29, 2023
008a517
Update Shipping label PDF..md
svohra1206 Sep 29, 2023
3ea45d5
Update Shipping label and packing slip.md
svohra1206 Sep 29, 2023
cb73933
Update Update orders.md
svohra1206 Sep 29, 2023
f729df2
Update Upload and Import file.md
svohra1206 Sep 29, 2023
d844c84
Update Check inventory.md
svohra1206 Sep 29, 2023
9851a33
Update Update Inventory.md
svohra1206 Sep 29, 2023
4c1b921
Update BOPIS PDP Experience.md
svohra1206 Sep 29, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Facility/Post code lookup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
22 changes: 11 additions & 11 deletions Facility/Store lookup.md
Original file line number Diff line number Diff line change
@@ -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,
Expand All @@ -26,7 +26,7 @@ Content-Type: application/json
}
```

### Parameters
#### Parameters

| Parameter | Description | Required (Y/N) |
|---------------|-----------------------------------------------------------|----------|
Expand All @@ -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":
Expand Down Expand Up @@ -125,8 +125,8 @@ Content-Type: application/json

<br></br>

## 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:

Expand All @@ -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

<ul>
<li>RETAIL</li>
Expand Down
8 changes: 4 additions & 4 deletions Fulfillment/APIs/Add shipment box.md
Original file line number Diff line number Diff line change
@@ -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://<host>/api/addShipmentPackage`

Example: https://demo-oms.hotwax.io/api/addShipmentPackage

### Header
#### Header

#### Body

Expand All @@ -29,7 +29,7 @@ Example: https://demo-oms.hotwax.io/api/addShipmentPackage

## Response

### Header
#### Header

#### Body

Expand Down
2 changes: 1 addition & 1 deletion Fulfillment/APIs/Create picklist.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion Fulfillment/APIs/In progress orders.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion Fulfillment/APIs/Outstanding orders.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion Fulfillment/APIs/Packing slip PDF.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion Fulfillment/APIs/Ready-to-ship items.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion Fulfillment/APIs/Retry shipping label.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion Fulfillment/APIs/Shipping label PDF..md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion Fulfillment/APIs/Shipping label and packing slip.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
10 changes: 5 additions & 5 deletions Fulfillment/APIs/Update orders.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -14,7 +14,7 @@ Example: https://demo-oms.hotwax.io/api/updateOrder

#### For Order Item rejection:

##### Body
#### Body

```
facilityId: <facilityId>,
Expand Down Expand Up @@ -42,7 +42,7 @@ rej_rejectionReason_0: item.rejectReason

#### For Shipment Package Change:

##### Body
#### Body

```
facilityId: <facilityId>,
Expand Down Expand Up @@ -73,7 +73,7 @@ rtp_newShipmentId_1: shipmentPackage.shipmentId

#### For Order Item rejection:

##### Body
#### Body

```
facilityId: <facilityId>,
Expand All @@ -89,7 +89,7 @@ _EVENT_MESSAGE_: "Order updated successfully"

#### For Shipment Package Change:

##### Body
#### Body

```
facilityId: <facilityId>,
Expand Down
2 changes: 1 addition & 1 deletion Fulfillment/APIs/Upload and Import file.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
6 changes: 3 additions & 3 deletions Inventory/Check inventory.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -13,7 +13,7 @@ Example: https://demo-oms.hotwax.io/api/checkInventory
Content-Type: application/json


### Body
#### Body
```
{
"filters": {
Expand Down Expand Up @@ -41,7 +41,7 @@ HTTP/1.1 200 OK
Content-Type: application/json


### Body
#### Body

```
{
Expand Down
6 changes: 3 additions & 3 deletions Inventory/Update Inventory.md
Original file line number Diff line number Diff line change
@@ -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:

Expand Down Expand Up @@ -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
```
{
{
Expand Down Expand Up @@ -89,7 +89,7 @@ HTTP/1.1 200 OK
Content-Type: application/json


### Body
#### Body

```
{
Expand Down
24 changes: 12 additions & 12 deletions Journeys/BOPIS PDP Experience.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -16,9 +16,9 @@ To show available pickup facilities near the customer, the latitude and longitud

#### Sample:

Method: `POST`
Method: `/POST`

##### Request
## Request
```
{
"json": {
Expand All @@ -27,7 +27,7 @@ Method: `POST`
}
```

##### Response
## Response
```
{
"responseHeader": {
Expand Down Expand Up @@ -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,
Expand All @@ -76,7 +76,7 @@ Method: `POST`

```

##### Response
## Response
```
{
"responseHeader": {
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -210,7 +210,7 @@ In case the customer's location is not available, you can display all the availa

#### Sample:

##### Request
## Request

```
{
Expand Down
Loading