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

HotWax carrier integration API document #833

Open
wants to merge 7 commits into
base: user-guides-pub
Choose a base branch
from

Conversation

AjinkyaM1
Copy link
Contributor

This document outlines the integration process for carriers with the HotWax platform using the Carrier Integration API. It includes details on request and response formats, parameters for shipment details, and error handling

@AjinkyaM1 AjinkyaM1 requested a review from dt2patel October 17, 2024 13:09
@AjinkyaM1 AjinkyaM1 added the documentation Improvements or additions to documentation label Oct 17, 2024
@AjinkyaM1 AjinkyaM1 self-assigned this Oct 17, 2024
Copy link
Contributor

@dt2patel dt2patel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we have a rate request API? Or only a label fetch API?


## Endpoint

**URL**: `<insert_endpoint_here>`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Which URL is this supposed to be? Is this the endpoint of the carrier which is receiving this JSON? @AjinkyaM1

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed the endpoint from this document. Initially, I planned to include the carrier's endpoint, but since third parties can integrate with us, the endpoints may vary. Additionally, the endpoints can differ for each carrier.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also added the document with the rate and void label requests.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How is it possible that there is no URL for the API? There must be some defined pattern.

@AjinkyaM1
Copy link
Contributor Author

Do we have a rate request API? Or only a label fetch API?

Yes, we have both the rate request and the void request. I have documented them in the latest commit.

@AjinkyaM1 AjinkyaM1 requested a review from dt2patel December 16, 2024 05:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants