📖Haravan

Node Haravan cho phép các nhà phát triển mở rộng các tính năng tích hợp của nền tảng, cho phép các đối tác đọc và ghi dữ liệu người bán cũng như tương tác với các hệ thống và nền tảng khác. Cùng với đó, tài khoản quản trị Haravan được sử dụng để đọc và ghi dữ liệu về cửa hàng thương mại, sản phẩm, đơn đặt hàng, v.v. Đối với tài khoản đối tác Haravan được sử dụng để truy cập dữ liệu có trong Partner Dashboard. Quyền truy cập này cho phép Đối tác mở rộng quy mô kinh doanh một cách hiệu quả bằng cách tự động hóa các hoạt động văn phòng trước và sau, giải phóng thời gian để tập trung vào việc cung cấp giá trị cho các thương nhân Haravan.

Trên trang này, bạn sẽ tìm thấy danh sách các hoạt động mà Haravan node hỗ trợ và liên kết đến nhiều tài nguyên hơn.

Xác thực và ủy quyền: Tham khảo Haravan Authentication để được hướng dẫn thiết lập xác thực và ủy quyền.

Basic Operations

Customer
- Retrieve a list of customers
- Search for customers that match a supplied query
- Retrieve detail of a customer
- Retrieve the count of customers
- Create customer
- Delete a customer
- Update customer
Inventory
- Retrieve a list of inventory adjustments
- Retrieve a count of the inventory adjustments
- Retrieve a single inventory adjustment
- Create an inventory adjustment
Order
- Retrieve a list of all checkouts
- Retrieve a count of all checkouts
- Retrieve a list of orders
- Retrieve a count of the orders
- Retrieve a single order
- Retrieves a list of refunds for an order
- Retrieves a single refund for an order
- Retrieves a list of transactions of an order
- Retrieves a single transaction of an order by ID
- Update order
- Create an order
Products
- Retrieve a list of collects
- Retrieve a count of all collects
- Retrieve detail of a collect
- Retrieve a list of products
- Retrieve a count of the products
- Retrieves single the product
- Create a new product
- Delete a product along with all its variants and images
- Update a product
- Delete a collect
- Create a new collect
Shipping and fulfillment
- Retrieves a list of fulfillments for an order
- Retrieves the count of fulfillments for an order
- Retrieves a single fulfillment for an order
- Create a new fulfillment
- Update an existing fulfillment
Location
- Retrieve a list of locations
- Retrieve a single location

Example Usage

Quy trình làm việc này cho phép bạn có thể tạo tài khoản cho khách hàng. Quy trình sử dụng ví dụ này sẽ sử dụng các node sau. - Start – Haravan 2.0.

Nếu bạn chưa có access token. Quy trình làm việc của bạn là: - Start – Haravan Authentication – Haravan 2.0.

1. Start node

Start node tồn tại theo mặc định khi bạn tạo workflow mới.

2. Haravan Authentication node

note: Nếu bạn có access token hãy bỏ qua phần này và di chuyển đến phần 3. Haravan Node

Nếu bạn chưa có access token thì sử dụng node Haravan Authentication để lấy access token

Bạn sẽ sử dụng node Haravan Authentication lấy access token để sử dụng cho các action trong node Haravan 2.0. Trước đó, bạn phải create new credentials để lấy code.

Click on the Add node or drag to connect button và điền Haravan Authentication trong search nodes box.
Lựa chọn Create new credential tại trường Credential to connect with.

Ảnh chụp màn hình bên dưới là các trường bắt buộc cung cấp thông tin kết nối cần thiết để nhận code.

Sau khi cung cấp Client ID, Client Secret, Redirect URI và lựa chọn "Authorization Code" danh sách dropdown của trường Grant Type.

Sau khi cung cấp các thông tin cần thiết xong, bạn hãy nhấp nút Connect my account, thì cửa số cấp quyền xuất hiện và hiển thị các quyền cho app của bạn. Bạn có thể tiếp tục để lấy code hãy chọn "YES".

Sau khi nhấn nút "YES", trình duyệt sẽ chuyển hướng đến URI chuyển hướng được đính kèm với code của bạn. Code của bạn là chuỗi sau xâu chuỗi "code=". Haravan sẽ redirect ngược lại về Allowed redirection URL kèm theo Code. VD: nếu Allowed redirection URL = https://www.haravan.com/ thì Haravan API sẽ redirect ngược lại về link https://www.haravan.com/?code=

