openapi: 3.0.3 info: title: 'API Documentation' description: '' version: 1.0.0 servers: - url: 'https://warespace.de' paths: /api/palletspace/v1/company/orders: get: summary: 'Display a listing of all company orders' operationId: displayAListingOfAllCompanyOrders description: 'This endpoint gives you a listing of palletspace orders for a company.' parameters: - in: query name: status description: 'Status to filter by. Possible options are requested, cancelled, inbound, stock, outsourced, quality_issue, fulfilled' example: stock required: false schema: type: string description: 'Status to filter by. Possible options are requested, cancelled, inbound, stock, outsourced, quality_issue, fulfilled' example: stock nullable: false - in: query name: page description: "Current page number. Defaults to '1'." example: 5 required: false schema: type: integer description: "Current page number. Defaults to '1'." example: 5 nullable: false - in: query name: page_size description: "Size of a page. Defaults to '100'." example: 20 required: false schema: type: integer description: "Size of a page. Defaults to '100'." example: 20 nullable: false responses: 200: description: success content: application/json: schema: type: object example: data: - id: 1 orderNumber: 6b885e57-c75a-3452-a067-9c2825fbab8b createdAt: '2021-09-17' createdBy: 'John Doe' orders: - id: 24 name: 'Location Name A' pallets: - id: 13 palletspace_pallet_id: 1 order_number: 5-24413802409-1 inbound_date: null outbound_date: null status: label: Requested value: requested createdAt: '2021-09-17 12:00:00' - id: 14 palletspace_pallet_id: 2 order_number: 5-24413802409-2 inbound_date: '2023-04-01' outbound_date: '2023-07-07' status: label: Stock value: stock createdAt: '2021-09-17 12:00:00' - id: 15 palletspace_pallet_id: 3 order_number: 5-24413802409-3 inbound_date: '2023-10-01' outbound_date: '2023-11-20' status: label: Stock value: stock createdAt: '2021-09-17 12:00:00' inboundDate: '2021-10-01' outboundDate: '2021-10-02' status: label: Stock value: stock transport: status: label: Requested value: requested - id: 45 name: 'Location Name B' pallets: - id: 10 palletspace_pallet_id: 1 order_number: 4-24413802409-1 inbound_date: null outbound_date: null status: label: Requested value: requested createdAt: '2021-09-17 12:00:00' - id: 11 palletspace_pallet_id: 2 order_number: 4-24413802409-2 inbound_date: '2023-04-01' outbound_date: '2023-07-07' status: label: Stock value: stock createdAt: '2021-09-17 12:00:00' - id: 12 palletspace_pallet_id: 3 order_number: 4-24413802409-3 inbound_date: '2023-10-01' outbound_date: '2023-11-20' status: label: Stock value: stock createdAt: '2021-09-17 12:00:00' inboundDate: '2023-01-31' outboundDate: '2023-07-08' status: label: Stock value: stock transport: status: label: Requested value: requested - id: 657 name: 'Location Name C' pallets: - id: 7 palletspace_pallet_id: 1 order_number: 3-24413802409-1 inbound_date: null outbound_date: null status: label: Requested value: requested createdAt: '2021-09-17 12:00:00' - id: 8 palletspace_pallet_id: 2 order_number: 3-24413802409-2 inbound_date: '2023-04-01' outbound_date: '2023-07-07' status: label: Stock value: stock createdAt: '2021-09-17 12:00:00' - id: 9 palletspace_pallet_id: 3 order_number: 3-24413802409-3 inbound_date: '2023-10-01' outbound_date: '2023-11-20' status: label: Stock value: stock createdAt: '2021-09-17 12:00:00' inboundDate: '2023-10-01' outboundDate: '2023-11-20' status: label: Stock value: stock transport: status: label: Requested value: requested - id: 2 orderNumber: 9134bab7-da5d-35ec-89ed-6dfe114c9f09 createdAt: '2023-08-29' createdBy: 'Jane Doe' orders: - id: 767 name: 'Location Name A' pallets: 12344 inboundDate: '2021-10-01' outboundDate: '2021-10-02' status: label: Stock value: stock transport: status: label: Requested value: requested - id: 3 orderNumber: f244716a-7212-3ab7-86f4-01f25f2af21b createdAt: '2021-09-12' createdBy: 'John Doe' orders: - id: 8 name: 'Location Name A' pallets: 12344 inboundDate: '2020-09-31' outboundDate: '2021-10-09' status: label: Stock value: stock transport: status: label: Requested value: requested - id: 96 name: 'Location Name B' pallets: - id: 1 palletspace_pallet_id: 1 order_number: 1-24413802409-1 inbound_date: null outbound_date: null status: label: Requested value: requested createdAt: '2021-09-17 12:00:00' - id: 2 palletspace_pallet_id: 2 order_number: 1-24413802409-2 inbound_date: '2023-04-01' outbound_date: '2023-07-07' status: label: Stock value: stock createdAt: '2021-09-17 12:00:00' - id: 3 palletspace_pallet_id: 3 order_number: 1-24413802409-3 inbound_date: '2023-10-01' outbound_date: '2023-11-20' status: label: Stock value: stock createdAt: '2021-09-17 12:00:00' inboundDate: '2023-04-01' outboundDate: '2023-07-07' status: label: Stock value: stock transport: status: label: Requested value: requested - id: 2 name: 'Location Name C' pallets: - id: 4 palletspace_pallet_id: 1 order_number: 2-24413802409-1 inbound_date: null outbound_date: null status: label: Requested value: requested createdAt: '2021-09-17 12:00:00' - id: 5 palletspace_pallet_id: 2 order_number: 2-24413802409-2 inbound_date: '2023-04-01' outbound_date: '2023-07-07' status: label: Stock value: stock createdAt: '2021-09-17 12:00:00' - id: 6 palletspace_pallet_id: 3 order_number: 2-24413802409-3 inbound_date: '2023-10-01' outbound_date: '2023-11-20' status: label: Stock value: stock createdAt: '2021-09-17 12:00:00' inboundDate: '2023-10-01' outboundDate: '2023-11-20' status: label: Stock value: stock transport: status: label: Requested value: requested properties: data: type: array example: - id: 1 orderNumber: 6b885e57-c75a-3452-a067-9c2825fbab8b createdAt: '2021-09-17' createdBy: 'John Doe' orders: - id: 24 name: 'Location Name A' pallets: - id: 13 palletspace_pallet_id: 1 order_number: 5-24413802409-1 inbound_date: null outbound_date: null status: label: Requested value: requested createdAt: '2021-09-17 12:00:00' - id: 14 palletspace_pallet_id: 2 order_number: 5-24413802409-2 inbound_date: '2023-04-01' outbound_date: '2023-07-07' status: label: Stock value: stock createdAt: '2021-09-17 12:00:00' - id: 15 palletspace_pallet_id: 3 order_number: 5-24413802409-3 inbound_date: '2023-10-01' outbound_date: '2023-11-20' status: label: Stock value: stock createdAt: '2021-09-17 12:00:00' inboundDate: '2021-10-01' outboundDate: '2021-10-02' status: label: Stock value: stock transport: status: label: Requested value: requested - id: 45 name: 'Location Name B' pallets: - id: 10 palletspace_pallet_id: 1 order_number: 4-24413802409-1 inbound_date: null outbound_date: null status: label: Requested value: requested createdAt: '2021-09-17 12:00:00' - id: 11 palletspace_pallet_id: 2 order_number: 4-24413802409-2 inbound_date: '2023-04-01' outbound_date: '2023-07-07' status: label: Stock value: stock createdAt: '2021-09-17 12:00:00' - id: 12 palletspace_pallet_id: 3 order_number: 4-24413802409-3 inbound_date: '2023-10-01' outbound_date: '2023-11-20' status: label: Stock value: stock createdAt: '2021-09-17 12:00:00' inboundDate: '2023-01-31' outboundDate: '2023-07-08' status: label: Stock value: stock transport: status: label: Requested value: requested - id: 657 name: 'Location Name C' pallets: - id: 7 palletspace_pallet_id: 1 order_number: 3-24413802409-1 inbound_date: null outbound_date: null status: label: Requested value: requested createdAt: '2021-09-17 12:00:00' - id: 8 palletspace_pallet_id: 2 order_number: 3-24413802409-2 inbound_date: '2023-04-01' outbound_date: '2023-07-07' status: label: Stock value: stock createdAt: '2021-09-17 12:00:00' - id: 9 palletspace_pallet_id: 3 order_number: 3-24413802409-3 inbound_date: '2023-10-01' outbound_date: '2023-11-20' status: label: Stock value: stock createdAt: '2021-09-17 12:00:00' inboundDate: '2023-10-01' outboundDate: '2023-11-20' status: label: Stock value: stock transport: status: label: Requested value: requested - id: 2 orderNumber: 9134bab7-da5d-35ec-89ed-6dfe114c9f09 createdAt: '2023-08-29' createdBy: 'Jane Doe' orders: - id: 767 name: 'Location Name A' pallets: 12344 inboundDate: '2021-10-01' outboundDate: '2021-10-02' status: label: Stock value: stock transport: status: label: Requested value: requested - id: 3 orderNumber: f244716a-7212-3ab7-86f4-01f25f2af21b createdAt: '2021-09-12' createdBy: 'John Doe' orders: - id: 8 name: 'Location Name A' pallets: 12344 inboundDate: '2020-09-31' outboundDate: '2021-10-09' status: label: Stock value: stock transport: status: label: Requested value: requested - id: 96 name: 'Location Name B' pallets: - id: 1 palletspace_pallet_id: 1 order_number: 1-24413802409-1 inbound_date: null outbound_date: null status: label: Requested value: requested createdAt: '2021-09-17 12:00:00' - id: 2 palletspace_pallet_id: 2 order_number: 1-24413802409-2 inbound_date: '2023-04-01' outbound_date: '2023-07-07' status: label: Stock value: stock createdAt: '2021-09-17 12:00:00' - id: 3 palletspace_pallet_id: 3 order_number: 1-24413802409-3 inbound_date: '2023-10-01' outbound_date: '2023-11-20' status: label: Stock value: stock createdAt: '2021-09-17 12:00:00' inboundDate: '2023-04-01' outboundDate: '2023-07-07' status: label: Stock value: stock transport: status: label: Requested value: requested - id: 2 name: 'Location Name C' pallets: - id: 4 palletspace_pallet_id: 1 order_number: 2-24413802409-1 inbound_date: null outbound_date: null status: label: Requested value: requested createdAt: '2021-09-17 12:00:00' - id: 5 palletspace_pallet_id: 2 order_number: 2-24413802409-2 inbound_date: '2023-04-01' outbound_date: '2023-07-07' status: label: Stock value: stock createdAt: '2021-09-17 12:00:00' - id: 6 palletspace_pallet_id: 3 order_number: 2-24413802409-3 inbound_date: '2023-10-01' outbound_date: '2023-11-20' status: label: Stock value: stock createdAt: '2021-09-17 12:00:00' inboundDate: '2023-10-01' outboundDate: '2023-11-20' status: label: Stock value: stock transport: status: label: Requested value: requested items: type: object properties: id: type: integer example: 1 orderNumber: type: string example: 6b885e57-c75a-3452-a067-9c2825fbab8b createdAt: type: string example: '2021-09-17' createdBy: type: string example: 'John Doe' orders: type: array example: - id: 24 name: 'Location Name A' pallets: - id: 13 palletspace_pallet_id: 1 order_number: 5-24413802409-1 inbound_date: null outbound_date: null status: label: Requested value: requested createdAt: '2021-09-17 12:00:00' - id: 14 palletspace_pallet_id: 2 order_number: 5-24413802409-2 inbound_date: '2023-04-01' outbound_date: '2023-07-07' status: label: Stock value: stock createdAt: '2021-09-17 12:00:00' - id: 15 palletspace_pallet_id: 3 order_number: 5-24413802409-3 inbound_date: '2023-10-01' outbound_date: '2023-11-20' status: label: Stock value: stock createdAt: '2021-09-17 12:00:00' inboundDate: '2021-10-01' outboundDate: '2021-10-02' status: label: Stock value: stock transport: status: label: Requested value: requested - id: 45 name: 'Location Name B' pallets: - id: 10 palletspace_pallet_id: 1 order_number: 4-24413802409-1 inbound_date: null outbound_date: null status: label: Requested value: requested createdAt: '2021-09-17 12:00:00' - id: 11 palletspace_pallet_id: 2 order_number: 4-24413802409-2 inbound_date: '2023-04-01' outbound_date: '2023-07-07' status: label: Stock value: stock createdAt: '2021-09-17 12:00:00' - id: 12 palletspace_pallet_id: 3 order_number: 4-24413802409-3 inbound_date: '2023-10-01' outbound_date: '2023-11-20' status: label: Stock value: stock createdAt: '2021-09-17 12:00:00' inboundDate: '2023-01-31' outboundDate: '2023-07-08' status: label: Stock value: stock transport: status: label: Requested value: requested - id: 657 name: 'Location Name C' pallets: - id: 7 palletspace_pallet_id: 1 order_number: 3-24413802409-1 inbound_date: null outbound_date: null status: label: Requested value: requested createdAt: '2021-09-17 12:00:00' - id: 8 palletspace_pallet_id: 2 order_number: 3-24413802409-2 inbound_date: '2023-04-01' outbound_date: '2023-07-07' status: label: Stock value: stock createdAt: '2021-09-17 12:00:00' - id: 9 palletspace_pallet_id: 3 order_number: 3-24413802409-3 inbound_date: '2023-10-01' outbound_date: '2023-11-20' status: label: Stock value: stock createdAt: '2021-09-17 12:00:00' inboundDate: '2023-10-01' outboundDate: '2023-11-20' status: label: Stock value: stock transport: status: label: Requested value: requested items: type: object properties: id: type: integer example: 24 name: type: string example: 'Location Name A' pallets: type: array example: - id: 13 palletspace_pallet_id: 1 order_number: 5-24413802409-1 inbound_date: null outbound_date: null status: label: Requested value: requested createdAt: '2021-09-17 12:00:00' - id: 14 palletspace_pallet_id: 2 order_number: 5-24413802409-2 inbound_date: '2023-04-01' outbound_date: '2023-07-07' status: label: Stock value: stock createdAt: '2021-09-17 12:00:00' - id: 15 palletspace_pallet_id: 3 order_number: 5-24413802409-3 inbound_date: '2023-10-01' outbound_date: '2023-11-20' status: label: Stock value: stock createdAt: '2021-09-17 12:00:00' items: type: object properties: id: type: integer example: 13 palletspace_pallet_id: type: integer example: 1 order_number: type: string example: 5-24413802409-1 inbound_date: type: string example: null outbound_date: type: string example: null status: type: object properties: { label: { type: string, example: Requested }, value: { type: string, example: requested } } createdAt: type: string example: '2021-09-17 12:00:00' inboundDate: type: string example: '2021-10-01' outboundDate: type: string example: '2021-10-02' status: type: object properties: label: type: string example: Stock value: type: string example: stock transport: type: object properties: status: type: object properties: label: { type: string, example: Requested } value: { type: string, example: requested } 401: description: unauthenticated content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Company Authentication' /api/warespace/v1/public/visitor-event: post: summary: 'Store Visitor Event' operationId: storeVisitorEvent description: 'Store a new warespace visitor event' parameters: - in: query name: event description: 'Event identifier (must match enum VisitorEventEventEnum)' example: page_view required: true schema: type: string description: 'Event identifier (must match enum VisitorEventEventEnum)' example: page_view nullable: false responses: 201: description: Created content: application/json: schema: type: object example: message: ok data: id: 1 event: page_view payload: foo: bar created_at: '2025-05-16T12:00:00Z' updated_at: '2025-05-16T12:00:00Z' properties: message: type: string example: ok data: type: object properties: id: type: integer example: 1 event: type: string example: page_view payload: type: object properties: foo: type: string example: bar created_at: type: string example: '2025-05-16T12:00:00Z' updated_at: type: string example: '2025-05-16T12:00:00Z' 403: description: 'Visitor session not found' content: application/json: schema: type: object example: message: 'Visitor session not found' properties: message: type: string example: 'Visitor session not found' 422: description: 'Validation error' content: application/json: schema: type: object example: message: 'The given data was invalid.' errors: event: - 'The event field is required.' properties: message: type: string example: 'The given data was invalid.' errors: type: object properties: event: type: array example: - 'The event field is required.' items: type: string 500: description: 'Visitor event not created' content: application/json: schema: type: object example: message: 'Visitor event not created' properties: message: type: string example: 'Visitor event not created' tags: - 'Company Authentication' requestBody: required: true content: application/json: schema: type: object properties: event: type: string description: 'Das Feld value darf nicht größer als 255 Zeichen sein.' example: mvqbkveoemuaneussxedy nullable: false url: type: string description: 'Must be a valid URL.' example: 'https://kovacek.com/voluptate-et-numquam-quos-qui-in-excepturi.html' nullable: false payload: type: object description: 'Optional payload data' example: url: /contact nullable: false properties: { } required: - event - url security: [] /api/warespace/v1/company/ecl/orders/inbound: get: summary: 'Display a listing of all ecl inbound orders' operationId: displayAListingOfAllEclInboundOrders description: 'This endpoint gives you a listing of all easy connected logistics inbound orders.' parameters: - in: query name: page description: "Current page number. Defaults to '1'." example: 5 required: false schema: type: integer description: "Current page number. Defaults to '1'." example: 5 nullable: false - in: query name: page_size description: "Size of a page. Defaults to '20'." example: 20 required: false schema: type: integer description: "Size of a page. Defaults to '20'." example: 20 nullable: false responses: 200: description: success content: application/json: schema: type: object example: data: - id: 1 order_number: '123456' status: pending_inbound sscc: '123456789012345678' quantity: 1 unit_of_measure: can documents: - id: 1 url: 'https://example.com/example.jpg' name: example.jpg customer: user: id: 1 name: 'Max Mustermann' email: max@mustermann.de phone_number_business: '+49 123 4567890' job_title: CEO locale: id: 2 code: en name: English company: id: 1 name: 'Mustermann GmbH' address_line_1: 'Musterstraße 1' address_line_2: Musterhaus postal_code: '12345' city: Musterstadt country: id: 1 name: Afghanistan alpha_2_code: AF alpha_3_code: AFG locale: id: 2 code: en name: English phone: '+49 123 4567890' email: info@mustermann.de billing_email: billing@mustermann.de website: 'https://www.mustermann.de' warehouse: id: 1 name: Musterlager address_line_1: 'Musterstraße 1' postal_code: '12345' city: Musterstadt country: id: 1 name: Afghanistan alpha_2_code: AF alpha_3_code: AFG phone: '+49 123 4567890' sales_mail: sales@musterlager.de contact_mail: contact@musterlager.de article: id: 1 company: id: 1 name: 'Mustermann GmbH' address_line_1: 'Musterstraße 1' address_line_2: Musterhaus postal_code: '12345' city: Musterstadt country: id: 1 name: Afghanistan alpha_2_code: AF alpha_3_code: AFG locale: id: 2 code: en name: English phone: '+49 123 4567890' email: info@mustermann.de billing_email: billing@mustermann.de website: 'https://www.mustermann.de' inbound: id: 1 article_id: 1 abc_indicator: b created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' hazardous: id: 1 created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' packagings: - id: 1 width: 20 height: 20 length: 20 volume: 8000 article_id: 1 net_weight: 1 gross_weight: 1 packaging_level: 1 base_unit_of_measure: pcs quantity_per_packaging_level: 1 created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' volume_unit: cm3 weight_unit: g bestBeforeDate: id: 1 article_id: 1 is_mandatory: true total_shelf_life: 365 minimum_remaining_shelf_life: 30 created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' commodityCodes: - id: 1 article_packaging_id: 1 check_required: false commodity_code: '1234567890' commodity_code_type: gtin created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' dimension_unit: mm short_description: 'Ventilator, 3-speed, 120V' stock_keeping_unit: ABC-12345-S-BL batch_number_management_indicator: false extern_client_number: '1234567890' created_at: '2021-01-01T00:00:00Z' updated_at: '2021-01-01T00:00:00Z' extern_client_number: '1234567890' properties: data: type: array example: - id: 1 order_number: '123456' status: pending_inbound sscc: '123456789012345678' quantity: 1 unit_of_measure: can documents: - id: 1 url: 'https://example.com/example.jpg' name: example.jpg customer: user: id: 1 name: 'Max Mustermann' email: max@mustermann.de phone_number_business: '+49 123 4567890' job_title: CEO locale: id: 2 code: en name: English company: id: 1 name: 'Mustermann GmbH' address_line_1: 'Musterstraße 1' address_line_2: Musterhaus postal_code: '12345' city: Musterstadt country: id: 1 name: Afghanistan alpha_2_code: AF alpha_3_code: AFG locale: id: 2 code: en name: English phone: '+49 123 4567890' email: info@mustermann.de billing_email: billing@mustermann.de website: 'https://www.mustermann.de' warehouse: id: 1 name: Musterlager address_line_1: 'Musterstraße 1' postal_code: '12345' city: Musterstadt country: id: 1 name: Afghanistan alpha_2_code: AF alpha_3_code: AFG phone: '+49 123 4567890' sales_mail: sales@musterlager.de contact_mail: contact@musterlager.de article: id: 1 company: id: 1 name: 'Mustermann GmbH' address_line_1: 'Musterstraße 1' address_line_2: Musterhaus postal_code: '12345' city: Musterstadt country: id: 1 name: Afghanistan alpha_2_code: AF alpha_3_code: AFG locale: id: 2 code: en name: English phone: '+49 123 4567890' email: info@mustermann.de billing_email: billing@mustermann.de website: 'https://www.mustermann.de' inbound: id: 1 article_id: 1 abc_indicator: b created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' hazardous: id: 1 created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' packagings: - id: 1 width: 20 height: 20 length: 20 volume: 8000 article_id: 1 net_weight: 1 gross_weight: 1 packaging_level: 1 base_unit_of_measure: pcs quantity_per_packaging_level: 1 created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' volume_unit: cm3 weight_unit: g bestBeforeDate: id: 1 article_id: 1 is_mandatory: true total_shelf_life: 365 minimum_remaining_shelf_life: 30 created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' commodityCodes: - id: 1 article_packaging_id: 1 check_required: false commodity_code: '1234567890' commodity_code_type: gtin created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' dimension_unit: mm short_description: 'Ventilator, 3-speed, 120V' stock_keeping_unit: ABC-12345-S-BL batch_number_management_indicator: false extern_client_number: '1234567890' created_at: '2021-01-01T00:00:00Z' updated_at: '2021-01-01T00:00:00Z' extern_client_number: '1234567890' items: type: object properties: id: type: integer example: 1 order_number: type: string example: '123456' status: type: string example: pending_inbound sscc: type: string example: '123456789012345678' quantity: type: integer example: 1 unit_of_measure: type: string example: can documents: type: array example: - id: 1 url: 'https://example.com/example.jpg' name: example.jpg items: type: object properties: id: type: integer example: 1 url: type: string example: 'https://example.com/example.jpg' name: type: string example: example.jpg customer: type: object properties: user: type: object properties: id: type: integer example: 1 name: type: string example: 'Max Mustermann' email: type: string example: max@mustermann.de phone_number_business: type: string example: '+49 123 4567890' job_title: type: string example: CEO locale: type: object properties: id: type: integer example: 2 code: type: string example: en name: type: string example: English company: type: object properties: id: type: integer example: 1 name: type: string example: 'Mustermann GmbH' address_line_1: type: string example: 'Musterstraße 1' address_line_2: type: string example: Musterhaus postal_code: type: string example: '12345' city: type: string example: Musterstadt country: type: object properties: id: type: integer example: 1 name: type: string example: Afghanistan alpha_2_code: type: string example: AF alpha_3_code: type: string example: AFG locale: type: object properties: id: type: integer example: 2 code: type: string example: en name: type: string example: English phone: type: string example: '+49 123 4567890' email: type: string example: info@mustermann.de billing_email: type: string example: billing@mustermann.de website: type: string example: 'https://www.mustermann.de' warehouse: type: object properties: id: type: integer example: 1 name: type: string example: Musterlager address_line_1: type: string example: 'Musterstraße 1' postal_code: type: string example: '12345' city: type: string example: Musterstadt country: type: object properties: id: type: integer example: 1 name: type: string example: Afghanistan alpha_2_code: type: string example: AF alpha_3_code: type: string example: AFG phone: type: string example: '+49 123 4567890' sales_mail: type: string example: sales@musterlager.de contact_mail: type: string example: contact@musterlager.de article: type: object properties: id: type: integer example: 1 company: type: object properties: id: type: integer example: 1 name: type: string example: 'Mustermann GmbH' address_line_1: type: string example: 'Musterstraße 1' address_line_2: type: string example: Musterhaus postal_code: type: string example: '12345' city: type: string example: Musterstadt country: type: object properties: id: type: integer example: 1 name: type: string example: Afghanistan alpha_2_code: type: string example: AF alpha_3_code: type: string example: AFG locale: type: object properties: id: type: integer example: 2 code: type: string example: en name: type: string example: English phone: type: string example: '+49 123 4567890' email: type: string example: info@mustermann.de billing_email: type: string example: billing@mustermann.de website: type: string example: 'https://www.mustermann.de' inbound: type: object properties: id: type: integer example: 1 article_id: type: integer example: 1 abc_indicator: type: string example: b created_at: type: string example: '2021-01-01 00:00:00' updated_at: type: string example: '2021-01-01 00:00:00' hazardous: type: object properties: id: type: integer example: 1 created_at: type: string example: '2021-01-01 00:00:00' updated_at: type: string example: '2021-01-01 00:00:00' packagings: type: array example: - id: 1 width: 20 height: 20 length: 20 volume: 8000 article_id: 1 net_weight: 1 gross_weight: 1 packaging_level: 1 base_unit_of_measure: pcs quantity_per_packaging_level: 1 created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' items: type: object properties: id: type: integer example: 1 width: type: integer example: 20 height: type: integer example: 20 length: type: integer example: 20 volume: type: integer example: 8000 article_id: type: integer example: 1 net_weight: type: integer example: 1 gross_weight: type: integer example: 1 packaging_level: type: integer example: 1 base_unit_of_measure: type: string example: pcs quantity_per_packaging_level: type: integer example: 1 created_at: type: string example: '2021-01-01 00:00:00' updated_at: type: string example: '2021-01-01 00:00:00' volume_unit: type: string example: cm3 weight_unit: type: string example: g bestBeforeDate: type: object properties: id: type: integer example: 1 article_id: type: integer example: 1 is_mandatory: type: boolean example: true total_shelf_life: type: integer example: 365 minimum_remaining_shelf_life: type: integer example: 30 created_at: type: string example: '2021-01-01 00:00:00' updated_at: type: string example: '2021-01-01 00:00:00' commodityCodes: type: array example: - id: 1 article_packaging_id: 1 check_required: false commodity_code: '1234567890' commodity_code_type: gtin created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' items: type: object properties: id: type: integer example: 1 article_packaging_id: type: integer example: 1 check_required: type: boolean example: false commodity_code: type: string example: '1234567890' commodity_code_type: type: string example: gtin created_at: type: string example: '2021-01-01 00:00:00' updated_at: type: string example: '2021-01-01 00:00:00' dimension_unit: type: string example: mm short_description: type: string example: 'Ventilator, 3-speed, 120V' stock_keeping_unit: type: string example: ABC-12345-S-BL batch_number_management_indicator: type: boolean example: false extern_client_number: type: string example: '1234567890' created_at: type: string example: '2021-01-01T00:00:00Z' updated_at: type: string example: '2021-01-01T00:00:00Z' extern_client_number: type: string example: '1234567890' 401: description: unauthenticated content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Company Authentication' '/api/warespace/v1/company/ecl/orders/inbound/{order}/status/{status}': post: summary: 'Update status' operationId: updateStatus description: 'If you want to set it an inbound order to a different status, you can use this endpoint.' parameters: [] responses: 200: description: success content: application/json: schema: type: object example: data: ok properties: data: type: string example: ok 401: description: unauthenticated content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: 'not found' content: application/json: schema: type: object example: message: 'Order not found' properties: message: type: string example: 'Order not found' 422: description: 'validation failed' content: application/json: schema: type: object example: message: 'Order is in draft status' properties: message: type: string example: 'Order is in draft status' tags: - 'Company Authentication' parameters: - in: path name: order description: 'The order number or id' example: 52000-38103-1 required: true schema: type: string - in: path name: status description: 'The status to set the order to' example: stocked required: true schema: type: string /api/warespace/v1/company/ecl/orders/outbound: get: summary: 'Display a listing of all ecl outbound orders.' operationId: displayAListingOfAllEclOutboundOrders description: 'This endpoint gives you a listing of ecl outbound orders.' parameters: - in: query name: page description: "Current page number. Defaults to '1'." example: 5 required: false schema: type: integer description: "Current page number. Defaults to '1'." example: 5 nullable: false - in: query name: page_size description: "Size of a page. Defaults to '20'." example: 20 required: false schema: type: integer description: "Size of a page. Defaults to '20'." example: 20 nullable: false responses: 200: description: success content: application/json: schema: type: object example: data: - id: 30 order_number: 52000-86588-1 status: pending_outbound outbound_date: '2025-02-19T23:00:00.000000Z' customer: user: id: 1 name: 'Max Mustermann' email: max@mustermann.de phone_number_business: '+49 123 4567890' job_title: CEO locale: id: 2 code: en name: English company: id: 1 name: 'Mustermann GmbH' address_line_1: 'Musterstraße 1' address_line_2: Musterhaus postal_code: '12345' city: Musterstadt country: id: 1 name: Afghanistan alpha_2_code: AF alpha_3_code: AFG locale: id: 2 code: en name: English phone: '+49 123 4567890' email: info@mustermann.de billing_email: billing@mustermann.de website: 'https://www.mustermann.de' warehouse: id: 1 name: Musterlager address_line_1: 'Musterstraße 1' postal_code: '12345' city: Musterstadt country: id: 1 name: Afghanistan alpha_2_code: AF alpha_3_code: AFG phone: '+49 123 4567890' sales_mail: sales@musterlager.de contact_mail: contact@musterlager.de items: - id: 1 article: id: 1 company: id: 1 name: 'Mustermann GmbH' address_line_1: 'Musterstraße 1' address_line_2: Musterhaus postal_code: '12345' city: Musterstadt country: id: 1 name: Afghanistan alpha_2_code: AF alpha_3_code: AFG locale: id: 2 code: en name: English phone: '+49 123 4567890' email: info@mustermann.de billing_email: billing@mustermann.de website: 'https://www.mustermann.de' inbound: id: 1 article_id: 1 abc_indicator: b created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' hazardous: id: 1 created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' packagings: - id: 1 width: 20 height: 20 length: 20 volume: 8000 article_id: 1 net_weight: 1 gross_weight: 1 packaging_level: 1 base_unit_of_measure: pcs quantity_per_packaging_level: 1 created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' volume_unit: cm3 weight_unit: g bestBeforeDate: id: 1 article_id: 1 is_mandatory: true total_shelf_life: 365 minimum_remaining_shelf_life: 30 created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' commodityCodes: - id: 1 article_packaging_id: 1 check_required: false commodity_code: '1234567890' commodity_code_type: gtin created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' dimension_unit: mm short_description: 'Ventilator, 3-speed, 120V' stock_keeping_unit: ABC-12345-S-BL batch_number_management_indicator: false extern_client_number: '1234567890' created_at: '2021-01-01T00:00:00Z' updated_at: '2021-01-01T00:00:00Z' quantity: 1 unit_of_measure: bag created_at: '2021-01-01 00:00:00' addresses: sending: address_line_1: '123 Main St' address_line_2: 'Gate 1' postal_code: '12345' city: Anytown country: id: 1 name: Afghanistan alpha_2_code: AF alpha_3_code: AFG recipient: address_line_1: '123 Main St' address_line_2: 'Gate 1' postal_code: '12345' city: Anytown country: id: 1 name: Afghanistan alpha_2_code: AF alpha_3_code: AFG extern_client_number: '1234567890' properties: data: type: array example: - id: 30 order_number: 52000-86588-1 status: pending_outbound outbound_date: '2025-02-19T23:00:00.000000Z' customer: user: id: 1 name: 'Max Mustermann' email: max@mustermann.de phone_number_business: '+49 123 4567890' job_title: CEO locale: id: 2 code: en name: English company: id: 1 name: 'Mustermann GmbH' address_line_1: 'Musterstraße 1' address_line_2: Musterhaus postal_code: '12345' city: Musterstadt country: id: 1 name: Afghanistan alpha_2_code: AF alpha_3_code: AFG locale: id: 2 code: en name: English phone: '+49 123 4567890' email: info@mustermann.de billing_email: billing@mustermann.de website: 'https://www.mustermann.de' warehouse: id: 1 name: Musterlager address_line_1: 'Musterstraße 1' postal_code: '12345' city: Musterstadt country: id: 1 name: Afghanistan alpha_2_code: AF alpha_3_code: AFG phone: '+49 123 4567890' sales_mail: sales@musterlager.de contact_mail: contact@musterlager.de items: - id: 1 article: id: 1 company: id: 1 name: 'Mustermann GmbH' address_line_1: 'Musterstraße 1' address_line_2: Musterhaus postal_code: '12345' city: Musterstadt country: id: 1 name: Afghanistan alpha_2_code: AF alpha_3_code: AFG locale: id: 2 code: en name: English phone: '+49 123 4567890' email: info@mustermann.de billing_email: billing@mustermann.de website: 'https://www.mustermann.de' inbound: id: 1 article_id: 1 abc_indicator: b created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' hazardous: id: 1 created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' packagings: - id: 1 width: 20 height: 20 length: 20 volume: 8000 article_id: 1 net_weight: 1 gross_weight: 1 packaging_level: 1 base_unit_of_measure: pcs quantity_per_packaging_level: 1 created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' volume_unit: cm3 weight_unit: g bestBeforeDate: id: 1 article_id: 1 is_mandatory: true total_shelf_life: 365 minimum_remaining_shelf_life: 30 created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' commodityCodes: - id: 1 article_packaging_id: 1 check_required: false commodity_code: '1234567890' commodity_code_type: gtin created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' dimension_unit: mm short_description: 'Ventilator, 3-speed, 120V' stock_keeping_unit: ABC-12345-S-BL batch_number_management_indicator: false extern_client_number: '1234567890' created_at: '2021-01-01T00:00:00Z' updated_at: '2021-01-01T00:00:00Z' quantity: 1 unit_of_measure: bag created_at: '2021-01-01 00:00:00' addresses: sending: address_line_1: '123 Main St' address_line_2: 'Gate 1' postal_code: '12345' city: Anytown country: id: 1 name: Afghanistan alpha_2_code: AF alpha_3_code: AFG recipient: address_line_1: '123 Main St' address_line_2: 'Gate 1' postal_code: '12345' city: Anytown country: id: 1 name: Afghanistan alpha_2_code: AF alpha_3_code: AFG extern_client_number: '1234567890' items: type: object properties: id: type: integer example: 30 order_number: type: string example: 52000-86588-1 status: type: string example: pending_outbound outbound_date: type: string example: '2025-02-19T23:00:00.000000Z' customer: type: object properties: user: type: object properties: id: type: integer example: 1 name: type: string example: 'Max Mustermann' email: type: string example: max@mustermann.de phone_number_business: type: string example: '+49 123 4567890' job_title: type: string example: CEO locale: type: object properties: id: type: integer example: 2 code: type: string example: en name: type: string example: English company: type: object properties: id: type: integer example: 1 name: type: string example: 'Mustermann GmbH' address_line_1: type: string example: 'Musterstraße 1' address_line_2: type: string example: Musterhaus postal_code: type: string example: '12345' city: type: string example: Musterstadt country: type: object properties: id: type: integer example: 1 name: type: string example: Afghanistan alpha_2_code: type: string example: AF alpha_3_code: type: string example: AFG locale: type: object properties: id: type: integer example: 2 code: type: string example: en name: type: string example: English phone: type: string example: '+49 123 4567890' email: type: string example: info@mustermann.de billing_email: type: string example: billing@mustermann.de website: type: string example: 'https://www.mustermann.de' warehouse: type: object properties: id: type: integer example: 1 name: type: string example: Musterlager address_line_1: type: string example: 'Musterstraße 1' postal_code: type: string example: '12345' city: type: string example: Musterstadt country: type: object properties: id: type: integer example: 1 name: type: string example: Afghanistan alpha_2_code: type: string example: AF alpha_3_code: type: string example: AFG phone: type: string example: '+49 123 4567890' sales_mail: type: string example: sales@musterlager.de contact_mail: type: string example: contact@musterlager.de items: type: array example: - id: 1 article: id: 1 company: id: 1 name: 'Mustermann GmbH' address_line_1: 'Musterstraße 1' address_line_2: Musterhaus postal_code: '12345' city: Musterstadt country: id: 1 name: Afghanistan alpha_2_code: AF alpha_3_code: AFG locale: id: 2 code: en name: English phone: '+49 123 4567890' email: info@mustermann.de billing_email: billing@mustermann.de website: 'https://www.mustermann.de' inbound: id: 1 article_id: 1 abc_indicator: b created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' hazardous: id: 1 created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' packagings: - id: 1 width: 20 height: 20 length: 20 volume: 8000 article_id: 1 net_weight: 1 gross_weight: 1 packaging_level: 1 base_unit_of_measure: pcs quantity_per_packaging_level: 1 created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' volume_unit: cm3 weight_unit: g bestBeforeDate: id: 1 article_id: 1 is_mandatory: true total_shelf_life: 365 minimum_remaining_shelf_life: 30 created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' commodityCodes: - id: 1 article_packaging_id: 1 check_required: false commodity_code: '1234567890' commodity_code_type: gtin created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' dimension_unit: mm short_description: 'Ventilator, 3-speed, 120V' stock_keeping_unit: ABC-12345-S-BL batch_number_management_indicator: false extern_client_number: '1234567890' created_at: '2021-01-01T00:00:00Z' updated_at: '2021-01-01T00:00:00Z' quantity: 1 unit_of_measure: bag created_at: '2021-01-01 00:00:00' items: type: object properties: id: type: integer example: 1 article: type: object properties: id: type: integer example: 1 company: type: object properties: id: { type: integer, example: 1 } name: { type: string, example: 'Mustermann GmbH' } address_line_1: { type: string, example: 'Musterstraße 1' } address_line_2: { type: string, example: Musterhaus } postal_code: { type: string, example: '12345' } city: { type: string, example: Musterstadt } country: { type: object, properties: { id: { type: integer, example: 1 }, name: { type: string, example: Afghanistan }, alpha_2_code: { type: string, example: AF }, alpha_3_code: { type: string, example: AFG } } } locale: { type: object, properties: { id: { type: integer, example: 2 }, code: { type: string, example: en }, name: { type: string, example: English } } } phone: { type: string, example: '+49 123 4567890' } email: { type: string, example: info@mustermann.de } billing_email: { type: string, example: billing@mustermann.de } website: { type: string, example: 'https://www.mustermann.de' } inbound: type: object properties: id: { type: integer, example: 1 } article_id: { type: integer, example: 1 } abc_indicator: { type: string, example: b } created_at: { type: string, example: '2021-01-01 00:00:00' } updated_at: { type: string, example: '2021-01-01 00:00:00' } hazardous: type: object properties: id: { type: integer, example: 1 } created_at: { type: string, example: '2021-01-01 00:00:00' } updated_at: { type: string, example: '2021-01-01 00:00:00' } packagings: type: array example: - { id: 1, width: 20, height: 20, length: 20, volume: 8000, article_id: 1, net_weight: 1, gross_weight: 1, packaging_level: 1, base_unit_of_measure: pcs, quantity_per_packaging_level: 1, created_at: '2021-01-01 00:00:00', updated_at: '2021-01-01 00:00:00' } items: type: object properties: { id: { type: integer, example: 1 }, width: { type: integer, example: 20 }, height: { type: integer, example: 20 }, length: { type: integer, example: 20 }, volume: { type: integer, example: 8000 }, article_id: { type: integer, example: 1 }, net_weight: { type: integer, example: 1 }, gross_weight: { type: integer, example: 1 }, packaging_level: { type: integer, example: 1 }, base_unit_of_measure: { type: string, example: pcs }, quantity_per_packaging_level: { type: integer, example: 1 }, created_at: { type: string, example: '2021-01-01 00:00:00' }, updated_at: { type: string, example: '2021-01-01 00:00:00' } } volume_unit: type: string example: cm3 weight_unit: type: string example: g bestBeforeDate: type: object properties: id: { type: integer, example: 1 } article_id: { type: integer, example: 1 } is_mandatory: { type: boolean, example: true } total_shelf_life: { type: integer, example: 365 } minimum_remaining_shelf_life: { type: integer, example: 30 } created_at: { type: string, example: '2021-01-01 00:00:00' } updated_at: { type: string, example: '2021-01-01 00:00:00' } commodityCodes: type: array example: - { id: 1, article_packaging_id: 1, check_required: false, commodity_code: '1234567890', commodity_code_type: gtin, created_at: '2021-01-01 00:00:00', updated_at: '2021-01-01 00:00:00' } items: type: object properties: { id: { type: integer, example: 1 }, article_packaging_id: { type: integer, example: 1 }, check_required: { type: boolean, example: false }, commodity_code: { type: string, example: '1234567890' }, commodity_code_type: { type: string, example: gtin }, created_at: { type: string, example: '2021-01-01 00:00:00' }, updated_at: { type: string, example: '2021-01-01 00:00:00' } } dimension_unit: type: string example: mm short_description: type: string example: 'Ventilator, 3-speed, 120V' stock_keeping_unit: type: string example: ABC-12345-S-BL batch_number_management_indicator: type: boolean example: false extern_client_number: type: string example: '1234567890' created_at: type: string example: '2021-01-01T00:00:00Z' updated_at: type: string example: '2021-01-01T00:00:00Z' quantity: type: integer example: 1 unit_of_measure: type: string example: bag created_at: type: string example: '2021-01-01 00:00:00' addresses: type: object properties: sending: type: object properties: address_line_1: type: string example: '123 Main St' address_line_2: type: string example: 'Gate 1' postal_code: type: string example: '12345' city: type: string example: Anytown country: type: object properties: id: type: integer example: 1 name: type: string example: Afghanistan alpha_2_code: type: string example: AF alpha_3_code: type: string example: AFG recipient: type: object properties: address_line_1: type: string example: '123 Main St' address_line_2: type: string example: 'Gate 1' postal_code: type: string example: '12345' city: type: string example: Anytown country: type: object properties: id: type: integer example: 1 name: type: string example: Afghanistan alpha_2_code: type: string example: AF alpha_3_code: type: string example: AFG extern_client_number: type: string example: '1234567890' 401: description: unauthenticated content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Company Authentication' '/api/warespace/v1/company/ecl/orders/outbound/{order}/status/{status}': post: summary: 'Update status' operationId: updateStatus description: 'This endpoint updates the status of an outbound order.' parameters: [] responses: 200: description: success content: application/json: schema: type: object example: data: ok properties: data: type: string example: ok 401: description: unauthenticated content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: 'not found' content: application/json: schema: type: object example: message: 'Order not found' properties: message: type: string example: 'Order not found' 422: description: 'validation failed' content: application/json: schema: type: object example: message: 'Order is in draft status' properties: message: type: string example: 'Order is in draft status' tags: - 'Company Authentication' parameters: - in: path name: order description: 'The order number or id' example: 52000-38103-1 required: true schema: type: string - in: path name: status description: 'The status to set the order to' example: stocked required: true schema: type: string /api/warespace/v1/company/ecl/articles: get: summary: 'Display a listing of all ecl articles' operationId: displayAListingOfAllEclArticles description: 'This endpoint gives you a listing of ecl articles for a company.' parameters: - in: query name: page description: "Current page number. Defaults to '1'." example: 5 required: false schema: type: integer description: "Current page number. Defaults to '1'." example: 5 nullable: false - in: query name: page_size description: "Size of a page. Defaults to '20'. Maximum is 100." example: 20 required: false schema: type: integer description: "Size of a page. Defaults to '20'. Maximum is 100." example: 20 nullable: false responses: 200: description: success content: application/json: schema: type: object example: data: - id: 1 company: id: 1 name: 'Mustermann GmbH' address_line_1: 'Musterstraße 1' address_line_2: Musterhaus postal_code: '12345' city: Musterstadt country: id: 1 name: Afghanistan alpha_2_code: AF alpha_3_code: AFG locale: id: 2 code: en name: English phone: '+49 123 4567890' email: info@mustermann.de billing_email: billing@mustermann.de website: 'https://www.mustermann.de' inbound: id: 1 article_id: 1 abc_indicator: b created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' hazardous: id: 1 created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' packagings: - id: 1 width: 20 height: 20 length: 20 volume: 8000 article_id: 1 net_weight: 1 gross_weight: 1 packaging_level: 1 base_unit_of_measure: pcs quantity_per_packaging_level: 1 created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' volume_unit: cm3 weight_unit: g bestBeforeDate: id: 1 article_id: 1 is_mandatory: true total_shelf_life: 365 minimum_remaining_shelf_life: 30 created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' commodityCodes: - id: 1 article_packaging_id: 1 check_required: false commodity_code: '1234567890' commodity_code_type: gtin created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' dimension_unit: mm short_description: 'Ventilator, 3-speed, 120V' stock_keeping_unit: ABC-12345-S-BL batch_number_management_indicator: false extern_client_number: '1234567890' created_at: '2021-01-01T00:00:00Z' updated_at: '2021-01-01T00:00:00Z' properties: data: type: array example: - id: 1 company: id: 1 name: 'Mustermann GmbH' address_line_1: 'Musterstraße 1' address_line_2: Musterhaus postal_code: '12345' city: Musterstadt country: id: 1 name: Afghanistan alpha_2_code: AF alpha_3_code: AFG locale: id: 2 code: en name: English phone: '+49 123 4567890' email: info@mustermann.de billing_email: billing@mustermann.de website: 'https://www.mustermann.de' inbound: id: 1 article_id: 1 abc_indicator: b created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' hazardous: id: 1 created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' packagings: - id: 1 width: 20 height: 20 length: 20 volume: 8000 article_id: 1 net_weight: 1 gross_weight: 1 packaging_level: 1 base_unit_of_measure: pcs quantity_per_packaging_level: 1 created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' volume_unit: cm3 weight_unit: g bestBeforeDate: id: 1 article_id: 1 is_mandatory: true total_shelf_life: 365 minimum_remaining_shelf_life: 30 created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' commodityCodes: - id: 1 article_packaging_id: 1 check_required: false commodity_code: '1234567890' commodity_code_type: gtin created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' dimension_unit: mm short_description: 'Ventilator, 3-speed, 120V' stock_keeping_unit: ABC-12345-S-BL batch_number_management_indicator: false extern_client_number: '1234567890' created_at: '2021-01-01T00:00:00Z' updated_at: '2021-01-01T00:00:00Z' items: type: object properties: id: type: integer example: 1 company: type: object properties: id: type: integer example: 1 name: type: string example: 'Mustermann GmbH' address_line_1: type: string example: 'Musterstraße 1' address_line_2: type: string example: Musterhaus postal_code: type: string example: '12345' city: type: string example: Musterstadt country: type: object properties: id: type: integer example: 1 name: type: string example: Afghanistan alpha_2_code: type: string example: AF alpha_3_code: type: string example: AFG locale: type: object properties: id: type: integer example: 2 code: type: string example: en name: type: string example: English phone: type: string example: '+49 123 4567890' email: type: string example: info@mustermann.de billing_email: type: string example: billing@mustermann.de website: type: string example: 'https://www.mustermann.de' inbound: type: object properties: id: type: integer example: 1 article_id: type: integer example: 1 abc_indicator: type: string example: b created_at: type: string example: '2021-01-01 00:00:00' updated_at: type: string example: '2021-01-01 00:00:00' hazardous: type: object properties: id: type: integer example: 1 created_at: type: string example: '2021-01-01 00:00:00' updated_at: type: string example: '2021-01-01 00:00:00' packagings: type: array example: - id: 1 width: 20 height: 20 length: 20 volume: 8000 article_id: 1 net_weight: 1 gross_weight: 1 packaging_level: 1 base_unit_of_measure: pcs quantity_per_packaging_level: 1 created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' items: type: object properties: id: type: integer example: 1 width: type: integer example: 20 height: type: integer example: 20 length: type: integer example: 20 volume: type: integer example: 8000 article_id: type: integer example: 1 net_weight: type: integer example: 1 gross_weight: type: integer example: 1 packaging_level: type: integer example: 1 base_unit_of_measure: type: string example: pcs quantity_per_packaging_level: type: integer example: 1 created_at: type: string example: '2021-01-01 00:00:00' updated_at: type: string example: '2021-01-01 00:00:00' volume_unit: type: string example: cm3 weight_unit: type: string example: g bestBeforeDate: type: object properties: id: type: integer example: 1 article_id: type: integer example: 1 is_mandatory: type: boolean example: true total_shelf_life: type: integer example: 365 minimum_remaining_shelf_life: type: integer example: 30 created_at: type: string example: '2021-01-01 00:00:00' updated_at: type: string example: '2021-01-01 00:00:00' commodityCodes: type: array example: - id: 1 article_packaging_id: 1 check_required: false commodity_code: '1234567890' commodity_code_type: gtin created_at: '2021-01-01 00:00:00' updated_at: '2021-01-01 00:00:00' items: type: object properties: id: type: integer example: 1 article_packaging_id: type: integer example: 1 check_required: type: boolean example: false commodity_code: type: string example: '1234567890' commodity_code_type: type: string example: gtin created_at: type: string example: '2021-01-01 00:00:00' updated_at: type: string example: '2021-01-01 00:00:00' dimension_unit: type: string example: mm short_description: type: string example: 'Ventilator, 3-speed, 120V' stock_keeping_unit: type: string example: ABC-12345-S-BL batch_number_management_indicator: type: boolean example: false extern_client_number: type: string example: '1234567890' created_at: type: string example: '2021-01-01T00:00:00Z' updated_at: type: string example: '2021-01-01T00:00:00Z' 401: description: unauthenticated content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Company Authentication' /api/warespace/v1/company/warehouse: get: summary: 'List Warehouses' operationId: listWarehouses description: 'List all warehouses of the authenticated company.' parameters: [] responses: 200: description: 'Successful response' content: application/json: schema: type: object example: data: - id: 5 name: 'Mustermann GmbH, Hermann-Löns-Straße 22, 33104 Paderborn, Deutschland' internal_name: 'Warehouse Paderborn' address: address_line_1: 'Hermann-Löns-Straße 22' address_line_2: null postal_code: '33104' city: Paderborn country: DE locale: id: 1 code: de name: German created_at: '2024-07-19T09:32:15.000000Z' updated_at: '2024-07-19T09:32:15.000000Z' api_identifier: lager-paderborn properties: data: type: array example: - id: 5 name: 'Mustermann GmbH, Hermann-Löns-Straße 22, 33104 Paderborn, Deutschland' internal_name: 'Warehouse Paderborn' address: address_line_1: 'Hermann-Löns-Straße 22' address_line_2: null postal_code: '33104' city: Paderborn country: DE locale: id: 1 code: de name: German created_at: '2024-07-19T09:32:15.000000Z' updated_at: '2024-07-19T09:32:15.000000Z' api_identifier: lager-paderborn items: type: object properties: id: type: integer example: 5 name: type: string example: 'Mustermann GmbH, Hermann-Löns-Straße 22, 33104 Paderborn, Deutschland' internal_name: type: string example: 'Warehouse Paderborn' address: type: object properties: address_line_1: type: string example: 'Hermann-Löns-Straße 22' address_line_2: type: string example: null postal_code: type: string example: '33104' city: type: string example: Paderborn country: type: string example: DE locale: type: object properties: id: type: integer example: 1 code: type: string example: de name: type: string example: German created_at: type: string example: '2024-07-19T09:32:15.000000Z' updated_at: type: string example: '2024-07-19T09:32:15.000000Z' api_identifier: type: string example: lager-paderborn tags: - 'Company Authentication' '/api/warespace/v1/company/warehouse/{warehouse_api_identifier}/capacity': post: summary: 'Create or Update Capacities' operationId: createOrUpdateCapacities description: 'Create or update warehouse capacities for multiple dates.' parameters: [] responses: 200: description: 'Successful response' content: application/json: schema: type: object example: message: 'Capacities created or updated successfully.' properties: message: type: string example: 'Capacities created or updated successfully.' 403: description: Forbidden content: application/json: schema: type: object example: message: 'You are not allowed to access this warehouse.' properties: message: type: string example: 'You are not allowed to access this warehouse.' 422: description: 'Validation error' content: application/json: schema: type: object example: message: 'This field is required if the parent element exists. (und 1 weiterer Fehler)' errors: item.3.bookable.pallet_positions: - 'This field is required if the parent element exists.' item.2.bookable.area_sqm: - 'This field is required if the parent element exists.' properties: message: type: string example: 'This field is required if the parent element exists. (und 1 weiterer Fehler)' errors: type: object properties: item.3.bookable.pallet_positions: type: array example: - 'This field is required if the parent element exists.' items: type: string item.2.bookable.area_sqm: type: array example: - 'This field is required if the parent element exists.' items: type: string tags: - 'Company Authentication' requestBody: required: false content: application/json: schema: type: object properties: item: type: object description: '' example: date: '2025-01-09' nullable: false properties: date: type: date description: 'The date for the capacity entry.' example: '2025-01-09' nullable: false total: type: object description: '' example: pallet_positions: 10000 nullable: false properties: pallet_positions: type: integer description: 'Number of pallet positions in total.' example: 10000 nullable: false area_sqm: type: integer description: 'Area in square meters in total.' example: 9000 nullable: false bookable: type: object description: '' example: pallet_positions: 2000 nullable: false properties: pallet_positions: type: integer description: 'Number of bookable pallet positions.' example: 2000 nullable: false area_sqm: type: integer description: 'Bookable area in square meters.' example: 2000 nullable: false parameters: - in: path name: warehouse_api_identifier description: '' example: esse required: true schema: type: string /api/warespace/v1/company/digital-twin/container/customs: post: summary: 'Customs Webhook' operationId: customsWebhook description: 'This endpoint receives structured customs data from incoming emails (e.g. from customs authorities) and stores them as Customs records for a container.' parameters: [] responses: 200: description: 'Processing successful' content: application/json: schema: type: object example: status: ok properties: status: type: string example: ok 422: description: 'Invalid payload structure' content: application/json: schema: type: object example: error: 'Invalid payload' properties: error: type: string example: 'Invalid payload' tags: - 'Company Authentication' requestBody: required: true content: application/json: schema: type: object properties: data: type: array description: 'Array of two entries: `mailSubject` and `mailBody`, each containing shipping and customs information respectively.' example: - mailSubject: referenceNumber: SAV1234-560000-PO12345678-LO12345678-123456789012 containerNumber: ABCD1234567 registrationCode: 202412-200 statusAccepted: Accepted statusReleased: Released - mailBody: referenceNumber: SAV1234-560000-PO12345678-LO12345678-123456789012 eoriNumber: DE1234567 companyName: 'Mustermann GmbH & Co. KG' containerNumber: ABCD1234567 registrationNumber: 12DE3456ABC789XYZ1 customsOfficeCode: DE123456 customsAgent: System itemNumber: '1' returnIndicatorShort: 'N' acceptanceDate: '123445678' releaseDate: '12345678' releaseTime: '09:28:00' acceptanceIndicator: 'J - Declaration accepted' releaseIndicator: 'J - Goods released' inspectionIndicator: '0 - No inspection' returnIndicatorFull: 'N - Customs declaration not returned' items: type: string required: - data /api/warespace/v1/company/visitor: get: summary: 'List Visitors' operationId: listVisitors description: 'List all warespace visitor events' parameters: - in: query name: page description: "Current page number. Defaults to '1'." example: 5 required: false schema: type: integer description: "Current page number. Defaults to '1'." example: 5 nullable: false - in: query name: page_size description: "Size of a page. Defaults to '20'." example: 20 required: false schema: type: integer description: "Size of a page. Defaults to '20'." example: 20 nullable: false - in: query name: from description: 'Start date (YYYY-MM-DD)' example: '2025-05-08' required: false schema: type: string description: 'Start date (YYYY-MM-DD)' example: '2025-05-08' nullable: false - in: query name: to description: 'End date (YYYY-MM-DD)' example: '2025-05-08' required: false schema: type: string description: 'End date (YYYY-MM-DD)' example: '2025-05-08' nullable: false responses: 200: description: '' content: application/json: schema: type: object example: data: [] '0': 200 '1': 'Successful response' properties: data: type: array example: [] 0: type: integer example: 200 1: type: string example: 'Successful response' 403: description: Unauthorized content: application/json: schema: type: object example: message: 'You are not authorized to access this resource.' properties: message: type: string example: 'You are not authorized to access this resource.' tags: - 'Company Authentication' /api/palletspace/v1/public/transport-offer: get: summary: 'Fetch the prices for the transport offers' operationId: fetchThePricesForTheTransportOffers description: 'This endpoint gives you the prices for the transport offers.' parameters: - in: query name: status description: 'Status to filter by. Possible options are requested, cancelled, inbound, stock, outsourced, quality_issue, fulfilled' example: stock required: false schema: type: string description: 'Status to filter by. Possible options are requested, cancelled, inbound, stock, outsourced, quality_issue, fulfilled' example: stock nullable: false - in: query name: page description: "Current page number. Defaults to '1'." example: 5 required: false schema: type: integer description: "Current page number. Defaults to '1'." example: 5 nullable: false - in: query name: page_size description: "Size of a page. Defaults to '100'." example: 20 required: false schema: type: integer description: "Size of a page. Defaults to '100'." example: 20 nullable: false responses: 200: description: success content: application/json: schema: type: object example: data: id: clvws3283005y4rb67rhcu4c8 costItems: - description: Frachtkosten type: SHIPMENT subtype: null price: amount: 901.89 currency: EUR - description: 'Klimaneutraler Versand / CO2 Offset' type: CLIMATE_NEUTRAL_SURCHARGE subtype: null price: amount: 56.84 currency: EUR pickupOn: '2024-05-27T06:00:00.000Z' pickupAtFrom: '2024-05-27T06:00:00.000Z' pickupAtUntil: '2024-05-29T14:00:00.000Z' price: amount: 958.73 currency: EUR grossAmount: 1140.89 vat: 182.16 priceStandard: amount: 958.73 currency: EUR runtime: daysMin: 5 daysMax: 8 delivery: earliest: '2024-06-03T06:00:00.000Z' latest: '2024-06-06T14:00:00.000Z' product: STANDARD truckType: DIRECT_TRUCK_40 transportType: FULL_LOAD co2Emission: amount: 56.84 value: 2870.68 unit: KG links: - description: 'Get another quotation.' href: 'https://api-sandbox.cargoboard.com/v1/quotations' method: POST rel: self - rel: quotationBook method: POST description: 'Book transport based on this quotation.' href: 'https://api-sandbox.cargoboard.com/v1/quotations/clvws3283005y4rb67rhcu4c8/book' properties: data: type: object properties: id: type: string example: clvws3283005y4rb67rhcu4c8 costItems: type: array example: - description: Frachtkosten type: SHIPMENT subtype: null price: amount: 901.89 currency: EUR - description: 'Klimaneutraler Versand / CO2 Offset' type: CLIMATE_NEUTRAL_SURCHARGE subtype: null price: amount: 56.84 currency: EUR items: type: object properties: description: type: string example: Frachtkosten type: type: string example: SHIPMENT subtype: type: string example: null price: type: object properties: amount: type: number example: 901.89 currency: type: string example: EUR pickupOn: type: string example: '2024-05-27T06:00:00.000Z' pickupAtFrom: type: string example: '2024-05-27T06:00:00.000Z' pickupAtUntil: type: string example: '2024-05-29T14:00:00.000Z' price: type: object properties: amount: type: number example: 958.73 currency: type: string example: EUR grossAmount: type: number example: 1140.89 vat: type: number example: 182.16 priceStandard: type: object properties: amount: type: number example: 958.73 currency: type: string example: EUR runtime: type: object properties: daysMin: type: integer example: 5 daysMax: type: integer example: 8 delivery: type: object properties: earliest: type: string example: '2024-06-03T06:00:00.000Z' latest: type: string example: '2024-06-06T14:00:00.000Z' product: type: string example: STANDARD truckType: type: string example: DIRECT_TRUCK_40 transportType: type: string example: FULL_LOAD co2Emission: type: object properties: amount: type: number example: 56.84 value: type: number example: 2870.68 unit: type: string example: KG links: type: array example: - description: 'Get another quotation.' href: 'https://api-sandbox.cargoboard.com/v1/quotations' method: POST rel: self - rel: quotationBook method: POST description: 'Book transport based on this quotation.' href: 'https://api-sandbox.cargoboard.com/v1/quotations/clvws3283005y4rb67rhcu4c8/book' items: type: object properties: description: type: string example: 'Get another quotation.' href: type: string example: 'https://api-sandbox.cargoboard.com/v1/quotations' method: type: string example: POST rel: type: string example: self 422: description: 'unprocessable entity' content: application/json: schema: type: object example: message: 'The given loads are too heavy. Up to 24000 kg are allowed, but 29700 kg were given.' error: 'Unprocessable Entity' statusCode: 422 properties: message: type: string example: 'The given loads are too heavy. Up to 24000 kg are allowed, but 29700 kg were given.' error: type: string example: 'Unprocessable Entity' statusCode: type: integer example: 422 tags: - Public /api/warespace/v1/public/warehouses: get: summary: 'Display a listing of the Warehouses' operationId: displayAListingOfTheWarehouses description: 'This endpoint gives you all the warehouses.' parameters: - in: query name: page description: "Current page number. Defaults to '1'." example: 5 required: false schema: type: integer description: "Current page number. Defaults to '1'." example: 5 nullable: false - in: query name: page_size description: "Size of a page. Defaults to '100'." example: 20 required: false schema: type: integer description: "Size of a page. Defaults to '100'." example: 20 nullable: false - in: query name: postal_code description: "Postal code to filter by. Defaults to 'null'." example: 12345 required: false schema: type: string description: "Postal code to filter by. Defaults to 'null'." example: 12345 nullable: false - in: query name: ids description: "Ids to filter by. Defaults to 'null'." example: - 1 - 2 required: false schema: type: array description: "Ids to filter by. Defaults to 'null'." example: - 1 - 2 items: type: integer - in: query name: pattern description: "Pattern to filter by. Defaults to 'null'." example: 'Logistikzentrum Leipzig' required: false schema: type: string description: "Pattern to filter by. Defaults to 'null'." example: 'Logistikzentrum Leipzig' nullable: false - in: query name: pallet_height description: "Pallet height to filter by. Defaults to 'null'." example: '120' required: false schema: type: integer description: "Pallet height to filter by. Defaults to 'null'." example: '120' nullable: false - in: query name: inbound description: "Inbound date to filter by (Y-m-d). Defaults to 'null'." example: '2024-02-01' required: false schema: type: string description: "Inbound date to filter by (Y-m-d). Defaults to 'null'." example: '2024-02-01' nullable: false - in: query name: outbound description: "Outbound date to filter by (Y-m-d). Defaults to 'null'." example: '2024-02-02' required: false schema: type: string description: "Outbound date to filter by (Y-m-d). Defaults to 'null'." example: '2024-02-02' nullable: false - in: query name: voucher description: "Voucher code which will be applied to the prices. Defaults to 'null'." example: CARGOBOARD15 required: false schema: type: string description: "Voucher code which will be applied to the prices. Defaults to 'null'." example: CARGOBOARD15 nullable: false - in: query name: quantity description: "Quantity to filter by. Defaults to '1'." example: 10 required: false schema: type: integer description: "Quantity to filter by. Defaults to '1'." example: 10 nullable: false responses: 200: description: success content: application/json: schema: type: object example: data: - id: 1 name: 'Born Steiner AG & Co. KGaB' zip: '25735' city: Celle country: DE capacity: 821 inboundPrice: 16.94 highRackStorageFee: 6.87 blockStorageFee: 0.5 outboundPrice: 12.51 geometry: coordinates: - 51.710762 - 15.386749 properties: maxPalletHeightInRackStorage: 86 maxPalletWeightInRackStorage: 182 maxPalletLengthInRackStorage: 1200 maxPalletWidthInRackStorage: 800 maxPalletPositionsPalletspace: 1000 visibility: isActiveLocationProfile: false locationProfileUrl: is_active_location_profile: true has_media_warehouse_images: true slug_company: guenther-gmbh slug_warehouse: region-wolfsburg features: - barrier-free - forklift - ramp - id: 2 name: 'Günther GmbH' zip: '04088' city: Wolfsburg country: DE capacity: 592 inboundPrice: 27.16 highRackStorageFee: 0.37 blockStorageFee: 0.5 outboundPrice: 79.58 geometry: coordinates: - 54.775493 - 14.573208 properties: maxPalletHeightInRackStorage: 86 maxPalletWeightInRackStorage: 182 maxPalletLengthInRackStorage: 1200 maxPalletWidthInRackStorage: 800 maxPalletPositionsPalletspace: 1000 visibility: isActiveLocationProfile: true locationProfileUrl: is_active_location_profile: true has_media_warehouse_images: true slug_company: guenther-gmbh slug_warehouse: region-wolfsburg features: - sprinkler - alarm - camera properties: data: type: array example: - id: 1 name: 'Born Steiner AG & Co. KGaB' zip: '25735' city: Celle country: DE capacity: 821 inboundPrice: 16.94 highRackStorageFee: 6.87 blockStorageFee: 0.5 outboundPrice: 12.51 geometry: coordinates: - 51.710762 - 15.386749 properties: maxPalletHeightInRackStorage: 86 maxPalletWeightInRackStorage: 182 maxPalletLengthInRackStorage: 1200 maxPalletWidthInRackStorage: 800 maxPalletPositionsPalletspace: 1000 visibility: isActiveLocationProfile: false locationProfileUrl: is_active_location_profile: true has_media_warehouse_images: true slug_company: guenther-gmbh slug_warehouse: region-wolfsburg features: - barrier-free - forklift - ramp - id: 2 name: 'Günther GmbH' zip: '04088' city: Wolfsburg country: DE capacity: 592 inboundPrice: 27.16 highRackStorageFee: 0.37 blockStorageFee: 0.5 outboundPrice: 79.58 geometry: coordinates: - 54.775493 - 14.573208 properties: maxPalletHeightInRackStorage: 86 maxPalletWeightInRackStorage: 182 maxPalletLengthInRackStorage: 1200 maxPalletWidthInRackStorage: 800 maxPalletPositionsPalletspace: 1000 visibility: isActiveLocationProfile: true locationProfileUrl: is_active_location_profile: true has_media_warehouse_images: true slug_company: guenther-gmbh slug_warehouse: region-wolfsburg features: - sprinkler - alarm - camera items: type: object properties: id: type: integer example: 1 name: type: string example: 'Born Steiner AG & Co. KGaB' zip: type: string example: '25735' city: type: string example: Celle country: type: string example: DE capacity: type: integer example: 821 inboundPrice: type: number example: 16.94 highRackStorageFee: type: number example: 6.87 blockStorageFee: type: number example: 0.5 outboundPrice: type: number example: 12.51 geometry: type: object properties: coordinates: type: array example: - 51.710762 - 15.386749 items: type: number properties: type: object properties: maxPalletHeightInRackStorage: type: integer example: 86 maxPalletWeightInRackStorage: type: integer example: 182 maxPalletLengthInRackStorage: type: integer example: 1200 maxPalletWidthInRackStorage: type: integer example: 800 maxPalletPositionsPalletspace: type: integer example: 1000 visibility: type: object properties: isActiveLocationProfile: type: boolean example: false locationProfileUrl: type: object properties: is_active_location_profile: type: boolean example: true has_media_warehouse_images: type: boolean example: true slug_company: type: string example: guenther-gmbh slug_warehouse: type: string example: region-wolfsburg features: type: array example: - barrier-free - forklift - ramp items: type: string 400: description: 'bad request' content: application/json: schema: type: object example: error: page: - 'The page field must be at least 1.' page_size: - 'The page size field must be at least 1.' properties: error: type: object properties: page: type: array example: - 'The page field must be at least 1.' items: type: string page_size: type: array example: - 'The page size field must be at least 1.' items: type: string 500: description: 'internal server error' content: application/json: schema: type: object example: error: 'The server has missing file permissions.' properties: error: type: string example: 'The server has missing file permissions.' tags: - Public security: [] /api/warespace/v1/public/nearest-warehouses: get: summary: 'Display a listing of the nearest Warehouses' operationId: displayAListingOfTheNearestWarehouses description: 'This endpoint gives you all the nearest warehouses.' parameters: - in: query name: page description: "Current page number. Defaults to '1'." example: 5 required: false schema: type: integer description: "Current page number. Defaults to '1'." example: 5 nullable: false - in: query name: page_size description: "Size of a page. Defaults to '100'." example: 20 required: false schema: type: integer description: "Size of a page. Defaults to '100'." example: 20 nullable: false - in: query name: postal_code description: "Postal code to filter by. Defaults to 'null'." example: 12345 required: false schema: type: string description: "Postal code to filter by. Defaults to 'null'." example: 12345 nullable: false - in: query name: ids description: "Ids to filter by. Defaults to 'null'." example: - 1 - 2 required: false schema: type: array description: "Ids to filter by. Defaults to 'null'." example: - 1 - 2 items: type: integer - in: query name: pattern description: "Pattern to filter by. Defaults to 'null'." example: 'Logistikzentrum Leipzig' required: false schema: type: string description: "Pattern to filter by. Defaults to 'null'." example: 'Logistikzentrum Leipzig' nullable: false - in: query name: pallet_height description: "Pallet height to filter by. Defaults to 'null'." example: '120' required: false schema: type: integer description: "Pallet height to filter by. Defaults to 'null'." example: '120' nullable: false - in: query name: inbound description: "Inbound date to filter by (Y-m-d). Defaults to 'null'." example: '2024-02-01' required: false schema: type: string description: "Inbound date to filter by (Y-m-d). Defaults to 'null'." example: '2024-02-01' nullable: false - in: query name: outbound description: "Outbound date to filter by (Y-m-d). Defaults to 'null'." example: '2024-02-02' required: false schema: type: string description: "Outbound date to filter by (Y-m-d). Defaults to 'null'." example: '2024-02-02' nullable: false - in: query name: quantity description: "Quantity to filter by. Defaults to '1'." example: 10 required: false schema: type: integer description: "Quantity to filter by. Defaults to '1'." example: 10 nullable: false responses: 200: description: success content: application/json: schema: type: object example: data: - id: 1 name: 'Born Steiner AG & Co. KGaB' zip: '25735' city: Celle country: DE capacity: 821 inboundPrice: 16.94 highRackStorageFee: 6.87 blockStorageFee: 0.5 outboundPrice: 12.51 geometry: coordinates: - 51.710762 - 15.386749 properties: maxPalletHeightInRackStorage: 86 maxPalletWeightInRackStorage: 182 maxPalletLengthInRackStorage: 1200 maxPalletWidthInRackStorage: 800 maxPalletPositionsPalletspace: 1000 visibility: isActiveLocationProfile: false locationProfileUrl: is_active_location_profile: true has_media_warehouse_images: true slug_company: guenther-gmbh slug_warehouse: region-wolfsburg features: - heatable - sprinkler - alarm - id: 2 name: 'Günther GmbH' zip: '04088' city: Wolfsburg country: DE capacity: 592 inboundPrice: 27.16 highRackStorageFee: 0.37 blockStorageFee: 0.5 outboundPrice: 79.58 geometry: coordinates: - 54.775493 - 14.573208 properties: maxPalletHeightInRackStorage: 86 maxPalletWeightInRackStorage: 182 maxPalletLengthInRackStorage: 1200 maxPalletWidthInRackStorage: 800 maxPalletPositionsPalletspace: 1000 visibility: isActiveLocationProfile: true locationProfileUrl: is_active_location_profile: true has_media_warehouse_images: true slug_company: guenther-gmbh slug_warehouse: region-wolfsburg features: - sprinkler - alarm - camera properties: data: type: array example: - id: 1 name: 'Born Steiner AG & Co. KGaB' zip: '25735' city: Celle country: DE capacity: 821 inboundPrice: 16.94 highRackStorageFee: 6.87 blockStorageFee: 0.5 outboundPrice: 12.51 geometry: coordinates: - 51.710762 - 15.386749 properties: maxPalletHeightInRackStorage: 86 maxPalletWeightInRackStorage: 182 maxPalletLengthInRackStorage: 1200 maxPalletWidthInRackStorage: 800 maxPalletPositionsPalletspace: 1000 visibility: isActiveLocationProfile: false locationProfileUrl: is_active_location_profile: true has_media_warehouse_images: true slug_company: guenther-gmbh slug_warehouse: region-wolfsburg features: - heatable - sprinkler - alarm - id: 2 name: 'Günther GmbH' zip: '04088' city: Wolfsburg country: DE capacity: 592 inboundPrice: 27.16 highRackStorageFee: 0.37 blockStorageFee: 0.5 outboundPrice: 79.58 geometry: coordinates: - 54.775493 - 14.573208 properties: maxPalletHeightInRackStorage: 86 maxPalletWeightInRackStorage: 182 maxPalletLengthInRackStorage: 1200 maxPalletWidthInRackStorage: 800 maxPalletPositionsPalletspace: 1000 visibility: isActiveLocationProfile: true locationProfileUrl: is_active_location_profile: true has_media_warehouse_images: true slug_company: guenther-gmbh slug_warehouse: region-wolfsburg features: - sprinkler - alarm - camera items: type: object properties: id: type: integer example: 1 name: type: string example: 'Born Steiner AG & Co. KGaB' zip: type: string example: '25735' city: type: string example: Celle country: type: string example: DE capacity: type: integer example: 821 inboundPrice: type: number example: 16.94 highRackStorageFee: type: number example: 6.87 blockStorageFee: type: number example: 0.5 outboundPrice: type: number example: 12.51 geometry: type: object properties: coordinates: type: array example: - 51.710762 - 15.386749 items: type: number properties: type: object properties: maxPalletHeightInRackStorage: type: integer example: 86 maxPalletWeightInRackStorage: type: integer example: 182 maxPalletLengthInRackStorage: type: integer example: 1200 maxPalletWidthInRackStorage: type: integer example: 800 maxPalletPositionsPalletspace: type: integer example: 1000 visibility: type: object properties: isActiveLocationProfile: type: boolean example: false locationProfileUrl: type: object properties: is_active_location_profile: type: boolean example: true has_media_warehouse_images: type: boolean example: true slug_company: type: string example: guenther-gmbh slug_warehouse: type: string example: region-wolfsburg features: type: array example: - heatable - sprinkler - alarm items: type: string 500: description: 'internal server error' content: application/json: schema: type: object example: error: 'The server has missing file permissions.' properties: error: type: string example: 'The server has missing file permissions.' tags: - Public security: [] /api/warespace/v1/public/warehouse-coordinates: get: summary: 'Display a listing of the Warehouse Coordinates' operationId: displayAListingOfTheWarehouseCoordinates description: 'This endpoint gives you the coordinates of all the warehouses.' parameters: - in: query name: page description: "Current page number. Defaults to '1'." example: 5 required: false schema: type: integer description: "Current page number. Defaults to '1'." example: 5 nullable: false - in: query name: page_size description: "Size of a page. Defaults to '100'." example: 20 required: false schema: type: integer description: "Size of a page. Defaults to '100'." example: 20 nullable: false responses: 200: description: success content: application/json: schema: type: object example: data: coordinates: lat: 49.729915 lng: 11.9233 address: name: 'Warehouse 1' address_line_1: 'Hauptstraße 1' city: Nürnberg zip: '90478' country: DE company: name: 'Mustermann GmbH' locationProfileUrl: is_active_location_profile: true has_media_warehouse_images: true slug_company: guenther-gmbh slug_warehouse: region-wolfsburg properties: data: type: object properties: coordinates: type: object properties: lat: type: number example: 49.729915 lng: type: number example: 11.9233 address: type: object properties: name: type: string example: 'Warehouse 1' address_line_1: type: string example: 'Hauptstraße 1' city: type: string example: Nürnberg zip: type: string example: '90478' country: type: string example: DE company: type: object properties: name: type: string example: 'Mustermann GmbH' locationProfileUrl: type: object properties: is_active_location_profile: type: boolean example: true has_media_warehouse_images: type: boolean example: true slug_company: type: string example: guenther-gmbh slug_warehouse: type: string example: region-wolfsburg 400: description: 'user not found' content: application/json: schema: type: object example: error: page: - 'The page field must be at least 1.' page_size: - 'The page size field must be at least 1.' properties: error: type: object properties: page: type: array example: - 'The page field must be at least 1.' items: type: string page_size: type: array example: - 'The page size field must be at least 1.' items: type: string 500: description: 'internal server error' content: application/json: schema: type: object example: error: 'The server has missing file permissions.' properties: error: type: string example: 'The server has missing file permissions.' tags: - Public security: [] /api/warespace/v1/public/company-partners: get: summary: 'Display a listing of the Partner Companies.' operationId: displayAListingOfThePartnerCompanies description: 'This endpoint gives you all the partner companies.' parameters: - in: query name: page description: "Current page number. Defaults to '1'." example: 1 required: false schema: type: integer description: "Current page number. Defaults to '1'." example: 1 nullable: false - in: query name: page_size description: "Size of a page. Defaults to '100'." example: 20 required: false schema: type: integer description: "Size of a page. Defaults to '100'." example: 20 nullable: false - in: query name: ids description: "Ids to filter by. Defaults to 'null'." example: - 1 - 2 required: false schema: type: array description: "Ids to filter by. Defaults to 'null'." example: - 1 - 2 items: type: integer responses: 200: description: success content: application/json: schema: type: object example: data: - id: 1 name: 'Lagerhaus Celle' slug: lagerhaus-celle media: - id: 1 url: 'https://example.com/image.svg' - id: 2 name: 'Lagerhaus an der Elbe' slug: lagerhaus-an-der-elbe media: - id: 2 url: 'https://example.com/logo.svg' properties: data: type: array example: - id: 1 name: 'Lagerhaus Celle' slug: lagerhaus-celle media: - id: 1 url: 'https://example.com/image.svg' - id: 2 name: 'Lagerhaus an der Elbe' slug: lagerhaus-an-der-elbe media: - id: 2 url: 'https://example.com/logo.svg' items: type: object properties: id: type: integer example: 1 name: type: string example: 'Lagerhaus Celle' slug: type: string example: lagerhaus-celle media: type: array example: - id: 1 url: 'https://example.com/image.svg' items: type: object properties: id: type: integer example: 1 url: type: string example: 'https://example.com/image.svg' 400: description: 'bad request' content: application/json: schema: type: object example: error: page: - 'The page field must be at least 1.' page_size: - 'The page size field must be at least 1.' properties: error: type: object properties: page: type: array example: - 'The page field must be at least 1.' items: type: string page_size: type: array example: - 'The page size field must be at least 1.' items: type: string 500: description: 'internal server error' content: application/json: schema: type: object example: error: 'The server has missing file permissions.' properties: error: type: string example: 'The server has missing file permissions.' tags: - Public security: [] /api/warespace/v1/public/general-stats: get: summary: Chart operationId: chart description: 'Monthly chart of companies, warehouses, users and orders' parameters: [] responses: 200: description: success content: application/json: schema: type: object example: data: companies: - count: 31 date: 2024-05 - count: 40 date: 2024-06 warehouses: - count: 31 date: 2024-05 - count: 40 date: 2024-06 users: - count: 31 date: 2024-05 - count: 40 date: 2024-06 orders: - count: 31 date: 2024-05 - count: 40 date: 2024-06 warehouseCapacity: 08.07.2024: 1000 09.07.2024: 1500 10.07.2024: 2000 properties: data: type: object properties: companies: type: array example: - count: 31 date: 2024-05 - count: 40 date: 2024-06 items: type: object properties: count: type: integer example: 31 date: type: string example: 2024-05 warehouses: type: array example: - count: 31 date: 2024-05 - count: 40 date: 2024-06 items: type: object properties: count: type: integer example: 31 date: type: string example: 2024-05 users: type: array example: - count: 31 date: 2024-05 - count: 40 date: 2024-06 items: type: object properties: count: type: integer example: 31 date: type: string example: 2024-05 orders: type: array example: - count: 31 date: 2024-05 - count: 40 date: 2024-06 items: type: object properties: count: type: integer example: 31 date: type: string example: 2024-05 warehouseCapacity: type: object properties: 08.07.2024: type: integer example: 1000 09.07.2024: type: integer example: 1500 10.07.2024: type: integer example: 2000 500: description: 'internal server error' content: application/json: schema: type: object example: error: 'The server has missing file permissions.' properties: error: type: string example: 'The server has missing file permissions.' tags: - Public security: [] /api/warespace/v1/public/locales: get: summary: 'Display a listing of the Locales' operationId: displayAListingOfTheLocales description: 'This endpoint gives you all the locales.' parameters: [] responses: 200: description: success content: application/json: schema: type: object example: data: - code: de name: Deutsch flag: 'https://www.example.com/flag-de.svg' default: true - code: en name: English flag: 'https://www.example.com/flag-en.svg' default: false properties: data: type: array example: - code: de name: Deutsch flag: 'https://www.example.com/flag-de.svg' default: true - code: en name: English flag: 'https://www.example.com/flag-en.svg' default: false items: type: object properties: code: type: string example: de name: type: string example: Deutsch flag: type: string example: 'https://www.example.com/flag-de.svg' default: type: boolean example: true 500: description: 'internal server error' content: application/json: schema: type: object example: error: 'The server has missing file permissions.' properties: error: type: string example: 'The server has missing file permissions.' tags: - Public security: [] /api/warespace/v1/public/load-carrier-types: get: summary: 'Display a listing of the load carrier types.' operationId: displayAListingOfTheLoadCarrierTypes description: 'This endpoint gives you all the load carrier types.' parameters: [] responses: 200: description: success content: application/json: schema: type: object example: data: - name: euro_pallet value: 'Euro pallet' - name: half_pallet value: 'Half pallet' - name: pallet_cage value: 'Pallet cage' - name: one_way_pallet value: 'One way pallet' - name: wood_box_or_flight_case value: 'Wood box or flight case' properties: data: type: array example: - name: euro_pallet value: 'Euro pallet' - name: half_pallet value: 'Half pallet' - name: pallet_cage value: 'Pallet cage' - name: one_way_pallet value: 'One way pallet' - name: wood_box_or_flight_case value: 'Wood box or flight case' items: type: object properties: name: type: string example: euro_pallet value: type: string example: 'Euro pallet' 500: description: 'internal server error' content: application/json: schema: type: object example: error: 'The server has missing file permissions.' properties: error: type: string example: 'The server has missing file permissions.' tags: - Public security: [] /api/warespace/v1/public/contact-request: post: summary: 'Store a contact request' operationId: storeAContactRequest description: 'This endpoint allows you to store a contact request. Use "Accept-Language" header to specify the language of the email, which the user will receive.' parameters: - in: header name: Accept-Language description: '' example: de schema: type: string responses: 200: description: success content: application/json: schema: type: object example: data: ok properties: data: type: string example: ok 422: description: 'validation error' content: application/json: schema: type: object example: message: 'Das Feld name ist erforderlich.' errors: name: - 'Das Feld name ist erforderlich.' properties: message: type: string example: 'Das Feld name ist erforderlich.' errors: type: object properties: name: type: array example: - 'Das Feld name ist erforderlich.' items: type: string tags: - Public requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: 'Name of the person making the request' example: 'Max Mustermann' nullable: false email: type: string description: 'Email of the person making the request' example: max@mustermann.de nullable: false message: type: string description: 'Message of the person making the request' example: 'I would like to know more about your services' nullable: false preferred_contact_method: type: string description: 'Preferred contact method of the person making the request' example: email nullable: false enum: - email - phone phone: type: string description: 'Phone number of the person making the request' example: '+49123456789' nullable: false company_name: type: string description: 'Company name of the person making the request' example: 'Example Inc.' nullable: false required: - name - email - message security: [] /api/warespace/v1/public/newsletter: post: summary: 'Store a newsletter request' operationId: storeANewsletterRequest description: 'This endpoint allows you to store a contact in the newsletter model. Use "Accept-Language" header to specify the locale.' parameters: - in: header name: Accept-Language description: '' example: de schema: type: string responses: 200: description: success content: application/json: schema: type: object example: data: ok properties: data: type: string example: ok 422: description: 'validation error' content: application/json: schema: type: object example: message: 'Das Feld email ist erforderlich.' errors: name: - 'Das Feld email ist erforderlich.' properties: message: type: string example: 'Das Feld email ist erforderlich.' errors: type: object properties: name: type: array example: - 'Das Feld email ist erforderlich.' items: type: string tags: - Public requestBody: required: true content: application/json: schema: type: object properties: email: type: string description: 'Email of the person making the request' example: max@mustermann.de nullable: false name: type: string description: 'Name of the person making the request' example: 'Max Mustermann' nullable: false purpose: type: string description: 'Used to define a category' example: 'Waiting list for external logisticians' nullable: false enum: - 'Waiting list for external logisticians' - Warespace - Palletspace metadata: type: string description: 'Additional information' example: 'This email is used as support mail' nullable: false companyName: type: string description: '' example: qui nullable: true phone: type: string description: 'Phone number of the person making the request' example: '+49123456789' nullable: false company_name: type: string description: 'Name of the company' example: 'Mustermann GmbH' nullable: false required: - email - purpose security: [] /api/warespace/v1/public/blog: get: summary: 'Display a listing of all blog posts' operationId: displayAListingOfAllBlogPosts description: 'This endpoint gives you a listing of all blog posts.' parameters: - in: query name: page description: "Current page number. Defaults to '1'." example: 5 required: false schema: type: integer description: "Current page number. Defaults to '1'." example: 5 nullable: false - in: query name: page_size description: "Size of a page. Defaults to '100'." example: 20 required: false schema: type: integer description: "Size of a page. Defaults to '100'." example: 20 nullable: false - in: query name: locale description: 'Locale of the blog posts: de, en, etc.' example: de required: false schema: type: string description: 'Locale of the blog posts: de, en, etc.' example: de nullable: false - in: header name: Accept-Language description: '' example: de schema: type: string responses: 200: description: success content: application/json: schema: type: object example: data: - id: 1 title: 'Lerne mehr über Logistik-Strategien' description: 'Erfahre mehr über die neuesten Logistik-Strategien und wie du sie für dein Unternehmen nutzen kannst.' imageUrl: 'https://example.com/image.jpg' datetime: 'd.m.Y H:i:s' href: 'https://example.com/blog/1' - id: 2 title: 'Die Zukunft der Logistik' description: 'Erfahre mehr über die Zukunft der Logistik und wie du dich darauf vorbereiten kannst.' imageUrl: 'https://example.com/image.jpg' datetime: 'd.m.Y H:i:s' href: 'https://example.com/blog/2' - id: 3 title: 'Die Vorteile von Logistik-Software' description: 'Erfahre mehr über die Vorteile von Logistik-Software und wie sie dein Unternehmen verbessern kann.' imageUrl: 'https://example.com/image.jpg' datetime: 'd.m.Y H:i:s' href: 'https://example.com/blog/3' properties: data: type: array example: - id: 1 title: 'Lerne mehr über Logistik-Strategien' description: 'Erfahre mehr über die neuesten Logistik-Strategien und wie du sie für dein Unternehmen nutzen kannst.' imageUrl: 'https://example.com/image.jpg' datetime: 'd.m.Y H:i:s' href: 'https://example.com/blog/1' - id: 2 title: 'Die Zukunft der Logistik' description: 'Erfahre mehr über die Zukunft der Logistik und wie du dich darauf vorbereiten kannst.' imageUrl: 'https://example.com/image.jpg' datetime: 'd.m.Y H:i:s' href: 'https://example.com/blog/2' - id: 3 title: 'Die Vorteile von Logistik-Software' description: 'Erfahre mehr über die Vorteile von Logistik-Software und wie sie dein Unternehmen verbessern kann.' imageUrl: 'https://example.com/image.jpg' datetime: 'd.m.Y H:i:s' href: 'https://example.com/blog/3' items: type: object properties: id: type: integer example: 1 title: type: string example: 'Lerne mehr über Logistik-Strategien' description: type: string example: 'Erfahre mehr über die neuesten Logistik-Strategien und wie du sie für dein Unternehmen nutzen kannst.' imageUrl: type: string example: 'https://example.com/image.jpg' datetime: type: string example: 'd.m.Y H:i:s' href: type: string example: 'https://example.com/blog/1' 400: description: 'bad request' content: application/json: schema: type: object example: error: page: - 'The page field must be at least 1.' page_size: - 'The page size field must be at least 1.' properties: error: type: object properties: page: type: array example: - 'The page field must be at least 1.' items: type: string page_size: type: array example: - 'The page size field must be at least 1.' items: type: string 500: description: 'internal server error' content: application/json: schema: type: object example: error: 'The server has missing file permissions.' properties: error: type: string example: 'The server has missing file permissions.' tags: - Public requestBody: required: false content: application/json: schema: type: object properties: page: type: integer description: 'Das Feld value muss mindestens 1 sein.' example: 20 nullable: false page_size: type: integer description: 'Das Feld value muss mindestens 1 sein.' example: 4 nullable: false security: [] /api/palletspace/v1/user/orders: get: summary: 'Display a listing of all orders' operationId: displayAListingOfAllOrders description: 'This endpoint gives you a listing of the palletspace orders for a user.' parameters: - in: query name: status description: 'Status to filter by. Possible options are requested, cancelled, inbound, stock, outsourced, quality_issue, fulfilled' example: stock required: false schema: type: string description: 'Status to filter by. Possible options are requested, cancelled, inbound, stock, outsourced, quality_issue, fulfilled' example: stock nullable: false - in: query name: page description: "Current page number. Defaults to '1'." example: 5 required: false schema: type: integer description: "Current page number. Defaults to '1'." example: 5 nullable: false - in: query name: page_size description: "Size of a page. Defaults to '100'." example: 20 required: false schema: type: integer description: "Size of a page. Defaults to '100'." example: 20 nullable: false responses: 200: description: success content: application/json: schema: type: object example: data: - id: 1 orderNumber: 1722-0885-5626 orderNumberUUID: 6b885e57-c75a-3452-a067-9c2825fbab8b createdAt: '2021-09-17' createdBy: 'John Doe' warehouses: - id: 24 name: 'Location Name A' urlSlug: location-name-a pallets: 12344 inboundDate: '2021-10-01' outboundDate: '2021-10-02' status: label: Stock value: stock transport: status: label: Requested value: requested canCancel: true cancelHasExpired: true - id: 45 name: 'Location Name B' urlSlug: location-name-b pallets: 233 inboundDate: '2023-01-31' outboundDate: '2023-07-08' status: label: Stock value: stock transport: status: label: Requested value: requested canCancel: true cancelHasExpired: true - id: 657 name: 'Location Name C' urlSlug: location-name-c pallets: 233 inboundDate: '2023-10-01' outboundDate: '2023-11-20' status: label: Stock value: stock transport: status: label: Requested value: requested canCancel: true cancelHasExpired: true canCancel: true cancelHasExpired: true - id: 2 orderNumber: 1722-0885-5626 orderNumberUUID: 6b885e57-c75a-3452-a067-9c2825fbab8b createdAt: '2023-08-29' createdBy: 'Jane Doe' warehouses: - id: 767 name: 'Location Name A' urlSlug: location-name-a pallets: 12344 inboundDate: '2021-10-01' outboundDate: '2021-10-02' status: label: Stock value: stock transport: status: label: Requested value: requested canCancel: true cancelHasExpired: true canCancel: true cancelHasExpired: true - id: 3 orderNumber: 1722-0885-5626 orderNumberUUID: 6b885e57-c75a-3452-a067-9c2825fbab8b createdAt: '2021-09-12' createdBy: 'John Doe' warehouses: - id: 8 name: 'Location Name A' urlSlug: location-name-a pallets: 12344 inboundDate: '2020-09-31' outboundDate: '2021-10-09' status: label: Stock value: stock transport: status: label: Requested value: requested canCancel: true cancelHasExpired: true - id: 96 name: 'Location Name B' urlSlug: location-name-b pallets: 233 inboundDate: '2023-04-01' outboundDate: '2023-07-07' status: label: Stock value: stock transport: status: label: Requested value: requested canCancel: true cancelHasExpired: true - id: 2 name: 'Location Name C' urlSlug: location-name-c pallets: 233 inboundDate: '2023-10-01' outboundDate: '2023-11-20' status: label: Stock value: stock transport: status: label: Requested value: requested canCancel: true cancelHasExpired: true canCancel: true cancelHasExpired: true properties: data: type: array example: - id: 1 orderNumber: 1722-0885-5626 orderNumberUUID: 6b885e57-c75a-3452-a067-9c2825fbab8b createdAt: '2021-09-17' createdBy: 'John Doe' warehouses: - id: 24 name: 'Location Name A' urlSlug: location-name-a pallets: 12344 inboundDate: '2021-10-01' outboundDate: '2021-10-02' status: label: Stock value: stock transport: status: label: Requested value: requested canCancel: true cancelHasExpired: true - id: 45 name: 'Location Name B' urlSlug: location-name-b pallets: 233 inboundDate: '2023-01-31' outboundDate: '2023-07-08' status: label: Stock value: stock transport: status: label: Requested value: requested canCancel: true cancelHasExpired: true - id: 657 name: 'Location Name C' urlSlug: location-name-c pallets: 233 inboundDate: '2023-10-01' outboundDate: '2023-11-20' status: label: Stock value: stock transport: status: label: Requested value: requested canCancel: true cancelHasExpired: true canCancel: true cancelHasExpired: true - id: 2 orderNumber: 1722-0885-5626 orderNumberUUID: 6b885e57-c75a-3452-a067-9c2825fbab8b createdAt: '2023-08-29' createdBy: 'Jane Doe' warehouses: - id: 767 name: 'Location Name A' urlSlug: location-name-a pallets: 12344 inboundDate: '2021-10-01' outboundDate: '2021-10-02' status: label: Stock value: stock transport: status: label: Requested value: requested canCancel: true cancelHasExpired: true canCancel: true cancelHasExpired: true - id: 3 orderNumber: 1722-0885-5626 orderNumberUUID: 6b885e57-c75a-3452-a067-9c2825fbab8b createdAt: '2021-09-12' createdBy: 'John Doe' warehouses: - id: 8 name: 'Location Name A' urlSlug: location-name-a pallets: 12344 inboundDate: '2020-09-31' outboundDate: '2021-10-09' status: label: Stock value: stock transport: status: label: Requested value: requested canCancel: true cancelHasExpired: true - id: 96 name: 'Location Name B' urlSlug: location-name-b pallets: 233 inboundDate: '2023-04-01' outboundDate: '2023-07-07' status: label: Stock value: stock transport: status: label: Requested value: requested canCancel: true cancelHasExpired: true - id: 2 name: 'Location Name C' urlSlug: location-name-c pallets: 233 inboundDate: '2023-10-01' outboundDate: '2023-11-20' status: label: Stock value: stock transport: status: label: Requested value: requested canCancel: true cancelHasExpired: true canCancel: true cancelHasExpired: true items: type: object properties: id: type: integer example: 1 orderNumber: type: string example: 1722-0885-5626 orderNumberUUID: type: string example: 6b885e57-c75a-3452-a067-9c2825fbab8b createdAt: type: string example: '2021-09-17' createdBy: type: string example: 'John Doe' warehouses: type: array example: - id: 24 name: 'Location Name A' urlSlug: location-name-a pallets: 12344 inboundDate: '2021-10-01' outboundDate: '2021-10-02' status: label: Stock value: stock transport: status: label: Requested value: requested canCancel: true cancelHasExpired: true - id: 45 name: 'Location Name B' urlSlug: location-name-b pallets: 233 inboundDate: '2023-01-31' outboundDate: '2023-07-08' status: label: Stock value: stock transport: status: label: Requested value: requested canCancel: true cancelHasExpired: true - id: 657 name: 'Location Name C' urlSlug: location-name-c pallets: 233 inboundDate: '2023-10-01' outboundDate: '2023-11-20' status: label: Stock value: stock transport: status: label: Requested value: requested canCancel: true cancelHasExpired: true items: type: object properties: id: type: integer example: 24 name: type: string example: 'Location Name A' urlSlug: type: string example: location-name-a pallets: type: integer example: 12344 inboundDate: type: string example: '2021-10-01' outboundDate: type: string example: '2021-10-02' status: type: object properties: label: type: string example: Stock value: type: string example: stock transport: type: object properties: status: type: object properties: label: { type: string, example: Requested } value: { type: string, example: requested } canCancel: type: boolean example: true cancelHasExpired: type: boolean example: true canCancel: type: boolean example: true cancelHasExpired: type: boolean example: true 401: description: unauthenticated content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'User Authentication' '/api/palletspace/v1/user/orders/cancel/{order_order_number_uuid}/warehouse/{warehouse_url_slug}': post: summary: 'Cancel a palletspace order' operationId: cancelAPalletspaceOrder description: 'This endpoint allows you to cancel a palletspace order.' parameters: [] responses: 200: description: success content: application/json: schema: type: object example: message: 'Order cancelled successfully.' properties: message: type: string example: 'Order cancelled successfully.' 400: description: 'bad request' content: application/json: schema: type: object example: message: 'Order already cancelled.' properties: message: type: string example: 'Order already cancelled.' 401: description: unauthenticated content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 403: description: forbidden content: application/json: schema: type: object example: message: Unauthorized. properties: message: type: string example: Unauthorized. 404: description: 'not found' content: application/json: schema: type: object example: message: 'Order not found.' properties: message: type: string example: 'Order not found.' tags: - 'User Authentication' parameters: - in: path name: order_order_number_uuid description: '' example: 8f0002a8-59e8-3d28-b9ea-78232ae69aec required: true schema: type: string - in: path name: warehouse_url_slug description: 'The slug of the warehouse url.' example: perferendis required: true schema: type: string /api/warespace/v1/user/user: get: summary: 'Display the authenticated user' operationId: displayTheAuthenticatedUser description: 'This endpoint gives you the authenticated user.' parameters: [] responses: 200: description: success content: application/json: schema: type: object example: id: 1 name: 'Max Mustermann' email: max.mustermann@email.de email_verified_at: '2024-04-17T14:52:54.000000Z' two_factor_confirmed_at: null current_team_id: null profile_photo_path: null created_at: '2024-04-17T14:52:54.000000Z' updated_at: '2024-04-17T14:52:54.000000Z' company_id: null force_password_change: false profile_photo_url: 'https://ui-avatars.com/api/?name=Max+Mustermann&color=7F9CF5&background=EBF4FF' company: null properties: id: type: integer example: 1 name: type: string example: 'Max Mustermann' email: type: string example: max.mustermann@email.de email_verified_at: type: string example: '2024-04-17T14:52:54.000000Z' two_factor_confirmed_at: type: string example: null current_team_id: type: string example: null profile_photo_path: type: string example: null created_at: type: string example: '2024-04-17T14:52:54.000000Z' updated_at: type: string example: '2024-04-17T14:52:54.000000Z' company_id: type: string example: null force_password_change: type: boolean example: false profile_photo_url: type: string example: 'https://ui-avatars.com/api/?name=Max+Mustermann&color=7F9CF5&background=EBF4FF' company: type: string example: null 401: description: unauthenticated content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'User Authentication' /api/warespace/v1/user/notifications: get: summary: 'Display the unread notifications.' operationId: displayTheUnreadNotifications description: 'This endpoint gives you the unread notifications of the authenticated user.' parameters: [] responses: 200: description: success content: application/json: schema: type: object example: data: - id: 0f2b7c8c-711f-4e79-bd7d-7bc7d380bc23 type: App\Notifications\InvitationNotification notifiable_type: App\Models\User notifiable_id: 51 data: title: 'Einladung von Reiter Reinhardt KGaA' route: 'https://example.com/dashboard/notifications' read_at: null created_at: '2021-08-25T09:00:00.000000Z' updated_at: '2021-08-25T09:00:00.000000Z' - id: 1f2b7c8c-711f-4e79-bd7d-7bc7d380bc23 type: App\Notifications\InvitationNotification notifiable_type: App\Models\User notifiable_id: 53 data: title: 'Einladung von Reiter Reinhardt KGaA' route: 'https://example.com/dashboard/notifications' read_at: '2021-08-25T09:05:00.000000Z' created_at: '2021-08-25T09:00:00.000000Z' updated_at: '2021-08-25T09:05:00.000000Z' properties: data: type: array example: - id: 0f2b7c8c-711f-4e79-bd7d-7bc7d380bc23 type: App\Notifications\InvitationNotification notifiable_type: App\Models\User notifiable_id: 51 data: title: 'Einladung von Reiter Reinhardt KGaA' route: 'https://example.com/dashboard/notifications' read_at: null created_at: '2021-08-25T09:00:00.000000Z' updated_at: '2021-08-25T09:00:00.000000Z' - id: 1f2b7c8c-711f-4e79-bd7d-7bc7d380bc23 type: App\Notifications\InvitationNotification notifiable_type: App\Models\User notifiable_id: 53 data: title: 'Einladung von Reiter Reinhardt KGaA' route: 'https://example.com/dashboard/notifications' read_at: '2021-08-25T09:05:00.000000Z' created_at: '2021-08-25T09:00:00.000000Z' updated_at: '2021-08-25T09:05:00.000000Z' items: type: object properties: id: type: string example: 0f2b7c8c-711f-4e79-bd7d-7bc7d380bc23 type: type: string example: App\Notifications\InvitationNotification notifiable_type: type: string example: App\Models\User notifiable_id: type: integer example: 51 data: type: object properties: title: type: string example: 'Einladung von Reiter Reinhardt KGaA' route: type: string example: 'https://example.com/dashboard/notifications' read_at: type: string example: null created_at: type: string example: '2021-08-25T09:00:00.000000Z' updated_at: type: string example: '2021-08-25T09:00:00.000000Z' 401: description: unauthenticated content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'User Authentication' '/api/warespace/v1/user/notifications/{notification}/mark-as-read': post: summary: 'Mark a notification as read.' operationId: markANotificationAsRead description: 'This endpoint marks a notification as read.' parameters: [] responses: 200: description: success content: application/json: schema: type: object example: message: 'Notification marked as read.' properties: message: type: string example: 'Notification marked as read.' 404: description: 'not found' content: application/json: schema: type: object example: message: 'Notification not found.' properties: message: type: string example: 'Notification not found.' tags: - 'User Authentication' parameters: - in: path name: notification description: 'The notification ID.' example: '137' required: true schema: type: integer /api/warespace/v1/user/statistics: get: summary: 'Display user statistics.' operationId: displayUserStatistics description: 'This endpoint gives you the statistics of the authenticated user.' parameters: [] responses: 200: description: success content: application/json: schema: type: array items: type: object example: - name: inbound stat: 2500 change: 21 changeType: increase - name: stock stat: 23500 change: 0 changeType: equal - name: fulfilled stat: 18282 change: 3.2 changeType: decrease 401: description: unauthenticated content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'User Authentication' /api/warespace/v1/user/recent-orders: get: summary: 'Display a listing of the last recent orders' operationId: displayAListingOfTheLastRecentOrders description: 'This endpoint gives you a listing of the last recent orders.' parameters: [] responses: 200: description: success content: application/json: schema: type: array items: type: object example: - title: Active recentActivity: - invoiceNumber: '00012' href: '#' pallets: 2500 inboundDate: '2021-10-01' createdAt: '2021-09-17 12:22:05' status: label: Requested value: requested orderNumber: 1722-0885-5626 orderNumberUUID: 6b885e57-c75a-3452-a067-9c2825fbab8b description: Palletspace - id: 2 invoiceNumber: '00011' href: '#' pallets: 30 inboundDate: '2023-03-22' createdAt: '2023-01-17 01:02:44' status: label: Stock value: stock orderNumber: 1722-0885-5626 orderNumberUUID: 6b885e57-c75a-3452-a067-9c2825fbab8b description: Palletspace - title: Fulfilled recentActivity: - id: 1 invoiceNumber: '00009' href: '#' pallets: 12500 inboundDate: '2023-03-22' createdAt: '2023-02-11 03:22:05' status: label: Fulfilled value: fulfilled orderNumber: 1722-0885-5626 orderNumberUUID: 6b885e57-c75a-3452-a067-9c2825fbab8b description: Tenderspace - id: 2 invoiceNumber: '00012' href: '#' pallets: 500 inboundDate: '2023-03-22' createdAt: '2023-03-07 02:12:06' status: label: Fulfilled value: fulfilled orderNumber: 1722-0885-5626 orderNumberUUID: 6b885e57-c75a-3452-a067-9c2825fbab8b description: Link 401: description: unauthenticated content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'User Authentication' /api/warespace/v1/user/authenticate: post: summary: Authenticate operationId: authenticate description: 'This endpoint gives you the access token by your user credentials.' parameters: [] responses: 200: description: success content: application/json: schema: type: object example: access_token: 1|kOuTvtR9oJbDkOncClZdAwtg9bPRT9YDja6BgWxX4701237a properties: access_token: type: string example: 1|kOuTvtR9oJbDkOncClZdAwtg9bPRT9YDja6BgWxX4701237a 401: description: unauthenticated content: application/json: schema: type: object example: message: 'Invalid Credentials' properties: message: type: string example: 'Invalid Credentials' tags: - 'User Authentication' requestBody: required: true content: application/json: schema: type: object properties: email: type: string description: 'Das Feld value muss eine gültige E-Mail-Adresse sein.' example: okeefe.maci@example.com nullable: false password: type: string description: 'Das Feld value muss mindestens 8 Zeichen umfassen.' example: 'Nf5A$S>YhHtw2&;k' nullable: false required: - email - password security: [] tags: - name: 'Company Authentication' description: '' - name: Public description: '' - name: 'User Authentication' description: '' components: securitySchemes: default: type: http scheme: bearer description: '' security: - default: []