--- updatedAt: 2026-10-10T07:21:34.000Z agentTools: projectIndex: https://docs.cargoboard.com/llms.txt --- # List orders Returns your orders as a paginated list. Supports paging, sorting and filtering. The `links` array contains `next` / `previous` page links — see [Filtering and Searching](https://docs.cargoboard.com/reference/filtering-and-searching). # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Cargoboard API", "description": "Get binding freight prices, book shipments, print labels, track orders and retrieve invoices.\n\n**Authentication:** send your API key in the `X-API-KEY` header. Sandbox and production use different keys. Request a key from Patrick at [api@cargoboard.com](mailto:api@cargoboard.com) — he replies quickly.\n\nGuides and examples: [docs.cargoboard.com](https://docs.cargoboard.com)", "version": "1.0.5", "contact": { "name": "Cargoboard API team", "url": "https://cargoboard.com/", "email": "api@cargoboard.com" } }, "servers": [ { "url": "https://api-sandbox.cargoboard.com", "description": "Sandbox (test) — no real transports" }, { "url": "https://api.cargoboard.com", "description": "Production — real, billable orders" } ], "paths": { "/v1/orders": { "get": { "operationId": "get-orders", "summary": "List orders", "description": "Returns your orders as a paginated list. Supports paging, sorting and filtering. The `links` array contains `next` / `previous` page links — see [Filtering and Searching](https://docs.cargoboard.com/reference/filtering-and-searching).", "parameters": [ { "name": "take", "in": "query", "description": "Number of results per page (max. 50). Required.", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 50 } }, { "name": "cursor", "in": "query", "description": "Cursor for the next page — take the value from the previous response.", "required": false, "schema": { "type": "number" } }, { "name": "orderBy", "in": "query", "description": "Sort order: `sequence` (ascending, default) or `-sequence` (descending). Other values return `422`.", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "default": [ "sequence" ] } }, { "name": "filter", "in": "query", "description": "Filter expression ``, e.g. `product=STANDARD` or `createdAt>=2026-01-01`. Operators: `=`, `!=`, `<`, `<=`, `>`, `>=`, `~` (contains). Use `|` for OR on one field, e.g. `status=INITIALIZED|CREATED`. See [Filtering and Searching](https://docs.cargoboard.com/reference/filtering-and-searching). Allowed fields: see [Filtering and Searching](https://docs.cargoboard.com/reference/filtering-and-searching#filterable-fields).", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filterOperator", "in": "query", "description": "How multiple filters are combined: `AND` (default) or `OR`.", "required": false, "schema": { "type": "string", "default": "AND" } }, { "name": "total", "in": "query", "description": "Set to `true` to include the total number of results.", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Customer orders fetched successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseGetOrdersForCustomer" } } } }, "403": { "description": "Missing or invalid `X-API-KEY`, or no access to this resource." }, "422": { "description": "Validation failed — the `message` array lists the missing or invalid fields." } }, "security": [ { "X-API-KEY": [] } ], "tags": [ "Orders" ] } } }, "components": { "schemas": { "ContactPerson": { "type": "object", "properties": { "name": { "type": "string", "example": "Jane Doe", "description": "Name of the local contact person." }, "phone": { "type": "string", "example": "+49 30 12345678", "description": "Phone number, ideally in international format." }, "email": { "type": "string", "example": "orders@example.com", "description": "E-mail address." } } }, "NeutralData": { "type": "object", "properties": { "postCode": { "type": "string", "example": "10115" }, "countryCode": { "type": "string", "example": "DE", "enum": [ "AL", "AT", "BE", "BG", "CH", "CZ", "DE", "DK", "EE", "ES", "FI", "FR", "GB", "GR", "HR", "HU", "IE", "IT", "LI", "LT", "LU", "LV", "NL", "NO", "PL", "PT", "RO", "RS", "SE", "SI", "SK", "TR" ] }, "name": { "type": "string", "example": "Selling Company ABC GmbH" }, "street": { "type": "string", "example": "Friedrichstraße 1" }, "city": { "type": "string", "example": "Berlin" } }, "required": [ "postCode", "countryCode", "name", "street", "city" ] }, "HateoasLink": { "type": "object", "properties": { "rel": { "description": "Relation name", "type": "string" }, "method": { "description": "Http method like: GET, POST, PUT, DELETE.", "type": "string" }, "description": { "description": "Description for link.", "type": "string" }, "href": { "description": "Href for relation.", "type": "string" } } }, "AddressOrder": { "type": "object", "properties": { "postCode": { "type": "string", "example": "10115", "description": "Postal code." }, "countryCode": { "type": "string", "example": "DE", "enum": [ "AL", "AT", "BE", "BG", "CH", "CZ", "DE", "DK", "EE", "ES", "FI", "FR", "GB", "GR", "HR", "HU", "IE", "IT", "LI", "LT", "LU", "LV", "NL", "NO", "PL", "PT", "RO", "RS", "SE", "SI", "SK", "TR" ], "description": "Two-letter country code (ISO 3166-1 alpha-2)." }, "street": { "type": "string", "example": "Friedrichstraße 1", "description": "Street and house number." }, "city": { "type": "string", "example": "Berlin", "description": "City." } }, "required": [ "postCode", "countryCode", "street", "city" ] }, "ShipperOrder": { "type": "object", "properties": { "name": { "type": "string", "example": "Producer ABC GmbH & Co. KG", "description": "Company or person name of the shipper." }, "contactPerson": { "description": "Local contact person. Required for pickups in Romania (`RO`).", "allOf": [ { "$ref": "#/components/schemas/ContactPerson" } ] }, "address": { "$ref": "#/components/schemas/AddressOrder" }, "neutralData": { "description": "Neutral address shown to the consignee instead of the real pickup address. The truck never goes to this address. Not available for parcel shipments.", "allOf": [ { "$ref": "#/components/schemas/NeutralData" } ] }, "pickupAtFrom": { "description": "Start of the pickup window (ISO 8601). For orders a pickup date is required: either `pickupOn` or both `pickupAtFrom` and `pickupAtUntil` (window of at least 2 hours). Dates must be today or later, Monday to Friday.", "type": "string", "format": "date-time", "example": "2023-07-18T08:00:00Z" }, "pickupAtUntil": { "description": "End of the pickup window (ISO 8601). For orders a pickup date is required: either `pickupOn` or both `pickupAtFrom` and `pickupAtUntil` (window of at least 2 hours). Dates must be today or later, Monday to Friday.", "type": "string", "format": "date-time", "example": "2023-07-18T16:00:00Z" }, "pickupOn": { "description": "Pickup day (`YYYY-MM-DD`). For orders a pickup date is required: either `pickupOn` or both `pickupAtFrom` and `pickupAtUntil` (window of at least 2 hours). Dates must be today or later, Monday to Friday.", "type": "string", "format": "date", "example": "2023-07-18" }, "wantsContactBeforePickup": { "description": "A service where a Logistic Company contacts the customer by phone days/hours before the pickup and arranges an appointment for the pickup. This is often booked when a customer is not on site every time and needs an exact time.", "type": "boolean" }, "wantsTailLiftTruck": { "description": "Additional service: truck with tail lift for pickup. Automatically sets `loadingType` to `LIFTING_PLATFORM_OR_TAIL_LIFT_TRUCK` if no loading type is given.", "type": "boolean" }, "loadingType": { "description": "How the vehicle is loaded. `LIFTING_PLATFORM_OR_TAIL_LIFT_TRUCK` automatically books a tail lift truck.", "type": "string", "example": "LIFTING_PLATFORM_OR_TAIL_LIFT_TRUCK", "enum": [ "RAMP", "SIDE", "CRANE", "LIFTING_PLATFORM_OR_TAIL_LIFT_TRUCK", "TRUCK_MOUNTED_FORKLIFT" ] }, "freeTextForPickup": { "type": "string", "example": "Free text for pickup.", "description": "Notes for the pickup, e.g. opening hours or break times." }, "reference": { "type": "string", "example": "XYZ123", "description": "Reference the driver uses when notifying the shipper." } }, "required": [ "name", "address" ] }, "ConsigneeOrder": { "type": "object", "properties": { "name": { "type": "string", "example": "Consignee ABC AG", "description": "Company or person name of the consignee." }, "contactPerson": { "$ref": "#/components/schemas/ContactPerson" }, "address": { "$ref": "#/components/schemas/AddressOrder" }, "neutralData": { "description": "Neutral address shown to the shipper instead of the real delivery address. The truck never goes to this address. Not available for parcel shipments.", "allOf": [ { "$ref": "#/components/schemas/NeutralData" } ] }, "isPrivateCustomer": { "description": "Set to `true` if the consignee is a private person (B2C); a surcharge applies. Also book a delivery option: `wantsContactBeforeDelivery` (delivery notification) or `wantsDeliveryWithoutConsigneePresence` (release to deposit) — see [Private consignees](https://docs.cargoboard.com/reference/address-fields#private-consignees-b2c).", "type": "boolean", "example": false, "default": false }, "wantsContactBeforeDelivery": { "description": "A service where a Logistic Company contacts the customer by phone days/hours before the delivery and arranges an appointment for the delivery. This is often booked when a customer is not on site every time and needs an exact time.", "type": "boolean", "example": false, "default": false }, "wantsPhoneCallFromDriverBeforeDelivery": { "description": "A service where a Logistic Company contacts the customer by phone about 30 - 60 minutes before arriving at the customer location to deliver the shipment.", "type": "boolean", "example": false, "default": false }, "wantsDeliveryWithoutConsigneePresence": { "description": "A service where delivery will not require consignee presence.", "type": "boolean", "example": false, "default": false }, "wantsTailLiftTruck": { "description": "Additional service: truck with tail lift for delivery. Automatically sets `unloadingType` to `LIFTING_PLATFORM_OR_TAIL_LIFT_TRUCK` if no unloading type is given.", "type": "boolean" }, "deliveryOn": { "description": "Fixed delivery day (`YYYY-MM-DD`, Monday to Friday). Required for `FIX` products and not allowed for other products.", "type": "string", "format": "date", "example": "2023-07-18" }, "deliveryTimeSlot": { "description": "Booked delivery time slot details.", "allOf": [ { "$ref": "#/components/schemas/DeliveryTimeSlot" } ] }, "unloadingType": { "description": "How the vehicle is unloaded. `LIFTING_PLATFORM_OR_TAIL_LIFT_TRUCK` automatically books a tail lift truck.", "type": "string", "example": "LIFTING_PLATFORM_OR_TAIL_LIFT_TRUCK", "enum": [ "RAMP", "SIDE", "CRANE", "LIFTING_PLATFORM_OR_TAIL_LIFT_TRUCK", "TRUCK_MOUNTED_FORKLIFT" ] }, "freeTextForDelivery": { "type": "string", "example": "Free text for delivery.", "description": "Notes for the delivery, e.g. opening hours or break times." }, "reference": { "type": "string", "example": "XYZ123", "description": "Reference the driver uses when notifying the consignee." } }, "required": [ "name", "address" ] }, "DangerousGoodOrder": { "type": "object", "properties": { "unNo": { "type": "string", "example": "3480", "description": "UN number, e.g. `3480`." }, "substanceName": { "type": "string", "example": "LITHIUM-IONEN-BATTERIEN", "description": "Proper shipping name according to ADR." }, "packageQuantity": { "type": "integer", "example": 1, "minimum": 1, "maximum": 100000, "description": "Optional. Leave it empty, or send the same value as `quantity`." }, "packageType": { "type": "string", "example": "KISTE", "description": "Descriptive packaging name in the national language, singular, without abbreviations or ADR codes — e.g. `FASS`, `KISTE`, `KANISTER aus Aluminium`." }, "quantity": { "type": "integer", "example": 1, "description": "Number of dangerous goods packages of this type. This is the authoritative value — always fill it.", "minimum": 1, "maximum": 100000 }, "weightGross": { "type": "integer", "example": 11, "description": "Gross weight in kilograms. Must not exceed the line weight (`unitWeight` × `unitQuantity`).", "minimum": 1, "maximum": 24500 }, "weightNetOrVolume": { "type": "integer", "example": 9, "description": "Net weight (kg) or volume (l), depending on `weightNetOrVolumeUnit`.", "minimum": 1, "maximum": 100000 }, "weightNetOrVolumeUnit": { "type": "string", "example": "NGW", "description": "`NGW` = net weight in kilograms, `LIT` = volume in litres. Other values are not supported." }, "riskAdditional1": { "type": "string", "description": "Additional (subsidiary) hazard label.", "enum": [ "2.1", "2.2", "2.3", "3", "4.1", "4.2", "4.3", "5.1", "5.2", "6.1", "8", "9", "9A", "LQ" ] }, "riskAdditional2": { "type": "string", "example": "4.1", "description": "Additional (subsidiary) hazard label.", "enum": [ "2.1", "2.2", "2.3", "3", "4.1", "4.2", "4.3", "5.1", "5.2", "6.1", "8", "9", "9A", "LQ" ] }, "riskAdditional3": { "type": "string", "example": "6.1", "description": "Additional (subsidiary) hazard label.", "enum": [ "2.1", "2.2", "2.3", "3", "4.1", "4.2", "4.3", "5.1", "5.2", "6.1", "8", "9", "9A", "LQ" ] }, "isSpecialProvision188": { "description": "Special provision 188 applies (small lithium cell/battery exemption).", "type": "boolean", "example": false }, "riskMain": { "type": "string", "example": "9A", "description": "Primary hazard label, e.g. `9A`. Main and additional labels must be different.", "enum": [ "2.1", "2.2", "2.3", "3", "4.1", "4.2", "4.3", "5.1", "5.2", "6.1", "8", "9", "9A", "LQ" ] }, "pointsTotal": { "type": "integer", "example": 27, "description": "Total ADR points." }, "pointsMultiplier": { "type": "integer", "example": 3, "description": "ADR multiplier used to calculate the points." }, "adrVersion": { "type": "string", "example": "ADR2025", "description": "ADR version. Currently only `ADR2025` is supported." }, "classificationCode": { "type": "string", "example": "M4", "description": "ADR classification code, e.g. `M4`." }, "packagingGroup": { "type": "string", "example": null, "description": "ADR packing group, or `null` if none applies." }, "isExemptedQuantity": { "type": "boolean", "example": false, "description": "Transported as Excepted Quantity (EQ)." }, "isLimitedQuantity": { "type": "boolean", "example": false, "description": "Transported as Limited Quantity (LQ)." }, "isHighConsequencesDangerousGood": { "type": "boolean", "example": false, "description": "High consequence dangerous goods." }, "technicalNameForNotOtherwiseSpecifiedSubstances": { "type": "string", "example": "N.O.S.", "description": "Technical name for N.O.S. entries." }, "netExplosiveMass": { "type": "integer", "example": 5, "description": "Net explosive mass in kilograms (class 1).", "minimum": 1, "maximum": 24500 }, "transportCategory": { "type": "string", "example": "2", "description": "ADR transport category." }, "tunnelRestriction": { "description": "ADR tunnel restriction code, e.g. `(E)`.", "type": "string", "example": "(E)" } }, "required": [ "packageType" ] }, "Barcode": { "type": "object", "properties": { "id": { "description": "Id of barcode.", "type": "string" }, "sequence": { "description": "Sequence of barcode.", "type": "number" }, "value": { "description": "Value of barcode.", "type": "string" } } }, "LineOrder": { "type": "object", "properties": { "content": { "description": "Description of the goods.", "example": "Tyres", "type": "string" }, "unitQuantity": { "description": "Number of identical units in this line.", "type": "integer", "example": 3 }, "unitPackageType": { "description": "Package type of one unit.", "type": "string", "enum": [ "KT", "PA", "BU", "KN", "RE", "RA", "BE", "EI", "KA", "HO", "GE", "FL", "FK", "EK", "KF", "KO", "DO", "TRY", "KI", "PK", "RO", "SA", "BL", "KS", "DR", "MTV", "VP", "HP", "FA", "CC", "CP", "EB", "CX", "DP", "HS", "RG", "RW", "RC", "EP", "FP", "KP", "GP", "EE", "KB", "IB", "HE", "KGP", "KFP", "IP", "TC", "KG", "SB", "GS", "TR", "CL", "ST", "UV", "CO", "VG", "AB", "PARTIE", "KU", "PAR", "DIRECT_PKW", "DIRECT_BUS", "DIRECT_BUS_PLANE", "DIRECT_BUS_PLANE_TL", "DIRECT_BUS_PLANE_XXL", "DIRECT_BUS_PLANE_XXL_TL", "DIRECT_TRUCK_7_5", "DIRECT_TRUCK_12", "DIRECT_TRUCK_40", "DIRECT_BUS_TL", "DIRECT_TRUCK_7_5_TL", "DIRECT_TRUCK_12_TL" ] }, "unitLength": { "description": "Length of one unit in centimeters.", "type": "integer", "example": 80 }, "unitWidth": { "description": "Width of one unit in centimeters.", "type": "integer", "example": 80 }, "unitHeight": { "description": "Height of one unit in centimeters.", "type": "integer", "example": 120 }, "unitWeight": { "description": "Weight of one unit in kilograms.", "type": "number", "example": 12.4 }, "isStackable": { "description": "The units can be stacked.", "type": "boolean", "example": false, "default": false }, "wantsPalletExchange": { "description": "Pallet exchange requested.", "type": "boolean", "example": false, "default": false }, "volume": { "description": "Volume for the line.", "type": "number" }, "palletBays": { "description": "Pallet bays for the line.", "type": "number" }, "loadingMeter": { "description": "Loading meter for the line.", "type": "number" }, "additionalEuroPallets": { "description": "Additional euro Pallets for the line (e.g. as top or side protection).", "type": "number", "example": 3 }, "combinedNomenclatureCode": { "description": "Combined Nomenclature (customs tariff) code for the line's content.", "type": "string", "example": "1507" }, "additionalGitterBoxes": { "description": "Additional wire mesh boxes (Gitterboxen) for the line (e.g. as top or side protection).", "type": "number", "example": 0 }, "dangerousGoods": { "description": "Dangerous Goods for an order line.", "type": "array", "items": { "$ref": "#/components/schemas/DangerousGoodOrder" } }, "barcodes": { "description": "Barcodes - one per every unit in line.", "type": "array", "items": { "$ref": "#/components/schemas/Barcode" } } }, "required": [ "content", "unitQuantity", "unitPackageType", "unitLength", "unitWidth", "unitHeight", "unitWeight" ] }, "OrderId": { "type": "object", "properties": { "id": { "description": "ID of an order covered by the invoice.", "type": "string" } }, "required": [ "id" ] }, "CostItemOrderForCustomer": { "type": "object", "properties": { "type": { "description": "Cost item type. Possible values: DANGEROUS_GOODS, PRIVATE_CUSTOMER, IMPORT_DUTIES, CONTACT_BEFORE_PICKUP, TAIL_LIFT_TRUCK, PREMIUM_DELIVERY, CONTACT_BEFORE_DELIVERY, PHONE_CALL_FROM_DRIVER_BEFORE_DELIVERY, PHONE_CALL_FROM_DRIVER_BEFORE_PICKUP, DELIVERY_WITHOUT_CONSIGNEE_PRESENCE, TRANSPORT_INSURANCE, EXPORT_DECLARATION, ADDITIONAL_PRODUCTS, PALLET_EXCHANGE, CLIMATE_NEUTRAL_SURCHARGE, SHIPMENT, FUEL_SURCHARGE, CUSTOMER_DISCOUNT, COUPON.", "type": "string", "example": "SHIPMENT", "enum": [ "DANGEROUS_GOODS", "PRIVATE_CUSTOMER", "IMPORT_DUTIES", "CONTACT_BEFORE_PICKUP", "TAIL_LIFT_TRUCK", "PREMIUM_DELIVERY", "CONTACT_BEFORE_DELIVERY", "PHONE_CALL_FROM_DRIVER_BEFORE_DELIVERY", "PHONE_CALL_FROM_DRIVER_BEFORE_PICKUP", "DELIVERY_WITHOUT_CONSIGNEE_PRESENCE", "TRANSPORT_INSURANCE", "EXPORT_DECLARATION", "ADDITIONAL_PRODUCTS", "PALLET_EXCHANGE", "CLIMATE_NEUTRAL_SURCHARGE", "SHIPMENT", "FUEL_SURCHARGE", "CUSTOMER_DISCOUNT", "COUPON" ] }, "subtype": { "description": "Cost item subtype. Possible values: PICKUP_ADVISE, DELIVERY_ADVISE, PHONE_CALL_FROM_DRIVER_BEFORE_PICKUP, PHONE_CALL_FROM_DRIVER_BEFORE_DELIVERY, TAIL_LIFT, TAIL_LIFT_PICKUP, TAIL_LIFT_DELIVERY, DELIVERY_WHITOUT_CONSIGNEE_PRESENCE, PREMIUM_DELIVERY, PRIVATE_CONSIGNEE, EXPRESS_16, EXPRESS_12, EXPRESS_10, EXPRESS_8, FIX_16, FIX_12, FIX_10, FIX_8, PICKUP_BEFORE_12, PICKUP_AFTER_12, DELIVERY_BEFORE_12, DELIVERY_AFTER_12, EXPORT_DECLARATION, IMPORT_DECLARATION.", "type": "string", "example": "PICKUP_ADVISE", "enum": [ "PICKUP_ADVISE", "DELIVERY_ADVISE", "PHONE_CALL_FROM_DRIVER_BEFORE_PICKUP", "PHONE_CALL_FROM_DRIVER_BEFORE_DELIVERY", "TAIL_LIFT", "TAIL_LIFT_PICKUP", "TAIL_LIFT_DELIVERY", "DELIVERY_WHITOUT_CONSIGNEE_PRESENCE", "PREMIUM_DELIVERY", "PRIVATE_CONSIGNEE", "EXPRESS_16", "EXPRESS_12", "EXPRESS_10", "EXPRESS_8", "FIX_16", "FIX_12", "FIX_10", "FIX_8", "PICKUP_BEFORE_12", "PICKUP_AFTER_12", "DELIVERY_BEFORE_12", "DELIVERY_AFTER_12", "EXPORT_DECLARATION", "IMPORT_DECLARATION" ] }, "description": { "description": "Description for cost item.", "type": "string", "example": "Cost item." }, "sellPrice": { "type": "number", "example": 2 }, "currency": { "description": "Currency for price. Possible values: EUR.", "type": "string", "example": "EUR", "enum": [ "EUR" ] }, "isOnCustomerInvoice": { "type": "boolean", "example": false, "default": false }, "vat": { "type": "number", "example": 2 }, "sequence": { "description": "Sequence of price level.", "type": "number" } }, "required": [ "type", "subtype", "description", "sellPrice", "currency", "isOnCustomerInvoice", "vat" ] }, "OrderForCustomer": { "type": "object", "properties": { "product": { "description": "Shipment product. Possible values: DIRECT, EXPRESS, EXPRESS_8, EXPRESS_10, EXPRESS_12, EXPRESS_16, FIX, FIX_8, FIX_10, FIX_12, FIX_16, STANDARD.", "type": "string", "example": "FIX", "enum": [ "DIRECT", "EXPRESS", "EXPRESS_8", "EXPRESS_10", "EXPRESS_12", "EXPRESS_16", "FIX", "FIX_8", "FIX_10", "FIX_12", "FIX_16", "STANDARD" ] }, "transportType": { "description": "Transport type of order. Possible values GROUPAGE, PART_LOAD, DIRECT", "type": "string", "example": "PART_LOAD" }, "customerOrderCode": { "description": "A code applied by customer that will appear on documents as CustomerOrderNo", "type": "string", "example": "XYZ-1568788" }, "couponCode": { "description": "A code applied by customer that will allow for special actions like discount etc.", "type": "string", "example": "CARGOBOARD-WELCOME-123" }, "wantsExportDeclaration": { "description": "A service where shipment will be declared for customs. Some customers do this by themselves and others book this option. This service should be only possible if shipment goes to, or comes from a country outside of the EU, like Great Britain, Norway, Switzerland.", "type": "boolean", "example": false, "default": false }, "wantsClimateContribution": { "description": "Climate contribution to reduce the negative environmental impact of this shipment.", "type": "boolean", "example": true, "default": true }, "wantsInsurance": { "description": "Cargoboard arranges transport insurance for this shipment. Requires `valueOfGoodsAmount`.", "type": "boolean", "example": true, "default": false }, "incoterm": { "description": "Incoterm - should always be STANDARD and if you ship to Switzerland, or UK it should be DAP", "type": "string", "example": "STANDARD", "enum": [ "STANDARD", "DAP_CLEARED", "DAP_UNCLEARED" ] }, "isSupplyingCompanyOrReceivingCustomer": { "description": "If true customer is supplying company or receiving customer", "type": "boolean", "example": false }, "shipper": { "$ref": "#/components/schemas/ShipperOrder" }, "consignee": { "$ref": "#/components/schemas/ConsigneeOrder" }, "valueOfGoodsAmount": { "description": "Amount of money - value of goods for insurance or customs", "type": "number", "example": 30 }, "valueOfGoodsCurrency": { "description": "Currency of value of goods. Possible values EUR", "type": "string", "example": "EUR" }, "lines": { "description": "Line for a product.", "type": "array", "items": { "$ref": "#/components/schemas/LineOrder" } }, "id": { "description": "Id of order.", "type": "string" }, "sequence": { "description": "Sequence of order.", "type": "number" }, "status": { "description": "Status of order. Possible values INITIALIZED, CREATED, WAITING_FOR_PAYMENT, CANCELLED", "type": "string", "example": "INITIALIZED" }, "customerId": { "description": "Id of customer.", "type": "string" }, "quotationId": { "description": "Id of quotation.", "type": "string" }, "reference": { "description": "Reference of order.", "type": "string" }, "paymentMethod": { "description": "Payment methods of order. Possible values INVOICE, SEPA, PAY_PAL, GIROPAY, CREDIT_CARD, DIRECT_DEBIT, PREPAYMENT, NO_PAYMENT", "type": "string", "example": "INVOICE" }, "refundType": { "description": "RefundType of order. Possible values FULL, PARTIAL, NO", "type": "string", "example": "FULL" }, "easybillInvoices": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice" } }, "runtimeDaysMin": { "description": "Runtime days minimum.", "type": "number", "example": 3 }, "runtimeDaysMax": { "description": "Runtime days maximum.", "type": "number", "example": 6 }, "priceAmount": { "description": "Price amount.", "type": "number", "example": 10 }, "priceCurrency": { "description": "Price currency. Possible values EUR", "type": "string", "example": "EUR" }, "priceAmountStandard": { "description": "Price amount standard.", "type": "number", "example": 12 }, "priceCurrencyStandard": { "description": "Price currency standard. Possible values EUR", "type": "string", "example": "EUR" }, "placedAt": { "description": "Date of order placement", "type": "string", "format": "date-time", "example": "2023-07-17T10:10:39.535Z" }, "createdAt": { "description": "Date of creation of order", "type": "string", "format": "date-time", "example": "2023-07-17T10:10:39.535Z" }, "updatedAt": { "description": "Date of update of order", "type": "string", "format": "date-time", "example": "2023-07-17T10:10:39.535Z" }, "truckType": { "description": "Truck type of order. Possible values DIRECT_BUS_PLANE, DIRECT_BUS_PLANE_XXL, DIRECT_TRUCK_7_5, DIRECT_TRUCK_12, DIRECT_TRUCK_40", "type": "string", "example": "DIRECT_BUS_PLANE" }, "shipmentStatus": { "description": "Shipment status of order. Possible values CREATED, IN_DISPOSITION, COLLECTED, TRANSIT, DELIVERED, ACTION_REQUIRED, CANCELLED, IN_DELIVERY, SCHEDULED, WAITING_FOR_CUSTOMER, CUSTOMS_CLEARANCE, MISSING_INFORMATION, ALL_DOCUMENTS_PRESENT", "type": "string", "example": "CREATED" }, "linesWeight": { "description": "Lines weight of quotation.", "type": "number", "example": 10 }, "linesVolume": { "description": "Lines volume of quotation.", "type": "number", "example": 10 }, "linesPalletBays": { "description": "Lines pallet bays of quotation.", "type": "number", "example": 10 }, "linesLoadingMeter": { "description": "Lines loading meter of quotation.", "type": "number", "example": 10 }, "co2EmissionAmount": { "description": "CO2 Emission amount of quotation.", "type": "number" }, "co2EmissionValue": { "description": "CO2 Emission value of quotation.", "type": "number" }, "co2EmissionUnit": { "description": "CO2 Emission unit of quotation.", "type": "string" }, "actualPrice": { "description": "Actual price of order.", "type": "number", "example": 10 }, "actualPriceStandard": { "description": "Actual standard price of order.", "type": "number", "example": 10 }, "grossActualPrice": { "description": "Gross actual price of order.", "type": "number" }, "costItems": { "type": "array", "items": { "$ref": "#/components/schemas/CostItemOrderForCustomer" } } }, "required": [ "product", "shipper", "consignee", "lines" ] }, "ResponseGetOrdersForCustomer": { "type": "object", "properties": { "data": { "description": "Orders.", "type": "array", "items": { "$ref": "#/components/schemas/OrderForCustomer" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/HateoasLink" } }, "total": { "description": "Total number of orders.", "type": "number" } } }, "DeliveryTimeSlot": { "type": "object", "properties": { "performedBy": { "description": "Party performing the delivery time slot booking.", "type": "string", "example": "CARGOBOARD" }, "deliveryTarget": { "description": "Type of delivery target.", "type": "string", "example": "ANOTHER" }, "deliveryTargetAnother": { "description": "Free text name of the delivery target when deliveryTarget is ANOTHER.", "type": "string", "example": "Some warehouse / marketplace name" }, "reference": { "description": "Reference for the delivery time slot (e.g. ASN/PO numbers).", "type": "string", "example": "ASN: 12345 · PO: 67890" }, "deeplinkUrl": { "description": "Deeplink URL to the delivery time slot booking.", "type": "string", "example": "https://booking.example.com/slot/abc" }, "deliveryFrom": { "description": "Start of the booked delivery time slot.", "type": "string", "format": "date-time", "example": "2026-05-07T11:00:00.000Z" }, "deliveryUntil": { "description": "End of the booked delivery time slot.", "type": "string", "format": "date-time", "example": "2026-05-07T12:00:00.000Z" } } }, "Invoice": { "type": "object", "properties": { "id": { "type": "string", "description": "Invoice ID — use it for [Get invoice PDF](https://docs.cargoboard.com/reference/prints-invoice-pdf-document)." }, "sequence": { "type": "number", "description": "Sequence number, used as pagination cursor." }, "status": { "type": "string", "description": "Invoice status." }, "documentNumber": { "type": "string", "description": "Invoice number." }, "documentType": { "type": "string", "description": "Document type." }, "isDocumentCompleted": { "type": "boolean", "description": "The invoice document is completed." }, "isDocumentCancelled": { "type": "boolean", "description": "The invoice document is cancelled." }, "isDocumentSent": { "type": "boolean", "description": "The invoice has been sent." }, "documentSentAt": { "type": "string", "format": "date-time", "description": "When the invoice was sent." }, "documentSentToEmails": { "type": "array", "items": { "type": "string" }, "description": "E-mail addresses the invoice was sent to." }, "isCancellationDocumentSent": { "type": "boolean", "description": "A cancellation document has been sent." }, "cancellationDocumentSentAt": { "type": "string", "format": "date-time", "description": "When the cancellation document was sent." }, "cancellationDocumentSentToEmails": { "type": "array", "items": { "type": "string" }, "description": "E-mail addresses the cancellation document was sent to." }, "documentAmountGross": { "type": "number", "description": "Gross invoice amount." }, "documentAmountGrossEur": { "type": "number", "description": "Gross invoice amount in EUR." }, "documentAmountNet": { "type": "number", "description": "Net invoice amount." }, "documentAmountNetEur": { "type": "number", "description": "Net invoice amount in EUR." }, "dueDate": { "type": "string", "format": "date-time", "description": "Payment due date." }, "dueInDays": { "type": "number", "description": "Payment term in days." }, "isPaid": { "type": "boolean", "description": "The invoice is paid." }, "paidAt": { "type": "string", "format": "date-time", "description": "Payment date." }, "paymentAmount": { "type": "number", "description": "Paid amount." }, "paymentAmountEur": { "type": "number", "description": "Paid amount in EUR." }, "isCancelled": { "type": "boolean", "description": "The invoice is cancelled." }, "cancelledAt": { "type": "string", "format": "date-time", "description": "Cancellation date." }, "cancellationAmount": { "type": "number", "description": "Cancelled amount." }, "cancellationAmountEur": { "type": "number", "description": "Cancelled amount in EUR." }, "orders": { "type": "array", "description": "Orders covered by this invoice.", "items": { "$ref": "#/components/schemas/OrderId" } } } } }, "securitySchemes": { "X-API-KEY": { "type": "apiKey", "in": "header", "name": "X-API-KEY", "description": "Your Cargoboard API key. Sandbox and production use different keys." } } }, "tags": [ { "name": "Orders", "description": "Book, retrieve, cancel and track transport orders; print labels and order confirmations." } ], "externalDocs": { "description": "Documentation for customers.", "url": "https://docs.cargoboard.com" }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ```