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/company/ecl/orders: get: summary: 'Display a listing of all ecl orders' operationId: displayAListingOfAllEclOrders description: 'This endpoint gives you a listing of palletspace orders 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'." 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 status: pending ordered_at: '2024-12-07 10:19:00' sscc: '123456789012345678' documents: [] customer: user: id: 25 name: 'John Doe' email: nyrowe@mailinator.com phone_number_business: '+49 123 456789' job_title: Vertrieb locale: de company: id: 5 name: 'Mustermann GmbH' address_line_1: 'Tulpenweg 18a' address_line_2: 'Tor 2' postal_code: '12345' city: München country: DE phone: '+1 (467) 613-7239' email: company@example.com billing_email: billing@company.com website: www.company.com warehouse: id: 5 name: 'Falcon 3' address_line_1: 'Beispielstr. 5' address_line_2: '' postal_code: '12345' city: Wiesbaden country: DE phone: '0123456789' sales_mail: - sales@example.de contact_mail: - contact@example.de order_material: - id: 1 quantity: 500 unit_of_measure: kg material: material_number: A12345678901234567 material_type: roh base_unit_of_measure: m gross_weight: 1000 net_weight: 980 weight_unit: g volume: 1 volume_unit: m3 temperature_conditions_indicator: c international_article_number: '9783161484100' length: 2.5 width: 1.2 height: 1 dimension_unit: m batch_number_management_indicator: true minimum_remaining_shelf_life: 90 total_shelf_life: 365 materialDataPerWarehouse: loading_equipment_quantity: 5 storage_unit_type: pal materialUnitOfMeasure: unit_of_measure_for_stockkeeping_unit: box numerator_for_conversion_to_base_units_of_measure: 1 denominator_for_conversion_to_base_units_of_measure: 12 materialC: abc_indicator: a maximum_storage_period: 90 post_to_inspection_stock: true commodity_code: '12345678901234567' serial_number_profile: '1000' materialShortText: language_key: en material_description: 'Steel Plate' materialHazardous: valid_to: null parked: null last_changed_on: null material_number: null mode_of_transport_category_for_dangerous_goods: null no_dangerous_goods: null un_number: null primary_hazard_inducing_substance: null secondary_hazard_inducing_substance: null dangerous_goods_category: null aggregate_state_at_transportation: null flash_point: null hazard_note_1: null hazard_note_2: null hazard_note_3: null hazard_note_4: null hazard_note_5: null hazard_note_6: null hazard_note_7: null hazard_note_8: null hazard_note_9: null hazard_note_10: null water_hazard_class: null flammable_liquids_ordinance_class: null storage_hazard_class: null accident_procedures_sheet_number_1: null accident_procedures_sheet_number_2: null maximal_quantity_per_transport_unit: null packing_group: null hazard_id_number: null hazard_label_1: null hazard_label_2: null hazard_label_3: null hazard_label_4: null label_number_1: null label_number_2: null label_number_3: null label_number_4: null label_number_5: null label_number_6: null label_number_7: null label_number_8: null label_number_9: null label_number_10: null hazardousPackaging: package_code: null hazardousMarine: marine_pollutant: null hazardousLimit: reportable_quantity: null quantity_unit_of_reportable_quantities: null exempted_quantity: null transport_not_permitted: null - id: 2 status: pending ordered_at: '2024-12-07T09:38:03.000000Z' sscc: '123456789' documents: - id: 1 url: 'https://example.de/storage/2/01JER7A08DWDJ94FSSRS64B9ZF.pdf"' name: Sicherheitsblatt customer: user: id: 25 name: 'Vivian Massey' email: lexizuf@mailinator.com phone_number_business: null job_title: null locale: de company: id: 5 name: 'Henry Calderon' address_line_1: '38 East Milton Drive' address_line_2: 'Tor 5' postal_code: '12345' city: München country: DE phone: '+1 (155) 279-3646' email: company@mailinator.com billing_email: billing@mailinator.com website: 'https://www.company.com' warehouse: id: 3 name: 'Falcon 3' address_line_1: 'Pfaffenstr. 38' address_line_2: 'Domenico Waldherr' postal_code: '74078' city: Heilbronn country: DE phone: '01726378044' sales_mail: - Domenico.Waldherr@Fritz-Gruppe.de contact_mail: - Domenico.Waldherr@Fritz-Gruppe.de order_material: - id: 2 quantity: 2000 unit_of_measure: Liter material: material_number: B12345678901234567 material_type: roh base_unit_of_measure: m gross_weight: 1000 net_weight: 980 weight_unit: kg volume: 1 volume_unit: m3 temperature_conditions_indicator: c international_article_number: '9783161484100' length: 2.5 width: 1.2 height: 1 dimension_unit: m batch_number_management_indicator: true minimum_remaining_shelf_life: 90 total_shelf_life: 365 materialDataPerWarehouse: loading_equipment_quantity: 5 storage_unit_type: pal materialUnitOfMeasure: unit_of_measure_for_stockkeeping_unit: box numerator_for_conversion_to_base_units_of_measure: 1 denominator_for_conversion_to_base_units_of_measure: 12 materialC: abc_indicator: a maximum_storage_period: 90 post_to_inspection_stock: true commodity_code: '12345678901234567' serial_number_profile: '1000' materialShortText: language_key: en material_description: 'Steel Plate' materialHazardous: valid_to: '2025-12-07 00:00:00' parked: false last_changed_on: '2024-11-07 00:00:00' material_number: A12345678901234567 mode_of_transport_category_for_dangerous_goods: '4' no_dangerous_goods: false un_number: '3077' primary_hazard_inducing_substance: Acetone secondary_hazard_inducing_substance: Ethanol dangerous_goods_category: '2' aggregate_state_at_transportation: l flash_point: 23.5 hazard_note_1: H220 hazard_note_2: H315 hazard_note_3: H302 hazard_note_4: H314 hazard_note_5: H317 hazard_note_6: H334 hazard_note_7: H335 hazard_note_8: H370 hazard_note_9: H371 hazard_note_10: H372 water_hazard_class: '2' flammable_liquids_ordinance_class: h225 storage_hazard_class: '1' accident_procedures_sheet_number_1: AP-001 accident_procedures_sheet_number_2: AP-002 maximal_quantity_per_transport_unit: '2' packing_group: i hazard_id_number: '33' hazard_label_1: '3' hazard_label_2: '6.1' hazard_label_3: '8' hazard_label_4: '9' label_number_1: '3' label_number_2: '6.1' label_number_3: '8' label_number_4: '9' label_number_5: '3' label_number_6: '6.1' label_number_7: '8' label_number_8: '9' label_number_9: '3' label_number_10: '6.1' hazardousPackaging: package_code: 3H2 hazardousMarine: marine_pollutant: 0 hazardousLimit: reportable_quantity: 1000 quantity_unit_of_reportable_quantities: kg exempted_quantity: 5 transport_not_permitted: false links: first: 'https://warespace.ddev.site:8443/api/warespace/v1/public/ecl/orders?page=1' last: 'https://warespace.ddev.site:8443/api/warespace/v1/public/ecl/orders?page=1' prev: null next: null meta: current_page: 1 from: 1 last_page: 1 links: - url: null label: '« Vorherige' active: false - url: 'https://warespace.ddev.site:8443/api/warespace/v1/public/ecl/orders?page=1' label: '1' active: true - url: null label: 'Nächste »' active: false path: 'https://warespace.ddev.site:8443/api/warespace/v1/public/ecl/orders' per_page: 20 to: 1 total: 1 properties: data: type: array example: - id: 1 status: pending ordered_at: '2024-12-07 10:19:00' sscc: '123456789012345678' documents: [] customer: user: id: 25 name: 'John Doe' email: nyrowe@mailinator.com phone_number_business: '+49 123 456789' job_title: Vertrieb locale: de company: id: 5 name: 'Mustermann GmbH' address_line_1: 'Tulpenweg 18a' address_line_2: 'Tor 2' postal_code: '12345' city: München country: DE phone: '+1 (467) 613-7239' email: company@example.com billing_email: billing@company.com website: www.company.com warehouse: id: 5 name: 'Falcon 3' address_line_1: 'Beispielstr. 5' address_line_2: '' postal_code: '12345' city: Wiesbaden country: DE phone: '0123456789' sales_mail: - sales@example.de contact_mail: - contact@example.de order_material: - id: 1 quantity: 500 unit_of_measure: kg material: material_number: A12345678901234567 material_type: roh base_unit_of_measure: m gross_weight: 1000 net_weight: 980 weight_unit: g volume: 1 volume_unit: m3 temperature_conditions_indicator: c international_article_number: '9783161484100' length: 2.5 width: 1.2 height: 1 dimension_unit: m batch_number_management_indicator: true minimum_remaining_shelf_life: 90 total_shelf_life: 365 materialDataPerWarehouse: loading_equipment_quantity: 5 storage_unit_type: pal materialUnitOfMeasure: unit_of_measure_for_stockkeeping_unit: box numerator_for_conversion_to_base_units_of_measure: 1 denominator_for_conversion_to_base_units_of_measure: 12 materialC: abc_indicator: a maximum_storage_period: 90 post_to_inspection_stock: true commodity_code: '12345678901234567' serial_number_profile: '1000' materialShortText: language_key: en material_description: 'Steel Plate' materialHazardous: valid_to: null parked: null last_changed_on: null material_number: null mode_of_transport_category_for_dangerous_goods: null no_dangerous_goods: null un_number: null primary_hazard_inducing_substance: null secondary_hazard_inducing_substance: null dangerous_goods_category: null aggregate_state_at_transportation: null flash_point: null hazard_note_1: null hazard_note_2: null hazard_note_3: null hazard_note_4: null hazard_note_5: null hazard_note_6: null hazard_note_7: null hazard_note_8: null hazard_note_9: null hazard_note_10: null water_hazard_class: null flammable_liquids_ordinance_class: null storage_hazard_class: null accident_procedures_sheet_number_1: null accident_procedures_sheet_number_2: null maximal_quantity_per_transport_unit: null packing_group: null hazard_id_number: null hazard_label_1: null hazard_label_2: null hazard_label_3: null hazard_label_4: null label_number_1: null label_number_2: null label_number_3: null label_number_4: null label_number_5: null label_number_6: null label_number_7: null label_number_8: null label_number_9: null label_number_10: null hazardousPackaging: package_code: null hazardousMarine: marine_pollutant: null hazardousLimit: reportable_quantity: null quantity_unit_of_reportable_quantities: null exempted_quantity: null transport_not_permitted: null - id: 2 status: pending ordered_at: '2024-12-07T09:38:03.000000Z' sscc: '123456789' documents: - id: 1 url: 'https://example.de/storage/2/01JER7A08DWDJ94FSSRS64B9ZF.pdf"' name: Sicherheitsblatt customer: user: id: 25 name: 'Vivian Massey' email: lexizuf@mailinator.com phone_number_business: null job_title: null locale: de company: id: 5 name: 'Henry Calderon' address_line_1: '38 East Milton Drive' address_line_2: 'Tor 5' postal_code: '12345' city: München country: DE phone: '+1 (155) 279-3646' email: company@mailinator.com billing_email: billing@mailinator.com website: 'https://www.company.com' warehouse: id: 3 name: 'Falcon 3' address_line_1: 'Pfaffenstr. 38' address_line_2: 'Domenico Waldherr' postal_code: '74078' city: Heilbronn country: DE phone: '01726378044' sales_mail: - Domenico.Waldherr@Fritz-Gruppe.de contact_mail: - Domenico.Waldherr@Fritz-Gruppe.de order_material: - id: 2 quantity: 2000 unit_of_measure: Liter material: material_number: B12345678901234567 material_type: roh base_unit_of_measure: m gross_weight: 1000 net_weight: 980 weight_unit: kg volume: 1 volume_unit: m3 temperature_conditions_indicator: c international_article_number: '9783161484100' length: 2.5 width: 1.2 height: 1 dimension_unit: m batch_number_management_indicator: true minimum_remaining_shelf_life: 90 total_shelf_life: 365 materialDataPerWarehouse: loading_equipment_quantity: 5 storage_unit_type: pal materialUnitOfMeasure: unit_of_measure_for_stockkeeping_unit: box numerator_for_conversion_to_base_units_of_measure: 1 denominator_for_conversion_to_base_units_of_measure: 12 materialC: abc_indicator: a maximum_storage_period: 90 post_to_inspection_stock: true commodity_code: '12345678901234567' serial_number_profile: '1000' materialShortText: language_key: en material_description: 'Steel Plate' materialHazardous: valid_to: '2025-12-07 00:00:00' parked: false last_changed_on: '2024-11-07 00:00:00' material_number: A12345678901234567 mode_of_transport_category_for_dangerous_goods: '4' no_dangerous_goods: false un_number: '3077' primary_hazard_inducing_substance: Acetone secondary_hazard_inducing_substance: Ethanol dangerous_goods_category: '2' aggregate_state_at_transportation: l flash_point: 23.5 hazard_note_1: H220 hazard_note_2: H315 hazard_note_3: H302 hazard_note_4: H314 hazard_note_5: H317 hazard_note_6: H334 hazard_note_7: H335 hazard_note_8: H370 hazard_note_9: H371 hazard_note_10: H372 water_hazard_class: '2' flammable_liquids_ordinance_class: h225 storage_hazard_class: '1' accident_procedures_sheet_number_1: AP-001 accident_procedures_sheet_number_2: AP-002 maximal_quantity_per_transport_unit: '2' packing_group: i hazard_id_number: '33' hazard_label_1: '3' hazard_label_2: '6.1' hazard_label_3: '8' hazard_label_4: '9' label_number_1: '3' label_number_2: '6.1' label_number_3: '8' label_number_4: '9' label_number_5: '3' label_number_6: '6.1' label_number_7: '8' label_number_8: '9' label_number_9: '3' label_number_10: '6.1' hazardousPackaging: package_code: 3H2 hazardousMarine: marine_pollutant: 0 hazardousLimit: reportable_quantity: 1000 quantity_unit_of_reportable_quantities: kg exempted_quantity: 5 transport_not_permitted: false items: type: object properties: id: type: integer example: 1 status: type: string example: pending ordered_at: type: string example: '2024-12-07 10:19:00' sscc: type: string example: '123456789012345678' documents: type: array example: [] customer: type: object properties: user: type: object properties: id: type: integer example: 25 name: type: string example: 'John Doe' email: type: string example: nyrowe@mailinator.com phone_number_business: type: string example: '+49 123 456789' job_title: type: string example: Vertrieb locale: type: string example: de company: type: object properties: id: type: integer example: 5 name: type: string example: 'Mustermann GmbH' address_line_1: type: string example: 'Tulpenweg 18a' address_line_2: type: string example: 'Tor 2' postal_code: type: string example: '12345' city: type: string example: München country: type: string example: DE phone: type: string example: '+1 (467) 613-7239' email: type: string example: company@example.com billing_email: type: string example: billing@company.com website: type: string example: www.company.com warehouse: type: object properties: id: type: integer example: 5 name: type: string example: 'Falcon 3' address_line_1: type: string example: 'Beispielstr. 5' address_line_2: type: string example: '' postal_code: type: string example: '12345' city: type: string example: Wiesbaden country: type: string example: DE phone: type: string example: '0123456789' sales_mail: type: array example: - sales@example.de items: type: string contact_mail: type: array example: - contact@example.de items: type: string order_material: type: array example: - id: 1 quantity: 500 unit_of_measure: kg material: material_number: A12345678901234567 material_type: roh base_unit_of_measure: m gross_weight: 1000 net_weight: 980 weight_unit: g volume: 1 volume_unit: m3 temperature_conditions_indicator: c international_article_number: '9783161484100' length: 2.5 width: 1.2 height: 1 dimension_unit: m batch_number_management_indicator: true minimum_remaining_shelf_life: 90 total_shelf_life: 365 materialDataPerWarehouse: loading_equipment_quantity: 5 storage_unit_type: pal materialUnitOfMeasure: unit_of_measure_for_stockkeeping_unit: box numerator_for_conversion_to_base_units_of_measure: 1 denominator_for_conversion_to_base_units_of_measure: 12 materialC: abc_indicator: a maximum_storage_period: 90 post_to_inspection_stock: true commodity_code: '12345678901234567' serial_number_profile: '1000' materialShortText: language_key: en material_description: 'Steel Plate' materialHazardous: valid_to: null parked: null last_changed_on: null material_number: null mode_of_transport_category_for_dangerous_goods: null no_dangerous_goods: null un_number: null primary_hazard_inducing_substance: null secondary_hazard_inducing_substance: null dangerous_goods_category: null aggregate_state_at_transportation: null flash_point: null hazard_note_1: null hazard_note_2: null hazard_note_3: null hazard_note_4: null hazard_note_5: null hazard_note_6: null hazard_note_7: null hazard_note_8: null hazard_note_9: null hazard_note_10: null water_hazard_class: null flammable_liquids_ordinance_class: null storage_hazard_class: null accident_procedures_sheet_number_1: null accident_procedures_sheet_number_2: null maximal_quantity_per_transport_unit: null packing_group: null hazard_id_number: null hazard_label_1: null hazard_label_2: null hazard_label_3: null hazard_label_4: null label_number_1: null label_number_2: null label_number_3: null label_number_4: null label_number_5: null label_number_6: null label_number_7: null label_number_8: null label_number_9: null label_number_10: null hazardousPackaging: package_code: null hazardousMarine: marine_pollutant: null hazardousLimit: reportable_quantity: null quantity_unit_of_reportable_quantities: null exempted_quantity: null transport_not_permitted: null items: type: object properties: id: type: integer example: 1 quantity: type: integer example: 500 unit_of_measure: type: string example: kg material: type: object properties: material_number: type: string example: A12345678901234567 material_type: type: string example: roh base_unit_of_measure: type: string example: m gross_weight: type: integer example: 1000 net_weight: type: integer example: 980 weight_unit: type: string example: g volume: type: integer example: 1 volume_unit: type: string example: m3 temperature_conditions_indicator: type: string example: c international_article_number: type: string example: '9783161484100' length: type: number example: 2.5 width: type: number example: 1.2 height: type: integer example: 1 dimension_unit: type: string example: m batch_number_management_indicator: type: boolean example: true minimum_remaining_shelf_life: type: integer example: 90 total_shelf_life: type: integer example: 365 materialDataPerWarehouse: type: object properties: loading_equipment_quantity: { type: integer, example: 5 } storage_unit_type: { type: string, example: pal } materialUnitOfMeasure: type: object properties: unit_of_measure_for_stockkeeping_unit: { type: string, example: box } numerator_for_conversion_to_base_units_of_measure: { type: integer, example: 1 } denominator_for_conversion_to_base_units_of_measure: { type: integer, example: 12 } materialC: type: object properties: abc_indicator: { type: string, example: a } maximum_storage_period: { type: integer, example: 90 } post_to_inspection_stock: { type: boolean, example: true } commodity_code: { type: string, example: '12345678901234567' } serial_number_profile: { type: string, example: '1000' } materialShortText: type: object properties: language_key: { type: string, example: en } material_description: { type: string, example: 'Steel Plate' } materialHazardous: type: object properties: valid_to: { type: string, example: null } parked: { type: string, example: null } last_changed_on: { type: string, example: null } material_number: { type: string, example: null } mode_of_transport_category_for_dangerous_goods: { type: string, example: null } no_dangerous_goods: { type: string, example: null } un_number: { type: string, example: null } primary_hazard_inducing_substance: { type: string, example: null } secondary_hazard_inducing_substance: { type: string, example: null } dangerous_goods_category: { type: string, example: null } aggregate_state_at_transportation: { type: string, example: null } flash_point: { type: string, example: null } hazard_note_1: { type: string, example: null } hazard_note_2: { type: string, example: null } hazard_note_3: { type: string, example: null } hazard_note_4: { type: string, example: null } hazard_note_5: { type: string, example: null } hazard_note_6: { type: string, example: null } hazard_note_7: { type: string, example: null } hazard_note_8: { type: string, example: null } hazard_note_9: { type: string, example: null } hazard_note_10: { type: string, example: null } water_hazard_class: { type: string, example: null } flammable_liquids_ordinance_class: { type: string, example: null } storage_hazard_class: { type: string, example: null } accident_procedures_sheet_number_1: { type: string, example: null } accident_procedures_sheet_number_2: { type: string, example: null } maximal_quantity_per_transport_unit: { type: string, example: null } packing_group: { type: string, example: null } hazard_id_number: { type: string, example: null } hazard_label_1: { type: string, example: null } hazard_label_2: { type: string, example: null } hazard_label_3: { type: string, example: null } hazard_label_4: { type: string, example: null } label_number_1: { type: string, example: null } label_number_2: { type: string, example: null } label_number_3: { type: string, example: null } label_number_4: { type: string, example: null } label_number_5: { type: string, example: null } label_number_6: { type: string, example: null } label_number_7: { type: string, example: null } label_number_8: { type: string, example: null } label_number_9: { type: string, example: null } label_number_10: { type: string, example: null } hazardousPackaging: { type: object, properties: { package_code: { type: string, example: null } } } hazardousMarine: { type: object, properties: { marine_pollutant: { type: string, example: null } } } hazardousLimit: { type: object, properties: { reportable_quantity: { type: string, example: null }, quantity_unit_of_reportable_quantities: { type: string, example: null }, exempted_quantity: { type: string, example: null }, transport_not_permitted: { type: string, example: null } } } links: type: object properties: first: type: string example: 'https://warespace.ddev.site:8443/api/warespace/v1/public/ecl/orders?page=1' last: type: string example: 'https://warespace.ddev.site:8443/api/warespace/v1/public/ecl/orders?page=1' prev: type: string example: null next: type: string example: null meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 1 links: type: array example: - url: null label: '« Vorherige' active: false - url: 'https://warespace.ddev.site:8443/api/warespace/v1/public/ecl/orders?page=1' label: '1' active: true - url: null label: 'Nächste »' active: false items: type: object properties: url: type: string example: null label: type: string example: '« Vorherige' active: type: boolean example: false path: type: string example: 'https://warespace.ddev.site:8443/api/warespace/v1/public/ecl/orders' per_page: type: integer example: 20 to: type: integer example: 1 total: type: integer example: 1 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/{order}/confirmation': post: summary: 'Store a confirmation for an order' operationId: storeAConfirmationForAnOrder description: "This endpoint stores a confirmation for an order. Posting to this endpoint will change the status of the order from 'pending_inbound' to 'confirmed_inbound'." 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: 'Validation failed' errors: document_date: - 'The document_date field must be a valid date.' items.0.material_number: - 'The material_number field is required.' properties: message: type: string example: 'Validation failed' errors: type: object properties: document_date: type: array example: - 'The document_date field must be a valid date.' items: type: string items.0.material_number: type: array example: - 'The material_number field is required.' items: type: string tags: - 'Company Authentication' requestBody: required: false content: application/json: schema: type: object properties: document_date: type: date description: 'The date of the document' example: '2024-12-07' nullable: false reference_document_number: type: string description: 'The reference document number' example: REF12345 nullable: false user_name: type: string description: 'The username associated with the document' example: johndoe nullable: false document_header_text: type: string description: 'The header text of the document' example: 'Delivery Order' nullable: false items: type: array description: '' example: null items: type: object properties: material_number: type: string description: 'The material number' example: MATERIAL12345 nullable: false plant: type: string description: 'The plant identifier' example: PL01 nullable: false storage_location: type: string description: 'The storage location code' example: ST01 nullable: false batch_number: type: string description: 'The batch number' example: BATCH123 nullable: false stock_type: type: boolean description: 'Indicates the type of stock (e.g., unrestricted, reserved)' example: true nullable: false entry_quantity: type: numeric description: 'The quantity of the entry' example: 100 nullable: false entry_quantity_unit: type: string description: 'The unit of measurement for the entry quantity' example: kg nullable: false purchase_order_number: type: string description: 'The purchase order number' example: PO12345 nullable: false position_item: type: string description: 'The position item identifier' example: POS1 nullable: false shipping_instructions: type: string description: 'The shipping instructions' example: SI nullable: false position_text: type: string description: 'Text associated with the position' example: 'Item description' nullable: false order_number: type: string description: 'The order number associated with the item' example: ORD12345 nullable: false order_position_number: type: string description: 'The position number within the order' example: '1' nullable: false expiration_date: type: date description: 'The expiration date of the material' example: '2024-12-31' nullable: false delivery_number: type: string description: 'The delivery number' example: DEL12345 nullable: false delivery_position: type: string description: 'The position number within the delivery' example: '1' nullable: false serial_numbers: type: array description: '' example: null items: type: object properties: serial_number: type: string description: 'The serial number for the item' example: SN123456789 nullable: false parameters: - in: path name: order description: 'The order number or id' example: 52000-38103-1 required: true schema: type: string '/api/warespace/v1/company/ecl/orders/{order}/pallets': post: summary: 'Store multiple pallets in storage' operationId: storeMultiplePalletsInStorage description: "This endpoint allows you to add multiple pallets for an order. Each pallet contains details such as dimensions, weight, and type. Posting to this endpoint will change the status of the order from 'confirmed_inbound' to 'stocked'." 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: 'Validation failed' errors: pallets.0.type: - 'The type field is invalid.' pallets.0.length: - 'The length field must be numeric.' properties: message: type: string example: 'Validation failed' errors: type: object properties: pallets.0.type: type: array example: - 'The type field is invalid.' items: type: string pallets.0.length: type: array example: - 'The length field must be numeric.' items: type: string tags: - 'Company Authentication' requestBody: required: true content: application/json: schema: type: object properties: pallets: type: array description: '' example: - [] items: type: object properties: external_load_carrier_id: type: string description: 'External identifier for the load carrier.' example: LOAD12345 nullable: false type: type: enum description: 'Type of pallet' example: euro_pallet nullable: false enum: - euro_pallet - industrial_pallet - box - other length: type: numeric description: 'Length of the pallet' example: 120.0 nullable: false width: type: numeric description: 'Width of the pallet' example: 80.0 nullable: false height: type: numeric description: 'Height of the pallet' example: 14.5 nullable: false dimension_unit: type: string description: 'Unit for dimensions (e.g., cm, m)' example: cm nullable: false weight: type: numeric description: 'Weight of the pallet' example: 25.0 nullable: false weight_unit: type: string description: 'Unit for weight (e.g., kg, lbs)' example: kg nullable: false inbound_date: type: date description: 'Date when the pallet was received' example: '2024-12-07' nullable: false required: - external_load_carrier_id required: - pallets parameters: - in: path name: order description: 'The order number or id.' example: 52000-38103-1 required: true schema: type: string /api/warespace/v1/company/warehouse: post: 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: 'Nuri 1' internal_name: 'Honold International GmbH & Co. KG' 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: 'Nuri 1' internal_name: 'Honold International GmbH & Co. KG' 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: 'Nuri 1' internal_name: type: string example: 'Honold International GmbH & Co. KG' 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: 4 required: true schema: type: integer /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: fugiat 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 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: 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 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_id}': 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: 52e6e4d9-a114-37b7-8b73-1be6456da3a4 required: true schema: type: string - in: path name: warehouse_id description: 'The ID of the warehouse.' example: 8 required: true schema: type: integer /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: madison.denesik@example.org nullable: false password: type: string description: 'Das Feld value muss mindestens 8 Zeichen umfassen.' example: ']&S?5{yuIqlK3ykM]V$' 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: []