# Treek-Public ## API Docs - Authentication [User login with email and password](https://docs.gotreek.com/user-login-with-email-and-password-25701080e0.md): :::highlight green 💡 - Orders [Create Order](https://docs.gotreek.com/create-order-25701088e0.md): Create a new shipping order for the authenticated user. The order is automatically linked either to the current merchant or, for manually created orders, to the warehouse owner, and initialized with a default status of pending. - Orders [List Orders](https://docs.gotreek.com/list-orders-25701087e0.md): Order search endpoint with status and date filtering, with optional shipping partners and rate calculation. - Orders [Order Details](https://docs.gotreek.com/order-details-25701089e0.md): Retrieve detailed information about a specific order including items and relationships with proper error handling. - Orders [Update Order](https://docs.gotreek.com/update-order-25789890e0.md): :::highlight yellow 💡 - Orders [Cancel Order](https://docs.gotreek.com/cancel-order-25701090e0.md): Cancel an existing order by its ID. This endpoint runs the full business cancellation flow for the order, then returns the updated order with its status and related data. - Orders [Reset Order](https://docs.gotreek.com/reset-order-25701091e0.md): Reset an existing order back to pending status with full cleanup and refunds. - Orders [Get Statuses](https://docs.gotreek.com/get-statuses-25836543e0.md): Retrieve the list of all available order status codes and their human‑readable labels. This endpoint is typically used by clients to populate dropdowns and validate allowed status values. - Orders [Verify Item](https://docs.gotreek.com/verify-item-25955990e0.md): Verify a single order item by comparing its stored SKU with a scanned or typed SKU. Returns a rich payload with item status, per‑order verification summary and a can_confirm flag indicating if the order can be fully confirmed. - Orders [Verify Order](https://docs.gotreek.com/verify-order-25956246e0.md): Confirm an order after all its items have been successfully verified. This endpoint transitions the order from pending to awaiting_pickup and returns the updated order with its items. - Orders [Order Price](https://docs.gotreek.com/order-price-26029415e0.md): Retrieve the calculated shipping price for a specific order, taking into account whether the order is COD or prepaid. This endpoint returns the current pricing result for the given order. - Shipments [Create Shipment ](https://docs.gotreek.com/create-shipment-25701097e0.md): Creates a shipment for an existing order using the specified courier service ,debit the appropriate wallet if needed, and generate a printable shipping label. - Shipments [Return Shipment](https://docs.gotreek.com/return-shipment-25913476e0.md): Create a reverse shipment for a delivered order using a selected courier service. This endpoint validates the order eligibility, courier restrictions, and wallet balance, then creates the reverse shipment, debits the wallet if needed, and generates a return label. - Shipments [Print Invoice](https://docs.gotreek.com/print-invoice-28151964e0.md): Generates a proforma invoice as a PDF for a specific shipment. - Boxes [Create Box](https://docs.gotreek.com/create-box-25701082e0.md): :::highlight yellow 💡 - Boxes [Get Boxes](https://docs.gotreek.com/get-boxes-25701081e0.md): Boxes listing endpoint with pagination for box templates and dimensions. - Boxes [Box Details](https://docs.gotreek.com/box-details-25701083e0.md): Retrieve a single box by its ID and return both its raw attributes and calculated shipping metrics (volume, volumetric weight, chargeable weight). - Boxes [Update Box](https://docs.gotreek.com/update-box-25701084e0.md): Update an existing box by its ID, applying validated changes to its attributes (type, dimensions, weight..) and returning the updated resource. - Merchants [Merchants Details](https://docs.gotreek.com/merchants-details-25701086e0.md): Merchants listing endpoint with optional active filtering and pagination. - Profile [User Details](https://docs.gotreek.com/user-details-25701094e0.md): Profile details endpoint for the authenticated user, with optional account statistics. - Profile [Update User](https://docs.gotreek.com/update-user-25701095e0.md): Profile update endpoint for the authenticated user, updating personal, company, and bank information. - Profile [Change Password](https://docs.gotreek.com/change-password-25701096e0.md): :::highlight yellow 💡 - Utilities [Countries List](https://docs.gotreek.com/countries-list-25701098e0.md): Retrieve a list of all available countries for shipping. Includes country codes and multilingual names. - Utilities [Cities List](https://docs.gotreek.com/cities-list-25701099e0.md): Retrieve cities filtered by country or search term. Useful for populating destination selection forms. Supports both Arabic and English names. - Utilities [Couriers List](https://docs.gotreek.com/couriers-list-25701101e0.md): Retrieve a list of all active courier services available for shipping. - Warehouses [Warehouses List](https://docs.gotreek.com/warehouses-list-25701103e0.md): List warehouses for the authenticated user with pagination, including basic location and owner information. - Warehouses [Create warehouse](https://docs.gotreek.com/create-warehouse-25701104e0.md): Create a new warehouse for the authenticated user by providing complete address, sender, and location details. - Warehouses [warehouse Details](https://docs.gotreek.com/warehouse-details-25701105e0.md): Retrieve a single warehouse by its ID, including its city, owner user information and the number of related orders. - Price Calculator [Price Calculator](https://docs.gotreek.com/price-calculator-25904021e0.md): Calculate shipping rates between two cities for one or more boxes. This endpoint is a public price calculator that does not require an order or authentication and can be used to estimate shipping costs. - Packaging Type [Packaging Types List](https://docs.gotreek.com/packaging-types-list-26096016e0.md): List all available packaging types for the authenticated user. - Packaging Type [Packaging Type Details](https://docs.gotreek.com/packaging-type-details-26096024e0.md): Retrieve details of a single packaging type by its ID. - statistics [Statistics ](https://docs.gotreek.com/statistics-25909589e0.md): Orders reporting endpoint providing summary stats and charts for the authenticated user. ## Schemas - [LoginRequest](https://docs.gotreek.com/loginrequest-11856592d0.md): - [CreateOrderRequest](https://docs.gotreek.com/createorderrequest-11693119d0.md): - [UpdateOrderRequest](https://docs.gotreek.com/updateorderrequest-11761863d0.md): - [Price Calculator](https://docs.gotreek.com/price-calculator-11806072d0.md): - [VerifyItem](https://docs.gotreek.com/verifyitem-11830587d0.md): - [CreateWarehouseRequest ](https://docs.gotreek.com/createwarehouserequest-11832674d0.md): - [Shipment Package](https://docs.gotreek.com/shipment-package-11839469d0.md): - [Create Reverse Shipment](https://docs.gotreek.com/create-reverse-shipment-11839470d0.md): - [OrderPackages](https://docs.gotreek.com/orderpackages-11873744d0.md): - [OrderItem](https://docs.gotreek.com/orderitem-11876330d0.md): - [Order](https://docs.gotreek.com/order-11693114d0.md): - [City](https://docs.gotreek.com/city-11693115d0.md): - [Country](https://docs.gotreek.com/country-11693116d0.md): - [User](https://docs.gotreek.com/user-11693117d0.md): - [OrderItem](https://docs.gotreek.com/orderitem-11693118d0.md): - [CreateOrderItemRequest](https://docs.gotreek.com/createorderitemrequest-11693120d0.md): - [CalculateRatesRequest](https://docs.gotreek.com/calculateratesrequest-11693121d0.md): - [BoxDimensions](https://docs.gotreek.com/boxdimensions-11693122d0.md): - [OrderShippingRate](https://docs.gotreek.com/ordershippingrate-11693123d0.md): - [RateCalculationParams](https://docs.gotreek.com/ratecalculationparams-11693124d0.md): - [Warehouse](https://docs.gotreek.com/warehouse-11693125d0.md): - [Box](https://docs.gotreek.com/box-11693127d0.md): - [CreateBoxRequest](https://docs.gotreek.com/createboxrequest-11693128d0.md): - [UpdateBoxRequest](https://docs.gotreek.com/updateboxrequest-11693129d0.md): - [ValidationError](https://docs.gotreek.com/validationerror-11693130d0.md): - [NotFoundError](https://docs.gotreek.com/notfounderror-11693131d0.md): - [UnauthorizedError](https://docs.gotreek.com/unauthorizederror-11693132d0.md): - [ForbiddenError](https://docs.gotreek.com/forbiddenerror-11693133d0.md): - [PaginationMeta](https://docs.gotreek.com/paginationmeta-11693134d0.md): - [PaginationLinks](https://docs.gotreek.com/paginationlinks-11693135d0.md):