Endpoints Overview
Endpoints Overview
The Endpoints Overview article provides a comprehensive guide to the various endpoints available in the WareTrack API. This resource will help you understand the functionality and purpose of each endpoint, enabling you to interact effectively with the API.
Overview of Endpoints
The WareTrack API includes several key endpoints designed to manage different aspects of warehouse operations. Each endpoint has specific functions and data requirements. Below is a brief overview of the primary endpoints:
-
Products Endpoint: Manage and retrieve product information. For details on how to handle product data, see FAQs / Product Management.
-
Orders Endpoint: Handle and track sales and purchase orders. For more information on order processing, refer to FAQs / Order Processing.
-
Shipments Endpoint: Track and manage shipment statuses. You can find additional details in shipment_date Date when the package was shipped.
API Endpoints and Methods
- GET /products: Retrieve a list of products from Products Product Details.
- POST /products: Add a new product to the inventory. For details, see product_name Name of the product.
- PUT /orders/{id}: Update an existing order. More information on order management can be found in @{column:b74fc269-8700-4f8a-9be6-2af32f96dde5.
- DELETE /orders/{id}: Remove an order from the system.
- GET /shipments: Get a list of all shipments.
Key Tables and Columns
-
Tables:
- Products Product Details: Contains detailed product information.
- SalesOrders Sales Orders: Stores details of sales orders.
-
Important Column:
- Product Name: product_name Name of the product - The column representing the product's name.
Additional Resources
For further details on using the API, check out the following articles:
- API documentation / Introduction to API: Provides a broad introduction to API functionalities.
- Introduction / System Overview: Offers an overview of the entire WareTrack system.
We hope this overview helps you navigate and utilize the WareTrack API efficiently. If you need additional assistance, please refer to the Quick start guide.
