Managing Shipments in Venddor IO

Introduction

Venddor IO facilitates seamless handling of shipments, offering users the capability to not only view all shipments but also to delve into specifics of each shipment. This robust system ensures that businesses can efficiently manage their supply chain processes.

Accessing Shipments

Overview of Shipments

For a holistic view of all shipments:

http://example.com/api/shipments

With this URL, users can employ GET to view and POST to add shipments.

Detailed View of a Shipment

For an in-depth examination of a specific shipment, identified by its unique ID:

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

This endpoint supports GET to view, PUT to update, and DELETE to remove the specific shipment.

Pagination in Shipments

Pagination parameters are incorporated to customize the display of shipments:

• page: Designates which page of shipments to display.
• items_per_page: Dictates the number of shipments showcased on a single page.

Usage Examples

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

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

Showcasing 20 shipments from the initial page:

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

Presenting 20 shipments from the 5th page:

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

Understanding Shipment Properties

Each shipment in Venddor IO possesses distinctive properties, embodied by specific fields. The critical fields include:

• carrier**: Refers to the carrier's name. By default, it's an empty string, but should match a valid carrier name.
• order_id*: Specifies the order ID linked with the shipment.
• products*: Indicates the shipped products, represented as a JSON object where the cart item ID is the key and its quantity is the value.
• shipping: Denotes the shipping method name. The default value is 'Custom shipping method'.
• shipping_id*: Pinpoints the ID of the shipping method.
• user_id: Points to the customer's user ID.
• tracking_number**: Identifies the tracking number for the shipment, a pivotal tool for tracking and management.
• comments: Captures any additional comments associated with the shipment.
• group_key: Tags the supplier group key, set automatically.
• order_timestamp: Timestamp of when the order was created.
• status: Represents the shipment status, such as Picked up (P), Packed (A), or Shipped (S).
• order_status: Captures the status post-shipment creation, like Paid (P) or Complete (C).