This documentation aims to provide all the information you need to work with our API.
To authenticate requests, include an Authorization
header with the value "Bearer {YOUR_AUTH_KEY}"
.
All authenticated endpoints are marked with a requires authentication
badge in the documentation below.
APIs for managing orders
APIs for managing stock orders
This endpoint gives you a listing of palletspace orders for a company.
Status to filter by. Possible options are requested, cancelled, inbound, stock, outsourced, quality_issue, fulfilled
Current page number. Defaults to '1'.
Size of a page. Defaults to '100'.
curl --request GET \
--get "https://warespace.de/api/palletspace/v1/company/orders?status=stock&page=5&page_size=20" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"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"
}
}
}
]
}
]
}
APIs for fetching transport offers
APIs for fetching transport offers
This endpoint gives you the prices for the transport offers.
Status to filter by. Possible options are requested, cancelled, inbound, stock, outsourced, quality_issue, fulfilled
Current page number. Defaults to '1'.
Size of a page. Defaults to '100'.
curl --request GET \
--get "https://warespace.de/api/palletspace/v1/public/transport-offer?status=stock&page=5&page_size=20" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"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"
}
]
}
APIs for fetching warehouses
APIs for managing warehouses
This endpoint gives you all the warehouses.
Current page number. Defaults to '1'.
Size of a page. Defaults to '100'.
Postal code to filter by. Defaults to 'null'.
Ids to filter by. Defaults to 'null'.
Pattern to filter by. Defaults to 'null'.
Pallet height to filter by. Defaults to 'null'.
Inbound date to filter by (Y-m-d). Defaults to 'null'.
Outbound date to filter by (Y-m-d). Defaults to 'null'.
Voucher code which will be applied to the prices. Defaults to 'null'.
curl --request GET \
--get "https://warespace.de/api/warespace/v1/public/warehouses?page=5&page_size=20&postal_code=12345&ids[]=1&ids[]=2&pattern=Logistikzentrum+Leipzig&pallet_height=120&inbound=2024-02-01&outbound=2024-02-02&voucher=CARGOBOARD15" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"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"
]
}
]
}
This endpoint gives you all the nearest warehouses.
Current page number. Defaults to '1'.
Size of a page. Defaults to '100'.
Postal code to filter by. Defaults to 'null'.
Ids to filter by. Defaults to 'null'.
Pattern to filter by. Defaults to 'null'.
Pallet height to filter by. Defaults to 'null'.
Inbound date to filter by (Y-m-d). Defaults to 'null'.
Outbound date to filter by (Y-m-d). Defaults to 'null'.
curl --request GET \
--get "https://warespace.de/api/warespace/v1/public/nearest-warehouses?page=5&page_size=20&postal_code=12345&ids[]=1&ids[]=2&pattern=Logistikzentrum+Leipzig&pallet_height=120&inbound=2024-02-01&outbound=2024-02-02" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"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"
]
}
]
}
APIs for fetching warehouse coordinates
APIs for managing warehouse coordinates
This endpoint gives you the coordinates of all the warehouses.
Current page number. Defaults to '1'.
Size of a page. Defaults to '100'.
curl --request GET \
--get "https://warespace.de/api/warespace/v1/public/warehouse-coordinates?page=5&page_size=20" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"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"
}
}
}
APIs for fetching partner companies
APIs for managing partner companies
This endpoint gives you all the partner companies.
Current page number. Defaults to '1'.
Size of a page. Defaults to '100'.
Ids to filter by. Defaults to 'null'.
curl --request GET \
--get "https://warespace.de/api/warespace/v1/public/company-partners?page=1&page_size=20&ids[]=1&ids[]=2" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"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"
}
]
}
]
}
APIs for fetching general statistics
APIs for managing general statistics
Monthly chart of companies, warehouses, users and orders
curl --request GET \
--get "https://warespace.de/api/warespace/v1/public/general-stats" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"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
}
}
}
APIs for fetching locales
APIs for managing locales
This endpoint gives you all the locales.
curl --request GET \
--get "https://warespace.de/api/warespace/v1/public/locales" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"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
}
]
}
APIs for fetching load carrier types
APIs for managing load carrier types
This endpoint gives you all the load carrier types.
curl --request GET \
--get "https://warespace.de/api/warespace/v1/public/load-carrier-types" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"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"
}
]
}
APIs for creating and managing contact requests
APIs for managing contact requests
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.
curl --request POST \
"https://warespace.de/api/warespace/v1/public/contact-request" \
--header "Accept-Language: de" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Max Mustermann\",
\"email\": \"max@mustermann.de\",
\"message\": \"I would like to know more about your services\",
\"preferred_contact_method\": \"email\",
\"phone\": \"+49123456789\",
\"company_name\": \"Example Inc.\"
}"
{
"data": "ok"
}
APIs for creating and managing newsletters
APIs for managing newsletters
This endpoint allows you to store a contact in the newsletter model. Use "Accept-Language" header to specify the locale.
curl --request POST \
"https://warespace.de/api/warespace/v1/public/newsletter" \
--header "Accept-Language: de" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"email\": \"max@mustermann.de\",
\"name\": \"Max Mustermann\",
\"purpose\": \"Waiting list for external logisticians\",
\"metadata\": \"This email is used as support mail\",
\"company_name\": \"Mustermann GmbH\",
\"phone\": \"+49123456789\"
}"
APIs for fetching blog posts
APIs for managing blog posts
This endpoint gives you all the warehouses.
Current page number. Defaults to '1'.
Size of a page. Defaults to '100'.
Locale of the blog posts: de, en, etc.
curl --request GET \
--get "https://warespace.de/api/warespace/v1/public/blog?page=5&page_size=20&locale=de" \
--header "Accept-Language: de" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"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"
}
]
}
APIs for managing orders
APIs for managing orders
This endpoint gives you a listing of the palletspace orders for a user.
Status to filter by. Possible options are requested, cancelled, inbound, stock, outsourced, quality_issue, fulfilled
Current page number. Defaults to '1'.
Size of a page. Defaults to '100'.
curl --request GET \
--get "https://warespace.de/api/palletspace/v1/user/orders?status=stock&page=5&page_size=20" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"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
}
]
}
This endpoint allows you to cancel a palletspace order.
The ID of the warehouse.
curl --request POST \
"https://warespace.de/api/palletspace/v1/user/orders/cancel/000c42c7-99cf-359b-ad56-8a251a1328f4/warehouse/8" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"message": "Order cancelled successfully."
}
APIs for managing users
APIs for managing users
This endpoint gives you the authenticated user.
curl --request GET \
--get "https://warespace.de/api/warespace/v1/user/user" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"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
}
APIs for managing user notifications
APIs for managing user notifications
This endpoint gives you the unread notifications of the authenticated user.
curl --request GET \
--get "https://warespace.de/api/warespace/v1/user/notifications" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
[
{
"id": "0f2b7c8c-711f-4e79-bd7d-7bc7d380bc23",
"type": "App\\Notifications\\NewFollower",
"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\\NewFollower",
"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"
}
]
This endpoint marks a notification as read.
The notification ID.
curl --request POST \
"https://warespace.de/api/warespace/v1/user/notifications/137/mark-as-read" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"message": "Notification marked as read."
}
APIs for managing user statistics
APIs for managing user statistics
This endpoint gives you the statistics of the authenticated user.
curl --request GET \
--get "https://warespace.de/api/warespace/v1/user/statistics" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
[
{
"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"
}
]
APIs for managing recent orders
APIs for managing recent orders
This endpoint gives you a listing of the last recent orders.
curl --request GET \
--get "https://warespace.de/api/warespace/v1/user/recent-orders" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
[
{
"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"
}
]
}
]
APIs for managing user authentication
APIs for managing users
This endpoint gives you the access token by your user credentials.
curl --request POST \
"https://warespace.de/api/warespace/v1/user/authenticate" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"email\": \"kaci77@example.com\",
\"password\": \"WUT=(v+Y^p;+x\"
}"
{
"access_token": "1|kOuTvtR9oJbDkOncClZdAwtg9bPRT9YDja6BgWxX4701237a"
}