Ein normaler quaderförmiger Karton, der stapelbar ist.
\"\n },\n \"machineName\": \"parcel\"\n },\n {\n \"id\": 9,\n \"name\": \"Sperrgut\",\n \"description\": {\n \"name\": \"Bitte wählen Sie diesen Verpackungstyp, sofern Sie nicht sortierfähige Güter versenden möchten.
\\r\\nDies betrifft zum Beispiel:
\\r\\nSäcke, Holzkisten, Plastikeimer, Kanister, Pakete mit herausragenden Teilen, Stoffballen etc...
\"\n },\n \"machineName\": \"bulk\"\n },\n {\n \"id\": 10,\n \"name\": \"Palette\",\n \"description\": {\n \"name\": \"Euro- oder Einwegpalette
\\r\\nDie Palette muss von einer Person unter Zuhilfenahme eines Standardgabelhubwagens zu bewegen sein.
\"\n },\n \"machineName\": \"pallet\"\n },\n {\n \"id\": 15,\n \"name\": \"Nicht stapelbare Palette\",\n \"description\": {\n \"name\": \"In diese Kategorie fallen Packstücke, auf die sich andere Packstücke begrenzt oder gar nicht aufstapeln lassen, wie z.B. kegelförmige Paletten. Solche Sendungen verhindern eine effiziente Nutzung von Transportkapazitäten und deren Abfertigung erfordert darüber hinaus zusätzlichen zeitlichen Aufwand.\"\n },\n \"machineName\": \"n_s_pallet\"\n },\n {\n \"id\": 11,\n \"name\": \"Reifen\",\n \"description\": {\n \"name\": \"Nicht im Karton verpackte Reifen (Reifen nur mit Folie umwickelt)
\"\n },\n \"machineName\": \"tires\"\n },\n {\n \"id\": 14,\n \"name\": \"Koffer\",\n \"description\": {\n \"name\": \"Alle Koffer oder Reisetaschen die nicht im Karton verpackt sind
\"\n },\n \"machineName\": \"suitcase\"\n }\n ],\n \"quickFilters\": [\n {\n \"property\": null,\n \"id\": \"export_license\",\n \"name\": \"Inkl. Ausfuhranmeldung\",\n \"icon\": null,\n \"order\": -1,\n \"permanent\": false,\n \"extended\": true\n },\n {\n \"id\": 1,\n \"property\": \"shippingType\",\n \"name\": \"Nur Abholung\",\n \"icon\": null,\n \"order\": 5,\n \"permanent\": true,\n \"extended\": true\n },\n {\n \"id\": 3,\n \"property\": \"options\",\n \"name\": \"Abholung heute\",\n \"icon\": null,\n \"order\": 10,\n \"permanent\": true,\n \"extended\": true\n },\n {\n \"id\": 2,\n \"property\": \"tariffTypes\",\n \"name\": \"Express\",\n \"icon\": null,\n \"order\": 15,\n \"permanent\": true,\n \"extended\": true\n },\n {\n \"id\": 1,\n \"property\": \"options\",\n \"name\": \"Kein Drucker\",\n \"icon\": null,\n \"order\": 19,\n \"permanent\": true,\n \"extended\": true\n },\n {\n \"id\": 1,\n \"property\": \"shipperGroups\",\n \"name\": \"UPS\",\n \"icon\": \"UPS\",\n \"order\": 20,\n \"permanent\": true,\n \"extended\": true\n },\n {\n \"id\": 2,\n \"property\": \"shipperGroups\",\n \"name\": \"DHL Express\",\n \"icon\": \"DHL-Express\",\n \"order\": 25,\n \"permanent\": true,\n \"extended\": true\n },\n {\n \"id\": 5,\n \"property\": \"shipperGroups\",\n \"name\": \"TNT\",\n \"icon\": \"TNT\",\n \"order\": 30,\n \"permanent\": true,\n \"extended\": true\n },\n {\n \"id\": 29,\n \"property\": \"shipperGroups\",\n \"name\": \"FedEx\",\n \"icon\": \"FedEx-not-tariff\",\n \"order\": 40,\n \"permanent\": true,\n \"extended\": true\n }\n ],\n \"serviceOptions\": [],\n \"seoData\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff0b1dc5-f465-4684-a9fb-63bd5ba0ae67", "name": "The request body is invalid (`violations` lists the fields) or the request cannot be fulfilled in the current state", "originalRequest": { "url": { "path": [ "v1", "shipment-rates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "`1` lists the shipments of the whole team instead of your own. Needs the team permission of your account, otherwise the response is 403. (This can only be one of 0,1)", "type": "text/plain" }, "key": "full_team", "value": "1" }, { "disabled": true, "description": { "content": "Customer numbers of team members whose shipments to use instead of your own. Needs the team permission of your account.", "type": "text/plain" }, "key": "muid[]", "value": "7957" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"shipmentId\": \"s_2b28a63d65684f0aa4bcca24dafdc9df\",\n \"filterData\": {\n \"timeMax\": 1440,\n \"timeMin\": 0\n },\n \"settings\": {\n \"mode\": \"m\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"title\": \"An error occurred\",\n \"detail\": \"shipmentId: This value should not be blank.\\nsettings: This value should not be blank.\",\n \"status\": 400,\n \"type\": \"/validation_errors/0=c1051bb4-d103-4f74-8988-acbcafc7fdc3;1=c1051bb4-d103-4f74-8988-acbcafc7fdc3\",\n \"violations\": [\n {\n \"propertyPath\": \"shipmentId\",\n \"message\": \"This value should not be blank.\",\n \"code\": \"c1051bb4-d103-4f74-8988-acbcafc7fdc3\"\n },\n {\n \"propertyPath\": \"settings\",\n \"message\": \"This value should not be blank.\",\n \"code\": \"c1051bb4-d103-4f74-8988-acbcafc7fdc3\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b49550c-e938-4a78-af1b-e201b19b49f1", "name": "No valid token or API key was provided, or the account is disabled", "originalRequest": { "url": { "path": [ "v1", "shipment-rates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "`1` lists the shipments of the whole team instead of your own. Needs the team permission of your account, otherwise the response is 403. (This can only be one of 0,1)", "type": "text/plain" }, "key": "full_team", "value": "1" }, { "disabled": true, "description": { "content": "Customer numbers of team members whose shipments to use instead of your own. Needs the team permission of your account.", "type": "text/plain" }, "key": "muid[]", "value": "7957" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"shipmentId\": \"s_2b28a63d65684f0aa4bcca24dafdc9df\",\n \"filterData\": {\n \"timeMax\": 1440,\n \"timeMin\": 0\n },\n \"settings\": {\n \"mode\": \"m\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"No API token provided\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f23aa63-8840-4461-8755-81683a6ea97d", "name": "The credential is valid but may not perform this action, e.g. a read-only token on a write operation or `full_team` without the team permission. An integration token whose customer headers do not verify answers with the `401`-style body instead.", "originalRequest": { "url": { "path": [ "v1", "shipment-rates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "`1` lists the shipments of the whole team instead of your own. Needs the team permission of your account, otherwise the response is 403. (This can only be one of 0,1)", "type": "text/plain" }, "key": "full_team", "value": "1" }, { "disabled": true, "description": { "content": "Customer numbers of team members whose shipments to use instead of your own. Needs the team permission of your account.", "type": "text/plain" }, "key": "muid[]", "value": "7957" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"shipmentId\": \"s_2b28a63d65684f0aa4bcca24dafdc9df\",\n \"filterData\": {\n \"timeMax\": 1440,\n \"timeMin\": 0\n },\n \"settings\": {\n \"mode\": \"m\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Customer verification failed\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56de9455-4751-4d76-ac5b-7fa4941e3114", "name": "The resource does not exist or belongs to another account", "originalRequest": { "url": { "path": [ "v1", "shipment-rates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "`1` lists the shipments of the whole team instead of your own. Needs the team permission of your account, otherwise the response is 403. (This can only be one of 0,1)", "type": "text/plain" }, "key": "full_team", "value": "1" }, { "disabled": true, "description": { "content": "Customer numbers of team members whose shipments to use instead of your own. Needs the team permission of your account.", "type": "text/plain" }, "key": "muid[]", "value": "7957" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"shipmentId\": \"s_2b28a63d65684f0aa4bcca24dafdc9df\",\n \"filterData\": {\n \"timeMax\": 1440,\n \"timeMin\": 0\n },\n \"settings\": {\n \"mode\": \"m\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"title\": \"An error occurred\",\n \"detail\": \"Shipment not found\",\n \"status\": 404,\n \"type\": \"/errors/404\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Cart", "description": "The cart totals the shipments you are about to pay for.", "item": [ { "id": "99c52b55-9c74-4994-8253-37c10677d80b", "name": "Get the cart total", "request": { "name": "Get the cart total", "description": { "content": "Get cart total costs with a description of the calculations", "type": "text/plain" }, "url": { "path": [ "v1", "cart", "total" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"shipmentIds\": [\n \"s_2b28a63d65684f0aa4bcca24dafdc9df\",\n \"s_ca213cb9368c412291b8441c90c95592\"\n ],\n \"voucherCode\": \"XmasDiscount\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7af841be-cf82-4ed3-ae53-07b0efe2922a", "name": "Totals, available payment methods and per-shipment problems", "originalRequest": { "url": { "path": [ "v1", "cart", "total" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"shipmentIds\": [\n \"s_2b28a63d65684f0aa4bcca24dafdc9df\",\n \"s_ca213cb9368c412291b8441c90c95592\"\n ],\n \"voucherCode\": \"XmasDiscount\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"total\": {\n \"id\": 1,\n \"tax\": 0,\n \"taxNet\": 0,\n \"taxFreeNet\": 0,\n \"taxes\": [],\n \"taxDefaultName\": \"MwSt.\",\n \"taxId\": \"DE293163480\",\n \"voucherValue\": 0,\n \"voucherPercent\": 0,\n \"voucherCode\": \"\",\n \"voucherType\": \"\",\n \"voucherOrderNumbers\": \"\",\n \"voucherErrorMessage\": null,\n \"gross\": 0,\n \"subtotal\": 0,\n \"surcharges\": 0,\n \"plusProductSurcharges\": {\n \"id\": 1,\n \"minSurcharge\": 0.42,\n \"percentSurcharge\": 10,\n \"price\": 0.49,\n \"currency\": \"EUR\"\n },\n \"subtotalNet\": 0,\n \"surchargesNet\": 0,\n \"totalNet\": 0,\n \"totalNetVoucher\": 0,\n \"shippingCostsNet\": 0,\n \"shippingCosts\": 0,\n \"additionalServices\": 0,\n \"additionalServicesSeparately\": {\n \"standard_insurance_total\": 0,\n \"standard_insurance_total_uvp\": 0,\n \"premium_insurance_total\": 0,\n \"premium_insurance_total_uvp\": 0,\n \"export_declaration_total\": 0,\n \"export_declaration_total_uvp\": 0,\n \"shipping_costs_total_uvp\": 0\n }\n },\n \"paymentMethods\": [],\n \"shipments\": [\n {\n \"id\": \"s_21b7f7ad8a584fce9f776b9cf6004711\",\n \"customer_number\": 200002,\n \"customer_personal_name\": null,\n \"customer_initials\": null,\n \"created\": \"2026-10-21 10:40:31\",\n \"last_modified\": \"2026-10-21 10:40:39\",\n \"internal_status\": \"open\",\n \"status\": \"delivered\",\n \"isCancellationPossible\": false,\n \"source\": null,\n \"from_address\": {\n \"company\": \"Jumingo\",\n \"name\": \"John Doe\",\n \"country\": \"DE\",\n \"id\": 1576,\n \"street\": \"100 West 33rd Street\",\n \"street2\": \"Apt 123\",\n \"zip\": \"10011\",\n \"city\": \"Berlin\",\n \"state\": null,\n \"phone\": \"1234567190\",\n \"settings\": null\n },\n \"to_address\": {\n \"company\": \"Grid Corp.\",\n \"name\": \"John Doe\",\n \"country\": \"US\",\n \"id\": 1579,\n \"street\": \"100 West 33rd Street\",\n \"street2\": \"Apt 123\",\n \"zip\": \"10021\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"phone\": \"1234557890\",\n \"settings\": null\n },\n \"billing_address\": {\n \"company\": \"Jumingo\",\n \"name\": \"John Doe\",\n \"country\": \"DE\",\n \"id\": 1577,\n \"street\": \"100 West 33rd Street\",\n \"street2\": \"Apt 123\",\n \"zip\": \"10011\",\n \"city\": \"Berlin\",\n \"state\": null,\n \"phone\": \"1234567190\",\n \"settings\": null\n },\n \"details\": {\n \"value_amount\": 999,\n \"value_currency\": \"EUR\",\n \"content_description\": \"PS-5\",\n \"reference_number\": \"my-reference-1\",\n \"email\": \"email@example.org\",\n \"email_tracking\": \"email@example.org\",\n \"email_label_copy\": \"email@example.org\",\n \"insurance_amount\": 25,\n \"insurance_currency\": \"EUR\",\n \"extra_insurance_price_netto\": 0,\n \"extra_insurance_price_brutto\": 0,\n \"extra_insurance_value\": 0,\n \"extra_insurance_type\": null,\n \"extra_insurance_provider\": null,\n \"export_license\": true,\n \"export_license_price_brutto\": 0,\n \"shipment_order_number\": \"A-2024010311-1\",\n \"shipment_order_number_short\": \"2024010311-1\",\n \"packaging_type\": \"parcel\",\n \"hs_tariff_number\": \"qqqqqqqq\",\n \"extra_export_license_number\": null,\n \"settings\": {\n \"tariff\": {\n \"distance\": null,\n \"settings\": {\n \"is_cin\": true,\n \"is_green_tariff\": true,\n \"is_tariff_weight_dependent\": true\n },\n \"loading_aid\": 30,\n \"delivery_date\": \"2026-11-20\",\n \"pickup_max_time\": \"2024-08-06 16:00:00\",\n \"pickup_min_time\": \"2024-08-06 12:45:00\",\n \"price_netto_uvp\": 47.45,\n \"same_day_pickup\": true,\n \"price_brutto_uvp\": 47.45,\n \"marketing_discount\": 0,\n \"uvp_discount_value\": 0,\n \"uvp_discount_percent\": 0,\n \"calculate_volume_weight\": 1,\n \"individual_customer_tariff\": false,\n \"marketing_discount_description\": null,\n \"extra_export_license_price_brutto_old\": 59.95,\n \"uvp_extra_insurance_price_brutto_preselect\": 70.8,\n \"uvp_extra_insurance_premium_price_brutto_preselect\": 106.2\n },\n \"offer_valid_until\": \"2024-08-06 14:34:59\",\n \"use_commercial_invoice\": false\n }\n },\n \"customs_invoice\": {\n \"invoiceNumber\": \"AAAAAAAAAA\",\n \"invoiceDate\": \"2023-12-12\",\n \"currency\": \"USD\",\n \"exportReason\": \"Gift\",\n \"remarks\": null,\n \"lineItems\": [\n {\n \"id\": 172,\n \"content\": \"Qwert\",\n \"quantity\": 3,\n \"unitOfMeasurement\": \"L\",\n \"netWeight\": 89,\n \"value\": 999,\n \"hsTariffNumber\": null,\n \"manufacturingCountry\": null,\n \"merchantProductId\": null,\n \"manufacturerProductId\": null,\n \"standardizedProductId\": null\n }\n ],\n \"useJumingoCommercialInvoice\": false,\n \"discount\": null,\n \"shippingCosts\": null,\n \"insuranceCosts\": null,\n \"goodsValue\": 2997,\n \"effectiveShippingCosts\": 59.5,\n \"effectiveInsuranceCosts\": 0,\n \"totalInvoiceAmount\": 3056.5\n },\n \"packages\": [\n {\n \"id\": 326,\n \"weight\": 6,\n \"length\": 2,\n \"width\": 3,\n \"height\": 4,\n \"volume_weight\": 0.0048,\n \"girth\": 14,\n \"first_length\": 4,\n \"second_length\": 3,\n \"type\": \"parcel\",\n \"type_id\": 7,\n \"name\": \"2024010311-1\",\n \"api_shipment_ids\": null,\n \"quantity\": 1\n }\n ],\n \"connection\": null,\n \"rate\": {\n \"carrier\": {\n \"shipper_group_id\": 2,\n \"shipper_group_name\": \"DHL Express\",\n \"shipper_id\": 129,\n \"shipper_tariff_id\": 522,\n \"shipper_tariff_full_id\": \"522\",\n \"shipper_tariff_type_id\": 5,\n \"shipper_tariff_type_name\": \"Economy\",\n \"shipper_tariff_zone_id\": 2845,\n \"limits\": []\n },\n \"service\": {\n \"name\": \"DPD CLASSIC NATIONAL\",\n \"description\": null,\n \"image\": \"/img/versandrechner/tarife/dhlexpress.svg\",\n \"dispatch_id\": 1,\n \"agb_link\": \"https://www.dhl.de/content/dam/images/Express/downloads/geschaeftsbedingungen-und-preise/geschaeftsbedingungen/dhl-express-atb-international-062019.pdf\",\n \"is_plus_product\": false,\n \"is_trackable_product\": true,\n \"is_insurable_product\": true,\n \"has_shop_finder\": false\n },\n \"shipping_type\": \"pickup\",\n \"transit_time_range_days\": \"2\",\n \"max_liability\": 25,\n \"max_included_liability_currency\": \"EUR\",\n \"printer_required\": true,\n \"parcel_content_required\": false,\n \"from_company_only\": false,\n \"to_company_only\": false,\n \"from_private_only\": false,\n \"to_private_only\": false,\n \"from_phone_number_required\": true,\n \"to_phone_number_required\": false,\n \"hs_tariff_number_required\": false,\n \"price_net\": 47.45,\n \"price_net_currency\": \"EUR\",\n \"price_total\": 47.45,\n \"price_total_currency\": \"EUR\",\n \"tax_free\": true,\n \"tax_rate\": 0,\n \"tax_country\": \"\",\n \"tax_name\": \"MwSt.\",\n \"pickup_date\": \"2024-08-06\",\n \"pickup_min_time\": \"2024-08-06 14:45:00\",\n \"pickup_max_time\": \"2024-08-06 18:00:00\",\n \"pickup_reference_number\": \"135855S5SSCP\",\n \"delivery_date_min\": \"2024-08-08T02:00:00Z\",\n \"delivery_date_max\": \"2024-08-08T02:00:00Z\",\n \"delivery_time_until\": \"2024-08-08 17:00:00\",\n \"distance\": 0,\n \"distanceFormatted\": null,\n \"durationFormatted\": \"2 Arbeitstage\",\n \"carType\": null,\n \"jumingo_express_carrier\": null,\n \"is_jumingo_express\": false,\n \"jum_disp\": false,\n \"marketing_discount\": 0,\n \"marketing_discount_description\": null,\n \"uvp_discount_value\": 0,\n \"uvp_discount_percent\": 0,\n \"uvp_extra_insurance_price_brutto_preselect\": 70.8,\n \"uvp_extra_insurance_premium_price_brutto_preselect\": 106.2,\n \"extra_export_license_price_brutto_old\": 59.95,\n \"price_brutto_uvp\": 47.45,\n \"price_netto_uvp\": 47.45\n },\n \"tracking\": {\n \"data\": {\n \"version\": \"1.0\",\n \"tracking_number\": \"3384299634\",\n \"status\": \"new\",\n \"status_text\": \"Daten übermittelt\",\n \"from\": null,\n \"to\": null,\n \"carrier\": {\n \"code\": \"dhl\",\n \"name\": \"DHL\",\n \"image\": \"/cms/Carrier_dhl_express_tracking_1617955411.svg\",\n \"phone\": \"+ 49 (0)180 6 345 300-1\",\n \"id\": 1\n },\n \"steps\": [],\n \"stepDates\": [],\n \"dates\": {\n \"created\": \"2024-02-01 17:05:06\",\n \"modified\": null,\n \"last_updated\": \"2024-02-01 17:05:06\",\n \"status_changed\": \"2024-01-08 01:00:00\"\n },\n \"infos\": [],\n \"progress\": [],\n \"carrierList\": null\n },\n \"active\": 0,\n \"status\": \"success\",\n \"progress\": {\n \"percent\": 0,\n \"points\": {\n \"in_system\": false,\n \"in_transit\": false,\n \"in_delivery\": false,\n \"undelivered\": false,\n \"exception\": false,\n \"completed\": false,\n \"parcel_shop\": false\n },\n \"class\": \"\"\n },\n \"carrierTrackingPage\": \"http://www.dhl.com/en/express/tracking.html?AWB=TN-12345\",\n \"implementationType\": \"direct_api\"\n },\n \"tax_free_reason\": \"third_country_transfer\",\n \"tax_id\": null,\n \"import_status\": \"completed\",\n \"import_progress_status\": \"\",\n \"import_checkout_id\": null,\n \"order\": {\n \"number\": \"2024010311\",\n \"unpaid\": null,\n \"canceled\": null,\n \"created\": \"2026-10-21 08:40:32\"\n },\n \"import_messages\": {\n \"parcel\": {\n \"hs_tariff_number\": {\n \"required\": {\n \"oldValue\": null,\n \"label\": \"HS-Tarifnummer\"\n }\n }\n },\n \"addresses\": {\n \"pickup\": [],\n \"delivery\": [],\n \"return\": [],\n \"billing\": []\n },\n \"details\": [],\n \"packages\": [\n []\n ],\n \"customsInvoice\": {\n \"lineItems\": [\n {\n \"hs_tariff_number\": {\n \"invalid\": {\n \"oldValue\": null\n },\n \"empty_not_allowed\": {\n \"oldValue\": null\n }\n },\n \"manufacturing_country\": {\n \"empty_not_allowed\": {\n \"oldValue\": null\n }\n }\n }\n ]\n }\n },\n \"import_messages_text\": null,\n \"type\": 2,\n \"canceled\": false,\n \"dates\": {\n \"pickup\": {\n \"date\": \"2024-08-06\",\n \"day_format\": \"Tuesday\",\n \"day_format_short\": \"Tue\",\n \"date_format_short\": \"Tue 6 Aug\",\n \"month\": \"Aug\",\n \"month_format\": \"August\",\n \"min_pickup_date\": \"2026-10-26\",\n \"pickup_min_time\": \"14:45\",\n \"pickup_max_time\": \"18:00\",\n \"pickup_min_time_minutes\": 885,\n \"pickup_max_time_minutes\": 1080\n },\n \"transit_date_min\": {\n \"date\": \"2024-08-08\",\n \"day_format\": \"Thursday\",\n \"day_format_short\": \"Thu\",\n \"month\": \"Aug\",\n \"month_format\": \"August\"\n },\n \"transit_date_max\": {\n \"date\": \"2024-08-08\",\n \"day_format\": \"Thursday\",\n \"day_format_short\": \"Thu\",\n \"month\": \"Aug\",\n \"month_format\": \"August\"\n },\n \"delivery\": {\n \"time_until_format\": \"5:00 PM\",\n \"time_until_minutes\": 1020,\n \"day\": \"08\",\n \"day_format\": \"Thu\",\n \"month_format\": \"Aug\",\n \"min_delivery_date\": \"2024-08-08 00:00:00\",\n \"max_delivery_date\": \"2024-08-08 00:00:00\",\n \"date_format_short\": \"Thu., 8. Aug.\"\n },\n \"transit_time_range\": {\n \"days\": \"2\",\n \"days_string\": \"Arbeitstage\",\n \"days_string_short\": \"Tage\"\n }\n },\n \"label_sent_on\": null,\n \"has_label\": false,\n \"label_generation_status\": \"waiting\",\n \"has_proforma\": false,\n \"has_export_cert_vat\": false,\n \"has_commercial_invoice\": false,\n \"has_export_declaration\": false,\n \"has_proof_of_export\": false,\n \"dates_aggregation\": {\n \"created\": {\n \"date\": \"2026-10-21\",\n \"time\": \"10:40:31\",\n \"minutes\": 641\n },\n \"last_modified\": {\n \"date\": \"2026-10-21\",\n \"time\": \"10:40:39\",\n \"minutes\": 641\n }\n },\n \"dates_in_the_past\": true,\n \"delayed\": true,\n \"settings\": {\n \"tariff\": {\n \"distance\": null,\n \"settings\": {\n \"is_cin\": true,\n \"is_green_tariff\": true,\n \"is_tariff_weight_dependent\": true\n },\n \"loading_aid\": 30,\n \"delivery_date\": \"2026-11-20\",\n \"pickup_max_time\": \"2024-08-06 16:00:00\",\n \"pickup_min_time\": \"2024-08-06 12:45:00\",\n \"price_netto_uvp\": 47.45,\n \"same_day_pickup\": true,\n \"price_brutto_uvp\": 47.45,\n \"marketing_discount\": 0,\n \"uvp_discount_value\": 0,\n \"uvp_discount_percent\": 0,\n \"calculate_volume_weight\": 1,\n \"individual_customer_tariff\": false,\n \"marketing_discount_description\": null,\n \"extra_export_license_price_brutto_old\": 59.95,\n \"uvp_extra_insurance_price_brutto_preselect\": 70.8,\n \"uvp_extra_insurance_premium_price_brutto_preselect\": 106.2\n },\n \"offer_valid_until\": \"2024-08-06 14:34:59\",\n \"use_commercial_invoice\": false\n },\n \"post_order_update_allowed\": true,\n \"export_cert_vat_possible\": true,\n \"picked_up\": false,\n \"update_ordered_delivery_address_allowed\": false,\n \"product_identifiers_required\": false,\n \"pickup_status\": 0,\n \"shipment_issues\": [\n {\n \"issue_type\": \"todo\",\n \"reason\": \"cin_incomplete\"\n }\n ],\n \"export_declaration\": null,\n \"is_return_possible\": true,\n \"documents\": {\n \"proforma\": null,\n \"commercial_invoice\": null,\n \"export_declaration\": null,\n \"proof_of_export\": null,\n \"export_cert_vat\": null\n }\n }\n ],\n \"errorList\": {\n \"s_21b7f7ad8a584fce9f776b9cf6004711\": [\n \"date_in_past\",\n \"time_in_past\",\n \"not_ready_status\"\n ]\n },\n \"userTaxId\": \"TESTVATID\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3caf2f2c-1c2a-4b0f-9de9-efce9953c7f8", "name": "The request body is invalid", "originalRequest": { "url": { "path": [ "v1", "cart", "total" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"shipmentIds\": [\n \"s_2b28a63d65684f0aa4bcca24dafdc9df\",\n \"s_ca213cb9368c412291b8441c90c95592\"\n ],\n \"voucherCode\": \"XmasDiscount\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"title\": \"An error occurred\",\n \"detail\": \"shipmentId: This value should not be blank.\\nsettings: This value should not be blank.\",\n \"status\": 400,\n \"type\": \"/validation_errors/0=c1051bb4-d103-4f74-8988-acbcafc7fdc3;1=c1051bb4-d103-4f74-8988-acbcafc7fdc3\",\n \"violations\": [\n {\n \"propertyPath\": \"shipmentId\",\n \"message\": \"This value should not be blank.\",\n \"code\": \"c1051bb4-d103-4f74-8988-acbcafc7fdc3\"\n },\n {\n \"propertyPath\": \"settings\",\n \"message\": \"This value should not be blank.\",\n \"code\": \"c1051bb4-d103-4f74-8988-acbcafc7fdc3\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b490b091-5f4a-4c68-a349-0fc6ba05b436", "name": "No valid token or API key was provided, or the account is disabled", "originalRequest": { "url": { "path": [ "v1", "cart", "total" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"shipmentIds\": [\n \"s_2b28a63d65684f0aa4bcca24dafdc9df\",\n \"s_ca213cb9368c412291b8441c90c95592\"\n ],\n \"voucherCode\": \"XmasDiscount\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"No API token provided\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a60fe373-c822-4003-8ce5-10fa0b4d6649", "name": "The credential is valid but may not perform this action, e.g. a read-only token on a write operation or `full_team` without the team permission. An integration token whose customer headers do not verify answers with the `401`-style body instead.", "originalRequest": { "url": { "path": [ "v1", "cart", "total" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"shipmentIds\": [\n \"s_2b28a63d65684f0aa4bcca24dafdc9df\",\n \"s_ca213cb9368c412291b8441c90c95592\"\n ],\n \"voucherCode\": \"XmasDiscount\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Customer verification failed\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ff50108-2551-4c11-b71d-513365f4a885", "name": "The resource does not exist or belongs to another account", "originalRequest": { "url": { "path": [ "v1", "cart", "total" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"shipmentIds\": [\n \"s_2b28a63d65684f0aa4bcca24dafdc9df\",\n \"s_ca213cb9368c412291b8441c90c95592\"\n ],\n \"voucherCode\": \"XmasDiscount\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"title\": \"An error occurred\",\n \"detail\": \"Shipment not found\",\n \"status\": 404,\n \"type\": \"/errors/404\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Order", "description": "An order is the paid set of shipments and carries the invoices, labels and customs documents.", "item": [ { "id": "f6a91022-8b4c-43dc-b821-9df91a0938d0", "name": "List orders", "request": { "name": "List orders", "description": {}, "url": { "path": [ "v1", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Accepted for compatibility with the shipment endpoints and ignored; the list always contains your own orders. (This can only be one of 0,1)", "type": "text/plain" }, "key": "full_team", "value": "1" }, { "disabled": true, "description": { "content": "Marks the response as a file download (`Content-Disposition: attachment`). The content stays in the requested format.", "type": "text/plain" }, "key": "export", "value": "2485" }, { "disabled": true, "description": { "content": "Filter by array of exact payment method names. For example: [\"paypal\", \"sofort\"]", "type": "text/plain" }, "key": "paymentMethod[]", "value": "string" }, { "disabled": true, "description": { "content": "Filter by array of exact payment method names. For example: [\"paypal\", \"sofort\"]", "type": "text/plain" }, "key": "paymentMethod[]", "value": "string" }, { "disabled": true, "description": { "content": "Filter by payment status, `1` for unpaid and `0` for paid. Covers invoice orders (`rechnung`, `sammelrechnung`); `lastschrift` orders match neither value.", "type": "text/plain" }, "key": "paymentStatus", "value": "string" }, { "disabled": true, "description": { "content": "Filter by created before the date. For example: \"2020-09-19\". Only the date part is used: `before` includes the whole day, `after` starts at 00:00.", "type": "text/plain" }, "key": "created[before]", "value": "string" }, { "disabled": true, "description": { "content": "Filter by created after the date. For example: \"2020-09-19\". Only the date part is used: `before` includes the whole day, `after` starts at 00:00.", "type": "text/plain" }, "key": "created[after]", "value": "string" }, { "disabled": true, "description": { "content": "Sort by created. For example: \"asc\"", "type": "text/plain" }, "key": "sort[created]", "value": "string" }, { "disabled": true, "description": { "content": "Sort by gross. For example: \"desc\"", "type": "text/plain" }, "key": "sort[gross]", "value": "string" }, { "disabled": true, "description": { "content": "Sort by orderNumber. For example: \"asc\"", "type": "text/plain" }, "key": "sort[orderNumber]", "value": "string" }, { "disabled": true, "description": { "content": "Sort by unpaid. For example: \"desc\"", "type": "text/plain" }, "key": "sort[unpaid]", "value": "string" }, { "disabled": true, "description": { "content": "Full text search over the shipments of each order: shipment number, tracking number, reference number, pickup code, sender address (return address), recipient address, billing address and e-mail address (email_label_copy or email_tracking). At least three characters.", "type": "text/plain" }, "key": "search", "value": "string" }, { "disabled": true, "description": { "content": "The collection page number", "type": "text/plain" }, "key": "page", "value": "2485" }, { "disabled": true, "description": { "content": "`false` returns every matching order in one response instead of a page.", "type": "text/plain" }, "key": "pagination", "value": "false" }, { "disabled": true, "description": { "content": "The number of items per page, 10 by default", "type": "text/plain" }, "key": "itemsPerPage", "value": "2485" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "393585d1-acf1-4e77-ae62-c9efba02830b", "name": "One page of orders; with `export` the same content as a file download", "originalRequest": { "url": { "path": [ "v1", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Accepted for compatibility with the shipment endpoints and ignored; the list always contains your own orders. (This can only be one of 0,1)", "type": "text/plain" }, "key": "full_team", "value": "1" }, { "disabled": true, "description": { "content": "Marks the response as a file download (`Content-Disposition: attachment`). The content stays in the requested format.", "type": "text/plain" }, "key": "export", "value": "2485" }, { "disabled": true, "description": { "content": "Filter by array of exact payment method names. For example: [\"paypal\", \"sofort\"]", "type": "text/plain" }, "key": "paymentMethod[]", "value": "string" }, { "disabled": true, "description": { "content": "Filter by payment status, `1` for unpaid and `0` for paid. Covers invoice orders (`rechnung`, `sammelrechnung`); `lastschrift` orders match neither value.", "type": "text/plain" }, "key": "paymentStatus", "value": "string" }, { "disabled": true, "description": { "content": "Filter by created before the date. For example: \"2020-09-19\". Only the date part is used: `before` includes the whole day, `after` starts at 00:00.", "type": "text/plain" }, "key": "created[before]", "value": "string" }, { "disabled": true, "description": { "content": "Filter by created after the date. For example: \"2020-09-19\". Only the date part is used: `before` includes the whole day, `after` starts at 00:00.", "type": "text/plain" }, "key": "created[after]", "value": "string" }, { "disabled": true, "description": { "content": "Sort by created. For example: \"asc\"", "type": "text/plain" }, "key": "sort[created]", "value": "string" }, { "disabled": true, "description": { "content": "Sort by gross. For example: \"desc\"", "type": "text/plain" }, "key": "sort[gross]", "value": "string" }, { "disabled": true, "description": { "content": "Sort by orderNumber. For example: \"asc\"", "type": "text/plain" }, "key": "sort[orderNumber]", "value": "string" }, { "disabled": true, "description": { "content": "Sort by unpaid. For example: \"desc\"", "type": "text/plain" }, "key": "sort[unpaid]", "value": "string" }, { "disabled": true, "description": { "content": "Full text search over the shipments of each order: shipment number, tracking number, reference number, pickup code, sender address (return address), recipient address, billing address and e-mail address (email_label_copy or email_tracking). At least three characters.", "type": "text/plain" }, "key": "search", "value": "string" }, { "disabled": true, "description": { "content": "The collection page number", "type": "text/plain" }, "key": "page", "value": "2485" }, { "disabled": true, "description": { "content": "`false` returns every matching order in one response instead of a page.", "type": "text/plain" }, "key": "pagination", "value": "false" }, { "disabled": true, "description": { "content": "The number of items per page, 10 by default", "type": "text/plain" }, "key": "itemsPerPage", "value": "2485" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"accountOwner\": \"7eabed77-eb65-40be-a0b4-4c24a0eda784\",\n \"bic\": \"bic\",\n \"cancelOrderLink\": \"2/7\",\n \"created\": \"2026-10-21 10:40:32\",\n \"currency\": \"EUR\",\n \"currencyDetails\": null,\n \"customer\": {\n \"customerNumber\": 200002,\n \"addresses\": [\n {\n \"id\": 1148,\n \"company\": \"Jumingo Inc.\",\n \"name\": \"Ajax\",\n \"street\": \"Kürfürstendamm 32\",\n \"street2\": \"Alexanderplatz\",\n \"zip\": \"12345\",\n \"city\": \"Berlin\",\n \"state\": null,\n \"country\": \"DE\",\n \"phone\": \"380432144556\"\n }\n ]\n },\n \"discountPercent\": 0,\n \"documents\": {\n \"orderNumber\": \"2024010311\",\n \"id\": \"2024010311\",\n \"invoicesCount\": 0,\n \"proformasCount\": 1,\n \"commercialInvoicesCount\": 0,\n \"confirmationsCount\": 1,\n \"exportCertVatCount\": 0,\n \"invoices\": [],\n \"confirmations\": [],\n \"proformas\": [],\n \"labels\": [],\n \"exportCertVat\": [],\n \"commercialInvoices\": [],\n \"exportDeclarations\": []\n },\n \"gross\": 2.1,\n \"iban\": \"iban\",\n \"lastschriftmandat\": \"tt\",\n \"modified\": \"2026-10-21 10:40:32\",\n \"orderNumber\": \"B-2024010311\",\n \"paymentCreditcardNumber\": null,\n \"paymentData\": null,\n \"paymentDate\": \"2026-10-26 09:05:32\",\n \"paymentMethod\": \"creditcard\",\n \"paymentReceipt\": 0,\n \"paymentSurcharge\": 0,\n \"paymentTransactionId\": null,\n \"paypalEmail\": \"email\",\n \"paypalPuiAccountHolderName\": null,\n \"paypalPuiBankIdentifierCode\": null,\n \"paypalPuiBankName\": null,\n \"paypalPuiCurrency\": null,\n \"paypalPuiInternationalBankAccountNumber\": null,\n \"paypalPuiPaymentDueDate\": null,\n \"paypalPuiReferenceNumber\": null,\n \"paypalPuiValue\": null,\n \"paypalTransactionId\": \"transaction_id\",\n \"shipments\": [\n {\n \"id\": 333,\n \"uuid\": \"s_21b7f7ad8a584fce9f776b9cf6004711\",\n \"orderShipmentNumber\": \"2024010311-1\",\n \"shipmentContent\": \"PS-5\",\n \"shipmentValue\": 999,\n \"trackingNumber\": \"TN-12345\"\n }\n ],\n \"sofortTransactionId\": \"transaction_id\",\n \"subtotal\": 0,\n \"surcharges\": 0,\n \"tax\": 2.5,\n \"taxFreeNet\": 2.5,\n \"taxNet\": 2.5,\n \"unpaid\": true,\n \"voucherCode\": \"\",\n \"voucherValue\": 0,\n \"voucherPercent\": 0.1,\n \"voucherType\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b529b08-9826-415d-a024-aab0a110ad1b", "name": "The request cannot be fulfilled in the current state", "originalRequest": { "url": { "path": [ "v1", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Accepted for compatibility with the shipment endpoints and ignored; the list always contains your own orders. (This can only be one of 0,1)", "type": "text/plain" }, "key": "full_team", "value": "1" }, { "disabled": true, "description": { "content": "Marks the response as a file download (`Content-Disposition: attachment`). The content stays in the requested format.", "type": "text/plain" }, "key": "export", "value": "2485" }, { "disabled": true, "description": { "content": "Filter by array of exact payment method names. For example: [\"paypal\", \"sofort\"]", "type": "text/plain" }, "key": "paymentMethod[]", "value": "string" }, { "disabled": true, "description": { "content": "Filter by payment status, `1` for unpaid and `0` for paid. Covers invoice orders (`rechnung`, `sammelrechnung`); `lastschrift` orders match neither value.", "type": "text/plain" }, "key": "paymentStatus", "value": "string" }, { "disabled": true, "description": { "content": "Filter by created before the date. For example: \"2020-09-19\". Only the date part is used: `before` includes the whole day, `after` starts at 00:00.", "type": "text/plain" }, "key": "created[before]", "value": "string" }, { "disabled": true, "description": { "content": "Filter by created after the date. For example: \"2020-09-19\". Only the date part is used: `before` includes the whole day, `after` starts at 00:00.", "type": "text/plain" }, "key": "created[after]", "value": "string" }, { "disabled": true, "description": { "content": "Sort by created. For example: \"asc\"", "type": "text/plain" }, "key": "sort[created]", "value": "string" }, { "disabled": true, "description": { "content": "Sort by gross. For example: \"desc\"", "type": "text/plain" }, "key": "sort[gross]", "value": "string" }, { "disabled": true, "description": { "content": "Sort by orderNumber. For example: \"asc\"", "type": "text/plain" }, "key": "sort[orderNumber]", "value": "string" }, { "disabled": true, "description": { "content": "Sort by unpaid. For example: \"desc\"", "type": "text/plain" }, "key": "sort[unpaid]", "value": "string" }, { "disabled": true, "description": { "content": "Full text search over the shipments of each order: shipment number, tracking number, reference number, pickup code, sender address (return address), recipient address, billing address and e-mail address (email_label_copy or email_tracking). At least three characters.", "type": "text/plain" }, "key": "search", "value": "string" }, { "disabled": true, "description": { "content": "The collection page number", "type": "text/plain" }, "key": "page", "value": "2485" }, { "disabled": true, "description": { "content": "`false` returns every matching order in one response instead of a page.", "type": "text/plain" }, "key": "pagination", "value": "false" }, { "disabled": true, "description": { "content": "The number of items per page, 10 by default", "type": "text/plain" }, "key": "itemsPerPage", "value": "2485" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"title\": \"An error occurred\",\n \"detail\": \"Cannot change the shipment because it has already been ordered\",\n \"status\": 400,\n \"type\": \"/errors/400\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17cfa11c-6b13-4f4c-a8f4-d6bbdc1fbb0a", "name": "No valid token or API key was provided, or the account is disabled", "originalRequest": { "url": { "path": [ "v1", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Accepted for compatibility with the shipment endpoints and ignored; the list always contains your own orders. (This can only be one of 0,1)", "type": "text/plain" }, "key": "full_team", "value": "1" }, { "disabled": true, "description": { "content": "Marks the response as a file download (`Content-Disposition: attachment`). The content stays in the requested format.", "type": "text/plain" }, "key": "export", "value": "2485" }, { "disabled": true, "description": { "content": "Filter by array of exact payment method names. For example: [\"paypal\", \"sofort\"]", "type": "text/plain" }, "key": "paymentMethod[]", "value": "string" }, { "disabled": true, "description": { "content": "Filter by payment status, `1` for unpaid and `0` for paid. Covers invoice orders (`rechnung`, `sammelrechnung`); `lastschrift` orders match neither value.", "type": "text/plain" }, "key": "paymentStatus", "value": "string" }, { "disabled": true, "description": { "content": "Filter by created before the date. For example: \"2020-09-19\". Only the date part is used: `before` includes the whole day, `after` starts at 00:00.", "type": "text/plain" }, "key": "created[before]", "value": "string" }, { "disabled": true, "description": { "content": "Filter by created after the date. For example: \"2020-09-19\". Only the date part is used: `before` includes the whole day, `after` starts at 00:00.", "type": "text/plain" }, "key": "created[after]", "value": "string" }, { "disabled": true, "description": { "content": "Sort by created. For example: \"asc\"", "type": "text/plain" }, "key": "sort[created]", "value": "string" }, { "disabled": true, "description": { "content": "Sort by gross. For example: \"desc\"", "type": "text/plain" }, "key": "sort[gross]", "value": "string" }, { "disabled": true, "description": { "content": "Sort by orderNumber. For example: \"asc\"", "type": "text/plain" }, "key": "sort[orderNumber]", "value": "string" }, { "disabled": true, "description": { "content": "Sort by unpaid. For example: \"desc\"", "type": "text/plain" }, "key": "sort[unpaid]", "value": "string" }, { "disabled": true, "description": { "content": "Full text search over the shipments of each order: shipment number, tracking number, reference number, pickup code, sender address (return address), recipient address, billing address and e-mail address (email_label_copy or email_tracking). At least three characters.", "type": "text/plain" }, "key": "search", "value": "string" }, { "disabled": true, "description": { "content": "The collection page number", "type": "text/plain" }, "key": "page", "value": "2485" }, { "disabled": true, "description": { "content": "`false` returns every matching order in one response instead of a page.", "type": "text/plain" }, "key": "pagination", "value": "false" }, { "disabled": true, "description": { "content": "The number of items per page, 10 by default", "type": "text/plain" }, "key": "itemsPerPage", "value": "2485" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"No API token provided\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0d220412-3b8a-47cf-b8fc-23b3100b88c5", "name": "Pay for shipments", "request": { "name": "Pay for shipments", "description": { "content": "Pays for the given shipments with the chosen payment method and creates the order. The shipments must have a rate and complete data; `POST /v1/cart/total` tells you beforehand which payment methods the account may use and which shipments still have problems.", "type": "text/plain" }, "url": { "path": [ "v1", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"method\": \"rechnung\",\n \"shipmentIds\": [\n \"s_2b28a63d65684f0aa4bcca24dafdc9df\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "af0fc438-e639-4fc4-9b36-de00e751571c", "name": "The payment succeeded or was started", "originalRequest": { "url": { "path": [ "v1", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"method\": \"rechnung\",\n \"shipmentIds\": [\n \"s_2b28a63d65684f0aa4bcca24dafdc9df\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1,\n \"success\": true,\n \"returnUrl\": null,\n \"failureUrl\": null,\n \"message\": null,\n \"paymentRedirectUrl\": null,\n \"returnData\": [],\n \"orderNumber\": \"2024010311\",\n \"token\": null,\n \"customerNumber\": 920119,\n \"hadOrderBefore\": true,\n \"shipmentIds\": [\n \"s_21b7f7ad8a584fce9f776b9cf6004711\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f6322a2-932d-4f60-aac2-b0a1028501c5", "name": "The request body is invalid (`violations` lists the fields) or the request cannot be fulfilled in the current state", "originalRequest": { "url": { "path": [ "v1", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"method\": \"rechnung\",\n \"shipmentIds\": [\n \"s_2b28a63d65684f0aa4bcca24dafdc9df\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"title\": \"An error occurred\",\n \"detail\": \"shipmentId: This value should not be blank.\\nsettings: This value should not be blank.\",\n \"status\": 400,\n \"type\": \"/validation_errors/0=c1051bb4-d103-4f74-8988-acbcafc7fdc3;1=c1051bb4-d103-4f74-8988-acbcafc7fdc3\",\n \"violations\": [\n {\n \"propertyPath\": \"shipmentId\",\n \"message\": \"This value should not be blank.\",\n \"code\": \"c1051bb4-d103-4f74-8988-acbcafc7fdc3\"\n },\n {\n \"propertyPath\": \"settings\",\n \"message\": \"This value should not be blank.\",\n \"code\": \"c1051bb4-d103-4f74-8988-acbcafc7fdc3\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b25ef39-5195-46c9-a76d-923c226ccef2", "name": "No valid token or API key was provided, or the account is disabled", "originalRequest": { "url": { "path": [ "v1", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"method\": \"rechnung\",\n \"shipmentIds\": [\n \"s_2b28a63d65684f0aa4bcca24dafdc9df\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"No API token provided\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a59e71ec-21d0-4088-a15f-55402e416b29", "name": "The credential is valid but may not perform this action, e.g. a read-only token on a write operation or `full_team` without the team permission. An integration token whose customer headers do not verify answers with the `401`-style body instead.", "originalRequest": { "url": { "path": [ "v1", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"method\": \"rechnung\",\n \"shipmentIds\": [\n \"s_2b28a63d65684f0aa4bcca24dafdc9df\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Customer verification failed\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1e242f3b-ce65-457e-bdc8-047850f32dd9", "name": "Get an order", "request": { "name": "Get an order", "description": {}, "url": { "path": [ "v1", "orders", ":orderNumber" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "2024010311", "key": "orderNumber", "disabled": false, "description": { "content": "(Required) The order number, with or without its `B-` prefix.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "83275933-6b10-4ca6-8282-69825848d176", "name": "The order", "originalRequest": { "url": { "path": [ "v1", "orders", ":orderNumber" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The order number, with or without its `B-` prefix.", "type": "text/plain" }, "type": "any", "value": "2024010311", "key": "orderNumber" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountOwner\": \"7eabed77-eb65-40be-a0b4-4c24a0eda784\",\n \"bic\": \"bic\",\n \"cancelOrderLink\": \"2/7\",\n \"created\": \"2026-10-21 10:40:32\",\n \"currency\": \"EUR\",\n \"currencyDetails\": null,\n \"customer\": {\n \"customerNumber\": 200002,\n \"addresses\": [\n {\n \"id\": 1148,\n \"company\": \"Jumingo Inc.\",\n \"name\": \"Ajax\",\n \"street\": \"Kürfürstendamm 32\",\n \"street2\": \"Alexanderplatz\",\n \"zip\": \"12345\",\n \"city\": \"Berlin\",\n \"state\": null,\n \"country\": \"DE\",\n \"phone\": \"380432144556\"\n }\n ]\n },\n \"discountPercent\": 0,\n \"documents\": {\n \"orderNumber\": \"2024010311\",\n \"id\": \"2024010311\",\n \"invoicesCount\": 0,\n \"proformasCount\": 1,\n \"commercialInvoicesCount\": 0,\n \"confirmationsCount\": 1,\n \"exportCertVatCount\": 0,\n \"invoices\": [],\n \"confirmations\": [],\n \"proformas\": [],\n \"labels\": [],\n \"exportCertVat\": [],\n \"commercialInvoices\": [],\n \"exportDeclarations\": []\n },\n \"gross\": 2.1,\n \"iban\": \"iban\",\n \"lastschriftmandat\": \"tt\",\n \"modified\": \"2026-10-21 10:40:32\",\n \"orderNumber\": \"B-2024010311\",\n \"paymentCreditcardNumber\": null,\n \"paymentData\": null,\n \"paymentDate\": \"2026-10-26 09:05:32\",\n \"paymentMethod\": \"creditcard\",\n \"paymentReceipt\": 0,\n \"paymentSurcharge\": 0,\n \"paymentTransactionId\": null,\n \"paypalEmail\": \"email\",\n \"paypalPuiAccountHolderName\": null,\n \"paypalPuiBankIdentifierCode\": null,\n \"paypalPuiBankName\": null,\n \"paypalPuiCurrency\": null,\n \"paypalPuiInternationalBankAccountNumber\": null,\n \"paypalPuiPaymentDueDate\": null,\n \"paypalPuiReferenceNumber\": null,\n \"paypalPuiValue\": null,\n \"paypalTransactionId\": \"transaction_id\",\n \"shipments\": [\n {\n \"id\": 333,\n \"uuid\": \"s_21b7f7ad8a584fce9f776b9cf6004711\",\n \"orderShipmentNumber\": \"2024010311-1\",\n \"shipmentContent\": \"PS-5\",\n \"shipmentValue\": 999,\n \"trackingNumber\": \"TN-12345\"\n }\n ],\n \"sofortTransactionId\": \"transaction_id\",\n \"subtotal\": 0,\n \"surcharges\": 0,\n \"tax\": 2.5,\n \"taxFreeNet\": 2.5,\n \"taxNet\": 2.5,\n \"unpaid\": true,\n \"voucherCode\": \"\",\n \"voucherValue\": 0,\n \"voucherPercent\": 0.1,\n \"voucherType\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "784e5d6b-db6c-4010-bfc7-97e53f4e1b60", "name": "No valid token or API key was provided, or the account is disabled", "originalRequest": { "url": { "path": [ "v1", "orders", ":orderNumber" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The order number, with or without its `B-` prefix.", "type": "text/plain" }, "type": "any", "value": "2024010311", "key": "orderNumber" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"No API token provided\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0876994-364a-480d-8ede-7d665b57493d", "name": "The resource does not exist or belongs to another account", "originalRequest": { "url": { "path": [ "v1", "orders", ":orderNumber" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The order number, with or without its `B-` prefix.", "type": "text/plain" }, "type": "any", "value": "2024010311", "key": "orderNumber" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"title\": \"An error occurred\",\n \"detail\": \"Shipment not found\",\n \"status\": 404,\n \"type\": \"/errors/404\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "376b3f81-1b5e-4d28-9ee5-5a77313ad4d8", "name": "Get the documents of an order", "request": { "name": "Get the documents of an order", "description": {}, "url": { "path": [ "v1", "orders", ":orderNumber", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "2024010311", "key": "orderNumber", "disabled": false, "description": { "content": "(Required) The order number without the `B-` prefix that the order list and `GET /v1/orders/{orderNumber}` return; a prefixed number is not found.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "fbb30cf2-3af0-4dae-b33d-bdf862e04f8a", "name": "The documents of the order", "originalRequest": { "url": { "path": [ "v1", "orders", ":orderNumber", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The order number without the `B-` prefix that the order list and `GET /v1/orders/{orderNumber}` return; a prefixed number is not found.", "type": "text/plain" }, "type": "any", "value": "2024010311", "key": "orderNumber" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"invoicesCount\": 0,\n \"proformasCount\": 1,\n \"commercialInvoicesCount\": 0,\n \"confirmationsCount\": 1,\n \"exportCertVatCount\": 0,\n \"invoices\": [],\n \"confirmations\": [],\n \"proformas\": [],\n \"labels\": [],\n \"exportCertVat\": [],\n \"commercialInvoices\": [],\n \"exportDeclarations\": []\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1192fe2e-5eeb-4934-af64-b8b322cdda53", "name": "No valid token or API key was provided, or the account is disabled", "originalRequest": { "url": { "path": [ "v1", "orders", ":orderNumber", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The order number without the `B-` prefix that the order list and `GET /v1/orders/{orderNumber}` return; a prefixed number is not found.", "type": "text/plain" }, "type": "any", "value": "2024010311", "key": "orderNumber" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"No API token provided\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1222b5f9-e532-4cca-b941-7949e9debbe4", "name": "The resource does not exist or belongs to another account", "originalRequest": { "url": { "path": [ "v1", "orders", ":orderNumber", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The order number without the `B-` prefix that the order list and `GET /v1/orders/{orderNumber}` return; a prefixed number is not found.", "type": "text/plain" }, "type": "any", "value": "2024010311", "key": "orderNumber" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"title\": \"An error occurred\",\n \"detail\": \"Shipment not found\",\n \"status\": 404,\n \"type\": \"/errors/404\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a20311b9-c130-492e-b509-6a14bb9b0114", "name": "Download a document of an order", "request": { "name": "Download a document of an order", "description": { "content": "Streams one document of the order as a PDF download. `name` is the `reference` the documents endpoint returns for the document, e.g. `2611207EKN-1` for the label of the first shipment. For `commercial-invoices` the document always covers the order in the path, so any value is accepted as `name`, e.g. the order number.", "type": "text/plain" }, "url": { "path": [ "v1", "orders", ":orderNumber", "file", ":type", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "2024010311", "key": "orderNumber", "disabled": false, "description": { "content": "(Required) The order number without the `B-` prefix that the order list and `GET /v1/orders/{orderNumber}` return; a prefixed number is not found.", "type": "text/plain" } }, { "type": "any", "value": "commercial-invoices", "key": "type", "disabled": false, "description": { "content": "(Required) The document type. (This can only be one of public,label,proforma,collective_bill,invoice,credit_invoice,debit_invoice,orderconfirmation,reminder,export_cert_vat,commercial-invoice,commercial-invoices,export-declaration,proof-of-export)", "type": "text/plain" } }, { "type": "any", "value": "2024010311", "key": "name", "disabled": false, "description": { "content": "(Required) The reference of the document, as returned in the documents of the order.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ce66bf3b-72bf-4b00-a2aa-791f6923cf5a", "name": "The document as a file download; `Content-Disposition` carries the file name.", "originalRequest": { "url": { "path": [ "v1", "orders", ":orderNumber", "file", ":type", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The order number without the `B-` prefix that the order list and `GET /v1/orders/{orderNumber}` return; a prefixed number is not found.", "type": "text/plain" }, "type": "any", "value": "2024010311", "key": "orderNumber" }, { "disabled": false, "description": { "content": "(Required) The document type. (This can only be one of public,label,proforma,collective_bill,invoice,credit_invoice,debit_invoice,orderconfirmation,reminder,export_cert_vat,commercial-invoice,commercial-invoices,export-declaration,proof-of-export)", "type": "text/plain" }, "type": "any", "value": "commercial-invoices", "key": "type" }, { "disabled": false, "description": { "content": "(Required) The reference of the document, as returned in the documents of the order.", "type": "text/plain" }, "type": "any", "value": "2024010311", "key": "name" } ] }, "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "body": "%PDF-1.4 ...", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c0c0a3ef-971a-4dc7-bb52-e32329e0c089", "name": "The request cannot be fulfilled in the current state", "originalRequest": { "url": { "path": [ "v1", "orders", ":orderNumber", "file", ":type", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The order number without the `B-` prefix that the order list and `GET /v1/orders/{orderNumber}` return; a prefixed number is not found.", "type": "text/plain" }, "type": "any", "value": "2024010311", "key": "orderNumber" }, { "disabled": false, "description": { "content": "(Required) The document type. (This can only be one of public,label,proforma,collective_bill,invoice,credit_invoice,debit_invoice,orderconfirmation,reminder,export_cert_vat,commercial-invoice,commercial-invoices,export-declaration,proof-of-export)", "type": "text/plain" }, "type": "any", "value": "commercial-invoices", "key": "type" }, { "disabled": false, "description": { "content": "(Required) The reference of the document, as returned in the documents of the order.", "type": "text/plain" }, "type": "any", "value": "2024010311", "key": "name" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"title\": \"An error occurred\",\n \"detail\": \"Cannot change the shipment because it has already been ordered\",\n \"status\": 400,\n \"type\": \"/errors/400\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "278ef7de-253b-44fd-9956-0ac873d128e5", "name": "No valid token or API key was provided, or the account is disabled", "originalRequest": { "url": { "path": [ "v1", "orders", ":orderNumber", "file", ":type", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The order number without the `B-` prefix that the order list and `GET /v1/orders/{orderNumber}` return; a prefixed number is not found.", "type": "text/plain" }, "type": "any", "value": "2024010311", "key": "orderNumber" }, { "disabled": false, "description": { "content": "(Required) The document type. (This can only be one of public,label,proforma,collective_bill,invoice,credit_invoice,debit_invoice,orderconfirmation,reminder,export_cert_vat,commercial-invoice,commercial-invoices,export-declaration,proof-of-export)", "type": "text/plain" }, "type": "any", "value": "commercial-invoices", "key": "type" }, { "disabled": false, "description": { "content": "(Required) The reference of the document, as returned in the documents of the order.", "type": "text/plain" }, "type": "any", "value": "2024010311", "key": "name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"No API token provided\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba4eeedd-9a45-499a-9540-7b740ce62ef2", "name": "The resource does not exist or belongs to another account", "originalRequest": { "url": { "path": [ "v1", "orders", ":orderNumber", "file", ":type", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The order number without the `B-` prefix that the order list and `GET /v1/orders/{orderNumber}` return; a prefixed number is not found.", "type": "text/plain" }, "type": "any", "value": "2024010311", "key": "orderNumber" }, { "disabled": false, "description": { "content": "(Required) The document type. (This can only be one of public,label,proforma,collective_bill,invoice,credit_invoice,debit_invoice,orderconfirmation,reminder,export_cert_vat,commercial-invoice,commercial-invoices,export-declaration,proof-of-export)", "type": "text/plain" }, "type": "any", "value": "commercial-invoices", "key": "type" }, { "disabled": false, "description": { "content": "(Required) The reference of the document, as returned in the documents of the order.", "type": "text/plain" }, "type": "any", "value": "2024010311", "key": "name" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"title\": \"An error occurred\",\n \"detail\": \"Shipment not found\",\n \"status\": 404,\n \"type\": \"/errors/404\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Connection", "description": "Connections link a shop or marketplace to your account. Creating them is for plugin developers only.", "item": [ { "id": "3e191347-e5eb-4664-8e50-28062c5268b2", "name": "List connections", "request": { "name": "List connections", "description": {}, "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status of connections (This can only be one of new,in_progress,error,success)", "type": "text/plain" }, "key": "status", "value": "success" }, { "disabled": true, "description": { "content": "Connection type ID", "type": "text/plain" }, "key": "connectionType", "value": "3668.318601797811" }, { "disabled": true, "description": { "content": "Sort by status (This can only be one of asc,desc)", "type": "text/plain" }, "key": "sort[status]", "value": "desc" }, { "disabled": true, "description": { "content": "Sort by connectionType (This can only be one of asc,desc)", "type": "text/plain" }, "key": "sort[connectionType]", "value": "desc" }, { "disabled": true, "description": { "content": "Sort by modified (This can only be one of asc,desc)", "type": "text/plain" }, "key": "sort[modified]", "value": "desc" }, { "disabled": true, "description": { "content": "The collection page number", "type": "text/plain" }, "key": "page", "value": "2485" }, { "disabled": true, "description": { "content": "The number of items per page", "type": "text/plain" }, "key": "itemsPerPage", "value": "2485" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1ad3800a-43d3-4df6-a7aa-81fdce868a8b", "name": "One page of connections", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status of connections (This can only be one of new,in_progress,error,success)", "type": "text/plain" }, "key": "status", "value": "success" }, { "disabled": true, "description": { "content": "Connection type ID", "type": "text/plain" }, "key": "connectionType", "value": "3668.318601797811" }, { "disabled": true, "description": { "content": "Sort by status (This can only be one of asc,desc)", "type": "text/plain" }, "key": "sort[status]", "value": "desc" }, { "disabled": true, "description": { "content": "Sort by connectionType (This can only be one of asc,desc)", "type": "text/plain" }, "key": "sort[connectionType]", "value": "desc" }, { "disabled": true, "description": { "content": "Sort by modified (This can only be one of asc,desc)", "type": "text/plain" }, "key": "sort[modified]", "value": "desc" }, { "disabled": true, "description": { "content": "The collection page number", "type": "text/plain" }, "key": "page", "value": "2485" }, { "disabled": true, "description": { "content": "The number of items per page", "type": "text/plain" }, "key": "itemsPerPage", "value": "2485" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 90,\n \"uuid\": \"s_c71525fb87f645ffbc126a7deec40001\",\n \"name\": \"Shop name\",\n \"customer\": \"/app/users/200002\",\n \"connectionType\": \"/app/connection-types/3\",\n \"active\": 1,\n \"lastSynced\": null,\n \"initSync\": \"0d\",\n \"syncPeriod\": \"0h\",\n \"sendTrackingMail\": 0,\n \"connectionDetails\": {\n \"settings\": \"settings\",\n \"shop_url\": \"https://www.example.org/\",\n \"plugin_name\": \"My shop plugin\",\n \"shop_version\": \"v1.0 beta\",\n \"plugin_version\": \"v1.1\"\n },\n \"status\": \"new\",\n \"message\": null,\n \"webhookUrl\": \"https://www.example.org/\",\n \"deleted\": 0,\n \"receiveWebhook\": false,\n \"created\": \"2026-10-21T02:00:00Z\",\n \"modified\": \"2026-10-21T02:00:00Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b5e1c5c-a425-4c48-bcb3-a5b71b773625", "name": "The request cannot be fulfilled in the current state", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status of connections (This can only be one of new,in_progress,error,success)", "type": "text/plain" }, "key": "status", "value": "success" }, { "disabled": true, "description": { "content": "Connection type ID", "type": "text/plain" }, "key": "connectionType", "value": "3668.318601797811" }, { "disabled": true, "description": { "content": "Sort by status (This can only be one of asc,desc)", "type": "text/plain" }, "key": "sort[status]", "value": "desc" }, { "disabled": true, "description": { "content": "Sort by connectionType (This can only be one of asc,desc)", "type": "text/plain" }, "key": "sort[connectionType]", "value": "desc" }, { "disabled": true, "description": { "content": "Sort by modified (This can only be one of asc,desc)", "type": "text/plain" }, "key": "sort[modified]", "value": "desc" }, { "disabled": true, "description": { "content": "The collection page number", "type": "text/plain" }, "key": "page", "value": "2485" }, { "disabled": true, "description": { "content": "The number of items per page", "type": "text/plain" }, "key": "itemsPerPage", "value": "2485" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"title\": \"An error occurred\",\n \"detail\": \"Cannot change the shipment because it has already been ordered\",\n \"status\": 400,\n \"type\": \"/errors/400\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "733b8a08-0a46-491b-a644-e477d74e27a7", "name": "No valid token or API key was provided, or the account is disabled", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status of connections (This can only be one of new,in_progress,error,success)", "type": "text/plain" }, "key": "status", "value": "success" }, { "disabled": true, "description": { "content": "Connection type ID", "type": "text/plain" }, "key": "connectionType", "value": "3668.318601797811" }, { "disabled": true, "description": { "content": "Sort by status (This can only be one of asc,desc)", "type": "text/plain" }, "key": "sort[status]", "value": "desc" }, { "disabled": true, "description": { "content": "Sort by connectionType (This can only be one of asc,desc)", "type": "text/plain" }, "key": "sort[connectionType]", "value": "desc" }, { "disabled": true, "description": { "content": "Sort by modified (This can only be one of asc,desc)", "type": "text/plain" }, "key": "sort[modified]", "value": "desc" }, { "disabled": true, "description": { "content": "The collection page number", "type": "text/plain" }, "key": "page", "value": "2485" }, { "disabled": true, "description": { "content": "The number of items per page", "type": "text/plain" }, "key": "itemsPerPage", "value": "2485" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"No API token provided\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "87d86270-cd4b-4321-8daf-2e0111c16229", "name": "Create a connection", "request": { "name": "Create a connection", "description": { "content": "Creates a new connection.\n\n**This API call is for e-commerce / shop plugin developers only.**\n\nAs a registered plugin developer, you have received additional, separate information for this call.\nIf you would like to create a new shop plugin, please contact our customer support for more information.", "type": "text/plain" }, "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"My shop\",\n \"type_id\": 3,\n \"webhook_url\": \"https://www.example.org/webhook\",\n \"shop_url\": \"https://www.example.org/\",\n \"shop_version\": \"v1.0\",\n \"plugin_name\": \"My shop plugin\",\n \"plugin_version\": \"v1.1\",\n \"settings\": \"settings\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e9b769cb-afa2-43d5-b751-35db6acf0a18", "name": "The connection was created", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"My shop\",\n \"type_id\": 3,\n \"webhook_url\": \"https://www.example.org/webhook\",\n \"shop_url\": \"https://www.example.org/\",\n \"shop_version\": \"v1.0\",\n \"plugin_name\": \"My shop plugin\",\n \"plugin_version\": \"v1.1\",\n \"settings\": \"settings\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"connection_uuid\": \"c_fafb10a828b242db9ac820d4d379686f\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "758f1b85-3346-4b1b-b298-57914f4e99a7", "name": "The request body is invalid", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"My shop\",\n \"type_id\": 3,\n \"webhook_url\": \"https://www.example.org/webhook\",\n \"shop_url\": \"https://www.example.org/\",\n \"shop_version\": \"v1.0\",\n \"plugin_name\": \"My shop plugin\",\n \"plugin_version\": \"v1.1\",\n \"settings\": \"settings\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"title\": \"An error occurred\",\n \"detail\": \"shipmentId: This value should not be blank.\\nsettings: This value should not be blank.\",\n \"status\": 400,\n \"type\": \"/validation_errors/0=c1051bb4-d103-4f74-8988-acbcafc7fdc3;1=c1051bb4-d103-4f74-8988-acbcafc7fdc3\",\n \"violations\": [\n {\n \"propertyPath\": \"shipmentId\",\n \"message\": \"This value should not be blank.\",\n \"code\": \"c1051bb4-d103-4f74-8988-acbcafc7fdc3\"\n },\n {\n \"propertyPath\": \"settings\",\n \"message\": \"This value should not be blank.\",\n \"code\": \"c1051bb4-d103-4f74-8988-acbcafc7fdc3\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ccae74c-cfce-4ce6-b1ae-121a0e7e35c9", "name": "No valid token or API key was provided, or the account is disabled", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"My shop\",\n \"type_id\": 3,\n \"webhook_url\": \"https://www.example.org/webhook\",\n \"shop_url\": \"https://www.example.org/\",\n \"shop_version\": \"v1.0\",\n \"plugin_name\": \"My shop plugin\",\n \"plugin_version\": \"v1.1\",\n \"settings\": \"settings\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"No API token provided\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b48831ee-0518-49d6-92e9-ab1a054310e6", "name": "The credential is valid but may not perform this action, e.g. a read-only token on a write operation or `full_team` without the team permission. An integration token whose customer headers do not verify answers with the `401`-style body instead.", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"My shop\",\n \"type_id\": 3,\n \"webhook_url\": \"https://www.example.org/webhook\",\n \"shop_url\": \"https://www.example.org/\",\n \"shop_version\": \"v1.0\",\n \"plugin_name\": \"My shop plugin\",\n \"plugin_version\": \"v1.1\",\n \"settings\": \"settings\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Customer verification failed\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9f79c0d1-f072-4cb0-9202-3f1a90295265", "name": "Get a connection", "request": { "name": "Get a connection", "description": {}, "url": { "path": [ "v1", "connections", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "s_c71525fb87f645ffbc126a7deec40011", "key": "uuid", "disabled": false, "description": { "content": "(Required) The connection id.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6d619215-69b3-4348-924e-092e0d72e4e2", "name": "The connection", "originalRequest": { "url": { "path": [ "v1", "connections", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The connection id.", "type": "text/plain" }, "type": "any", "value": "s_c71525fb87f645ffbc126a7deec40011", "key": "uuid" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 90,\n \"uuid\": \"s_c71525fb87f645ffbc126a7deec40001\",\n \"name\": \"Shop name\",\n \"customer\": \"/app/users/200002\",\n \"connectionType\": \"/app/connection-types/3\",\n \"active\": 1,\n \"lastSynced\": null,\n \"initSync\": \"0d\",\n \"syncPeriod\": \"0h\",\n \"sendTrackingMail\": 0,\n \"connectionDetails\": {\n \"settings\": \"settings\",\n \"shop_url\": \"https://www.example.org/\",\n \"plugin_name\": \"My shop plugin\",\n \"shop_version\": \"v1.0 beta\",\n \"plugin_version\": \"v1.1\"\n },\n \"status\": \"new\",\n \"message\": null,\n \"webhookUrl\": \"https://www.example.org/\",\n \"deleted\": 0,\n \"receiveWebhook\": false,\n \"created\": \"2026-10-21T02:00:00Z\",\n \"modified\": \"2026-10-21T02:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e5993db-9a57-42fa-a9a2-ca617ea1ff3c", "name": "No valid token or API key was provided, or the account is disabled", "originalRequest": { "url": { "path": [ "v1", "connections", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The connection id.", "type": "text/plain" }, "type": "any", "value": "s_c71525fb87f645ffbc126a7deec40011", "key": "uuid" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"No API token provided\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "599d9c39-9970-4f9a-8024-3d9f64e4337f", "name": "The resource does not exist or belongs to another account", "originalRequest": { "url": { "path": [ "v1", "connections", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The connection id.", "type": "text/plain" }, "type": "any", "value": "s_c71525fb87f645ffbc126a7deec40011", "key": "uuid" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"title\": \"An error occurred\",\n \"detail\": \"Shipment not found\",\n \"status\": 404,\n \"type\": \"/errors/404\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Carrier", "description": "Carrier data such as access points (parcel shops and lockers).", "item": [ { "id": "90bb106e-785d-44c9-92ea-880748d8aa05", "name": "Search carrier access points", "request": { "name": "Search carrier access points", "description": { "content": "Lists the carrier locations near an address. Which address fields a search needs depends on the carrier (UPS and DPD need `city`, GLS needs `postCode`); a missing one is reported per carrier in `errors` of the response, not as an error status. Limited to 150 calls per account in 24 hours.", "type": "text/plain" }, "url": { "path": [ "v1", "carrier", "access-points-search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"carrierCodes\": [\n \"ups\"\n ],\n \"countryCode\": \"DE\",\n \"city\": \"Neuss\",\n \"postCode\": \"41460\",\n \"street\": \"Markt 2\",\n \"state\": \"\",\n \"radius\": 10,\n \"onlyOpen\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7584a6a4-cb42-45ee-869a-27ab667efe68", "name": "The access points per carrier", "originalRequest": { "url": { "path": [ "v1", "carrier", "access-points-search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"carrierCodes\": [\n \"ups\"\n ],\n \"countryCode\": \"DE\",\n \"city\": \"Neuss\",\n \"postCode\": \"41460\",\n \"street\": \"Markt 2\",\n \"state\": \"\",\n \"radius\": 10,\n \"onlyOpen\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1,\n \"accessPoints\": [],\n \"errors\": [\n {\n \"carrier\": \"ups\",\n \"messages\": [\n \"UPS OAuthToken request got en error\"\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32a1afd9-d098-4136-8a01-632022d49e49", "name": "The request body is invalid", "originalRequest": { "url": { "path": [ "v1", "carrier", "access-points-search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"carrierCodes\": [\n \"ups\"\n ],\n \"countryCode\": \"DE\",\n \"city\": \"Neuss\",\n \"postCode\": \"41460\",\n \"street\": \"Markt 2\",\n \"state\": \"\",\n \"radius\": 10,\n \"onlyOpen\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"title\": \"An error occurred\",\n \"detail\": \"shipmentId: This value should not be blank.\\nsettings: This value should not be blank.\",\n \"status\": 400,\n \"type\": \"/validation_errors/0=c1051bb4-d103-4f74-8988-acbcafc7fdc3;1=c1051bb4-d103-4f74-8988-acbcafc7fdc3\",\n \"violations\": [\n {\n \"propertyPath\": \"shipmentId\",\n \"message\": \"This value should not be blank.\",\n \"code\": \"c1051bb4-d103-4f74-8988-acbcafc7fdc3\"\n },\n {\n \"propertyPath\": \"settings\",\n \"message\": \"This value should not be blank.\",\n \"code\": \"c1051bb4-d103-4f74-8988-acbcafc7fdc3\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63d814db-1f6c-4343-8978-dc2ae03a5a83", "name": "No valid token or API key was provided, or the account is disabled", "originalRequest": { "url": { "path": [ "v1", "carrier", "access-points-search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"carrierCodes\": [\n \"ups\"\n ],\n \"countryCode\": \"DE\",\n \"city\": \"Neuss\",\n \"postCode\": \"41460\",\n \"street\": \"Markt 2\",\n \"state\": \"\",\n \"radius\": 10,\n \"onlyOpen\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"No API token provided\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1b2fb2a-eb1d-4197-ae20-36650b850827", "name": "The credential is valid but may not perform this action, e.g. a read-only token on a write operation or `full_team` without the team permission. An integration token whose customer headers do not verify answers with the `401`-style body instead.", "originalRequest": { "url": { "path": [ "v1", "carrier", "access-points-search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"carrierCodes\": [\n \"ups\"\n ],\n \"countryCode\": \"DE\",\n \"city\": \"Neuss\",\n \"postCode\": \"41460\",\n \"street\": \"Markt 2\",\n \"state\": \"\",\n \"radius\": 10,\n \"onlyOpen\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Customer verification failed\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55ac69b1-ff46-48e1-87f8-d9e1d2753efd", "name": "The rate limit of 150 calls per account in 24 hours is used up", "originalRequest": { "url": { "path": [ "v1", "carrier", "access-points-search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"carrierCodes\": [\n \"ups\"\n ],\n \"countryCode\": \"DE\",\n \"city\": \"Neuss\",\n \"postCode\": \"41460\",\n \"street\": \"Markt 2\",\n \"state\": \"\",\n \"radius\": 10,\n \"onlyOpen\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"title\": \"An error occurred\",\n \"detail\": \"API rate limit exceeded for: shipping@testcorp.example!\",\n \"status\": 429,\n \"type\": \"/errors/429\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] }, "event": [], "info": { "_postman_id": "444147ef-9d34-449f-b446-1fd258905c97", "name": "JUMiNGO API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "## About\n\nWith the JUMiNGO shipping API you import your shipments into your JUMiNGO account from any source, fetch the shipping rates available for them, buy the shipping labels and retrieve tracking data, labels and documents for every shipment you purchased.\n\nIts main purpose is to connect your account to e-commerce systems and marketplaces.\n\n## General\n\nThe API is organised around REST: resource-oriented URLs, JSON request and response bodies, standard HTTP verbs and HTTP status codes. All requests must be made over HTTPS; plain HTTP calls fail.\n\nBest-practice usage of the API and the business logic behind it are described in the guides on [developers.jumingo.com](https://developers.jumingo.com/), starting with the [quickstart](https://developers.jumingo.com/#description/quickstart).\n\n## Base URL\n\nAll paths in this reference are relative to `https://api.jumingo.com`, so the shipments collection is `https://api.jumingo.com/v1/shipments`.\n\n## Authentication\n\nEvery request needs a credential of your JUMiNGO account: a **personal access token** (recommended) or the **legacy API key**. A request without either is answered with `401` and `{\"message\": \"No API token provided\"}`.\n\n### Personal access token (recommended)\n\nEnable the customer API under [Connections](https://www.jumingo.com/de-de/users/connections/create/8), then create tokens under [My account › API tokens](https://www.jumingo.com/de-de/users/my-account/api-tokens). A token looks like `jum_` followed by 96 hexadecimal characters and is sent as a Bearer token:\n\n```\nAuthorization: Bearer jum_INSERT_YOUR_TOKEN\n```\n\nEach token has a name and a scope. A **Read** token may only call `GET` operations; a `POST`, `PUT`, `PATCH` or `DELETE` with it is answered with `403`. A **Read & write** token may call every operation. You can create several tokens (one per integration), rotate one (new secret, same name and scope) and revoke it at any time; the secret is shown once when the token is created. An unknown, revoked or expired token is answered with `401`, e.g. `{\"message\": \"Invalid API token\"}`.\n\n### API key (legacy)\n\nThe API key shown under Connections still works in the `X-AUTH-TOKEN` header:\n\n```\nX-AUTH-TOKEN: INSERT_YOUR_API_KEY\n```\n\nIt is a single unscoped key that cannot be rotated. **The API key is deprecated and stops working on 1 July 2027.** Switch your integration to a personal access token before that date. A wrong key is answered with `401` and `{\"message\": \"Invalid credentials.\"}`.\n\n## HTTP status codes\n\nCodes in the `2xx` range mean success, `4xx` an error on the client side (a missing parameter, a validation error, a resource that does not exist or that belongs to another account) and `5xx` an error on our side.\n\nHTTP status code | Meaning\n---------------- | -------\n200, 201, 204 | Everything worked. Creating operations answer `201`, deleting ones `204`.\n400 | The request was rejected. Invalid input comes with a `violations` list, see below.\n401 | No valid API key was provided or the account is disabled.\n403 | You are not allowed to call this endpoint.\n404 | The resource does not exist, or it belongs to another account.\n429 | The rate limit of the endpoint is used up. Only the access point search is limited today.\n500, 502, 503, 504 | Something went wrong on our side. Contact support if it persists.\n\n## Error responses\n\nEvery error except `401` is a [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) problem object (`Content-Type: application/problem+json`) with `title`, `detail`, `status` and `type`. Input validation errors (`400`) additionally carry a `violations` array with one entry per invalid field:\n\n```json\n{\n \"title\": \"An error occurred\",\n \"detail\": \"shipmentId: This value should not be blank.\",\n \"status\": 400,\n \"type\": \"/validation_errors/0=c1051bb4-d103-4f74-8988-acbcafc7fdc3\",\n \"violations\": [\n {\"propertyPath\": \"shipmentId\", \"message\": \"This value should not be blank.\", \"code\": \"c1051bb4-d103-4f74-8988-acbcafc7fdc3\"}\n ]\n}\n```\n\nMessages are returned in the language of your account.\n\n## Dates and times\n\nValues you send (`pickupDate`, `deliveryDate`, `order_date`, …) are `string