Sau khi lấy được code bạn đóng Code window và trở về màn hình credential. Ngay lúc này bạn tắt nó và chỉ cần bấm đóng khi thông Close without connecting xuất hiện vì Haravan chưa có Authorization server hỗ trợ giao thức OAuth 2.0. Điều này sẽ không ảnh hưởng đến các quá trình tiếp theo.

Tiếp tục, bạn sẽ dán code được cung cấp vào trường Code. Sau đó, bạn sẽ nhấn nút Execute node để lấy access Token.

Sau khi thực thi node Haravan Authentication:

3. Haravan node

Click on the Add node or drag to connect button và điền Haravan trong search nodes box.

Lựa chọn Create new credential tại trường Credential to connect with.

Điền Access Token của app trong trường Access Token.

note: Nếu bạn không lấy access token từ node Haravan Authentication, theo liên kết này để có được access token (How to get token of your app ?). Ngược lại bạn sẽ phải lấy access_token bạn nhận từ node Haravan Authentication để điền vào trường Access Token. Sau đó, bạn có thể nhấp nút save để hoàn thành việc tạo credentials.

Create customer

Tìm kiếm Create customer trong search Haravan 2.0 Actions box.

Sau đó, bạn có thể nhập các trường thông tin sau để tạo mới 1 khách hàng

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Create customer action.

Update customer

Tìm kiếm Update customer trong search Haravan 2.0 Actions box.

Để sử dụng action này bạn sẽ phải cung cấp Customer ID tương ứng với khách hàng mà bạn muốn cập nhật thông tin.

Cung cấp thông tin cần chỉnh sửa cho một khách hàng bằng cách điền vào các trường sau:

note: trường bạn để trống thì Haravan sẽ giữ nguyên thông tin trước đó.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Update customer action.

Retrieve a list of customers

Tìm kiếm Retrieve a list of customers trong search Haravan 2.0 Actions box.

Bạn có thể nhập các trường trong hình bên dưới để filter và phân trang hiển thị danh sách khách hàng.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Retrieve a list of customers action.

Search for customers that match a supplied query

Tìm kiếm Search for customers that match a supplied query trong search Haravan 2.0 Actions box.

Bạn có thể nhập các trường trong hình bên dưới để filter và phân trang để tìm kiếm khách hàng phù hợp với truy vấn được cung cấp.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Search for Customers that Match a Supplied Query action.

Retrieve the count of customers

Tìm kiếm Retrieve the count of customers trong search Haravan 2.0 Actions box.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Retrieve the count of customers action.

Retrieve detail of a customer

Tìm kiếm Retrieve detail of a customer trong search Haravan 2.0 Actions box.

Để sử dụng action này bạn sẽ phải cung cấp Customer ID tương ứng với khách hàng mà bạn muốn xem thông tin chi tiết.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Retrieve detail of a customer action.

Delete a customer

Tìm kiếm Delete a customer trong search Haravan 2.0 Actions box.

Để sử dụng action này bạn sẽ phải cung cấp Customer ID tương ứng với khách hàng mà bạn muốn xóa.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Delete a customer action.

Create an inventory adjustment

Tìm kiếm Create an inventory adjustment trong search Haravan 2.0 Actions box.

Sau đó, bạn có thể nhập các trường thông tin sau để tạo điều chỉnh hàng tồn kho.

Note: Bạn phải nhập location ID nơi tồn kho của bạn và nhập tối thiểu một item để thực thi điều chỉnh hàng tồn kho.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Create an inventory adjustment action.

Retrieve a list of inventory adjustments

Tìm kiếm Retrieve a list of inventory adjustments trong search Haravan 2.0 Actions box.

Bạn có thể nhập các trường trong hình bên dưới để filter và phân trang hiển thị danh sách điều chỉnh hàng tồn kho.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Retrieves a list of inventory adjustments action.

Retrieve a single inventory adjustment

Tìm kiếm Retrieve a single inventory adjustment trong search Haravan 2.0 Actions box.

Để sử dụng action này bạn sẽ phải cung cấp Adjustment ID tương ứng với 1 điều chỉnh hàng tồn kho mà bạn muốn xem thông tin chi tiết.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Retrieve a single inventory adjustment action.

Retrieve a count of the inventory adjustments

Tìm kiếm Retrieve a count of the inventory adjustments trong search Haravan 2.0 Actions box.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Retrieve a count of the inventory adjustments action.

Create an order

Tìm kiếm Create an order trong search Haravan 2.0 Actions box.

Sau đó, bạn có thể nhập các trường thông tin sau để tạo mới 1 đơn hàng

Note: bạn phải nhập address1, address2, phone number và line items phải có tối thiểu 1 sản phẩm

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Create an order action.

Update order

Tìm kiếm Update order trong search Haravan 2.0 Actions box.

Để sử dụng action này bạn sẽ phải cung cấp Order ID tương ứng với đơn hàng mà bạn muốn cập nhật thông tin.

Cung cấp thông tin cần chỉnh sửa cho một đơn hàng bằng cách điền vào các trường sau:

note: trường bạn để trống thì Haravan sẽ giữ nguyên thông tin trước đó.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Update Order action.

Retrieve a list of orders

Tìm kiếm Retrieve a list of orders trong search Haravan 2.0 Actions box.

Bạn có thể nhập các trường trong hình bên dưới để filter và phân trang hiển thị danh sách khách hàng.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Retrieve a list of orders action.

Retrieves a List of Refunds for an Order

Tìm kiếm Retrieves a List of Refunds for an Order trong search Haravan 2.0 Actions box.

Để sử dụng action này bạn sẽ phải cung cấp Order ID tương ứng với đơn hàng mà bạn muốn xem danh sách refund của đơn hàng đó.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Retrieves a List of Refunds for an Order action.

Retrieves a single refund for an order

Tìm kiếm Retrieves a single refund for an order trong search Haravan 2.0 Actions box.

Để sử dụng action này bạn sẽ phải cung cấp Order ID tương ứng với đơn hàng và Refund ID của đơn hàng đó mà bạn muốn xem thông tin chi tiết.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Retrieves a single refund for an order action.

Retrieves a list of transactions of an order

Tìm kiếm Retrieves a list of transactions of an order trong search Haravan 2.0 Actions box.

Để sử dụng action này bạn sẽ phải cung cấp Order ID tương ứng với đơn hàng mà bạn muốn xem thông tin các transaction.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Retrieves a list of transactions of an order action.

Retrieves a Single Transaction of an Order by ID

Tìm kiếm Retrieves a Single Transaction of an Order by ID trong search Haravan 2.0 Actions box.

Để sử dụng action này bạn sẽ phải cung cấp Order ID tương ứng với đơn hàng và Transaction ID của đơn hàng đó mà bạn muốn xem thông tin chi tiết.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Retrieves a Single Transaction of an Order by ID action.

Retrieve a Single Order

Tìm kiếm Retrieve a Single Order trong search Haravan 2.0 Actions box.

Để sử dụng action này bạn sẽ phải cung cấp Order ID tương ứng với đơn hàng mà bạn muốn xem thông tin chi tiết.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Retrieve a Single Order action.

Retrieve a count of the orders

Tìm kiếm Retrieve a count of the orders trong search Haravan 2.0 Actions box.

Bạn có thể nhập trường Order Status trong hình bên dưới để lấy số lượng loại đơn hàng mà bạn muốn xem.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Retrieve a count of the orders action.

Retrieve a list of all checkouts

Tìm kiếm Retrieve a list of all checkouts trong search Haravan 2.0 Actions box.

Bạn có thể nhập các trường trong hình bên dưới để filter và phân trang hiển thị danh sách Abandoned checkouts.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Retrieve a list of all checkouts action.

Retrieve a count of all checkouts

Tìm kiếm Retrieve a count of all checkouts trong search Haravan 2.0 Actions box.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Retrieve a count of all checkouts action.

Create a new product

Tìm kiếm Create a new product trong search Haravan 2.0 Actions box.

Sau đó, bạn có thể nhập các trường thông tin sau để tạo mới 1 sản phẩm

Note: Bạn phải nhập Product Type, Product Name và Vendor, còn các trường còn lại bạn có thể nhập nhưng không bắt buộc.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Create a new product action.

Update a product

Tìm kiếm Update a product trong search Haravan 2.0 Actions box.

Để sử dụng action này bạn sẽ phải cung cấp Product ID tương ứng với sản phẩm mà bạn muốn cập nhật thông tin.

Cung cấp thông tin cần chỉnh sửa cho một sản phẩm bằng cách điền vào các trường sau:

note: trường bạn để trống thì Haravan sẽ giữ nguyên thông tin trước đó.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Update a product action.

Retrieve a list of products

Tìm kiếm Retrieve a list of products trong search Haravan 2.0 Actions box.

Bạn có thể nhập các trường trong hình bên dưới để filter và phân trang hiển thị danh sách sản phẩm.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Retrieve a list of products action.

Retrieve a count of the products

Tìm kiếm Retrieve a count of the products trong search Haravan 2.0 Actions box.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Retrieve a count of the products action.

Retrieves single the product

Tìm kiếm Retrieves single the product trong search Haravan 2.0 Actions box.

Để sử dụng action này bạn sẽ phải cung cấp Product ID tương ứng với sản phẩm mà bạn muốn xem thông tin chi tiết.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Retrieves single the product action.

Delete a product along with all its variants and images

Tìm kiếm Delete a product along with all its variants and images trong search Haravan 2.0 Actions box.

Để sử dụng action này bạn sẽ phải cung cấp Product ID tương ứng với sản phẩm mà bạn muốn xóa.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Delete a product along with all its variants and images action.

Create a new collect

Tìm kiếm Create a new collect trong search Haravan 2.0 Actions box.

Để sử dụng action này bạn sẽ phải cung cấp Product ID và Collection ID mà bạn muốn Product ID truyền vào thuộc vào nhóm tương ứng Collection ID đó.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Create a new collect action.

Retrieve a list of collects

Tìm kiếm Retrieve a list of collects trong search Haravan 2.0 Actions box.

Bạn có thể nhập các trường trong hình bên dưới để filter và phân trang hiển thị danh sách các bộ sưu tập.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Retrieve a list of collects action.

Retrieve a count of all collects

Tìm kiếm Retrieve a count of all collects trong search Haravan 2.0 Actions box.

Bạn có thể lựa chọn Retrieval Type (Count All Collects, Count only Collects for a Certain Collection, Count only Collects for a Certain Collection).

TH1: Bạn chọn 'Count All Collects' thì sẽ hiển thị hết số lượng bô sưu tập hiện có.

TH2: Bạn chọn 'Count only Collects for a Certain Collection' thì bạn sẽ phải nhập Collection ID để hiển thị số lượng bộ sưu tập tương ứng với Collection ID đó.

TH3: Bạn chọn 'Count only Collects for a Certain Collection' thì bạn sẽ phải nhập Product ID để hiển thị số lượng bộ sưu tập tương ứng với Product ID đó.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Retrieve a count of all collects action.

Retrieve Detail of a Collect

Tìm kiếm Retrieve Detail of a Collect trong search Haravan 2.0 Actions box.

Để sử dụng action này bạn sẽ phải cung cấp Collect ID tương ứng với bộ sưu tập mà bạn muốn xem thông tin chi tiết.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Retrieve detail of a collect action.

Delete a collect

Tìm kiếm Delete a collect trong search Haravan 2.0 Actions box.

Để sử dụng action này bạn sẽ phải cung cấp Collect ID tương ứng với bộ sưu tập mà bạn muốn xóa.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Delete a collect action.

Create a new fulfillment

Tìm kiếm Create a new fulfillment trong search Haravan 2.0 Actions box.

Để sử dụng action này bạn sẽ phải cung cấp Order ID tương ứng với đơn hàng mà bạn muốn hoàn thành và phải cung cấp Tracking Number.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Create a new fulfillment action.

Update an existing fulfillment

Tìm kiếm Update an existing fulfillment trong search Haravan 2.0 Actions box.

Để sử dụng action này bạn sẽ phải cung cấp Order ID và Fulfillment ID tương ứng đơn hàng hoàn thành mà bạn muốn cập nhật.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Update an existing fulfillment action.

Retrieves a list of fulfillments for an order

Tìm kiếm Retrieves a list of fulfillments for an order trong search Haravan 2.0 Actions box.

Bạn phải cung cấp Order ID tương ứng với đơn hàng và có thể nhập các trường trong hình bên dưới để filter và phân trang hiển thị danh sách fulfillment của đơn hàng đó.

Cuối cùng, bạn click vào nút Execute node để chạy Haravan node thực thi Retrieves a list of fulfillments for an order action.