Handling Shipping Methods in Venddor IO

Introduction

Venddor IO offers a structured approach to managing shipping methods, ensuring businesses can streamline their logistics processes efficiently. Users can view a comprehensive list of shipping methods or hone in on the specifics of each method.

Accessing Shipping Methods

Overview of Shipping Methods

For a holistic view of all shipping methods:

http://example.com/api/shippings

This URL supports GET for viewing and POST for adding new shipping methods.

Detailed View of a Shipping Method

For a deep dive into a specific shipping method, identified by its unique ID:

http://example.com/api/shippings/:id

This endpoint is versatile, supporting GET for viewing, PUT for updating, and DELETE for removal of the specific method.

Pagination in Shipping Methods

Customize the display of shipping methods using pagination parameters:

• page: Designates the page number to display.
• items_per_page: Dictates the quantity of shipping methods showcased on one page.

Usage Examples

Displaying the 5th page of shipping methods (default is 10 methods per page):

http://example.com/api/shippings?page=5

Showcasing 20 shipping methods from the initial page:

http://example.com/api/shippings?items_per_page=20

Presenting 20 shipping methods from the 5th page:

http://example.com/api/shippings?page=5&items_per_page=20

Deciphering Shipping Method Properties

Each shipping method in Venddor IO is characterized by unique properties, embodied in distinct fields:

• shipping*: Denotes the name of the shipping method.
• company_id: Refers to the ID of the company. By default, it's the default company id.
• delivery_time: Specifies the expected delivery timeframe.
• icon: Represents the shipping method's icon.
• localization: A string of comma-separated localization IDs.
• max_weight & min_weight: Indicates the weight range deliverable by this method.
• position: Refers to the shipping method's position in the list.
• rate_calculation: Dictates how rates are calculated, either manually (M) or in real-time (R).
• rates: Provides a detailed array of rates.
• service_id: Pinpoints the ID of the associated shipping service.
• service_params: Contains parameters for the shipping service, represented as a JSON object.
• shipping_id: Auto-set unique ID for the shipping method.
• status: Determines the shipping method's status, like Active (A), Disabled (D), or Hidden (H).
• tax_ids: String of comma-separated tax IDs associated with the shipping method.
• usergroup_ids: Lists the user groups that can access this shipping method, represented by comma-separated IDs.