openapi: 3.0.3 info: title: 'Constell API Documentation' description: '' version: 1.0.0 servers: - url: 'https://www.constell.agent.co.ug' tags: - name: 'User profile' description: '' - name: 'Warehouse Location' description: '' - name: Shipments description: '' - name: Package description: '' - name: 'Consolidation Batch' description: '' - name: 'Batch Package' description: '' - name: Invoice description: '' - name: 'Shipment Delivery' description: '' - name: AssistedShopping description: '' - name: Order description: '' - name: Expenditures description: '' - name: 'Policy documents' description: '' - name: Notifications description: '' - name: Others description: '' - name: Manifests description: '' - name: Pricing description: '' - name: 'Shipping address' description: '' - name: 'Support Tickets' description: '' paths: /api/auth/register: post: summary: 'Register or Create User/Customer account' operationId: registerOrCreateUserCustomerAccount description: '' parameters: [] responses: { } tags: - 'User profile' requestBody: required: true content: application/json: schema: type: object properties: full_name: type: string description: '' example: consequatur email: type: string description: '' example: qkunze@example.com phone: type: string description: '' example: consequatur other_phone_number: type: string description: '' example: consequatur nullable: true address: type: string description: '' example: consequatur nullable: true mode_of_transport: type: string description: 'E.g AIR, SEA' example: consequatur role: type: string description: "E.g 'admin','origin_agent', 'destination_officer','shopping_assistant', 'finance', 'super_admin','client'" example: consequatur nullable: true password: type: string description: optional example: 'O[2UZ5ij-e/dl4m{o,' password_confirmation: type: string description: '' example: consequatur required: - full_name - email - phone /api/auth/send_otp: post: summary: 'Send OTP' operationId: sendOTP description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: text/plain: schema: type: string example: "{\n \"status\": \"success\",\n \"message\": \"An OTP has been sent to your phone and email\",\n }\n }" tags: - 'User profile' requestBody: required: true content: application/json: schema: type: object properties: validation_text: type: string description: '' example: 'Email or Password' required: - validation_text /api/auth/verify_otp: post: summary: 'Verify OTP' operationId: verifyOTP description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: text/plain: schema: type: string example: "{\n \"status\": \"success\",\n \"message\": \"An OTP has been sent to your phone and email\",\n }\n }" tags: - 'User profile' requestBody: required: true content: application/json: schema: type: object properties: validation_text: type: string description: '' example: 'Email or phone number' otp: type: string description: '' example: consequatur required: - validation_text - otp /api/auth/change_password: post: summary: 'Set or change password' operationId: setOrChangePassword description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: text/plain: schema: type: string example: "{\n \"status\": \"success\",\n \"message\": \"Account Password has been reset\",\n }\n }" tags: - 'User profile' requestBody: required: true content: application/json: schema: type: object properties: password: type: string description: '' example: 'O[2UZ5ij-e/dl4m{o,' user_id: type: integer description: optional example: 17 nullable: true password_confirmation: type: string description: '' example: consequatur required: - password - password_confirmation /api/auth/login: post: summary: Login operationId: login description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: status: success message: 'Successfully loged in' authorization: token: 1|ipsfUoT7lmvPZaeKNtyU5GDIarzgv084cW0RLfxl80a3b2ec token_type: Bearer data: id: 1 full_name: 'Thembo Charles' email: ashley7520charles@gmail.com phone: '0787444081' email_verified_at: null tin: '110023452' passport: '65748' address: Kampala otp: '4782' status: active user_type: user created_at: '2025-12-05T06:42:09.000000Z' updated_at: '2025-12-05T07:58:28.000000Z' deleted_at: null properties: status: type: string example: success message: type: string example: 'Successfully loged in' authorization: type: object properties: token: type: string example: 1|ipsfUoT7lmvPZaeKNtyU5GDIarzgv084cW0RLfxl80a3b2ec token_type: type: string example: Bearer data: type: object properties: id: type: integer example: 1 full_name: type: string example: 'Thembo Charles' email: type: string example: ashley7520charles@gmail.com phone: type: string example: '0787444081' email_verified_at: type: string example: null tin: type: string example: '110023452' passport: type: string example: '65748' address: type: string example: Kampala otp: type: string example: '4782' status: type: string example: active user_type: type: string example: user created_at: type: string example: '2025-12-05T06:42:09.000000Z' updated_at: type: string example: '2025-12-05T07:58:28.000000Z' deleted_at: type: string example: null tags: - 'User profile' requestBody: required: true content: application/json: schema: type: object properties: password: type: string description: '' example: 'O[2UZ5ij-e/dl4m{o,' email: type: string description: '' example: qkunze@example.com required: - password - email /api/auth/logout: post: summary: 'Log Out User' operationId: logOutUser description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: text/plain: schema: type: string example: "{\n \"status\": \"success\",\n \"message\": \"Successfully logged out\",\n }\n }" tags: - 'User profile' /api/auth/user: get: summary: 'User Profile' operationId: userProfile description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: status: success message: 'User Profile' data: id: 1 full_name: 'Thembo Charles' email: ashley7520charles@gmail.com phone: '0787444081' email_verified_at: null tin: '110023452' passport: '65748' address: Kampala otp: '4782' status: active user_type: user created_at: '2025-12-05T06:42:09.000000Z' updated_at: '2025-12-05T07:58:28.000000Z' deleted_at: null properties: status: type: string example: success message: type: string example: 'User Profile' data: type: object properties: id: type: integer example: 1 full_name: type: string example: 'Thembo Charles' email: type: string example: ashley7520charles@gmail.com phone: type: string example: '0787444081' email_verified_at: type: string example: null tin: type: string example: '110023452' passport: type: string example: '65748' address: type: string example: Kampala otp: type: string example: '4782' status: type: string example: active user_type: type: string example: user created_at: type: string example: '2025-12-05T06:42:09.000000Z' updated_at: type: string example: '2025-12-05T07:58:28.000000Z' deleted_at: type: string example: null tags: - 'User profile' /api/auth/create_user: post: summary: 'Register or Create User/Customer account' operationId: registerOrCreateUserCustomerAccount description: '' parameters: [] responses: { } tags: - 'User profile' requestBody: required: true content: application/json: schema: type: object properties: full_name: type: string description: '' example: consequatur email: type: string description: '' example: qkunze@example.com phone: type: string description: '' example: consequatur other_phone_number: type: string description: '' example: consequatur nullable: true address: type: string description: '' example: consequatur nullable: true mode_of_transport: type: string description: 'E.g AIR, SEA' example: consequatur role: type: string description: "E.g 'admin','origin_agent', 'destination_officer','shopping_assistant', 'finance', 'super_admin','client'" example: consequatur nullable: true password: type: string description: optional example: 'O[2UZ5ij-e/dl4m{o,' password_confirmation: type: string description: '' example: consequatur required: - full_name - email - phone /api/auth/update_user: put: summary: 'Update user' operationId: updateUser description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: text/plain: schema: type: string example: "{\n \"status\": \"success\",\n \"message\": \"Successfully logged out\",\n}" tags: - 'User profile' requestBody: required: true content: application/json: schema: type: object properties: full_name: type: string description: '' example: consequatur phone: type: string description: '' example: consequatur address: type: string description: '' example: consequatur other_phone_number: type: string description: 'Request parameter: other_phone_number.' example: 'Any string' mode_of_transport: type: string description: 'Request parameter: mode_of_transport.' example: 'Any string' street: type: string description: '' example: consequatur city: type: string description: '' example: consequatur region: type: string description: '' example: consequatur country: type: string description: '' example: consequatur required: - full_name - phone /api/auth/all_profiles: get: summary: 'Account profiles' operationId: accountProfiles description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/auth/all_profiles could not be found.' properties: message: type: string example: 'The route api/auth/all_profiles could not be found.' tags: - 'User profile' /api/auth/user_warehouse: post: summary: 'Allocate an Account a WareHouse' operationId: allocateAnAccountAWareHouse description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - 'User profile' requestBody: required: true content: application/json: schema: type: object properties: user_id: type: integer description: '' example: 17 warehouse_location_id: type: integer description: '' example: 17 required: - user_id - warehouse_location_id /api/customers: post: summary: 'Read Users' operationId: readUsers description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - 'User profile' requestBody: required: false content: application/json: schema: type: object properties: user_role: type: string description: "optional E.g: 'admin','origin_agent', 'destination_officer', 'shopping_assistant', 'finance','super_admin','client'" example: consequatur '/api/customers/{user_id}': get: summary: 'Customer Details' operationId: customerDetails description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/customers/17 could not be found.' properties: message: type: string example: 'The route api/customers/17 could not be found.' tags: - 'User profile' parameters: - in: path name: user_id description: '' example: 17 required: true schema: type: integer /api/search-customer: post: summary: 'Search cistomer/User by Client code' operationId: searchCistomerUserByClientCode description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - 'User profile' requestBody: required: true content: application/json: schema: type: object properties: client_code: type: string description: AIR-00001 example: consequatur required: - client_code /api/settings/locations: get: summary: 'Warehouse Locations' operationId: warehouseLocations description: '' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: status: success message: 'Warehouse Locations' data: - id: 1 created_at: '2025-12-05T09:12:00.000000Z' updated_at: '2025-12-05T09:12:00.000000Z' deleted_at: null country: Uganda address: A rack_count: '01' is_occupied: 0 properties: status: type: string example: success message: type: string example: 'Warehouse Locations' data: type: array example: - id: 1 created_at: '2025-12-05T09:12:00.000000Z' updated_at: '2025-12-05T09:12:00.000000Z' deleted_at: null country: Uganda address: A rack_count: '01' is_occupied: 0 items: type: object properties: id: type: integer example: 1 created_at: type: string example: '2025-12-05T09:12:00.000000Z' updated_at: type: string example: '2025-12-05T09:12:00.000000Z' deleted_at: type: string example: null country: type: string example: Uganda address: type: string example: A rack_count: type: string example: '01' is_occupied: type: integer example: 0 tags: - 'Warehouse Location' post: summary: 'Create Warehouse Location' operationId: createWarehouseLocation description: '' parameters: [] responses: { } tags: - 'Warehouse Location' requestBody: required: true content: application/json: schema: type: object properties: code: type: string description: '' example: consequatur address: type: string description: '' example: consequatur nullable: true manager: type: string description: '' example: consequatur nullable: true active: type: boolean description: 'Request parameter: active.' example: false name: type: string description: '' example: consequatur nullable: true country: type: string description: '' example: consequatur nullable: true city: type: string description: '' example: consequatur nullable: true state: type: string description: '' example: consequatur nullable: true zip: type: string description: '' example: consequatur nullable: true phone_number: type: string description: '' example: consequatur nullable: true currency: type: string description: '' example: consequatur nullable: true type: type: string description: "E.g: 'origin', 'destination'" example: consequatur required: - code - address '/api/settings/locations/{id}': put: summary: 'Update Warehouse Location' operationId: updateWarehouseLocation description: '' parameters: [] responses: { } tags: - 'Warehouse Location' requestBody: required: true content: application/json: schema: type: object properties: code: type: string description: '' example: consequatur address: type: string description: '' example: consequatur manager: type: string description: '' example: consequatur active: type: boolean description: 'Request parameter: active.' example: false rack_count: type: string description: '' example: consequatur name: type: string description: '' example: consequatur country: type: string description: '' example: consequatur city: type: string description: '' example: consequatur state: type: string description: '' example: consequatur zip: type: string description: '' example: consequatur phone_number: type: string description: '' example: consequatur currency: type: string description: '' example: consequatur type: type: string description: "E.g: 'origin', 'destination'" example: consequatur required: - code - address - rack_count delete: summary: 'Delete Warehouse Location' operationId: deleteWarehouseLocation description: '' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: status: success message: 'Warehouse Location deleted successfully' properties: status: type: string example: success message: type: string example: 'Warehouse Location deleted successfully' tags: - 'Warehouse Location' get: summary: 'Display the specified resource.' operationId: displayTheSpecifiedResource description: '' parameters: [] responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/settings/locations/consequatur could not be found.' properties: message: type: string example: 'The route api/settings/locations/consequatur could not be found.' tags: - Others security: [] parameters: - in: path name: id description: 'The ID of the location.' example: consequatur required: true schema: type: string - in: path name: warehouseLocation_id description: '' example: 17 required: true schema: type: integer /api/settings/warehouse_racks: post: summary: 'Create Warehouse Rack' operationId: createWarehouseRack description: '' parameters: [] responses: { } tags: - 'Warehouse Location' requestBody: required: true content: application/json: schema: type: object properties: zone_name: type: string description: '' example: consequatur bin_start: type: string description: '' example: consequatur nullable: true bin_end: type: string description: '' example: consequatur nullable: true capacity: type: string description: '' example: consequatur nullable: true type: type: string description: 'Example SHELF,PALLET,COLD,FRAGILE' example: consequatur warehouse_location_id: type: integer description: '' example: 17 required: - zone_name - bin_start - bin_end - warehouse_location_id get: summary: 'Display a listing of the resource.' operationId: displayAListingOfTheResource description: '' parameters: [] responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/settings/warehouse_racks could not be found.' properties: message: type: string example: 'The route api/settings/warehouse_racks could not be found.' tags: - Others security: [] '/api/settings/warehouse_racks/{id}': put: summary: 'Update Warehouse Rack' operationId: updateWarehouseRack description: '' parameters: [] responses: { } tags: - 'Warehouse Location' requestBody: required: true content: application/json: schema: type: object properties: zone_name: type: string description: sometimes example: consequatur bin_start: type: string description: sometimes example: consequatur bin_end: type: string description: sometimes example: consequatur capacity: type: string description: sometimes example: consequatur type: type: string description: 'sometimes Example SHELF,PALLET,COLD,FRAGILE' example: consequatur warehouse_location_id: type: integer description: 'Request parameter: warehouse_location_id. The id of an existing record in the warehouse_locations table.' example: 1000 warehouseRack_id: type: integer description: '' example: 17 required: - warehouseRack_id delete: summary: 'Delete Warehouse Rack' operationId: deleteWarehouseRack description: '' parameters: [] responses: { } tags: - 'Warehouse Location' requestBody: required: true content: application/json: schema: type: object properties: warehouseRack_id: type: integer description: '' example: 17 required: - warehouseRack_id get: summary: 'Display the specified resource.' operationId: displayTheSpecifiedResource description: '' parameters: [] responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/settings/warehouse_racks/1 could not be found.' properties: message: type: string example: 'The route api/settings/warehouse_racks/1 could not be found.' tags: - Others security: [] parameters: - in: path name: id description: 'The ID of the warehouse rack.' example: 1 required: true schema: type: integer /api/orders: get: summary: Shipments operationId: shipments description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: status: success data: current_page: 1 data: - id: 5 created_at: '2025-12-05T12:20:11.000000Z' updated_at: '2025-12-05T12:20:11.000000Z' deleted_at: null tracking_number: ORD-20251205-00002 user_id: 1 origin_country: ITALY receiver_name: 'Tom Mboya' receiver_phone: '0789887766' receiver_email: tom.mboya@gmail.com receiver_address: 'Uganda - Kampala' status: PENDING received_at: null dispatched_at: null arrived_at: null released_at: null delivered_at: null status_history: - id: 4 created_at: '2025-12-05T12:27:49.000000Z' updated_at: '2025-12-05T12:27:49.000000Z' deleted_at: null order_id: 5 status: CONSOLIDATED notes: 'Well received' location: USA user_id: 1 user: id: 1 full_name: 'Thembo Charles' email: ashley7520charles@gmail.com phone: '0787444081' email_verified_at: null tin: '110023452' passport: '65748' address: Kampala otp: '4782' status: active user_type: user created_at: '2025-12-05T06:42:09.000000Z' updated_at: '2025-12-05T07:58:28.000000Z' deleted_at: null user: id: 1 full_name: 'Thembo Charles' email: ashley7520charles@gmail.com phone: '0787444081' email_verified_at: null tin: '110023452' passport: '65748' address: Kampala otp: '4782' status: active user_type: user created_at: '2025-12-05T06:42:09.000000Z' updated_at: '2025-12-05T07:58:28.000000Z' deleted_at: null - id: 2 created_at: '2025-12-05T11:29:08.000000Z' updated_at: '2025-12-05T11:29:08.000000Z' deleted_at: null tracking_number: ORD-20251205-00001 user_id: 1 origin_country: USA receiver_name: 'Tom Mboya' receiver_phone: '0789887766' receiver_email: tom.mboya@gmail.com receiver_address: 'Uganda - Kampala' status: PENDING received_at: null dispatched_at: null arrived_at: null released_at: null delivered_at: null status_history: - id: 2 created_at: '2025-12-05T12:03:09.000000Z' updated_at: '2025-12-05T12:03:09.000000Z' deleted_at: null order_id: 2 status: CONSOLIDATED notes: 'Well received' location: USA user_id: 1 user: id: 1 full_name: 'Thembo Charles' email: ashley7520charles@gmail.com phone: '0787444081' email_verified_at: null tin: '110023452' passport: '65748' address: Kampala otp: '4782' status: active user_type: user created_at: '2025-12-05T06:42:09.000000Z' updated_at: '2025-12-05T07:58:28.000000Z' deleted_at: null - id: 1 created_at: '2025-12-05T12:01:16.000000Z' updated_at: '2025-12-05T12:01:16.000000Z' deleted_at: null order_id: 2 status: RECEIVED notes: 'Well received' location: USA user_id: null user: null user: id: 1 full_name: 'Thembo Charles' email: ashley7520charles@gmail.com phone: '0787444081' email_verified_at: null tin: '110023452' passport: '65748' address: Kampala otp: '4782' status: active user_type: user created_at: '2025-12-05T06:42:09.000000Z' updated_at: '2025-12-05T07:58:28.000000Z' deleted_at: null first_page_url: 'http://127.0.0.1:8000/api/orders?page=1' from: 1 last_page: 1 last_page_url: 'http://127.0.0.1:8000/api/orders?page=1' links: - url: null label: '« Previous' active: false - url: 'http://127.0.0.1:8000/api/orders?page=1' label: '1' active: true - url: null label: 'Next »' active: false next_page_url: null path: 'http://127.0.0.1:8000/api/orders' per_page: 20 prev_page_url: null to: 2 total: 2 properties: status: type: string example: success data: type: object properties: current_page: type: integer example: 1 data: type: array example: - id: 5 created_at: '2025-12-05T12:20:11.000000Z' updated_at: '2025-12-05T12:20:11.000000Z' deleted_at: null tracking_number: ORD-20251205-00002 user_id: 1 origin_country: ITALY receiver_name: 'Tom Mboya' receiver_phone: '0789887766' receiver_email: tom.mboya@gmail.com receiver_address: 'Uganda - Kampala' status: PENDING received_at: null dispatched_at: null arrived_at: null released_at: null delivered_at: null status_history: - id: 4 created_at: '2025-12-05T12:27:49.000000Z' updated_at: '2025-12-05T12:27:49.000000Z' deleted_at: null order_id: 5 status: CONSOLIDATED notes: 'Well received' location: USA user_id: 1 user: id: 1 full_name: 'Thembo Charles' email: ashley7520charles@gmail.com phone: '0787444081' email_verified_at: null tin: '110023452' passport: '65748' address: Kampala otp: '4782' status: active user_type: user created_at: '2025-12-05T06:42:09.000000Z' updated_at: '2025-12-05T07:58:28.000000Z' deleted_at: null user: id: 1 full_name: 'Thembo Charles' email: ashley7520charles@gmail.com phone: '0787444081' email_verified_at: null tin: '110023452' passport: '65748' address: Kampala otp: '4782' status: active user_type: user created_at: '2025-12-05T06:42:09.000000Z' updated_at: '2025-12-05T07:58:28.000000Z' deleted_at: null - id: 2 created_at: '2025-12-05T11:29:08.000000Z' updated_at: '2025-12-05T11:29:08.000000Z' deleted_at: null tracking_number: ORD-20251205-00001 user_id: 1 origin_country: USA receiver_name: 'Tom Mboya' receiver_phone: '0789887766' receiver_email: tom.mboya@gmail.com receiver_address: 'Uganda - Kampala' status: PENDING received_at: null dispatched_at: null arrived_at: null released_at: null delivered_at: null status_history: - id: 2 created_at: '2025-12-05T12:03:09.000000Z' updated_at: '2025-12-05T12:03:09.000000Z' deleted_at: null order_id: 2 status: CONSOLIDATED notes: 'Well received' location: USA user_id: 1 user: id: 1 full_name: 'Thembo Charles' email: ashley7520charles@gmail.com phone: '0787444081' email_verified_at: null tin: '110023452' passport: '65748' address: Kampala otp: '4782' status: active user_type: user created_at: '2025-12-05T06:42:09.000000Z' updated_at: '2025-12-05T07:58:28.000000Z' deleted_at: null - id: 1 created_at: '2025-12-05T12:01:16.000000Z' updated_at: '2025-12-05T12:01:16.000000Z' deleted_at: null order_id: 2 status: RECEIVED notes: 'Well received' location: USA user_id: null user: null user: id: 1 full_name: 'Thembo Charles' email: ashley7520charles@gmail.com phone: '0787444081' email_verified_at: null tin: '110023452' passport: '65748' address: Kampala otp: '4782' status: active user_type: user created_at: '2025-12-05T06:42:09.000000Z' updated_at: '2025-12-05T07:58:28.000000Z' deleted_at: null items: type: object properties: id: type: integer example: 5 created_at: type: string example: '2025-12-05T12:20:11.000000Z' updated_at: type: string example: '2025-12-05T12:20:11.000000Z' deleted_at: type: string example: null tracking_number: type: string example: ORD-20251205-00002 user_id: type: integer example: 1 origin_country: type: string example: ITALY receiver_name: type: string example: 'Tom Mboya' receiver_phone: type: string example: '0789887766' receiver_email: type: string example: tom.mboya@gmail.com receiver_address: type: string example: 'Uganda - Kampala' status: type: string example: PENDING received_at: type: string example: null dispatched_at: type: string example: null arrived_at: type: string example: null released_at: type: string example: null delivered_at: type: string example: null status_history: type: array example: - id: 4 created_at: '2025-12-05T12:27:49.000000Z' updated_at: '2025-12-05T12:27:49.000000Z' deleted_at: null order_id: 5 status: CONSOLIDATED notes: 'Well received' location: USA user_id: 1 user: id: 1 full_name: 'Thembo Charles' email: ashley7520charles@gmail.com phone: '0787444081' email_verified_at: null tin: '110023452' passport: '65748' address: Kampala otp: '4782' status: active user_type: user created_at: '2025-12-05T06:42:09.000000Z' updated_at: '2025-12-05T07:58:28.000000Z' deleted_at: null items: type: object properties: id: type: integer example: 4 created_at: type: string example: '2025-12-05T12:27:49.000000Z' updated_at: type: string example: '2025-12-05T12:27:49.000000Z' deleted_at: type: string example: null order_id: type: integer example: 5 status: type: string example: CONSOLIDATED notes: type: string example: 'Well received' location: type: string example: USA user_id: type: integer example: 1 user: type: object properties: id: { type: integer, example: 1 } full_name: { type: string, example: 'Thembo Charles' } email: { type: string, example: ashley7520charles@gmail.com } phone: { type: string, example: '0787444081' } email_verified_at: { type: string, example: null } tin: { type: string, example: '110023452' } passport: { type: string, example: '65748' } address: { type: string, example: Kampala } otp: { type: string, example: '4782' } status: { type: string, example: active } user_type: { type: string, example: user } created_at: { type: string, example: '2025-12-05T06:42:09.000000Z' } updated_at: { type: string, example: '2025-12-05T07:58:28.000000Z' } deleted_at: { type: string, example: null } user: type: object properties: id: type: integer example: 1 full_name: type: string example: 'Thembo Charles' email: type: string example: ashley7520charles@gmail.com phone: type: string example: '0787444081' email_verified_at: type: string example: null tin: type: string example: '110023452' passport: type: string example: '65748' address: type: string example: Kampala otp: type: string example: '4782' status: type: string example: active user_type: type: string example: user created_at: type: string example: '2025-12-05T06:42:09.000000Z' updated_at: type: string example: '2025-12-05T07:58:28.000000Z' deleted_at: type: string example: null first_page_url: type: string example: 'http://127.0.0.1:8000/api/orders?page=1' from: type: integer example: 1 last_page: type: integer example: 1 last_page_url: type: string example: 'http://127.0.0.1:8000/api/orders?page=1' links: type: array example: - url: null label: '« Previous' active: false - url: 'http://127.0.0.1:8000/api/orders?page=1' label: '1' active: true - url: null label: 'Next »' active: false items: type: object properties: url: type: string example: null label: type: string example: '« Previous' active: type: boolean example: false next_page_url: type: string example: null path: type: string example: 'http://127.0.0.1:8000/api/orders' per_page: type: integer example: 20 prev_page_url: type: string example: null to: type: integer example: 2 total: type: integer example: 2 tags: - Shipments post: summary: 'Create a Shipment Orders' operationId: createAShipmentOrders description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - Shipments requestBody: required: true content: application/json: schema: type: object properties: warehouse_location_id: type: integer description: '' example: 17 destination_location_id: type: integer description: '' example: 17 receiver_name: type: string description: '' example: consequatur receiver_phone: type: string description: '' example: consequatur receiver_email: type: string description: '' example: qkunze@example.com receiver_address: type: string description: '' example: consequatur nullable: true shipping_mode: type: string description: '' example: "'express','standard'" expected_delivery_time: type: string description: 'Request parameter: expected_delivery_time.' example: 'Any string' transport_mode: type: string description: '' example: 'AIR or SEA' user_id: type: integer description: optional example: 17 required: - warehouse_location_id - destination_location_id - receiver_name - receiver_phone - shipping_mode - transport_mode '/api/orders/{id}': get: summary: 'Show Shipment' operationId: showShipment description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: status: success data: id: 5 created_at: '2025-12-05T12:20:11.000000Z' updated_at: '2025-12-05T12:20:11.000000Z' deleted_at: null tracking_number: ORD-20251205-00002 user_id: 1 origin_country: ITALY receiver_name: 'Tom Mboya' receiver_phone: '0789887766' receiver_email: tom.mboya@gmail.com receiver_address: 'Uganda - Kampala' status: PENDING received_at: null dispatched_at: null arrived_at: null released_at: null delivered_at: null status_history: - id: 4 created_at: '2025-12-05T12:27:49.000000Z' updated_at: '2025-12-05T12:27:49.000000Z' deleted_at: null order_id: 5 status: CONSOLIDATED notes: 'Well received' location: USA user_id: 1 user: id: 1 full_name: 'Thembo Charles' email: ashley7520charles@gmail.com phone: '0787444081' email_verified_at: null tin: '110023452' passport: '65748' address: Kampala otp: '4782' status: active user_type: user created_at: '2025-12-05T06:42:09.000000Z' updated_at: '2025-12-05T07:58:28.000000Z' deleted_at: null user: id: 1 full_name: 'Thembo Charles' email: ashley7520charles@gmail.com phone: '0787444081' email_verified_at: null tin: '110023452' passport: '65748' address: Kampala otp: '4782' status: active user_type: user created_at: '2025-12-05T06:42:09.000000Z' updated_at: '2025-12-05T07:58:28.000000Z' deleted_at: null properties: status: type: string example: success data: type: object properties: id: type: integer example: 5 created_at: type: string example: '2025-12-05T12:20:11.000000Z' updated_at: type: string example: '2025-12-05T12:20:11.000000Z' deleted_at: type: string example: null tracking_number: type: string example: ORD-20251205-00002 user_id: type: integer example: 1 origin_country: type: string example: ITALY receiver_name: type: string example: 'Tom Mboya' receiver_phone: type: string example: '0789887766' receiver_email: type: string example: tom.mboya@gmail.com receiver_address: type: string example: 'Uganda - Kampala' status: type: string example: PENDING received_at: type: string example: null dispatched_at: type: string example: null arrived_at: type: string example: null released_at: type: string example: null delivered_at: type: string example: null status_history: type: array example: - id: 4 created_at: '2025-12-05T12:27:49.000000Z' updated_at: '2025-12-05T12:27:49.000000Z' deleted_at: null order_id: 5 status: CONSOLIDATED notes: 'Well received' location: USA user_id: 1 user: id: 1 full_name: 'Thembo Charles' email: ashley7520charles@gmail.com phone: '0787444081' email_verified_at: null tin: '110023452' passport: '65748' address: Kampala otp: '4782' status: active user_type: user created_at: '2025-12-05T06:42:09.000000Z' updated_at: '2025-12-05T07:58:28.000000Z' deleted_at: null items: type: object properties: id: type: integer example: 4 created_at: type: string example: '2025-12-05T12:27:49.000000Z' updated_at: type: string example: '2025-12-05T12:27:49.000000Z' deleted_at: type: string example: null order_id: type: integer example: 5 status: type: string example: CONSOLIDATED notes: type: string example: 'Well received' location: type: string example: USA user_id: type: integer example: 1 user: type: object properties: id: type: integer example: 1 full_name: type: string example: 'Thembo Charles' email: type: string example: ashley7520charles@gmail.com phone: type: string example: '0787444081' email_verified_at: type: string example: null tin: type: string example: '110023452' passport: type: string example: '65748' address: type: string example: Kampala otp: type: string example: '4782' status: type: string example: active user_type: type: string example: user created_at: type: string example: '2025-12-05T06:42:09.000000Z' updated_at: type: string example: '2025-12-05T07:58:28.000000Z' deleted_at: type: string example: null user: type: object properties: id: type: integer example: 1 full_name: type: string example: 'Thembo Charles' email: type: string example: ashley7520charles@gmail.com phone: type: string example: '0787444081' email_verified_at: type: string example: null tin: type: string example: '110023452' passport: type: string example: '65748' address: type: string example: Kampala otp: type: string example: '4782' status: type: string example: active user_type: type: string example: user created_at: type: string example: '2025-12-05T06:42:09.000000Z' updated_at: type: string example: '2025-12-05T07:58:28.000000Z' deleted_at: type: string example: null tags: - Shipments put: summary: 'Update Shipments' operationId: updateShipments description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: text/plain: schema: type: string example: "{\n \"status\": \"success\",\n \"message\": \"Order updated successfully.\",\n }\n }" tags: - Shipments requestBody: required: false content: application/json: schema: type: object properties: receiver_name: type: string description: '' example: consequatur receiver_phone: type: string description: '' example: consequatur receiver_email: type: string description: '' example: qkunze@example.com receiver_address: type: string description: '' example: consequatur warehouse_location_id: type: integer description: '' example: 17 destination_location_id: type: integer description: '' example: 17 shipping_mode: type: string description: '' example: "'express','standard'," expected_delivery_time: type: date description: '' example: consequatur origin_country: type: string description: '' example: consequatur delete: summary: 'Delete Shipment' operationId: deleteShipment description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: text/plain: schema: type: string example: "{\n \"status\": \"success\",\n \"message\": \"Shipment deleted successfully.\",\n }\n }" tags: - Shipments parameters: - in: path name: id description: 'The ID of the order.' example: consequatur required: true schema: type: string - in: path name: order_id description: '' example: 17 required: true schema: type: integer '/api/orders/tracking/{tracking_number}': get: summary: 'Get Shipments By Tracking Number' operationId: getShipmentsByTrackingNumber description: '' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: status: success data: id: 5 created_at: '2025-12-05T12:20:11.000000Z' updated_at: '2025-12-05T12:20:11.000000Z' deleted_at: null tracking_number: ORD-20251205-00002 user_id: 1 origin_country: ITALY receiver_name: 'Tom Mboya' receiver_phone: '0789887766' receiver_email: tom.mboya@gmail.com receiver_address: 'Uganda - Kampala' status: PENDING received_at: null dispatched_at: null arrived_at: null released_at: null delivered_at: null status_history: [] user: { } packages: [] properties: status: type: string example: success data: type: object properties: id: type: integer example: 5 created_at: type: string example: '2025-12-05T12:20:11.000000Z' updated_at: type: string example: '2025-12-05T12:20:11.000000Z' deleted_at: type: string example: null tracking_number: type: string example: ORD-20251205-00002 user_id: type: integer example: 1 origin_country: type: string example: ITALY receiver_name: type: string example: 'Tom Mboya' receiver_phone: type: string example: '0789887766' receiver_email: type: string example: tom.mboya@gmail.com receiver_address: type: string example: 'Uganda - Kampala' status: type: string example: PENDING received_at: type: string example: null dispatched_at: type: string example: null arrived_at: type: string example: null released_at: type: string example: null delivered_at: type: string example: null status_history: type: array example: [] user: type: object properties: { } packages: type: array example: [] 404: description: '' content: application/json: schema: type: object example: message: 'No query results for model [App\Models\Order].' properties: message: type: string example: 'No query results for model [App\Models\Order].' tags: - Shipments security: [] parameters: - in: path name: tracking_number description: 'The tracking number of the order.' example: consequatur required: true schema: type: string /api/packages: post: summary: 'Add Package to shipment' operationId: addPackageToShipment description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - Package requestBody: required: true content: application/json: schema: type: object properties: order_id: type: integer description: '' example: 17 contents: type: string description: '' example: consequatur declared_value: type: number description: '' example: 11613.31890586 weight: type: number description: '' example: 11613.31890586 length: type: number description: '' example: 11613.31890586 width: type: number description: '' example: 11613.31890586 height: type: number description: '' example: 11613.31890586 warehouse_rack_id: type: string description: 'Request parameter: warehouse_rack_id. The id of an existing record in the warehouse_racks table.' example: 'Any string' nullable: true transport_insured: type: boolean description: 'optional E.g true, false' example: false tracking_number: type: string description: '' example: consequatur nullable: true isPercel: type: boolean description: "optional\nbodyParam warehouse_rack_id integeer" example: false nullable: true repackaged: type: boolean description: '' example: false required: - order_id - contents - weight - length - width - height - repackaged '/api/packages/{id}': put: summary: 'Update shipment Package' operationId: updateShipmentPackage description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - Package requestBody: required: true content: application/json: schema: type: object properties: order_id: type: string description: 'Request parameter: order_id. The id of an existing record in the orders table.' example: 'Any string' contents: type: string description: '' example: consequatur declared_value: type: number description: '' example: 11613.31890586 weight: type: number description: '' example: 11613.31890586 length: type: number description: '' example: 11613.31890586 width: type: number description: '' example: 11613.31890586 height: type: number description: '' example: 11613.31890586 transport_mode: type: string description: 'Request parameter: transport_mode.' example: 'Any string' transport_insured: type: boolean description: 'Request parameter: transport_insured.' example: false warehouse_rack_id: type: integer description: '' example: 17 required: - contents - weight - length - width - height delete: summary: 'Delete Package' operationId: deletePackage description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: text/plain: schema: type: string example: "{\n \"status\": \"success\",\n \"message\": \"Package deleted successfully.\",\n }\n }" tags: - Package parameters: - in: path name: id description: 'The ID of the package.' example: consequatur required: true schema: type: string - in: path name: package_id description: '' example: 17 required: true schema: type: integer '/api/packages/{id}/package-photos': post: summary: 'Add Package images' operationId: addPackageImages description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: message: 'Package photos uploaded successfully' data: id: 1 created_at: '2025-12-08T07:19:43.000000Z' updated_at: '2025-12-08T07:39:24.000000Z' deleted_at: null order_id: 5 hwb_number: HWB-2025128-0002 contents: 'Computer - Desktop' declared_value: '2500000.00' weight: '5.00' length: '4.00' width: '6.00' height: '2.00' is_fragile: true is_hazardous: false is_damaged: false package_photos: - package_photos/ngtZoTVR3mPb8G8otpFTeKnD78maftxCL7UXRcuD.jpg - package_photos/LXHHmhE4YM0YoTn1Lva95FSyQi31i89dskkPv2il.jpg - package_photos/thtdPXJtqtkpECHhbeyXIOAIMSGt564ZFIXBqdcp.jpg - package_photos/Uc34hnpyAPsAT1QINJfca0msaFdudcYfaY2Qs21h.jpg location_id: 1 received_at: '2025-12-03T00:00:00.000000Z' properties: message: type: string example: 'Package photos uploaded successfully' data: type: object properties: id: type: integer example: 1 created_at: type: string example: '2025-12-08T07:19:43.000000Z' updated_at: type: string example: '2025-12-08T07:39:24.000000Z' deleted_at: type: string example: null order_id: type: integer example: 5 hwb_number: type: string example: HWB-2025128-0002 contents: type: string example: 'Computer - Desktop' declared_value: type: string example: '2500000.00' weight: type: string example: '5.00' length: type: string example: '4.00' width: type: string example: '6.00' height: type: string example: '2.00' is_fragile: type: boolean example: true is_hazardous: type: boolean example: false is_damaged: type: boolean example: false package_photos: type: array example: - package_photos/ngtZoTVR3mPb8G8otpFTeKnD78maftxCL7UXRcuD.jpg - package_photos/LXHHmhE4YM0YoTn1Lva95FSyQi31i89dskkPv2il.jpg - package_photos/thtdPXJtqtkpECHhbeyXIOAIMSGt564ZFIXBqdcp.jpg - package_photos/Uc34hnpyAPsAT1QINJfca0msaFdudcYfaY2Qs21h.jpg items: type: string location_id: type: integer example: 1 received_at: type: string example: '2025-12-03T00:00:00.000000Z' tags: - Package requestBody: required: true content: multipart/form-data: schema: type: object properties: photos: type: array description: 'Must be an image.' items: type: string format: binary 'photos[]': type: string format: binary description: '' required: - 'photos[]' delete: summary: 'Delete a Package image' operationId: deleteAPackageImage description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: message: 'Package photo deleted successfully' data: id: 1 created_at: '2025-12-08T07:19:43.000000Z' updated_at: '2025-12-08T07:39:24.000000Z' deleted_at: null order_id: 5 hwb_number: HWB-2025128-0002 contents: 'Computer - Desktop' declared_value: '2500000.00' weight: '5.00' length: '4.00' width: '6.00' height: '2.00' is_fragile: true is_hazardous: false is_damaged: false package_photos: - package_photos/LXHHmhE4YM0YoTn1Lva95FSyQi31i89dskkPv2il.jpg - package_photos/thtdPXJtqtkpECHhbeyXIOAIMSGt564ZFIXBqdcp.jpg - package_photos/Uc34hnpyAPsAT1QINJfca0msaFdudcYfaY2Qs21h.jpg location_id: 1 received_at: '2025-12-03T00:00:00.000000Z' properties: message: type: string example: 'Package photo deleted successfully' data: type: object properties: id: type: integer example: 1 created_at: type: string example: '2025-12-08T07:19:43.000000Z' updated_at: type: string example: '2025-12-08T07:39:24.000000Z' deleted_at: type: string example: null order_id: type: integer example: 5 hwb_number: type: string example: HWB-2025128-0002 contents: type: string example: 'Computer - Desktop' declared_value: type: string example: '2500000.00' weight: type: string example: '5.00' length: type: string example: '4.00' width: type: string example: '6.00' height: type: string example: '2.00' is_fragile: type: boolean example: true is_hazardous: type: boolean example: false is_damaged: type: boolean example: false package_photos: type: array example: - package_photos/LXHHmhE4YM0YoTn1Lva95FSyQi31i89dskkPv2il.jpg - package_photos/thtdPXJtqtkpECHhbeyXIOAIMSGt564ZFIXBqdcp.jpg - package_photos/Uc34hnpyAPsAT1QINJfca0msaFdudcYfaY2Qs21h.jpg items: type: string location_id: type: integer example: 1 received_at: type: string example: '2025-12-03T00:00:00.000000Z' tags: - Package requestBody: required: true content: application/json: schema: type: object properties: photo: type: string description: 'e.g package_photos/ngtZoTVR3mPb8G8otpFTeKnD78maftxCL7UXRcuD.jpg' example: consequatur required: - photo parameters: - in: path name: id description: 'The ID of the package.' example: consequatur required: true schema: type: string - in: path name: packageId description: '' example: 17 required: true schema: type: integer /api/refresh_package_status: post: summary: 'Update a Package status' operationId: updateAPackageStatus description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - Package requestBody: required: true content: application/json: schema: type: object properties: barcode: type: string description: 'Read this from a barcode reader' example: consequatur status: type: string description: "E.g held,approved'" example: consequatur notes: type: string description: '' example: consequatur nullable: true required: - barcode - status - notes /api/release-package: post: summary: 'Release Package to customer' operationId: releasePackageToCustomer description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - 'Consolidation Batch' requestBody: required: false content: application/json: schema: type: object properties: barcode: type: string description: 'This is the Package Bar code, Scan it.' example: consequatur /api/consolidation-batches: get: summary: 'Consolidation Batches' operationId: consolidationBatches description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: application/json: schema: type: array items: type: object properties: id: type: integer example: 1 created_at: type: string example: '2025-12-08T08:21:32.000000Z' updated_at: type: string example: '2025-12-08T08:40:10.000000Z' deleted_at: type: string example: null mawb_number: type: string example: MAWB-20251208-001 transport_mode: type: string example: AIR container_flight_number: type: string example: AB001 departure_date: type: string example: '2025-12-10T00:00:00.000000Z' status: type: string example: FINALIZED package_count: type: integer example: 0 total_weight: type: string example: '0.00' created_by: type: integer example: 1 finalized_at: type: string example: '2025-12-09T00:00:00.000000Z' departed_at: type: string example: '2025-12-10T00:00:00.000000Z' arrived_at: type: string example: '2025-12-10T00:00:00.000000Z' packages: type: array example: - id: 1 created_at: '2025-12-08T07:19:43.000000Z' updated_at: '2025-12-08T07:42:06.000000Z' deleted_at: null order_id: 5 hwb_number: HWB-2025128-0002 contents: 'Computer - Desktop' declared_value: '2500000.00' weight: '5.00' length: '4.00' width: '6.00' height: '2.00' is_fragile: true is_hazardous: false is_damaged: false package_photos: - package_photos/LXHHmhE4YM0YoTn1Lva95FSyQi31i89dskkPv2il.jpg - package_photos/thtdPXJtqtkpECHhbeyXIOAIMSGt564ZFIXBqdcp.jpg - package_photos/Uc34hnpyAPsAT1QINJfca0msaFdudcYfaY2Qs21h.jpg location_id: 1 received_at: '2025-12-03T00:00:00.000000Z' pivot: batch_id: 1 package_id: 1 created_at: '2025-12-08T08:57:19.000000Z' updated_at: '2025-12-08T08:57:19.000000Z' order: id: 5 created_at: '2025-12-05T12:20:11.000000Z' updated_at: '2025-12-05T12:20:11.000000Z' deleted_at: null tracking_number: ORD-20251205-00002 user_id: 1 origin_country: ITALY receiver_name: 'Tom Mboya' receiver_phone: '0789887766' receiver_email: tom.mboya@gmail.com receiver_address: 'Uganda - Kampala' status: PENDING received_at: null dispatched_at: null arrived_at: null released_at: null delivered_at: null user: id: 1 full_name: 'Thembo Charles' email: ashley7520charles@gmail.com phone: '0787444081' email_verified_at: null tin: '110023452' passport: '65748' address: Kampala otp: '4782' status: active user_type: user created_at: '2025-12-05T06:42:09.000000Z' updated_at: '2025-12-05T07:58:28.000000Z' deleted_at: null items: type: object properties: id: type: integer example: 1 created_at: type: string example: '2025-12-08T07:19:43.000000Z' updated_at: type: string example: '2025-12-08T07:42:06.000000Z' deleted_at: type: string example: null order_id: type: integer example: 5 hwb_number: type: string example: HWB-2025128-0002 contents: type: string example: 'Computer - Desktop' declared_value: type: string example: '2500000.00' weight: type: string example: '5.00' length: type: string example: '4.00' width: type: string example: '6.00' height: type: string example: '2.00' is_fragile: type: boolean example: true is_hazardous: type: boolean example: false is_damaged: type: boolean example: false package_photos: type: array example: - package_photos/LXHHmhE4YM0YoTn1Lva95FSyQi31i89dskkPv2il.jpg - package_photos/thtdPXJtqtkpECHhbeyXIOAIMSGt564ZFIXBqdcp.jpg - package_photos/Uc34hnpyAPsAT1QINJfca0msaFdudcYfaY2Qs21h.jpg items: type: string location_id: type: integer example: 1 received_at: type: string example: '2025-12-03T00:00:00.000000Z' pivot: type: object properties: batch_id: type: integer example: 1 package_id: type: integer example: 1 created_at: type: string example: '2025-12-08T08:57:19.000000Z' updated_at: type: string example: '2025-12-08T08:57:19.000000Z' order: type: object properties: id: type: integer example: 5 created_at: type: string example: '2025-12-05T12:20:11.000000Z' updated_at: type: string example: '2025-12-05T12:20:11.000000Z' deleted_at: type: string example: null tracking_number: type: string example: ORD-20251205-00002 user_id: type: integer example: 1 origin_country: type: string example: ITALY receiver_name: type: string example: 'Tom Mboya' receiver_phone: type: string example: '0789887766' receiver_email: type: string example: tom.mboya@gmail.com receiver_address: type: string example: 'Uganda - Kampala' status: type: string example: PENDING received_at: type: string example: null dispatched_at: type: string example: null arrived_at: type: string example: null released_at: type: string example: null delivered_at: type: string example: null user: type: object properties: id: type: integer example: 1 full_name: type: string example: 'Thembo Charles' email: type: string example: ashley7520charles@gmail.com phone: type: string example: '0787444081' email_verified_at: type: string example: null tin: type: string example: '110023452' passport: type: string example: '65748' address: type: string example: Kampala otp: type: string example: '4782' status: type: string example: active user_type: type: string example: user created_at: type: string example: '2025-12-05T06:42:09.000000Z' updated_at: type: string example: '2025-12-05T07:58:28.000000Z' deleted_at: type: string example: null example: - id: 1 created_at: '2025-12-08T08:21:32.000000Z' updated_at: '2025-12-08T08:40:10.000000Z' deleted_at: null mawb_number: MAWB-20251208-001 transport_mode: AIR container_flight_number: AB001 departure_date: '2025-12-10T00:00:00.000000Z' status: FINALIZED package_count: 0 total_weight: '0.00' created_by: 1 finalized_at: '2025-12-09T00:00:00.000000Z' departed_at: '2025-12-10T00:00:00.000000Z' arrived_at: '2025-12-10T00:00:00.000000Z' packages: - id: 1 created_at: '2025-12-08T07:19:43.000000Z' updated_at: '2025-12-08T07:42:06.000000Z' deleted_at: null order_id: 5 hwb_number: HWB-2025128-0002 contents: 'Computer - Desktop' declared_value: '2500000.00' weight: '5.00' length: '4.00' width: '6.00' height: '2.00' is_fragile: true is_hazardous: false is_damaged: false package_photos: - package_photos/LXHHmhE4YM0YoTn1Lva95FSyQi31i89dskkPv2il.jpg - package_photos/thtdPXJtqtkpECHhbeyXIOAIMSGt564ZFIXBqdcp.jpg - package_photos/Uc34hnpyAPsAT1QINJfca0msaFdudcYfaY2Qs21h.jpg location_id: 1 received_at: '2025-12-03T00:00:00.000000Z' pivot: batch_id: 1 package_id: 1 created_at: '2025-12-08T08:57:19.000000Z' updated_at: '2025-12-08T08:57:19.000000Z' order: id: 5 created_at: '2025-12-05T12:20:11.000000Z' updated_at: '2025-12-05T12:20:11.000000Z' deleted_at: null tracking_number: ORD-20251205-00002 user_id: 1 origin_country: ITALY receiver_name: 'Tom Mboya' receiver_phone: '0789887766' receiver_email: tom.mboya@gmail.com receiver_address: 'Uganda - Kampala' status: PENDING received_at: null dispatched_at: null arrived_at: null released_at: null delivered_at: null user: id: 1 full_name: 'Thembo Charles' email: ashley7520charles@gmail.com phone: '0787444081' email_verified_at: null tin: '110023452' passport: '65748' address: Kampala otp: '4782' status: active user_type: user created_at: '2025-12-05T06:42:09.000000Z' updated_at: '2025-12-05T07:58:28.000000Z' deleted_at: null tags: - 'Consolidation Batch' post: summary: 'Create a Consolidation Batch' operationId: createAConsolidationBatch description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - 'Consolidation Batch' requestBody: required: true content: application/json: schema: type: object properties: transport_mode: type: string description: "e.g 'AIR', 'SEA', 'ROAD', 'TRAIN'" example: consequatur container_flight_number: type: string description: '' example: consequatur nullable: true departure_date: type: date description: '' example: consequatur nullable: true status: type: string description: 'Request parameter: status.' example: 'Any string' enum: - OPEN - FINALIZED - DEPARTED - ARRIVED destination_warehouse_id: type: integer description: '' example: 17 warehouse_location_id: type: integer description: '' example: 17 mawb_number: type: string description: nullable example: consequatur required: - transport_mode - container_flight_number - departure_date - destination_warehouse_id - warehouse_location_id '/api/consolidation-batches/{id}': get: summary: 'Consolidation Batch' operationId: consolidationBatch description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: application/json: schema: type: array items: type: object properties: id: type: integer example: 1 created_at: type: string example: '2025-12-08T08:21:32.000000Z' updated_at: type: string example: '2025-12-08T08:40:10.000000Z' deleted_at: type: string example: null mawb_number: type: string example: MAWB-20251208-001 transport_mode: type: string example: AIR container_flight_number: type: string example: AB001 departure_date: type: string example: '2025-12-10T00:00:00.000000Z' status: type: string example: FINALIZED package_count: type: integer example: 0 total_weight: type: string example: '0.00' created_by: type: integer example: 1 finalized_at: type: string example: '2025-12-09T00:00:00.000000Z' departed_at: type: string example: '2025-12-10T00:00:00.000000Z' arrived_at: type: string example: '2025-12-10T00:00:00.000000Z' packages: type: array example: - id: 1 created_at: '2025-12-08T07:19:43.000000Z' updated_at: '2025-12-08T07:42:06.000000Z' deleted_at: null order_id: 5 hwb_number: HWB-2025128-0002 contents: 'Computer - Desktop' declared_value: '2500000.00' weight: '5.00' length: '4.00' width: '6.00' height: '2.00' is_fragile: true is_hazardous: false is_damaged: false package_photos: - package_photos/LXHHmhE4YM0YoTn1Lva95FSyQi31i89dskkPv2il.jpg - package_photos/thtdPXJtqtkpECHhbeyXIOAIMSGt564ZFIXBqdcp.jpg - package_photos/Uc34hnpyAPsAT1QINJfca0msaFdudcYfaY2Qs21h.jpg location_id: 1 received_at: '2025-12-03T00:00:00.000000Z' pivot: batch_id: 1 package_id: 1 created_at: '2025-12-08T08:57:19.000000Z' updated_at: '2025-12-08T08:57:19.000000Z' order: id: 5 created_at: '2025-12-05T12:20:11.000000Z' updated_at: '2025-12-05T12:20:11.000000Z' deleted_at: null tracking_number: ORD-20251205-00002 user_id: 1 origin_country: ITALY receiver_name: 'Tom Mboya' receiver_phone: '0789887766' receiver_email: tom.mboya@gmail.com receiver_address: 'Uganda - Kampala' status: PENDING received_at: null dispatched_at: null arrived_at: null released_at: null delivered_at: null user: id: 1 full_name: 'Thembo Charles' email: ashley7520charles@gmail.com phone: '0787444081' email_verified_at: null tin: '110023452' passport: '65748' address: Kampala otp: '4782' status: active user_type: user created_at: '2025-12-05T06:42:09.000000Z' updated_at: '2025-12-05T07:58:28.000000Z' deleted_at: null items: type: object properties: id: type: integer example: 1 created_at: type: string example: '2025-12-08T07:19:43.000000Z' updated_at: type: string example: '2025-12-08T07:42:06.000000Z' deleted_at: type: string example: null order_id: type: integer example: 5 hwb_number: type: string example: HWB-2025128-0002 contents: type: string example: 'Computer - Desktop' declared_value: type: string example: '2500000.00' weight: type: string example: '5.00' length: type: string example: '4.00' width: type: string example: '6.00' height: type: string example: '2.00' is_fragile: type: boolean example: true is_hazardous: type: boolean example: false is_damaged: type: boolean example: false package_photos: type: array example: - package_photos/LXHHmhE4YM0YoTn1Lva95FSyQi31i89dskkPv2il.jpg - package_photos/thtdPXJtqtkpECHhbeyXIOAIMSGt564ZFIXBqdcp.jpg - package_photos/Uc34hnpyAPsAT1QINJfca0msaFdudcYfaY2Qs21h.jpg items: type: string location_id: type: integer example: 1 received_at: type: string example: '2025-12-03T00:00:00.000000Z' pivot: type: object properties: batch_id: type: integer example: 1 package_id: type: integer example: 1 created_at: type: string example: '2025-12-08T08:57:19.000000Z' updated_at: type: string example: '2025-12-08T08:57:19.000000Z' order: type: object properties: id: type: integer example: 5 created_at: type: string example: '2025-12-05T12:20:11.000000Z' updated_at: type: string example: '2025-12-05T12:20:11.000000Z' deleted_at: type: string example: null tracking_number: type: string example: ORD-20251205-00002 user_id: type: integer example: 1 origin_country: type: string example: ITALY receiver_name: type: string example: 'Tom Mboya' receiver_phone: type: string example: '0789887766' receiver_email: type: string example: tom.mboya@gmail.com receiver_address: type: string example: 'Uganda - Kampala' status: type: string example: PENDING received_at: type: string example: null dispatched_at: type: string example: null arrived_at: type: string example: null released_at: type: string example: null delivered_at: type: string example: null user: type: object properties: id: type: integer example: 1 full_name: type: string example: 'Thembo Charles' email: type: string example: ashley7520charles@gmail.com phone: type: string example: '0787444081' email_verified_at: type: string example: null tin: type: string example: '110023452' passport: type: string example: '65748' address: type: string example: Kampala otp: type: string example: '4782' status: type: string example: active user_type: type: string example: user created_at: type: string example: '2025-12-05T06:42:09.000000Z' updated_at: type: string example: '2025-12-05T07:58:28.000000Z' deleted_at: type: string example: null example: - id: 1 created_at: '2025-12-08T08:21:32.000000Z' updated_at: '2025-12-08T08:40:10.000000Z' deleted_at: null mawb_number: MAWB-20251208-001 transport_mode: AIR container_flight_number: AB001 departure_date: '2025-12-10T00:00:00.000000Z' status: FINALIZED package_count: 0 total_weight: '0.00' created_by: 1 finalized_at: '2025-12-09T00:00:00.000000Z' departed_at: '2025-12-10T00:00:00.000000Z' arrived_at: '2025-12-10T00:00:00.000000Z' packages: - id: 1 created_at: '2025-12-08T07:19:43.000000Z' updated_at: '2025-12-08T07:42:06.000000Z' deleted_at: null order_id: 5 hwb_number: HWB-2025128-0002 contents: 'Computer - Desktop' declared_value: '2500000.00' weight: '5.00' length: '4.00' width: '6.00' height: '2.00' is_fragile: true is_hazardous: false is_damaged: false package_photos: - package_photos/LXHHmhE4YM0YoTn1Lva95FSyQi31i89dskkPv2il.jpg - package_photos/thtdPXJtqtkpECHhbeyXIOAIMSGt564ZFIXBqdcp.jpg - package_photos/Uc34hnpyAPsAT1QINJfca0msaFdudcYfaY2Qs21h.jpg location_id: 1 received_at: '2025-12-03T00:00:00.000000Z' pivot: batch_id: 1 package_id: 1 created_at: '2025-12-08T08:57:19.000000Z' updated_at: '2025-12-08T08:57:19.000000Z' order: id: 5 created_at: '2025-12-05T12:20:11.000000Z' updated_at: '2025-12-05T12:20:11.000000Z' deleted_at: null tracking_number: ORD-20251205-00002 user_id: 1 origin_country: ITALY receiver_name: 'Tom Mboya' receiver_phone: '0789887766' receiver_email: tom.mboya@gmail.com receiver_address: 'Uganda - Kampala' status: PENDING received_at: null dispatched_at: null arrived_at: null released_at: null delivered_at: null user: id: 1 full_name: 'Thembo Charles' email: ashley7520charles@gmail.com phone: '0787444081' email_verified_at: null tin: '110023452' passport: '65748' address: Kampala otp: '4782' status: active user_type: user created_at: '2025-12-05T06:42:09.000000Z' updated_at: '2025-12-05T07:58:28.000000Z' deleted_at: null tags: - 'Consolidation Batch' put: summary: 'Update a Consolidation Batch' operationId: updateAConsolidationBatch description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - 'Consolidation Batch' requestBody: required: true content: application/json: schema: type: object properties: transport_mode: type: string description: "e.g 'AIR', 'SEA', 'ROAD', 'TRAIN'" example: consequatur container_flight_number: type: string description: '' example: consequatur departure_date: type: date description: '' example: consequatur status: type: string description: 'e.g OPEN,FINALIZED,DEPARTED,ARRIVED' example: consequatur destination_warehouse_id: type: integer description: string example: 17 warehouse_location_id: type: integer description: '' example: 17 mawb_number: type: string description: 'Request parameter: mawb_number.' example: 'Any string' required: - transport_mode - container_flight_number - departure_date - warehouse_location_id delete: summary: 'Delete Consolidation Batch' operationId: deleteConsolidationBatch description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: text/plain: schema: type: string example: "{\n \"status\": \"success\",\n \"message\": \"Consolidation batch deleted successfully.\",\n }\n }" tags: - 'Consolidation Batch' parameters: - in: path name: id description: 'The ID of the consolidation batch.' example: consequatur required: true schema: type: string /api/receive-consolidation: post: summary: 'Receive Consolidation at destination' operationId: receiveConsolidationAtDestination description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: text/plain: schema: type: string example: "{\n \"status\": \"success\",\n \"message\": \"Consolidation batch deleted successfully.\",\n }\n }" tags: - 'Consolidation Batch' requestBody: required: true content: application/json: schema: type: object properties: consolidation_id: type: integer description: '' example: 17 barcode: type: string description: 'This is the Package Bar code, Scan then all untill they are done.' example: consequatur required: - consolidation_id /api/search-consolidation: post: summary: 'Search Consolidation at destination' operationId: searchConsolidationAtDestination description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - 'Consolidation Batch' requestBody: required: true content: application/json: schema: type: object properties: consolidation_code: type: string description: 'This is the Consolidation Barcode, Scan it.' example: consequatur required: - consolidation_code /api/consolidation_by_barcode: post: summary: 'Read consolidation by barCode' operationId: readConsolidationByBarCode description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - 'Consolidation Batch' requestBody: required: false content: application/json: schema: type: object properties: consolidation_code: type: string description: '' example: consequatur /api/batch-packages: post: summary: 'Add Package to Batch/Consolidation' operationId: addPackageToBatchConsolidation description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - 'Batch Package' requestBody: required: true content: application/json: schema: type: object properties: barcode: type: integer description: 'The bar code of the package' example: 17 batch_id: type: integer description: '' example: 17 required: - barcode - batch_id delete: summary: 'Delete Consolidation Batch' operationId: deleteConsolidationBatch description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: text/plain: schema: type: string example: "{\n \"status\": \"success\",\n \"message\": \"Package removed from batch.\",\n }\n }" tags: - 'Batch Package' requestBody: required: true content: application/json: schema: type: object properties: batch_id: type: integer description: '' example: 17 package_id: type: integer description: '' example: 17 required: - batch_id - package_id /api/billing/invoices: get: summary: Invoices operationId: invoices description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: message: 'Invoices fetched successfully' data: current_page: 1 data: - id: 2 created_at: '2025-12-08T10:31:55.000000Z' updated_at: '2025-12-08T10:42:55.000000Z' deleted_at: null invoice_number: INV-20251208-00002 user_id: 1 order_id: 5 type: FREIGHT status: PAID due_date: '2005-12-09T00:00:00.000000Z' order: id: 5 created_at: '2025-12-05T12:20:11.000000Z' updated_at: '2025-12-05T12:20:11.000000Z' deleted_at: null tracking_number: ORD-20251205-00002 user_id: 1 origin_country: ITALY receiver_name: 'Tom Mboya' receiver_phone: '0789887766' receiver_email: tom.mboya@gmail.com receiver_address: 'Uganda - Kampala' status: PENDING received_at: null dispatched_at: null arrived_at: null released_at: null delivered_at: null user: id: 1 full_name: 'Thembo Charles' email: ashley7520charles@gmail.com phone: '0787444081' email_verified_at: null tin: '110023452' passport: '65748' address: Kampala otp: '4782' status: active user_type: user created_at: '2025-12-05T06:42:09.000000Z' updated_at: '2025-12-05T07:58:28.000000Z' deleted_at: null line_items: [] payments: [] - id: 1 created_at: '2025-12-08T10:31:08.000000Z' updated_at: '2025-12-08T10:31:08.000000Z' deleted_at: null invoice_number: ORD-20251208-00001 user_id: 1 order_id: 5 type: FREIGHT status: UNPAID due_date: '2005-12-09T00:00:00.000000Z' order: id: 5 created_at: '2025-12-05T12:20:11.000000Z' updated_at: '2025-12-05T12:20:11.000000Z' deleted_at: null tracking_number: ORD-20251205-00002 user_id: 1 origin_country: ITALY receiver_name: 'Tom Mboya' receiver_phone: '0789887766' receiver_email: tom.mboya@gmail.com receiver_address: 'Uganda - Kampala' status: PENDING received_at: null dispatched_at: null arrived_at: null released_at: null delivered_at: null user: id: 1 full_name: 'Thembo Charles' email: ashley7520charles@gmail.com phone: '0787444081' email_verified_at: null tin: '110023452' passport: '65748' address: Kampala otp: '4782' status: active user_type: user created_at: '2025-12-05T06:42:09.000000Z' updated_at: '2025-12-05T07:58:28.000000Z' deleted_at: null line_items: [] payments: [] first_page_url: 'http://127.0.0.1:8000/api/billing/invoices?page=1' from: 1 last_page: 1 last_page_url: 'http://127.0.0.1:8000/api/billing/invoices?page=1' links: - url: null label: '« Previous' active: false - url: 'http://127.0.0.1:8000/api/billing/invoices?page=1' label: '1' active: true - url: null label: 'Next »' active: false next_page_url: null path: 'http://127.0.0.1:8000/api/billing/invoices' per_page: 20 prev_page_url: null to: 2 total: 2 properties: message: type: string example: 'Invoices fetched successfully' data: type: object properties: current_page: type: integer example: 1 data: type: array example: - id: 2 created_at: '2025-12-08T10:31:55.000000Z' updated_at: '2025-12-08T10:42:55.000000Z' deleted_at: null invoice_number: INV-20251208-00002 user_id: 1 order_id: 5 type: FREIGHT status: PAID due_date: '2005-12-09T00:00:00.000000Z' order: id: 5 created_at: '2025-12-05T12:20:11.000000Z' updated_at: '2025-12-05T12:20:11.000000Z' deleted_at: null tracking_number: ORD-20251205-00002 user_id: 1 origin_country: ITALY receiver_name: 'Tom Mboya' receiver_phone: '0789887766' receiver_email: tom.mboya@gmail.com receiver_address: 'Uganda - Kampala' status: PENDING received_at: null dispatched_at: null arrived_at: null released_at: null delivered_at: null user: id: 1 full_name: 'Thembo Charles' email: ashley7520charles@gmail.com phone: '0787444081' email_verified_at: null tin: '110023452' passport: '65748' address: Kampala otp: '4782' status: active user_type: user created_at: '2025-12-05T06:42:09.000000Z' updated_at: '2025-12-05T07:58:28.000000Z' deleted_at: null line_items: [] payments: [] - id: 1 created_at: '2025-12-08T10:31:08.000000Z' updated_at: '2025-12-08T10:31:08.000000Z' deleted_at: null invoice_number: ORD-20251208-00001 user_id: 1 order_id: 5 type: FREIGHT status: UNPAID due_date: '2005-12-09T00:00:00.000000Z' order: id: 5 created_at: '2025-12-05T12:20:11.000000Z' updated_at: '2025-12-05T12:20:11.000000Z' deleted_at: null tracking_number: ORD-20251205-00002 user_id: 1 origin_country: ITALY receiver_name: 'Tom Mboya' receiver_phone: '0789887766' receiver_email: tom.mboya@gmail.com receiver_address: 'Uganda - Kampala' status: PENDING received_at: null dispatched_at: null arrived_at: null released_at: null delivered_at: null user: id: 1 full_name: 'Thembo Charles' email: ashley7520charles@gmail.com phone: '0787444081' email_verified_at: null tin: '110023452' passport: '65748' address: Kampala otp: '4782' status: active user_type: user created_at: '2025-12-05T06:42:09.000000Z' updated_at: '2025-12-05T07:58:28.000000Z' deleted_at: null line_items: [] payments: [] items: type: object properties: id: type: integer example: 2 created_at: type: string example: '2025-12-08T10:31:55.000000Z' updated_at: type: string example: '2025-12-08T10:42:55.000000Z' deleted_at: type: string example: null invoice_number: type: string example: INV-20251208-00002 user_id: type: integer example: 1 order_id: type: integer example: 5 type: type: string example: FREIGHT status: type: string example: PAID due_date: type: string example: '2005-12-09T00:00:00.000000Z' order: type: object properties: id: type: integer example: 5 created_at: type: string example: '2025-12-05T12:20:11.000000Z' updated_at: type: string example: '2025-12-05T12:20:11.000000Z' deleted_at: type: string example: null tracking_number: type: string example: ORD-20251205-00002 user_id: type: integer example: 1 origin_country: type: string example: ITALY receiver_name: type: string example: 'Tom Mboya' receiver_phone: type: string example: '0789887766' receiver_email: type: string example: tom.mboya@gmail.com receiver_address: type: string example: 'Uganda - Kampala' status: type: string example: PENDING received_at: type: string example: null dispatched_at: type: string example: null arrived_at: type: string example: null released_at: type: string example: null delivered_at: type: string example: null user: type: object properties: id: type: integer example: 1 full_name: type: string example: 'Thembo Charles' email: type: string example: ashley7520charles@gmail.com phone: type: string example: '0787444081' email_verified_at: type: string example: null tin: type: string example: '110023452' passport: type: string example: '65748' address: type: string example: Kampala otp: type: string example: '4782' status: type: string example: active user_type: type: string example: user created_at: type: string example: '2025-12-05T06:42:09.000000Z' updated_at: type: string example: '2025-12-05T07:58:28.000000Z' deleted_at: type: string example: null line_items: type: array example: [] payments: type: array example: [] first_page_url: type: string example: 'http://127.0.0.1:8000/api/billing/invoices?page=1' from: type: integer example: 1 last_page: type: integer example: 1 last_page_url: type: string example: 'http://127.0.0.1:8000/api/billing/invoices?page=1' links: type: array example: - url: null label: '« Previous' active: false - url: 'http://127.0.0.1:8000/api/billing/invoices?page=1' label: '1' active: true - url: null label: 'Next »' active: false items: type: object properties: url: type: string example: null label: type: string example: '« Previous' active: type: boolean example: false next_page_url: type: string example: null path: type: string example: 'http://127.0.0.1:8000/api/billing/invoices' per_page: type: integer example: 20 prev_page_url: type: string example: null to: type: integer example: 2 total: type: integer example: 2 tags: - Invoice post: summary: 'Make an Invoice' operationId: makeAnInvoice description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: message: 'Invoice created successfully' data: order_id: '5' type: FREIGHT due_date: '2005-12-09T00:00:00.000000Z' user_id: 1 invoice_number: INV-20251208-00002 updated_at: '2025-12-08T10:31:55.000000Z' created_at: '2025-12-08T10:31:55.000000Z' id: 2 order: id: 5 created_at: '2025-12-05T12:20:11.000000Z' updated_at: '2025-12-05T12:20:11.000000Z' deleted_at: null tracking_number: ORD-20251205-00002 user_id: 1 origin_country: ITALY receiver_name: 'Tom Mboya' receiver_phone: '0789887766' receiver_email: tom.mboya@gmail.com receiver_address: 'Uganda - Kampala' status: PENDING received_at: null dispatched_at: null arrived_at: null released_at: null delivered_at: null properties: message: type: string example: 'Invoice created successfully' data: type: object properties: order_id: type: string example: '5' type: type: string example: FREIGHT due_date: type: string example: '2005-12-09T00:00:00.000000Z' user_id: type: integer example: 1 invoice_number: type: string example: INV-20251208-00002 updated_at: type: string example: '2025-12-08T10:31:55.000000Z' created_at: type: string example: '2025-12-08T10:31:55.000000Z' id: type: integer example: 2 order: type: object properties: id: type: integer example: 5 created_at: type: string example: '2025-12-05T12:20:11.000000Z' updated_at: type: string example: '2025-12-05T12:20:11.000000Z' deleted_at: type: string example: null tracking_number: type: string example: ORD-20251205-00002 user_id: type: integer example: 1 origin_country: type: string example: ITALY receiver_name: type: string example: 'Tom Mboya' receiver_phone: type: string example: '0789887766' receiver_email: type: string example: tom.mboya@gmail.com receiver_address: type: string example: 'Uganda - Kampala' status: type: string example: PENDING received_at: type: string example: null dispatched_at: type: string example: null arrived_at: type: string example: null released_at: type: string example: null delivered_at: type: string example: null tags: - Invoice requestBody: required: true content: application/json: schema: type: object properties: order_id: type: string description: '' example: consequatur type: type: string description: '' example: 'FREIGHT,STORAGE,CUSTOMS,OTHER,SHOPPING' 0: type: string description: 'Request parameter: 0.' example: 'Any string' due_date: type: date description: '' example: consequatur nullable: true currency: type: string description: optional example: consequatur required: - order_id - type - due_date '/api/billing/invoices/{id}': get: summary: 'Single Invoice Details' operationId: singleInvoiceDetails description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/billing/invoices/consequatur could not be found.' properties: message: type: string example: 'The route api/billing/invoices/consequatur could not be found.' tags: - Invoice requestBody: required: true content: application/json: schema: type: object properties: invoice_id: type: integer description: '' example: 17 required: - invoice_id put: summary: 'Update an Invoice' operationId: updateAnInvoice description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: message: 'Invoice Updated successfully' data: order_id: '5' type: FREIGHT due_date: '2005-12-09T00:00:00.000000Z' user_id: 1 invoice_number: INV-20251208-00002 updated_at: '2025-12-08T10:31:55.000000Z' created_at: '2025-12-08T10:31:55.000000Z' id: 2 order: id: 5 created_at: '2025-12-05T12:20:11.000000Z' updated_at: '2025-12-05T12:20:11.000000Z' deleted_at: null tracking_number: ORD-20251205-00002 user_id: 1 origin_country: ITALY receiver_name: 'Tom Mboya' receiver_phone: '0789887766' receiver_email: tom.mboya@gmail.com receiver_address: 'Uganda - Kampala' status: PENDING received_at: null dispatched_at: null arrived_at: null released_at: null delivered_at: null properties: message: type: string example: 'Invoice Updated successfully' data: type: object properties: order_id: type: string example: '5' type: type: string example: FREIGHT due_date: type: string example: '2005-12-09T00:00:00.000000Z' user_id: type: integer example: 1 invoice_number: type: string example: INV-20251208-00002 updated_at: type: string example: '2025-12-08T10:31:55.000000Z' created_at: type: string example: '2025-12-08T10:31:55.000000Z' id: type: integer example: 2 order: type: object properties: id: type: integer example: 5 created_at: type: string example: '2025-12-05T12:20:11.000000Z' updated_at: type: string example: '2025-12-05T12:20:11.000000Z' deleted_at: type: string example: null tracking_number: type: string example: ORD-20251205-00002 user_id: type: integer example: 1 origin_country: type: string example: ITALY receiver_name: type: string example: 'Tom Mboya' receiver_phone: type: string example: '0789887766' receiver_email: type: string example: tom.mboya@gmail.com receiver_address: type: string example: 'Uganda - Kampala' status: type: string example: PENDING received_at: type: string example: null dispatched_at: type: string example: null arrived_at: type: string example: null released_at: type: string example: null delivered_at: type: string example: null tags: - Invoice requestBody: required: true content: application/json: schema: type: object properties: type: type: string description: '' example: 'FREIGHT,STORAGE,CUSTOMS,OTHER,SHOPPING' status: type: string description: '' example: 'UNPAID,PAID,OVERDUE,CANCELLED' due_date: type: date description: '' example: consequatur currency: type: string description: '' example: consequatur package_id: type: integer description: '' example: 17 required: - type - due_date delete: summary: 'Delete Invoice' operationId: deleteInvoice description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: text/plain: schema: type: string example: "{\n \"status\": \"success\",\n \"message\": \"Invoice deleted successfully\",\n }\n }" tags: - Invoice parameters: - in: path name: id description: 'The ID of the invoice.' example: consequatur required: true schema: type: string '/api/billing/invoices/{id}/restore': post: summary: 'Restore Invoice' operationId: restoreInvoice description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: text/plain: schema: type: string example: "{\n \"status\": \"success\",\n \"message\": \"Invoice restored successfully\",\n }\n }" tags: - Invoice parameters: - in: path name: id description: 'The ID of the invoice.' example: 1 required: true schema: type: integer - in: path name: invoice_id description: '' example: 17 required: true schema: type: integer /api/billing/invoice-line-items: post: summary: 'Add Item to Invoice' operationId: addItemToInvoice description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: message: 'Invoice line item created successfully' data: invoice_id: '1' description: 'Cargo A' quantity: '1' unit_price: '30000' updated_at: '2025-12-08T13:30:52.000000Z' created_at: '2025-12-08T13:30:52.000000Z' id: 1 properties: message: type: string example: 'Invoice line item created successfully' data: type: object properties: invoice_id: type: string example: '1' description: type: string example: 'Cargo A' quantity: type: string example: '1' unit_price: type: string example: '30000' updated_at: type: string example: '2025-12-08T13:30:52.000000Z' created_at: type: string example: '2025-12-08T13:30:52.000000Z' id: type: integer example: 1 tags: - Invoice requestBody: required: true content: application/json: schema: type: object properties: invoice_id: type: string description: '' example: consequatur package_id: type: integer description: optional example: 17 nullable: true description: type: string description: 'E.g freight, insurance, storage, repackaging' example: 'Dolores dolorum amet iste laborum eius est dolor.' quantity: type: integer description: '' example: 17 unit_price: type: number description: '' example: 11613.31890586 required: - invoice_id - description - quantity - unit_price get: summary: 'Display a listing of the resource.' operationId: displayAListingOfTheResource description: '' parameters: [] responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/billing/invoice-line-items could not be found.' properties: message: type: string example: 'The route api/billing/invoice-line-items could not be found.' tags: - Others security: [] '/api/billing/invoice-line-items/{id}': put: summary: 'Edit Invoice Item' operationId: editInvoiceItem description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: message: 'Invoice line item updated successfully' data: id: 2 created_at: '2025-12-08T13:32:09.000000Z' updated_at: '2025-12-08T13:32:09.000000Z' deleted_at: null invoice_id: 1 description: 'Cargo A' quantity: 1 unit_price: 30000 properties: message: type: string example: 'Invoice line item updated successfully' data: type: object properties: id: type: integer example: 2 created_at: type: string example: '2025-12-08T13:32:09.000000Z' updated_at: type: string example: '2025-12-08T13:32:09.000000Z' deleted_at: type: string example: null invoice_id: type: integer example: 1 description: type: string example: 'Cargo A' quantity: type: integer example: 1 unit_price: type: integer example: 30000 tags: - Invoice requestBody: required: true content: application/json: schema: type: object properties: description: type: string description: '' example: 'Dolores dolorum amet iste laborum eius est dolor.' quantity: type: integer description: '' example: 17 unit_price: type: number description: '' example: 11613.31890586 invoice_id: type: string description: '' example: consequatur required: - description - quantity - unit_price - invoice_id delete: summary: 'Delete Invoice Item' operationId: deleteInvoiceItem description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: message: 'Invoice line item deleted successfully' properties: message: type: string example: 'Invoice line item deleted successfully' tags: - Invoice get: summary: 'Display the specified resource.' operationId: displayTheSpecifiedResource description: '' parameters: [] responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/billing/invoice-line-items/1 could not be found.' properties: message: type: string example: 'The route api/billing/invoice-line-items/1 could not be found.' tags: - Others security: [] parameters: - in: path name: id description: 'The ID of the invoice line item.' example: 1 required: true schema: type: integer '/api/billing/invoice-line-items/{id}/restore': post: summary: 'Restore Invoice Item' operationId: restoreInvoiceItem description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: message: 'Invoice line item deleted successfully' properties: message: type: string example: 'Invoice line item deleted successfully' tags: - Invoice parameters: - in: path name: id description: 'The ID of the invoice line item.' example: 1 required: true schema: type: integer - in: path name: invoiceLineItem_id description: '' example: 17 required: true schema: type: integer /api/billing/payments: post: summary: 'Record Invoice Payment' operationId: recordInvoicePayment description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: message: 'Payment recorded successfully' data: invoice_id: '1' amount: '30000' method: CASH paid_at: '2025-12-08' updated_at: '2025-12-08T13:47:08.000000Z' created_at: '2025-12-08T13:47:08.000000Z' id: 1 properties: message: type: string example: 'Payment recorded successfully' data: type: object properties: invoice_id: type: string example: '1' amount: type: string example: '30000' method: type: string example: CASH paid_at: type: string example: '2025-12-08' updated_at: type: string example: '2025-12-08T13:47:08.000000Z' created_at: type: string example: '2025-12-08T13:47:08.000000Z' id: type: integer example: 1 tags: - Invoice requestBody: required: true content: application/json: schema: type: object properties: invoice_id: type: integer description: '' example: 17 nullable: true assisted_shopping_id: type: integer description: '' example: 17 nullable: true amount: type: number description: '' example: 11613.31890586 method: type: string description: '' example: 'MOBILE_MONEY,CARD,BANK_TRANSFER,CASH' nullable: true transaction_reference: type: string description: 'Request parameter: transaction_reference.' example: 'Any string' nullable: true gateway_reference: type: string description: 'Request parameter: gateway_reference.' example: 'Any string' nullable: true status: type: string description: 'Request parameter: status.' example: 'Any string' enum: - PENDING - COMPLETED - FAILED nullable: true paid_at: type: date description: '' example: consequatur required: - amount - method - paid_at get: summary: 'All Payments' operationId: allPayments description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/billing/payments could not be found.' properties: message: type: string example: 'The route api/billing/payments could not be found.' tags: - Invoice '/api/billing/payments/{payment_id}': delete: summary: 'Delete Invoice Payment' operationId: deleteInvoicePayment description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: text/plain: schema: type: string example: "{\n \"message\": \"Payment deleted successfully\",\n }" tags: - Invoice parameters: - in: path name: payment_id description: 'Optional parameter. date required' required: true schema: type: string examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: consequatur '/api/billing/send_invoice/{invoice_id}': get: summary: 'Send Invoice Notification' operationId: sendInvoiceNotification description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: text/plain: schema: type: string example: "{\n \"status\": \"success\",\n \"message\": \"Invoice Sent successfully\",\n }\n }" tags: - Invoice parameters: - in: path name: invoice_id description: '' example: 17 required: true schema: type: integer /api/delivery/orders: get: summary: 'Shipment Delivery' operationId: shipmentDelivery description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: text/plain: schema: type: string example: "{\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 4,\n \"created_at\": \"2025-12-09T07:41:36.000000Z\",\n \"updated_at\": \"2025-12-09T08:12:25.000000Z\",\n \"deleted_at\": null,\n \"delivery_number\": \"DEL-000001\",\n \"order_id\": 5,\n \"rider_id\": null,\n \"delivery_address\": \"Kasese\",\n \"delivery_date\": \"2025-12-10\",\n \"status\": \"PENDING\",\n \"pod_signature\": null,\n \"pod_photo_path\": \"pod_photos/2akLAes8oj4j5OIxC71O5GxwEN8fSJ1jxtotKyxk.jpg\",\n \"delivery_notes\": null,\n \"delivered_at\": null,\n \"order\": {\n \"id\": 5,\n \"created_at\": \"2025-12-05T12:20:11.000000Z\",\n \"updated_at\": \"2025-12-05T12:20:11.000000Z\",\n \"deleted_at\": null,\n \"tracking_number\": \"ORD-20251205-00002\",\n \"user_id\": 1,\n \"origin_country\": \"ITALY\",\n \"receiver_name\": \"Tom Mboya\",\n \"receiver_phone\": \"0789887766\",\n \"receiver_email\": \"tom.mboya@gmail.com\",\n \"receiver_address\": \"Uganda - Kampala\",\n \"status\": \"PENDING\",\n \"received_at\": null,\n \"dispatched_at\": null,\n \"arrived_at\": null,\n \"released_at\": null,\n \"delivered_at\": null,\n \"packages\": [\n {\n \"id\": 1,\n \"created_at\": \"2025-12-08T07:19:43.000000Z\",\n \"updated_at\": \"2025-12-08T07:42:06.000000Z\",\n \"deleted_at\": null,\n \"order_id\": 5,\n \"hwb_number\": \"HWB-2025128-0002\",\n \"contents\": \"Computer - Desktop\",\n \"declared_value\": \"2500000.00\",\n \"weight\": \"5.00\",\n \"length\": \"4.00\",\n \"width\": \"6.00\",\n \"height\": \"2.00\",\n \"is_fragile\": true,\n \"is_hazardous\": false,\n \"is_damaged\": false,\n \"package_photos\": [\n \"package_photos/LXHHmhE4YM0YoTn1Lva95FSyQi31i89dskkPv2il.jpg\",\n \"package_photos/thtdPXJtqtkpECHhbeyXIOAIMSGt564ZFIXBqdcp.jpg\",\n \"package_photos/Uc34hnpyAPsAT1QINJfca0msaFdudcYfaY2Qs21h.jpg\"\n ],\n \"location_id\": 1,\n \"received_at\": \"2025-12-03T00:00:00.000000Z\"\n },\n\n ]\n }\n }\n ],\n \"first_page_url\": \"http://127.0.0.1:8000/api/delivery/orders?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"http://127.0.0.1:8000/api/delivery/orders?page=1\",\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/delivery/orders?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"next_page_url\": null,\n \"path\": \"http://127.0.0.1:8000/api/delivery/orders\",\n \"per_page\": 20,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n}" tags: - 'Shipment Delivery' post: summary: 'Create Shipment Delivery' operationId: createShipmentDelivery description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: message: 'Shipment Delivery created successfully' data: order_id: '5' delivery_address: Kasese delivery_date: '2025-12-10' delivery_number: DEL-000001 updated_at: '2025-12-09T07:41:36.000000Z' created_at: '2025-12-09T07:41:36.000000Z' id: 4 order: id: 5 created_at: '2025-12-05T12:20:11.000000Z' updated_at: '2025-12-05T12:20:11.000000Z' deleted_at: null tracking_number: ORD-20251205-00002 user_id: 1 origin_country: ITALY receiver_name: 'Tom Mboya' receiver_phone: '0789887766' receiver_email: tom.mboya@gmail.com receiver_address: 'Uganda - Kampala' status: PENDING received_at: null dispatched_at: null arrived_at: null released_at: null delivered_at: null packages: - id: 1 created_at: '2025-12-08T07:19:43.000000Z' updated_at: '2025-12-08T07:42:06.000000Z' deleted_at: null order_id: 5 hwb_number: HWB-2025128-0002 contents: 'Computer - Desktop' declared_value: '2500000.00' weight: '5.00' length: '4.00' width: '6.00' height: '2.00' is_fragile: true is_hazardous: false is_damaged: false package_photos: - package_photos/LXHHmhE4YM0YoTn1Lva95FSyQi31i89dskkPv2il.jpg - package_photos/thtdPXJtqtkpECHhbeyXIOAIMSGt564ZFIXBqdcp.jpg - package_photos/Uc34hnpyAPsAT1QINJfca0msaFdudcYfaY2Qs21h.jpg location_id: 1 received_at: '2025-12-03T00:00:00.000000Z' - id: 2 created_at: '2025-12-08T07:32:17.000000Z' updated_at: '2025-12-08T07:32:17.000000Z' deleted_at: null order_id: 5 hwb_number: HWB-2025128-0021 contents: 'Computer - Desktop' declared_value: '2500000.00' weight: '5.00' length: '4.00' width: '6.00' height: '2.00' is_fragile: true is_hazardous: false is_damaged: false package_photos: null location_id: 1 received_at: '2025-12-03T00:00:00.000000Z' properties: message: type: string example: 'Shipment Delivery created successfully' data: type: object properties: order_id: type: string example: '5' delivery_address: type: string example: Kasese delivery_date: type: string example: '2025-12-10' delivery_number: type: string example: DEL-000001 updated_at: type: string example: '2025-12-09T07:41:36.000000Z' created_at: type: string example: '2025-12-09T07:41:36.000000Z' id: type: integer example: 4 order: type: object properties: id: type: integer example: 5 created_at: type: string example: '2025-12-05T12:20:11.000000Z' updated_at: type: string example: '2025-12-05T12:20:11.000000Z' deleted_at: type: string example: null tracking_number: type: string example: ORD-20251205-00002 user_id: type: integer example: 1 origin_country: type: string example: ITALY receiver_name: type: string example: 'Tom Mboya' receiver_phone: type: string example: '0789887766' receiver_email: type: string example: tom.mboya@gmail.com receiver_address: type: string example: 'Uganda - Kampala' status: type: string example: PENDING received_at: type: string example: null dispatched_at: type: string example: null arrived_at: type: string example: null released_at: type: string example: null delivered_at: type: string example: null packages: type: array example: - id: 1 created_at: '2025-12-08T07:19:43.000000Z' updated_at: '2025-12-08T07:42:06.000000Z' deleted_at: null order_id: 5 hwb_number: HWB-2025128-0002 contents: 'Computer - Desktop' declared_value: '2500000.00' weight: '5.00' length: '4.00' width: '6.00' height: '2.00' is_fragile: true is_hazardous: false is_damaged: false package_photos: - package_photos/LXHHmhE4YM0YoTn1Lva95FSyQi31i89dskkPv2il.jpg - package_photos/thtdPXJtqtkpECHhbeyXIOAIMSGt564ZFIXBqdcp.jpg - package_photos/Uc34hnpyAPsAT1QINJfca0msaFdudcYfaY2Qs21h.jpg location_id: 1 received_at: '2025-12-03T00:00:00.000000Z' - id: 2 created_at: '2025-12-08T07:32:17.000000Z' updated_at: '2025-12-08T07:32:17.000000Z' deleted_at: null order_id: 5 hwb_number: HWB-2025128-0021 contents: 'Computer - Desktop' declared_value: '2500000.00' weight: '5.00' length: '4.00' width: '6.00' height: '2.00' is_fragile: true is_hazardous: false is_damaged: false package_photos: null location_id: 1 received_at: '2025-12-03T00:00:00.000000Z' items: type: object properties: id: type: integer example: 1 created_at: type: string example: '2025-12-08T07:19:43.000000Z' updated_at: type: string example: '2025-12-08T07:42:06.000000Z' deleted_at: type: string example: null order_id: type: integer example: 5 hwb_number: type: string example: HWB-2025128-0002 contents: type: string example: 'Computer - Desktop' declared_value: type: string example: '2500000.00' weight: type: string example: '5.00' length: type: string example: '4.00' width: type: string example: '6.00' height: type: string example: '2.00' is_fragile: type: boolean example: true is_hazardous: type: boolean example: false is_damaged: type: boolean example: false package_photos: type: array example: - package_photos/LXHHmhE4YM0YoTn1Lva95FSyQi31i89dskkPv2il.jpg - package_photos/thtdPXJtqtkpECHhbeyXIOAIMSGt564ZFIXBqdcp.jpg - package_photos/Uc34hnpyAPsAT1QINJfca0msaFdudcYfaY2Qs21h.jpg items: type: string location_id: type: integer example: 1 received_at: type: string example: '2025-12-03T00:00:00.000000Z' tags: - 'Shipment Delivery' requestBody: required: true content: application/json: schema: type: object properties: rider_id: type: string description: 'Request parameter: rider_id. The id of an existing record in the users table.' example: 'Any string' nullable: true package_id: type: integer description: '' example: 17 delivery_address: type: string description: '' example: consequatur delivery_date: type: date description: '' example: consequatur status: type: string description: 'Request parameter: status.' example: 'Any string' enum: - PENDING - ASSIGNED - OUT_FOR_DELIVERY - DELIVERED - FAILED nullable: true pod_signature: type: string description: 'Request parameter: pod_signature.' example: 'Any string' nullable: true pod_photo_path: type: string description: 'Request parameter: pod_photo_path.' example: 'Any string' nullable: true delivery_notes: type: string description: '' example: consequatur nullable: true delivered_at: type: string description: 'Request parameter: delivered_at. Must be a valid date.' example: 'Any string' nullable: true required: - package_id - delivery_address - delivery_date '/api/delivery/orders/{id}': get: summary: 'Single Shipment Delivery' operationId: singleShipmentDelivery description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: message: 'Shipment Delivery' data: id: 4 created_at: '2025-12-09T07:41:36.000000Z' updated_at: '2025-12-09T08:12:25.000000Z' deleted_at: null delivery_number: DEL-000001 order_id: 5 rider_id: null delivery_address: Kasese delivery_date: '2025-12-10' status: PENDING pod_signature: null pod_photo_path: pod_photos/2akLAes8oj4j5OIxC71O5GxwEN8fSJ1jxtotKyxk.jpg delivery_notes: null delivered_at: null order: id: 5 created_at: '2025-12-05T12:20:11.000000Z' updated_at: '2025-12-05T12:20:11.000000Z' deleted_at: null tracking_number: ORD-20251205-00002 user_id: 1 origin_country: ITALY receiver_name: 'Tom Mboya' receiver_phone: '0789887766' receiver_email: tom.mboya@gmail.com receiver_address: 'Uganda - Kampala' status: PENDING received_at: null dispatched_at: null arrived_at: null released_at: null delivered_at: null packages: - id: 1 created_at: '2025-12-08T07:19:43.000000Z' updated_at: '2025-12-08T07:42:06.000000Z' deleted_at: null order_id: 5 hwb_number: HWB-2025128-0002 contents: 'Computer - Desktop' declared_value: '2500000.00' weight: '5.00' length: '4.00' width: '6.00' height: '2.00' is_fragile: true is_hazardous: false is_damaged: false package_photos: - package_photos/LXHHmhE4YM0YoTn1Lva95FSyQi31i89dskkPv2il.jpg - package_photos/thtdPXJtqtkpECHhbeyXIOAIMSGt564ZFIXBqdcp.jpg - package_photos/Uc34hnpyAPsAT1QINJfca0msaFdudcYfaY2Qs21h.jpg location_id: 1 received_at: '2025-12-03T00:00:00.000000Z' - id: 2 created_at: '2025-12-08T07:32:17.000000Z' updated_at: '2025-12-08T07:32:17.000000Z' deleted_at: null order_id: 5 hwb_number: HWB-2025128-0021 contents: 'Computer - Desktop' declared_value: '2500000.00' weight: '5.00' length: '4.00' width: '6.00' height: '2.00' is_fragile: true is_hazardous: false is_damaged: false package_photos: null location_id: 1 received_at: '2025-12-03T00:00:00.000000Z' user: id: 1 full_name: 'Thembo Charles' email: ashley7520charles@gmail.com phone: '0787444081' email_verified_at: null tin: '110023452' passport: '65748' address: Kampala otp: '4782' status: active user_type: user created_at: '2025-12-05T06:42:09.000000Z' updated_at: '2025-12-05T07:58:28.000000Z' deleted_at: null properties: message: type: string example: 'Shipment Delivery' data: type: object properties: id: type: integer example: 4 created_at: type: string example: '2025-12-09T07:41:36.000000Z' updated_at: type: string example: '2025-12-09T08:12:25.000000Z' deleted_at: type: string example: null delivery_number: type: string example: DEL-000001 order_id: type: integer example: 5 rider_id: type: string example: null delivery_address: type: string example: Kasese delivery_date: type: string example: '2025-12-10' status: type: string example: PENDING pod_signature: type: string example: null pod_photo_path: type: string example: pod_photos/2akLAes8oj4j5OIxC71O5GxwEN8fSJ1jxtotKyxk.jpg delivery_notes: type: string example: null delivered_at: type: string example: null order: type: object properties: id: type: integer example: 5 created_at: type: string example: '2025-12-05T12:20:11.000000Z' updated_at: type: string example: '2025-12-05T12:20:11.000000Z' deleted_at: type: string example: null tracking_number: type: string example: ORD-20251205-00002 user_id: type: integer example: 1 origin_country: type: string example: ITALY receiver_name: type: string example: 'Tom Mboya' receiver_phone: type: string example: '0789887766' receiver_email: type: string example: tom.mboya@gmail.com receiver_address: type: string example: 'Uganda - Kampala' status: type: string example: PENDING received_at: type: string example: null dispatched_at: type: string example: null arrived_at: type: string example: null released_at: type: string example: null delivered_at: type: string example: null packages: type: array example: - id: 1 created_at: '2025-12-08T07:19:43.000000Z' updated_at: '2025-12-08T07:42:06.000000Z' deleted_at: null order_id: 5 hwb_number: HWB-2025128-0002 contents: 'Computer - Desktop' declared_value: '2500000.00' weight: '5.00' length: '4.00' width: '6.00' height: '2.00' is_fragile: true is_hazardous: false is_damaged: false package_photos: - package_photos/LXHHmhE4YM0YoTn1Lva95FSyQi31i89dskkPv2il.jpg - package_photos/thtdPXJtqtkpECHhbeyXIOAIMSGt564ZFIXBqdcp.jpg - package_photos/Uc34hnpyAPsAT1QINJfca0msaFdudcYfaY2Qs21h.jpg location_id: 1 received_at: '2025-12-03T00:00:00.000000Z' - id: 2 created_at: '2025-12-08T07:32:17.000000Z' updated_at: '2025-12-08T07:32:17.000000Z' deleted_at: null order_id: 5 hwb_number: HWB-2025128-0021 contents: 'Computer - Desktop' declared_value: '2500000.00' weight: '5.00' length: '4.00' width: '6.00' height: '2.00' is_fragile: true is_hazardous: false is_damaged: false package_photos: null location_id: 1 received_at: '2025-12-03T00:00:00.000000Z' items: type: object properties: id: type: integer example: 1 created_at: type: string example: '2025-12-08T07:19:43.000000Z' updated_at: type: string example: '2025-12-08T07:42:06.000000Z' deleted_at: type: string example: null order_id: type: integer example: 5 hwb_number: type: string example: HWB-2025128-0002 contents: type: string example: 'Computer - Desktop' declared_value: type: string example: '2500000.00' weight: type: string example: '5.00' length: type: string example: '4.00' width: type: string example: '6.00' height: type: string example: '2.00' is_fragile: type: boolean example: true is_hazardous: type: boolean example: false is_damaged: type: boolean example: false package_photos: type: array example: - package_photos/LXHHmhE4YM0YoTn1Lva95FSyQi31i89dskkPv2il.jpg - package_photos/thtdPXJtqtkpECHhbeyXIOAIMSGt564ZFIXBqdcp.jpg - package_photos/Uc34hnpyAPsAT1QINJfca0msaFdudcYfaY2Qs21h.jpg items: type: string location_id: type: integer example: 1 received_at: type: string example: '2025-12-03T00:00:00.000000Z' user: type: object properties: id: type: integer example: 1 full_name: type: string example: 'Thembo Charles' email: type: string example: ashley7520charles@gmail.com phone: type: string example: '0787444081' email_verified_at: type: string example: null tin: type: string example: '110023452' passport: type: string example: '65748' address: type: string example: Kampala otp: type: string example: '4782' status: type: string example: active user_type: type: string example: user created_at: type: string example: '2025-12-05T06:42:09.000000Z' updated_at: type: string example: '2025-12-05T07:58:28.000000Z' deleted_at: type: string example: null tags: - 'Shipment Delivery' put: summary: 'Update Shipment Delivery' operationId: updateShipmentDelivery description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: message: 'Shipment Delivery updated successfully' data: order_id: '5' delivery_address: Kasese delivery_date: '2025-12-10' delivery_number: DEL-000001 updated_at: '2025-12-09T07:41:36.000000Z' created_at: '2025-12-09T07:41:36.000000Z' id: 4 order: id: 5 created_at: '2025-12-05T12:20:11.000000Z' updated_at: '2025-12-05T12:20:11.000000Z' deleted_at: null tracking_number: ORD-20251205-00002 user_id: 1 origin_country: ITALY receiver_name: 'Tom Mboya' receiver_phone: '0789887766' receiver_email: tom.mboya@gmail.com receiver_address: 'Uganda - Kampala' status: PENDING received_at: null dispatched_at: null arrived_at: null released_at: null delivered_at: null packages: - id: 1 created_at: '2025-12-08T07:19:43.000000Z' updated_at: '2025-12-08T07:42:06.000000Z' deleted_at: null order_id: 5 hwb_number: HWB-2025128-0002 contents: 'Computer - Desktop' declared_value: '2500000.00' weight: '5.00' length: '4.00' width: '6.00' height: '2.00' is_fragile: true is_hazardous: false is_damaged: false package_photos: - package_photos/LXHHmhE4YM0YoTn1Lva95FSyQi31i89dskkPv2il.jpg - package_photos/thtdPXJtqtkpECHhbeyXIOAIMSGt564ZFIXBqdcp.jpg - package_photos/Uc34hnpyAPsAT1QINJfca0msaFdudcYfaY2Qs21h.jpg location_id: 1 received_at: '2025-12-03T00:00:00.000000Z' - id: 2 created_at: '2025-12-08T07:32:17.000000Z' updated_at: '2025-12-08T07:32:17.000000Z' deleted_at: null order_id: 5 hwb_number: HWB-2025128-0021 contents: 'Computer - Desktop' declared_value: '2500000.00' weight: '5.00' length: '4.00' width: '6.00' height: '2.00' is_fragile: true is_hazardous: false is_damaged: false package_photos: null location_id: 1 received_at: '2025-12-03T00:00:00.000000Z' properties: message: type: string example: 'Shipment Delivery updated successfully' data: type: object properties: order_id: type: string example: '5' delivery_address: type: string example: Kasese delivery_date: type: string example: '2025-12-10' delivery_number: type: string example: DEL-000001 updated_at: type: string example: '2025-12-09T07:41:36.000000Z' created_at: type: string example: '2025-12-09T07:41:36.000000Z' id: type: integer example: 4 order: type: object properties: id: type: integer example: 5 created_at: type: string example: '2025-12-05T12:20:11.000000Z' updated_at: type: string example: '2025-12-05T12:20:11.000000Z' deleted_at: type: string example: null tracking_number: type: string example: ORD-20251205-00002 user_id: type: integer example: 1 origin_country: type: string example: ITALY receiver_name: type: string example: 'Tom Mboya' receiver_phone: type: string example: '0789887766' receiver_email: type: string example: tom.mboya@gmail.com receiver_address: type: string example: 'Uganda - Kampala' status: type: string example: PENDING received_at: type: string example: null dispatched_at: type: string example: null arrived_at: type: string example: null released_at: type: string example: null delivered_at: type: string example: null packages: type: array example: - id: 1 created_at: '2025-12-08T07:19:43.000000Z' updated_at: '2025-12-08T07:42:06.000000Z' deleted_at: null order_id: 5 hwb_number: HWB-2025128-0002 contents: 'Computer - Desktop' declared_value: '2500000.00' weight: '5.00' length: '4.00' width: '6.00' height: '2.00' is_fragile: true is_hazardous: false is_damaged: false package_photos: - package_photos/LXHHmhE4YM0YoTn1Lva95FSyQi31i89dskkPv2il.jpg - package_photos/thtdPXJtqtkpECHhbeyXIOAIMSGt564ZFIXBqdcp.jpg - package_photos/Uc34hnpyAPsAT1QINJfca0msaFdudcYfaY2Qs21h.jpg location_id: 1 received_at: '2025-12-03T00:00:00.000000Z' - id: 2 created_at: '2025-12-08T07:32:17.000000Z' updated_at: '2025-12-08T07:32:17.000000Z' deleted_at: null order_id: 5 hwb_number: HWB-2025128-0021 contents: 'Computer - Desktop' declared_value: '2500000.00' weight: '5.00' length: '4.00' width: '6.00' height: '2.00' is_fragile: true is_hazardous: false is_damaged: false package_photos: null location_id: 1 received_at: '2025-12-03T00:00:00.000000Z' items: type: object properties: id: type: integer example: 1 created_at: type: string example: '2025-12-08T07:19:43.000000Z' updated_at: type: string example: '2025-12-08T07:42:06.000000Z' deleted_at: type: string example: null order_id: type: integer example: 5 hwb_number: type: string example: HWB-2025128-0002 contents: type: string example: 'Computer - Desktop' declared_value: type: string example: '2500000.00' weight: type: string example: '5.00' length: type: string example: '4.00' width: type: string example: '6.00' height: type: string example: '2.00' is_fragile: type: boolean example: true is_hazardous: type: boolean example: false is_damaged: type: boolean example: false package_photos: type: array example: - package_photos/LXHHmhE4YM0YoTn1Lva95FSyQi31i89dskkPv2il.jpg - package_photos/thtdPXJtqtkpECHhbeyXIOAIMSGt564ZFIXBqdcp.jpg - package_photos/Uc34hnpyAPsAT1QINJfca0msaFdudcYfaY2Qs21h.jpg items: type: string location_id: type: integer example: 1 received_at: type: string example: '2025-12-03T00:00:00.000000Z' tags: - 'Shipment Delivery' requestBody: required: true content: application/json: schema: type: object properties: rider_id: type: string description: 'Request parameter: rider_id. The id of an existing record in the user table.' example: 'Any string' nullable: true delivery_address: type: string description: '' example: consequatur delivery_date: type: date description: '' example: consequatur pod_signature: type: string description: 'Request parameter: pod_signature.' example: 'Any string' nullable: true pod_photo_path: type: string description: 'Request parameter: pod_photo_path.' example: 'Any string' nullable: true delivery_notes: type: string description: '' example: consequatur nullable: true delivered_at: type: string description: 'Request parameter: delivered_at. Must be a valid date.' example: 'Any string' nullable: true required: - delivery_address - delivery_date delete: summary: 'Delete Shipment Delivery' operationId: deleteShipmentDelivery description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: text/plain: schema: type: string example: "{\n \"status\": \"success\",\n \"message\": \"Shipment Delivery deleted successfully\",\n }" tags: - 'Shipment Delivery' parameters: - in: path name: id description: 'The ID of the order.' example: 1 required: true schema: type: integer '/api/delivery/orders/{delivery_order}/upload-pod': post: summary: 'Upload a point of Shipment Delivery photo' operationId: uploadAPointOfShipmentDeliveryPhoto description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: message: 'Point Of Delivery photo uploaded successfully' photo_url: pod_photos/2akLAes8oj4j5OIxC71O5GxwEN8fSJ1jxtotKyxk.jpg properties: message: type: string example: 'Point Of Delivery photo uploaded successfully' photo_url: type: string example: pod_photos/2akLAes8oj4j5OIxC71O5GxwEN8fSJ1jxtotKyxk.jpg tags: - 'Shipment Delivery' requestBody: required: true content: multipart/form-data: schema: type: object properties: pod_photo: type: string format: binary description: '' required: - pod_photo parameters: - in: path name: delivery_order description: '' example: 1 required: true schema: type: integer - in: path name: delivery_order_id description: '' example: 17 required: true schema: type: integer '/api/delivery/orders/{delivery_order}/upload-signature': post: summary: 'Upload Customer Delivery Signature' operationId: uploadCustomerDeliverySignature description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: text/plain: schema: type: string example: "{\n \"message\": \"Signature saved successfully\",\n }" tags: - 'Shipment Delivery' requestBody: required: true content: application/json: schema: type: object properties: signature: type: string description: '' example: consequatur required: - signature parameters: - in: path name: delivery_order description: '' example: 1 required: true schema: type: integer - in: path name: delivery_order_id description: '' example: 17 required: true schema: type: integer '/api/delivery/update-orders-status/{delivery_order}': post: summary: 'Update Shipment Delivery status' operationId: updateShipmentDeliveryStatus description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: text/plain: schema: type: string example: "{\n \"message\": \"Rider assigned successfully\",\n }" tags: - 'Shipment Delivery' requestBody: required: true content: application/json: schema: type: object properties: status: type: string description: '' example: 'PENDING,ASSIGNED,OUT_FOR_DELIVERY,DELIVERED,FAILED' rider_id: type: integer description: '' example: 17 reason: type: string description: '' example: consequatur required: - status parameters: - in: path name: delivery_order description: '' example: consequatur required: true schema: type: string - in: path name: delivery_order_id description: '' example: 17 required: true schema: type: integer /api/delivery/dashboard: get: summary: Dashboard operationId: dashboard description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: total: 1 pending: 1 assigned: 0 out: 0 delivered: 0 failed: 0 today_deliveries: [] properties: total: type: integer example: 1 pending: type: integer example: 1 assigned: type: integer example: 0 out: type: integer example: 0 delivered: type: integer example: 0 failed: type: integer example: 0 today_deliveries: type: array example: [] tags: - 'Shipment Delivery' /api/delivery/riders: get: summary: Riders operationId: riders description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: message: Riders data: - id: 1 full_name: 'Thembo Charles' phone: '0787444081' email: ashley7520charles@gmail.com properties: message: type: string example: Riders data: type: array example: - id: 1 full_name: 'Thembo Charles' phone: '0787444081' email: ashley7520charles@gmail.com items: type: object properties: id: type: integer example: 1 full_name: type: string example: 'Thembo Charles' phone: type: string example: '0787444081' email: type: string example: ashley7520charles@gmail.com tags: - 'Shipment Delivery' /api/assisted_shopping: get: summary: 'Assisted shopping lists' operationId: assistedShoppingLists description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/assisted_shopping could not be found.' properties: message: type: string example: 'The route api/assisted_shopping could not be found.' tags: - AssistedShopping post: summary: 'Add Assisted shopping' operationId: addAssistedShopping description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - AssistedShopping requestBody: required: false content: application/json: schema: type: object properties: insured: type: boolean description: '' example: false shipping_mode: type: string description: "e.g: 'express','standard'" example: consequatur remarks: type: string description: '' example: consequatur nullable: true '/api/assisted_shopping/{id}': get: summary: 'Assisted shopping' operationId: assistedShopping description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/assisted_shopping/17 could not be found.' properties: message: type: string example: 'The route api/assisted_shopping/17 could not be found.' tags: - AssistedShopping put: summary: 'Updated Assisted shopping' operationId: updatedAssistedShopping description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - AssistedShopping requestBody: required: false content: application/json: schema: type: object properties: insured: type: boolean description: 'Request parameter: insured.' example: false shipping_mode: type: string description: "e.g: 'express','standard'" example: consequatur remarks: type: string description: 'Request parameter: remarks.' example: 'Any string' string: type: remarks description: optional example: consequatur delete: summary: 'Delete Assisted shopping' operationId: deleteAssistedShopping description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: text/plain: schema: type: string example: "{\n \"message\": \"Assisted Shopping item deleted to successfully\",\n }" tags: - AssistedShopping parameters: - in: path name: id description: 'The ID of the assisted shopping.' example: 17 required: true schema: type: integer - in: path name: assistedShopping_id description: '' example: 17 required: true schema: type: integer /api/assisted_shopping_items: post: summary: 'Add Item to Assisted shopping' operationId: addItemToAssistedShopping description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - AssistedShopping requestBody: required: true content: application/json: schema: type: object properties: assisted_shopping_id: type: integer description: '' example: 17 item_name: type: string description: '' example: consequatur quantity: type: integer description: '' example: 17 unit_price: type: number description: '' example: 11613.31890586 nullable: true url: type: string description: '' example: 'http://kunze.biz/iste-laborum-eius-est-dolor.html' nullable: true vendor: type: string description: '' example: consequatur nullable: true required: - assisted_shopping_id - item_name - quantity - unit_price - url '/api/assisted_shopping_items/{id}': put: summary: 'Update Item on Assisted shopping' operationId: updateItemOnAssistedShopping description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - AssistedShopping requestBody: required: true content: application/json: schema: type: object properties: item_name: type: string description: '' example: consequatur quantity: type: integer description: '' example: 17 unit_price: type: number description: '' example: 11613.31890586 url: type: string description: '' example: 'http://kunze.biz/iste-laborum-eius-est-dolor.html' vendor: type: string description: '' example: consequatur vendor_order_number: type: string description: '' example: consequatur required: - item_name - quantity - unit_price - url parameters: - in: path name: id description: 'The ID of the assisted shopping item.' example: consequatur required: true schema: type: string - in: path name: assisted_shoppingitem_id description: '' example: 17 required: true schema: type: integer '/api/assisted_shopping_items/vendor_order/{vendor_order_number}': get: summary: 'Find Assisted shopping items by Vendor Order Number' operationId: findAssistedShoppingItemsByVendorOrderNumber description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/assisted_shopping_items/vendor_order/consequatur could not be found.' properties: message: type: string example: 'The route api/assisted_shopping_items/vendor_order/consequatur could not be found.' tags: - AssistedShopping parameters: - in: path name: vendor_order_number description: 'The vendor order number to search for.' example: consequatur required: true schema: type: string '/api/send-notification/{assisted_shopping_id}': get: summary: 'Send Assisted shopping Notification' operationId: sendAssistedShoppingNotification description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/send-notification/17 could not be found.' properties: message: type: string example: 'The route api/send-notification/17 could not be found.' tags: - AssistedShopping parameters: - in: path name: assisted_shopping_id description: '' example: 17 required: true schema: type: integer /api/assisted_shopping_quote: post: summary: 'Add Assistedshopping Quote Item' operationId: addAssistedshoppingQuoteItem description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - AssistedShopping requestBody: required: true content: application/json: schema: type: object properties: item_name: type: string description: '' example: consequatur quantity: type: integer description: '' example: 17 unit_price: type: number description: '' example: 11613.31890586 currency: type: string description: '' example: consequatur assisted_shopping_id: type: integer description: '' example: 17 required: - item_name - quantity - unit_price - assisted_shopping_id get: summary: 'Display a listing of the resource.' operationId: displayAListingOfTheResource description: '' parameters: [] responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/assisted_shopping_quote could not be found.' properties: message: type: string example: 'The route api/assisted_shopping_quote could not be found.' tags: - Others security: [] '/api/assisted_shopping_quote/{id}': put: summary: 'Update Assisted shopping Quote' operationId: updateAssistedShoppingQuote description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - AssistedShopping requestBody: required: false content: application/json: schema: type: object properties: item_name: type: string description: '' example: consequatur quantity: type: integer description: '' example: 17 unit_price: type: number description: '' example: 11613.31890586 currency: type: string description: '' example: consequatur assisted_shopping_id: type: integer description: '' example: 17 delete: summary: 'Delete Assisted shopping Quote item' operationId: deleteAssistedShoppingQuoteItem description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - AssistedShopping get: summary: 'Display the specified resource.' operationId: displayTheSpecifiedResource description: '' parameters: [] responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/assisted_shopping_quote/17 could not be found.' properties: message: type: string example: 'The route api/assisted_shopping_quote/17 could not be found.' tags: - Others security: [] parameters: - in: path name: id description: 'The ID of the assisted shopping quote.' example: 17 required: true schema: type: integer - in: path name: assistedShoppingQuote_id description: '' example: 17 required: true schema: type: integer /api/send_quotation: post: summary: 'Send Assisted shopping Quote' operationId: sendAssistedShoppingQuote description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - AssistedShopping requestBody: required: true content: application/json: schema: type: object properties: assisted_shopping_id: type: integer description: '' example: 17 required: - assisted_shopping_id /api/approve_assistedshopping_quotation: post: summary: 'Approve Assisted shopping Quote' operationId: approveAssistedShoppingQuote description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - AssistedShopping requestBody: required: true content: application/json: schema: type: object properties: assisted_shopping_id: type: integer description: '' example: 17 required: - assisted_shopping_id /api/receive_assisted_shopping_item: post: summary: 'Receive Item on Assisted shopping' operationId: receiveItemOnAssistedShopping description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - AssistedShopping requestBody: required: true content: application/json: schema: type: object properties: assisted_shopping_id: type: integer description: '' example: 17 vendor_order_number: type: string description: 'Read this from the BarCode input, vendor_order_number is input from barcode' example: consequatur required: - assisted_shopping_id /api/order_status_hisory: post: summary: 'Update Order status' operationId: updateOrderStatus description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: text/plain: schema: type: string example: "{\n \"status\": \"success\",\n \"message\": \"Order history created successfully.\",\n }" tags: - Order requestBody: required: true content: application/json: schema: type: object properties: order_id: type: integer description: '' example: 17 status: type: string description: 'e.g PENDING, RECEIVED,PREPARING_TO_DISPATCH,DISPATCHED,DELAYED,ARRIVED,READY_FOR_COLLECTION,COLLECTED' example: consequatur location: type: string description: '' example: consequatur notes: type: string description: '' example: consequatur user_id: type: integer description: 'Request parameter: user_id.' example: 1000 required: - order_id - status - notes '/api/order_status_hisory/{id}': delete: summary: 'Delete Order status history' operationId: deleteOrderStatusHistory description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: text/plain: schema: type: string example: "{\n \"status\": \"success\",\n \"message\": \"Order status history deleted.\",\n }\n }" tags: - Order parameters: - in: path name: id description: 'The ID of the order status hisory.' example: 1 required: true schema: type: integer - in: path name: orderStatusHistory_id description: '' example: 17 required: true schema: type: integer /api/cargo_decleration: get: summary: "Order\nThis is a delivery request" operationId: orderThisIsADeliveryRequest description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: message: Order data: - id: 1 created_at: '2025-12-30T08:08:52.000000Z' updated_at: '2025-12-30T08:29:31.000000Z' deleted_at: null warehouse_location_id: 1 internal_curier: DHL tracking_number: DHL-009874 cargo_details: Laptops value: '34000' weight: '50' status: pending files: - package_photos/mCJHMcA4IyQl1Ws54K3OllAgVNWm1pYB3gNCKrY0.pdf - package_photos/p9FvfMIqBxNwePlG4RsR2DN6IoBZOaUGOtv29cAJ.pdf user_id: 1 user: id: 1 full_name: 'Samson Tusiime' email: tusiimesam@gmail.com phone: '+256775926572' tin: null passport: null address: Kampala status: active user_type: super_user created_at: '2025-12-22T07:51:55.000000Z' updated_at: '2025-12-22T07:51:55.000000Z' deleted_at: null delivery_address: null location: id: 1 created_at: '2025-12-22T13:00:03.000000Z' updated_at: '2025-12-22T13:03:02.000000Z' deleted_at: null code: ZM name: Zamaleto address: Kampala manager: Charles active: 1 rack_count: '4' country: Uganda properties: message: type: string example: Order data: type: array example: - id: 1 created_at: '2025-12-30T08:08:52.000000Z' updated_at: '2025-12-30T08:29:31.000000Z' deleted_at: null warehouse_location_id: 1 internal_curier: DHL tracking_number: DHL-009874 cargo_details: Laptops value: '34000' weight: '50' status: pending files: - package_photos/mCJHMcA4IyQl1Ws54K3OllAgVNWm1pYB3gNCKrY0.pdf - package_photos/p9FvfMIqBxNwePlG4RsR2DN6IoBZOaUGOtv29cAJ.pdf user_id: 1 user: id: 1 full_name: 'Samson Tusiime' email: tusiimesam@gmail.com phone: '+256775926572' tin: null passport: null address: Kampala status: active user_type: super_user created_at: '2025-12-22T07:51:55.000000Z' updated_at: '2025-12-22T07:51:55.000000Z' deleted_at: null delivery_address: null location: id: 1 created_at: '2025-12-22T13:00:03.000000Z' updated_at: '2025-12-22T13:03:02.000000Z' deleted_at: null code: ZM name: Zamaleto address: Kampala manager: Charles active: 1 rack_count: '4' country: Uganda items: type: object properties: id: type: integer example: 1 created_at: type: string example: '2025-12-30T08:08:52.000000Z' updated_at: type: string example: '2025-12-30T08:29:31.000000Z' deleted_at: type: string example: null warehouse_location_id: type: integer example: 1 internal_curier: type: string example: DHL tracking_number: type: string example: DHL-009874 cargo_details: type: string example: Laptops value: type: string example: '34000' weight: type: string example: '50' status: type: string example: pending files: type: array example: - package_photos/mCJHMcA4IyQl1Ws54K3OllAgVNWm1pYB3gNCKrY0.pdf - package_photos/p9FvfMIqBxNwePlG4RsR2DN6IoBZOaUGOtv29cAJ.pdf items: type: string user_id: type: integer example: 1 user: type: object properties: id: type: integer example: 1 full_name: type: string example: 'Samson Tusiime' email: type: string example: tusiimesam@gmail.com phone: type: string example: '+256775926572' tin: type: string example: null passport: type: string example: null address: type: string example: Kampala status: type: string example: active user_type: type: string example: super_user created_at: type: string example: '2025-12-22T07:51:55.000000Z' updated_at: type: string example: '2025-12-22T07:51:55.000000Z' deleted_at: type: string example: null delivery_address: type: string example: null location: type: object properties: id: type: integer example: 1 created_at: type: string example: '2025-12-22T13:00:03.000000Z' updated_at: type: string example: '2025-12-22T13:03:02.000000Z' deleted_at: type: string example: null code: type: string example: ZM name: type: string example: Zamaleto address: type: string example: Kampala manager: type: string example: Charles active: type: integer example: 1 rack_count: type: string example: '4' country: type: string example: Uganda tags: - Order post: summary: "Store Order\nThis is a delivery request" operationId: storeOrderThisIsADeliveryRequest description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - Order requestBody: required: true content: application/json: schema: type: object properties: warehouse_location_id: type: integer description: '' example: 17 internal_curier: type: string description: optional example: consequatur nullable: true tracking_number: type: string description: optional example: consequatur nullable: true insured: type: boolean description: '' example: false shipping_mode: type: string description: "sometimes e.g:express,standard'" example: consequatur cargo_details: type: array description: 'List of cargo items' example: - consequatur items: type: string required: - warehouse_location_id - cargo_details '/api/cargo_decleration/{id}': get: summary: "Order\nThis is a delivery request" operationId: orderThisIsADeliveryRequest description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/cargo_decleration/consequatur could not be found.' properties: message: type: string example: 'The route api/cargo_decleration/consequatur could not be found.' tags: - Order put: summary: "Update Order\nThis is a delivery request" operationId: updateOrderThisIsADeliveryRequest description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - Order requestBody: required: true content: application/json: schema: type: object properties: internal_curier: type: string description: optional example: consequatur tracking_number: type: string description: optional example: consequatur cargo_details: type: string description: '' example: consequatur value: type: string description: '' example: consequatur weight: type: string description: '' example: consequatur status: type: string description: '' example: 'pending,received,declined' insured: type: boolean description: '' example: false shipping_mode: type: string description: '' example: consequatur required: - cargo_details - value delete: summary: "Delete Order\nThis is a delivery request" operationId: deleteOrderThisIsADeliveryRequest description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - Order parameters: - in: path name: id description: 'The ID of the cargo decleration.' example: consequatur required: true schema: type: string - in: path name: cargoDeclation_id description: '' example: 17 required: true schema: type: integer '/api/cargo_files/{cargo_decleration_id}': post: summary: "Uplaod Order files\nThis is a delivery request" operationId: uplaodOrderFilesThisIsADeliveryRequest description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - Order requestBody: required: false content: application/json: schema: type: object properties: files: type: array description: '' example: - consequatur items: type: string delete: summary: "Delete Order file\nThis is a delivery request" operationId: deleteOrderFileThisIsADeliveryRequest description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - Order requestBody: required: true content: application/json: schema: type: object properties: file_name: type: string description: '' example: consequatur required: - file_name parameters: - in: path name: cargo_decleration_id description: 'The ID of the cargo decleration.' example: consequatur required: true schema: type: string - in: path name: cargoDeclation_id description: '' example: 17 required: true schema: type: integer /api/expenditures/category: get: summary: 'Categories list' operationId: categoriesList description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/expenditures/category could not be found.' properties: message: type: string example: 'The route api/expenditures/category could not be found.' tags: - Expenditures post: summary: 'Create Categories' operationId: createCategories description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - Expenditures requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: '' example: consequatur description: type: string description: '' example: 'Dolores dolorum amet iste laborum eius est dolor.' nullable: true required: - name '/api/expenditures/category/{id}': put: summary: 'Update Category' operationId: updateCategory description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - Expenditures requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: '' example: consequatur description: type: string description: '' example: 'Dolores dolorum amet iste laborum eius est dolor.' nullable: true required: - name delete: summary: 'Delete Category' operationId: deleteCategory description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - Expenditures parameters: - in: path name: id description: 'The ID of the category.' example: 17 required: true schema: type: integer - in: path name: category description: '' example: 17 required: true schema: type: integer /api/expenditures/expenses: get: summary: 'List Expenses' operationId: listExpenses description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/expenditures/expenses could not be found.' properties: message: type: string example: 'The route api/expenditures/expenses could not be found.' tags: - Expenditures requestBody: required: false content: application/json: schema: type: object properties: from: type: date description: '' example: consequatur to: type: date description: '' example: consequatur category_id: type: integer description: '' example: 17 post: summary: 'Record Expenses' operationId: recordExpenses description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - Expenditures requestBody: required: true content: application/json: schema: type: object properties: date: type: date description: '' example: consequatur expense_category_id: type: integer description: '' example: 17 particular: type: string description: '' example: consequatur quantity: type: integer description: '' example: 17 unit_price: type: integer description: '' example: 17 required: - date - expense_category_id - particular - quantity - unit_price '/api/expenditures/expenses/{id}': put: summary: 'Update Expenses' operationId: updateExpenses description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - Expenditures requestBody: required: true content: application/json: schema: type: object properties: date: type: date description: '' example: consequatur expense_category_id: type: integer description: '' example: 17 particular: type: string description: '' example: consequatur quantity: type: integer description: '' example: 17 unit_price: type: integer description: '' example: 17 required: - expense_category_id delete: summary: 'Delete Expenses' operationId: deleteExpenses description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - Expenditures parameters: - in: path name: id description: 'The ID of the expense.' example: 17 required: true schema: type: integer - in: path name: expense_id description: 'Optional parameter.' required: true schema: type: integer examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: 17 /api/documents: get: summary: 'Policy documents' operationId: policyDocuments description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/documents could not be found.' properties: message: type: string example: 'The route api/documents could not be found.' tags: - 'Policy documents' post: summary: 'Uplaod Policy documents' operationId: uplaodPolicyDocuments description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - 'Policy documents' requestBody: required: true content: multipart/form-data: schema: type: object properties: name: type: string description: '' example: consequatur file_url: type: string format: binary description: 'mimes:jpg,jpeg,png,webp,pdf' description: type: string description: '' example: 'Dolores dolorum amet iste laborum eius est dolor.' required: - name '/api/documents/{id}': get: summary: 'Policy document' operationId: policyDocument description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/documents/17 could not be found.' properties: message: type: string example: 'The route api/documents/17 could not be found.' tags: - 'Policy documents' put: summary: 'Updated Policy document' operationId: updatedPolicyDocument description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - 'Policy documents' requestBody: required: true content: multipart/form-data: schema: type: object properties: name: type: string description: '' example: consequatur file_url: type: string format: binary description: 'mimes:jpg,jpeg,png,webp,pdf' description: type: string description: '' example: 'Dolores dolorum amet iste laborum eius est dolor.' required: - name delete: summary: 'Delete Policy document' operationId: deletePolicyDocument description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - 'Policy documents' parameters: - in: path name: id description: '' example: 17 required: true schema: type: integer /api/settings/notifications: get: summary: Notifications operationId: notifications description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/settings/notifications could not be found.' properties: message: type: string example: 'The route api/settings/notifications could not be found.' tags: - Notifications '/api/settings/notification/{user_message_id}': patch: summary: 'Update Notification status' operationId: updateNotificationStatus description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: { } tags: - Notifications requestBody: required: true content: application/json: schema: type: object properties: notification_status: type: string description: '' example: "'read','not_read'" required: - notification_status parameters: - in: path name: user_message_id description: '' example: 17 required: true schema: type: integer /api/auth/get_client_byCode: post: summary: '' operationId: postApiAuthGet_client_byCode description: '' parameters: [] responses: { } tags: - Others requestBody: required: true content: application/json: schema: type: object properties: client_code: type: string description: 'The client_code of an existing record in the users table.' example: consequatur required: - client_code security: [] /api/activity_logs: get: summary: '' operationId: getApiActivity_logs description: '' parameters: [] responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/activity_logs could not be found.' properties: message: type: string example: 'The route api/activity_logs could not be found.' tags: - Others security: [] /api/shipping_address/create: get: summary: '' operationId: getApiShipping_addressCreate description: '' parameters: [] responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/shipping_address/create could not be found.' properties: message: type: string example: 'The route api/shipping_address/create could not be found.' tags: - Others security: [] '/api/shipping_address/{id}': get: summary: '' operationId: getApiShipping_addressId description: '' parameters: [] responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/shipping_address/17 could not be found.' properties: message: type: string example: 'The route api/shipping_address/17 could not be found.' tags: - Others security: [] put: summary: 'Update Shipping address' operationId: updateShippingAddress description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: message: 'Shipping Address updated successfully' data: name: 'USA - AIR' address_line1: '4720 Boston Way' address_line2: 'Suite C Shypt' city: Lanham state: MD zip: '20706' phone_number: '+1 301 317 0512' updated_at: '2026-01-23T08:01:06.000000Z' created_at: '2026-01-23T08:01:06.000000Z' id: 1 properties: message: type: string example: 'Shipping Address updated successfully' data: type: object properties: name: type: string example: 'USA - AIR' address_line1: type: string example: '4720 Boston Way' address_line2: type: string example: 'Suite C Shypt' city: type: string example: Lanham state: type: string example: MD zip: type: string example: '20706' phone_number: type: string example: '+1 301 317 0512' updated_at: type: string example: '2026-01-23T08:01:06.000000Z' created_at: type: string example: '2026-01-23T08:01:06.000000Z' id: type: integer example: 1 tags: - 'Shipping address' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: '' example: consequatur address_line1: type: string description: '' example: consequatur address_line2: type: string description: '' example: consequatur city: type: string description: '' example: consequatur state: type: string description: '' example: consequatur zip: type: string description: '' example: consequatur phone_number: type: string description: '' example: consequatur required: - name delete: summary: 'Delete Shipping address' operationId: deleteShippingAddress description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: text/plain: schema: type: string example: "{\n \"message\": \"Shipping Address deleted successfully\", *\n }" tags: - 'Shipping address' parameters: - in: path name: id description: 'The ID of the shipping address.' example: 17 required: true schema: type: integer '/api/shipping_address/{shipping_address_id}/edit': get: summary: '' operationId: getApiShipping_addressShipping_address_idEdit description: '' parameters: [] responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/shipping_address/17/edit could not be found.' properties: message: type: string example: 'The route api/shipping_address/17/edit could not be found.' tags: - Others security: [] parameters: - in: path name: shipping_address_id description: 'The ID of the shipping address.' example: 17 required: true schema: type: integer /api/pesal_pal: get: summary: '' operationId: getApiPesal_pal description: '' parameters: [] responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/pesal_pal could not be found.' properties: message: type: string example: 'The route api/pesal_pal could not be found.' tags: - Others security: [] /api/ipn_url: get: summary: '' operationId: getApiIpn_url description: '' parameters: [] responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/ipn_url could not be found.' properties: message: type: string example: 'The route api/ipn_url could not be found.' tags: - Others security: [] /api/call_back_url: get: summary: '' operationId: getApiCall_back_url description: '' parameters: [] responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/call_back_url could not be found.' properties: message: type: string example: 'The route api/call_back_url could not be found.' tags: - Others security: [] /api/manifests: get: summary: 'Display a listing Manifests' operationId: displayAListingManifests description: '' parameters: - in: header name: bearer description: '' example: Token schema: type: string responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/manifests could not be found.' properties: message: type: string example: 'The route api/manifests could not be found.' tags: - Manifests post: summary: 'Store a newly created Manifest.' operationId: storeANewlyCreatedManifest description: '' parameters: - in: header name: bearer description: '' example: Token schema: type: string responses: { } tags: - Manifests requestBody: required: true content: application/json: schema: type: object properties: warehouse_location_id: type: string description: 'The id of an existing record in the warehouse_locations table.' example: consequatur destination_location_id: type: string description: 'The id of an existing record in the warehouse_locations table.' example: consequatur title: type: string description: '' example: consequatur nullable: true transport_mode: type: string description: '' example: ROAD enum: - AIR - SEA - TRAIN - ROAD required: - warehouse_location_id - destination_location_id - transport_mode '/api/manifests/{id}': put: summary: 'Update the specified Manifest' operationId: updateTheSpecifiedManifest description: '' parameters: - in: header name: bearer description: '' example: Token schema: type: string responses: { } tags: - Manifests requestBody: required: true content: application/json: schema: type: object properties: title: type: string description: '' example: consequatur nullable: true transport_mode: type: string description: '' example: ROAD enum: - AIR - SEA - TRAIN - ROAD required: - transport_mode delete: summary: 'Remove the specified Manifest.' operationId: removeTheSpecifiedManifest description: '' parameters: - in: header name: bearer description: '' example: Token schema: type: string responses: { } tags: - Manifests parameters: - in: path name: id description: 'The ID of the manifest.' example: 3 required: true schema: type: integer /api/manifest_by_barcode: post: summary: 'Display the specified resource.' operationId: displayTheSpecifiedResource description: '' parameters: - in: header name: bearer description: '' example: Token schema: type: string responses: { } tags: - Manifests requestBody: required: true content: application/json: schema: type: object properties: manifest_code: type: string description: 'Scan the Barcode Manifest Box - Pallet' example: consequatur required: - manifest_code /api/reset_consolidation_manifest: post: summary: 'Reset all manifest consoldations to DISPATCHED' operationId: resetAllManifestConsoldationsToDISPATCHED description: '' parameters: - in: header name: bearer description: '' example: Token schema: type: string responses: { } tags: - Manifests requestBody: required: true content: application/json: schema: type: object properties: manifest_code: type: string description: 'The manifest_code of an existing record in the manifests table.' example: consequatur required: - manifest_code /api/manifest_consolidations: post: summary: 'Store a newly created Consolidation in a Manifest' operationId: storeANewlyCreatedConsolidationInAManifest description: '' parameters: - in: header name: bearer description: '' example: Token schema: type: string responses: { } tags: - Manifests requestBody: required: true content: application/json: schema: type: object properties: manifest_id: type: string description: 'The id of an existing record in the manifests table.' example: consequatur consolidation_code: type: string description: 'The consolidation_code of an existing record in the consolidations table.' example: consequatur notes: type: string description: 'consolidation_code is the barcode.' example: consequatur nullable: true required: - manifest_id - consolidation_code '/api/manifest_consolidations/{id}': put: summary: 'Update the specified Consolidation in a Manifest' operationId: updateTheSpecifiedConsolidationInAManifest description: "Scan packages as delayed, dispatched or Verified\n\nNB: The status does not have to apear on the user form" parameters: - in: header name: bearer description: '' example: Token schema: type: string responses: { } tags: - Manifests requestBody: required: true content: application/json: schema: type: object properties: consolidation_code: type: string description: 'The consolidation_code of an existing record in the consolidations table.' example: consequatur notes: type: string description: '' example: consequatur nullable: true status: type: string description: '' example: DISPATCHED enum: - DISPATCHED - DELAYED - VERIFIED required: - consolidation_code - status delete: summary: 'Remove the specified Consolidation from Manifest' operationId: removeTheSpecifiedConsolidationFromManifest description: '' parameters: - in: header name: bearer description: '' example: Token schema: type: string responses: { } tags: - Manifests parameters: - in: path name: id description: 'The ID of the manifest consolidation.' example: consequatur required: true schema: type: string /api/billing/pricings: get: summary: 'Display a listing of prices.' operationId: displayAListingOfPrices description: '' parameters: - in: header name: bearer description: '' example: Token schema: type: string responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/billing/pricings could not be found.' properties: message: type: string example: 'The route api/billing/pricings could not be found.' tags: - Pricing post: summary: 'Store a newly created price' operationId: storeANewlyCreatedPrice description: '' parameters: - in: header name: bearer description: '' example: Token schema: type: string responses: { } tags: - Pricing requestBody: required: true content: application/json: schema: type: object properties: transport_mode: type: string description: '' example: TRAIN enum: - AIR - SEA - ROAD - TRAIN warehouse_location_id: type: string description: 'The id of an existing record in the warehouse_locations table.' example: consequatur destination_location_id: type: string description: 'The value and warehouse_location_id must be different. The id of an existing record in the warehouse_locations table.' example: consequatur weight_price: type: number description: 'This field is required when none of volumetric_price and percel_price are present.' example: 11613.31890586 nullable: true volumetric_price: type: number description: 'This field is required when none of weight_price and percel_price are present.' example: 11613.31890586 nullable: true percel_price: type: number description: 'This field is required when none of weight_price and volumetric_price are present.' example: 11613.31890586 nullable: true required: - transport_mode - warehouse_location_id - destination_location_id '/api/billing/pricings/{id}': put: summary: 'Update the specified price' operationId: updateTheSpecifiedPrice description: '' parameters: - in: header name: bearer description: '' example: Token schema: type: string responses: { } tags: - Pricing requestBody: required: true content: application/json: schema: type: object properties: transport_mode: type: string description: '' example: AIR enum: - AIR - SEA - ROAD - TRAIN warehouse_location_id: type: string description: 'The id of an existing record in the warehouse_locations table.' example: consequatur destination_location_id: type: string description: 'The value and warehouse_location_id must be different. The id of an existing record in the warehouse_locations table.' example: consequatur weight_price: type: number description: 'This field is required when none of volumetric_price and percel_price are present.' example: 11613.31890586 nullable: true volumetric_price: type: number description: 'This field is required when none of weight_price and percel_price are present.' example: 11613.31890586 nullable: true percel_price: type: number description: 'This field is required when none of weight_price and volumetric_price are present.' example: 11613.31890586 nullable: true required: - transport_mode - warehouse_location_id - destination_location_id delete: summary: 'Remove the specified price' operationId: removeTheSpecifiedPrice description: '' parameters: - in: header name: bearer description: '' example: Token schema: type: string responses: { } tags: - Pricing parameters: - in: path name: id description: 'The ID of the pricing.' example: 1 required: true schema: type: integer /api/shipping_address: get: summary: 'Fetch Shipping address' operationId: fetchShippingAddress description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: message: 'Shipping Address fetched successfully' data: - id: 1 created_at: '2026-01-23T08:01:06.000000Z' updated_at: '2026-01-23T08:01:06.000000Z' name: 'USA - AIR' address_line1: '4720 Boston Way' address_line2: 'Suite C Shypt' city: Lanham state: MD zip: '20706' phone_number: '+1 301 317 0512' deleted_at: null properties: message: type: string example: 'Shipping Address fetched successfully' data: type: array example: - id: 1 created_at: '2026-01-23T08:01:06.000000Z' updated_at: '2026-01-23T08:01:06.000000Z' name: 'USA - AIR' address_line1: '4720 Boston Way' address_line2: 'Suite C Shypt' city: Lanham state: MD zip: '20706' phone_number: '+1 301 317 0512' deleted_at: null items: type: object properties: id: type: integer example: 1 created_at: type: string example: '2026-01-23T08:01:06.000000Z' updated_at: type: string example: '2026-01-23T08:01:06.000000Z' name: type: string example: 'USA - AIR' address_line1: type: string example: '4720 Boston Way' address_line2: type: string example: 'Suite C Shypt' city: type: string example: Lanham state: type: string example: MD zip: type: string example: '20706' phone_number: type: string example: '+1 301 317 0512' deleted_at: type: string example: null tags: - 'Shipping address' post: summary: 'Record Shipping address' operationId: recordShippingAddress description: '' parameters: - in: header name: Bearer description: '' example: Token schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: message: 'Shipping Address created successfully' data: name: 'USA - AIR' address_line1: '4720 Boston Way' address_line2: 'Suite C Shypt' city: Lanham state: MD zip: '20706' phone_number: '+1 301 317 0512' updated_at: '2026-01-23T08:01:06.000000Z' created_at: '2026-01-23T08:01:06.000000Z' id: 1 properties: message: type: string example: 'Shipping Address created successfully' data: type: object properties: name: type: string example: 'USA - AIR' address_line1: type: string example: '4720 Boston Way' address_line2: type: string example: 'Suite C Shypt' city: type: string example: Lanham state: type: string example: MD zip: type: string example: '20706' phone_number: type: string example: '+1 301 317 0512' updated_at: type: string example: '2026-01-23T08:01:06.000000Z' created_at: type: string example: '2026-01-23T08:01:06.000000Z' id: type: integer example: 1 tags: - 'Shipping address' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: '' example: consequatur address_line1: type: string description: '' example: consequatur nullable: true address_line2: type: string description: '' example: consequatur nullable: true city: type: string description: '' example: consequatur nullable: true state: type: string description: '' example: consequatur nullable: true zip: type: string description: '' example: consequatur nullable: true phone_number: type: string description: '' example: consequatur nullable: true required: - name /api/tickets: get: summary: 'Display a listing of the tickets.' operationId: displayAListingOfTheTickets description: '' parameters: [] responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/tickets could not be found.' properties: message: type: string example: 'The route api/tickets could not be found.' tags: - 'Support Tickets' post: summary: 'Store a newly created ticket in storage.' operationId: storeANewlyCreatedTicketInStorage description: '' parameters: [] responses: { } tags: - 'Support Tickets' requestBody: required: true content: application/json: schema: type: object properties: subject: type: string description: 'Must not be greater than 255 characters.' example: vmqeopfuudtdsufvyvddq message: type: string description: '' example: consequatur reference: type: string description: '' example: consequatur nullable: true required: - subject - message '/api/tickets/{ticket_id}': get: summary: 'Display the specified ticket.' operationId: displayTheSpecifiedTicket description: '' parameters: [] responses: 404: description: '' content: application/json: schema: type: object example: message: 'The route api/tickets/17 could not be found.' properties: message: type: string example: 'The route api/tickets/17 could not be found.' tags: - 'Support Tickets' parameters: - in: path name: ticket_id description: 'The ID of the ticket.' example: 17 required: true schema: type: integer '/api/tickets/{ticket_id}/reply': post: summary: 'Add a reply to the specified ticket.' operationId: addAReplyToTheSpecifiedTicket description: '' parameters: [] responses: { } tags: - 'Support Tickets' requestBody: required: true content: application/json: schema: type: object properties: message: type: string description: '' example: consequatur required: - message parameters: - in: path name: ticket_id description: 'The ID of the ticket.' example: 17 required: true schema: type: integer '/api/tickets/{ticket_id}/status': patch: summary: '' operationId: patchApiTicketsTicket_idStatus description: '' parameters: [] responses: { } tags: - 'Support Tickets' requestBody: required: true content: application/json: schema: type: object properties: status: type: string description: '' example: open enum: - open - closed - resolved required: - status parameters: - in: path name: ticket_id description: 'The ID of the ticket.' example: 17 required: true schema: type: integer '/api/tickets/messages/{ticketMessage_id}/read': patch: summary: '' operationId: patchApiTicketsMessagesTicketMessage_idRead description: '' parameters: [] responses: { } tags: - 'Support Tickets' parameters: - in: path name: ticketMessage_id description: 'The ID of the ticketMessage.' example: 17 required: true schema: type: integer