Introduction
3 min
Overview
These APIs manage the shipping method for the tenant and the consumer.
In This Section
Shipping Method Consumer APIs
These APIs allow the consumer to manage the shipping method for their orders.
- Create Labels: This endpoint creates the labels associated with a shipment.
- Get Rate for Cart: This endpoint returns the shipping rate for the current cart.
- Get Rate for Item: This endpoint returns the shipping rate for a specific item.
Shipping Method Management APIs
These APIs allow the administrator to manage the shipping method such as creating, updating or deleting methods.
- Create Shipping Carrier: This endpoint allows the administrator to create a new shipping carrier with the provided details.
- Create Shipping Fee: This endpoint allows the administrator to create a new shipping fee.
- Create Shipping Method: This endpoint allows the administrator to create a new shipping method with the provided details.
- Delete Shipping Fee: This endpoint allows administrators to delete an existing shipping fee.
- Get Alternative Shipping Method: This endpoint allows the administrator to retrieve an alternative shipping rate for the specified cart.
- Get Shipping Carrier by ID: This endpoint fetches a set of shipping carriers based on the IDs passed in.
- Get Shipping Carrier by ID: This endpoint fetches the details of the specified shipping carrier based on the ID passed in.
- Get Shipping Fee by ID: This endpoint fetches the details of the specified shipping fee based on the ID passed in.
- Get Shipping Method by ID: This endpoint returns the details of the specified shipping method based on the ID passed in.
- Get Shipping Method by IDs: This endpoint returns a set of shipping methods based on the IDs passed in.
- Update Shipping Carrier: This endpoint allows the administrator to update the details of an existing shipping carrier.
- Update Shipping Fee: This endpoint allows the administrator to update the details of an existing shipping fee.
- Update Shipping Method: This endpoint allows the administrator to update the details of an existing shipping method.
Shipping Method Search Integration APIs
- Reindex Shipping Methods: This endpoint allows the administrators to reindex shipping method search data.
- Reindex Shipping Carriers: This endpoint allows the administrators to reindex shipping carrier search data.
- Reindex Shipping Fees: This endpoint allows the administrators to reindex shipping fee search data.