{ "openapi": "3.1.0", "info": { "title": "JUMiNGO API", "version": "1.1.0", "description": "> [!WARNING]\n> **Test request sends real calls.** The *Test request* panel next to every operation calls `https://api.jumingo.com` with the API key you enter, so a `POST` creates a real shipment or order in your account. There is no sandbox yet; use read operations such as `GET /v1/shipments` to explore, and keep your key out of shared screens. The key is stored only in your browser.\n\n## 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 supplementary [integration guide](https://www.jumingo.com/cms/JUMiNGO_API-integration-guide.pdf \"JUMiNGO API Integration Guide\").\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 your API key in the `X-AUTH-TOKEN` header:\n\n```\nX-AUTH-TOKEN: INSERT_YOUR_API_KEY\n```\n\nYou find the key in your JUMiNGO user account after enabling the customer API under [Connections](https://www.jumingo.com/de-de/users/connections/create/8). Requests without a valid key are answered with `401` and `{\"message\": \"No API token provided\"}`.\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.\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 ` in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339#section-5.6) format, e.g. `2026-11-11T16:11:52Z`; `string ` values are `YYYY-MM-DD`.\n\nTimestamps the API returns are **not** RFC 3339. They come in two shapes, named in this reference by the schema of the field:\n\n* `LocalDateTime` — `YYYY-MM-DD hh:mm:ss` in the Europe/Berlin time zone (CET/CEST), e.g. `2026-10-21 10:40:31`. Used for `created`, `last_modified`, `modified` and `paymentDate` of shipments and orders.\n* `MidnightDateTime` — `YYYY-MM-DDThh:mm:ssZ` where only the date part is meaningful, e.g. `2026-10-21T02:00:00Z`. Used for `created` and `modified` of connections and the delivery dates of a rate.\n\nDates nested in a shipment's `dates` object are pre-formatted for display in the language of the account.", "contact": { "name": "JUMiNGO GmbH", "email": "connections@jumingo.com" } }, "servers": [ { "url": "https://api.jumingo.com", "description": "Production" } ], "security": [ { "apiKey": [] } ], "tags": [ { "name": "Shipment", "description": "Shipments are the central resource: create them from your orders, rate them, pay for them and track them." }, { "name": "ShipmentRate", "description": "Rates are the carrier offers available for a shipment." }, { "name": "Cart", "description": "The cart totals the shipments you are about to pay for." }, { "name": "Order", "description": "An order is the paid set of shipments and carries the invoices, labels and customs documents." }, { "name": "Connection", "description": "Connections link a shop or marketplace to your account. Creating them is for plugin developers only." }, { "name": "Carrier", "description": "Carrier data such as access points (parcel shops and lockers)." } ], "paths": { "/v1/shipments": { "get": { "tags": [ "Shipment" ], "summary": "List shipments", "description": "Gets a list of all shipments. You can filter and sort the shipments. The pagination is done by limit and offset parameters.", "operationId": "listShipments", "parameters": [ { "name": "full_team", "in": "query", "required": false, "description": "`1` lists the shipments of the whole team instead of your own. Needs the team permission of your account, otherwise the response is 403.", "schema": { "type": "integer", "enum": [ 0, 1 ] } }, { "name": "muid[]", "in": "query", "required": false, "description": "Customer numbers of team members whose shipments to use instead of your own. Needs the team permission of your account.", "explode": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "status", "in": "query", "required": false, "description": "Status of shipments", "schema": { "type": "string", "enum": [ "all", "missing_data", "ready", "completed", "in_transit", "in_delivery", "delivered", "in_progress", "exception", "undelivered", "archived", "drafts", "ordered", "isThirdParty", "checkout", "get_rates", "save_changes", "delete", "buy", "buy_in_progress" ], "default": "all" } }, { "name": "importProgressStatus", "in": "query", "required": false, "description": "Import Progress Status of shipments", "schema": { "type": "string", "enum": [ "checkout", "get_rates", "save_changes", "delete", "buy", "buy_in_progress" ] } }, { "name": "created[before]", "in": "query", "required": false, "description": "Filter by created before the date and/or time. For example: \"2020-09-19T00:00:00.000\"", "schema": { "type": "string" } }, { "name": "created[after]", "in": "query", "required": false, "description": "Filter by created after the date and/or time. For example: \"2020-09-19T00:00:00.000\"", "schema": { "type": "string" } }, { "name": "sort[created]", "in": "query", "required": false, "description": "Sort by created. For example: \"asc\"", "schema": { "type": "string" } }, { "name": "sort[modified]", "in": "query", "required": false, "description": "Sort by modified. For example: \"desc\"", "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "description": "Full text search", "schema": { "type": "string" } }, { "name": "orderNumber", "in": "query", "required": false, "description": "Filter shipments by orderNumber", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The collection page number", "schema": { "type": "integer" } }, { "name": "itemsPerPage", "in": "query", "required": false, "description": "The number of items per page", "schema": { "type": "integer" } }, { "name": "pagination", "in": "query", "required": false, "description": "Client enable pagination", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "One page of shipments", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Shipment" } }, "examples": { "default": { "$ref": "#/components/examples/shipment-list" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } }, "post": { "tags": [ "Shipment" ], "summary": "Create a shipment", "description": "Creates a new shipment.\nIf you are using an e-commerce connection, you must specify the order data with \"connection_custom_data\".\n", "operationId": "createShipment", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateShipment" }, "examples": { "default": { "$ref": "#/components/examples/request-create-shipment" } } } } }, "responses": { "201": { "description": "The shipment was created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateShipmentResult" }, "examples": { "default": { "$ref": "#/components/examples/shipment-created" } } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } } }, "/v1/shipments/{uuid}": { "get": { "tags": [ "Shipment" ], "summary": "Get a shipment", "description": "Get a specific shipment based on the given shipment ID.", "operationId": "getShipment", "parameters": [ { "name": "full_team", "in": "query", "required": false, "description": "`1` lists the shipments of the whole team instead of your own. Needs the team permission of your account, otherwise the response is 403.", "schema": { "type": "integer", "enum": [ 0, 1 ] } }, { "name": "muid[]", "in": "query", "required": false, "description": "Customer numbers of team members whose shipments to use instead of your own. Needs the team permission of your account.", "explode": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "uuid", "in": "path", "required": true, "description": "The shipment id.", "schema": { "type": "string", "pattern": "^s_[0-9a-f]{32}$" }, "example": "s_21b7f7ad8a584fce9f776b9cf6004711" } ], "responses": { "200": { "description": "The shipment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" }, "examples": { "default": { "$ref": "#/components/examples/shipment" } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "tags": [ "Shipment" ], "summary": "Replace a shipment", "description": "Stores the given data as the whole shipment. Only possible until the shipment is ordered.", "operationId": "replaceShipment", "parameters": [ { "name": "uuid", "in": "path", "required": true, "description": "The shipment id.", "schema": { "type": "string", "pattern": "^s_[0-9a-f]{32}$" }, "example": "s_21b7f7ad8a584fce9f776b9cf6004711" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateShipment" }, "examples": { "default": { "$ref": "#/components/examples/request-update-shipment" } } } } }, "responses": { "200": { "description": "The updated shipment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" }, "examples": { "default": { "$ref": "#/components/examples/shipment" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "patch": { "tags": [ "Shipment" ], "summary": "Update parts of a shipment", "description": "Merges the given sections into the shipment (JSON merge patch). Only possible until the shipment is ordered.", "operationId": "updateShipment", "parameters": [ { "name": "uuid", "in": "path", "required": true, "description": "The shipment id.", "schema": { "type": "string", "pattern": "^s_[0-9a-f]{32}$" }, "example": "s_21b7f7ad8a584fce9f776b9cf6004711" } ], "requestBody": { "required": true, "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/PatchShipment" }, "examples": { "default": { "$ref": "#/components/examples/request-patch-shipment" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/PatchShipment" }, "examples": { "default": { "$ref": "#/components/examples/request-patch-shipment" } } } } }, "responses": { "200": { "description": "The updated shipment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" }, "examples": { "default": { "$ref": "#/components/examples/shipment" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "delete": { "tags": [ "Shipment" ], "summary": "Delete a shipment", "operationId": "deleteShipment", "parameters": [ { "name": "uuid", "in": "path", "required": true, "description": "The shipment id.", "schema": { "type": "string", "pattern": "^s_[0-9a-f]{32}$" }, "example": "s_21b7f7ad8a584fce9f776b9cf6004711" } ], "responses": { "204": { "description": "The shipment was deleted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/v1/shipments/cheapest": { "post": { "tags": [ "Shipment" ], "summary": "Select the cheapest rate for shipments", "description": "Update shipments rate with cheapest tariff", "operationId": "selectCheapestRates", "parameters": [ { "name": "shippingType", "in": "query", "required": false, "description": "Rate shipping type", "schema": { "type": "string", "enum": [ "pickup", "shop" ] } }, { "name": "tariffType", "in": "query", "required": false, "description": "Rate tariff type", "schema": { "type": "string", "enum": [ "Same Day", "Express", "Economy", "Standard" ] } }, { "name": "carrier", "in": "query", "required": false, "description": "Rate carrier", "schema": { "type": "string", "enum": [ "UPS", "DHL Express", "TNT", "FedEx", "dpd", "GLS", "JUMiNGO Cargo", "JUMiNGO Direct", "JUMiNGO Express", "Der Kurier", "bgm" ] } }, { "name": "sort", "in": "query", "required": false, "description": "Results sorting", "schema": { "type": "string", "enum": [ "fastest", "cheapest" ] } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "shipmentIds" ], "properties": { "shipmentIds": { "type": "array", "description": "The shipments to rate.", "items": { "type": "string", "example": "s_ca213cb9368c412291b8441c90c95592" } }, "rateInput": { "$ref": "#/components/schemas/ShipmentCheapestRateInput" } } }, "examples": { "default": { "$ref": "#/components/examples/request-cheapest-rates" } } } } }, "responses": { "200": { "description": "The cheapest matching rate was stored on every shipment. The response has no body." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } } }, "/v1/shipments/{uuid}/file/upload/{type}": { "post": { "tags": [ "Shipment" ], "summary": "Upload a customs document", "operationId": "uploadShipmentDocument", "parameters": [ { "name": "uuid", "in": "path", "required": true, "description": "The shipment id.", "schema": { "type": "string", "pattern": "^s_[0-9a-f]{32}$" }, "example": "s_21b7f7ad8a584fce9f776b9cf6004711" }, { "name": "type", "in": "path", "required": true, "description": "The document type.", "schema": { "type": "string", "enum": [ "commercial-invoice", "export-declaration", "proof-of-export", "customs-duty-notice" ] } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary", "description": "The PDF to attach." } } }, "examples": { "default": { "summary": "A commercial invoice as PDF", "value": { "file": "commercial-invoice.pdf" } } } } } }, "responses": { "201": { "description": "The document was stored", "content": { "application/json": { "schema": { "type": "array", "maxItems": 0, "items": true }, "example": [] } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "delete": { "tags": [ "Shipment" ], "summary": "Delete a customs document", "operationId": "deleteShipmentDocument", "parameters": [ { "name": "uuid", "in": "path", "required": true, "description": "The shipment id.", "schema": { "type": "string", "pattern": "^s_[0-9a-f]{32}$" }, "example": "s_21b7f7ad8a584fce9f776b9cf6004711" }, { "name": "type", "in": "path", "required": true, "description": "The document type.", "schema": { "type": "string", "enum": [ "commercial-invoice", "export-declaration", "proof-of-export", "customs-duty-notice" ] } } ], "responses": { "204": { "description": "The document was deleted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/v1/shipment-rates": { "post": { "tags": [ "ShipmentRate" ], "summary": "Get the rates for a shipment", "description": "With this endpoint you can fetch available shipment rates for a given shipment. It is necessary to include a valid shipmentId in the request body. Best practice is to create a shipment first, including the sender and delivery address, the packaging type and all package dimensions. The returned shipment ID can be used in the shipment-rates call to get all available rates for this shipment from the JUMiNGO system.\n\n**Minimum input**\nreplace shipment id with shipment from your account to receive available rates. Although it is not required to include the packaging type ID in the request, the results will be more relevant if you add one.\n```\n {\n \"shipmentId\":\"s_2b28a63d65684f0aa4bcca24dafdc9df\",\n \"filterData\": {\n \"timeMax\": 1440,\n \"timeMin\": 0\n },\n \"settings\":{\n \"mode\":\"m\"\n }\n }\n```\n**Get data for a single rate**\nreplace shipment id with shipment from your account and valid tariffId that is suitable for this shipment id\n```\n {\n \"shipmentId\": \"s_2b28a63d65684f0aa4bcca24dafdc9df\",\n \"filterData\": {\n \"timeMax\": 1440,\n \"timeMin\": 0\n },\n \"settings\": {\n \"mode\": \"single\",\n \"tariffId\": \"s-420\"\n }\n }\n```\n", "operationId": "getShipmentRates", "parameters": [ { "name": "full_team", "in": "query", "required": false, "description": "`1` lists the shipments of the whole team instead of your own. Needs the team permission of your account, otherwise the response is 403.", "schema": { "type": "integer", "enum": [ 0, 1 ] } }, { "name": "muid[]", "in": "query", "required": false, "description": "Customer numbers of team members whose shipments to use instead of your own. Needs the team permission of your account.", "explode": true, "schema": { "type": "array", "items": { "type": "integer" } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentRateInput" }, "examples": { "default": { "$ref": "#/components/examples/request-shipment-rates" } } } } }, "responses": { "201": { "description": "The available rates", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentRateOutput" }, "examples": { "default": { "$ref": "#/components/examples/shipment-rates" } } } } }, "400": { "$ref": "#/components/responses/BadRequestOrValidationError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/v1/cart/total": { "post": { "tags": [ "Cart" ], "summary": "Get the cart total", "description": "Get cart total costs with a description of the calculations", "operationId": "getCartTotal", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CartTotalInput" }, "examples": { "default": { "$ref": "#/components/examples/request-cart-total" } } } } }, "responses": { "201": { "description": "Totals, available payment methods and per-shipment problems", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CartTotalOutput" }, "examples": { "default": { "$ref": "#/components/examples/cart-total" } } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/v1/orders": { "get": { "tags": [ "Order" ], "summary": "List orders", "operationId": "listOrders", "parameters": [ { "name": "full_team", "in": "query", "required": false, "description": "Accepted for compatibility with the shipment endpoints and ignored; the list always contains your own orders.", "schema": { "type": "integer", "enum": [ 0, 1 ] } }, { "name": "export", "in": "query", "required": false, "description": "Use this parameter with value 1 to export data. For example: 1", "schema": { "type": "integer" } }, { "name": "paymentMethod[]", "in": "query", "required": false, "description": "Filter by array of exact payment method names. For example: [\"paypal\", \"sofort\"]", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "paymentStatus", "in": "query", "required": false, "description": "Filter by Payment status number. Use prefix 1 for unpaid and 0 for paid\"", "schema": { "type": "string" } }, { "name": "created[before]", "in": "query", "required": false, "description": "Filter by created before the date and/or time. For example: \"2020-09-19T00:00:00.000\"", "schema": { "type": "string" } }, { "name": "created[after]", "in": "query", "required": false, "description": "Filter by created after the date and/or time. For example: \"2020-09-19T00:00:00.000\"", "schema": { "type": "string" } }, { "name": "sort[created]", "in": "query", "required": false, "description": "Sort by created. For example: \"asc\"", "schema": { "type": "string" } }, { "name": "sort[gross]", "in": "query", "required": false, "description": "Sort by gross. For example: \"desc\"", "schema": { "type": "string" } }, { "name": "sort[orderNumber]", "in": "query", "required": false, "description": "Sort by orderNumber. For example: \"asc\"", "schema": { "type": "string" } }, { "name": "sort[unpaid]", "in": "query", "required": false, "description": "Sort by unpaid. For example: \"desc\"", "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "description": "Full text search by data: - Shipping number - Tracking number - Pickup code - Sender address (return address) - Recipient address - Billing address - E-mail address (email_label_copy OR email_tracking)", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The collection page number", "schema": { "type": "integer" } }, { "name": "pagination", "in": "query", "required": false, "description": "`false` returns every matching order in one response instead of a page.", "schema": { "type": "boolean" } }, { "name": "itemsPerPage", "in": "query", "required": false, "description": "The number of items per page, 10 by default", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "One page of orders, or the export file when `export=1`", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderOutput" } }, "examples": { "default": { "$ref": "#/components/examples/order-list" } } }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "description": "The orders as a spreadsheet download, returned for `export=1`." } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" } } }, "post": { "tags": [ "Order" ], "summary": "Pay for shipments", "description": "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.", "operationId": "createOrder", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentInput" }, "examples": { "default": { "$ref": "#/components/examples/request-payment" } } } } }, "responses": { "201": { "description": "The payment succeeded or was started", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentResult" }, "examples": { "default": { "$ref": "#/components/examples/payment-result" } } } } }, "400": { "$ref": "#/components/responses/BadRequestOrValidationError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } } }, "/v1/orders/{orderNumber}": { "get": { "tags": [ "Order" ], "summary": "Get an order", "operationId": "getOrder", "parameters": [ { "name": "orderNumber", "in": "path", "required": true, "description": "The order number, with or without its `B-` prefix.", "schema": { "type": "string" }, "example": "2024010311" } ], "responses": { "200": { "description": "The order", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderOutput" }, "examples": { "default": { "$ref": "#/components/examples/order" } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/v1/orders/{orderNumber}/documents": { "get": { "tags": [ "Order" ], "summary": "Get the documents of an order", "operationId": "getOrderDocuments", "parameters": [ { "name": "orderNumber", "in": "path", "required": true, "description": "The order number, with or without its `B-` prefix.", "schema": { "type": "string" }, "example": "2024010311" } ], "responses": { "200": { "description": "The documents of the order", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDocuments" }, "examples": { "default": { "$ref": "#/components/examples/order-documents" } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/v1/orders/{orderNumber}/file/{type}/{name}": { "get": { "tags": [ "Order" ], "summary": "Download a document of an order", "operationId": "getOrderFile", "description": "Streams one document of the order as a PDF download. `name` is the document reference the documents endpoint returns for it, e.g. the shipment id of a label or of one shipment's commercial invoice. For `commercial-invoices` the document always covers the order in the path, so any value is accepted as `name`, e.g. the order number.", "parameters": [ { "name": "orderNumber", "in": "path", "required": true, "description": "The order number, with or without its `B-` prefix.", "schema": { "type": "string" }, "example": "2024010311" }, { "name": "type", "in": "path", "required": true, "description": "The document type.", "schema": { "type": "string", "enum": [ "public", "label", "proforma", "collective_bill", "invoice", "credit_invoice", "debit_invoice", "orderconfirmation", "reminder", "export_cert_vat", "commercial-invoice", "commercial-invoices", "export-declaration", "proof-of-export" ] }, "example": "commercial-invoices" }, { "name": "name", "in": "path", "required": true, "description": "The reference of the document, as returned in the documents of the order.", "schema": { "type": "string" }, "example": "2024010311" } ], "responses": { "200": { "description": "The document as a file download; `Content-Disposition` carries the file name.", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" }, "example": "%PDF-1.4 ..." } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/v1/connections": { "get": { "tags": [ "Connection" ], "summary": "List connections", "operationId": "listConnections", "parameters": [ { "name": "status", "in": "query", "required": false, "description": "Status of connections", "schema": { "type": "string", "enum": [ "new", "in_progress", "error", "success" ] } }, { "name": "connectionType", "in": "query", "required": false, "description": "Connection type ID", "schema": { "type": "number" } }, { "name": "sort[status]", "in": "query", "required": false, "description": "Sort by status", "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "sort[connectionType]", "in": "query", "required": false, "description": "Sort by connectionType", "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "sort[modified]", "in": "query", "required": false, "description": "Sort by modified", "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "page", "in": "query", "required": false, "description": "The collection page number", "schema": { "type": "integer" } }, { "name": "itemsPerPage", "in": "query", "required": false, "description": "The number of items per page", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "One page of connections", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Connection" } }, "examples": { "default": { "$ref": "#/components/examples/connection-list" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" } } }, "post": { "tags": [ "Connection" ], "summary": "Create a connection", "description": "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.", "operationId": "createConnection", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateConnection" }, "examples": { "default": { "$ref": "#/components/examples/request-create-connection" } } } } }, "responses": { "201": { "description": "The connection was created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateConnectionResult" }, "examples": { "default": { "$ref": "#/components/examples/connection-created" } } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } } }, "/v1/connections/{uuid}": { "get": { "tags": [ "Connection" ], "summary": "Get a connection", "operationId": "getConnection", "parameters": [ { "name": "uuid", "in": "path", "required": true, "description": "The connection id.", "schema": { "type": "string", "maxLength": 34 }, "example": "s_c71525fb87f645ffbc126a7deec40011" } ], "responses": { "200": { "description": "The connection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connection" }, "examples": { "default": { "$ref": "#/components/examples/connection" } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/v1/carrier/access-points-search": { "post": { "tags": [ "Carrier" ], "summary": "Search carrier access points", "operationId": "searchAccessPoints", "requestBody": { "content": { "application/json": { "schema": { "properties": { "carrierCodes": { "type": "array", "items": { "type": "string", "example": "ups" }, "description": "The carrier codes" }, "countryCode": { "example": "DE", "type": "string", "description": "The country as ISO 3166-1 alpha-2 code" }, "city": { "example": "Neuss", "type": "string", "description": "The city name" }, "postCode": { "example": "41460", "type": "string", "description": "The postcode" }, "street": { "example": "Markt 2", "type": "string", "description": "The street name and building number" }, "state": { "example": "", "type": "string", "description": "Abbreviation of the state; the state required only for US and Canada" }, "radius": { "example": 10, "type": "integer", "description": "The radius in kilometers around the specified address" }, "onlyOpen": { "example": false, "type": "boolean", "description": "Show only open access points" } }, "required": [ "radius", "countryCode", "carrierCodes", "onlyOpen" ], "type": "object" }, "examples": { "default": { "$ref": "#/components/examples/request-access-points" } } } }, "required": true }, "responses": { "201": { "description": "The access points per carrier", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessPointsResponse" }, "examples": { "default": { "$ref": "#/components/examples/access-points" } } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } } } }, "components": { "securitySchemes": { "apiKey": { "type": "apiKey", "in": "header", "name": "X-AUTH-TOKEN", "description": "Your personal API key from the JUMiNGO user account." } }, "responses": { "Unauthorized": { "description": "No valid API key was provided or the account is disabled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationError" }, "examples": { "default": { "$ref": "#/components/examples/authentication-error" } } } } }, "Forbidden": { "description": "The API key is valid but may not perform this action, e.g. a read-only integration 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.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "default": { "$ref": "#/components/examples/problem-forbidden" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationError" }, "examples": { "default": { "$ref": "#/components/examples/customer-verification-failed" } } } } }, "BadRequestOrValidationError": { "description": "The request body is invalid (`violations` lists the fields) or the request cannot be fulfilled in the current state", "content": { "application/problem+json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ValidationProblem" }, { "$ref": "#/components/schemas/Problem" } ] }, "examples": { "validation": { "$ref": "#/components/examples/validation-problem" }, "state": { "$ref": "#/components/examples/problem-bad-request" } } } } }, "NotFound": { "description": "The resource does not exist or belongs to another account", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "default": { "$ref": "#/components/examples/problem-not-found" } } } } }, "BadRequest": { "description": "The request cannot be fulfilled in the current state", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "default": { "$ref": "#/components/examples/problem-bad-request" } } } } }, "ValidationError": { "description": "The request body is invalid", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblem" }, "examples": { "default": { "$ref": "#/components/examples/validation-problem" } } } } } }, "schemas": { "AccessPoints": { "type": "object", "description": "Contains the data of the carrier access points.", "properties": { "id": { "type": "integer", "description": "Carrier Access Point id", "example": 118911 }, "name": { "type": "string", "description": "Carrier Access Point name", "example": "NEUSSER SCHUHREPARATUR & SCHLU" }, "type": { "type": "string", "description": "Carrier Access Point type", "example": "UPS Access Point™" }, "city": { "type": "string", "description": "City of the Carrier Access Point", "example": "NEUSS" }, "street": { "type": "string", "description": "The adress of the Carrier Access Point", "example": "NIEDERWALLSTRASSE 31" }, "postCode": { "type": "string", "description": "Postal code of the Carrier Access Point", "example": "41460" }, "countryCode": { "$ref": "#/components/schemas/CountryCode" }, "state": { "type": "string", "description": "The state or region as the carrier reports it; empty when the carrier gives none.", "example": "NW" }, "latitude": { "type": "string", "description": "The latitude of geo position", "example": "6.687880039" }, "longitude": { "type": "string", "description": "The longitude of geo position", "example": "6.687880039" }, "distance": { "type": "string", "description": "The distance from selected location in request", "example": "0.5" }, "distanceCode": { "type": "string", "description": "The distance units", "maxLength": 2, "example": "KM" }, "hoursOfOperation": { "type": "array", "items": { "type": "object", "description": "The carrier Access Point hours of operation time", "properties": { "dayName": { "type": "string", "description": "The day name in the current language.", "example": "Montag" }, "workingHours": { "type": "string", "description": "Range of working hours throughout the day", "example": "05:00-19:00" }, "lunchBreak": { "type": "string", "description": "Range of lunch breaking hours", "example": "13:00-14:00" }, "workingDay": { "type": "boolean", "description": "Is a workable day", "example": true } } } }, "workState": { "type": "string", "description": "Whether the access point is open right now: `opened`, `closes soon` or `closed`, translated into the language of the account.", "example": "opened" } } }, "AccessPointsResponse": { "type": "object", "description": "Contains the data of the carrier response.", "properties": { "id": { "type": "integer", "description": "Request id", "example": 1 }, "accessPoints": { "type": "array", "items": { "$ref": "#/components/schemas/AccessPoints" } }, "errors": { "type": "array", "items": { "type": "object", "description": "Error messages for invalid carriers", "properties": { "carrier": { "type": "string", "description": "Carrier code", "example": "ups" }, "messages": { "type": "array", "items": { "type": "string", "example": "postCode: This value should not be blank" } } } } } } }, "AuthenticationError": { "type": "object", "description": "The body of a 401 response.", "required": [ "message" ], "properties": { "message": { "type": "string", "example": "No API token provided" } } }, "CartTotalCalculatorResult": { "type": "object", "properties": { "id": { "type": "integer", "description": "id", "example": 1 }, "tax": { "type": "number", "format": "float", "description": "The tax value", "example": 2.82 }, "taxNet": { "type": "number", "format": "float", "description": "The tax net", "example": 14.84 }, "taxFreeNet": { "type": "number", "format": "float", "description": "The taxfree net", "example": 12.17 }, "taxes": { "description": "Taxes keyed by country code. An empty list when there are none.", "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "tax_name": { "type": "string", "example": "MwSt." }, "tax_countryCode": { "$ref": "#/components/schemas/CountryCode" }, "tax_rate": { "type": "number", "format": "float", "example": 19 }, "tax_id": { "type": "integer", "example": 1 }, "tax_amount": { "type": "number", "format": "float", "example": 2.82 } } } }, { "type": "array", "maxItems": 0, "items": true } ] }, "taxDefaultName": { "type": "string", "description": "The tax default name", "example": "MwSt." }, "taxId": { "type": "string", "description": "The tax id", "example": "DE293163480" }, "voucherValue": { "type": "number", "format": "float", "description": "The value by the voucher", "example": 0 }, "voucherPercent": { "type": "number", "format": "float", "description": "The percent by the voucher", "example": 0 }, "voucherCode": { "type": "string", "description": "The voucher code", "example": "" }, "voucherType": { "type": "string", "description": "The type of voucher", "example": "" }, "voucherOrderNumbers": { "type": "string", "description": "The order number of vaucher", "example": "" }, "voucherErrorMessage": { "type": [ "string", "null" ], "description": "Why the voucher was not applied; null when it was or none was given.", "example": null }, "gross": { "type": "number", "format": "floatt", "description": "The gross", "example": 29.83 }, "subtotal": { "type": "number", "format": "float", "description": "The Subtotal cost", "example": 29.83 }, "surcharges": { "type": "number", "format": "float", "description": "The surcharges", "example": 0 }, "plusProductSurcharges": { "type": "object", "properties": { "id": { "type": "integer", "description": "id", "example": 1 }, "minSurcharge": { "type": "number", "format": "float", "description": "The minimal surcharge", "example": 0.42 }, "percentSurcharge": { "type": "integer", "description": "The percent of surcharge", "example": 10 }, "price": { "type": "number", "format": "float", "description": "The price", "example": 0.5 }, "currency": { "type": "string", "description": "Designation Currency", "minLength": 3, "maxLength": 3, "example": "EUR" } } }, "subtotalNet": { "type": [ "number", "null" ], "format": "float", "description": "The subtotal without VAT", "example": 25.07 }, "surchargesNet": { "type": [ "number", "null" ], "format": "float", "description": "The surcharges without VAT", "example": 0 }, "totalNet": { "type": [ "number", "null" ], "format": "float", "description": "The total without VAT", "example": 25.07 }, "totalNetVoucher": { "type": [ "number", "null" ], "format": "float", "description": "The total without VAT after the voucher", "example": 25.07 }, "shippingCostsNet": { "type": [ "number", "null" ], "format": "float", "description": "The shipping costs without VAT", "example": 25.07 }, "shippingCosts": { "type": [ "number", "null" ], "format": "float", "description": "The shipping costs", "example": 29.83 }, "additionalServices": { "type": [ "number", "null" ], "format": "float", "description": "The additional services (insurance, export declaration) in total", "example": 0 }, "additionalServicesSeparately": { "type": "object", "properties": { "standard_insurance_total": { "type": "number", "format": "float", "description": "total of all standard insurance costs", "example": 0.5 }, "standard_insurance_total_uvp": { "type": "number", "format": "float", "description": "total of all uvp/original standard insurance costs if discount applies", "example": 0.5 }, "premium_insurance_total": { "type": "number", "format": "float", "description": "total of all premium insurance costs", "example": 0.5 }, "premium_insurance_total_uvp": { "type": "number", "format": "float", "description": "total of all uvp/original premium insurance costs if discount applies", "example": 0.5 }, "export_declaration_total": { "type": "number", "format": "float", "description": "total of all export declaration costs", "example": 0.5 }, "export_declaration_total_uvp": { "type": "number", "format": "float", "description": "total of all uvp/original export declaration costs if discount applies", "example": 0.5 }, "shipping_costs_total_uvp": { "type": "number", "format": "float", "description": "total of all uvp/original rate costs if discount applies", "example": 0.5 } } } }, "description": "Contains the data of the cart total calculator result." }, "CartTotalInput": { "type": "object", "required": [ "shipmentIds" ], "properties": { "shipmentIds": { "type": "array", "items": { "type": "string" }, "description": "The list of shipment uuid", "example": [ "s_642bf5ab244c4380a379f0c8877f69b3", "s_42499ae0e73843ada5e313f1eaca8779" ] }, "voucherCode": { "type": "string", "description": "The voucher code", "example": "XmasDiscount" } }, "description": "Contains the List of shipment uuid and voucher code." }, "CartTotalOutput": { "type": "object", "required": [ "total", "paymentMethods" ], "properties": { "total": { "$ref": "#/components/schemas/CartTotalCalculatorResult" }, "paymentMethods": { "type": "array", "description": "List of available payment methods", "items": { "$ref": "#/components/schemas/PaymentMethodsOutput" } }, "shipments": { "type": "array", "description": "List of calculated shipments", "items": { "$ref": "#/components/schemas/Shipment" } }, "errorList": { "description": "Problems per shipment that prevent ordering, keyed by shipment id; an empty list when there are none.", "anyOf": [ { "$ref": "#/components/schemas/EmptyList" }, { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "example": "date_in_past" } } } ] }, "userTaxId": { "type": [ "string", "null" ], "example": "DE123456789" } }, "description": "Contains total and payment metods data" }, "ConfirmationDocument": { "type": "object", "required": [ "name", "type", "reference" ], "properties": { "name": { "type": "string", "description": "Document name", "example": "A-200206AJ75-1.pdf" }, "type": { "type": "string", "description": "Type of document", "example": "confirmation" }, "reference": { "type": "string", "description": "Reference", "example": "200206AJ75-1" }, "file": { "type": "string", "description": "Base64 file content; only on the order documents endpoint" } } }, "Connection": { "type": "object", "properties": { "id": { "type": "integer", "description": "Connection id", "example": 1 }, "uuid": { "type": "string", "description": "identifier of connection", "example": "s_c71525fb87f645ffbc126a7deec40011" }, "name": { "type": "string", "description": "Name of connection", "example": "My shop" }, "active": { "type": "integer", "description": "1 when the connection is active, 0 otherwise.", "example": 1 }, "lastSynced": { "type": [ "string", "null" ], "description": "When the connection last synchronised; null until the first sync." }, "initSync": { "type": "string", "description": "identifier connection sync period", "example": "0d" }, "syncPeriod": { "type": "string", "description": "identifier whether connection active or not", "example": "4h" }, "sendTrackingMail": { "type": "integer", "description": "identifier whether send tracking email or not", "example": 1, "default": 0 }, "connectionDetails": { "description": "Shop-specific settings, e.g. the shop URL and plugin version; an empty list when there are none.", "anyOf": [ { "$ref": "#/components/schemas/EmptyList" }, { "type": "object", "additionalProperties": true } ] }, "status": { "type": "string", "description": "Connection status", "example": "new" }, "message": { "type": [ "string", "null" ], "description": "Last status message of the connection." }, "webhookUrl": { "type": "string", "description": "Webhook url address" }, "deleted": { "type": "integer", "description": "identifier whether connection was deleted or not", "example": 1, "default": 0 }, "created": { "$ref": "#/components/schemas/MidnightDateTime", "description": "The date the connection was created." }, "modified": { "$ref": "#/components/schemas/MidnightDateTime", "description": "The date the connection was last modified." }, "connectionType": { "type": "string", "description": "Reference to the connection type.", "example": "/app/connection-types/3" }, "receiveWebhook": { "type": "boolean", "description": "Is receive webhook enabled for connection" }, "customer": { "type": "string", "description": "Reference to the owning account.", "example": "/app/users/200002" } } }, "ConnectionCustomData": { "type": "object", "additionalProperties": true, "properties": { "order_number": { "type": "string", "description": "Order number", "maxLength": 255, "example": "123-456-789" }, "order_date": { "type": "string", "format": "date-time", "description": "Order date", "example": "2018-06-30T12:52:03Z" }, "order_status": { "type": "string", "description": "Order Status", "maxLength": 255, "example": "paid" }, "sub_total_amount": { "type": "number", "format": "float", "description": "Subtotal", "minimum": 0, "example": 15.66 }, "sub_total_currency": { "$ref": "#/components/schemas/Currency" }, "tax_amount": { "type": "number", "format": "float", "description": "Tax amount", "minimum": 0, "example": 5.19 }, "tax_currency": { "$ref": "#/components/schemas/Currency" }, "shipping_cost_amount": { "type": "number", "format": "float", "description": "Shipping costs of the order", "minimum": 0, "example": 2.99 }, "shipping_cost_currency": { "$ref": "#/components/schemas/Currency" }, "total_amount": { "type": "number", "format": "float", "description": "Total", "minimum": 0, "example": 13.44 }, "total_currency": { "$ref": "#/components/schemas/Currency" }, "shipping_method": { "type": "string", "description": "Customer-selected delivery method", "maxLength": 255, "example": "next day" }, "earliest_delivery_date": { "type": "string", "format": "date", "description": "Earliest delivery date", "example": "2018-07-01" }, "latest_delivery_date": { "type": "string", "format": "date", "description": "Latest delivery date", "example": "2018-07-01" }, "payment_method": { "type": "string", "description": "Payment method", "maxLength": 255, "example": "others" }, "payment_date": { "type": "string", "format": "date-time", "description": "Payment date", "example": "2018-06-30T12:52:03Z" }, "buyer_name": { "type": "string", "description": "Full name of the buyer", "maxLength": 255, "example": "John Doe" }, "buyer_email": { "type": "string", "description": "Email address of the buyer", "maxLength": 254, "example": "email@example.org" }, "buyer_tax_id": { "type": "string", "description": "Tax number of the buyer", "maxLength": 255, "example": "DE123456789" }, "sale_channel": { "type": "string", "description": "Sales channel", "maxLength": 255, "example": "main shop" }, "notes": { "type": "string", "description": "Custom notes about the order", "maxLength": 255, "example": "Treat with priority" }, "items": { "type": "array", "description": "Items of the order", "items": { "$ref": "#/components/schemas/ConnectionCustomDataItem" } } }, "description": "Used to submit additional order data from e-commerce systems.\nContains the data of the order and one or more included items.\nRequired for shop / e-commerce connections, optional for API connections.\nA shipment returns exactly the keys the shop sent, known or not." }, "ConnectionCustomDataItem": { "type": "object", "required": [ "id", "price_amount", "price_currency", "quantity", "title" ], "properties": { "id": { "type": "string", "description": "Item ID", "maxLength": 255, "example": "a-id-123" }, "quantity": { "type": "integer", "format": "int32", "description": "The quantity of this item", "minimum": 1, "maximum": 999999999, "example": 3 }, "title": { "type": "string", "description": "Title of the item", "maxLength": 255, "example": "T-Shirt" }, "variant": { "type": "string", "description": "Variant of the item", "maxLength": 255, "example": "size M, color red" }, "sku": { "type": "string", "description": "Stock keeping unit value", "maxLength": 255, "example": "sku123" }, "condition": { "type": "string", "description": "Condition of the article", "maxLength": 255, "example": "new" }, "price_amount": { "type": "number", "format": "float", "description": "Total price of item(s)", "minimum": 0, "example": 1.23 }, "price_currency": { "$ref": "#/components/schemas/Currency" } } }, "ConnectionType": { "type": "object", "properties": { "id": { "type": "integer", "description": "Connection id", "example": 1 }, "version": { "type": "integer", "description": "Connection version", "example": 1 }, "description": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of connection type", "example": "eBay" }, "description": { "type": "string", "description": "Description of connection type" }, "image": { "type": "string", "description": "Location of connection type image", "example": "/img/connections/ebay.png" }, "metaKeywords": { "type": "string", "description": "Meta keywords of connection type" }, "metaDescription": { "type": "string", "description": "Meta description of connection type" } } }, "formFields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "siteId" }, "label": { "type": "string", "example": "eBay Webseite (Land)" }, "type": { "type": "string", "example": "select" }, "options": { "type": "array", "items": { "type": "string" } }, "required": { "type": "boolean", "example": true }, "info": { "type": "string", "example": "info" } } } }, "isCreationViaApiAllowed": { "type": "boolean", "description": "Indicates whether the connection and shipments can only be created via api or via an account", "example": true }, "isVisible": { "type": "boolean", "description": "Indicates whether the connection in the account can be selected when creating a new one", "example": true }, "isSyncable": { "type": "boolean", "description": "Indicates whether the jumingo account can be synced with a button (ebay, amazon) or not (api, plugins)", "example": true }, "showApiToken": { "type": "boolean", "description": "Specifies whether the api token should be displayed (for api and shop plugins)", "example": true }, "hasCreateForm": { "type": "boolean", "description": "Indicates whether a connection is created via form or not (from external via shop plugin)", "example": true } } }, "Country": { "type": "object", "description": "Country", "properties": { "id": { "type": "integer", "description": "Country id", "example": 21 }, "isoCode": { "$ref": "#/components/schemas/CountryCode" }, "taxFree": { "type": "integer", "description": "Indicates that shipping from or to this country is VAT free", "example": 1, "default": 0 }, "name": { "type": "string", "description": "Country name", "maxLength": 50, "example": "Andorra" }, "postCodeFree": { "type": "integer", "description": "Indicates that country does not have post codes", "example": 1, "default": 0 }, "settings": { "type": "array", "description": "Custom country data", "items": { "type": "object" }, "example": [] } } }, "CountryCode": { "type": "string", "description": "Country as ISO 3166-1 alpha-2 code", "example": "US", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XK", "YE", "YT", "ZA", "ZM", "ZW" ] }, "CreateConnection": { "type": "object", "required": [ "name", "plugin_name", "plugin_version", "settings", "shop_url", "shop_version", "type_id", "webhook_url" ], "properties": { "name": { "type": "string", "description": "Name of the shop", "maxLength": 225, "example": "my shop connection" }, "type_id": { "type": "integer", "example": 1, "description": "Connection type ID; please see external list of valid connection type IDs." }, "webhook_url": { "type": "string", "description": "URL to which the webhooks should be sent", "maxLength": 2000, "format": "uri", "example": "https://www.example.org/" }, "shop_url": { "type": "string", "description": "URL of the shop", "maxLength": 2000, "format": "uri", "example": "https://www.example.org/" }, "shop_version": { "type": "string", "description": "Version of the shop", "maxLength": 255, "example": "v1.0 beta" }, "plugin_name": { "type": "string", "description": "Name of the plugin", "maxLength": 255, "example": "my shop plugin" }, "plugin_version": { "type": "string", "description": "Version of the plugin", "maxLength": 255, "example": "v1.1" }, "settings": { "type": "string", "description": "Shop settings", "maxLength": 255 } }, "description": "Body for request to create a connection." }, "CreateConnectionResult": { "type": "object", "properties": { "connection_uuid": { "type": "string", "example": "c_dfd82f79758545adb67e22d4a6102f47" } }, "description": "Returns the connection ID." }, "CreateShipment": { "type": "object", "required": [ "details", "packages", "from_address", "to_address" ], "properties": { "from_address": { "$ref": "#/components/schemas/CreateShipmentAddress" }, "to_address": { "$ref": "#/components/schemas/CreateShipmentAddress" }, "details": { "$ref": "#/components/schemas/CreateShipmentDetails" }, "packages": { "type": "array", "description": "Packages of the shipment", "items": { "$ref": "#/components/schemas/CreateShipmentPackage" } }, "customs_invoice": { "$ref": "#/components/schemas/CustomsInvoiceInput" }, "connection": { "$ref": "#/components/schemas/CreateShipmentConnection" }, "rate": { "$ref": "#/components/schemas/CreateShipmentRate" }, "label_format": { "type": "string", "description": "Label format", "enum": [ "A4", "A6" ] } } }, "CreateShipmentAddress": { "type": "object", "required": [ "city", "country", "name", "street" ], "properties": { "company": { "type": "string", "description": "Company name", "maxLength": 35, "example": "Test Corp." }, "name": { "type": "string", "description": "First and Last Name", "maxLength": 35, "example": "John Doe" }, "street": { "type": "string", "description": "First address line (usually street name and house number)", "maxLength": 35, "example": "100 West 33rd Street" }, "street2": { "type": "string", "description": "Second address line for further information", "maxLength": 35, "example": "Apt 123" }, "zip": { "type": "string", "description": "Postal code of the address; is required if the country needs a postal code", "maxLength": 10, "example": "10001" }, "city": { "type": "string", "description": "Name of the city", "maxLength": 30, "example": "New York" }, "state": { "$ref": "#/components/schemas/StateCode" }, "country": { "$ref": "#/components/schemas/CountryCode" }, "phone": { "type": "string", "description": "Phone number", "maxLength": 35, "example": "1234567890" }, "settings": { "type": "object", "properties": { "email": { "type": "string", "example": "test@email.com" } }, "description": "Custom address data" } } }, "CreateShipmentConnection": { "type": "object", "required": [ "connection_uuid" ], "properties": { "connection_uuid": { "type": "string", "description": "The ID of the connection to be used. Each connected e-commerce system has a Connection ID. An overview of the systems including the IDs can be found in your user account.", "example": "c_891547f2fca547e798ba61dbf89acdde" }, "connection_item_uuid": { "type": "string", "description": "Your individual item ID of the shipment. Mostly corresponds to the order number in your shop. Item IDs must be unique. Required for shop / e-commerce connections, optional for API connections.", "example": "my-unique-item-id" }, "validation_mode": { "type": "string", "description": "This sets the validation mode. In strict mode, each validation error (e.g. more characters than allowed) results in an error response. In lax mode, the shipment is created despite validation errors. Incorrect values are removed or shortened accordingly. The lax validation mode is intended to be able to safely import the shipments from e-commerce systems and to complete them afterwards.", "default": "strict", "enum": [ "strict", "lax" ], "example": "strict" }, "connection_custom_data": { "allOf": [ { "$ref": "#/components/schemas/ConnectionCustomData" }, { "required": [ "buyer_name", "items", "order_date", "order_number", "order_status", "shipping_cost_amount", "shipping_cost_currency", "shipping_method", "sub_total_amount", "sub_total_currency", "tax_amount", "tax_currency", "total_amount", "total_currency" ] } ] } } }, "CreateShipmentDetails": { "type": "object", "required": [ "content_description", "value_amount", "value_currency" ], "properties": { "value_amount": { "type": "integer", "format": "int32", "description": "Goods value of the consignment; needed for the customs", "minimum": 1, "maximum": 999999999, "example": 200 }, "value_currency": { "$ref": "#/components/schemas/CurrencyCode" }, "content_description": { "type": "string", "description": "Description of the contents of the package(s); needed for the customs", "maxLength": 35, "example": "sample" }, "reference_number": { "type": "string", "description": "A reference text that you can use to identify your shipment, e.g. an order number of your merchandise management system. Will be printed on the shipping label in most cases.", "maxLength": 35, "example": "my-reference" }, "email": { "type": "string", "description": "If specified, after the order has been placed, an email will be use for user registration", "maxLength": 254, "example": "email@example.org" }, "email_tracking": { "type": "string", "description": "If specified, after the order has been placed, an email will be sent to this email address with the tracking link", "maxLength": 254, "example": "email@example.org" }, "email_label_copy": { "type": "string", "description": "If specified, after the order has been placed, an additional email with the shipping label will be sent to this email address", "maxLength": 254, "example": "email@example.org" }, "insurance_amount": { "type": "integer", "format": "int32", "description": "Amount of additional insurance value", "minimum": 0, "maximum": 20000, "example": 200 }, "insurance_currency": { "$ref": "#/components/schemas/CurrencyCode" }, "extra_insurance_value": { "type": "integer", "description": "Amount of extra insurance value", "example": 300 }, "extra_insurance_type": { "type": "string", "description": "Type of insurance. Possible values: standard | premium", "enum": [ "standard", "premium" ], "default": "standard" }, "export_license": { "type": "boolean", "description": "Indicate if you need an export license and want to buy it along with the shipment" }, "packaging_type": { "$ref": "#/components/schemas/PackagingType" }, "hs_tariff_number": { "type": "string", "description": "Hs number for import/export goods defining the type of the good for customs.", "example": "61091000" }, "extra_export_license_number": { "type": "string", "description": "Extra export license number", "example": "4200042" }, "settings": { "type": "object", "description": "Custom settings", "example": { "use_commercial_invoice": false }, "additionalProperties": true } } }, "CreateShipmentPackage": { "type": "object", "required": [ "height", "length", "weight", "width" ], "properties": { "weight": { "type": "number", "format": "float", "description": "Weight of the package in kg", "minimum": 0.1, "maximum": 9999999, "example": 0.1 }, "length": { "type": "integer", "format": "int32", "description": "Length of the package in cm", "minimum": 1, "maximum": 99999, "example": 18 }, "width": { "type": "integer", "format": "int32", "description": "Width of the package in cm", "minimum": 1, "maximum": 99999, "example": 19 }, "height": { "type": "integer", "format": "int32", "description": "Height of the package in cm", "minimum": 1, "maximum": 99999, "example": 20 } } }, "CreateShipmentRate": { "type": "object", "required": [ "shipper_tariff_id", "shipping_type", "pickup_date", "pickup_min_time", "pickup_max_time" ], "properties": { "shipper_tariff_id": { "type": "string", "description": "The shipper tariff id", "example": "2" }, "shipping_type": { "type": "string", "description": "The shipping type indicates whether the shipment must be delivered in a shop or picked up by a driver.", "enum": [ "pickup", "shop" ], "example": "pickup" }, "pickup_date": { "type": "string", "format": "date", "description": "The date for which the collection was arranged.", "example": "2020-07-14" }, "pickup_min_time": { "type": "string", "description": "The earliest time at which the shipment is picked up.", "example": "10:00:00" }, "pickup_max_time": { "type": "string", "description": "The latest time by which the shipment is picked up.", "example": "18:00:00" } } }, "CreateShipmentResult": { "type": "object", "properties": { "shipment_id": { "type": "string", "example": "s_fb1bc92aba1c4d70a3eaa44d687ae179" }, "warnings": { "type": "object", "properties": { "messages": { "type": "array", "items": { "type": "string", "example": "error message" } }, "count": { "type": "integer" } } } }, "description": "Returns the shipment ID." }, "Currency": { "type": "string", "description": "Currency as ISO 4217 code", "enum": [ "EUR", "GBP", "USD", "CAD", "CHF", "JPY", "ILS", "HKD", "RUB", "DKK", "SEK", "NOK", "CZK", "HUF", "PLN", "AUD", "BRL", "MYR", "MXN", "TWD", "NZD", "PHP", "SGD", "THB" ] }, "CurrencyCode": { "type": "string", "description": "Currency as ISO 4217 code", "enum": [ "EUR", "GBP", "USD", "CAD", "CHF", "JPY", "ILS", "HKD", "RUB", "DKK", "SEK", "NOK", "CZK", "HUF", "PLN", "AUD", "BRL", "MYR", "MXN", "TWD", "NZD", "PHP", "SGD", "THB" ] }, "CustomsInvoiceInput": { "type": "object", "properties": { "invoiceNumber": { "type": "string", "description": "Invoice Number", "example": "invoice_number_123" }, "invoiceDate": { "type": "string", "format": "date", "description": "Invoice Date", "example": "2022-08-28" }, "currency": { "$ref": "#/components/schemas/CurrencyCode" }, "exportReason": { "type": "string", "enum": [ "Gift", "Commercial", "Personal", "Return", "Claim", "Temporary", "Relocation", "Sample" ] }, "remarks": { "type": "array", "items": { "type": "string", "example": "NIEDERWALLSTRASSE 31" }, "description": "Remarks", "minItems": 0, "maxItems": 3 }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/CustomsLineItemInput" } }, "useJumingoCommercialInvoice": { "type": "boolean", "description": "Generate the JUMiNGO commercial (customs) invoice for this shipment and send it to the carrier as the commercial invoice, instead of a proforma invoice or an own uploaded commercial invoice. Only takes effect together with `settings.use_commercial_invoice: true` and for a packaging type other than `document`; the API does not set the setting for you.", "default": false, "example": true }, "discount": { "type": "number", "format": "float", "minimum": 0, "description": "Discount granted on the invoice, in the invoice currency. Must be lower than the total value of all line items. There is no default - when omitted, no discount is shown on the invoice.", "example": 12.5 }, "shippingCosts": { "type": "number", "format": "float", "minimum": 0, "description": "Shipping costs shown on the invoice, in the invoice currency. When omitted, the shipping costs of the JUMiNGO shipment are used and converted into the invoice currency.", "example": 23.99 }, "insuranceCosts": { "type": "number", "format": "float", "minimum": 0, "description": "Insurance costs shown on the invoice, in the invoice currency. When omitted, the insurance costs of the JUMiNGO shipment are used and converted into the invoice currency.", "example": 5.49 } } }, "CustomsInvoiceOutput": { "type": "object", "properties": { "invoiceNumber": { "type": "string", "description": "Invoice Number", "example": "invoice_number_123" }, "invoiceDate": { "type": "string", "format": "date", "description": "Invoice Date", "example": "2022-08-28" }, "currency": { "$ref": "#/components/schemas/CurrencyCode" }, "exportReason": { "type": "string", "enum": [ "Gift", "Commercial", "Personal", "Return", "Claim", "Temporary", "Relocation", "Sample" ] }, "remarks": { "type": [ "array", "null" ], "items": { "type": "string", "example": "NIEDERWALLSTRASSE 31" }, "description": "Remarks", "minItems": 0, "maxItems": 3 }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/CustomsLineItemOutput" } }, "useJumingoCommercialInvoice": { "type": "boolean", "description": "Whether the JUMiNGO commercial (customs) invoice is generated for this shipment.", "example": true }, "discount": { "type": [ "number", "null" ], "format": "float", "description": "Discount stored on the invoice, in the invoice currency. Null when no discount was given.", "example": 12.5 }, "shippingCosts": { "type": [ "number", "null" ], "format": "float", "description": "Shipping costs explicitly stored on the invoice. Null when they are derived from the shipment - see `effectiveShippingCosts` for the value that is printed.", "example": 23.99 }, "insuranceCosts": { "type": [ "number", "null" ], "format": "float", "description": "Insurance costs explicitly stored on the invoice. Null when they are derived from the shipment - see `effectiveInsuranceCosts` for the value that is printed.", "example": 5.49 }, "goodsValue": { "type": [ "number", "null" ], "format": "float", "description": "Total value of all line items, in the invoice currency. Null while the shipment has no price to derive from.", "example": 1234 }, "effectiveShippingCosts": { "type": [ "number", "null" ], "format": "float", "description": "Shipping costs printed on the invoice - either the stored value or the one derived from the shipment. Null while the shipment has no price to derive from.", "example": 23.99 }, "effectiveInsuranceCosts": { "type": [ "number", "null" ], "format": "float", "description": "Insurance costs printed on the invoice - either the stored value or the one derived from the shipment. Null while the shipment has no price to derive from.", "example": 5.49 }, "totalInvoiceAmount": { "type": [ "number", "null" ], "format": "float", "description": "Goods value - discount + shipping costs + insurance costs. Null while the shipment has no price to derive from.", "example": 1251.98 } } }, "CustomsLineItemInput": { "type": "object", "properties": { "content": { "type": "string", "description": "Shipment content", "example": "T-Shirts" }, "quantity": { "type": "integer", "description": "Quantity of items", "example": 12 }, "unitOfMeasurement": { "type": "string", "description": "Unit Of Measurement", "enum": [ "PCS", "M", "M2", "M3", "L", "KG" ] }, "netWeight": { "type": "number", "format": "float", "description": "Gross Weight", "example": 15.5 }, "value": { "type": "number", "format": "float", "description": "Shipment value", "maximum": 999999999, "example": 155.5 }, "hsTariffNumber": { "type": "string", "description": "hsTariffNumber", "example": "61091000" }, "manufacturingCountry": { "$ref": "#/components/schemas/CountryCode" }, "merchantProductId": { "type": [ "string", "null" ], "maxLength": 35, "description": "Merchant product ID (M-PID, EU customs code C127): your own identifier for this item, e.g. the SKU,\nlisting ID or item number from your shop, marketplace or ERP. Leading and trailing spaces are\nremoved; an empty value is stored as null.\nRequired, like the other of M-PID and NS-PID, for B2C imports into the EU from a third country:\nimport tariff, pickup outside the EU, delivery inside the EU, ordering customer is a business and\nthe receiver address has no company name. Otherwise optional.\nIn an update, an omitted field keeps the stored value; null or an empty string clears it.\n", "example": "SKU-12345" }, "manufacturerProductId": { "type": [ "string", "null" ], "maxLength": 35, "description": "Non-standardised manufacturer product ID (NS-PID, EU customs code C128): the manufacturer's or\nsupplier's internal product code, e.g. a model or part number. No set format; may be identical to\nthe EAN/GTIN.\nRequired, like the other of M-PID and NS-PID, for B2C imports into the EU from a third country:\nimport tariff, pickup outside the EU, delivery inside the EU, ordering customer is a business and\nthe receiver address has no company name. Otherwise optional.\nIn an update, an omitted field keeps the stored value; null or an empty string clears it.\n", "example": "MFG-67890" }, "standardizedProductId": { "type": [ "string", "null" ], "maxLength": 35, "description": "Standardised manufacturer product ID (S-PID, EU customs code C129): EAN, GTIN, UPC or ISBN. Only if\none exists; never required. In an update, an omitted field keeps the stored value; null or an\nempty string clears it.\n", "example": "4006381333931" } } }, "CustomsLineItemOutput": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID", "example": 12 }, "content": { "type": "string", "description": "Shipment content", "example": "T-Shirts" }, "quantity": { "type": "integer", "description": "Quantity of items", "example": 12 }, "unitOfMeasurement": { "type": "string", "description": "Unit Of Measurement", "enum": [ "PCS", "M", "M2", "M3", "L", "KG" ] }, "netWeight": { "type": "number", "format": "float", "description": "Gross Weight", "example": 15.5 }, "value": { "type": "number", "format": "float", "description": "Shipment value", "example": 155.5 }, "hsTariffNumber": { "type": [ "string", "null" ], "description": "hsTariffNumber", "example": "61091000" }, "manufacturingCountry": { "anyOf": [ { "$ref": "#/components/schemas/CountryCode" }, { "type": "null" } ] }, "merchantProductId": { "type": [ "string", "null" ], "maxLength": 35, "description": "Merchant product ID (M-PID, EU customs code C127): your own identifier for this item, e.g. the SKU,\nlisting ID or item number from your shop, marketplace or ERP.\nRequired, like the other of M-PID and NS-PID, for B2C imports into the EU from a third country:\nimport tariff, pickup outside the EU, delivery inside the EU, ordering customer is a business and\nthe receiver address has no company name. Otherwise optional.\n", "example": "SKU-12345" }, "manufacturerProductId": { "type": [ "string", "null" ], "maxLength": 35, "description": "Non-standardised manufacturer product ID (NS-PID, EU customs code C128): the manufacturer's or\nsupplier's internal product code, e.g. a model or part number. No set format; may be identical to\nthe EAN/GTIN.\nRequired, like the other of M-PID and NS-PID, for B2C imports into the EU from a third country:\nimport tariff, pickup outside the EU, delivery inside the EU, ordering customer is a business and\nthe receiver address has no company name. Otherwise optional.\n", "example": "MFG-67890" }, "standardizedProductId": { "type": [ "string", "null" ], "maxLength": 35, "description": "Standardised manufacturer product ID (S-PID, EU customs code C129): EAN, GTIN, UPC or ISBN. Only if\none exists; never required.\n", "example": "4006381333931" } } }, "EmptyList": { "type": "array", "maxItems": 0, "items": true, "description": "An empty list. The API serialises an empty object as `[]`, so a field documented as an object is an empty list while it has no entries." }, "Insurance": { "type": "object", "properties": { "percent": { "type": "number", "format": "float", "description": "Premium in percent of the insured value", "example": 1.5 }, "min": { "type": "number", "format": "float", "description": "Min amount", "example": 3.99 }, "minGross": { "type": "number", "format": "float", "description": "Min amount gross", "example": 3.99 }, "maxInsuranceValue": { "type": "number", "description": "Highest insurable value", "example": 50000 } } }, "InvoiceDocument": { "type": "object", "required": [ "name", "type", "reference" ], "properties": { "name": { "type": "string", "description": "Document name", "example": "R-200206200544.pdf" }, "type": { "type": "string", "description": "Type of document", "example": "invoice" }, "reference": { "type": "string", "description": "Reference", "example": "200206200544" }, "file": { "type": "string", "description": "Base64 file content; only on the order documents endpoint" } } }, "LabelDocument": { "type": "object", "required": [ "name", "type", "reference" ], "properties": { "name": { "type": "string", "description": "Document name", "example": "L-200206AJ75-1.pdf" }, "type": { "type": "string", "description": "Type of document", "example": "label" }, "reference": { "type": "string", "description": "Reference", "example": "200206AJ75-1" }, "file": { "type": "string", "description": "Base64 file content; only on the order documents endpoint" } } }, "LocalDateTime": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "A timestamp as `YYYY-MM-DD hh:mm:ss` in the Europe/Berlin time zone (CET/CEST), not RFC 3339.", "example": "2026-10-21 10:40:31" }, "MidnightDateTime": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$", "description": "A date as `YYYY-MM-DDThh:mm:ssZ`. Only the date part is meaningful: the time part is the UTC midnight of that date rendered in the account time zone, so it reads `T02:00:00Z` during CEST and `T01:00:00Z` during CET.", "example": "2026-10-21T02:00:00Z" }, "OrderAddress": { "type": "object", "description": "An address of the order as it was saved with the order.", "properties": { "id": { "type": "integer", "description": "Address id", "example": 1148 }, "company": { "type": [ "string", "null" ], "example": "Jumingo Inc." }, "name": { "type": [ "string", "null" ], "example": "Ajax" }, "street": { "type": [ "string", "null" ], "example": "Kurfürstendamm 32" }, "street2": { "type": [ "string", "null" ], "example": "Alexanderplatz" }, "zip": { "type": [ "string", "null" ], "example": "12345" }, "city": { "type": [ "string", "null" ], "example": "Berlin" }, "state": { "type": [ "string", "null" ], "example": null }, "country": { "type": [ "string", "null" ], "description": "ISO 3166-1 alpha-2 country code", "example": "DE" }, "phone": { "type": [ "string", "null" ], "example": "380432144556" } } }, "OrderDocuments": { "type": "object", "description": "The documents of an order. `orderNumber` and `id` come with an order; the documents endpoint omits them and carries each document's `file` instead.", "required": [ "invoicesCount", "proformasCount", "commercialInvoicesCount", "confirmationsCount", "exportCertVatCount", "invoices", "confirmations", "proformas", "labels", "commercialInvoices", "exportDeclarations", "exportCertVat" ], "properties": { "orderNumber": { "type": "string", "description": "The order number", "example": "2024010311" }, "id": { "type": "string", "description": "The order number, repeated as the id of this document set", "example": "2024010311" }, "invoicesCount": { "type": "integer", "description": "Expected invoices count", "example": 1 }, "proformasCount": { "type": "integer", "description": "Expected proformas count", "example": 1 }, "commercialInvoicesCount": { "type": "integer", "description": "Expected commercial invoices count. Shipments whose commercial invoice is generated by JUMiNGO are counted while the PDF is still being rendered, so the difference to the length of `commercialInvoices` is the number of documents still pending.", "example": 1 }, "confirmationsCount": { "type": "integer", "description": "Expected order confirmations count", "example": 1 }, "invoices": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceDocument" } }, "confirmations": { "type": "array", "items": { "$ref": "#/components/schemas/ConfirmationDocument" } }, "proformas": { "description": "Keyed by shipment id; an empty list when the order has none.", "anyOf": [ { "$ref": "#/components/schemas/EmptyList" }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ProformaDocument" } } ] }, "labels": { "description": "Keyed by shipment id; an empty list when the order has none.", "anyOf": [ { "$ref": "#/components/schemas/EmptyList" }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/LabelDocument" } } ] }, "commercialInvoices": { "description": "Keyed by shipment id; an empty list when the order has none.", "anyOf": [ { "$ref": "#/components/schemas/EmptyList" }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ShipmentFileDocument" } } ] }, "exportDeclarations": { "description": "Keyed by shipment id; an empty list when the order has none.", "anyOf": [ { "$ref": "#/components/schemas/EmptyList" }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ShipmentFileDocument" } } ] }, "exportCertVatCount": { "type": "integer", "description": "Expected export VAT certificates count", "example": 0 }, "exportCertVat": { "description": "Keyed by shipment id; an empty list when the order has none.", "anyOf": [ { "$ref": "#/components/schemas/EmptyList" }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ShipmentFileDocument" } } ] } } }, "OrderOutput": { "type": "object", "properties": { "orderNumber": { "type": "string", "description": "Order number", "example": "B-2024010311" }, "customer": { "type": "object", "properties": { "customerNumber": { "type": "integer", "description": "Customer number", "example": 100001 }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/OrderAddress" } } } }, "paymentMethod": { "type": "string", "description": "Order payment method", "example": "bill" }, "accountOwner": { "type": [ "string", "null" ], "description": "Account Owner", "example": "Owner" }, "iban": { "type": [ "string", "null" ], "description": "International Bank Account Number (IBAN)", "example": "SE35 5000 0000 0549 1000 0003" }, "bic": { "type": [ "string", "null" ], "description": "Business Identifier Code (BIC)", "example": "BARCGB22XXX" }, "lastschriftmandat": { "type": [ "string", "null" ], "description": "Lastschrift mandatory", "example": "" }, "paypalEmail": { "type": [ "string", "null" ], "description": "PayPal email", "example": "user@mail.com" }, "paypalTransactionId": { "type": [ "string", "null" ], "description": "PayPal transaction id", "example": "VADE0B248932" }, "paypalPuiReferenceNumber": { "type": [ "string", "null" ], "description": "PayPal Pay upon Invoice (PUI) reference number", "example": "VADE0B248932" }, "paypalPuiBankName": { "type": [ "string", "null" ], "description": "PayPal Pay upon Invoice (PUI) Bank name", "example": "Bank" }, "paypalPuiAccountHolderName": { "type": [ "string", "null" ], "description": "PayPal Pay upon Invoice (PUI) holder name", "example": "Dou John" }, "paypalPuiInternationalBankAccountNumber": { "type": [ "string", "null" ], "description": "PayPal Pay upon Invoice (PUI) Banck number", "example": "VADE0B123545" }, "paypalPuiBankIdentifierCode": { "type": [ "string", "null" ], "description": "PayPal Pay upon Invoice (PUI) Banck number", "example": "VADE0B123545" }, "paypalPuiValue": { "type": [ "number", "null" ], "description": "PayPal Pay upon Invoice (PUI) amount", "example": 22.3 }, "paypalPuiCurrency": { "type": [ "string", "null" ], "description": "PayPal Pay upon Invoice (PUI) currency", "example": "EUR" }, "paypalPuiPaymentDueDate": { "type": [ "string", "null" ], "description": "PayPal Pay upon Invoice (PUI) due date" }, "sofortTransactionId": { "type": [ "string", "null" ], "description": "Sofort transaction id", "example": "UR55578852" }, "paymentTransactionId": { "type": [ "string", "null" ], "description": "Payment transaction id", "example": "UR55578852" }, "paymentCreditcardNumber": { "type": [ "string", "null" ], "description": "Payment credit card number", "example": "5362 0000 0000 0003" }, "paymentData": { "type": [ "object", "null" ], "description": "Payment-method specific data as given when paying.", "additionalProperties": true }, "taxNet": { "type": "number", "format": "float", "description": "Invoice tax netto", "example": 183.66 }, "taxFreeNet": { "type": "number", "format": "float", "description": "Invoice tax free netto", "example": 0 }, "tax": { "type": "number", "format": "float", "description": "Tax amount", "example": 34.9 }, "gross": { "type": "number", "format": "float", "description": "Invoice amount gross", "example": 218.56 }, "paymentReceipt": { "type": "number", "format": "float", "description": "Amount already received for this order", "example": 0 }, "paymentDate": { "$ref": "#/components/schemas/LocalDateTime", "description": "When the payment was made." }, "voucherCode": { "type": "string", "description": "Voucher code", "example": "ED455DF44541" }, "voucherValue": { "type": "number", "format": "float", "description": "Voucher value", "example": 0 }, "voucherPercent": { "type": "number", "format": "float", "description": "Voucher value", "example": 0 }, "voucherType": { "type": "string", "description": "Voucher type", "example": "Discount" }, "subtotal": { "type": "number", "format": "float", "description": "Sub total of order", "example": 16.64 }, "discountPercent": { "type": "number", "format": "float", "description": "Discount of percent", "example": 0 }, "currency": { "type": "string", "description": "Currency", "example": "EUR" }, "currencyDetails": { "type": [ "array", "null" ], "items": { "type": "string" } }, "created": { "$ref": "#/components/schemas/LocalDateTime", "description": "When the order was created." }, "surcharges": { "type": "number", "format": "float", "description": "Additional charges", "example": 1.53 }, "paymentSurcharge": { "type": "number", "format": "float", "description": "Additional payment charge", "example": 2.02 }, "shipments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "description": "Id of shipment entity", "example": 1 }, "uuid": { "type": "string", "description": "The shipment id used by the shipment endpoints", "example": "s_21b7f7ad8a584fce9f776b9cf6004711" }, "orderShipmentNumber": { "type": "string", "description": "Shipment number", "example": "200206OM6Y" }, "shipmentContent": { "type": "string", "description": "Shipment content", "example": "Content description" }, "shipmentValue": { "type": [ "integer", "null" ], "description": "Shipment value", "example": 112 }, "trackingNumber": { "type": [ "string", "null" ], "description": "Tracking number", "example": "TN-12345" } } } }, "unpaid": { "type": "boolean", "description": "Status of order" }, "cancelOrderLink": { "type": "string", "description": "FYQ link with info how to cansel order", "example": "2/94" }, "documents": { "$ref": "#/components/schemas/OrderDocuments" }, "modified": { "$ref": "#/components/schemas/LocalDateTime", "description": "When the order was last modified." } } }, "PackageType": { "type": "object", "properties": { "id": { "type": "integer", "description": "Package id", "example": 1 }, "name": { "type": "string", "description": "Package name", "example": "Paket" }, "description": { "type": "object", "properties": { "name": { "type": "string", "description": "Description of the package type; may be empty", "example": "

Ein normaler quaderförmiger Karton, der stapelbar ist.

" } } }, "machineName": { "$ref": "#/components/schemas/PackagingType" } } }, "PackagingType": { "type": "string", "description": "Specifies the type of packaging of the packages. A response carries `undefined` while the shipment has no packages.", "enum": [ "undefined", "parcel", "document", "bulk", "pallet", "n_s_pallet", "tires", "suitcase" ], "default": "parcel" }, "PatchShipment": { "type": "object", "properties": { "from_address": { "$ref": "#/components/schemas/CreateShipmentAddress" }, "to_address": { "$ref": "#/components/schemas/CreateShipmentAddress" }, "billing_address": { "$ref": "#/components/schemas/ShipmentAddress" }, "details": { "$ref": "#/components/schemas/CreateShipmentDetails" }, "packages": { "type": "array", "description": "Packages of the shipment", "items": { "$ref": "#/components/schemas/CreateShipmentPackage" } }, "customs_invoice": { "$ref": "#/components/schemas/CustomsInvoiceInput" }, "connection": { "$ref": "#/components/schemas/CreateShipmentConnection" }, "rate": { "$ref": "#/components/schemas/CreateShipmentRate" }, "label_format": { "type": "string", "description": "Label format", "enum": [ "A4", "A6" ] } }, "description": "The sections of the shipment to change; everything else is kept." }, "PaymentInput": { "type": "object", "required": [ "method", "shipmentIds" ], "properties": { "shipmentIds": { "type": "array", "description": "The shipments to pay for.", "items": { "type": "string", "example": "s_21b7f7ad8a584fce9f776b9cf6004711" } }, "method": { "type": "string", "description": "Payment method. Which methods your account may use is returned by `POST /v1/cart/total`.", "enum": [ "rechnung", "sammelrechnung", "lastschrift", "paypal", "creditcard", "instantpay", "giropay" ], "example": "rechnung" }, "voucherCode": { "type": "string", "description": "The voucher code", "example": "jum100" }, "data": { "type": "object", "properties": { "accountOwner": { "type": "string", "example": "John Doe" }, "iban": { "type": "string", "example": "DE89370400440532013000" }, "bic": { "type": "string", "example": "ABAGATWWXXX" }, "agreement": { "type": "boolean", "description": "The SEPA mandate was accepted.", "example": true } }, "description": "Payment-method specific data, e.g. the SEPA mandate for `lastschrift`." } }, "description": "Pays for one or more shipments and turns them into an order." }, "PaymentMethodsOutput": { "type": "object", "required": [ "name", "additionalData" ], "properties": { "name": { "type": "string", "description": "Payment method name", "example": "bill" }, "additionalData": { "description": "Data of the payment method, e.g. the billing address for payment on account; an empty list when the method has none.", "anyOf": [ { "$ref": "#/components/schemas/EmptyList" }, { "type": "object", "additionalProperties": true } ] } } }, "PaymentResult": { "type": "object", "description": "The outcome of a payment.", "required": [ "id", "success", "returnUrl", "failureUrl", "message", "paymentRedirectUrl", "returnData", "orderNumber", "token", "customerNumber", "hadOrderBefore", "shipmentIds" ], "properties": { "id": { "type": "integer", "description": "Always 1; the result has no identity of its own.", "example": 1 }, "success": { "type": "boolean", "description": "Payment status" }, "returnUrl": { "type": [ "string", "null" ], "description": "Set for redirect-based payment methods only, null otherwise: send the customer here to complete the payment." }, "failureUrl": { "type": [ "string", "null" ], "description": "Where a redirect-based payment returns on failure; null otherwise." }, "message": { "type": [ "string", "null" ], "description": "A message about the payment, e.g. why it failed; null otherwise." }, "paymentRedirectUrl": { "type": [ "string", "null" ], "description": "The payment provider's page for redirect-based payment methods; null otherwise." }, "returnData": { "description": "Provider-specific data of the payment; an empty list when there is none.", "anyOf": [ { "$ref": "#/components/schemas/EmptyList" }, { "type": [ "object", "null" ], "additionalProperties": true } ] }, "orderNumber": { "type": [ "string", "null" ], "description": "The order number of the paid order.", "example": "B-2024010311" }, "token": { "type": [ "string", "null" ], "description": "Set for redirect-based payment methods only, null otherwise." }, "customerNumber": { "type": [ "integer", "null" ], "description": "The customer number the order belongs to.", "example": 920119 }, "hadOrderBefore": { "type": "boolean", "description": "True when the account already had a paid order before this one." }, "shipmentIds": { "type": [ "array", "null" ], "description": "The ids of the shipments the order contains.", "items": { "type": "string", "example": "s_21b7f7ad8a584fce9f776b9cf6004711" } } } }, "Problem": { "type": "object", "description": "The error body of every 4xx and 5xx response except 401, following RFC 7807.", "required": [ "title", "detail", "status", "type" ], "properties": { "title": { "type": "string", "example": "An error occurred" }, "detail": { "type": "string", "description": "Human-readable explanation, in the language of the account.", "example": "Shipment not found" }, "status": { "type": "integer", "description": "The HTTP status code of the response.", "example": 404 }, "type": { "type": "string", "description": "The error category as a relative URI.", "example": "/errors/404" } } }, "ProformaDocument": { "type": "object", "required": [ "name", "type", "reference" ], "properties": { "name": { "type": "string", "description": "Document name", "example": "P-200206AJ75-1.pdf" }, "type": { "type": "string", "description": "Type of document", "example": "proforma" }, "reference": { "type": "string", "description": "Reference", "example": "200206AJ75-1" }, "file": { "type": "string", "description": "Base64 file content; only on the order documents endpoint" } } }, "Shipment": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique ID of the shipment", "example": "s_c6aa551badab4223a75da01316ce0752" }, "customer_number": { "type": "integer", "format": "int32", "description": "Your customer number", "example": 920119 }, "customer_personal_name": { "type": [ "string", "null" ], "description": "Your personal name, it's allowed only if you are a team member", "example": "John Doe" }, "created": { "$ref": "#/components/schemas/LocalDateTime", "description": "When the shipment was created." }, "last_modified": { "$ref": "#/components/schemas/LocalDateTime", "description": "When the shipment was last modified." }, "status": { "type": "string", "description": "The processing status of the shipment", "enum": [ "missing_data", "ready", "completed", "in_transit", "in_delivery", "delivered", "in_progress", "archived" ], "example": "completed" }, "source": { "type": [ "object", "null" ], "description": "Where the shipment came from.", "properties": { "type": { "type": "string", "description": "`Excel`, `CSV`, `API`, `BULKSEND`, `Calculator`, `Tracking` or the name of the shop system the shipment was imported from, e.g. `Ebay`.", "example": "API" }, "id": { "type": [ "string", "null" ], "description": "Identifier of the import the shipment belongs to." }, "original_filename": { "type": [ "string", "null" ], "description": "File name of the import, for file-based sources." } } }, "from_address": { "$ref": "#/components/schemas/ShipmentAddress" }, "to_address": { "$ref": "#/components/schemas/ShipmentAddress" }, "details": { "$ref": "#/components/schemas/ShipmentDetails" }, "customs_invoice": { "anyOf": [ { "$ref": "#/components/schemas/CustomsInvoiceOutput" }, { "type": "null" } ], "description": "Null unless the shipment needs customs documents." }, "packages": { "type": "array", "description": "Packages of the shipment", "items": { "$ref": "#/components/schemas/ShipmentPackage" } }, "connection": { "anyOf": [ { "$ref": "#/components/schemas/ShipmentConnection" }, { "type": "null" } ], "description": "The shop connection the shipment was imported through; null for other sources." }, "rate": { "anyOf": [ { "$ref": "#/components/schemas/ShipmentRate" }, { "type": "null" } ], "description": "The selected rate; null until one is selected." }, "tracking": { "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking" }, { "type": "null" } ], "description": "Null until a label was bought." }, "dates_in_the_past": { "type": "boolean", "description": "Is pickup or delivery dates in the past according country timezones.", "example": true }, "settings": { "type": "object", "description": "Shipment settings. Besides the keys below the object carries internal state such as the snapshot of the selected rate.", "additionalProperties": true, "properties": { "source_type": { "type": "string", "description": "Source of shipment", "example": "SCC" }, "label_format": { "type": "string", "description": "Prefered label format", "enum": [ "A4", "A6" ] }, "use_commercial_invoice": { "type": "boolean", "description": "An indicator that shows whether to use a commercial invoice or a proforma invoice" } } }, "picked_up": { "type": "boolean", "description": "The parcel had not been collected successfully during the initial pickup time frame.", "example": false }, "update_ordered_delivery_address_allowed": { "type": "boolean", "description": "Parameter to show can we update delivery address for an already ordered shipment or not", "example": false }, "product_identifiers_required": { "type": [ "boolean", "null" ], "description": "Whether the customs line items of this shipment must carry `merchantProductId` (M-PID, C127) and\n`manufacturerProductId` (NS-PID, C128): a B2C import into the EU from a third country. Read-only.\n", "example": false }, "pickup_status": { "type": "integer", "description": "Statuses for a new pickup: '0' - default status; '1' - 'schedule a new pickup' email has been sent; '2' - second pickup scheduled; '3' - support email after failed second pickup has been sent;", "example": 0 }, "billing_address": { "$ref": "#/components/schemas/ShipmentAddress" }, "customer_initials": { "type": [ "string", "null" ], "description": "Initials of the team member who created the shipment." }, "internal_status": { "type": "string", "description": "Lifecycle status of the shipment record.", "example": "open" }, "isCancellationPossible": { "type": "boolean", "description": "Whether the shipment can still be cancelled.", "example": false }, "is_return_possible": { "type": "boolean", "description": "Whether a return shipment can be created for it.", "example": true }, "canceled": { "type": "boolean", "example": false }, "type": { "type": "integer", "description": "Shipment type identifier.", "example": 2 }, "delayed": { "type": "boolean", "description": "The carrier reported a delay.", "example": false }, "order": { "type": [ "object", "null" ], "description": "The order the shipment was paid with; null while the shipment is a draft.", "properties": { "number": { "type": [ "string", "null" ], "example": "2024010311" }, "unpaid": { "type": [ "boolean", "null" ], "example": false }, "canceled": { "type": [ "boolean", "null" ], "example": false }, "created": { "type": [ "string", "null" ], "description": "When the order was created, as `YYYY-MM-DD hh:mm:ss` in UTC.", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "example": "2026-10-21 08:40:32" } } }, "import_status": { "type": "string", "description": "Status of the import run that created or updated the shipment.", "example": "completed" }, "import_progress_status": { "type": [ "string", "null" ], "description": "Step of the import run the shipment is in; empty or null when finished.", "example": "" }, "import_checkout_id": { "type": [ "string", "null" ] }, "import_messages": { "description": "Import validation messages grouped by shipment section; an empty list when the import had no issues.", "anyOf": [ { "$ref": "#/components/schemas/EmptyList" }, { "type": "object", "properties": { "parcel": { "anyOf": [ { "$ref": "#/components/schemas/EmptyList" }, { "type": "object", "additionalProperties": { "type": "object" } } ] }, "addresses": { "anyOf": [ { "$ref": "#/components/schemas/EmptyList" }, { "type": "object", "properties": { "pickup": { "type": "array", "items": { "type": "object" } }, "delivery": { "type": "array", "items": { "type": "object" } }, "return": { "type": "array", "items": { "type": "object" } }, "billing": { "type": "array", "items": { "type": "object" } } } } ] }, "details": { "type": "array", "items": { "type": "object" } }, "packages": { "type": "array", "description": "One entry per package.", "items": true }, "customsInvoice": { "anyOf": [ { "$ref": "#/components/schemas/EmptyList" }, { "type": "object", "properties": { "lineItems": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } } } } ] } } } ] }, "import_messages_text": { "description": "Import validation messages grouped by shipment section; an empty list or null when the import had no issues.", "anyOf": [ { "$ref": "#/components/schemas/EmptyList" }, { "type": "null" }, { "type": "object", "properties": { "parcel": { "anyOf": [ { "$ref": "#/components/schemas/EmptyList" }, { "type": "object", "description": "Messages per field. An entry is the message text, or an object with the rejected `oldValue`.", "additionalProperties": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "additionalProperties": true } ] } } } ] }, "addresses": { "anyOf": [ { "$ref": "#/components/schemas/EmptyList" }, { "type": "object", "properties": { "pickup": { "type": "array", "items": { "type": "object" } }, "delivery": { "type": "array", "items": { "type": "object" } }, "return": { "type": "array", "items": { "type": "object" } }, "billing": { "type": "array", "items": { "type": "object" } } } } ] }, "details": { "type": "array", "items": { "type": "object" } }, "packages": { "type": "array", "description": "One entry per package.", "items": true }, "customsInvoice": { "anyOf": [ { "$ref": "#/components/schemas/EmptyList" }, { "type": "object", "properties": { "lineItems": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } ] } } } ] }, "shipment_issues": { "type": "array", "description": "Open issues that block the shipment, e.g. an incomplete customs invoice.", "items": { "type": "object", "properties": { "issue_type": { "type": "string", "example": "todo" }, "reason": { "type": "string", "example": "cin_incomplete" } } } }, "documents": { "type": "object", "description": "Download paths of the customs documents attached to the shipment; null when not available.", "properties": { "proforma": { "type": [ "string", "null" ] }, "commercial_invoice": { "type": [ "string", "null" ] }, "export_declaration": { "type": [ "string", "null" ] }, "proof_of_export": { "type": [ "string", "null" ] }, "export_cert_vat": { "type": [ "string", "null" ] } } }, "has_label": { "type": "boolean", "example": false }, "has_proforma": { "type": "boolean", "example": false }, "has_commercial_invoice": { "type": "boolean", "example": false }, "has_export_declaration": { "type": "boolean", "example": false }, "has_proof_of_export": { "type": "boolean", "example": false }, "has_export_cert_vat": { "type": "boolean", "example": false }, "export_cert_vat_possible": { "type": "boolean", "example": true }, "export_declaration": { "type": [ "string", "null" ] }, "label_generation_status": { "type": "string", "example": "waiting" }, "label_sent_on": { "type": [ "string", "null" ] }, "post_order_update_allowed": { "type": "boolean", "description": "Whether the delivery address may still be changed after ordering.", "example": true }, "tax_free_reason": { "type": [ "string", "null" ], "example": "third_country_transfer" }, "tax_id": { "type": [ "string", "null" ] }, "dates": { "type": "object", "description": "Pickup, transit and delivery dates of the selected rate, formatted for display in the language of the account.", "additionalProperties": true }, "dates_aggregation": { "type": "object", "description": "The `created` and `last_modified` timestamps split into date, time and minutes of the day.", "additionalProperties": { "type": "object", "properties": { "date": { "type": "string", "example": "2026-10-21" }, "time": { "type": "string", "example": "10:40:31" }, "minutes": { "type": "number", "example": 640 } } } } } }, "ShipmentAddress": { "type": "object", "properties": { "company": { "type": [ "string", "null" ], "description": "Company name", "maxLength": 35, "example": "Test Corp." }, "name": { "type": [ "string", "null" ], "description": "First and Last Name", "maxLength": 35, "example": "John Doe" }, "street": { "type": [ "string", "null" ], "description": "First address line (usually street name and house number)", "maxLength": 35, "example": "100 West 33rd Street" }, "street2": { "type": [ "string", "null" ], "description": "Second address line for further information", "maxLength": 35, "example": "Apt 123" }, "zip": { "type": [ "string", "null" ], "description": "Postal code of the address", "maxLength": 10, "example": "10001" }, "city": { "type": [ "string", "null" ], "description": "Name of the city", "maxLength": 30, "example": "New York" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/State" }, { "type": "null" } ] }, "country": { "anyOf": [ { "$ref": "#/components/schemas/CountryCode" }, { "type": "null" } ] }, "phone": { "type": [ "string", "null" ], "description": "Phone number", "maxLength": 35, "example": "1234567890" }, "settings": { "description": "Custom address data; null or an empty list when there is none.", "anyOf": [ { "$ref": "#/components/schemas/EmptyList" }, { "type": [ "object", "null" ], "additionalProperties": true } ] }, "id": { "type": [ "integer", "null" ], "description": "Address id in the account address book.", "example": 1576 } } }, "ShipmentCheapestRateInput": { "type": "object", "required": [ "deliveryDate", "pickupDate", "settings" ], "properties": { "filterData": { "type": "object", "properties": { "deliveryTimeUntil": { "type": "integer", "description": "Latest delivery time", "example": 0 }, "options": { "type": "array", "items": { "type": "string" }, "description": "options", "example": [] }, "packageTypes": { "type": "integer", "description": "Package type id", "example": 17 }, "priceMax": { "type": "integer", "description": "Max price", "example": 17 }, "shipperGroups": { "type": "array", "items": { "type": "string" }, "description": "Shipper groups", "example": [] }, "shippingType": { "type": "integer", "description": "The shipping type indicates whether the shipment must be delivered in a shop or picked up by a driver.", "example": 2 }, "tariffTypes": { "type": "array", "items": { "type": "string" }, "description": "Tariff types", "example": [] }, "timeMax": { "type": "integer", "description": "Max time", "example": 1440 }, "timeMin": { "type": "integer", "description": "Min time", "example": 0 }, "transitTimeMax": { "type": "integer", "description": "Max time of transit", "example": 125 } } }, "deliveryDate": { "type": "string", "format": "date-time", "description": "Delivery date", "example": "2020-07-14T17:10:37Z" }, "pickupDate": { "type": "string", "format": "date-time", "description": "The date for which the collection was arranged.", "example": "2020-07-14T17:10:37Z" }, "pickupDateMode": { "$ref": "#/components/schemas/ShipmentPickupDateMode" }, "settings": { "type": "object", "properties": { "mode": { "type": "string", "description": "Setting modes for shipment tariff", "example": "m", "enum": [ "m", "a", "a2", "all", "single" ] }, "tariffId": { "type": "string", "description": "Tarriff id", "example": "s-4" }, "getExternalTariffs": { "type": "boolean", "description": "allow to get external tariffs", "example": true } } } } }, "ShipmentConnection": { "type": "object", "properties": { "connection_uuid": { "type": "string", "description": "The ID of the connection used to create the shipment.", "example": "c_891547f2fca547e798ba61dbf89acdde" }, "connection_name": { "type": [ "string", "null" ], "description": "The name of the connection.", "example": "My shop" }, "connection_type": { "type": [ "integer", "null" ], "description": "The connection type id.", "example": 1 }, "connection_item_uuid": { "type": [ "string", "null" ], "description": "Your individual item ID of the shipment. Mostly corresponds to the order number in your shop.", "example": "my-unique-item-id" }, "connection_custom_data": { "$ref": "#/components/schemas/ConnectionCustomData", "description": "The custom data given when the shipment was created; only the fields the shop sent are present." } } }, "ShipmentDetails": { "type": "object", "properties": { "value_amount": { "type": [ "integer", "null" ], "format": "int32", "description": "Goods value of the consignment; needed for the customs", "minimum": 1, "maximum": 999999999, "example": 200 }, "value_currency": { "$ref": "#/components/schemas/CurrencyCode" }, "content_description": { "type": [ "string", "null" ], "description": "Description of the contents of the package(s); needed for the customs", "example": "sample" }, "reference_number": { "type": [ "string", "null" ], "description": "A reference text that you can use to identify your shipment, e.g. an order number of your merchandise management system. Will be printed on the shipping label in most cases.", "example": "my-reference" }, "email": { "type": [ "string", "null" ], "description": "Is always the email address of your customer account", "example": "email@example.org" }, "email_tracking": { "type": [ "string", "null" ], "description": "If specified, after the order has been placed, an email will be sent to this email address with the tracking link", "example": "email@example.org" }, "email_label_copy": { "type": [ "string", "null" ], "description": "If specified, after the order has been placed, an additional email with the shipping label will be sent to this email address", "example": "email@example.org" }, "insurance_amount": { "type": "integer", "format": "int32", "description": "Amount of additional insurance value", "minimum": 0, "maximum": 20000, "example": 200 }, "insurance_currency": { "type": "string", "example": "EUR" }, "extra_insurance_price_netto": { "type": "number", "description": "Amount of extra insurance value netto", "example": 8.2, "format": "float" }, "extra_insurance_price_brutto": { "type": "number", "description": "Amount of extra insurance value brutto", "example": 10, "format": "float" }, "export_license": { "type": "boolean", "description": "Indicate if you need an export license and want to buy it along with the shipment" }, "extra_insurance_value": { "type": "integer", "description": "Amount of extra insurance value", "example": 300 }, "extra_insurance_type": { "type": [ "string", "null" ], "description": "Type of insurance. Possible values: standard | premium", "enum": [ "standard", "premium", null ] }, "extra_insurance_provider": { "type": [ "string", "null" ], "description": "Provider of the extra insurance; null without extra insurance.", "example": "Kravag" }, "export_license_price_brutto": { "type": "number", "description": "Amount of extra license price brutto", "example": 11, "format": "float" }, "shipment_order_number_short": { "type": [ "string", "null" ], "description": "Shipment order number (only after the order has been placed)", "example": "A-180709V1ML-1" }, "shipment_order_number": { "type": [ "string", "null" ], "description": "Order number (only after the order has been placed)", "example": "B-180709V1ML" }, "packaging_type": { "$ref": "#/components/schemas/PackagingType" }, "hs_tariff_number": { "type": [ "string", "null" ], "description": "Hs number for import/export goods defining the type of the good for customs.", "example": "61091000" }, "extra_export_license_number": { "type": [ "string", "null" ], "description": "Extra export license number", "example": "4200042" }, "settings": { "type": "object", "description": "Custom settings", "example": { "use_commercial_invoice": false }, "additionalProperties": true } } }, "ShipmentFileDocument": { "type": "object", "required": [ "name", "type", "reference" ], "properties": { "name": { "type": "string", "description": "Document name", "example": "my-custom-name.pdf" }, "type": { "type": "string", "description": "Type of document", "example": "commercial-invoice" }, "reference": { "type": "string", "description": "Reference", "example": "s_642bf5ab244c4380a379f0c8877f69b3" }, "file": { "type": "string", "description": "Base64 file content; only on the order documents endpoint" } } }, "ShipmentPackage": { "type": "object", "description": "A package of the shipment as the API returns it; the input shape is CreateShipmentPackage.", "required": [ "id", "weight", "length", "width", "height", "volume_weight", "girth", "first_length", "second_length", "type", "type_id", "name", "api_shipment_ids", "quantity" ], "properties": { "id": { "type": "integer", "description": "Package id", "example": 326 }, "weight": { "type": [ "number", "null" ], "format": "float", "description": "Weight of the package in kg", "minimum": 0.1, "maximum": 9999999, "example": 0.1 }, "length": { "type": [ "integer", "null" ], "format": "int32", "description": "Length of the package in cm", "minimum": 1, "maximum": 99999, "example": 18 }, "width": { "type": [ "integer", "null" ], "format": "int32", "description": "Width of the package in cm", "minimum": 1, "maximum": 99999, "example": 19 }, "height": { "type": [ "integer", "null" ], "format": "int32", "description": "Height of the package in cm", "minimum": 1, "maximum": 99999, "example": 20 }, "volume_weight": { "type": [ "number", "null" ], "format": "float", "description": "Volumetric weight of the package in kg", "example": 0.0048 }, "girth": { "type": [ "integer", "null" ], "format": "int32", "description": "Girth of the package in cm", "minimum": 1, "example": 96 }, "first_length": { "type": [ "integer", "null" ], "format": "int32", "description": "Longest side of the package in cm", "minimum": 1, "example": 20 }, "second_length": { "type": [ "integer", "null" ], "format": "int32", "description": "Second longest side of the package in cm", "minimum": 1, "example": 19 }, "type": { "type": "string", "description": "Package type machine name", "example": "parcel" }, "type_id": { "type": "integer", "description": "Package type id", "example": 7 }, "name": { "type": [ "string", "null" ], "description": "Package name, the shipment number with the package position; null before the shipment has a number.", "example": "2024010311-1" }, "api_shipment_ids": { "type": [ "array", "null" ], "description": "Carrier shipment ids of the package once booked; null before.", "items": { "type": "string" } }, "quantity": { "type": "integer", "description": "How many identical packages this entry stands for", "example": 1 } } }, "ShipmentPickupDateMode": { "type": "string", "description": "Mode of pickup date. Default is flex. Use exact in combination with a pickupDate to filter only rates that can still be picked up on this day.", "example": "flex", "enum": [ "flex", "exact" ] }, "ShipmentRate": { "type": "object", "properties": { "carrier": { "type": "object", "description": "The carrier and tariff behind the rate.", "properties": { "shipper_group_id": { "type": "integer", "example": 2 }, "shipper_group_name": { "type": "string", "description": "Name of the carrier", "example": "DHL Express" }, "shipper_id": { "type": "integer", "example": 129 }, "shipper_tariff_id": { "type": "integer", "example": 522 }, "shipper_tariff_full_id": { "type": "string", "example": "522" }, "shipper_tariff_type_id": { "type": "integer", "example": 5 }, "shipper_tariff_type_name": { "type": "string", "example": "Economy" }, "shipper_tariff_zone_id": { "type": "integer", "example": 2845 }, "limits": { "type": "array", "items": true } } }, "service": { "type": "object", "description": "The carrier product.", "properties": { "name": { "type": "string", "example": "DHL Express Worldwide" }, "description": { "type": [ "string", "null" ] }, "image": { "type": "string", "example": "/img/versandrechner/tarife/dhlexpress.svg" }, "dispatch_id": { "type": "integer", "example": 1 }, "agb_link": { "type": [ "string", "null" ], "description": "Link to the carrier terms and conditions." }, "is_plus_product": { "type": "boolean", "example": false }, "is_trackable_product": { "type": "boolean", "example": true }, "is_insurable_product": { "type": "boolean", "example": true }, "has_shop_finder": { "type": "boolean", "example": false } } }, "shipping_type": { "type": "string", "description": "The shipping type indicates whether the shipment must be delivered in a shop or picked up by a driver.", "enum": [ "pickup", "shop" ], "example": "pickup" }, "transit_time_range_days": { "type": "string", "description": "Specifies the minimum and maximum delivery time in working days that the shipment is expected to be on its way.", "example": "1-6" }, "max_included_liability_currency": { "$ref": "#/components/schemas/Currency" }, "printer_required": { "type": "boolean", "description": "Indicates whether a printer is required to print the shipping label.", "example": true }, "price_net": { "type": "number", "format": "float", "description": "Net price", "example": 5.79 }, "price_net_currency": { "$ref": "#/components/schemas/Currency" }, "price_total": { "type": "number", "format": "float", "description": "Total", "example": 6.89 }, "price_total_currency": { "$ref": "#/components/schemas/Currency" }, "tax_free": { "type": "boolean", "description": "Indicates whether the shipment is tax-free", "example": false }, "tax_rate": { "type": "number", "format": "float", "description": "Tax rate in percent", "example": 19 }, "tax_country": { "type": "string", "description": "ISO 3166-1 alpha-2 code of the country whose tax applies; empty when tax-free.", "example": "DE" }, "tax_name": { "type": "string", "description": "Name of the tax", "example": "MwSt." }, "pickup_date": { "type": "string", "format": "date", "description": "The date for which the collection was arranged.", "example": "2018-07-09" }, "pickup_min_time": { "anyOf": [ { "$ref": "#/components/schemas/LocalDateTime" }, { "type": "null" } ], "description": "The earliest time at which the shipment is picked up; null while no pickup window is known." }, "pickup_max_time": { "$ref": "#/components/schemas/LocalDateTime", "description": "The latest time by which the shipment is picked up." }, "pickup_reference_number": { "type": [ "string", "null" ], "description": "A reference number with which the collection can be checked.", "example": "135855S5SSCP" }, "delivery_date_min": { "$ref": "#/components/schemas/MidnightDateTime", "description": "Earliest delivery date" }, "delivery_date_max": { "$ref": "#/components/schemas/MidnightDateTime", "description": "Latest delivery date" }, "delivery_time_until": { "$ref": "#/components/schemas/LocalDateTime", "description": "Latest delivery time" }, "durationFormatted": { "type": "string", "description": "A formatted duration description with translation", "example": "4 hours" }, "max_liability": { "type": "number", "format": "float", "description": "The maximum included liability amount of this rate", "example": 25 }, "parcel_content_required": { "type": "boolean", "example": false }, "from_company_only": { "type": "boolean", "example": false }, "to_company_only": { "type": "boolean", "example": false }, "from_private_only": { "type": "boolean", "example": false }, "to_private_only": { "type": "boolean", "example": false }, "from_phone_number_required": { "type": "boolean", "example": false }, "to_phone_number_required": { "type": "boolean", "example": false }, "hs_tariff_number_required": { "type": "boolean", "example": false }, "is_jumingo_express": { "type": "boolean", "example": false }, "jum_disp": { "type": "boolean", "example": false }, "distance": { "type": "number", "format": "float", "example": 0 }, "distanceFormatted": { "type": [ "string", "null" ] }, "carType": { "type": [ "string", "null" ] }, "jumingo_express_carrier": { "type": [ "string", "null" ] }, "marketing_discount": { "type": "number", "example": 0 }, "marketing_discount_description": { "type": [ "string", "null" ] }, "uvp_discount_value": { "type": "number", "example": 0 }, "uvp_discount_percent": { "type": "number", "example": 0 }, "uvp_extra_insurance_price_brutto_preselect": { "type": "number", "format": "float", "example": 70.8 }, "uvp_extra_insurance_premium_price_brutto_preselect": { "type": "number", "format": "float", "example": 106.2 }, "extra_export_license_price_brutto_old": { "type": "number", "format": "float", "example": 59.95 }, "price_brutto_uvp": { "type": "number", "format": "float", "description": "List price including VAT", "example": 47.45 }, "price_netto_uvp": { "type": "number", "format": "float", "description": "List price excluding VAT", "example": 47.45 } }, "description": "The shipment rate object is only available if a tariff has been selected." }, "ShipmentRateAddress": { "type": "object", "description": "An address of the rate request, echoed with the rates.", "properties": { "company": { "type": [ "string", "null" ], "example": "Jumingo Inc." }, "name": { "type": [ "string", "null" ], "example": "Ajax" }, "street": { "type": [ "string", "null" ], "example": "Kurfürstendamm 32" }, "street2": { "type": [ "string", "null" ], "example": "Alexanderplatz" }, "zip": { "type": [ "string", "null" ], "example": "12345" }, "city": { "type": [ "string", "null" ], "example": "Berlin" }, "state": { "type": [ "string", "null" ], "example": null }, "country": { "type": [ "string", "null" ], "description": "ISO 3166-1 alpha-2 country code", "example": "DE" }, "phone": { "type": [ "string", "null" ], "example": "380432144556" } } }, "ShipmentRateInput": { "type": "object", "required": [ "shipmentId", "settings" ], "properties": { "shipmentId": { "type": "string", "description": "The unique ID of the shipment", "example": "s_c6aa551badab4223a75da01316ce0752" }, "filterData": { "type": "object", "properties": { "deliveryTimeUntil": { "type": "integer", "description": "Latest delivery time", "example": 0 }, "options": { "type": "array", "items": { "type": "string" }, "description": "Filter options.\n| ID | Description |\n| ---| -------------------------------------------------- |\n| 1 | No printer |\n| 3 | Pickup today |\n| 4 | Flexible pickup time |\n| 5 | Delivery from and to private addresses possible |\n| 6 | Insurance bookable |\n", "example": [] }, "packageTypes": { "type": "integer", "description": "Package type id (derived from the packagingType of the referenced shipmentId)", "example": 17 }, "priceMax": { "type": "integer", "description": "Maximum price", "example": 17 }, "shipperGroups": { "type": "array", "items": { "type": "string" }, "description": "Filter by shipper groups", "example": [] }, "shippingType": { "type": "integer", "description": "The shipping type indicates whether the shipment must be delivered in a shop or picked up by a driver.", "example": 2 }, "tariffTypes": { "type": "array", "items": { "type": "string" }, "description": "Filter by tariff types", "example": [] }, "timeMax": { "type": "integer", "description": "Maximum transit time in minutes", "example": 1440 }, "timeMin": { "type": "integer", "description": "Minimum transit time in minutes", "example": 0 }, "transitTimeMax": { "type": "integer", "description": "Maximum transit time", "example": 125 } } }, "deliveryDate": { "type": "string", "format": "date-time", "description": "The latest permitted delivery date", "example": "2023-12-14T00:00:00Z" }, "pickupDate": { "type": "string", "format": "date-time", "description": "The date on which the shipment is to be sent.", "example": "2023-12-04T00:00:00Z" }, "packagingTypeId": { "type": "integer", "description": "Package type id\n| ID | Description |\n| ---| --------------------|\n| 1 | Document |\n| 7 | Parcel |\n| 9 | Bulky goods |\n| 10 | Pallet |\n| 11 | Tire |\n| 14 | Suitcase |\n| 15 | Non-stackable pallet|\n", "example": 7, "enum": [ 1, 7, 9, 10, 11, 14, 15 ] }, "pickupDateMode": { "type": "string", "description": "Mode of pickup date. Default is flex. Use exact in combination with a pickupDate to filter only rates that can still be picked up on this day.", "example": "flex", "enum": [ "flex", "exact" ] }, "settings": { "type": "object", "required": [ "mode" ], "properties": { "mode": { "type": "string", "description": "Setting modes for shipment tariff.\nUse 'm' for a regular call to fetch rates. This will return the same results as the shipping cost calculation on the JUMiNGO homepage.\nUse 'a' to get available Same Day rates.\nUse 'single' to fetch data about a single tariff. If used, tariffID needs to be set in the request as well.\n", "example": "m", "enum": [ "m", "a", "single" ] }, "tariffId": { "type": "string", "description": "Tarriff id", "example": "s-4" }, "getExternalTariffs": { "type": "boolean", "description": "allow to get external tariffs", "example": true } } } } }, "ShipmentRateOutput": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ], "description": "identifier of shipment rate", "example": "8a43a995-bade-4222-8dc3-5089774fc069" }, "shipperGroups": { "type": "object", "description": "Carriers with at least one rate, keyed by their position. An entry is the carrier group as the rate service returns it; the keys below are the stable ones.", "additionalProperties": { "type": "object", "additionalProperties": true, "required": [ "id", "name", "logo" ], "properties": { "id": { "type": "integer", "description": "Shipper group id", "example": 2 }, "name": { "type": "string", "description": "Shipper group name", "example": "DHL Express" }, "logo": { "type": "string", "description": "Shipper group logo", "example": "/img/versandrechner/versender/dhlexpress.png" }, "machine_name": { "type": "string", "example": "ups" }, "isShopDeliveryPossible": { "type": "boolean", "example": true }, "urlConverted": { "type": "string", "example": "ups" }, "email": { "type": [ "string", "null" ], "example": null }, "settings": { "type": [ "string", "null" ], "description": "Carrier group settings as a JSON string", "example": "{\"important\": true}" } } } }, "countries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Country id", "example": 54 }, "isocode": { "type": "string", "description": "Country iso code", "example": "DE" }, "post_code_free": { "type": "integer", "description": "Post code", "example": 0 }, "tax_free": { "type": "integer", "description": "tax free", "example": 0 } } } }, "status": { "type": "string", "description": "Status of response", "example": "success" }, "fromCountryCode": { "type": [ "string", "null" ], "description": "From country code", "example": "DE" }, "toCountryCode": { "type": [ "string", "null" ], "description": "To country code", "example": "DE" }, "pickupCountryHolidays": { "description": "Public holidays of the pickup country, keyed by Unix timestamp. An empty list when there are none.", "anyOf": [ { "type": "object", "additionalProperties": { "type": "integer", "example": 1 } }, { "type": "array", "maxItems": 0, "items": true } ] }, "insurance": { "type": [ "object", "null" ], "description": "Insurance conditions of the rate service; null when it returned none.", "required": [ "national", "international", "proformaInvoiceValue", "liabilityValue" ], "properties": { "national": { "$ref": "#/components/schemas/Insurance" }, "international": { "$ref": "#/components/schemas/Insurance" }, "national_premium": { "$ref": "#/components/schemas/Insurance" }, "international_premium": { "$ref": "#/components/schemas/Insurance" }, "insurance_provider": { "type": "string", "example": "Kravag" }, "proformaInvoiceValue": { "type": "number", "format": "float", "example": 1.99 }, "liabilityValue": { "type": "number", "format": "float", "example": 10 } } }, "exportDeclaration": { "type": [ "object", "null" ], "description": "Export declaration prices; null when the rate service returned none.", "properties": { "export_declaration_price": { "type": "number", "format": "float", "example": 1.99 }, "export_declaration_price_old": { "type": "number", "format": "float", "example": 2.99 }, "export_declaration_price_diff": { "type": "number", "format": "float", "example": 1 }, "export_declaration_price_diff_percent": { "type": "number", "format": "float", "example": 17 } } }, "apiTariffMode": { "type": [ "string", "null" ], "description": "The `settings.mode` of the request.", "example": "a" }, "isSearchRequest": { "type": [ "boolean", "null" ], "description": "Is search request" }, "packagingTypeId": { "type": [ "integer", "null" ], "description": "Package type id", "example": 17 }, "details": { "type": [ "object", "null" ], "properties": { "email": { "type": [ "string", "null" ] } } }, "packageTypes": { "type": "array", "items": { "$ref": "#/components/schemas/PackageType" } }, "billing": { "anyOf": [ { "$ref": "#/components/schemas/ShipmentRateAddress" }, { "type": "null" } ] }, "from": { "anyOf": [ { "$ref": "#/components/schemas/ShipmentRateAddress" }, { "type": "null" } ] }, "to": { "anyOf": [ { "$ref": "#/components/schemas/ShipmentRateAddress" }, { "type": "null" } ] }, "packages": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentPackage" } }, "tariffs": { "type": "array", "items": { "$ref": "#/components/schemas/Tariff" } }, "summary": { "$ref": "#/components/schemas/ShipmentRateSummary" }, "quickFilters": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": [ "string", "null" ], "description": "Property of the filterData object the filter sets; null for virtual filters.", "example": "shipperGroups" }, "id": { "type": [ "integer", "string", "boolean" ], "description": "Value the filter sets on that property.", "example": 2 }, "name": { "type": "string", "description": "Name of the quick filter" }, "icon": { "type": [ "string", "null" ], "description": "Icon to show instead of the name when not null." }, "order": { "type": "integer", "description": "Quick filters sort order ASC" }, "permanent": { "type": "boolean", "description": "Is filter permanent or not. Related to mobile view" }, "extended": { "type": "boolean", "description": "Is filter extended or not. Related to extended or short scc view" } } } }, "seoData": { "type": "boolean" }, "serviceOptions": { "type": "array", "items": { "type": "string" } }, "message": { "type": [ "string", "null" ] }, "tariff": { "oneOf": [ { "$ref": "#/components/schemas/Tariff" }, { "type": "null" } ], "description": "The single rate when `settings.mode` is `single`, null otherwise." }, "tariffTypes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 4 }, "name": { "type": "string", "example": "Express" } } } }, "pickupDate": { "type": [ "string", "null" ], "format": "date-time" }, "deliveryDate": { "type": [ "string", "null" ], "format": "date-time" }, "pickupDateMode": { "type": [ "string", "null" ] }, "filterData": { "type": [ "object", "null" ], "description": "The filter that was applied.", "additionalProperties": true }, "packagesInfo": { "type": "array", "items": { "type": "object", "properties": { "weight": { "type": "number", "example": 6 }, "width": { "type": "number", "example": 3 }, "length": { "type": "number", "example": 2 }, "height": { "type": "number", "example": 4 }, "type": { "type": "integer", "example": 1 }, "first_length": { "type": "number", "example": 4 }, "second_length": { "type": "number", "example": 3 }, "shortest_and_longest_side": { "type": "number", "example": 6 }, "girth": { "type": "number", "example": 14 }, "length_sum": { "type": "number", "example": 9 }, "quantity": { "type": "integer", "example": 1 } } } } } }, "ShipmentRateSummary": { "type": "object", "required": [ "taxFree", "tax", "packageAll", "package", "minPrice", "maxPrice", "minPriceNet", "maxPriceNet" ], "properties": { "taxFree": { "type": [ "boolean", "null" ], "description": "Whether the rates are tax free; null when there is no rate.", "example": false }, "tax": { "type": [ "object", "null" ], "description": "The tax of the rates; null when there is no rate.", "properties": { "rate": { "type": [ "number", "null" ], "format": "float", "description": "The tax rate value", "example": 19 }, "name": { "type": "string", "description": "The tax name", "example": "MwSt." } } }, "packageAll": { "type": "boolean", "description": "Always false; `allPackage` is set instead when the request has several packages.", "example": false }, "allPackage": { "type": "boolean", "description": "Present and true when the request has more than one package.", "example": true }, "package": { "type": [ "object", "null" ], "description": "The dimensions of the single package; null when the request has none or several.", "properties": { "weight": { "type": "number", "format": "float", "description": "Weight of the package in kg", "minimum": 0.1, "maximum": 9999999, "example": 0.1 }, "length": { "type": "integer", "format": "int32", "description": "Length of the package in cm", "minimum": 1, "maximum": 99999, "example": 18 }, "width": { "type": "integer", "format": "int32", "description": "Width of the package in cm", "minimum": 1, "maximum": 99999, "example": 19 }, "height": { "type": "integer", "format": "int32", "description": "Height of the package in cm", "minimum": 1, "maximum": 99999, "example": 20 } } }, "minPrice": { "type": [ "number", "null" ], "format": "float", "description": "Lowest gross price of the rates; null when no filter was applied.", "example": 96.37 }, "maxPrice": { "type": [ "number", "null" ], "format": "float", "description": "Highest gross price of the rates; null when no filter was applied.", "example": 621.98 }, "minPriceNet": { "type": [ "number", "null" ], "format": "float", "description": "Lowest net price of the rates; null when no filter was applied.", "example": 96.37 }, "maxPriceNet": { "type": [ "number", "null" ], "format": "float", "description": "Highest net price of the rates; null when no filter was applied.", "example": 621.98 } } }, "ShipmentTracking": { "type": "object", "properties": { "data": { "type": "object", "description": "The tracking data as the carrier service stored it; the keys vary by carrier and tracker version.", "additionalProperties": true, "properties": { "version": { "type": "string" }, "tracking_number": { "type": "string" }, "status_text": { "type": "string" }, "from": { "anyOf": [ { "$ref": "#/components/schemas/TrackingAddress" }, { "type": "null" } ] }, "to": { "anyOf": [ { "$ref": "#/components/schemas/TrackingAddress" }, { "type": "null" } ] }, "carrier": { "type": "object", "additionalProperties": true, "required": [ "code", "name" ], "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "image": { "type": "string" }, "phone": { "type": "string" }, "id": { "type": "integer" } } }, "steps": { "type": "array", "description": "Contains detailed tracking information", "items": { "$ref": "#/components/schemas/TrackingStep" } }, "status": { "type": "string", "description": "Tracking status of the shipment", "enum": [ "new", "notfound", "transit", "expired", "exception", "pickup", "undelivered", "delivered", "parcel_shop" ], "example": "transit" }, "stepDates": { "type": [ "array", "null" ], "items": { "type": "object" } }, "dates": { "description": "An empty list before the first poll.", "anyOf": [ { "$ref": "#/components/schemas/EmptyList" }, { "$ref": "#/components/schemas/TrackingDates" } ] }, "infos": { "type": "array", "items": { "type": "object" } }, "progress": { "description": "The carrier service's own progress record; an empty list when it has none.", "anyOf": [ { "$ref": "#/components/schemas/EmptyList" }, { "type": "object", "additionalProperties": true } ] }, "carrierList": { "type": [ "object", "null" ], "additionalProperties": true } } }, "active": { "type": [ "integer", "null" ], "description": "1 while the tracker is polling the carrier, 0 otherwise; null before the first poll.", "example": 0 }, "status": { "type": [ "string", "null" ], "description": "Whether the tracking data could be fetched; null before the first poll.", "example": "success" }, "progress": { "description": "An empty list before the first poll.", "anyOf": [ { "$ref": "#/components/schemas/EmptyList" }, { "type": "object", "properties": { "class": { "type": "string" }, "points": { "type": "object", "required": [ "completed", "exception", "in_system", "in_transit", "in_delivery", "undelivered" ], "properties": { "completed": { "type": "boolean" }, "exception": { "type": "boolean" }, "in_system": { "type": "boolean" }, "in_transit": { "type": "boolean" }, "in_delivery": { "type": "boolean" }, "undelivered": { "type": "boolean" }, "parcel_shop": { "type": "boolean" } } }, "percent": { "type": "integer" } } } ] }, "carrierTrackingPage": { "type": [ "string", "null" ], "description": "The tracking page of the carrier for this shipment." }, "implementationType": { "type": [ "string", "null" ], "example": "direct_api" } } }, "State": { "type": "string", "description": "Abbreviation of the state; the state is required only for US and Canada.", "example": "NY", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AB", "BC", "MB", "NB", "NL", "NT", "NS", "NU", "ON", "PE", "QC", "SK", "YT" ] }, "StateCode": { "type": "string", "description": "State of the address. US and Canadian states are abbreviated (NY), Vietnamese provinces use the full ISO 3166-2 code (VN-SG). The state is required only for US, Canada and Vietnam.", "example": "NY", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AB", "BC", "MB", "NB", "NL", "NT", "NS", "NU", "ON", "PE", "QC", "SK", "YT", "VN-01", "VN-02", "VN-04", "VN-05", "VN-07", "VN-09", "VN-13", "VN-18", "VN-21", "VN-22", "VN-23", "VN-25", "VN-26", "VN-29", "VN-30", "VN-33", "VN-34", "VN-35", "VN-37", "VN-39", "VN-44", "VN-45", "VN-49", "VN-56", "VN-59", "VN-66", "VN-68", "VN-69", "VN-71", "VN-CT", "VN-DN", "VN-HN", "VN-HP", "VN-SG" ] }, "Tariff": { "type": "object", "description": "One rate as the rate service calculates it. The keys below are the documented ones; the row also carries the rate service's working data, which may change without notice.", "additionalProperties": true, "required": [ "id", "name", "price_netto", "price_brutto", "currency", "shipper_group_id", "tax_free", "dates" ], "properties": { "price_netto": { "type": "number", "format": "float", "example": 28.87 }, "price_brutto": { "type": "number", "format": "float", "example": 28.87 }, "packages": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "packageId": { "type": "integer", "example": 1 }, "volumeWeight": { "type": "number", "format": "float", "example": 0.26 } } } }, "id": { "type": [ "integer", "string" ], "description": "The rate id; special rates such as same-day carry a prefixed string id.", "example": 1 }, "shipper_id": { "type": "integer", "example": 1 }, "tariff_type_id": { "type": "integer", "example": 1 }, "dispatch_id": { "type": "integer", "example": 1 }, "package_type_ids": { "type": "string", "example": "7,9,11,14" }, "country_id": { "type": "integer", "example": 1 }, "transfer": { "type": "string", "example": "export" }, "printer_required": { "type": "integer", "example": 1 }, "from_company_only": { "type": "integer", "example": 1 }, "to_company_only": { "type": "integer", "example": 1 }, "from_private_only": { "type": "integer", "example": 1 }, "to_private_only": { "type": "integer", "example": 1 }, "from_phone_number_required": { "type": "integer", "example": 1 }, "to_phone_number_required": { "type": "integer", "example": 1 }, "hs_tariff_number_required": { "type": "integer", "example": 1 }, "calculate_volume_weight": { "type": "integer", "example": 1 }, "volume_weight_factor": { "type": "integer", "example": 5000 }, "marketing_discount": { "type": [ "number", "null" ], "format": "float", "example": 2 }, "marketing_discount_valid_until": { "type": [ "string", "null" ], "format": "date", "description": "Last date for marketing discount", "example": "2020-02-07" }, "delivery_on_saturday": { "type": "integer", "example": 1 }, "guaranteed_delivery_date": { "type": "integer", "example": 1 }, "loading_aid": { "type": "integer", "example": 1 }, "best_offer_order": { "type": "integer", "example": 30 }, "environmentally_friendly_order": { "type": "integer", "example": 50 }, "marketing_discount_type": { "type": "string", "example": "normal" }, "marketing_discount_countdown_time_from": { "type": [ "string", "null" ], "description": "Start marketing discount time", "example": "07:00:00" }, "marketing_discount_countdown_time_until": { "type": [ "string", "null" ], "description": "Latest marketing discount time", "example": "15:00:00" }, "daily_auto_scheduled_pickup_required": { "type": "integer", "example": 1 }, "is_plus_product": { "type": "boolean", "example": false }, "is_trackable_product": { "type": "boolean", "example": false }, "is_insurable_product": { "type": "boolean", "example": false }, "seller_customerNumber": { "type": [ "string", "null" ] }, "surcharge_per_kg": { "type": "integer", "example": 1 }, "surcharge_per_kg_min": { "type": "integer", "example": 1 }, "shipper_tariff_id": { "type": "integer", "example": 2 }, "name": { "type": "string", "example": "UPS EXPRESS SAVER ®" }, "shipper_tariff_zone_id": { "type": "integer", "example": 13 }, "transit_time_min": { "type": "integer", "example": 2 }, "transit_time_max": { "type": "integer", "example": 3 }, "delivery_time_until": { "type": "string", "description": "Latest delivery time", "example": "18:00:00" }, "store_delivery": { "type": "integer", "example": 1 }, "pickup_surcharge": { "type": "integer", "example": 0 }, "shipper_tariff_zone_country_id": { "type": "integer", "example": 222 }, "shippingType": { "type": "integer", "example": 1 }, "currency": { "$ref": "#/components/schemas/CurrencyCode" }, "individual_customer_tariff": { "type": "boolean", "example": false }, "external_tariff": { "type": "boolean", "example": false }, "total_weight": { "type": "number", "format": "float", "example": 5 }, "shipper_group_id": { "type": "integer", "example": 1 }, "shipper": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "example": "UPS Express" }, "tracking_link": { "type": "string", "example": "http://wwwapps.ups.com/WebTracking/processInputRequest?sort_by=status&tracknums_displayed=1&TypeOfInquiryNumber=T&loc=de_DE&InquiryNumber=" }, "agb_link": { "type": "string", "example": "https://www.ups.com/media/de/terms_carriage_ger.pdf" }, "transit_time_link": { "type": [ "string", "null" ], "example": "https://wwwapps.ups.com/ctc/request?loc=de_DE" }, "limits": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "operant": { "type": "string", "example": "girth" }, "operator": { "type": "string", "example": "<=" }, "value": { "type": "number", "example": 419 } } } }, "ShipperGroupName": { "type": "string", "example": "UPS" } } }, "image": { "type": "string", "example": "/img/versandrechner/tarife/upsneu.png" }, "shopName": { "type": "string", "example": "UPS Access Point" }, "shopsName": { "type": "string", "example": "PaketShops" }, "hasShopFinder": { "type": "boolean", "example": true }, "dates": { "type": "object", "additionalProperties": true, "properties": { "pickup": { "type": "object", "additionalProperties": true, "properties": { "pickupTimeMinPeriodMinutes": { "type": "integer", "example": 120 }, "date": { "type": "string", "format": "date", "example": "2020-06-05" }, "dateFormat": { "type": "string", "example": "05.06.2020" }, "day": { "type": "integer", "example": 5 }, "dayFormat": { "type": "string", "example": "Freitag" }, "dayFormatShort": { "type": "string", "example": "Fr." }, "month": { "type": "string", "example": "Jun" }, "monthFormat": { "type": "string", "example": "Juni" }, "dateFormatShort": { "type": "string", "example": "Di., 2. Jun." }, "timeFrom": { "type": "string", "example": "03:00" }, "timeFromMinutes": { "type": "integer", "example": 180 }, "timeFromFormat": { "type": "string", "example": "13:45 Uhr" }, "timeUntil": { "type": "string", "example": "01:00" }, "timeUntilMinutes": { "type": "integer", "example": 60 }, "timeUntilFormat": { "type": "string", "example": "15:45 Uhr" }, "min_pickup_date": { "type": "string", "format": "date", "example": "2020-06-02" } } }, "transit_time_min": { "type": "object", "additionalProperties": true, "properties": { "date": { "type": "string", "format": "date", "example": "2020-06-05" }, "dateFormat": { "type": "string", "example": "05.06.2020" }, "day": { "type": "integer", "example": 5 }, "dayFormat": { "type": "string", "example": "Freitag" }, "dayFormatShort": { "type": "string", "example": "Fr." }, "month": { "type": "string", "example": "Jun" } } }, "transit_time_max": { "type": "object", "additionalProperties": true, "properties": { "date": { "type": "string", "format": "date", "example": "2020-06-05" }, "dateFormat": { "type": "string", "example": "05.06.2020" }, "day": { "type": "integer", "example": 5 }, "dayFormat": { "type": "string", "example": "Freitag" }, "dayFormatShort": { "type": "string", "example": "Fr." }, "month": { "type": "string", "example": "Jun" }, "monthFormat": { "type": "string", "example": "Juni" } } }, "delivery": { "type": "object", "additionalProperties": true, "properties": { "timeUntilFormat": { "type": "string", "example": "16 Uhr" }, "day": { "type": [ "string", "integer" ], "example": "4 - 5" }, "dayFormat": { "type": "string", "example": "Do. / Fr." }, "monthFormat": { "type": "string", "example": "Juni" }, "dateFormatShort": { "type": "string", "example": "Do., 4. Jun. - Fr., 5. Jun." } } }, "transit_time_range": { "type": "object", "additionalProperties": true, "properties": { "days": { "type": [ "string", "integer" ], "description": "Days range for delivery, or the hours as an integer", "example": "2-3" }, "daysString": { "type": "string", "description": "A full description of days units with translation", "example": "working days" }, "daysStringShort": { "type": "string", "description": "A short description of days units with translation", "example": "d" } } } } }, "pickupTimeMinPeriodMinutes": { "type": "integer", "example": 120 }, "pickupSliderUsed": { "type": "boolean", "example": false }, "pickupSliderUsedMessageShown": { "type": "boolean", "example": false }, "sliderDraggableRange": { "type": "boolean", "example": false }, "sliderDraggableRangeInt": { "type": "integer", "example": 1 }, "same_day_pickup": { "type": "boolean", "example": true }, "has_pickup_surcharge": { "type": "boolean", "example": false }, "deliveryMaxDaysFromNowOrder": { "type": "number", "format": "float", "example": 2.01 }, "deliveryTimeUntilInMinutes": { "type": "integer", "example": 840 }, "printerIsRequired": { "type": "integer", "example": 1 }, "tax_free": { "type": "boolean", "example": false }, "tax_free_reason": { "type": [ "string", "null" ], "example": "third_country_transfer" }, "tax_rate": { "type": [ "number", "null" ], "format": "float", "example": 19 }, "tax_name": { "type": "string", "example": "MwSt." }, "tax_countryCode": { "anyOf": [ { "$ref": "#/components/schemas/CountryCode" }, { "type": "null" } ] }, "hasAreaSurcharge": { "type": "boolean", "example": false }, "extra_export_license_price_brutto": { "type": "number", "format": "float", "example": 59.49 }, "extra_insurance_value": { "type": "integer", "example": 1000 }, "extra_insurance_price_netto": { "type": "number", "format": "float", "example": 20 }, "extra_insurance_price_brutto": { "type": "number", "format": "float", "example": 20 }, "insurance_value": { "type": "integer", "example": 510 }, "price_netto_uvp": { "type": "number", "format": "float", "example": 8.87 }, "price_brutto_uvp": { "type": "number", "format": "float", "example": 28.87 }, "marketing_discount_title": { "type": [ "string", "null" ], "example": "title" }, "marketing_discount_description": { "type": [ "string", "null" ], "example": "description" }, "uvp_discount_value": { "type": "integer", "example": 0 }, "uvp_discount_percent": { "type": "integer", "example": 0 }, "uvp_discount_type": { "type": "string", "example": "customer" }, "requestType": { "type": "string", "example": "m" }, "best_offer_best_price_order": { "type": "integer", "example": 3 }, "pickupTimeFromMinutesSelected": { "type": "integer", "example": 705 }, "pickupTimeUntilMinutesSelected": { "type": "integer", "example": 825 } } }, "TrackingAddress": { "type": "object", "description": "A tracking address as the carrier reported it; which keys are present depends on the carrier.", "additionalProperties": true, "properties": { "city": { "type": "string", "example": "Berlin" }, "street": { "type": "string", "example": "Riemeisterstraße 132A" }, "postalCode": { "type": "string", "example": "14169" }, "countryCode": { "type": "string", "description": "ISO 3166-1 alpha-2 country code", "example": "DE" }, "countryName": { "type": "string", "description": "The country name in the language of the account", "example": "Deutschland" }, "country": { "$ref": "#/components/schemas/Country" } } }, "TrackingDates": { "type": "object", "description": "Which keys are present depends on the tracker version.", "additionalProperties": true, "properties": { "created": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "When the tracker was created, as `YYYY-MM-DD hh:mm:ss`.", "example": "2024-02-01 17:05:06" }, "modified": { "type": [ "string", "null" ], "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "When the tracker was last modified, as `YYYY-MM-DD hh:mm:ss`.", "example": "2024-02-01 17:05:06" }, "last_updated": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "When the tracking information was last fetched from the carrier, as `YYYY-MM-DD hh:mm:ss`.", "example": "2024-02-01 17:05:06" }, "status_changed": { "type": [ "string", "null" ], "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "When the tracking status last changed, as `YYYY-MM-DD hh:mm:ss`.", "example": "2024-02-01 17:05:06" } } }, "TrackingStep": { "type": "object", "properties": { "date": { "type": "string", "description": "Date of tracking information", "example": "2017-12-16" }, "time": { "type": "string", "description": "Time of tracking information", "example": "13:56" }, "type": { "type": "string", "description": "The type of tracking information. The text comes directly from the respective carrier. This is usually a free text, which is very different depending on the carrier. As a rule, one cannot rely on the expressiveness of the texts; in addition, the texts could be changed by the carrier at any time. Please always read the actual tracking status from the ShipmentTracking's status field.", "example": "The shipment has been dropped off and is now at a ups access point." }, "location": { "type": "string", "description": "The location of the scan. The text comes directly from the respective carrier. The format and information density varies considerably depending on the carrier and region. Mostly the country code is included, sometimes also the city.", "example": "STANFORD LE HOPE, GB" } } }, "UpdateShipment": { "type": "object", "required": [ "details", "packages", "from_address", "to_address" ], "properties": { "from_address": { "$ref": "#/components/schemas/CreateShipmentAddress" }, "to_address": { "$ref": "#/components/schemas/CreateShipmentAddress" }, "billing_address": { "$ref": "#/components/schemas/ShipmentAddress" }, "details": { "$ref": "#/components/schemas/CreateShipmentDetails" }, "packages": { "type": "array", "description": "Packages of the shipment", "items": { "$ref": "#/components/schemas/CreateShipmentPackage" } }, "customs_invoice": { "$ref": "#/components/schemas/CustomsInvoiceInput" }, "connection": { "$ref": "#/components/schemas/CreateShipmentConnection" }, "rate": { "$ref": "#/components/schemas/CreateShipmentRate" }, "label_format": { "type": "string", "description": "Label format", "enum": [ "A4", "A6" ] } }, "description": "The full shipment to store; omitted optional sections are cleared." }, "ValidationProblem": { "type": "object", "description": "The body of a 400 response caused by invalid input: a Problem plus one entry per violated field.", "required": [ "title", "detail", "status", "type", "violations" ], "properties": { "title": { "type": "string", "example": "An error occurred" }, "detail": { "type": "string", "description": "All violations, one per line, as `field: message`.", "example": "shipmentId: This value should not be blank." }, "status": { "type": "integer", "example": 400 }, "type": { "type": "string", "example": "/validation_errors/0=c1051bb4-d103-4f74-8988-acbcafc7fdc3" }, "violations": { "type": "array", "items": { "type": "object", "required": [ "propertyPath", "message", "code" ], "properties": { "propertyPath": { "type": "string", "description": "The invalid field, as a path into the request body.", "example": "shipmentId" }, "message": { "type": "string", "description": "Validation message in the language of the account.", "example": "This value should not be blank." }, "code": { "type": [ "string", "null" ], "description": "Stable identifier of the violated constraint; null for a violation raised by the application itself.", "example": "c1051bb4-d103-4f74-8988-acbcafc7fdc3" } } } } } } }, "examples": { "shipment-list": { "summary": "One page with one shipment", "value": [ { "id": "s_21b7f7ad8a584fce9f776b9cf6004711", "customer_number": 200002, "customer_personal_name": null, "customer_initials": null, "created": "2026-10-21 10:40:31", "last_modified": "2026-10-21 10:40:39", "internal_status": "open", "status": "delivered", "isCancellationPossible": false, "source": { "type": "Tracking", "id": null, "original_filename": null }, "from_address": { "company": "Jumingo", "name": "John Doe", "country": "DE", "id": 1576, "street": "100 West 33rd Street", "street2": "Apt 123", "zip": "10011", "city": "Berlin", "state": null, "phone": "1234567190", "settings": null }, "to_address": { "company": "Grid Corp.", "name": "John Doe", "country": "US", "id": 1579, "street": "100 West 33rd Street", "street2": "Apt 123", "zip": "10021", "city": "New York", "state": "NY", "phone": "1234557890", "settings": null }, "billing_address": { "company": "Jumingo", "name": "John Doe", "country": "DE", "id": 1577, "street": "100 West 33rd Street", "street2": "Apt 123", "zip": "10011", "city": "Berlin", "state": null, "phone": "1234567190", "settings": null }, "details": { "value_amount": 999, "value_currency": "EUR", "content_description": "PS-5", "reference_number": "my-reference-1", "email": "email@example.org", "email_tracking": "email@example.org", "email_label_copy": "email@example.org", "insurance_amount": 25, "insurance_currency": "EUR", "extra_insurance_price_netto": 0, "extra_insurance_price_brutto": 0, "extra_insurance_value": 0, "extra_insurance_type": null, "extra_insurance_provider": null, "export_license": true, "export_license_price_brutto": 0, "shipment_order_number": "A-2024010311-1", "shipment_order_number_short": "2024010311-1", "packaging_type": "parcel", "hs_tariff_number": "qqqqqqqq", "extra_export_license_number": null, "settings": { "tariff": { "distance": null, "settings": { "is_cin": true, "is_green_tariff": true, "is_tariff_weight_dependent": true }, "loading_aid": 30, "delivery_date": "2026-11-20", "pickup_max_time": "2024-08-06 16:00:00", "pickup_min_time": "2024-08-06 12:45:00", "price_netto_uvp": 47.45, "same_day_pickup": true, "price_brutto_uvp": 47.45, "marketing_discount": 0, "uvp_discount_value": 0, "uvp_discount_percent": 0, "calculate_volume_weight": 1, "individual_customer_tariff": false, "marketing_discount_description": null, "extra_export_license_price_brutto_old": 59.95, "uvp_extra_insurance_price_brutto_preselect": 70.8, "uvp_extra_insurance_premium_price_brutto_preselect": 106.2 }, "offer_valid_until": "2024-08-06 14:34:59", "use_commercial_invoice": false } }, "customs_invoice": { "invoiceNumber": "AAAAAAAAAA", "invoiceDate": "2023-12-12", "currency": "USD", "exportReason": "Gift", "remarks": null, "lineItems": [ { "id": 172, "content": "Qwert", "quantity": 3, "unitOfMeasurement": "L", "netWeight": 89, "value": 999, "hsTariffNumber": null, "manufacturingCountry": null, "merchantProductId": null, "manufacturerProductId": null, "standardizedProductId": null } ], "useJumingoCommercialInvoice": false, "discount": null, "shippingCosts": null, "insuranceCosts": null, "goodsValue": 2997, "effectiveShippingCosts": 59.5, "effectiveInsuranceCosts": 0, "totalInvoiceAmount": 3056.5 }, "packages": [ { "id": 326, "weight": 6, "length": 2, "width": 3, "height": 4, "volume_weight": 0.0048, "girth": 14, "first_length": 4, "second_length": 3, "type": "parcel", "type_id": 7, "name": "2024010311-1", "api_shipment_ids": null, "quantity": 1 } ], "connection": null, "rate": { "carrier": { "shipper_group_id": 2, "shipper_group_name": "DHL Express", "shipper_id": 129, "shipper_tariff_id": 522, "shipper_tariff_full_id": "522", "shipper_tariff_type_id": 5, "shipper_tariff_type_name": "Economy", "shipper_tariff_zone_id": 2845, "limits": [] }, "service": { "name": "DPD CLASSIC NATIONAL", "description": null, "image": "/img/versandrechner/tarife/dhlexpress.svg", "dispatch_id": 1, "agb_link": "https://www.dhl.de/content/dam/images/Express/downloads/geschaeftsbedingungen-und-preise/geschaeftsbedingungen/dhl-express-atb-international-062019.pdf", "is_plus_product": false, "is_trackable_product": true, "is_insurable_product": true, "has_shop_finder": false }, "shipping_type": "pickup", "transit_time_range_days": "2", "max_liability": 25, "max_included_liability_currency": "EUR", "printer_required": true, "parcel_content_required": false, "from_company_only": false, "to_company_only": false, "from_private_only": false, "to_private_only": false, "from_phone_number_required": true, "to_phone_number_required": false, "hs_tariff_number_required": false, "price_net": 47.45, "price_net_currency": "EUR", "price_total": 47.45, "price_total_currency": "EUR", "tax_free": true, "tax_rate": 0, "tax_country": "", "tax_name": "MwSt.", "pickup_date": "2024-08-06", "pickup_min_time": "2024-08-06 14:45:00", "pickup_max_time": "2024-08-06 18:00:00", "pickup_reference_number": "135855S5SSCP", "delivery_date_min": "2024-08-08T02:00:00Z", "delivery_date_max": "2024-08-08T02:00:00Z", "delivery_time_until": "2024-08-08 17:00:00", "distance": 0, "distanceFormatted": null, "durationFormatted": "2 Arbeitstage", "carType": null, "jumingo_express_carrier": null, "is_jumingo_express": false, "jum_disp": false, "marketing_discount": 0, "marketing_discount_description": null, "uvp_discount_value": 0, "uvp_discount_percent": 0, "uvp_extra_insurance_price_brutto_preselect": 70.8, "uvp_extra_insurance_premium_price_brutto_preselect": 106.2, "extra_export_license_price_brutto_old": 59.95, "price_brutto_uvp": 47.45, "price_netto_uvp": 47.45 }, "tracking": { "data": { "version": "1.0", "tracking_number": "3384299634", "status": "new", "status_text": "Daten übermittelt", "from": null, "to": null, "carrier": { "code": "dhl", "name": "DHL", "image": "/cms/Carrier_dhl_express_tracking_1617955411.svg", "phone": "+ 49 (0)180 6 345 300-1", "id": 1 }, "steps": [], "stepDates": [], "dates": { "created": "2024-02-01 17:05:06", "modified": null, "last_updated": "2024-02-01 17:05:06", "status_changed": "2024-01-08 01:00:00" }, "infos": [], "progress": [], "carrierList": null }, "active": 0, "status": "success", "progress": { "percent": 0, "points": { "in_system": false, "in_transit": false, "in_delivery": false, "undelivered": false, "exception": false, "completed": false, "parcel_shop": false }, "class": "" }, "carrierTrackingPage": "http://www.dhl.com/en/express/tracking.html?AWB=TN-12345", "implementationType": "direct_api" }, "tax_free_reason": "third_country_transfer", "tax_id": null, "import_status": "completed", "import_progress_status": "", "import_checkout_id": null, "order": { "number": "2024010311", "unpaid": false, "canceled": false, "created": "2026-10-21 08:40:32" }, "import_messages": { "parcel": { "hs_tariff_number": { "required": { "oldValue": null, "label": "HS-Tarifnummer" } } }, "addresses": { "pickup": [], "delivery": [], "return": [], "billing": [] }, "details": [], "packages": [ [] ], "customsInvoice": { "lineItems": [ { "hs_tariff_number": { "invalid": { "oldValue": null }, "empty_not_allowed": { "oldValue": null } }, "manufacturing_country": { "empty_not_allowed": { "oldValue": null } } } ] } }, "import_messages_text": { "parcel": { "hs_tariff_number": [ "Validierungshinweis: Benötigter Wert fehlt (Pflichtfeld)." ] }, "addresses": { "pickup": [], "delivery": [], "return": [], "billing": [] }, "details": [], "packages": [], "customsInvoice": { "lineItems": [ { "hs_tariff_number": [ "Validierungshinweis: Der Wert ist nicht erlaubt.", "Validierungshinweis: Benötigter Wert fehlt (leerer Wert ist nicht erlaubt)." ], "manufacturing_country": [ "Validierungshinweis: Benötigter Wert fehlt (leerer Wert ist nicht erlaubt)." ] } ] } }, "type": 2, "canceled": false, "dates": { "pickup": { "date": "2024-08-06", "day_format": "Tuesday", "day_format_short": "Tue", "date_format_short": "Tue 6 Aug", "month": "Aug", "month_format": "August", "min_pickup_date": "2026-10-26", "pickup_min_time": "14:45", "pickup_max_time": "18:00", "pickup_min_time_minutes": 885, "pickup_max_time_minutes": 1080 }, "transit_date_min": { "date": "2024-08-08", "day_format": "Thursday", "day_format_short": "Thu", "month": "Aug", "month_format": "August" }, "transit_date_max": { "date": "2024-08-08", "day_format": "Thursday", "day_format_short": "Thu", "month": "Aug", "month_format": "August" }, "delivery": { "time_until_format": "5:00 PM", "time_until_minutes": 1020, "day": "08", "day_format": "Thu", "month_format": "Aug", "min_delivery_date": "2024-08-08 00:00:00", "max_delivery_date": "2024-08-08 00:00:00", "date_format_short": "Thu., 8. Aug." }, "transit_time_range": { "days": "2", "days_string": "Arbeitstage", "days_string_short": "Tage" } }, "label_sent_on": null, "has_label": false, "label_generation_status": "waiting", "has_proforma": false, "has_export_cert_vat": false, "has_commercial_invoice": false, "has_export_declaration": false, "has_proof_of_export": false, "dates_aggregation": { "created": { "date": "2026-10-21", "time": "10:40:31", "minutes": 641 }, "last_modified": { "date": "2026-10-21", "time": "10:40:39", "minutes": 641 } }, "dates_in_the_past": true, "delayed": true, "settings": { "tariff": { "distance": null, "settings": { "is_cin": true, "is_green_tariff": true, "is_tariff_weight_dependent": true }, "loading_aid": 30, "delivery_date": "2026-11-20", "pickup_max_time": "2024-08-06 16:00:00", "pickup_min_time": "2024-08-06 12:45:00", "price_netto_uvp": 47.45, "same_day_pickup": true, "price_brutto_uvp": 47.45, "marketing_discount": 0, "uvp_discount_value": 0, "uvp_discount_percent": 0, "calculate_volume_weight": 1, "individual_customer_tariff": false, "marketing_discount_description": null, "extra_export_license_price_brutto_old": 59.95, "uvp_extra_insurance_price_brutto_preselect": 70.8, "uvp_extra_insurance_premium_price_brutto_preselect": 106.2 }, "offer_valid_until": "2024-08-06 14:34:59", "use_commercial_invoice": false }, "post_order_update_allowed": true, "export_cert_vat_possible": true, "picked_up": false, "update_ordered_delivery_address_allowed": false, "product_identifiers_required": false, "pickup_status": 0, "shipment_issues": [ { "issue_type": "todo", "reason": "cin_incomplete" } ], "export_declaration": null, "is_return_possible": true, "documents": { "proforma": null, "commercial_invoice": null, "export_declaration": null, "proof_of_export": null, "export_cert_vat": null } } ] }, "problem-bad-request": { "summary": "The request cannot be fulfilled", "value": { "title": "An error occurred", "detail": "Cannot change the shipment because it has already been ordered", "status": 400, "type": "/errors/400" } }, "authentication-error": { "summary": "No or invalid X-AUTH-TOKEN header", "value": { "message": "No API token provided" } }, "problem-forbidden": { "summary": "The action is not allowed for this API key", "value": { "title": "An error occurred", "detail": "This integration token is read-only.", "status": 403, "type": "/errors/403" } }, "customer-verification-failed": { "summary": "The integration token's customer headers do not verify", "value": { "message": "Customer verification failed" } }, "request-create-shipment": { "summary": "A national parcel without a rate", "value": { "from_address": { "company": "Test Corp.", "name": "John Doe", "street": "100 West 33rd Street", "street2": "Apt 123", "zip": "10001", "city": "New York", "state": "NY", "country": "US", "phone": "1234567890" }, "to_address": { "company": "Test Corp.", "name": "Jane Doe", "street": "100 West 33rd Street", "street2": "Apt 123", "zip": "10021", "city": "New York", "state": "NY", "country": "US", "phone": "1234567890" }, "details": { "value_amount": 200, "value_currency": "EUR", "content_description": "sample", "reference_number": "my-reference", "email_tracking": "email@example.org", "email_label_copy": "email@example.org", "insurance_amount": 200, "insurance_currency": "EUR", "export_license": true, "packaging_type": "parcel" }, "packages": [ { "weight": 0.1, "length": 18, "width": 19, "height": 20 } ] } }, "shipment-created": { "summary": "The id of the new shipment", "value": { "shipment_id": "s_044101f094984f3787c8f8e05732b3c5", "warnings": { "messages": [], "count": 0 } } }, "validation-problem": { "summary": "Two required fields are missing", "value": { "title": "An error occurred", "detail": "shipmentId: This value should not be blank.\nsettings: This value should not be blank.", "status": 400, "type": "/validation_errors/0=c1051bb4-d103-4f74-8988-acbcafc7fdc3;1=c1051bb4-d103-4f74-8988-acbcafc7fdc3", "violations": [ { "propertyPath": "shipmentId", "message": "This value should not be blank.", "code": "c1051bb4-d103-4f74-8988-acbcafc7fdc3" }, { "propertyPath": "settings", "message": "This value should not be blank.", "code": "c1051bb4-d103-4f74-8988-acbcafc7fdc3" } ] } }, "shipment": { "summary": "A paid shipment with a selected rate", "value": { "id": "s_21b7f7ad8a584fce9f776b9cf6004711", "customer_number": 200002, "customer_personal_name": null, "customer_initials": null, "created": "2026-10-21 10:40:31", "last_modified": "2026-10-21 10:40:39", "internal_status": "open", "status": "delivered", "isCancellationPossible": false, "source": { "type": "Tracking", "id": null, "original_filename": null }, "from_address": { "company": "Jumingo", "name": "John Doe", "country": "DE", "id": 1576, "street": "100 West 33rd Street", "street2": "Apt 123", "zip": "10011", "city": "Berlin", "state": null, "phone": "1234567190", "settings": null }, "to_address": { "company": "Grid Corp.", "name": "John Doe", "country": "US", "id": 1579, "street": "100 West 33rd Street", "street2": "Apt 123", "zip": "10021", "city": "New York", "state": "NY", "phone": "1234557890", "settings": null }, "billing_address": { "company": "Jumingo", "name": "John Doe", "country": "DE", "id": 1577, "street": "100 West 33rd Street", "street2": "Apt 123", "zip": "10011", "city": "Berlin", "state": null, "phone": "1234567190", "settings": null }, "details": { "value_amount": 999, "value_currency": "EUR", "content_description": "PS-5", "reference_number": "my-reference-1", "email": "email@example.org", "email_tracking": "email@example.org", "email_label_copy": "email@example.org", "insurance_amount": 25, "insurance_currency": "EUR", "extra_insurance_price_netto": 0, "extra_insurance_price_brutto": 0, "extra_insurance_value": 0, "extra_insurance_type": null, "extra_insurance_provider": null, "export_license": true, "export_license_price_brutto": 0, "shipment_order_number": "A-2024010311-1", "shipment_order_number_short": "2024010311-1", "packaging_type": "parcel", "hs_tariff_number": "qqqqqqqq", "extra_export_license_number": null, "settings": { "tariff": { "distance": null, "settings": { "is_cin": true, "is_green_tariff": true, "is_tariff_weight_dependent": true }, "loading_aid": 30, "delivery_date": "2026-11-20", "pickup_max_time": "2024-08-06 16:00:00", "pickup_min_time": "2024-08-06 12:45:00", "price_netto_uvp": 47.45, "same_day_pickup": true, "price_brutto_uvp": 47.45, "marketing_discount": 0, "uvp_discount_value": 0, "uvp_discount_percent": 0, "calculate_volume_weight": 1, "individual_customer_tariff": false, "marketing_discount_description": null, "extra_export_license_price_brutto_old": 59.95, "uvp_extra_insurance_price_brutto_preselect": 70.8, "uvp_extra_insurance_premium_price_brutto_preselect": 106.2 }, "offer_valid_until": "2024-08-06 14:34:59", "use_commercial_invoice": false } }, "customs_invoice": { "invoiceNumber": "AAAAAAAAAA", "invoiceDate": "2023-12-12", "currency": "USD", "exportReason": "Gift", "remarks": null, "lineItems": [ { "id": 172, "content": "Qwert", "quantity": 3, "unitOfMeasurement": "L", "netWeight": 89, "value": 999, "hsTariffNumber": null, "manufacturingCountry": null, "merchantProductId": null, "manufacturerProductId": null, "standardizedProductId": null } ], "useJumingoCommercialInvoice": false, "discount": null, "shippingCosts": null, "insuranceCosts": null, "goodsValue": 2997, "effectiveShippingCosts": 59.5, "effectiveInsuranceCosts": 0, "totalInvoiceAmount": 3056.5 }, "packages": [ { "id": 326, "weight": 6, "length": 2, "width": 3, "height": 4, "volume_weight": 0.0048, "girth": 14, "first_length": 4, "second_length": 3, "type": "parcel", "type_id": 7, "name": "2024010311-1", "api_shipment_ids": null, "quantity": 1 } ], "connection": null, "rate": { "carrier": { "shipper_group_id": 2, "shipper_group_name": "DHL Express", "shipper_id": 129, "shipper_tariff_id": 522, "shipper_tariff_full_id": "522", "shipper_tariff_type_id": 5, "shipper_tariff_type_name": "Economy", "shipper_tariff_zone_id": 2845, "limits": [] }, "service": { "name": "DPD CLASSIC NATIONAL", "description": null, "image": "/img/versandrechner/tarife/dhlexpress.svg", "dispatch_id": 1, "agb_link": "https://www.dhl.de/content/dam/images/Express/downloads/geschaeftsbedingungen-und-preise/geschaeftsbedingungen/dhl-express-atb-international-062019.pdf", "is_plus_product": false, "is_trackable_product": true, "is_insurable_product": true, "has_shop_finder": false }, "shipping_type": "pickup", "transit_time_range_days": "2", "max_liability": 25, "max_included_liability_currency": "EUR", "printer_required": true, "parcel_content_required": false, "from_company_only": false, "to_company_only": false, "from_private_only": false, "to_private_only": false, "from_phone_number_required": true, "to_phone_number_required": false, "hs_tariff_number_required": false, "price_net": 47.45, "price_net_currency": "EUR", "price_total": 47.45, "price_total_currency": "EUR", "tax_free": true, "tax_rate": 0, "tax_country": "", "tax_name": "MwSt.", "pickup_date": "2024-08-06", "pickup_min_time": "2024-08-06 14:45:00", "pickup_max_time": "2024-08-06 18:00:00", "pickup_reference_number": "135855S5SSCP", "delivery_date_min": "2024-08-08T02:00:00Z", "delivery_date_max": "2024-08-08T02:00:00Z", "delivery_time_until": "2024-08-08 17:00:00", "distance": 0, "distanceFormatted": null, "durationFormatted": "2 Arbeitstage", "carType": null, "jumingo_express_carrier": null, "is_jumingo_express": false, "jum_disp": false, "marketing_discount": 0, "marketing_discount_description": null, "uvp_discount_value": 0, "uvp_discount_percent": 0, "uvp_extra_insurance_price_brutto_preselect": 70.8, "uvp_extra_insurance_premium_price_brutto_preselect": 106.2, "extra_export_license_price_brutto_old": 59.95, "price_brutto_uvp": 47.45, "price_netto_uvp": 47.45 }, "tracking": { "data": { "version": "1.0", "tracking_number": "3384299634", "status": "new", "status_text": "Daten übermittelt", "from": null, "to": null, "carrier": { "code": "dhl", "name": "DHL", "image": "/cms/Carrier_dhl_express_tracking_1617955411.svg", "phone": "+ 49 (0)180 6 345 300-1", "id": 1 }, "steps": [], "stepDates": [], "dates": { "created": "2024-02-01 17:05:06", "modified": null, "last_updated": "2024-02-01 17:05:06", "status_changed": "2024-01-08 01:00:00" }, "infos": [], "progress": [], "carrierList": null }, "active": 0, "status": "success", "progress": { "percent": 0, "points": { "in_system": false, "in_transit": false, "in_delivery": false, "undelivered": false, "exception": false, "completed": false, "parcel_shop": false }, "class": "" }, "carrierTrackingPage": "http://www.dhl.com/en/express/tracking.html?AWB=TN-12345", "implementationType": "direct_api" }, "tax_free_reason": "third_country_transfer", "tax_id": null, "import_status": "completed", "import_progress_status": "", "import_checkout_id": null, "order": { "number": "2024010311", "unpaid": false, "canceled": false, "created": "2026-10-21 08:40:32" }, "import_messages": { "parcel": { "hs_tariff_number": { "required": { "oldValue": null, "label": "HS-Tarifnummer" } } }, "addresses": { "pickup": [], "delivery": [], "return": [], "billing": [] }, "details": [], "packages": [ [] ], "customsInvoice": { "lineItems": [ { "hs_tariff_number": { "invalid": { "oldValue": null }, "empty_not_allowed": { "oldValue": null } }, "manufacturing_country": { "empty_not_allowed": { "oldValue": null } } } ] } }, "import_messages_text": { "parcel": { "hs_tariff_number": [ "Validierungshinweis: Benötigter Wert fehlt (Pflichtfeld)." ] }, "addresses": { "pickup": [], "delivery": [], "return": [], "billing": [] }, "details": [], "packages": [], "customsInvoice": { "lineItems": [ { "hs_tariff_number": [ "Validierungshinweis: Der Wert ist nicht erlaubt.", "Validierungshinweis: Benötigter Wert fehlt (leerer Wert ist nicht erlaubt)." ], "manufacturing_country": [ "Validierungshinweis: Benötigter Wert fehlt (leerer Wert ist nicht erlaubt)." ] } ] } }, "type": 2, "canceled": false, "dates": { "pickup": { "date": "2024-08-06", "day_format": "Tuesday", "day_format_short": "Tue", "date_format_short": "Tue 6 Aug", "month": "Aug", "month_format": "August", "min_pickup_date": "2026-10-26", "pickup_min_time": "14:45", "pickup_max_time": "18:00", "pickup_min_time_minutes": 885, "pickup_max_time_minutes": 1080 }, "transit_date_min": { "date": "2024-08-08", "day_format": "Thursday", "day_format_short": "Thu", "month": "Aug", "month_format": "August" }, "transit_date_max": { "date": "2024-08-08", "day_format": "Thursday", "day_format_short": "Thu", "month": "Aug", "month_format": "August" }, "delivery": { "time_until_format": "5:00 PM", "time_until_minutes": 1020, "day": "08", "day_format": "Thu", "month_format": "Aug", "min_delivery_date": "2024-08-08 00:00:00", "max_delivery_date": "2024-08-08 00:00:00", "date_format_short": "Thu., 8. Aug." }, "transit_time_range": { "days": "2", "days_string": "Arbeitstage", "days_string_short": "Tage" } }, "label_sent_on": null, "has_label": false, "label_generation_status": "waiting", "has_proforma": false, "has_export_cert_vat": false, "has_commercial_invoice": false, "has_export_declaration": false, "has_proof_of_export": false, "dates_aggregation": { "created": { "date": "2026-10-21", "time": "10:40:31", "minutes": 641 }, "last_modified": { "date": "2026-10-21", "time": "10:40:39", "minutes": 641 } }, "dates_in_the_past": true, "delayed": true, "settings": { "tariff": { "distance": null, "settings": { "is_cin": true, "is_green_tariff": true, "is_tariff_weight_dependent": true }, "loading_aid": 30, "delivery_date": "2026-11-20", "pickup_max_time": "2024-08-06 16:00:00", "pickup_min_time": "2024-08-06 12:45:00", "price_netto_uvp": 47.45, "same_day_pickup": true, "price_brutto_uvp": 47.45, "marketing_discount": 0, "uvp_discount_value": 0, "uvp_discount_percent": 0, "calculate_volume_weight": 1, "individual_customer_tariff": false, "marketing_discount_description": null, "extra_export_license_price_brutto_old": 59.95, "uvp_extra_insurance_price_brutto_preselect": 70.8, "uvp_extra_insurance_premium_price_brutto_preselect": 106.2 }, "offer_valid_until": "2024-08-06 14:34:59", "use_commercial_invoice": false }, "post_order_update_allowed": true, "export_cert_vat_possible": true, "picked_up": false, "update_ordered_delivery_address_allowed": false, "product_identifiers_required": false, "pickup_status": 0, "shipment_issues": [ { "issue_type": "todo", "reason": "cin_incomplete" } ], "export_declaration": null, "is_return_possible": true, "documents": { "proforma": null, "commercial_invoice": null, "export_declaration": null, "proof_of_export": null, "export_cert_vat": null } } }, "problem-not-found": { "summary": "The resource does not exist or belongs to another account", "value": { "title": "An error occurred", "detail": "Shipment not found", "status": 404, "type": "/errors/404" } }, "request-update-shipment": { "summary": "The same shipment with a new recipient", "value": { "from_address": { "company": "Test Corp.", "name": "John Doe", "street": "100 West 33rd Street", "street2": "Apt 123", "zip": "10001", "city": "New York", "state": "NY", "country": "US", "phone": "1234567890" }, "to_address": { "company": "Test Corp.", "name": "Max Mustermann", "street": "100 West 33rd Street", "street2": "Apt 123", "zip": "10021", "city": "New York", "state": "NY", "country": "US", "phone": "1234567890" }, "details": { "value_amount": 200, "value_currency": "EUR", "content_description": "sample", "reference_number": "my-reference", "email_tracking": "email@example.org", "email_label_copy": "email@example.org", "insurance_amount": 200, "insurance_currency": "EUR", "export_license": true, "packaging_type": "parcel" }, "packages": [ { "weight": 0.1, "length": 18, "width": 19, "height": 20 } ] } }, "request-patch-shipment": { "summary": "Change only the recipient", "value": { "to_address": { "company": "Test Corp.", "name": "Max Mustermann", "street": "100 West 33rd Street", "street2": "Apt 123", "zip": "10021", "city": "New York", "state": "NY", "country": "US", "phone": "1234567890" } } }, "request-cheapest-rates": { "summary": "Select the cheapest rate for two shipments", "value": { "shipmentIds": [ "s_2b28a63d65684f0aa4bcca24dafdc9df", "s_ca213cb9368c412291b8441c90c95592" ], "rateInput": { "pickupDate": "2026-11-11T08:00:00Z", "deliveryDate": "2026-11-14T17:00:00Z", "packagingTypeId": 7, "settings": { "mode": "a" } } } }, "request-shipment-rates": { "summary": "All rates for a shipment", "value": { "shipmentId": "s_2b28a63d65684f0aa4bcca24dafdc9df", "filterData": { "timeMax": 1440, "timeMin": 0 }, "settings": { "mode": "m" } } }, "shipment-rates": { "summary": "Rates for a national parcel", "value": { "uuid": "3654ecb1-57ce-4937-90c5-99390cf68205", "shipperGroups": { "0": { "id": 1, "name": "UPS", "logo": "/img/versandrechner/versender/upsneu.png", "email": null, "settings": "{\"important\": true, \"allowedForBulkRateSelection\": true}", "machine_name": "ups", "isShopDeliveryPossible": true, "urlConverted": "ups" }, "1": { "id": 2, "name": "DHL Express", "logo": "/img/versandrechner/versender/dhlexpress.png", "email": null, "settings": "{\"important\": true, \"allowedForBulkRateSelection\": true}", "machine_name": "dhl express", "isShopDeliveryPossible": false, "urlConverted": "dhl-express" }, "4": { "id": 5, "name": "TNT", "logo": "/img/versandrechner/versender/tnt.png", "email": "germany@fedex.com", "settings": "{\"important\": true, \"allowedForBulkRateSelection\": true}", "machine_name": "tnt", "isShopDeliveryPossible": false, "urlConverted": "tnt" }, "19": { "id": 29, "name": "FedEx", "logo": "/img/versandrechner/versender/fedex.png", "email": "germany@fedex.com", "settings": "{\"important\": true, \"allowedForBulkRateSelection\": true}", "machine_name": "fedex", "isShopDeliveryPossible": false, "urlConverted": "fedex" }, "20": { "id": 30, "name": "SkyNet", "logo": "/img/versandrechner/versender/sky.png", "email": null, "settings": null, "machine_name": "skynet", "isShopDeliveryPossible": false, "urlConverted": "sky" }, "26": { "id": 15, "name": "jumingo", "logo": "/img/versandrechner/versender/jumingo.png", "email": null, "settings": null, "machine_name": "jumingo", "isShopDeliveryPossible": false, "urlConverted": "jumingo" } }, "countries": [ { "id": 54, "isocode": "DE", "post_code_free": 0, "tax_free": 0 }, { "id": 2, "isocode": "AE", "post_code_free": 1, "tax_free": 1 } ], "status": "success", "message": null, "tariffs": [ { "price_netto": 96.37, "price_brutto": 96.37, "packages": [ { "packageId": 0, "volumeWeight": 0.0048 } ], "id": 15, "shipper_id": 2, "tariff_type_id": 2, "dispatch_id": 1, "package_type_ids": "7,9,11,14", "country_id": 54, "transfer": "export", "printer_required": 1, "from_company_only": 0, "to_company_only": 0, "from_private_only": 0, "to_private_only": 0, "from_phone_number_required": 0, "to_phone_number_required": 0, "hs_tariff_number_required": 0, "api_type": "dhl-express_new", "calculate_volume_weight": 1, "volume_weight_factor": 5000, "marketing_discount": null, "marketing_discount_valid_until": null, "delivery_on_saturday": 0, "guaranteed_delivery_date": 1, "loading_aid": 0, "best_offer_order": 30, "environmentally_friendly_order": 50, "marketing_discount_type": "normal", "marketing_discount_countdown_time_from": "07:00:00", "marketing_discount_countdown_time_until": "15:00:00", "insurance_included_max_value_api": 0, "delivery_time_until_api": "16:00:00", "pickup_time_from_api": "09:00:00", "pickup_time_until_api": "17:00:00", "daily_auto_scheduled_pickup_required": 0, "is_plus_product": false, "is_trackable_product": true, "is_insurable_product": true, "parcel_content_required": 0, "settings": [], "shipper_tariff_id": 15, "name": "DHL EXPRESS WORLDWIDE", "shipper_tariff_zone_id": 114, "transit_time_min": 2, "transit_time_max": 2, "delivery_time_until": "15:00:00", "store_delivery": 0, "pickup_surcharge": 0, "shipper_tariff_zone_country_id": 1161, "shippingType": 1, "currency": "EUR", "individual_customer_tariff": false, "external_tariff": false, "total_weight": 6, "shipper_group_id": 2, "shipper": { "name": "DHL EXPRESS INTERNATIONAL", "tracking_link": "http://www.dhl.com/en/express/tracking.html?AWB=", "agb_link": "https://www.dhl.de/content/dam/images/Express/downloads/geschaeftsbedingungen-und-preise/geschaeftsbedingungen/dhl-express-atb-international-201702.pdf", "transit_time_link": "http://dct.dhl.com/input.jsp?langId=de", "limits": [ { "operant": "weight", "operator": "<=", "value": 70 }, { "operant": "first_length", "operator": "<=", "value": 175 } ], "ShipperGroupName": "DHL Express" }, "image": "/img/versandrechner/tarife/dhlexpress.png", "dates": { "pickup": { "date": "2026-10-26", "dateFormat": "26.10.2026", "day": 26, "dayFormat": "Montag", "dayFormatShort": "Mo", "month": "Okt", "monthFormat": "Oktober", "dateFormatShort": "Mo., 26 Okt.", "timeFrom": "09:30", "timeFromFormat": "09:30", "timeUntil": "16:00", "timeUntilFormat": "16:00", "min_pickup_date": "2026-10-26", "pickupTimeMinPeriodMinutes": 120, "timeFromMinutes": 570, "timeUntilMinutes": 960 }, "transit_time_min": { "date": "2026-10-28", "dateFormat": "28.10.2026", "day": 28, "dayFormatShort": "Mi", "month": "Okt" }, "transit_time_max": { "date": "2026-10-28", "dateFormat": "28.10.2026", "day": 28, "dayFormat": "Mittwoch", "dayFormatShort": "Mi", "month": "Okt", "monthFormat": "Oktober" }, "delivery": { "timeUntilFormat": "16:00", "day": 28, "dayFormat": "Mi", "monthFormat": "Oktober", "dateFormatShort": "Mi., 28 Okt.", "timeUntilMinutes": 960 }, "transit_time_range": { "days": 2, "daysString": "Arbeitstage", "daysStringShort": "Tage" } }, "pickupSliderUsed": false, "pickupSliderUsedMessageShown": false, "sliderDraggableRange": true, "sliderDraggableRangeInt": 1, "same_day_pickup": true, "has_pickup_surcharge": false, "deliveryMaxDaysFromNowOrder": 2, "deliveryTimeUntilInMinutes": 960, "printerIsRequired": 1, "tax_free": true, "tax_free_reason": "third_country_transfer", "tax_rate": null, "tax_name": "MwSt.", "tax_countryCode": null, "hasAreaSurcharge": false, "extra_export_license_price_brutto": 59.49, "extra_insurance_value": 0, "extra_insurance_price_netto": 0, "extra_insurance_price_brutto": 0, "extra_export_license_price_brutto_old": 69.99, "extra_export_license_price_brutto_diff": 11, "extra_export_license_price_brutto_diff_percent": 16, "details": { "extra_insurance_type": "none" }, "standard_special_badge_text": "", "premium_special_badge_text": "", "uvp_insurance_standard_discount_percentage": 0, "uvp_insurance_premium_discount_percentage": 0, "extra_insurance_price_brutto_preselect": 7.99, "extra_insurance_premium_price_brutto_preselect": 11.99, "uvp_extra_insurance_price_brutto_preselect": 7.99, "uvp_extra_insurance_premium_price_brutto_preselect": 11.99, "insurance_value": 0, "price_netto_uvp": 96.37, "price_brutto_uvp": 96.37, "marketing_discount_title": null, "marketing_discount_description": null, "uvp_discount_value": 0, "uvp_discount_percent": 0, "uvp_discount_type": "customer", "requestType": "m", "is_jumingo_express": false, "best_offer_best_price_order": 3, "pickupTimeFromMinutesSelected": 510, "offer_valid_until": "2026-10-26 09:19:59" }, { "price_netto": 116.22, "price_brutto": 116.22, "packages": [ { "packageId": 0, "volumeWeight": 0.0048 } ], "id": 2527, "shipper_id": 761, "tariff_type_id": 5, "dispatch_id": 1, "package_type_ids": "7,9,11,14", "country_id": 54, "transfer": "export", "printer_required": 1, "from_company_only": 0, "to_company_only": 0, "from_private_only": 0, "to_private_only": 0, "from_phone_number_required": 0, "to_phone_number_required": 0, "hs_tariff_number_required": 0, "api_type": "cargointl-de", "calculate_volume_weight": 1, "volume_weight_factor": 5000, "marketing_discount": null, "marketing_discount_valid_until": null, "delivery_on_saturday": 0, "guaranteed_delivery_date": 0, "loading_aid": 0, "best_offer_order": 50, "environmentally_friendly_order": 50, "marketing_discount_type": "none", "marketing_discount_countdown_time_from": null, "marketing_discount_countdown_time_until": null, "insurance_included_max_value_api": 0, "delivery_time_until_api": "16:00:00", "pickup_time_from_api": "09:00:00", "pickup_time_until_api": "17:00:00", "daily_auto_scheduled_pickup_required": 0, "is_plus_product": false, "is_trackable_product": true, "is_insurable_product": true, "store_delivery": 1, "pickup_surcharge": 0, "parcel_content_required": 0, "settings": [], "shipper_tariff_id": 2527, "name": "", "shipper_tariff_zone_id": 10016, "transit_time_min": 5, "transit_time_max": 10, "delivery_time_until": "15:00:00", "shipper_tariff_zone_country_id": 93298, "shippingType": 1, "currency": "EUR", "individual_customer_tariff": false, "external_tariff": false, "total_weight": 6, "shipper_group_id": 15, "shipper": { "name": "JUMINGO", "tracking_link": "http://localhost/traking/test", "agb_link": "http://localhost/traking/test", "transit_time_link": null, "limits": [], "ShipperGroupName": "jumingo" }, "image": "/img/versandrechner/tarife/jumingo.png", "shopName": "Paketshop", "shopsName": "PaketShops", "hasShopFinder": false, "dates": { "pickup": { "date": "2026-10-27", "dateFormat": "27.10.2026", "day": 27, "dayFormat": "Dienstag", "dayFormatShort": "Di", "month": "Okt", "monthFormat": "Oktober", "dateFormatShort": "Di., 27 Okt.", "timeFrom": "10:00", "timeFromFormat": "10:00", "timeUntil": "18:00", "timeUntilFormat": "18:00", "min_pickup_date": "2026-10-27", "pickupTimeMinPeriodMinutes": 120, "timeFromMinutes": 600, "timeUntilMinutes": 1080 }, "transit_time_min": { "date": "2026-11-03", "dateFormat": "03.11.2026", "day": 3, "dayFormatShort": "Di", "month": "Nov" }, "transit_time_max": { "date": "2026-11-10", "dateFormat": "10.11.2026", "day": 10, "dayFormat": "Dienstag", "dayFormatShort": "Di", "month": "Nov", "monthFormat": "November" }, "delivery": { "timeUntilFormat": "16:00", "day": "3 - 10", "dayFormat": "Di / Di", "monthFormat": "November", "dateFormatShort": "Di., 3 Nov. - Di., 10 Nov.", "timeUntilMinutes": 960 }, "transit_time_range": { "days": "5-10", "daysString": "Arbeitstage", "daysStringShort": "Tage" } }, "pickupSliderUsed": false, "pickupSliderUsedMessageShown": false, "sliderDraggableRange": true, "sliderDraggableRangeInt": 1, "same_day_pickup": false, "has_pickup_surcharge": false, "deliveryMaxDaysFromNowOrder": 8.07, "deliveryTimeUntilInMinutes": 960, "printerIsRequired": 1, "tax_free": true, "tax_free_reason": "third_country_transfer", "tax_rate": null, "tax_name": "MwSt.", "tax_countryCode": null, "hasAreaSurcharge": false, "extra_export_license_price_brutto": 59.49, "extra_insurance_value": 0, "extra_insurance_price_netto": 0, "extra_insurance_price_brutto": 0, "extra_export_license_price_brutto_old": 69.99, "extra_export_license_price_brutto_diff": 11, "extra_export_license_price_brutto_diff_percent": 16, "details": { "extra_insurance_type": "none" }, "standard_special_badge_text": "", "premium_special_badge_text": "", "uvp_insurance_standard_discount_percentage": 0, "uvp_insurance_premium_discount_percentage": 0, "extra_insurance_price_brutto_preselect": 7.99, "extra_insurance_premium_price_brutto_preselect": 11.99, "uvp_extra_insurance_price_brutto_preselect": 7.99, "uvp_extra_insurance_premium_price_brutto_preselect": 11.99, "insurance_value": 0, "price_netto_uvp": 116.22, "price_brutto_uvp": 116.22, "marketing_discount_title": null, "marketing_discount_description": null, "uvp_discount_value": 0, "uvp_discount_percent": 0, "uvp_discount_type": "customer", "requestType": "m", "is_jumingo_express": false, "best_offer_best_price_order": 5, "offer_valid_until": "2026-10-26 23:55:00" }, { "price_netto": 116.22, "price_brutto": 116.22, "packages": [ { "packageId": 0, "volumeWeight": 0.0048 } ], "id": "s-2527", "shipper_id": 761, "tariff_type_id": 5, "dispatch_id": 1, "package_type_ids": "7,9,11,14", "country_id": 54, "transfer": "export", "printer_required": 1, "from_company_only": 0, "to_company_only": 0, "from_private_only": 0, "to_private_only": 0, "from_phone_number_required": 0, "to_phone_number_required": 0, "hs_tariff_number_required": 0, "api_type": "cargointl-de", "calculate_volume_weight": 1, "volume_weight_factor": 5000, "marketing_discount": null, "marketing_discount_valid_until": null, "delivery_on_saturday": 0, "guaranteed_delivery_date": 0, "loading_aid": 0, "best_offer_order": 50, "environmentally_friendly_order": 50, "marketing_discount_type": "none", "marketing_discount_countdown_time_from": null, "marketing_discount_countdown_time_until": null, "insurance_included_max_value_api": 0, "delivery_time_until_api": "16:00:00", "pickup_time_from_api": "09:00:00", "pickup_time_until_api": "17:00:00", "daily_auto_scheduled_pickup_required": 0, "is_plus_product": false, "is_trackable_product": true, "is_insurable_product": true, "store_delivery": 1, "pickup_surcharge": 0, "parcel_content_required": 0, "settings": [], "shipper_tariff_id": 2527, "name": "", "shipper_tariff_zone_id": 10016, "transit_time_min": 5, "transit_time_max": 11, "delivery_time_until": "15:00:00", "shipper_tariff_zone_country_id": 93298, "shippingType": 2, "currency": "EUR", "individual_customer_tariff": false, "external_tariff": false, "total_weight": 6, "shipper_group_id": 15, "shipper": { "name": "JUMINGO", "tracking_link": "http://localhost/traking/test", "agb_link": "http://localhost/traking/test", "transit_time_link": null, "limits": [], "ShipperGroupName": "jumingo" }, "image": "/img/versandrechner/tarife/jumingo.png", "shopName": "Paketshop", "shopsName": "PaketShops", "hasShopFinder": false, "dates": { "pickup": { "date": "2026-10-26", "dateFormat": "26.10.2026", "day": 26, "dayFormat": "Montag", "dayFormatShort": "Mo", "month": "Okt", "monthFormat": "Oktober", "dateFormatShort": "Mo., 26 Okt.", "min_pickup_date": "2026-10-26" }, "transit_time_min": { "date": "2026-11-02", "dateFormat": "02.11.2026", "day": 2, "dayFormatShort": "Mo", "month": "Nov" }, "transit_time_max": { "date": "2026-11-10", "dateFormat": "10.11.2026", "day": 10, "dayFormat": "Dienstag", "dayFormatShort": "Di", "month": "Nov", "monthFormat": "November" }, "delivery": { "timeUntilFormat": "16:00", "day": "2 - 10", "dayFormat": "Mo / Di", "monthFormat": "November", "dateFormatShort": "Mo., 2 Nov. - Di., 10 Nov.", "timeUntilMinutes": 960 }, "transit_time_range": { "days": "5-11", "daysString": "Arbeitstage", "daysStringShort": "Tage" } }, "sliderDraggableRangeInt": 0, "deliveryMaxDaysFromNowOrder": 7.08, "deliveryTimeUntilInMinutes": 960, "printerIsRequired": 1, "tax_free": true, "tax_free_reason": "third_country_transfer", "tax_rate": null, "tax_name": "MwSt.", "tax_countryCode": null, "hasAreaSurcharge": false, "extra_export_license_price_brutto": 59.49, "extra_insurance_value": 0, "extra_insurance_price_netto": 0, "extra_insurance_price_brutto": 0, "extra_export_license_price_brutto_old": 69.99, "extra_export_license_price_brutto_diff": 11, "extra_export_license_price_brutto_diff_percent": 16, "details": { "extra_insurance_type": "none" }, "standard_special_badge_text": "", "premium_special_badge_text": "", "uvp_insurance_standard_discount_percentage": 0, "uvp_insurance_premium_discount_percentage": 0, "extra_insurance_price_brutto_preselect": 7.99, "extra_insurance_premium_price_brutto_preselect": 11.99, "uvp_extra_insurance_price_brutto_preselect": 7.99, "uvp_extra_insurance_premium_price_brutto_preselect": 11.99, "insurance_value": 0, "price_netto_uvp": 116.22, "price_brutto_uvp": 116.22, "marketing_discount_title": null, "marketing_discount_description": null, "uvp_discount_value": 0, "uvp_discount_percent": 0, "uvp_discount_type": "customer", "requestType": "m", "is_jumingo_express": false, "best_offer_best_price_order": 6, "offer_valid_until": "2026-10-26 23:55:00" }, { "price_netto": 124.37, "price_brutto": 124.37, "packages": [ { "packageId": 0, "volumeWeight": 0.0048 } ], "id": 3138, "shipper_id": 748, "tariff_type_id": 5, "dispatch_id": 1, "package_type_ids": "7,9,11,14", "country_id": 54, "transfer": "export", "printer_required": 1, "from_company_only": 0, "to_company_only": 0, "from_private_only": 0, "to_private_only": 0, "from_phone_number_required": 0, "to_phone_number_required": 0, "hs_tariff_number_required": 0, "api_type": "fedex", "calculate_volume_weight": 1, "volume_weight_factor": 5000, "marketing_discount": null, "marketing_discount_valid_until": null, "delivery_on_saturday": 0, "guaranteed_delivery_date": 0, "loading_aid": 0, "best_offer_order": 50, "environmentally_friendly_order": 50, "marketing_discount_type": "none", "marketing_discount_countdown_time_from": null, "marketing_discount_countdown_time_until": null, "insurance_included_max_value_api": 0, "delivery_time_until_api": "16:00:00", "pickup_time_from_api": "09:00:00", "pickup_time_until_api": "17:00:00", "daily_auto_scheduled_pickup_required": 0, "is_plus_product": false, "is_trackable_product": true, "is_insurable_product": true, "store_delivery": 1, "pickup_surcharge": 0, "parcel_content_required": 0, "settings": [], "shipper_tariff_id": 3138, "name": "", "shipper_tariff_zone_id": 12285, "transit_time_min": 6, "transit_time_max": 6, "delivery_time_until": "15:00:00", "shipper_tariff_zone_country_id": 109613, "shippingType": 1, "currency": "EUR", "individual_customer_tariff": false, "external_tariff": false, "total_weight": 6, "shipper_group_id": 29, "shipper": { "name": "FedEx Warensendung VK", "tracking_link": "https://www.fedex.com/en-de/tracking.html", "agb_link": "https://www.fedex.com/de-de/conditions-of-carriage.html", "transit_time_link": null, "limits": [], "ShipperGroupName": "FedEx" }, "image": "/img/versandrechner/tarife/fedex.png", "shopName": "Paketshop", "shopsName": "PaketShops", "hasShopFinder": false, "dates": { "pickup": { "date": "2026-10-27", "dateFormat": "27.10.2026", "day": 27, "dayFormat": "Dienstag", "dayFormatShort": "Di", "month": "Okt", "monthFormat": "Oktober", "dateFormatShort": "Di., 27 Okt.", "timeFrom": "10:00", "timeFromFormat": "10:00", "timeUntil": "18:00", "timeUntilFormat": "18:00", "min_pickup_date": "2026-10-27", "pickupTimeMinPeriodMinutes": 120, "timeFromMinutes": 600, "timeUntilMinutes": 1080 }, "transit_time_min": { "date": "2026-11-04", "dateFormat": "04.11.2026", "day": 4, "dayFormatShort": "Mi", "month": "Nov" }, "transit_time_max": { "date": "2026-11-04", "dateFormat": "04.11.2026", "day": 4, "dayFormat": "Mittwoch", "dayFormatShort": "Mi", "month": "Nov", "monthFormat": "November" }, "delivery": { "timeUntilFormat": "16:00", "day": 4, "dayFormat": "Mi", "monthFormat": "November", "dateFormatShort": "Mi., 4 Nov.", "timeUntilMinutes": 960 }, "transit_time_range": { "days": 6, "daysString": "Arbeitstage", "daysStringShort": "Tage" } }, "pickupSliderUsed": false, "pickupSliderUsedMessageShown": false, "sliderDraggableRange": true, "sliderDraggableRangeInt": 1, "same_day_pickup": false, "has_pickup_surcharge": false, "deliveryMaxDaysFromNowOrder": 9, "deliveryTimeUntilInMinutes": 960, "printerIsRequired": 1, "tax_free": true, "tax_free_reason": "third_country_transfer", "tax_rate": null, "tax_name": "MwSt.", "tax_countryCode": null, "hasAreaSurcharge": false, "extra_export_license_price_brutto": 59.49, "extra_insurance_value": 0, "extra_insurance_price_netto": 0, "extra_insurance_price_brutto": 0, "extra_export_license_price_brutto_old": 69.99, "extra_export_license_price_brutto_diff": 11, "extra_export_license_price_brutto_diff_percent": 16, "details": { "extra_insurance_type": "none" }, "standard_special_badge_text": "", "premium_special_badge_text": "", "uvp_insurance_standard_discount_percentage": 0, "uvp_insurance_premium_discount_percentage": 0, "extra_insurance_price_brutto_preselect": 7.99, "extra_insurance_premium_price_brutto_preselect": 11.99, "uvp_extra_insurance_price_brutto_preselect": 7.99, "uvp_extra_insurance_premium_price_brutto_preselect": 11.99, "insurance_value": 0, "price_netto_uvp": 124.37, "price_brutto_uvp": 124.37, "marketing_discount_title": null, "marketing_discount_description": null, "uvp_discount_value": 0, "uvp_discount_percent": 0, "uvp_discount_type": "customer", "requestType": "m", "is_jumingo_express": false, "best_offer_best_price_order": 7, "offer_valid_until": "2026-10-26 23:55:00" }, { "price_netto": 124.37, "price_brutto": 124.37, "packages": [ { "packageId": 0, "volumeWeight": 0.0048 } ], "id": "s-3138", "shipper_id": 748, "tariff_type_id": 5, "dispatch_id": 1, "package_type_ids": "7,9,11,14", "country_id": 54, "transfer": "export", "printer_required": 1, "from_company_only": 0, "to_company_only": 0, "from_private_only": 0, "to_private_only": 0, "from_phone_number_required": 0, "to_phone_number_required": 0, "hs_tariff_number_required": 0, "api_type": "fedex", "calculate_volume_weight": 1, "volume_weight_factor": 5000, "marketing_discount": null, "marketing_discount_valid_until": null, "delivery_on_saturday": 0, "guaranteed_delivery_date": 0, "loading_aid": 0, "best_offer_order": 50, "environmentally_friendly_order": 50, "marketing_discount_type": "none", "marketing_discount_countdown_time_from": null, "marketing_discount_countdown_time_until": null, "insurance_included_max_value_api": 0, "delivery_time_until_api": "16:00:00", "pickup_time_from_api": "09:00:00", "pickup_time_until_api": "17:00:00", "daily_auto_scheduled_pickup_required": 0, "is_plus_product": false, "is_trackable_product": true, "is_insurable_product": true, "store_delivery": 1, "pickup_surcharge": 0, "parcel_content_required": 0, "settings": [], "shipper_tariff_id": 3138, "name": "", "shipper_tariff_zone_id": 12285, "transit_time_min": 6, "transit_time_max": 7, "delivery_time_until": "15:00:00", "shipper_tariff_zone_country_id": 109613, "shippingType": 2, "currency": "EUR", "individual_customer_tariff": false, "external_tariff": false, "total_weight": 6, "shipper_group_id": 29, "shipper": { "name": "FedEx Warensendung VK", "tracking_link": "https://www.fedex.com/en-de/tracking.html", "agb_link": "https://www.fedex.com/de-de/conditions-of-carriage.html", "transit_time_link": null, "limits": [], "ShipperGroupName": "FedEx" }, "image": "/img/versandrechner/tarife/fedex.png", "shopName": "Paketshop", "shopsName": "PaketShops", "hasShopFinder": false, "dates": { "pickup": { "date": "2026-10-26", "dateFormat": "26.10.2026", "day": 26, "dayFormat": "Montag", "dayFormatShort": "Mo", "month": "Okt", "monthFormat": "Oktober", "dateFormatShort": "Mo., 26 Okt.", "min_pickup_date": "2026-10-26" }, "transit_time_min": { "date": "2026-11-03", "dateFormat": "03.11.2026", "day": 3, "dayFormatShort": "Di", "month": "Nov" }, "transit_time_max": { "date": "2026-11-04", "dateFormat": "04.11.2026", "day": 4, "dayFormat": "Mittwoch", "dayFormatShort": "Mi", "month": "Nov", "monthFormat": "November" }, "delivery": { "timeUntilFormat": "16:00", "day": "3 - 4", "dayFormat": "Di / Mi", "monthFormat": "November", "dateFormatShort": "Di., 3 Nov. - Mi., 4 Nov.", "timeUntilMinutes": 960 }, "transit_time_range": { "days": "6-7", "daysString": "Arbeitstage", "daysStringShort": "Tage" } }, "sliderDraggableRangeInt": 0, "deliveryMaxDaysFromNowOrder": 8.01, "deliveryTimeUntilInMinutes": 960, "printerIsRequired": 1, "tax_free": true, "tax_free_reason": "third_country_transfer", "tax_rate": null, "tax_name": "MwSt.", "tax_countryCode": null, "hasAreaSurcharge": false, "extra_export_license_price_brutto": 59.49, "extra_insurance_value": 0, "extra_insurance_price_netto": 0, "extra_insurance_price_brutto": 0, "extra_export_license_price_brutto_old": 69.99, "extra_export_license_price_brutto_diff": 11, "extra_export_license_price_brutto_diff_percent": 16, "details": { "extra_insurance_type": "none" }, "standard_special_badge_text": "", "premium_special_badge_text": "", "uvp_insurance_standard_discount_percentage": 0, "uvp_insurance_premium_discount_percentage": 0, "extra_insurance_price_brutto_preselect": 7.99, "extra_insurance_premium_price_brutto_preselect": 11.99, "uvp_extra_insurance_price_brutto_preselect": 7.99, "uvp_extra_insurance_premium_price_brutto_preselect": 11.99, "insurance_value": 0, "price_netto_uvp": 124.37, "price_brutto_uvp": 124.37, "marketing_discount_title": null, "marketing_discount_description": null, "uvp_discount_value": 0, "uvp_discount_percent": 0, "uvp_discount_type": "customer", "requestType": "m", "is_jumingo_express": false, "best_offer_best_price_order": 8, "offer_valid_until": "2026-10-26 23:55:00" }, { "price_netto": 180.88, "price_brutto": 180.88, "packages": [ { "packageId": 0, "volumeWeight": 0.006 } ], "id": 78, "shipper_id": 32, "tariff_type_id": 2, "dispatch_id": 1, "package_type_ids": "7,9,11,14", "country_id": 54, "transfer": "export", "printer_required": 1, "from_company_only": 1, "to_company_only": 0, "from_private_only": 0, "to_private_only": 0, "from_phone_number_required": 0, "to_phone_number_required": 0, "hs_tariff_number_required": 0, "api_type": "tnt", "calculate_volume_weight": 1, "volume_weight_factor": 4000, "marketing_discount": null, "marketing_discount_valid_until": null, "delivery_on_saturday": 0, "guaranteed_delivery_date": 0, "loading_aid": 0, "best_offer_order": 29, "environmentally_friendly_order": 50, "marketing_discount_type": "normal", "marketing_discount_countdown_time_from": "07:00:00", "marketing_discount_countdown_time_until": "19:00:00", "insurance_included_max_value_api": 0, "delivery_time_until_api": "16:00:00", "pickup_time_from_api": "09:00:00", "pickup_time_until_api": "17:00:00", "daily_auto_scheduled_pickup_required": 0, "is_plus_product": false, "is_trackable_product": true, "is_insurable_product": true, "parcel_content_required": 0, "settings": [], "shipper_tariff_id": 78, "name": "TNT ECONOMY EXPRESS", "shipper_tariff_zone_id": 413, "transit_time_min": 5, "transit_time_max": 5, "delivery_time_until": "15:00:00", "store_delivery": 0, "pickup_surcharge": 0, "shipper_tariff_zone_country_id": 4030, "shippingType": 1, "currency": "EUR", "individual_customer_tariff": false, "external_tariff": false, "total_weight": 6, "shipper_group_id": 5, "shipper": { "name": "TNT-Economy Express", "tracking_link": "https://www.tnt.com/express/de_de/site/home/applications/tracking.html?cons=", "agb_link": "https://www.tnt.com/express/de_de/site/home/terms-conditions.html", "transit_time_link": null, "limits": [ { "operant": "weight", "operator": "<=", "value": 70 }, { "operant": "length", "operator": "<=", "value": 240 }, { "operant": "width", "operator": "<=", "value": 120 }, { "operant": "height", "operator": "<=", "value": 140 } ], "ShipperGroupName": "TNT" }, "image": "/img/versandrechner/tarife/tnt.png", "dates": { "pickup": { "date": "2026-10-26", "dateFormat": "26.10.2026", "day": 26, "dayFormat": "Montag", "dayFormatShort": "Mo", "month": "Okt", "monthFormat": "Oktober", "dateFormatShort": "Mo., 26 Okt.", "timeFrom": "09:30", "timeFromFormat": "09:30", "timeUntil": "15:00", "timeUntilFormat": "15:00", "min_pickup_date": "2026-10-26", "pickupTimeMinPeriodMinutes": 120, "timeFromMinutes": 570, "timeUntilMinutes": 900 }, "transit_time_min": { "date": "2026-11-02", "dateFormat": "02.11.2026", "day": 2, "dayFormatShort": "Mo", "month": "Nov" }, "transit_time_max": { "date": "2026-11-02", "dateFormat": "02.11.2026", "day": 2, "dayFormat": "Montag", "dayFormatShort": "Mo", "month": "Nov", "monthFormat": "November" }, "delivery": { "timeUntilFormat": "16:00", "day": 2, "dayFormat": "Mo", "monthFormat": "November", "dateFormatShort": "Mo., 2 Nov.", "timeUntilMinutes": 960 }, "transit_time_range": { "days": 5, "daysString": "Arbeitstage", "daysStringShort": "Tage" } }, "pickupSliderUsed": false, "pickupSliderUsedMessageShown": false, "sliderDraggableRange": true, "sliderDraggableRangeInt": 1, "same_day_pickup": true, "has_pickup_surcharge": false, "deliveryMaxDaysFromNowOrder": 7, "deliveryTimeUntilInMinutes": 960, "printerIsRequired": 1, "tax_free": true, "tax_free_reason": "third_country_transfer", "tax_rate": null, "tax_name": "MwSt.", "tax_countryCode": null, "hasAreaSurcharge": false, "extra_export_license_price_brutto": 59.49, "extra_insurance_value": 0, "extra_insurance_price_netto": 0, "extra_insurance_price_brutto": 0, "extra_export_license_price_brutto_old": 69.99, "extra_export_license_price_brutto_diff": 11, "extra_export_license_price_brutto_diff_percent": 16, "details": { "extra_insurance_type": "none" }, "standard_special_badge_text": "", "premium_special_badge_text": "", "uvp_insurance_standard_discount_percentage": 0, "uvp_insurance_premium_discount_percentage": 0, "extra_insurance_price_brutto_preselect": 7.99, "extra_insurance_premium_price_brutto_preselect": 11.99, "uvp_extra_insurance_price_brutto_preselect": 7.99, "uvp_extra_insurance_premium_price_brutto_preselect": 11.99, "insurance_value": 0, "price_netto_uvp": 180.88, "price_brutto_uvp": 180.88, "marketing_discount_title": null, "marketing_discount_description": null, "uvp_discount_value": 0, "uvp_discount_percent": 0, "uvp_discount_type": "customer", "requestType": "m", "is_jumingo_express": false, "best_offer_best_price_order": 1, "pickupTimeFromMinutesSelected": 510, "offer_valid_until": "2026-10-26 09:19:59" }, { "price_netto": 348.1, "price_brutto": 348.1, "packages": [ { "packageId": 0, "volumeWeight": 0.0048 } ], "id": 33, "shipper_id": 8, "tariff_type_id": 2, "dispatch_id": 1, "package_type_ids": "7,9,11,14", "country_id": 54, "transfer": "export", "printer_required": 1, "from_company_only": 1, "to_company_only": 0, "from_private_only": 0, "to_private_only": 0, "from_phone_number_required": 0, "to_phone_number_required": 0, "hs_tariff_number_required": 0, "api_type": "tnt", "calculate_volume_weight": 1, "volume_weight_factor": 5000, "marketing_discount": null, "marketing_discount_valid_until": null, "delivery_on_saturday": 0, "guaranteed_delivery_date": 0, "loading_aid": 0, "best_offer_order": 29, "environmentally_friendly_order": 50, "marketing_discount_type": "normal", "marketing_discount_countdown_time_from": "07:00:00", "marketing_discount_countdown_time_until": "13:00:00", "insurance_included_max_value_api": 0, "delivery_time_until_api": "16:00:00", "pickup_time_from_api": "09:00:00", "pickup_time_until_api": "17:00:00", "daily_auto_scheduled_pickup_required": 0, "is_plus_product": false, "is_trackable_product": true, "is_insurable_product": true, "parcel_content_required": 0, "settings": [], "shipper_tariff_id": 33, "name": "TNT EXPRESS", "shipper_tariff_zone_id": 186, "transit_time_min": 2, "transit_time_max": 2, "delivery_time_until": "15:00:00", "store_delivery": 1, "pickup_surcharge": 0, "shipper_tariff_zone_country_id": 10384, "shippingType": 1, "currency": "EUR", "individual_customer_tariff": false, "external_tariff": false, "total_weight": 6, "shipper_group_id": 5, "shipper": { "name": "TNT", "tracking_link": "https://www.tnt.com/express/de_de/site/home/applications/tracking.html?cons=", "agb_link": "https://www.tnt.com/express/de_de/site/home/terms-conditions.html", "transit_time_link": "", "limits": [ { "operant": "weight", "operator": "<=", "value": 70 }, { "operant": "length", "operator": "<=", "value": 240 }, { "operant": "width", "operator": "<=", "value": 120 }, { "operant": "height", "operator": "<=", "value": 150 } ], "ShipperGroupName": "TNT" }, "image": "/img/versandrechner/tarife/tnt.png", "dates": { "pickup": { "date": "2026-10-26", "dateFormat": "26.10.2026", "day": 26, "dayFormat": "Montag", "dayFormatShort": "Mo", "month": "Okt", "monthFormat": "Oktober", "dateFormatShort": "Mo., 26 Okt.", "timeFrom": "09:30", "timeFromFormat": "09:30", "timeUntil": "15:00", "timeUntilFormat": "15:00", "min_pickup_date": "2026-10-26", "pickupTimeMinPeriodMinutes": 120, "timeFromMinutes": 570, "timeUntilMinutes": 900 }, "transit_time_min": { "date": "2026-10-28", "dateFormat": "28.10.2026", "day": 28, "dayFormatShort": "Mi", "month": "Okt" }, "transit_time_max": { "date": "2026-10-28", "dateFormat": "28.10.2026", "day": 28, "dayFormat": "Mittwoch", "dayFormatShort": "Mi", "month": "Okt", "monthFormat": "Oktober" }, "delivery": { "timeUntilFormat": "16:00", "day": 28, "dayFormat": "Mi", "monthFormat": "Oktober", "dateFormatShort": "Mi., 28 Okt.", "timeUntilMinutes": 960 }, "transit_time_range": { "days": 2, "daysString": "Arbeitstage", "daysStringShort": "Tage" } }, "pickupSliderUsed": false, "pickupSliderUsedMessageShown": false, "sliderDraggableRange": true, "sliderDraggableRangeInt": 1, "same_day_pickup": true, "has_pickup_surcharge": false, "deliveryMaxDaysFromNowOrder": 2, "deliveryTimeUntilInMinutes": 960, "printerIsRequired": 1, "tax_free": true, "tax_free_reason": "third_country_transfer", "tax_rate": null, "tax_name": "MwSt.", "tax_countryCode": null, "hasAreaSurcharge": false, "extra_export_license_price_brutto": 59.49, "extra_insurance_value": 0, "extra_insurance_price_netto": 0, "extra_insurance_price_brutto": 0, "extra_export_license_price_brutto_old": 69.99, "extra_export_license_price_brutto_diff": 11, "extra_export_license_price_brutto_diff_percent": 16, "details": { "extra_insurance_type": "none" }, "standard_special_badge_text": "", "premium_special_badge_text": "", "uvp_insurance_standard_discount_percentage": 0, "uvp_insurance_premium_discount_percentage": 0, "extra_insurance_price_brutto_preselect": 7.99, "extra_insurance_premium_price_brutto_preselect": 11.99, "uvp_extra_insurance_price_brutto_preselect": 7.99, "uvp_extra_insurance_premium_price_brutto_preselect": 11.99, "insurance_value": 0, "price_netto_uvp": 348.1, "price_brutto_uvp": 348.1, "marketing_discount_title": null, "marketing_discount_description": null, "marketing_discount_countdown": null, "uvp_discount_value": 0, "uvp_discount_percent": 0, "uvp_discount_type": "customer", "requestType": "m", "is_jumingo_express": false, "best_offer_best_price_order": 2, "pickupTimeFromMinutesSelected": 510, "offer_valid_until": "2026-10-26 09:19:59" }, { "price_netto": 400.18, "price_brutto": 400.18, "packages": [ { "packageId": 0, "volumeWeight": 0.0048 } ], "id": 264, "shipper_id": 113, "tariff_type_id": 2, "dispatch_id": 1, "package_type_ids": "7,9,11,14,1", "country_id": 54, "transfer": "export", "printer_required": 0, "from_company_only": 0, "to_company_only": 0, "from_private_only": 0, "to_private_only": 0, "from_phone_number_required": 0, "to_phone_number_required": 0, "hs_tariff_number_required": 0, "api_type": "none", "calculate_volume_weight": 1, "volume_weight_factor": 5000, "marketing_discount": null, "marketing_discount_valid_until": null, "delivery_on_saturday": 0, "guaranteed_delivery_date": 0, "loading_aid": 0, "best_offer_order": 50, "environmentally_friendly_order": 50, "marketing_discount_type": "none", "marketing_discount_countdown_time_from": null, "marketing_discount_countdown_time_until": null, "insurance_included_max_value_api": 0, "delivery_time_until_api": "15:00:00", "pickup_time_from_api": "09:00:00", "pickup_time_until_api": "17:00:00", "daily_auto_scheduled_pickup_required": 0, "is_plus_product": false, "is_trackable_product": true, "is_insurable_product": true, "parcel_content_required": 0, "settings": [], "shipper_tariff_id": 264, "name": "SkyNet", "shipper_tariff_zone_id": 1414, "transit_time_min": 3, "transit_time_max": 5, "delivery_time_until": "15:00:00", "store_delivery": 1, "pickup_surcharge": 0, "shipper_tariff_zone_country_id": 13966, "shippingType": 1, "currency": "EUR", "individual_customer_tariff": false, "external_tariff": false, "total_weight": 6, "shipper_group_id": 30, "shipper": { "name": "SkyNet Worldwide Express", "tracking_link": "http://sky.skynet.net/public/Tracking.aspx?guide=", "agb_link": "http://skynet-cgn.de/agb/", "transit_time_link": "", "limits": [ { "operant": "girth", "operator": "<=", "value": 300 }, { "operant": "weight", "operator": "<=", "value": 25 }, { "operant": "length", "operator": "<=", "value": 120 }, { "operant": "width", "operator": "<=", "value": 60 }, { "operant": "height", "operator": "<=", "value": 60 } ], "ShipperGroupName": "SkyNet" }, "image": "/img/versandrechner/tarife/sky.png", "dates": { "pickup": { "date": "2026-10-27", "dateFormat": "27.10.2026", "day": 27, "dayFormat": "Dienstag", "dayFormatShort": "Di", "month": "Okt", "monthFormat": "Oktober", "dateFormatShort": "Di., 27 Okt.", "timeFrom": "08:00", "timeFromFormat": "08:00", "timeUntil": "16:00", "timeUntilFormat": "16:00", "min_pickup_date": "2026-10-27", "pickupTimeMinPeriodMinutes": 480, "timeFromMinutes": 480, "timeUntilMinutes": 960 }, "transit_time_min": { "date": "2026-10-30", "dateFormat": "30.10.2026", "day": 30, "dayFormatShort": "Fr", "month": "Okt" }, "transit_time_max": { "date": "2026-11-03", "dateFormat": "03.11.2026", "day": 3, "dayFormat": "Dienstag", "dayFormatShort": "Di", "month": "Nov", "monthFormat": "November" }, "delivery": { "timeUntilFormat": "16:00", "day": "30 - 3", "dayFormat": "Fr / Di", "monthFormat": "Okt / Nov", "dateFormatShort": "Fr., 30 Okt. - Di., 3 Nov.", "timeUntilMinutes": 960 }, "transit_time_range": { "days": "3-5", "daysString": "Arbeitstage", "daysStringShort": "Tage" } }, "pickupSliderUsed": false, "pickupSliderUsedMessageShown": false, "sliderDraggableRange": false, "sliderDraggableRangeInt": 0, "same_day_pickup": false, "has_pickup_surcharge": false, "deliveryMaxDaysFromNowOrder": 4.04, "deliveryTimeUntilInMinutes": 960, "printerIsRequired": 0, "tax_free": true, "tax_free_reason": "third_country_transfer", "tax_rate": null, "tax_name": "MwSt.", "tax_countryCode": null, "hasAreaSurcharge": false, "extra_export_license_price_brutto": 59.49, "extra_insurance_value": 0, "extra_insurance_price_netto": 0, "extra_insurance_price_brutto": 0, "extra_export_license_price_brutto_old": 69.99, "extra_export_license_price_brutto_diff": 11, "extra_export_license_price_brutto_diff_percent": 16, "details": { "extra_insurance_type": "none" }, "standard_special_badge_text": "", "premium_special_badge_text": "", "uvp_insurance_standard_discount_percentage": 0, "uvp_insurance_premium_discount_percentage": 0, "extra_insurance_price_brutto_preselect": 7.99, "extra_insurance_premium_price_brutto_preselect": 11.99, "uvp_extra_insurance_price_brutto_preselect": 7.99, "uvp_extra_insurance_premium_price_brutto_preselect": 11.99, "insurance_value": 500, "price_netto_uvp": 400.18, "price_brutto_uvp": 400.18, "marketing_discount_title": null, "marketing_discount_description": null, "uvp_discount_value": 0, "uvp_discount_percent": 0, "uvp_discount_type": "customer", "requestType": "m", "is_jumingo_express": false, "best_offer_best_price_order": 9, "offer_valid_until": "2026-10-26 23:55:00" }, { "price_netto": 471.7, "price_brutto": 471.7, "packages": [ { "packageId": 0, "volumeWeight": 0.0048 } ], "id": 275, "shipper_id": 4, "tariff_type_id": 2, "dispatch_id": 1, "package_type_ids": "7,9,11,14", "country_id": 54, "transfer": "export", "printer_required": 1, "from_company_only": 0, "to_company_only": 0, "from_private_only": 0, "to_private_only": 0, "from_phone_number_required": 0, "to_phone_number_required": 0, "hs_tariff_number_required": 0, "api_type": "ups_new", "calculate_volume_weight": 1, "volume_weight_factor": 5000, "marketing_discount": null, "marketing_discount_valid_until": null, "delivery_on_saturday": 0, "guaranteed_delivery_date": 0, "loading_aid": 0, "best_offer_order": 50, "environmentally_friendly_order": 50, "marketing_discount_type": "normal", "marketing_discount_countdown_time_from": "07:00:00", "marketing_discount_countdown_time_until": "21:59:00", "insurance_included_max_value_api": 0, "delivery_time_until_api": "16:00:00", "pickup_time_from_api": "09:00:00", "pickup_time_until_api": "17:00:00", "daily_auto_scheduled_pickup_required": 0, "is_plus_product": false, "is_trackable_product": true, "is_insurable_product": true, "parcel_content_required": 0, "settings": [], "shipper_tariff_id": 275, "name": "UPS EXPEDITED ®", "shipper_tariff_zone_id": 1441, "transit_time_min": 2, "transit_time_max": 5, "delivery_time_until": "15:00:00", "store_delivery": 1, "pickup_surcharge": 0, "shipper_tariff_zone_country_id": 14419, "shippingType": 1, "currency": "EUR", "individual_customer_tariff": false, "external_tariff": false, "total_weight": 6, "shipper_group_id": 1, "shipper": { "name": "UPS Express ", "tracking_link": "http://wwwapps.ups.com/WebTracking/processInputRequest?sort_by=status&tracknums_displayed=1&TypeOfInquiryNumber=T&loc=de_DE&InquiryNumber=", "agb_link": "https://www.ups.com/media/de/terms_carriage_ger.pdf", "transit_time_link": "https://wwwapps.ups.com/ctc/request?loc=de_DE", "limits": [ { "operant": "girth", "operator": "<=", "value": 419 }, { "operant": "weight", "operator": "<=", "value": 70 }, { "operant": "first_length", "operator": "<=", "value": 269 } ], "ShipperGroupName": "UPS" }, "image": "/img/versandrechner/tarife/upsneu.png", "shopName": "UPS Access Point", "shopsName": "PaketShops", "hasShopFinder": true, "dates": { "pickup": { "date": "2026-10-26", "dateFormat": "26.10.2026", "day": 26, "dayFormat": "Montag", "dayFormatShort": "Mo", "month": "Okt", "monthFormat": "Oktober", "dateFormatShort": "Mo., 26 Okt.", "timeFrom": "09:30", "timeFromFormat": "09:30", "timeUntil": "16:00", "timeUntilFormat": "16:00", "min_pickup_date": "2026-10-26", "pickupTimeMinPeriodMinutes": 120, "timeFromMinutes": 570, "timeUntilMinutes": 960 }, "transit_time_min": { "date": "2026-10-28", "dateFormat": "28.10.2026", "day": 28, "dayFormatShort": "Mi", "month": "Okt" }, "transit_time_max": { "date": "2026-11-02", "dateFormat": "02.11.2026", "day": 2, "dayFormat": "Montag", "dayFormatShort": "Mo", "month": "Nov", "monthFormat": "November" }, "delivery": { "timeUntilFormat": "16:00", "day": "28 - 2", "dayFormat": "Mi / Mo", "monthFormat": "Okt / Nov", "dateFormatShort": "Mi., 28 Okt. - Mo., 2 Nov.", "timeUntilMinutes": 960 }, "transit_time_range": { "days": "2-5", "daysString": "Arbeitstage", "daysStringShort": "Tage" } }, "pickupSliderUsed": false, "pickupSliderUsedMessageShown": false, "sliderDraggableRange": true, "sliderDraggableRangeInt": 1, "same_day_pickup": true, "has_pickup_surcharge": false, "deliveryMaxDaysFromNowOrder": 2.05, "deliveryTimeUntilInMinutes": 960, "printerIsRequired": 1, "tax_free": true, "tax_free_reason": "third_country_transfer", "tax_rate": null, "tax_name": "MwSt.", "tax_countryCode": null, "hasAreaSurcharge": false, "extra_export_license_price_brutto": 59.49, "extra_insurance_value": 0, "extra_insurance_price_netto": 0, "extra_insurance_price_brutto": 0, "extra_export_license_price_brutto_old": 69.99, "extra_export_license_price_brutto_diff": 11, "extra_export_license_price_brutto_diff_percent": 16, "details": { "extra_insurance_type": "none" }, "standard_special_badge_text": "", "premium_special_badge_text": "", "uvp_insurance_standard_discount_percentage": 0, "uvp_insurance_premium_discount_percentage": 0, "extra_insurance_price_brutto_preselect": 7.99, "extra_insurance_premium_price_brutto_preselect": 11.99, "uvp_extra_insurance_price_brutto_preselect": 7.99, "uvp_extra_insurance_premium_price_brutto_preselect": 11.99, "insurance_value": 510, "price_netto_uvp": 471.7, "price_brutto_uvp": 471.7, "marketing_discount_title": null, "marketing_discount_description": null, "uvp_discount_value": 0, "uvp_discount_percent": 0, "uvp_discount_type": "customer", "requestType": "m", "is_jumingo_express": false, "best_offer_best_price_order": 10, "pickupTimeFromMinutesSelected": 510, "offer_valid_until": "2026-10-26 09:19:59" }, { "price_netto": 471.7, "price_brutto": 471.7, "packages": [ { "packageId": 0, "volumeWeight": 0.0048 } ], "id": "s-275", "shipper_id": 4, "tariff_type_id": 2, "dispatch_id": 1, "package_type_ids": "7,9,11,14", "country_id": 54, "transfer": "export", "printer_required": 1, "from_company_only": 0, "to_company_only": 0, "from_private_only": 0, "to_private_only": 0, "from_phone_number_required": 0, "to_phone_number_required": 0, "hs_tariff_number_required": 0, "api_type": "ups_new", "calculate_volume_weight": 1, "volume_weight_factor": 5000, "marketing_discount": null, "marketing_discount_valid_until": null, "delivery_on_saturday": 0, "guaranteed_delivery_date": 0, "loading_aid": 0, "best_offer_order": 50, "environmentally_friendly_order": 50, "marketing_discount_type": "normal", "marketing_discount_countdown_time_from": "07:00:00", "marketing_discount_countdown_time_until": "21:59:00", "insurance_included_max_value_api": 0, "delivery_time_until_api": "16:00:00", "pickup_time_from_api": "09:00:00", "pickup_time_until_api": "17:00:00", "daily_auto_scheduled_pickup_required": 0, "is_plus_product": false, "is_trackable_product": true, "is_insurable_product": true, "parcel_content_required": 0, "settings": [], "shipper_tariff_id": 275, "name": "UPS EXPEDITED ®", "shipper_tariff_zone_id": 1441, "transit_time_min": 2, "transit_time_max": 6, "delivery_time_until": "15:00:00", "store_delivery": 1, "pickup_surcharge": 0, "shipper_tariff_zone_country_id": 14419, "shippingType": 2, "currency": "EUR", "individual_customer_tariff": false, "external_tariff": false, "total_weight": 6, "shipper_group_id": 1, "shipper": { "name": "UPS Express ", "tracking_link": "http://wwwapps.ups.com/WebTracking/processInputRequest?sort_by=status&tracknums_displayed=1&TypeOfInquiryNumber=T&loc=de_DE&InquiryNumber=", "agb_link": "https://www.ups.com/media/de/terms_carriage_ger.pdf", "transit_time_link": "https://wwwapps.ups.com/ctc/request?loc=de_DE", "limits": [ { "operant": "girth", "operator": "<=", "value": 330 }, { "operant": "weight", "operator": "<=", "value": 20 }, { "operant": "first_length", "operator": "<=", "value": 80 }, { "operant": "packages_count", "operator": "<=", "value": 999 } ], "ShipperGroupName": "UPS" }, "image": "/img/versandrechner/tarife/upsneu.png", "shopName": "UPS Access Point", "shopsName": "PaketShops", "hasShopFinder": true, "dates": { "pickup": { "date": "2026-10-26", "dateFormat": "26.10.2026", "day": 26, "dayFormat": "Montag", "dayFormatShort": "Mo", "month": "Okt", "monthFormat": "Oktober", "dateFormatShort": "Mo., 26 Okt.", "min_pickup_date": "2026-10-26" }, "transit_time_min": { "date": "2026-10-28", "dateFormat": "28.10.2026", "day": 28, "dayFormatShort": "Mi", "month": "Okt" }, "transit_time_max": { "date": "2026-11-03", "dateFormat": "03.11.2026", "day": 3, "dayFormat": "Dienstag", "dayFormatShort": "Di", "month": "Nov", "monthFormat": "November" }, "delivery": { "timeUntilFormat": "16:00", "day": "28 - 3", "dayFormat": "Mi / Di", "monthFormat": "Okt / Nov", "dateFormatShort": "Mi., 28 Okt. - Di., 3 Nov.", "timeUntilMinutes": 960 }, "transit_time_range": { "days": "2-6", "daysString": "Arbeitstage", "daysStringShort": "Tage" } }, "sliderDraggableRangeInt": 0, "deliveryMaxDaysFromNowOrder": 2.06, "deliveryTimeUntilInMinutes": 960, "printerIsRequired": 1, "tax_free": true, "tax_free_reason": "third_country_transfer", "tax_rate": null, "tax_name": "MwSt.", "tax_countryCode": null, "hasAreaSurcharge": false, "extra_export_license_price_brutto": 59.49, "extra_insurance_value": 0, "extra_insurance_price_netto": 0, "extra_insurance_price_brutto": 0, "extra_export_license_price_brutto_old": 69.99, "extra_export_license_price_brutto_diff": 11, "extra_export_license_price_brutto_diff_percent": 16, "details": { "extra_insurance_type": "none" }, "standard_special_badge_text": "", "premium_special_badge_text": "", "uvp_insurance_standard_discount_percentage": 0, "uvp_insurance_premium_discount_percentage": 0, "extra_insurance_price_brutto_preselect": 7.99, "extra_insurance_premium_price_brutto_preselect": 11.99, "uvp_extra_insurance_price_brutto_preselect": 7.99, "uvp_extra_insurance_premium_price_brutto_preselect": 11.99, "insurance_value": 510, "price_netto_uvp": 471.7, "price_brutto_uvp": 471.7, "marketing_discount_title": null, "marketing_discount_description": null, "uvp_discount_value": 0, "uvp_discount_percent": 0, "uvp_discount_type": "customer", "requestType": "m", "is_jumingo_express": false, "best_offer_best_price_order": 11, "offer_valid_until": "2026-10-26 23:55:00" }, { "price_netto": 482.38, "price_brutto": 482.38, "packages": [ { "packageId": 0, "volumeWeight": 0.0048 } ], "id": 280, "shipper_id": 123, "tariff_type_id": 2, "dispatch_id": 1, "package_type_ids": "7,9,11,14", "country_id": 54, "transfer": "export", "printer_required": 1, "from_company_only": 0, "to_company_only": 0, "from_private_only": 0, "to_private_only": 0, "from_phone_number_required": 0, "to_phone_number_required": 0, "hs_tariff_number_required": 0, "api_type": "dhl-express_new", "calculate_volume_weight": 1, "volume_weight_factor": 5000, "marketing_discount": null, "marketing_discount_valid_until": null, "delivery_on_saturday": 0, "guaranteed_delivery_date": 1, "loading_aid": 0, "best_offer_order": 30, "environmentally_friendly_order": 50, "marketing_discount_type": "normal", "marketing_discount_countdown_time_from": "07:00:00", "marketing_discount_countdown_time_until": "15:00:00", "insurance_included_max_value_api": 0, "delivery_time_until_api": "16:00:00", "pickup_time_from_api": "09:00:00", "pickup_time_until_api": "17:00:00", "daily_auto_scheduled_pickup_required": 0, "is_plus_product": false, "is_trackable_product": true, "is_insurable_product": true, "parcel_content_required": 0, "settings": [], "shipper_tariff_id": 280, "name": "DHL EXPRESS WORLDWIDE", "shipper_tariff_zone_id": 1469, "transit_time_min": 2, "transit_time_max": 2, "delivery_time_until": "15:00:00", "store_delivery": 0, "pickup_surcharge": 0, "shipper_tariff_zone_country_id": 14644, "shippingType": 1, "currency": "EUR", "individual_customer_tariff": false, "external_tariff": false, "total_weight": 6, "shipper_group_id": 2, "shipper": { "name": "ENVIORO - DHL EXPRESS INTERNATIONAL", "tracking_link": "http://www.dhl.com/en/express/tracking.html?AWB=", "agb_link": "https://www.dhl.de/content/dam/images/Express/downloads/geschaeftsbedingungen-und-preise/geschaeftsbedingungen/dhl-express-atb-international-201702.pdf", "transit_time_link": "http://dct.dhl.com/input.jsp?langId=de", "limits": [ { "operant": "weight", "operator": "<=", "value": 70 }, { "operant": "first_length", "operator": "<=", "value": 175 } ], "ShipperGroupName": "DHL Express" }, "image": "/img/versandrechner/tarife/dhlexpress.png", "dates": { "pickup": { "date": "2026-10-26", "dateFormat": "26.10.2026", "day": 26, "dayFormat": "Montag", "dayFormatShort": "Mo", "month": "Okt", "monthFormat": "Oktober", "dateFormatShort": "Mo., 26 Okt.", "timeFrom": "09:30", "timeFromFormat": "09:30", "timeUntil": "16:00", "timeUntilFormat": "16:00", "min_pickup_date": "2026-10-26", "pickupTimeMinPeriodMinutes": 120, "timeFromMinutes": 570, "timeUntilMinutes": 960 }, "transit_time_min": { "date": "2026-10-28", "dateFormat": "28.10.2026", "day": 28, "dayFormatShort": "Mi", "month": "Okt" }, "transit_time_max": { "date": "2026-10-28", "dateFormat": "28.10.2026", "day": 28, "dayFormat": "Mittwoch", "dayFormatShort": "Mi", "month": "Okt", "monthFormat": "Oktober" }, "delivery": { "timeUntilFormat": "16:00", "day": 28, "dayFormat": "Mi", "monthFormat": "Oktober", "dateFormatShort": "Mi., 28 Okt.", "timeUntilMinutes": 960 }, "transit_time_range": { "days": 2, "daysString": "Arbeitstage", "daysStringShort": "Tage" } }, "pickupSliderUsed": false, "pickupSliderUsedMessageShown": false, "sliderDraggableRange": true, "sliderDraggableRangeInt": 1, "same_day_pickup": true, "has_pickup_surcharge": false, "deliveryMaxDaysFromNowOrder": 2, "deliveryTimeUntilInMinutes": 960, "printerIsRequired": 1, "tax_free": true, "tax_free_reason": "third_country_transfer", "tax_rate": null, "tax_name": "MwSt.", "tax_countryCode": null, "hasAreaSurcharge": false, "extra_export_license_price_brutto": 59.49, "extra_insurance_value": 0, "extra_insurance_price_netto": 0, "extra_insurance_price_brutto": 0, "extra_export_license_price_brutto_old": 69.99, "extra_export_license_price_brutto_diff": 11, "extra_export_license_price_brutto_diff_percent": 16, "details": { "extra_insurance_type": "none" }, "standard_special_badge_text": "", "premium_special_badge_text": "", "uvp_insurance_standard_discount_percentage": 0, "uvp_insurance_premium_discount_percentage": 0, "extra_insurance_price_brutto_preselect": 7.99, "extra_insurance_premium_price_brutto_preselect": 11.99, "uvp_extra_insurance_price_brutto_preselect": 7.99, "uvp_extra_insurance_premium_price_brutto_preselect": 11.99, "insurance_value": 0, "price_netto_uvp": 482.38, "price_brutto_uvp": 482.38, "marketing_discount_title": null, "marketing_discount_description": null, "uvp_discount_value": 0, "uvp_discount_percent": 0, "uvp_discount_type": "customer", "requestType": "m", "is_jumingo_express": false, "best_offer_best_price_order": 4, "pickupTimeFromMinutesSelected": 510, "offer_valid_until": "2026-10-26 09:19:59" }, { "price_netto": 621.98, "price_brutto": 621.98, "packages": [ { "packageId": 0, "volumeWeight": 0.0048 } ], "id": 285, "shipper_id": 117, "tariff_type_id": 2, "dispatch_id": 1, "package_type_ids": "7,9,11,14", "country_id": 54, "transfer": "export", "printer_required": 1, "from_company_only": 0, "to_company_only": 0, "from_private_only": 0, "to_private_only": 0, "from_phone_number_required": 0, "to_phone_number_required": 0, "hs_tariff_number_required": 0, "api_type": "ups_new", "calculate_volume_weight": 1, "volume_weight_factor": 5000, "marketing_discount": null, "marketing_discount_valid_until": null, "delivery_on_saturday": 0, "guaranteed_delivery_date": 0, "loading_aid": 0, "best_offer_order": 50, "environmentally_friendly_order": 50, "marketing_discount_type": "normal", "marketing_discount_countdown_time_from": "07:00:00", "marketing_discount_countdown_time_until": "21:59:00", "insurance_included_max_value_api": 0, "delivery_time_until_api": "16:00:00", "pickup_time_from_api": "09:00:00", "pickup_time_until_api": "17:00:00", "daily_auto_scheduled_pickup_required": 0, "is_plus_product": false, "is_trackable_product": true, "is_insurable_product": true, "parcel_content_required": 0, "settings": [], "shipper_tariff_id": 285, "name": "UPS EXPEDITED ®", "shipper_tariff_zone_id": 1500, "transit_time_min": 2, "transit_time_max": 5, "delivery_time_until": "15:00:00", "store_delivery": 1, "pickup_surcharge": 0, "shipper_tariff_zone_country_id": 15261, "shippingType": 1, "currency": "EUR", "individual_customer_tariff": false, "external_tariff": false, "total_weight": 6, "shipper_group_id": 1, "shipper": { "name": "UPS EXPEDITED", "tracking_link": "http://wwwapps.ups.com/WebTracking/processInputRequest?sort_by=status&tracknums_displayed=1&TypeOfInquiryNumber=T&loc=de_DE&InquiryNumber=", "agb_link": "https://www.ups.com/media/de/terms_carriage_ger.pdf", "transit_time_link": "https://wwwapps.ups.com/ctc/request?loc=de_DE", "limits": [ { "operant": "girth", "operator": "<=", "value": 419 }, { "operant": "weight", "operator": "<=", "value": 70 }, { "operant": "first_length", "operator": "<=", "value": 269 } ], "ShipperGroupName": "UPS" }, "image": "/img/versandrechner/tarife/upsneu.png", "shopName": "UPS Access Point", "shopsName": "PaketShops", "hasShopFinder": true, "dates": { "pickup": { "date": "2026-10-26", "dateFormat": "26.10.2026", "day": 26, "dayFormat": "Montag", "dayFormatShort": "Mo", "month": "Okt", "monthFormat": "Oktober", "dateFormatShort": "Mo., 26 Okt.", "timeFrom": "09:30", "timeFromFormat": "09:30", "timeUntil": "16:00", "timeUntilFormat": "16:00", "min_pickup_date": "2026-10-26", "pickupTimeMinPeriodMinutes": 120, "timeFromMinutes": 570, "timeUntilMinutes": 960 }, "transit_time_min": { "date": "2026-10-28", "dateFormat": "28.10.2026", "day": 28, "dayFormatShort": "Mi", "month": "Okt" }, "transit_time_max": { "date": "2026-11-02", "dateFormat": "02.11.2026", "day": 2, "dayFormat": "Montag", "dayFormatShort": "Mo", "month": "Nov", "monthFormat": "November" }, "delivery": { "timeUntilFormat": "16:00", "day": "28 - 2", "dayFormat": "Mi / Mo", "monthFormat": "Okt / Nov", "dateFormatShort": "Mi., 28 Okt. - Mo., 2 Nov.", "timeUntilMinutes": 960 }, "transit_time_range": { "days": "2-5", "daysString": "Arbeitstage", "daysStringShort": "Tage" } }, "pickupSliderUsed": false, "pickupSliderUsedMessageShown": false, "sliderDraggableRange": true, "sliderDraggableRangeInt": 1, "same_day_pickup": true, "has_pickup_surcharge": false, "deliveryMaxDaysFromNowOrder": 2.05, "deliveryTimeUntilInMinutes": 960, "printerIsRequired": 1, "tax_free": true, "tax_free_reason": "third_country_transfer", "tax_rate": null, "tax_name": "MwSt.", "tax_countryCode": null, "hasAreaSurcharge": false, "extra_export_license_price_brutto": 59.49, "extra_insurance_value": 0, "extra_insurance_price_netto": 0, "extra_insurance_price_brutto": 0, "extra_export_license_price_brutto_old": 69.99, "extra_export_license_price_brutto_diff": 11, "extra_export_license_price_brutto_diff_percent": 16, "details": { "extra_insurance_type": "none" }, "standard_special_badge_text": "", "premium_special_badge_text": "", "uvp_insurance_standard_discount_percentage": 0, "uvp_insurance_premium_discount_percentage": 0, "extra_insurance_price_brutto_preselect": 7.99, "extra_insurance_premium_price_brutto_preselect": 11.99, "uvp_extra_insurance_price_brutto_preselect": 7.99, "uvp_extra_insurance_premium_price_brutto_preselect": 11.99, "insurance_value": 510, "price_netto_uvp": 621.98, "price_brutto_uvp": 621.98, "marketing_discount_title": null, "marketing_discount_description": null, "uvp_discount_value": 0, "uvp_discount_percent": 0, "uvp_discount_type": "customer", "requestType": "m", "is_jumingo_express": false, "best_offer_best_price_order": 12, "pickupTimeFromMinutesSelected": 510, "offer_valid_until": "2026-10-26 09:19:59" }, { "price_netto": 621.98, "price_brutto": 621.98, "packages": [ { "packageId": 0, "volumeWeight": 0.0048 } ], "id": "s-285", "shipper_id": 117, "tariff_type_id": 2, "dispatch_id": 1, "package_type_ids": "7,9,11,14", "country_id": 54, "transfer": "export", "printer_required": 1, "from_company_only": 0, "to_company_only": 0, "from_private_only": 0, "to_private_only": 0, "from_phone_number_required": 0, "to_phone_number_required": 0, "hs_tariff_number_required": 0, "api_type": "ups_new", "calculate_volume_weight": 1, "volume_weight_factor": 5000, "marketing_discount": null, "marketing_discount_valid_until": null, "delivery_on_saturday": 0, "guaranteed_delivery_date": 0, "loading_aid": 0, "best_offer_order": 50, "environmentally_friendly_order": 50, "marketing_discount_type": "normal", "marketing_discount_countdown_time_from": "07:00:00", "marketing_discount_countdown_time_until": "21:59:00", "insurance_included_max_value_api": 0, "delivery_time_until_api": "16:00:00", "pickup_time_from_api": "09:00:00", "pickup_time_until_api": "17:00:00", "daily_auto_scheduled_pickup_required": 0, "is_plus_product": false, "is_trackable_product": true, "is_insurable_product": true, "parcel_content_required": 0, "settings": [], "shipper_tariff_id": 285, "name": "UPS EXPEDITED ®", "shipper_tariff_zone_id": 1500, "transit_time_min": 2, "transit_time_max": 6, "delivery_time_until": "15:00:00", "store_delivery": 1, "pickup_surcharge": 0, "shipper_tariff_zone_country_id": 15261, "shippingType": 2, "currency": "EUR", "individual_customer_tariff": false, "external_tariff": false, "total_weight": 6, "shipper_group_id": 1, "shipper": { "name": "UPS EXPEDITED", "tracking_link": "http://wwwapps.ups.com/WebTracking/processInputRequest?sort_by=status&tracknums_displayed=1&TypeOfInquiryNumber=T&loc=de_DE&InquiryNumber=", "agb_link": "https://www.ups.com/media/de/terms_carriage_ger.pdf", "transit_time_link": "https://wwwapps.ups.com/ctc/request?loc=de_DE", "limits": [ { "operant": "girth", "operator": "<=", "value": 330 }, { "operant": "weight", "operator": "<=", "value": 20 }, { "operant": "first_length", "operator": "<=", "value": 80 }, { "operant": "packages_count", "operator": "<=", "value": 999 } ], "ShipperGroupName": "UPS" }, "image": "/img/versandrechner/tarife/upsneu.png", "shopName": "UPS Access Point", "shopsName": "PaketShops", "hasShopFinder": true, "dates": { "pickup": { "date": "2026-10-26", "dateFormat": "26.10.2026", "day": 26, "dayFormat": "Montag", "dayFormatShort": "Mo", "month": "Okt", "monthFormat": "Oktober", "dateFormatShort": "Mo., 26 Okt.", "min_pickup_date": "2026-10-26" }, "transit_time_min": { "date": "2026-10-28", "dateFormat": "28.10.2026", "day": 28, "dayFormatShort": "Mi", "month": "Okt" }, "transit_time_max": { "date": "2026-11-03", "dateFormat": "03.11.2026", "day": 3, "dayFormat": "Dienstag", "dayFormatShort": "Di", "month": "Nov", "monthFormat": "November" }, "delivery": { "timeUntilFormat": "16:00", "day": "28 - 3", "dayFormat": "Mi / Di", "monthFormat": "Okt / Nov", "dateFormatShort": "Mi., 28 Okt. - Di., 3 Nov.", "timeUntilMinutes": 960 }, "transit_time_range": { "days": "2-6", "daysString": "Arbeitstage", "daysStringShort": "Tage" } }, "sliderDraggableRangeInt": 0, "deliveryMaxDaysFromNowOrder": 2.06, "deliveryTimeUntilInMinutes": 960, "printerIsRequired": 1, "tax_free": true, "tax_free_reason": "third_country_transfer", "tax_rate": null, "tax_name": "MwSt.", "tax_countryCode": null, "hasAreaSurcharge": false, "extra_export_license_price_brutto": 59.49, "extra_insurance_value": 0, "extra_insurance_price_netto": 0, "extra_insurance_price_brutto": 0, "extra_export_license_price_brutto_old": 69.99, "extra_export_license_price_brutto_diff": 11, "extra_export_license_price_brutto_diff_percent": 16, "details": { "extra_insurance_type": "none" }, "standard_special_badge_text": "", "premium_special_badge_text": "", "uvp_insurance_standard_discount_percentage": 0, "uvp_insurance_premium_discount_percentage": 0, "extra_insurance_price_brutto_preselect": 7.99, "extra_insurance_premium_price_brutto_preselect": 11.99, "uvp_extra_insurance_price_brutto_preselect": 7.99, "uvp_extra_insurance_premium_price_brutto_preselect": 11.99, "insurance_value": 510, "price_netto_uvp": 621.98, "price_brutto_uvp": 621.98, "marketing_discount_title": null, "marketing_discount_description": null, "uvp_discount_value": 0, "uvp_discount_percent": 0, "uvp_discount_type": "customer", "requestType": "m", "is_jumingo_express": false, "best_offer_best_price_order": 13, "offer_valid_until": "2026-10-26 23:55:00" } ], "fromCountryCode": "DE", "toCountryCode": "AE", "pickupCountryHolidays": [], "insurance": { "national": { "percent": 1.5, "min": 3.99, "maxInsuranceValue": 50000, "minGross": 3.99 }, "international": { "percent": 2.5, "min": 7.99, "maxInsuranceValue": 50000, "minGross": 7.99 }, "national_premium": { "percent": 2, "min": 7.99, "maxInsuranceValue": 50000, "minGross": 7.99 }, "international_premium": { "percent": 3, "min": 11.99, "maxInsuranceValue": 50000, "minGross": 11.99 }, "insurance_provider": "Kravag", "proformaInvoiceValue": 1.99, "liabilityValue": 10 }, "exportDeclaration": { "export_declaration_price": 49.95, "export_declaration_price_old": 59.95, "export_declaration_price_diff": 10, "export_declaration_price_diff_percent": 17 }, "apiTariffMode": null, "isSearchRequest": false, "packagingTypeId": 7, "pickupDateMode": null, "details": { "email": "user0@jumingo.dev" }, "pickupDate": null, "deliveryDate": null, "filterData": null, "billing": { "company": "Jumingo Inc.", "name": "Ajax", "street": "Kürfürstendamm 32", "street2": "Alexanderplatz", "zip": "12345", "city": "Berlin", "state": null, "country": "DE", "phone": "380432144556" }, "from": { "company": "Europa-Park", "name": "Euro Mouse", "street": "Europa-Park-Str. 2", "street2": null, "zip": "77977", "city": "Rust", "state": null, "country": "DE", "phone": "07822776688" }, "to": { "company": "Test Corp.", "name": "John Doe", "street": "1 Sheikh Mohammed bin Rashid Blvd", "street2": null, "zip": null, "city": "Dubai", "state": null, "country": "AE", "phone": "1234567890" }, "packages": [], "packagesInfo": [ { "weight": 6, "width": 3, "length": 2, "height": 4, "type": 1, "first_length": 4, "second_length": 3, "shortest_and_longest_side": 6, "girth": 14, "length_sum": 9, "quantity": 1 } ], "tariff": null, "summary": { "taxFree": true, "tax": { "rate": null, "name": "MwSt." }, "packageAll": false, "package": { "height": 4, "width": 3, "length": 2, "weight": 6 }, "maxPrice": 621.98, "minPrice": 96.37, "maxPriceNet": 621.98, "minPriceNet": 96.37 }, "tariffTypes": [ { "id": 4, "name": "Same Day" }, { "id": 2, "name": "Express" }, { "id": 5, "name": "Economy" }, { "id": 1, "name": "Standard " } ], "packageTypes": [ { "id": 1, "name": "Dokument", "description": { "name": "" }, "machineName": "document" }, { "id": 7, "name": "Paket", "description": { "name": "

Ein normaler quaderförmiger Karton, der stapelbar ist.

" }, "machineName": "parcel" }, { "id": 9, "name": "Sperrgut", "description": { "name": "

Bitte wählen Sie diesen Verpackungstyp, sofern Sie nicht sortierfähige Güter versenden möchten. 

\r\n

Dies betrifft zum Beispiel:

\r\n

Säcke, Holzkisten, Plastikeimer, Kanister, Pakete mit herausragenden Teilen, Stoffballen etc...

" }, "machineName": "bulk" }, { "id": 10, "name": "Palette", "description": { "name": "

Euro- oder Einwegpalette

\r\n

Die Palette muss von einer Person unter Zuhilfenahme eines Standardgabelhubwagens zu bewegen sein.

" }, "machineName": "pallet" }, { "id": 15, "name": "Nicht stapelbare Palette", "description": { "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." }, "machineName": "n_s_pallet" }, { "id": 11, "name": "Reifen", "description": { "name": "

Nicht im Karton verpackte Reifen (Reifen nur mit Folie umwickelt)

" }, "machineName": "tires" }, { "id": 14, "name": "Koffer", "description": { "name": "

Alle Koffer oder Reisetaschen  die nicht im Karton verpackt sind

" }, "machineName": "suitcase" } ], "quickFilters": [ { "property": null, "id": "export_license", "name": "Inkl. Ausfuhranmeldung", "icon": null, "order": -1, "permanent": false, "extended": true }, { "id": 1, "property": "shippingType", "name": "Nur Abholung", "icon": null, "order": 5, "permanent": true, "extended": true }, { "id": 3, "property": "options", "name": "Abholung heute", "icon": null, "order": 10, "permanent": true, "extended": true }, { "id": 2, "property": "tariffTypes", "name": "Express", "icon": null, "order": 15, "permanent": true, "extended": true }, { "id": 1, "property": "options", "name": "Kein Drucker", "icon": null, "order": 19, "permanent": true, "extended": true }, { "id": 1, "property": "shipperGroups", "name": "UPS", "icon": "UPS", "order": 20, "permanent": true, "extended": true }, { "id": 2, "property": "shipperGroups", "name": "DHL Express", "icon": "DHL-Express", "order": 25, "permanent": true, "extended": true }, { "id": 5, "property": "shipperGroups", "name": "TNT", "icon": "TNT", "order": 30, "permanent": true, "extended": true }, { "id": 29, "property": "shipperGroups", "name": "FedEx", "icon": "FedEx-not-tariff", "order": 40, "permanent": true, "extended": true } ], "serviceOptions": [], "seoData": false } }, "request-cart-total": { "summary": "Totals for two shipments with a voucher", "value": { "shipmentIds": [ "s_2b28a63d65684f0aa4bcca24dafdc9df", "s_ca213cb9368c412291b8441c90c95592" ], "voucherCode": "XmasDiscount" } }, "cart-total": { "summary": "Totals and payment methods for one shipment", "value": { "total": { "id": 1, "tax": 0, "taxNet": 0, "taxFreeNet": 0, "taxes": [], "taxDefaultName": "MwSt.", "taxId": "DE293163480", "voucherValue": 0, "voucherPercent": 0, "voucherCode": "", "voucherType": "", "voucherOrderNumbers": "", "voucherErrorMessage": null, "gross": 0, "subtotal": 0, "surcharges": 0, "plusProductSurcharges": { "id": 1, "minSurcharge": 0.42, "percentSurcharge": 10, "price": 0.49, "currency": "EUR" }, "subtotalNet": 0, "surchargesNet": 0, "totalNet": 0, "totalNetVoucher": 0, "shippingCostsNet": 0, "shippingCosts": 0, "additionalServices": 0, "additionalServicesSeparately": { "standard_insurance_total": 0, "standard_insurance_total_uvp": 0, "premium_insurance_total": 0, "premium_insurance_total_uvp": 0, "export_declaration_total": 0, "export_declaration_total_uvp": 0, "shipping_costs_total_uvp": 0 } }, "paymentMethods": [], "shipments": [ { "id": "s_21b7f7ad8a584fce9f776b9cf6004711", "customer_number": 200002, "customer_personal_name": null, "customer_initials": null, "created": "2026-10-21 10:40:31", "last_modified": "2026-10-21 10:40:39", "internal_status": "open", "status": "delivered", "isCancellationPossible": false, "source": null, "from_address": { "company": "Jumingo", "name": "John Doe", "country": "DE", "id": 1576, "street": "100 West 33rd Street", "street2": "Apt 123", "zip": "10011", "city": "Berlin", "state": null, "phone": "1234567190", "settings": null }, "to_address": { "company": "Grid Corp.", "name": "John Doe", "country": "US", "id": 1579, "street": "100 West 33rd Street", "street2": "Apt 123", "zip": "10021", "city": "New York", "state": "NY", "phone": "1234557890", "settings": null }, "billing_address": { "company": "Jumingo", "name": "John Doe", "country": "DE", "id": 1577, "street": "100 West 33rd Street", "street2": "Apt 123", "zip": "10011", "city": "Berlin", "state": null, "phone": "1234567190", "settings": null }, "details": { "value_amount": 999, "value_currency": "EUR", "content_description": "PS-5", "reference_number": "my-reference-1", "email": "email@example.org", "email_tracking": "email@example.org", "email_label_copy": "email@example.org", "insurance_amount": 25, "insurance_currency": "EUR", "extra_insurance_price_netto": 0, "extra_insurance_price_brutto": 0, "extra_insurance_value": 0, "extra_insurance_type": null, "extra_insurance_provider": null, "export_license": true, "export_license_price_brutto": 0, "shipment_order_number": "A-2024010311-1", "shipment_order_number_short": "2024010311-1", "packaging_type": "parcel", "hs_tariff_number": "qqqqqqqq", "extra_export_license_number": null, "settings": { "tariff": { "distance": null, "settings": { "is_cin": true, "is_green_tariff": true, "is_tariff_weight_dependent": true }, "loading_aid": 30, "delivery_date": "2026-11-20", "pickup_max_time": "2024-08-06 16:00:00", "pickup_min_time": "2024-08-06 12:45:00", "price_netto_uvp": 47.45, "same_day_pickup": true, "price_brutto_uvp": 47.45, "marketing_discount": 0, "uvp_discount_value": 0, "uvp_discount_percent": 0, "calculate_volume_weight": 1, "individual_customer_tariff": false, "marketing_discount_description": null, "extra_export_license_price_brutto_old": 59.95, "uvp_extra_insurance_price_brutto_preselect": 70.8, "uvp_extra_insurance_premium_price_brutto_preselect": 106.2 }, "offer_valid_until": "2024-08-06 14:34:59", "use_commercial_invoice": false } }, "customs_invoice": { "invoiceNumber": "AAAAAAAAAA", "invoiceDate": "2023-12-12", "currency": "USD", "exportReason": "Gift", "remarks": null, "lineItems": [ { "id": 172, "content": "Qwert", "quantity": 3, "unitOfMeasurement": "L", "netWeight": 89, "value": 999, "hsTariffNumber": null, "manufacturingCountry": null, "merchantProductId": null, "manufacturerProductId": null, "standardizedProductId": null } ], "useJumingoCommercialInvoice": false, "discount": null, "shippingCosts": null, "insuranceCosts": null, "goodsValue": 2997, "effectiveShippingCosts": 59.5, "effectiveInsuranceCosts": 0, "totalInvoiceAmount": 3056.5 }, "packages": [ { "id": 326, "weight": 6, "length": 2, "width": 3, "height": 4, "volume_weight": 0.0048, "girth": 14, "first_length": 4, "second_length": 3, "type": "parcel", "type_id": 7, "name": "2024010311-1", "api_shipment_ids": null, "quantity": 1 } ], "connection": null, "rate": { "carrier": { "shipper_group_id": 2, "shipper_group_name": "DHL Express", "shipper_id": 129, "shipper_tariff_id": 522, "shipper_tariff_full_id": "522", "shipper_tariff_type_id": 5, "shipper_tariff_type_name": "Economy", "shipper_tariff_zone_id": 2845, "limits": [] }, "service": { "name": "DPD CLASSIC NATIONAL", "description": null, "image": "/img/versandrechner/tarife/dhlexpress.svg", "dispatch_id": 1, "agb_link": "https://www.dhl.de/content/dam/images/Express/downloads/geschaeftsbedingungen-und-preise/geschaeftsbedingungen/dhl-express-atb-international-062019.pdf", "is_plus_product": false, "is_trackable_product": true, "is_insurable_product": true, "has_shop_finder": false }, "shipping_type": "pickup", "transit_time_range_days": "2", "max_liability": 25, "max_included_liability_currency": "EUR", "printer_required": true, "parcel_content_required": false, "from_company_only": false, "to_company_only": false, "from_private_only": false, "to_private_only": false, "from_phone_number_required": true, "to_phone_number_required": false, "hs_tariff_number_required": false, "price_net": 47.45, "price_net_currency": "EUR", "price_total": 47.45, "price_total_currency": "EUR", "tax_free": true, "tax_rate": 0, "tax_country": "", "tax_name": "MwSt.", "pickup_date": "2024-08-06", "pickup_min_time": "2024-08-06 14:45:00", "pickup_max_time": "2024-08-06 18:00:00", "pickup_reference_number": "135855S5SSCP", "delivery_date_min": "2024-08-08T02:00:00Z", "delivery_date_max": "2024-08-08T02:00:00Z", "delivery_time_until": "2024-08-08 17:00:00", "distance": 0, "distanceFormatted": null, "durationFormatted": "2 Arbeitstage", "carType": null, "jumingo_express_carrier": null, "is_jumingo_express": false, "jum_disp": false, "marketing_discount": 0, "marketing_discount_description": null, "uvp_discount_value": 0, "uvp_discount_percent": 0, "uvp_extra_insurance_price_brutto_preselect": 70.8, "uvp_extra_insurance_premium_price_brutto_preselect": 106.2, "extra_export_license_price_brutto_old": 59.95, "price_brutto_uvp": 47.45, "price_netto_uvp": 47.45 }, "tracking": { "data": { "version": "1.0", "tracking_number": "3384299634", "status": "new", "status_text": "Daten übermittelt", "from": null, "to": null, "carrier": { "code": "dhl", "name": "DHL", "image": "/cms/Carrier_dhl_express_tracking_1617955411.svg", "phone": "+ 49 (0)180 6 345 300-1", "id": 1 }, "steps": [], "stepDates": [], "dates": { "created": "2024-02-01 17:05:06", "modified": null, "last_updated": "2024-02-01 17:05:06", "status_changed": "2024-01-08 01:00:00" }, "infos": [], "progress": [], "carrierList": null }, "active": 0, "status": "success", "progress": { "percent": 0, "points": { "in_system": false, "in_transit": false, "in_delivery": false, "undelivered": false, "exception": false, "completed": false, "parcel_shop": false }, "class": "" }, "carrierTrackingPage": "http://www.dhl.com/en/express/tracking.html?AWB=TN-12345", "implementationType": "direct_api" }, "tax_free_reason": "third_country_transfer", "tax_id": null, "import_status": "completed", "import_progress_status": "", "import_checkout_id": null, "order": { "number": "2024010311", "unpaid": null, "canceled": null, "created": "2026-10-21 08:40:32" }, "import_messages": { "parcel": { "hs_tariff_number": { "required": { "oldValue": null, "label": "HS-Tarifnummer" } } }, "addresses": { "pickup": [], "delivery": [], "return": [], "billing": [] }, "details": [], "packages": [ [] ], "customsInvoice": { "lineItems": [ { "hs_tariff_number": { "invalid": { "oldValue": null }, "empty_not_allowed": { "oldValue": null } }, "manufacturing_country": { "empty_not_allowed": { "oldValue": null } } } ] } }, "import_messages_text": null, "type": 2, "canceled": false, "dates": { "pickup": { "date": "2024-08-06", "day_format": "Tuesday", "day_format_short": "Tue", "date_format_short": "Tue 6 Aug", "month": "Aug", "month_format": "August", "min_pickup_date": "2026-10-26", "pickup_min_time": "14:45", "pickup_max_time": "18:00", "pickup_min_time_minutes": 885, "pickup_max_time_minutes": 1080 }, "transit_date_min": { "date": "2024-08-08", "day_format": "Thursday", "day_format_short": "Thu", "month": "Aug", "month_format": "August" }, "transit_date_max": { "date": "2024-08-08", "day_format": "Thursday", "day_format_short": "Thu", "month": "Aug", "month_format": "August" }, "delivery": { "time_until_format": "5:00 PM", "time_until_minutes": 1020, "day": "08", "day_format": "Thu", "month_format": "Aug", "min_delivery_date": "2024-08-08 00:00:00", "max_delivery_date": "2024-08-08 00:00:00", "date_format_short": "Thu., 8. Aug." }, "transit_time_range": { "days": "2", "days_string": "Arbeitstage", "days_string_short": "Tage" } }, "label_sent_on": null, "has_label": false, "label_generation_status": "waiting", "has_proforma": false, "has_export_cert_vat": false, "has_commercial_invoice": false, "has_export_declaration": false, "has_proof_of_export": false, "dates_aggregation": { "created": { "date": "2026-10-21", "time": "10:40:31", "minutes": 641 }, "last_modified": { "date": "2026-10-21", "time": "10:40:39", "minutes": 641 } }, "dates_in_the_past": true, "delayed": true, "settings": { "tariff": { "distance": null, "settings": { "is_cin": true, "is_green_tariff": true, "is_tariff_weight_dependent": true }, "loading_aid": 30, "delivery_date": "2026-11-20", "pickup_max_time": "2024-08-06 16:00:00", "pickup_min_time": "2024-08-06 12:45:00", "price_netto_uvp": 47.45, "same_day_pickup": true, "price_brutto_uvp": 47.45, "marketing_discount": 0, "uvp_discount_value": 0, "uvp_discount_percent": 0, "calculate_volume_weight": 1, "individual_customer_tariff": false, "marketing_discount_description": null, "extra_export_license_price_brutto_old": 59.95, "uvp_extra_insurance_price_brutto_preselect": 70.8, "uvp_extra_insurance_premium_price_brutto_preselect": 106.2 }, "offer_valid_until": "2024-08-06 14:34:59", "use_commercial_invoice": false }, "post_order_update_allowed": true, "export_cert_vat_possible": true, "picked_up": false, "update_ordered_delivery_address_allowed": false, "product_identifiers_required": false, "pickup_status": 0, "shipment_issues": [ { "issue_type": "todo", "reason": "cin_incomplete" } ], "export_declaration": null, "is_return_possible": true, "documents": { "proforma": null, "commercial_invoice": null, "export_declaration": null, "proof_of_export": null, "export_cert_vat": null } } ], "errorList": { "s_21b7f7ad8a584fce9f776b9cf6004711": [ "date_in_past", "time_in_past", "not_ready_status" ] }, "userTaxId": "TESTVATID" } }, "order-list": { "summary": "One page with one order", "value": [ { "accountOwner": "7eabed77-eb65-40be-a0b4-4c24a0eda784", "bic": "bic", "cancelOrderLink": "2/7", "created": "2026-10-21 10:40:32", "currency": "EUR", "currencyDetails": null, "customer": { "customerNumber": 200002, "addresses": [ { "id": 1148, "company": "Jumingo Inc.", "name": "Ajax", "street": "Kürfürstendamm 32", "street2": "Alexanderplatz", "zip": "12345", "city": "Berlin", "state": null, "country": "DE", "phone": "380432144556" } ] }, "discountPercent": 0, "documents": { "orderNumber": "2024010311", "id": "2024010311", "invoicesCount": 0, "proformasCount": 1, "commercialInvoicesCount": 0, "confirmationsCount": 1, "exportCertVatCount": 0, "invoices": [], "confirmations": [], "proformas": [], "labels": [], "exportCertVat": [], "commercialInvoices": [], "exportDeclarations": [] }, "gross": 2.1, "iban": "iban", "lastschriftmandat": "tt", "modified": "2026-10-21 10:40:32", "orderNumber": "B-2024010311", "paymentCreditcardNumber": null, "paymentData": null, "paymentDate": "2026-10-26 09:05:32", "paymentMethod": "creditcard", "paymentReceipt": 0, "paymentSurcharge": 0, "paymentTransactionId": null, "paypalEmail": "email", "paypalPuiAccountHolderName": null, "paypalPuiBankIdentifierCode": null, "paypalPuiBankName": null, "paypalPuiCurrency": null, "paypalPuiInternationalBankAccountNumber": null, "paypalPuiPaymentDueDate": null, "paypalPuiReferenceNumber": null, "paypalPuiValue": null, "paypalTransactionId": "transaction_id", "shipments": [ { "id": 333, "uuid": "s_21b7f7ad8a584fce9f776b9cf6004711", "orderShipmentNumber": "2024010311-1", "shipmentContent": "PS-5", "shipmentValue": 999, "trackingNumber": "TN-12345" } ], "sofortTransactionId": "transaction_id", "subtotal": 0, "surcharges": 0, "tax": 2.5, "taxFreeNet": 2.5, "taxNet": 2.5, "unpaid": true, "voucherCode": "", "voucherValue": 0, "voucherPercent": 0.1, "voucherType": "" } ] }, "request-payment": { "summary": "Pay by invoice", "value": { "method": "rechnung", "shipmentIds": [ "s_2b28a63d65684f0aa4bcca24dafdc9df" ] } }, "payment-result": { "summary": "A successful payment by invoice", "value": { "id": 1, "success": true, "returnUrl": null, "failureUrl": null, "message": null, "paymentRedirectUrl": null, "returnData": [], "orderNumber": "B-2024010311", "token": null, "customerNumber": 920119, "hadOrderBefore": true, "shipmentIds": [ "s_21b7f7ad8a584fce9f776b9cf6004711" ] } }, "order": { "summary": "A paid order with one shipment", "value": { "accountOwner": "7eabed77-eb65-40be-a0b4-4c24a0eda784", "bic": "bic", "cancelOrderLink": "2/7", "created": "2026-10-21 10:40:32", "currency": "EUR", "currencyDetails": null, "customer": { "customerNumber": 200002, "addresses": [ { "id": 1148, "company": "Jumingo Inc.", "name": "Ajax", "street": "Kürfürstendamm 32", "street2": "Alexanderplatz", "zip": "12345", "city": "Berlin", "state": null, "country": "DE", "phone": "380432144556" } ] }, "discountPercent": 0, "documents": { "orderNumber": "2024010311", "id": "2024010311", "invoicesCount": 0, "proformasCount": 1, "commercialInvoicesCount": 0, "confirmationsCount": 1, "exportCertVatCount": 0, "invoices": [], "confirmations": [], "proformas": [], "labels": [], "exportCertVat": [], "commercialInvoices": [], "exportDeclarations": [] }, "gross": 2.1, "iban": "iban", "lastschriftmandat": "tt", "modified": "2026-10-21 10:40:32", "orderNumber": "B-2024010311", "paymentCreditcardNumber": null, "paymentData": null, "paymentDate": "2026-10-26 09:05:32", "paymentMethod": "creditcard", "paymentReceipt": 0, "paymentSurcharge": 0, "paymentTransactionId": null, "paypalEmail": "email", "paypalPuiAccountHolderName": null, "paypalPuiBankIdentifierCode": null, "paypalPuiBankName": null, "paypalPuiCurrency": null, "paypalPuiInternationalBankAccountNumber": null, "paypalPuiPaymentDueDate": null, "paypalPuiReferenceNumber": null, "paypalPuiValue": null, "paypalTransactionId": "transaction_id", "shipments": [ { "id": 333, "uuid": "s_21b7f7ad8a584fce9f776b9cf6004711", "orderShipmentNumber": "2024010311-1", "shipmentContent": "PS-5", "shipmentValue": 999, "trackingNumber": "TN-12345" } ], "sofortTransactionId": "transaction_id", "subtotal": 0, "surcharges": 0, "tax": 2.5, "taxFreeNet": 2.5, "taxNet": 2.5, "unpaid": true, "voucherCode": "", "voucherValue": 0, "voucherPercent": 0.1, "voucherType": "" } }, "order-documents": { "summary": "Documents of an order", "value": { "invoicesCount": 0, "proformasCount": 1, "commercialInvoicesCount": 0, "confirmationsCount": 1, "exportCertVatCount": 0, "invoices": [], "confirmations": [], "proformas": [], "labels": [], "exportCertVat": [], "commercialInvoices": [], "exportDeclarations": [] } }, "connection-list": { "summary": "One page with one connection", "value": [ { "id": 90, "uuid": "s_c71525fb87f645ffbc126a7deec40001", "name": "Shop name", "customer": "/app/users/200002", "connectionType": "/app/connection-types/3", "active": 1, "lastSynced": null, "initSync": "0d", "syncPeriod": "0h", "sendTrackingMail": 0, "connectionDetails": { "settings": "settings", "shop_url": "https://www.example.org/", "plugin_name": "My shop plugin", "shop_version": "v1.0 beta", "plugin_version": "v1.1" }, "status": "new", "message": null, "webhookUrl": "https://www.example.org/", "deleted": 0, "receiveWebhook": false, "created": "2026-10-21T02:00:00Z", "modified": "2026-10-21T02:00:00Z" } ] }, "request-create-connection": { "summary": "Register a shop plugin", "value": { "name": "My shop", "type_id": 3, "webhook_url": "https://www.example.org/webhook", "shop_url": "https://www.example.org/", "shop_version": "v1.0", "plugin_name": "My shop plugin", "plugin_version": "v1.1", "settings": "settings" } }, "connection-created": { "summary": "The id of the new connection", "value": { "connection_uuid": "c_fafb10a828b242db9ac820d4d379686f" } }, "connection": { "summary": "A shop connection", "value": { "id": 90, "uuid": "s_c71525fb87f645ffbc126a7deec40001", "name": "Shop name", "customer": "/app/users/200002", "connectionType": "/app/connection-types/3", "active": 1, "lastSynced": null, "initSync": "0d", "syncPeriod": "0h", "sendTrackingMail": 0, "connectionDetails": { "settings": "settings", "shop_url": "https://www.example.org/", "plugin_name": "My shop plugin", "shop_version": "v1.0 beta", "plugin_version": "v1.1" }, "status": "new", "message": null, "webhookUrl": "https://www.example.org/", "deleted": 0, "receiveWebhook": false, "created": "2026-10-21T02:00:00Z", "modified": "2026-10-21T02:00:00Z" } }, "request-access-points": { "summary": "UPS access points around an address", "value": { "carrierCodes": [ "ups" ], "countryCode": "DE", "city": "Neuss", "postCode": "41460", "street": "Markt 2", "state": "", "radius": 10, "onlyOpen": false } }, "access-points": { "summary": "The carrier returned no access points and one error", "value": { "id": 1, "accessPoints": [], "errors": [ { "carrier": "ups", "messages": [ "UPS OAuthToken request got en error" ] } ] } } } } }