{ "openapi": "3.0.1", "info": { "title": "Client API", "description": "The Customer BFF Gateway API for integrating with the Nesy logistics platform.\n\nCovers the full shipment lifecycle — from creation and tracking to pickup scheduling, label printing, and cancellation. Also provides reference data lookups and account management.\n\n**Authentication:** All endpoints require a valid `apikey` query parameter.\n\n**Response format:** All endpoints return HTTP 200. The `status` field in the response body indicates the outcome: `0` = OK, `1` = Error, `2` = Validation Failed. See the `ClientApiErrorCodes` and `ClientApiValidationCodes` schemas (in the Schemas section below) for the full list of possible `Error.Code` and `Validations[]` codes and their meanings.\n\nSee the [Integration Flows](#tag-group/integration-flows) section for the recommended call order per shipment pathway.", "version": "v1" }, "paths": { "/parcelshops": { "get": { "tags": [ "LookupApi" ], "summary": "Get Parcel Shops", "description": "Returns available parcel shops for parcel shop delivery and pickups.", "parameters": [ { "name": "filter", "in": "query", "description": "Filter by type. Allowed values: 'locker', 'parcelshop'. Leave empty for all types.", "schema": { "type": "string" } }, { "name": "shortName", "in": "query", "description": "Filter by specific parcel shop ID.", "schema": { "type": "string" } }, { "name": "isActive", "in": "query", "description": "Filter by active status. True for active only, false for inactive only, null for all.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClientApiParcelShopsResultDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientApiParcelShopsResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientApiParcelShopsResultDto" } } } } } } }, "/getdeliverpoints": { }, "/places": { "get": { "tags": [ "LookupApi" ], "summary": "Get Available Places", "description": "Returns available locations where delivery is available.", "parameters": [ { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "zipcode", "in": "query", "schema": { "type": "string" } }, { "name": "approx", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClientAPIPlacesResultDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientAPIPlacesResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientAPIPlacesResultDto" } } } } } } }, "/layouts": { "get": { "tags": [ "LookupApi" ], "summary": "Layouts", "description": "Retrieves available layouts for printing labels and other shipment-related documents.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClientAPILayoutsResultDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientAPILayoutsResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientAPILayoutsResultDto" } } } } } } }, "/routinginfo": { "post": { "tags": [ "LookupApi" ], "summary": "Routing Info", "description": "Retrieves routing information for a shipment, including details on the shipment's journey and expected delivery time.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIRoutingInfoRequestDto" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIRoutingInfoRequestDto" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIRoutingInfoRequestDto" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIRoutingInfoRequestDto" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClientAPIRoutingInfoResultDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientAPIRoutingInfoResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientAPIRoutingInfoResultDto" } } } } } } }, "/deliverytime": { "post": { "tags": [ "LookupApi" ], "summary": "Get Delivery Times", "description": "Gets available delivery and pickup times, assisting in scheduling and planning shipments.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIGetDeliveryTimeRequestDto" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIGetDeliveryTimeRequestDto" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIGetDeliveryTimeRequestDto" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIGetDeliveryTimeRequestDto" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClientAPIGetDeliveryTimeResponseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientAPIGetDeliveryTimeResponseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientAPIGetDeliveryTimeResponseDto" } } } } } } }, "/checkcountryiseligible": { "post": { "tags": [ "LookupApi" ], "summary": "Check Country Eligibility", "description": "Checks whether a given country is eligible by its country short code.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CountryCodeRequestDto" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CountryCodeRequestDto" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CountryCodeRequestDto" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CountryCodeRequestDto" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClientAPICheckCountryEligibilityResultDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientAPICheckCountryEligibilityResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientAPICheckCountryEligibilityResultDto" } } } } } } }, "/requestpickupataddress": { "post": { "tags": [ "PickupApi" ], "summary": "Request Pickup At Address", "description": "Schedules a pickup request for shipments at a specified address. Returns a generated PDF pickup document. Only committed shipments can be picked up; shipments must be committed before a pickup can be requested. If ShipmentIDs in the body is empty or omitted, the pickup is created for all committed shipments that have not been picked up yet.", "parameters": [ { "name": "prefferedpickuptime", "in": "query", "description": "Preferred pickup time as a Unix timestamp in milliseconds. The system assigns the nearest available slot if the requested time is unavailable.", "schema": { "type": "string" } }, { "name": "copies", "in": "query", "description": "Number of pickup document PDF copies to generate. Defaults to 1.", "schema": { "type": "integer", "format": "int32" } }, { "name": "mini", "in": "query", "description": "When true, generates a mini-format pickup document PDF instead of the full-size version.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Pickup address and shipment list. ShipmentIDs must reference committed shipments; if omitted or empty, all committed shipments that have not been picked up yet are used.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIRequestPickUpAtAddress" } ] }, "examples": { "Pickup at specified address": { "summary": "Pickup at specified address", "value": { "ShipmentIDs": [ 1234567, 1234568 ], "PickupName": "Test Sender", "PickupCity": "ZAGREB", "PickupZipcode": "10000", "PickupStreetAndNumber": "Wolkrova 1124" } } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIRequestPickUpAtAddress" } ] }, "examples": { "Pickup at specified address": { "summary": "Pickup at specified address", "value": { "ShipmentIDs": [ 1234567, 1234568 ], "PickupName": "Test Sender", "PickupCity": "ZAGREB", "PickupZipcode": "10000", "PickupStreetAndNumber": "Wolkrova 1124" } } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIRequestPickUpAtAddress" } ] }, "examples": { "Pickup at specified address": { "summary": "Pickup at specified address", "value": { "ShipmentIDs": [ 1234567, 1234568 ], "PickupName": "Test Sender", "PickupCity": "ZAGREB", "PickupZipcode": "10000", "PickupStreetAndNumber": "Wolkrova 1124" } } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIRequestPickUpAtAddress" } ] }, "examples": { "Pickup at specified address": { "summary": "Pickup at specified address", "value": { "ShipmentIDs": [ 1234567, 1234568 ], "PickupName": "Test Sender", "PickupCity": "ZAGREB", "PickupZipcode": "10000", "PickupStreetAndNumber": "Wolkrova 1124" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClientAPIRequestPickupResultDto" }, "examples": { "Success": { "summary": "Pickup scheduled", "value": { "Status": 0, "Validations": [ ], "Shipmentids": [ 1234567, 1234568 ], "Pickupdocuments": [ "JVBERi0xLjQKJ...(base64-encoded PDF)" ], "Pickupintervals": [ ], "PickupIds": [ 9877 ], "error": null, "TraceID": "e6f4a5d7-4567-4d8e-8f01-4567890123de" } } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientAPIRequestPickupResultDto" }, "examples": { "Success": { "summary": "Pickup scheduled", "value": { "Status": 0, "Validations": [ ], "Shipmentids": [ 1234567, 1234568 ], "Pickupdocuments": [ "JVBERi0xLjQKJ...(base64-encoded PDF)" ], "Pickupintervals": [ ], "PickupIds": [ 9877 ], "error": null, "TraceID": "e6f4a5d7-4567-4d8e-8f01-4567890123de" } } } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientAPIRequestPickupResultDto" }, "examples": { "Success": { "summary": "Pickup scheduled", "value": { "Status": 0, "Validations": [ ], "Shipmentids": [ 1234567, 1234568 ], "Pickupdocuments": [ "JVBERi0xLjQKJ...(base64-encoded PDF)" ], "Pickupintervals": [ ], "PickupIds": [ 9877 ], "error": null, "TraceID": "e6f4a5d7-4567-4d8e-8f01-4567890123de" } } } } } } } } }, "/requestpickup": { "post": { "tags": [ "PickupApi" ], "summary": "Request Pickup", "description": "Schedules a pickup request for shipments and returns a generated PDF pickup document. Only committed shipments can be picked up; shipments must be committed before a pickup can be requested. If the request body is empty or omitted, the pickup is created for all committed shipments that have not been picked up yet.", "parameters": [ { "name": "prefferedpickuptime", "in": "query", "description": "Preferred pickup time as a Unix timestamp in milliseconds. The system assigns the nearest available slot if the requested time is unavailable.", "schema": { "type": "string" } }, { "name": "copies", "in": "query", "description": "Number of pickup document PDF copies to generate. Defaults to 1.", "schema": { "type": "integer", "format": "int32" } }, { "name": "mini", "in": "query", "description": "When true, generates a mini-format pickup document PDF instead of the full-size version.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "List of shipment IDs to include in the pickup. If the body is empty or omitted, the pickup is created for all committed shipments that have not been picked up yet.", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "examples": { "Pickup for all committed shipments": { "value": [ ] } } }, "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "examples": { "Pickup for all committed shipments": { "value": [ ] } } }, "text/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "examples": { "Pickup for all committed shipments": { "value": [ ] } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "examples": { "Pickup for all committed shipments": { "value": [ ] } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClientAPIRequestPickupResultDto" }, "examples": { "Success": { "summary": "Pickup scheduled", "value": { "Status": 0, "Validations": [ ], "Shipmentids": [ 1234567, 1234568 ], "Pickupdocuments": [ "JVBERi0xLjQKJ...(base64-encoded PDF)" ], "Pickupintervals": [ ], "PickupIds": [ 9876 ], "error": null, "TraceID": "d5e3f4c6-3456-4c7d-9def-3456789012cd" } } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientAPIRequestPickupResultDto" }, "examples": { "Success": { "summary": "Pickup scheduled", "value": { "Status": 0, "Validations": [ ], "Shipmentids": [ 1234567, 1234568 ], "Pickupdocuments": [ "JVBERi0xLjQKJ...(base64-encoded PDF)" ], "Pickupintervals": [ ], "PickupIds": [ 9876 ], "error": null, "TraceID": "d5e3f4c6-3456-4c7d-9def-3456789012cd" } } } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientAPIRequestPickupResultDto" }, "examples": { "Success": { "summary": "Pickup scheduled", "value": { "Status": 0, "Validations": [ ], "Shipmentids": [ 1234567, 1234568 ], "Pickupdocuments": [ "JVBERi0xLjQKJ...(base64-encoded PDF)" ], "Pickupintervals": [ ], "PickupIds": [ 9876 ], "error": null, "TraceID": "d5e3f4c6-3456-4c7d-9def-3456789012cd" } } } } } } } } }, "/pickupslist": { "get": { "tags": [ "PickupApi" ], "summary": "Get Pickups List", "description": "Retrieves a scheduled pickup entry by shipment ID or pickup list number, and returns a generated PDF pickup document.", "parameters": [ { "name": "shipmentid", "in": "query", "description": "ID of the shipment to retrieve the pickup list for.", "schema": { "type": "integer", "format": "int64" } }, { "name": "pickupslistnumber", "in": "query", "description": "Pickup list number to retrieve. When provided, returns the document for that specific pickup list.", "schema": { "type": "integer", "format": "int64" } }, { "name": "copies", "in": "query", "description": "Number of pickup document PDF copies to generate. Defaults to 1.", "schema": { "type": "integer", "format": "int32" } }, { "name": "mini", "in": "query", "description": "When true, generates a mini-format pickup document PDF instead of the full-size version.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClientAPIPickupsListResultDto" }, "examples": { "Success": { "summary": "Pickup list found", "value": { "Status": 0, "Validations": [ ], "Shipmentids": [ 1234567 ], "Pickupdocument": "JVBERi0xLjQKJ...(base64-encoded PDF)", "Pickupinterval": { "From": "2026-07-07T09:00:00", "Until": "2026-07-07T13:00:00" }, "TraceID": "f7a8b9c0-5678-4e1f-8a2b-5678901234ef" } } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientAPIPickupsListResultDto" }, "examples": { "Success": { "summary": "Pickup list found", "value": { "Status": 0, "Validations": [ ], "Shipmentids": [ 1234567 ], "Pickupdocument": "JVBERi0xLjQKJ...(base64-encoded PDF)", "Pickupinterval": { "From": "2026-07-07T09:00:00", "Until": "2026-07-07T13:00:00" }, "TraceID": "f7a8b9c0-5678-4e1f-8a2b-5678901234ef" } } } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientAPIPickupsListResultDto" }, "examples": { "Success": { "summary": "Pickup list found", "value": { "Status": 0, "Validations": [ ], "Shipmentids": [ 1234567 ], "Pickupdocument": "JVBERi0xLjQKJ...(base64-encoded PDF)", "Pickupinterval": { "From": "2026-07-07T09:00:00", "Until": "2026-07-07T13:00:00" }, "TraceID": "f7a8b9c0-5678-4e1f-8a2b-5678901234ef" } } } } } } } } }, "/pickupdelyintervals": { "get": { "tags": [ "PickupApi" ], "summary": "Get Pickup and Delivery Intervals", "description": "Returns available time intervals for all available postal codes in the country, aiding in precise scheduling of pickups and deliveries.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClientAPIPickupDelyIntervalsResultDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientAPIPickupDelyIntervalsResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientAPIPickupDelyIntervalsResultDto" } } } } } } }, "/createshipment": { "post": { "tags": [ "ShipmentApi" ], "summary": "Create Shipment", "description": "Initiates the creation of a new shipment with the provided details, including sender and recipient information. This is the primary method for registering shipments into the system.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ClientAPICreateShipmentRequest" } ] }, "examples": { "Standard shipment": { "summary": "Standard shipment", "description": "Client prints the label and orders pickup. `IsSenderNonCustomer` is false and the authenticated customer's default sender is used.", "value": { "Cosignee": { "Name": "Test Consignee", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Wolkrova 1124", "Telephone": "1111111", "NotifyEmail": "example@gmail.com", "NotifyGSM": "1111111" }, "Ref1": "random-text", "Ref2": "random-text", "Ref3": "random-text", "IsSenderNonCustomer": false, "NumberOfCollies": 2 } }, "Pickup at third-party location": { "summary": "Pickup at third-party location", "description": "No label is printed; the shipment is picked up at the sender location. `IsSenderNonCustomer` is true and `Sender` holds the third-party address.", "value": { "Cosignee": { "Name": "Test Consignee", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Wolkrova 1124", "Telephone": "1111111", "NotifyEmail": "example@gmail.com", "NotifyGSM": "1111111" }, "Ref1": "random-text", "Ref2": "random-text", "Ref3": "random-text", "IsSenderNonCustomer": true, "NumberOfCollies": 2, "Sender": { "Name": "Third Party Sender", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Ulica Grada Vukovara 5", "Telephone": "2222222", "NotifyEmail": "thirdparty@gmail.com", "NotifyGSM": "2222222" } } }, "With individual collies": { "summary": "With individual collies", "description": "Packages differ in reference or barcode, so `Collies` is used instead of `NumberOfCollies`. The two fields are mutually exclusive.", "value": { "Cosignee": { "Name": "Test Consignee", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Wolkrova 1124", "Telephone": "1111111", "NotifyEmail": "example@gmail.com", "NotifyGSM": "1111111" }, "Ref1": "random-text", "Ref2": "random-text", "Ref3": "random-text", "IsSenderNonCustomer": false, "Collies": [ { "Ref1": "colli-1", "Ref2": "random-text", "Ref3": "random-text", "Remark": "Fragile", "Barcode": null }, { "Ref1": "colli-2", "Ref2": "random-text", "Ref3": "random-text", "Remark": "Fragile", "Barcode": null } ] } } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ClientAPICreateShipmentRequest" } ] }, "examples": { "Standard shipment": { "summary": "Standard shipment", "description": "Client prints the label and orders pickup. `IsSenderNonCustomer` is false and the authenticated customer's default sender is used.", "value": { "Cosignee": { "Name": "Test Consignee", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Wolkrova 1124", "Telephone": "1111111", "NotifyEmail": "example@gmail.com", "NotifyGSM": "1111111" }, "Ref1": "random-text", "Ref2": "random-text", "Ref3": "random-text", "IsSenderNonCustomer": false, "NumberOfCollies": 2 } }, "Pickup at third-party location": { "summary": "Pickup at third-party location", "description": "No label is printed; the shipment is picked up at the sender location. `IsSenderNonCustomer` is true and `Sender` holds the third-party address.", "value": { "Cosignee": { "Name": "Test Consignee", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Wolkrova 1124", "Telephone": "1111111", "NotifyEmail": "example@gmail.com", "NotifyGSM": "1111111" }, "Ref1": "random-text", "Ref2": "random-text", "Ref3": "random-text", "IsSenderNonCustomer": true, "NumberOfCollies": 2, "Sender": { "Name": "Third Party Sender", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Ulica Grada Vukovara 5", "Telephone": "2222222", "NotifyEmail": "thirdparty@gmail.com", "NotifyGSM": "2222222" } } }, "With individual collies": { "summary": "With individual collies", "description": "Packages differ in reference or barcode, so `Collies` is used instead of `NumberOfCollies`. The two fields are mutually exclusive.", "value": { "Cosignee": { "Name": "Test Consignee", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Wolkrova 1124", "Telephone": "1111111", "NotifyEmail": "example@gmail.com", "NotifyGSM": "1111111" }, "Ref1": "random-text", "Ref2": "random-text", "Ref3": "random-text", "IsSenderNonCustomer": false, "Collies": [ { "Ref1": "colli-1", "Ref2": "random-text", "Ref3": "random-text", "Remark": "Fragile", "Barcode": null }, { "Ref1": "colli-2", "Ref2": "random-text", "Ref3": "random-text", "Remark": "Fragile", "Barcode": null } ] } } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ClientAPICreateShipmentRequest" } ] }, "examples": { "Standard shipment": { "summary": "Standard shipment", "description": "Client prints the label and orders pickup. `IsSenderNonCustomer` is false and the authenticated customer's default sender is used.", "value": { "Cosignee": { "Name": "Test Consignee", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Wolkrova 1124", "Telephone": "1111111", "NotifyEmail": "example@gmail.com", "NotifyGSM": "1111111" }, "Ref1": "random-text", "Ref2": "random-text", "Ref3": "random-text", "IsSenderNonCustomer": false, "NumberOfCollies": 2 } }, "Pickup at third-party location": { "summary": "Pickup at third-party location", "description": "No label is printed; the shipment is picked up at the sender location. `IsSenderNonCustomer` is true and `Sender` holds the third-party address.", "value": { "Cosignee": { "Name": "Test Consignee", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Wolkrova 1124", "Telephone": "1111111", "NotifyEmail": "example@gmail.com", "NotifyGSM": "1111111" }, "Ref1": "random-text", "Ref2": "random-text", "Ref3": "random-text", "IsSenderNonCustomer": true, "NumberOfCollies": 2, "Sender": { "Name": "Third Party Sender", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Ulica Grada Vukovara 5", "Telephone": "2222222", "NotifyEmail": "thirdparty@gmail.com", "NotifyGSM": "2222222" } } }, "With individual collies": { "summary": "With individual collies", "description": "Packages differ in reference or barcode, so `Collies` is used instead of `NumberOfCollies`. The two fields are mutually exclusive.", "value": { "Cosignee": { "Name": "Test Consignee", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Wolkrova 1124", "Telephone": "1111111", "NotifyEmail": "example@gmail.com", "NotifyGSM": "1111111" }, "Ref1": "random-text", "Ref2": "random-text", "Ref3": "random-text", "IsSenderNonCustomer": false, "Collies": [ { "Ref1": "colli-1", "Ref2": "random-text", "Ref3": "random-text", "Remark": "Fragile", "Barcode": null }, { "Ref1": "colli-2", "Ref2": "random-text", "Ref3": "random-text", "Remark": "Fragile", "Barcode": null } ] } } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ClientAPICreateShipmentRequest" } ] }, "examples": { "Standard shipment": { "summary": "Standard shipment", "description": "Client prints the label and orders pickup. `IsSenderNonCustomer` is false and the authenticated customer's default sender is used.", "value": { "Cosignee": { "Name": "Test Consignee", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Wolkrova 1124", "Telephone": "1111111", "NotifyEmail": "example@gmail.com", "NotifyGSM": "1111111" }, "Ref1": "random-text", "Ref2": "random-text", "Ref3": "random-text", "IsSenderNonCustomer": false, "NumberOfCollies": 2 } }, "Pickup at third-party location": { "summary": "Pickup at third-party location", "description": "No label is printed; the shipment is picked up at the sender location. `IsSenderNonCustomer` is true and `Sender` holds the third-party address.", "value": { "Cosignee": { "Name": "Test Consignee", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Wolkrova 1124", "Telephone": "1111111", "NotifyEmail": "example@gmail.com", "NotifyGSM": "1111111" }, "Ref1": "random-text", "Ref2": "random-text", "Ref3": "random-text", "IsSenderNonCustomer": true, "NumberOfCollies": 2, "Sender": { "Name": "Third Party Sender", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Ulica Grada Vukovara 5", "Telephone": "2222222", "NotifyEmail": "thirdparty@gmail.com", "NotifyGSM": "2222222" } } }, "With individual collies": { "summary": "With individual collies", "description": "Packages differ in reference or barcode, so `Collies` is used instead of `NumberOfCollies`. The two fields are mutually exclusive.", "value": { "Cosignee": { "Name": "Test Consignee", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Wolkrova 1124", "Telephone": "1111111", "NotifyEmail": "example@gmail.com", "NotifyGSM": "1111111" }, "Ref1": "random-text", "Ref2": "random-text", "Ref3": "random-text", "IsSenderNonCustomer": false, "Collies": [ { "Ref1": "colli-1", "Ref2": "random-text", "Ref3": "random-text", "Remark": "Fragile", "Barcode": null }, { "Ref1": "colli-2", "Ref2": "random-text", "Ref3": "random-text", "Remark": "Fragile", "Barcode": null } ] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClientAPICreateShipmentResult" }, "examples": { "Success": { "summary": "Shipment created", "value": { "Status": 0, "Validations": [ ], "error": null, "shipmentid": 1234567, "pickuptime": "2026-07-07T09:00:00", "pickupendtime": "2026-07-07T13:00:00", "deliverytime": "2026-07-08T09:00:00", "deliveryendtime": "2026-07-08T18:00:00", "CargoIDs": [ ], "TraceID": "b3f1c2a4-1234-4a5b-9abc-1234567890ab" } } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientAPICreateShipmentResult" }, "examples": { "Success": { "summary": "Shipment created", "value": { "Status": 0, "Validations": [ ], "error": null, "shipmentid": 1234567, "pickuptime": "2026-07-07T09:00:00", "pickupendtime": "2026-07-07T13:00:00", "deliverytime": "2026-07-08T09:00:00", "deliveryendtime": "2026-07-08T18:00:00", "CargoIDs": [ ], "TraceID": "b3f1c2a4-1234-4a5b-9abc-1234567890ab" } } } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientAPICreateShipmentResult" }, "examples": { "Success": { "summary": "Shipment created", "value": { "Status": 0, "Validations": [ ], "error": null, "shipmentid": 1234567, "pickuptime": "2026-07-07T09:00:00", "pickupendtime": "2026-07-07T13:00:00", "deliverytime": "2026-07-08T09:00:00", "deliveryendtime": "2026-07-08T18:00:00", "CargoIDs": [ ], "TraceID": "b3f1c2a4-1234-4a5b-9abc-1234567890ab" } } } } } } } } }, "/createshipmentwithbarcode": { }, "/updateshipment": { "post": { "tags": [ "ShipmentApi" ], "summary": "Update Shipment", "description": "Allows for the updating of shipment details after creation but before commit.", "parameters": [ { "name": "shipmentId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ClientAPICreateShipmentRequest" } ] }, "examples": { "Standard shipment": { "summary": "Standard shipment", "description": "Client prints the label and orders pickup. `IsSenderNonCustomer` is false and the authenticated customer's default sender is used.", "value": { "Cosignee": { "Name": "Test Consignee", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Wolkrova 1124", "Telephone": "1111111", "NotifyEmail": "example@gmail.com", "NotifyGSM": "1111111" }, "Ref1": "random-text", "Ref2": "random-text", "Ref3": "random-text", "IsSenderNonCustomer": false, "NumberOfCollies": 2 } }, "Pickup at third-party location": { "summary": "Pickup at third-party location", "description": "No label is printed; the shipment is picked up at the sender location. `IsSenderNonCustomer` is true and `Sender` holds the third-party address.", "value": { "Cosignee": { "Name": "Test Consignee", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Wolkrova 1124", "Telephone": "1111111", "NotifyEmail": "example@gmail.com", "NotifyGSM": "1111111" }, "Ref1": "random-text", "Ref2": "random-text", "Ref3": "random-text", "IsSenderNonCustomer": true, "NumberOfCollies": 2, "Sender": { "Name": "Third Party Sender", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Ulica Grada Vukovara 5", "Telephone": "2222222", "NotifyEmail": "thirdparty@gmail.com", "NotifyGSM": "2222222" } } }, "With individual collies": { "summary": "With individual collies", "description": "Packages differ in reference or barcode, so `Collies` is used instead of `NumberOfCollies`. The two fields are mutually exclusive.", "value": { "Cosignee": { "Name": "Test Consignee", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Wolkrova 1124", "Telephone": "1111111", "NotifyEmail": "example@gmail.com", "NotifyGSM": "1111111" }, "Ref1": "random-text", "Ref2": "random-text", "Ref3": "random-text", "IsSenderNonCustomer": false, "Collies": [ { "Ref1": "colli-1", "Ref2": "random-text", "Ref3": "random-text", "Remark": "Fragile", "Barcode": null }, { "Ref1": "colli-2", "Ref2": "random-text", "Ref3": "random-text", "Remark": "Fragile", "Barcode": null } ] } } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ClientAPICreateShipmentRequest" } ] }, "examples": { "Standard shipment": { "summary": "Standard shipment", "description": "Client prints the label and orders pickup. `IsSenderNonCustomer` is false and the authenticated customer's default sender is used.", "value": { "Cosignee": { "Name": "Test Consignee", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Wolkrova 1124", "Telephone": "1111111", "NotifyEmail": "example@gmail.com", "NotifyGSM": "1111111" }, "Ref1": "random-text", "Ref2": "random-text", "Ref3": "random-text", "IsSenderNonCustomer": false, "NumberOfCollies": 2 } }, "Pickup at third-party location": { "summary": "Pickup at third-party location", "description": "No label is printed; the shipment is picked up at the sender location. `IsSenderNonCustomer` is true and `Sender` holds the third-party address.", "value": { "Cosignee": { "Name": "Test Consignee", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Wolkrova 1124", "Telephone": "1111111", "NotifyEmail": "example@gmail.com", "NotifyGSM": "1111111" }, "Ref1": "random-text", "Ref2": "random-text", "Ref3": "random-text", "IsSenderNonCustomer": true, "NumberOfCollies": 2, "Sender": { "Name": "Third Party Sender", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Ulica Grada Vukovara 5", "Telephone": "2222222", "NotifyEmail": "thirdparty@gmail.com", "NotifyGSM": "2222222" } } }, "With individual collies": { "summary": "With individual collies", "description": "Packages differ in reference or barcode, so `Collies` is used instead of `NumberOfCollies`. The two fields are mutually exclusive.", "value": { "Cosignee": { "Name": "Test Consignee", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Wolkrova 1124", "Telephone": "1111111", "NotifyEmail": "example@gmail.com", "NotifyGSM": "1111111" }, "Ref1": "random-text", "Ref2": "random-text", "Ref3": "random-text", "IsSenderNonCustomer": false, "Collies": [ { "Ref1": "colli-1", "Ref2": "random-text", "Ref3": "random-text", "Remark": "Fragile", "Barcode": null }, { "Ref1": "colli-2", "Ref2": "random-text", "Ref3": "random-text", "Remark": "Fragile", "Barcode": null } ] } } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ClientAPICreateShipmentRequest" } ] }, "examples": { "Standard shipment": { "summary": "Standard shipment", "description": "Client prints the label and orders pickup. `IsSenderNonCustomer` is false and the authenticated customer's default sender is used.", "value": { "Cosignee": { "Name": "Test Consignee", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Wolkrova 1124", "Telephone": "1111111", "NotifyEmail": "example@gmail.com", "NotifyGSM": "1111111" }, "Ref1": "random-text", "Ref2": "random-text", "Ref3": "random-text", "IsSenderNonCustomer": false, "NumberOfCollies": 2 } }, "Pickup at third-party location": { "summary": "Pickup at third-party location", "description": "No label is printed; the shipment is picked up at the sender location. `IsSenderNonCustomer` is true and `Sender` holds the third-party address.", "value": { "Cosignee": { "Name": "Test Consignee", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Wolkrova 1124", "Telephone": "1111111", "NotifyEmail": "example@gmail.com", "NotifyGSM": "1111111" }, "Ref1": "random-text", "Ref2": "random-text", "Ref3": "random-text", "IsSenderNonCustomer": true, "NumberOfCollies": 2, "Sender": { "Name": "Third Party Sender", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Ulica Grada Vukovara 5", "Telephone": "2222222", "NotifyEmail": "thirdparty@gmail.com", "NotifyGSM": "2222222" } } }, "With individual collies": { "summary": "With individual collies", "description": "Packages differ in reference or barcode, so `Collies` is used instead of `NumberOfCollies`. The two fields are mutually exclusive.", "value": { "Cosignee": { "Name": "Test Consignee", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Wolkrova 1124", "Telephone": "1111111", "NotifyEmail": "example@gmail.com", "NotifyGSM": "1111111" }, "Ref1": "random-text", "Ref2": "random-text", "Ref3": "random-text", "IsSenderNonCustomer": false, "Collies": [ { "Ref1": "colli-1", "Ref2": "random-text", "Ref3": "random-text", "Remark": "Fragile", "Barcode": null }, { "Ref1": "colli-2", "Ref2": "random-text", "Ref3": "random-text", "Remark": "Fragile", "Barcode": null } ] } } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ClientAPICreateShipmentRequest" } ] }, "examples": { "Standard shipment": { "summary": "Standard shipment", "description": "Client prints the label and orders pickup. `IsSenderNonCustomer` is false and the authenticated customer's default sender is used.", "value": { "Cosignee": { "Name": "Test Consignee", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Wolkrova 1124", "Telephone": "1111111", "NotifyEmail": "example@gmail.com", "NotifyGSM": "1111111" }, "Ref1": "random-text", "Ref2": "random-text", "Ref3": "random-text", "IsSenderNonCustomer": false, "NumberOfCollies": 2 } }, "Pickup at third-party location": { "summary": "Pickup at third-party location", "description": "No label is printed; the shipment is picked up at the sender location. `IsSenderNonCustomer` is true and `Sender` holds the third-party address.", "value": { "Cosignee": { "Name": "Test Consignee", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Wolkrova 1124", "Telephone": "1111111", "NotifyEmail": "example@gmail.com", "NotifyGSM": "1111111" }, "Ref1": "random-text", "Ref2": "random-text", "Ref3": "random-text", "IsSenderNonCustomer": true, "NumberOfCollies": 2, "Sender": { "Name": "Third Party Sender", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Ulica Grada Vukovara 5", "Telephone": "2222222", "NotifyEmail": "thirdparty@gmail.com", "NotifyGSM": "2222222" } } }, "With individual collies": { "summary": "With individual collies", "description": "Packages differ in reference or barcode, so `Collies` is used instead of `NumberOfCollies`. The two fields are mutually exclusive.", "value": { "Cosignee": { "Name": "Test Consignee", "CountryCode": "HR", "Zipcode": "10000", "City": "ZAGREB", "StreetAndNumber": "Wolkrova 1124", "Telephone": "1111111", "NotifyEmail": "example@gmail.com", "NotifyGSM": "1111111" }, "Ref1": "random-text", "Ref2": "random-text", "Ref3": "random-text", "IsSenderNonCustomer": false, "Collies": [ { "Ref1": "colli-1", "Ref2": "random-text", "Ref3": "random-text", "Remark": "Fragile", "Barcode": null }, { "Ref1": "colli-2", "Ref2": "random-text", "Ref3": "random-text", "Remark": "Fragile", "Barcode": null } ] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClientAPICreateShipmentResult" }, "examples": { "Success": { "summary": "Shipment created", "value": { "Status": 0, "Validations": [ ], "error": null, "shipmentid": 1234567, "pickuptime": "2026-07-07T09:00:00", "pickupendtime": "2026-07-07T13:00:00", "deliverytime": "2026-07-08T09:00:00", "deliveryendtime": "2026-07-08T18:00:00", "CargoIDs": [ ], "TraceID": "b3f1c2a4-1234-4a5b-9abc-1234567890ab" } } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientAPICreateShipmentResult" }, "examples": { "Success": { "summary": "Shipment created", "value": { "Status": 0, "Validations": [ ], "error": null, "shipmentid": 1234567, "pickuptime": "2026-07-07T09:00:00", "pickupendtime": "2026-07-07T13:00:00", "deliverytime": "2026-07-08T09:00:00", "deliveryendtime": "2026-07-08T18:00:00", "CargoIDs": [ ], "TraceID": "b3f1c2a4-1234-4a5b-9abc-1234567890ab" } } } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientAPICreateShipmentResult" }, "examples": { "Success": { "summary": "Shipment created", "value": { "Status": 0, "Validations": [ ], "error": null, "shipmentid": 1234567, "pickuptime": "2026-07-07T09:00:00", "pickupendtime": "2026-07-07T13:00:00", "deliverytime": "2026-07-08T09:00:00", "deliveryendtime": "2026-07-08T18:00:00", "CargoIDs": [ ], "TraceID": "b3f1c2a4-1234-4a5b-9abc-1234567890ab" } } } } } } } } }, "/commitshipments": { "post": { "tags": [ "ShipmentApi" ], "summary": "Commit Shipments", "description": "Commits the specified shipments and returns their labels.Committed shipments are marked as ready for processing and dispatch.", "parameters": [ { "name": "skipimport", "in": "query", "description": "When true, skips committing the shipment — only generates and returns the label without marking the shipment as committed.", "schema": { "type": "boolean" } }, { "name": "layoutid", "in": "query", "description": "Label layout ID override. Defaults to the authenticated customer's preferred layout when omitted.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipdocument", "in": "query", "description": "When true, skips shipment document generation.", "schema": { "type": "boolean" } }, { "name": "dataonly", "in": "query", "description": "When true, returns commit result data without generating labels.", "schema": { "type": "boolean" } }, { "name": "includereturnlabel", "in": "query", "description": "When true, includes a return label alongside the outbound shipment label (use in only 2C operations).", "schema": { "type": "boolean" } } ], "requestBody": { "description": "List of shipment IDs to commit (max 100). Each ID must correspond to an existing, uncommitted shipment.", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "examples": { "Commit two shipments": { "summary": "Commit two shipments", "value": [ 1234567, 1234568 ] } } }, "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "examples": { "Commit two shipments": { "summary": "Commit two shipments", "value": [ 1234567, 1234568 ] } } }, "text/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "examples": { "Commit two shipments": { "summary": "Commit two shipments", "value": [ 1234567, 1234568 ] } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "examples": { "Commit two shipments": { "summary": "Commit two shipments", "value": [ 1234567, 1234568 ] } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ICommitShipmentResultClientAPIPrintShipmentsResultDto" }, "examples": { "Success": { "summary": "Shipments committed", "value": { "Status": 0, "Validations": [ ], "data": [ { "ShipmentID": 1234567, "SdglfdNr": 1, "LandNr": 191, "MandNr": 1 }, { "ShipmentID": 1234568, "SdglfdNr": 2, "LandNr": 191, "MandNr": 1 } ], "labelsbase64": "JVBERi0xLjQKJ...(base64-encoded PDF)", "TraceID": "c4d2e3b5-2345-4b6c-8bcd-2345678901bc" } } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ICommitShipmentResultClientAPIPrintShipmentsResultDto" }, "examples": { "Success": { "summary": "Shipments committed", "value": { "Status": 0, "Validations": [ ], "data": [ { "ShipmentID": 1234567, "SdglfdNr": 1, "LandNr": 191, "MandNr": 1 }, { "ShipmentID": 1234568, "SdglfdNr": 2, "LandNr": 191, "MandNr": 1 } ], "labelsbase64": "JVBERi0xLjQKJ...(base64-encoded PDF)", "TraceID": "c4d2e3b5-2345-4b6c-8bcd-2345678901bc" } } } }, "text/json": { "schema": { "$ref": "#/components/schemas/ICommitShipmentResultClientAPIPrintShipmentsResultDto" }, "examples": { "Success": { "summary": "Shipments committed", "value": { "Status": 0, "Validations": [ ], "data": [ { "ShipmentID": 1234567, "SdglfdNr": 1, "LandNr": 191, "MandNr": 1 }, { "ShipmentID": 1234568, "SdglfdNr": 2, "LandNr": 191, "MandNr": 1 } ], "labelsbase64": "JVBERi0xLjQKJ...(base64-encoded PDF)", "TraceID": "c4d2e3b5-2345-4b6c-8bcd-2345678901bc" } } } } } } } } }, "/reprintlabels": { "post": { "tags": [ "ShipmentApi" ], "summary": "Reprint Shipment Labels", "description": "Allows for the reprinting of labels for any shipment, can be called only after commitshipment.", "parameters": [ { "name": "layoutid", "in": "query", "description": "Label layout ID override. Defaults to the authenticated customer's preferred layout when omitted.", "schema": { "type": "integer", "format": "int32" } }, { "name": "includereturnlabel", "in": "query", "description": "When true, includes a return label alongside the outbound shipment label (use in only 2C operations).", "schema": { "type": "boolean" } } ], "requestBody": { "description": "List of shipment IDs to reprint labels for (max 100).", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "examples": { "Reprint labels": { "summary": "Reprint labels", "value": [ 1234567 ] } } }, "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "examples": { "Reprint labels": { "summary": "Reprint labels", "value": [ 1234567 ] } } }, "text/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "examples": { "Reprint labels": { "summary": "Reprint labels", "value": [ 1234567 ] } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "examples": { "Reprint labels": { "summary": "Reprint labels", "value": [ 1234567 ] } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ShipmentDataCargoIdClientAPIPrintShipmentsResultDto" }, "examples": { "Success": { "summary": "Labels reprinted", "value": { "Status": 0, "Validations": [ ], "data": [ { "ShipmentID": 1234567, "SdglfdNr": 1, "LandNr": 191, "MandNr": 1 } ], "labelsbase64": "JVBERi0xLjQKJ...(base64-encoded PDF)", "TraceID": "a1b2c3d4-6789-4f0a-9b2c-6789012345fa" } }, "Error: shipment not committed": { "summary": "Error: shipment not committed", "description": "Labels can only be reprinted for shipments that have already been committed via `commitshipments`.", "value": { "Status": 1, "Validations": [ ], "data": null, "labelsbase64": null, "error": { "Code": 7250, "Message": "Shipment has not been committed yet. Call commitshipments before reprintlabels.", "StackTrace": null, "InnerException": null, "Validations": null }, "TraceID": "b2c3d4e5-7890-4f1b-8a3c-7890123456ab" } } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentDataCargoIdClientAPIPrintShipmentsResultDto" }, "examples": { "Success": { "summary": "Labels reprinted", "value": { "Status": 0, "Validations": [ ], "data": [ { "ShipmentID": 1234567, "SdglfdNr": 1, "LandNr": 191, "MandNr": 1 } ], "labelsbase64": "JVBERi0xLjQKJ...(base64-encoded PDF)", "TraceID": "a1b2c3d4-6789-4f0a-9b2c-6789012345fa" } }, "Error: shipment not committed": { "summary": "Error: shipment not committed", "description": "Labels can only be reprinted for shipments that have already been committed via `commitshipments`.", "value": { "Status": 1, "Validations": [ ], "data": null, "labelsbase64": null, "error": { "Code": 7250, "Message": "Shipment has not been committed yet. Call commitshipments before reprintlabels.", "StackTrace": null, "InnerException": null, "Validations": null }, "TraceID": "b2c3d4e5-7890-4f1b-8a3c-7890123456ab" } } } }, "text/json": { "schema": { "$ref": "#/components/schemas/ShipmentDataCargoIdClientAPIPrintShipmentsResultDto" }, "examples": { "Success": { "summary": "Labels reprinted", "value": { "Status": 0, "Validations": [ ], "data": [ { "ShipmentID": 1234567, "SdglfdNr": 1, "LandNr": 191, "MandNr": 1 } ], "labelsbase64": "JVBERi0xLjQKJ...(base64-encoded PDF)", "TraceID": "a1b2c3d4-6789-4f0a-9b2c-6789012345fa" } }, "Error: shipment not committed": { "summary": "Error: shipment not committed", "description": "Labels can only be reprinted for shipments that have already been committed via `commitshipments`.", "value": { "Status": 1, "Validations": [ ], "data": null, "labelsbase64": null, "error": { "Code": 7250, "Message": "Shipment has not been committed yet. Call commitshipments before reprintlabels.", "StackTrace": null, "InnerException": null, "Validations": null }, "TraceID": "b2c3d4e5-7890-4f1b-8a3c-7890123456ab" } } } } } } } } }, "/pdfinternal": { }, "/pdfex": { }, "/returnparcel": { }, "/cancelshipments": { "post": { "tags": [ "ShipmentApi" ], "summary": "Cancel Shipments", "description": "Enables the cancellation of one or more shipments that have been previously created but not yet committed. This is useful for halting shipments due to order changes or errors.", "requestBody": { "description": "List of shipment IDs to cancel. Only uncommitted shipments can be cancelled.", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "examples": { "Cancel two shipments": { "summary": "Cancel two shipments", "value": [ 1234567, 1234568 ] } } }, "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "examples": { "Cancel two shipments": { "summary": "Cancel two shipments", "value": [ 1234567, 1234568 ] } } }, "text/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "examples": { "Cancel two shipments": { "summary": "Cancel two shipments", "value": [ 1234567, 1234568 ] } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "examples": { "Cancel two shipments": { "summary": "Cancel two shipments", "value": [ 1234567, 1234568 ] } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClientAPICancelShipmentsResultDto" }, "examples": { "Success": { "summary": "Shipments cancelled", "value": { "Status": 0, "Validations": [ ], "shipmentids": [ 1234567, 1234568 ], "TraceID": "c3d4e5f6-8901-4f2c-9b4d-8901234567bc" } } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientAPICancelShipmentsResultDto" }, "examples": { "Success": { "summary": "Shipments cancelled", "value": { "Status": 0, "Validations": [ ], "shipmentids": [ 1234567, 1234568 ], "TraceID": "c3d4e5f6-8901-4f2c-9b4d-8901234567bc" } } } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientAPICancelShipmentsResultDto" }, "examples": { "Success": { "summary": "Shipments cancelled", "value": { "Status": 0, "Validations": [ ], "shipmentids": [ 1234567, 1234568 ], "TraceID": "c3d4e5f6-8901-4f2c-9b4d-8901234567bc" } } } } } } } } }, "/priceinfo": { "post": { "tags": [ "ShipmentApi" ], "summary": "Get Price Information", "description": "Provides detailed pricing information for shipments based on specified criteria.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIPriceInfoRequestDto" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIPriceInfoRequestDto" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIPriceInfoRequestDto" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIPriceInfoRequestDto" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClientAPIPriceInfoResultDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientAPIPriceInfoResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientAPIPriceInfoResultDto" } } } } } } }, "/priceinfoforshipment": { "get": { "tags": [ "ShipmentApi" ], "summary": "Price Info for Shipment", "description": "Retrieves pricing information for a specific shipment, providing details on the cost of shipping that particular package.", "parameters": [ { "name": "shipmentId", "in": "query", "description": "ID of the shipment to retrieve pricing for. Mutually exclusive with cargoid and ref.", "schema": { "type": "integer", "format": "int64" } }, { "name": "cargoid", "in": "query", "description": "Cargo ID of the shipment. Mutually exclusive with shipmentId and ref.", "schema": { "type": "string" } }, { "name": "ref", "in": "query", "description": "Customer reference of the shipment. Mutually exclusive with shipmentId and cargoid.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClientAPIPriceInfoResultDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientAPIPriceInfoResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientAPIPriceInfoResultDto" } } } } } } }, "/addcollies": { "post": { "tags": [ "ShipmentApi" ], "summary": "Add Collies", "description": "Adds collies to a shipment, increasing the number of packages associated with the shipment.", "parameters": [ { "name": "shipmentId", "in": "query", "description": "ID of the shipment to add collies to.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "numberofcolliestoadd", "in": "query", "description": "Number of collies to add when the collies list is not provided.", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "collies": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAPICreateShipmentRequestColliDto" }, "description": "List of individual colli details to add. When provided, takes precedence over numberofcolliestoadd." } } }, "encoding": { "collies": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClientAPIAddColliesResultDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientAPIAddColliesResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientAPIAddColliesResultDto" } } } } } } }, "/removecollies": { "post": { "tags": [ "ShipmentApi" ], "summary": "Remove Collies", "description": "Removes collies from a shipment, reducing the number of packages associated with the shipment.", "parameters": [ { "name": "shipmentId", "in": "query", "description": "ID of the shipment to remove collies from.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "numberofcolliestoremove", "in": "query", "description": "Number of collies to remove when the collies list is not provided.", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "List of colli barcodes to remove from the shipment. When provided, takes precedence over numberofcolliestoremove.", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClientAPIAddColliesResultDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientAPIAddColliesResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientAPIAddColliesResultDto" } } } } } } }, "/shipment": { }, "/shipmentbyid": { "get": { "tags": [ "ShipmentTrackingApi" ], "summary": "Find Shipment by ID", "description": "Finds shipment by shipmentID, allowing for the retrieval of shipment details using the unique shipment identifier.", "parameters": [ { "name": "shipmentId", "in": "query", "description": "Unique system identifier of the shipment to retrieve.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClientAPIShipmentResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientAPIShipmentResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientAPIShipmentResult" } } } } } } }, "/shipmentsbyid": { "post": { "tags": [ "ShipmentTrackingApi" ], "summary": "Get Multiple Shipments by ID", "description": "Retrieves multiple shipments by a list of shipment IDs, facilitating batch processing and management of shipments.", "requestBody": { "description": "List of shipment IDs to retrieve in a single batch request.", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClientAPIShipmentsResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientAPIShipmentsResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientAPIShipmentsResult" } } } } } } }, "/shipmentsbyref1": { "get": { "tags": [ "ShipmentTrackingApi" ], "summary": "Find Shipments by Reference 1", "description": "Finds shipments using ref1 or barcode and date of shipment creation, enabling searches based on reference numbers or barcodes.", "parameters": [ { "name": "date", "in": "query", "description": "Shipment creation date as a Unix timestamp in milliseconds.", "schema": { "type": "string" } }, { "name": "ref", "in": "query", "description": "Reference 1 value or barcode to search for.", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Maximum number of results to return.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClientAPIShipmentsResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientAPIShipmentsResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientAPIShipmentsResult" } } } } } } }, "/shipmentbycargoid": { "get": { "tags": [ "ShipmentTrackingApi" ], "summary": "Find Shipment by Cargo ID", "description": "Finds shipment by CargoID, retrieving detailed information about a specific shipment using its unique CargoID.", "parameters": [ { "name": "cargoid", "in": "query", "description": "Carrier-assigned cargo ID of the shipment to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClientAPIShipmentResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientAPIShipmentResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientAPIShipmentResult" } } } } } } }, "/shipmentsbyanyref": { "get": { "tags": [ "ShipmentTrackingApi" ], "summary": "Find Shipments by Any Reference", "description": "Finds shipments using any reference or barcode and date of shipment creation.", "parameters": [ { "name": "starttime", "in": "query", "description": "Search window start as a Unix timestamp in milliseconds.", "schema": { "type": "integer", "format": "int64" } }, { "name": "endtime", "in": "query", "description": "Search window end as a Unix timestamp in milliseconds.", "schema": { "type": "integer", "format": "int64" } }, { "name": "ref", "in": "query", "description": "Reference value or barcode to search across all reference fields (Ref1, Ref2, Ref3, barcode).", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Maximum number of results to return.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClientAPIShipmentsResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientAPIShipmentsResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientAPIShipmentsResult" } } } } } } }, "/recentshipments": { "get": { "tags": [ "ShipmentTrackingApi" ], "summary": "Get Recent Shipments", "description": "Retrieves a list of shipments created within a recent timeframe.", "parameters": [ { "name": "starttime", "in": "query", "description": "Search window start as a Unix timestamp in milliseconds.", "schema": { "type": "string" } }, { "name": "endtime", "in": "query", "description": "Search window end as a Unix timestamp in milliseconds.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Maximum number of results to return.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClientAPIShipmentsResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientAPIShipmentsResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientAPIShipmentsResult" } } } } } } }, "/addupdatesender": { "post": { "tags": [ "UserApi" ], "summary": "Add or Update Sender", "description": "Allows the addition or updating of sender information in the system. This ensures that sender details are current and accurate for shipment processing.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIAddUpdateSenderRequestDto" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIAddUpdateSenderRequestDto" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIAddUpdateSenderRequestDto" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIAddUpdateSenderRequestDto" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClientAPIAddUpdateSenderResultDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientAPIAddUpdateSenderResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientAPIAddUpdateSenderResultDto" } } } } } } }, "/senders": { "get": { "tags": [ "UserApi" ], "summary": "Get Senders List", "description": "Retrieves a list of senders associated with the account, allowing for management and selection of sender profiles during shipment creation.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClientApiSendersResultDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientApiSendersResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientApiSendersResultDto" } } } } } } }, "/apiuserinfo": { "get": { "tags": [ "UserApi" ], "summary": "Api User Info", "description": "Retrieves information about the API user, including details on the user's account", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClientApiUserInfoResultDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientApiUserInfoResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientApiUserInfoResultDto" } } } } } } }, "/warehouse": { "get": { "tags": [ "WarehouseApi" ], "summary": "Get Warehouse Information", "description": "Retrieves warehouse inventory items for the authenticated customer, optionally filtered by item code.", "parameters": [ { "name": "itemCode", "in": "query", "description": "Item code to filter by. When omitted, all warehouse items for the customer are returned.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClientApiWarehouseItemsResultDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientApiWarehouseItemsResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientApiWarehouseItemsResultDto" } } } } } } }, "/warehousetraffic": { "get": { "tags": [ "WarehouseApi" ], "summary": "Get Warehouse Traffic", "description": "Retrieves warehouse traffic records showing stock movements (additions and removals) for the authenticated customer, optionally filtered by item code.", "parameters": [ { "name": "itemCode", "in": "query", "description": "Item code to filter traffic records by. When omitted, all traffic records for the customer are returned.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClientApiWarehouseTrafficsResultDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientApiWarehouseTrafficsResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientApiWarehouseTrafficsResultDto" } } } } } } } }, "components": { "schemas": { "APISender": { "type": "object", "properties": { "name": { "type": "string", "description": "Person or business name (max 35 characters)", "nullable": true }, "countryCode": { "type": "string", "description": "Country code in ISO format (max 3 characters)", "nullable": true }, "zipcode": { "type": "string", "description": "Postal code (max 10 characters)", "nullable": true }, "city": { "type": "string", "description": "City name (max 35 characters)", "nullable": true }, "streetAndNumber": { "type": "string", "description": "Street and street number (max 70 characters)", "nullable": true }, "telephone": { "type": "string", "description": "Telephone (max 30 characters)", "nullable": true }, "fax": { "type": "string", "description": "Fax (max 30 characters)", "nullable": true }, "notifyGSM": { "type": "string", "description": "Mobile number for notifications (max 35 characters)", "nullable": true }, "notifyEmail": { "type": "string", "description": "Email for sending notifications (max 70 characters)", "nullable": true }, "senderID": { "type": "integer", "format": "int32", "nullable": true, "example": 0 } }, "additionalProperties": false }, "APIShipmentStatusFlag": { "enum": [ "None", "Temp", "Commiting", "Importing", "Routed", "Printed", "Imported", "PickupRequested", "IsShipment", "Multicolli", "Single", "PickupCustomer", "PickupNonCustomer", "PickupSkipped", "FinalPrint", "IsMip", "IsCanceled", "Error" ], "type": "string", "description": "0 = None, 1 = Temp, 2 = Commiting, 4 = Importing, 8 = Routed, 32 = Printed, 64 = Imported, 128 = PickupRequested, 256 = IsShipment, 512 = Multicolli, 1024 = Single, 2048 = PickupCustomer, 4096 = PickupNonCustomer, 8192 = PickupSkipped, 16384 = FinalPrint, 32768 = IsMip, 65536 = IsCanceled, 1073741824 = Error" }, "Address": { "type": "object", "properties": { "name": { "type": "string", "description": "Person or business name (max 35 characters)", "nullable": true }, "countryCode": { "type": "string", "description": "Country code in ISO format (max 3 characters)", "nullable": true }, "zipcode": { "type": "string", "description": "Postal code (max 10 characters)", "nullable": true }, "city": { "type": "string", "description": "City name (max 35 characters)", "nullable": true }, "streetAndNumber": { "type": "string", "description": "Street and street number (max 70 characters)", "nullable": true }, "telephone": { "type": "string", "description": "Telephone (max 30 characters)", "nullable": true }, "fax": { "type": "string", "description": "Fax (max 30 characters)", "nullable": true }, "notifyGSM": { "type": "string", "description": "Mobile number for notifications (max 35 characters)", "nullable": true }, "notifyEmail": { "type": "string", "description": "Email for sending notifications (max 70 characters)", "nullable": true } }, "additionalProperties": false }, "CNAddress": { "type": "object", "properties": { "addressID": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "countryPrefix": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "place": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "houseNumber": { "type": "integer", "format": "int32", "nullable": true, "example": 0 }, "houseNumberAddition": { "type": "string", "nullable": true }, "addressText": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "textPhone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "type": { "type": "integer", "format": "int32", "example": 0 }, "lat": { "type": "number", "format": "double", "nullable": true, "example": 0 }, "long": { "type": "number", "format": "double", "nullable": true, "example": 0 } }, "additionalProperties": false }, "CNCOD": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "nullable": true, "example": 0 }, "amountCurrency": { "type": "number", "format": "double", "nullable": true, "example": 0 }, "originalAmount": { "type": "number", "format": "double", "nullable": true, "example": 0 }, "originalAmountCurrency": { "type": "number", "format": "double", "nullable": true, "example": 0 }, "currency": { "type": "string", "nullable": true }, "currencyType": { "allOf": [ { "$ref": "#/components/schemas/CurrencyAttribute" } ], "nullable": true }, "exchangeRate": { "type": "number", "format": "double", "nullable": true, "example": 0 }, "exchangeDate": { "type": "string", "nullable": true }, "returnAccount": { "type": "string", "nullable": true }, "returnAccountBank": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CNClient": { "type": "object", "properties": { "clientID": { "type": "integer", "format": "int32", "nullable": true, "example": 0 }, "clientName": { "type": "string", "nullable": true }, "defaultGoodsDescription": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CNCommission": { "type": "object", "properties": { "amount": { "type": "number", "description": "Commission amount. Decimal numbers must use a dot (.) as the separator (e.g., 12.50).", "format": "double", "example": 0 }, "itemCode": { "type": "string", "description": "Item/product code that identifies the commission type or service being charged.", "nullable": true } }, "additionalProperties": false, "description": "Represents a single commission line attached to a shipment." }, "CNDepo": { "type": "object", "properties": { "centerID": { "type": "integer", "format": "int32", "nullable": true, "example": 0 }, "name": { "type": "string", "nullable": true }, "abbreviatedName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CNEvent": { "type": "object", "properties": { "timeOfScan": { "type": "string", "format": "date-time", "nullable": true }, "statusID": { "type": "integer", "format": "int32", "nullable": true, "example": 0 }, "statusName": { "type": "string", "nullable": true }, "statusDescription": { "type": "string", "nullable": true }, "statusDescriptionEN": { "type": "string", "nullable": true }, "scanDepo": { "allOf": [ { "$ref": "#/components/schemas/CNDepo" } ], "nullable": true }, "remark": { "type": "string", "nullable": true }, "actualReceiver": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CNLayout": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "example": 0 }, "layoutName": { "type": "string", "nullable": true }, "layoutType": { "type": "integer", "format": "int32", "example": 0 }, "isPublic": { "type": "boolean" }, "isDefault": { "type": "boolean" } }, "additionalProperties": false }, "CNObsoleteShipment": { "type": "object", "properties": { "sdglfdNr": { "type": "integer", "format": "int64", "nullable": true, "example": 0 }, "landNr": { "type": "integer", "format": "int32", "nullable": true, "example": 0 }, "mandNr": { "type": "integer", "format": "int32", "nullable": true, "example": 0 }, "sendDate": { "type": "string", "nullable": true }, "createDate": { "type": "string", "nullable": true }, "isReturnDocument": { "type": "boolean", "nullable": true }, "colliNr": { "type": "integer", "format": "int32", "nullable": true, "example": 0 }, "currentReceiver": { "allOf": [ { "$ref": "#/components/schemas/CNPerson" } ], "nullable": true }, "currentSender": { "allOf": [ { "$ref": "#/components/schemas/CNPerson" } ], "nullable": true }, "count": { "type": "number", "format": "double", "nullable": true, "example": 0 }, "verifiedWeight": { "type": "number", "format": "double", "nullable": true, "example": 0 }, "cod": { "type": "number", "format": "double", "nullable": true, "example": 0 }, "codToPay": { "type": "number", "format": "double", "nullable": true, "example": 0 }, "exWorks": { "type": "number", "format": "double", "nullable": true, "example": 0 }, "exWorksToPay": { "type": "number", "format": "double", "nullable": true, "example": 0 }, "isCargo": { "type": "boolean", "nullable": true }, "isPrinted": { "type": "boolean", "nullable": true }, "isMaster": { "type": "boolean", "nullable": true }, "ref1": { "type": "string", "nullable": true }, "ref2": { "type": "string", "nullable": true }, "ref3": { "type": "string", "nullable": true }, "refInt": { "type": "string", "nullable": true }, "fullCargoID": { "type": "string", "nullable": true }, "pointPackRef": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CNParcelShop": { "type": "object", "properties": { "countryID": { "type": "integer", "format": "int32", "nullable": true, "example": 0 }, "centerID": { "type": "integer", "format": "int32", "nullable": true, "example": 0 }, "shortName": { "type": "string", "nullable": true }, "remark": { "type": "string", "nullable": true }, "delivery": { "type": "boolean", "nullable": true }, "dropoff": { "type": "boolean", "nullable": true }, "geoLat": { "type": "number", "format": "double", "nullable": true, "example": 0 }, "geoLong": { "type": "number", "format": "double", "nullable": true, "example": 0 }, "address": { "allOf": [ { "$ref": "#/components/schemas/CNAddress" } ], "nullable": true }, "psPlace": { "type": "string", "nullable": true }, "psZipcode": { "type": "string", "nullable": true }, "partner": { "type": "string", "nullable": true }, "workingHours": { "type": "array", "items": { "$ref": "#/components/schemas/CNWorkingHours" }, "nullable": true }, "isActive": { "type": "boolean" }, "isGWO": { "type": "boolean" }, "isPointPack": { "type": "boolean" }, "oohType": { "allOf": [ { "$ref": "#/components/schemas/OOHType" } ], "description": "0 = ParcelShop, 1 = Locker, 2 = SafeBox" }, "isCodAllowed": { "type": "boolean", "nullable": true }, "isExworkAllowed": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CNPerson": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "place": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "lineTelephone": { "type": "string", "nullable": true }, "lineTelephone2": { "type": "string", "nullable": true }, "long": { "type": "string", "nullable": true }, "lat": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "telephone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "gsm": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CNPickDelyIntervals": { "type": "object", "properties": { "name": { "type": "string", "description": "Location or depot name associated with these intervals.", "nullable": true }, "zipcode": { "type": "string", "description": "Postal code for which the pickup and delivery intervals apply.", "nullable": true }, "pickupIntervals": { "type": "array", "items": { "$ref": "#/components/schemas/CNTimeInterval" }, "description": "Available time intervals for courier pickup at this location.", "nullable": true }, "deliveryIntervals": { "type": "array", "items": { "$ref": "#/components/schemas/CNTimeInterval" }, "description": "Available time intervals for delivery at this location.", "nullable": true } }, "additionalProperties": false }, "CNPlace": { "type": "object", "properties": { "zipCode": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "zipcodeName": { "type": "string", "nullable": true }, "standardAvailable": { "type": "boolean", "nullable": true }, "cargoAvailable": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CNPrice": { "type": "object", "properties": { "totalPrice": { "type": "number", "description": "Total calculated price for the shipment.", "format": "double", "nullable": true, "example": 0 } }, "additionalProperties": false }, "CNPriceInfo": { "type": "object", "properties": { "unit": { "allOf": [ { "$ref": "#/components/schemas/CNUnit" } ], "description": "Billing unit details including type, name, and abbreviation.", "nullable": true }, "count": { "type": "number", "description": "Number of billing units used for pricing (e.g., weight in kg, number of pallets).", "format": "double", "nullable": true, "example": 0 }, "numberOfCollies": { "type": "integer", "description": "Total number of packages (collies) in the shipment.", "format": "int32", "nullable": true, "example": 0 }, "net": { "type": "number", "description": "Net price excluding taxes and fees.", "format": "double", "example": 0 }, "gross": { "type": "number", "description": "Gross price including all taxes and fees.", "format": "double", "example": 0 }, "vat": { "type": "number", "description": "VAT amount applied to the shipment.", "format": "double", "nullable": true, "example": 0 }, "taxRate": { "type": "number", "description": "Tax rate percentage applied to the shipment price.", "format": "double", "nullable": true, "example": 0 }, "shippingFee": { "type": "number", "description": "Additional shipping fee, if applicable.", "format": "double", "nullable": true, "example": 0 } }, "additionalProperties": false }, "CNReturnSticker": { "type": "object", "properties": { "pkey": { "type": "integer", "format": "int32", "example": 0 }, "createTime": { "type": "string", "format": "date-time", "nullable": true }, "returnCreateTime": { "type": "string", "format": "date-time", "nullable": true }, "createdBy": { "type": "integer", "format": "int64", "nullable": true, "example": 0 }, "returnCreatedBy": { "type": "integer", "format": "int32", "nullable": true, "example": 0 }, "info": { "type": "string", "nullable": true }, "fullID": { "type": "string", "nullable": true }, "originalShipment": { "allOf": [ { "$ref": "#/components/schemas/OriginalShipment" } ], "nullable": true } }, "additionalProperties": false }, "CNRoute": { "type": "object", "properties": { "routeID": { "type": "integer", "format": "int32", "nullable": true, "example": 0 }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CNShipment": { "type": "object", "properties": { "shipmentID": { "type": "integer", "description": "Unique system-generated identifier for this shipment.", "format": "int64", "nullable": true, "example": 0 }, "cargoID": { "type": "integer", "description": "Carrier-assigned cargo identifier.", "format": "int64", "nullable": true, "example": 0 }, "countryID": { "type": "integer", "description": "Internal country identifier.", "format": "int32", "nullable": true, "example": 0 }, "centerID": { "type": "integer", "description": "Internal distribution center identifier.", "format": "int32", "nullable": true, "example": 0 }, "parcelShop": { "allOf": [ { "$ref": "#/components/schemas/CNParcelShop" } ], "description": "Parcel shop designated for last-mile delivery.", "nullable": true }, "dropOffParcelShop": { "allOf": [ { "$ref": "#/components/schemas/CNParcelShop" } ], "description": "Parcel shop where the sender dropped off the shipment.", "nullable": true }, "client": { "allOf": [ { "$ref": "#/components/schemas/CNClient" } ], "description": "Customer account details associated with this shipment.", "nullable": true }, "receiverDepo": { "allOf": [ { "$ref": "#/components/schemas/CNDepo" } ], "description": "Receiving depot responsible for last-mile delivery.", "nullable": true }, "gwReceiverDepo": { "allOf": [ { "$ref": "#/components/schemas/CNDepo" } ], "description": "Gateway receiving depot for international shipments.", "nullable": true }, "receiverRoute": { "allOf": [ { "$ref": "#/components/schemas/CNRoute" } ], "description": "Delivery route assigned to this shipment.", "nullable": true }, "receiverRouteNumber": { "type": "integer", "description": "Numeric route code for the delivery route.", "format": "int32", "nullable": true, "example": 0 }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/CNEvent" }, "description": "List of tracking events recorded for this shipment.", "nullable": true }, "prices": { "allOf": [ { "$ref": "#/components/schemas/CNPrice" } ], "description": "Pricing information for this shipment.", "nullable": true }, "parent": { "allOf": [ { "$ref": "#/components/schemas/CNShipment" } ], "description": "Parent shipment when this record is a colli (child package).", "nullable": true }, "collies": { "type": "array", "items": { "$ref": "#/components/schemas/CNShipment" }, "description": "List of child packages (collies) when this is a master shipment.", "nullable": true }, "codDetails": { "allOf": [ { "$ref": "#/components/schemas/CNCOD" } ], "description": "Cash-on-delivery details for this shipment.", "nullable": true }, "returnSticker": { "allOf": [ { "$ref": "#/components/schemas/CNReturnSticker" } ], "description": "Return sticker details attached to the shipment.", "nullable": true }, "isPickup": { "type": "boolean", "description": "When true, the shipment was created as a pickup.", "nullable": true }, "sendDate": { "type": "string", "description": "Date the shipment was sent (ISO 8601 format).", "nullable": true }, "createDate": { "type": "string", "description": "Date the shipment was created (ISO 8601 format).", "nullable": true }, "isReturnDocument": { "type": "boolean", "description": "When true, a return document is attached to this shipment.", "nullable": true }, "apiStatus": { "allOf": [ { "$ref": "#/components/schemas/APIShipmentStatusFlag" } ], "description": "Combined status flags representing the current shipment lifecycle state. Legacy !", "nullable": true }, "colliNr": { "type": "integer", "description": "Package sequence number within the master shipment (e.g., 1 of 3).", "format": "int32", "nullable": true, "example": 0 }, "pickupRemark": { "type": "string", "description": "Remark for the courier at pickup (max 255 characters).", "nullable": true }, "deliveryRemark": { "type": "string", "description": "Remark for the courier at delivery (max 255 characters).", "nullable": true }, "remark": { "type": "string", "description": "General remark or contents description for the shipment (max 150 characters).", "nullable": true }, "cosignee": { "allOf": [ { "$ref": "#/components/schemas/CNPerson" } ], "description": "Recipient (consignee) contact and address details.", "nullable": true }, "sender": { "allOf": [ { "$ref": "#/components/schemas/CNPerson" } ], "description": "Sender contact and address details.", "nullable": true }, "unit": { "allOf": [ { "$ref": "#/components/schemas/CNUnit" } ], "description": "Billing unit type used for pricing this shipment.", "nullable": true }, "count": { "type": "number", "description": "Number of billing units (e.g., weight in kg, number of pallets).", "format": "double", "nullable": true, "example": 0 }, "declaredWeight": { "type": "number", "description": "Weight declared by the sender at shipment creation.", "format": "double", "nullable": true, "example": 0 }, "verifiedWeight": { "type": "number", "description": "Weight verified by the carrier after measurement.", "format": "double", "nullable": true, "example": 0 }, "cod": { "type": "number", "description": "Cash-on-delivery amount to collect from the consignee.", "format": "double", "nullable": true, "example": 0 }, "codToPay": { "type": "number", "description": "Remaining COD amount yet to be collected.", "format": "double", "nullable": true, "example": 0 }, "exWorks": { "type": "number", "description": "Ex-works amount charged to the sender.", "format": "double", "nullable": true, "example": 0 }, "exWorksToPay": { "type": "number", "description": "Remaining ex-works amount yet to be paid.", "format": "double", "nullable": true, "example": 0 }, "exWorksPickToPay": { "type": "number", "description": "Ex-works pickup amount yet to be paid.", "format": "double", "nullable": true, "example": 0 }, "exWorksType": { "type": "integer", "description": "Ex-works collection type identifier. Must be 4 (PaidByReceiver).", "format": "int32", "nullable": true, "example": 0 }, "cppAmount": { "type": "number", "description": "Cash-pickup-payment (CPP) amount the sender must pay. Omitted when the shipment has no CPP.", "format": "double", "nullable": true, "example": 0 }, "cppCurrency": { "type": "string", "description": "Currency of the CPP amount (e.g. EUR). Omitted when the shipment has no CPP or the currency is not set.", "nullable": true }, "cppCollectionStatus": { "type": "string", "description": "CPP collection status: Collected, NotCollected, CollectionFailed, CollectionCancelled or CollectionRejected. Omitted when the shipment has no CPP.", "nullable": true }, "isCargo": { "type": "boolean", "description": "When true, the shipment is classified as cargo type.", "nullable": true }, "isCanceled": { "type": "boolean", "description": "When true, the shipment has been canceled.", "nullable": true }, "isPrinted": { "type": "boolean", "description": "When true, the shipment label has been printed.", "nullable": true }, "isMaster": { "type": "boolean", "description": "When true, this is a master shipment containing multiple collies.", "nullable": true }, "documentCollection": { "type": "boolean", "description": "When true, document collection service is active for this shipment.", "nullable": true }, "notificationType": { "type": "integer", "description": "Notification channel type for consignee delivery alerts (e.g., SMS, email).", "format": "int32", "nullable": true, "example": 0 }, "ref1": { "type": "string", "description": "Customer reference 1 (max 35 characters).", "nullable": true }, "ref2": { "type": "string", "description": "Customer reference 2 (max 35 characters).", "nullable": true }, "ref3": { "type": "string", "description": "Customer reference 3 (max 35 characters).", "nullable": true }, "refInt": { "type": "string", "description": "International customer reference (max 35 characters).", "nullable": true }, "multifunctionalBarcode": { "type": "string", "description": "Primary barcode used for scanning and tracking this shipment.", "nullable": true }, "internationalBarcode": { "type": "string", "description": "Barcode used for international routing.", "nullable": true }, "fullCargoID": { "type": "string", "description": "Full cargo identifier including carrier prefix.", "nullable": true }, "sortingDepoAndRoute": { "type": "string", "description": "Sorting depot and route code used for routing the shipment.", "nullable": true }, "pin": { "type": "string", "description": "PIN code required for parcel locker or secure delivery.", "nullable": true }, "servicesLabel": { "type": "string", "description": "Service codes label summarizing active services on the shipment.", "nullable": true }, "commissionType": { "allOf": [ { "$ref": "#/components/schemas/CommissionTypeFlag" } ], "description": "Commission type flags associated with this shipment.", "nullable": true }, "nesyBarcode": { "type": "string", "nullable": true }, "nesyShipmentId": { "type": "string", "nullable": true }, "barcode": { "type": "string", "description": "Primary scanning barcode for this package.", "nullable": true }, "insuranceValue": { "type": "number", "description": "Declared monetary value of the shipment for insurance purposes.", "format": "double", "example": 0 }, "insuranceCurrency": { "type": "string", "description": "Currency of the declared insurance value.", "nullable": true } }, "additionalProperties": false }, "CNShipmentIdDto": { "type": "object", "properties": { "shipmentID": { "type": "string", "description": "Unique system-generated identifier of the associated shipment.", "nullable": true } }, "additionalProperties": false }, "CNTimeInterval": { "type": "object", "properties": { "from": { "type": "string", "description": "Start time of the interval (format: HH:mm).", "nullable": true }, "until": { "type": "string", "description": "End time of the interval (format: HH:mm).", "nullable": true } }, "additionalProperties": false }, "CNUnit": { "type": "object", "properties": { "unitID": { "type": "integer", "description": "Internal identifier for the billing unit type.", "format": "int32", "nullable": true, "example": 0 }, "name": { "type": "string", "description": "Full name of the billing unit (e.g., \"Kilogram\").", "nullable": true }, "abbreviatedName": { "type": "string", "description": "Abbreviated name of the billing unit (e.g., \"kg\").", "nullable": true }, "description": { "type": "string", "description": "Description of the billing unit and how it is applied.", "nullable": true } }, "additionalProperties": false }, "CNWarehouseItem": { "type": "object", "properties": { "itemCode": { "type": "string", "description": "Unique code identifying this warehouse item (e.g., packaging material or label type).", "nullable": true }, "description": { "type": "string", "description": "Human-readable description of the warehouse item.", "nullable": true }, "currentAmount": { "type": "number", "description": "Current stock quantity of this item in the warehouse.", "format": "double", "nullable": true, "example": 0 }, "type": { "allOf": [ { "$ref": "#/components/schemas/CommissioningItemType" } ], "description": "Category type of the commissioning item (e.g., label, packaging).", "nullable": true } }, "additionalProperties": false }, "CNWarehouseTraffic": { "type": "object", "properties": { "item": { "allOf": [ { "$ref": "#/components/schemas/CNWarehouseItem" } ], "description": "The warehouse item this traffic record applies to.", "nullable": true }, "shipment": { "allOf": [ { "$ref": "#/components/schemas/CNShipmentIdDto" } ], "description": "The shipment associated with this stock movement, if applicable.", "nullable": true }, "operation": { "allOf": [ { "$ref": "#/components/schemas/WarehouseTrafficOperation" } ], "description": "Type of stock movement (e.g., addition or removal).", "nullable": true }, "commitedOn": { "type": "string", "description": "Date and time when the stock movement was committed.", "format": "date-time", "nullable": true }, "description": { "type": "string", "description": "Description or reason for this stock movement.", "nullable": true }, "serialNumber": { "type": "string", "description": "Serial number of the item involved in this movement, if applicable.", "nullable": true }, "amount": { "type": "number", "description": "Quantity of items moved in this traffic record.", "format": "double", "nullable": true, "example": 0 } }, "additionalProperties": false }, "CNWorkingHours": { "type": "object", "properties": { "type": { "type": "integer", "format": "int32", "nullable": true, "example": 0 }, "typeName": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true }, "until": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CheckCountryEligibilityData": { "type": "object", "properties": { "isEligible": { "type": "boolean" } }, "additionalProperties": false }, "ClientAPIAddColliesResultDto": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIResultStatus" } ], "description": "0 = OK, 1 = Error, 2 = ValidationFailed" }, "validations": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAPIValidation" }, "nullable": true }, "error": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIError" } ], "nullable": true }, "traceID": { "type": "string", "nullable": true }, "colliIds": { "type": "array", "items": { "type": "string" }, "description": "List of barcode IDs for the collies that were added or removed.", "nullable": true }, "shipmentId": { "type": "integer", "description": "ID of the shipment that was modified.", "format": "int64", "example": 0 } }, "additionalProperties": false }, "ClientAPIAddUpdateSenderRequestDto": { "required": [ "city", "countryCode", "name", "streetAndNumber" ], "type": "object", "properties": { "senderID": { "type": "integer", "description": "ID of the sender address to update. If null, a new sender address is created.", "format": "int32", "nullable": true, "example": 0 }, "name": { "minLength": 1, "type": "string", "description": "Name of the sender. Required." }, "countryCode": { "minLength": 1, "type": "string", "description": "ISO country code of the sender address. Required." }, "zipcode": { "type": "string", "description": "Postal/zip code of the sender address.", "nullable": true }, "city": { "minLength": 1, "type": "string", "description": "City of the sender address. Required." }, "streetAndNumber": { "minLength": 1, "type": "string", "description": "Street name and house number of the sender address. Required." }, "telephone": { "type": "string", "description": "Telephone number of the sender.", "nullable": true }, "fax": { "type": "string", "description": "Fax number of the sender.", "nullable": true }, "notifyGSM": { "type": "string", "description": "Mobile number used to notify the sender (e.g. via SMS).", "nullable": true }, "notifyEmail": { "type": "string", "description": "Email address used to notify the sender.", "nullable": true } }, "additionalProperties": false }, "ClientAPIAddUpdateSenderResultDto": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIResultStatus" } ], "description": "0 = OK, 1 = Error, 2 = ValidationFailed" }, "validations": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAPIValidation" }, "nullable": true }, "error": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIError" } ], "nullable": true }, "traceID": { "type": "string", "nullable": true }, "senderId": { "type": "integer", "description": "ID of the created or updated sender address. Use this value with SenderID to reference this sender in future requests.", "format": "int64", "example": 0 } }, "additionalProperties": false }, "ClientAPICancelShipmentsResultDto": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIResultStatus" } ], "description": "0 = OK, 1 = Error, 2 = ValidationFailed" }, "validations": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAPIValidation" }, "nullable": true }, "shipmentids": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 0 }, "nullable": true }, "traceID": { "type": "string", "nullable": true }, "error": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIError" } ], "nullable": true } }, "additionalProperties": false }, "ClientAPICheckCountryEligibilityResultDto": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIResultStatus" } ], "description": "0 = OK, 1 = Error, 2 = ValidationFailed" }, "validations": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAPIValidation" }, "nullable": true }, "error": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIError" } ], "nullable": true }, "traceID": { "type": "string", "nullable": true }, "data": { "allOf": [ { "$ref": "#/components/schemas/CheckCountryEligibilityData" } ], "nullable": true } }, "additionalProperties": false }, "ClientAPICreateShipmentRequest": { "required": [ "cosignee" ], "type": "object", "properties": { "senderID": { "type": "integer", "description": "Registered sender account ID. Can't be used with Sender field. If null Sender is not given, the authenticated customer's default sender is used.", "format": "int32", "nullable": true, "example": 0 }, "cosignee": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "description": "Recipient (consignee) address details. Consignee is a required field" }, "sender": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "description": "Sender address details. Can't be used with SenderId", "nullable": true }, "cosigneeNotifyType": { "allOf": [ { "$ref": "#/components/schemas/CosigneeNotifyTypes" } ], "description": "Notification channel for alerting the consignee about delivery (e.g., SMS, email).", "nullable": true }, "isSenderNonCustomer": { "type": "boolean", "description": "Set to true when the shipment is remote pickup", "nullable": true }, "deliveryParcelLocker": { "type": "string", "description": "Target parcel locker code for last-mile delivery. Mutually exclusive with DeliveryParcelShop.", "nullable": true }, "dropOffParcelLocker": { "type": "string", "description": "Parcel locker code where the sender will drop off the shipment. Mutually exclusive with DropOffParcelShop.", "nullable": true }, "numberOfCollies": { "type": "integer", "description": "Number of packages (collies) in the shipment (max 999). Can't be used with Collies field", "format": "int32", "nullable": true, "example": 0 }, "unitType": { "allOf": [ { "$ref": "#/components/schemas/PricingUnitType" } ], "description": "Unit type for shipment-level pricing. If null or not sent, the system default is used.", "nullable": true }, "unitAmount": { "type": "number", "description": "Unit amount for shipment-level pricing. Decimal numbers must use a dot (.) as the separator (e.g., 1234.56).", "format": "double", "nullable": true, "example": 0 }, "ref1": { "type": "string", "description": "Reference 1 value for the shipment (max 35 characters).", "nullable": true }, "ref2": { "type": "string", "description": "Reference 2 value for the shipment (max 35 characters).", "nullable": true }, "ref3": { "type": "string", "description": "Reference 3 value for the shipment (max 35 characters).", "nullable": true }, "refInt": { "type": "string", "description": "International reference for the shipment (max 35 characters).", "nullable": true }, "exWorksType": { "type": "integer", "description": "Ex-works collection type identifier. Must be 4 (PaidByReceiver)", "format": "int32", "nullable": true, "example": 0 }, "codValue": { "type": "number", "description": "Cash-on-delivery amount to collect from the consignee. Decimal numbers must use a dot (.) as the separator (e.g., 1234.56).", "format": "double", "nullable": true, "example": 0 }, "codCurrency": { "type": "integer", "description": "Currency code for the cash-on-delivery amount. Required when CODValue is set.", "format": "int32", "nullable": true, "example": 0 }, "codIban": { "type": "string", "description": "IBAN of the bank account to which COD funds will be transferred.", "nullable": true }, "codBicSwift": { "type": "string", "description": "BIC/SWIFT code for the COD bank transfer. Required for international IBAN accounts.", "nullable": true }, "dopService": { "type": "boolean", "description": "Package Opening Allowed service" }, "cargo": { "type": "boolean", "description": "Marks the shipment as cargo type, applying cargo-specific handling and routing rules." }, "returnDocument": { "type": "boolean", "description": "Attaches a return document to the shipment. The consignee must sign it upon delivery and it is returned to sender." }, "remark": { "type": "string", "description": "Shipment contents description or general remark (max 150 characters).", "nullable": true }, "pickupRemark": { "type": "string", "description": "Remark for the courier regarding shipment pickup (max 255 characters).", "nullable": true }, "deliveryRemark": { "type": "string", "description": "Remark for the courier regarding shipment delivery (max 255 characters).", "nullable": true }, "prefferedPickupTime": { "type": "string", "description": "Preferred pickup date and time. The system assigns the nearest available slot if the requested time is unavailable.", "format": "date-time", "nullable": true }, "dropOffParcelShop": { "type": "string", "description": "Parcel shop code where the sender will drop off the shipment. Mutually exclusive with DropOffParcelLocker.", "nullable": true }, "deliveryParcelShop": { "type": "string", "description": "Target parcel shop code for last-mile delivery. Mutually exclusive with DeliveryParcelLocker.", "nullable": true }, "pdfAttachmentBase64": { "type": "string", "description": "Base64-encoded PDF document to attach to the shipment. It is only used for commissioning shipments.", "nullable": true }, "commissionType": { "allOf": [ { "$ref": "#/components/schemas/CommissionTypeFlag" } ], "description": "Flag indicating which commission types apply to this shipment." }, "commissions": { "type": "array", "items": { "$ref": "#/components/schemas/CNCommission" }, "description": "List of commission entries associated with this shipment.", "nullable": true }, "collies": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAPICreateShipmentRequestColliDto" }, "description": "Individual package (colli) details. Use when packages differ in weight, references, or barcodes. Can't be used with numberofcollies field", "nullable": true }, "noSticker": { "type": "boolean", "description": "When true, suppresses label/sticker generation for this shipment.", "nullable": true }, "insuranceValue": { "type": "number", "description": "Declared monetary value of the shipment for insurance purposes. Decimal numbers must use a dot (.) as the separator (e.g., 1234.56).", "format": "double", "nullable": true, "example": 0 }, "insuranceCurrency": { "allOf": [ { "$ref": "#/components/schemas/CurrencyAttribute" } ], "description": "Currency of the declared insurance value.", "nullable": true }, "returnAddress": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "description": "Return address if delivery fails. Defaults to the sender address when not specified.", "nullable": true }, "deliveryLocation": { "allOf": [ { "$ref": "#/components/schemas/HubModel" } ], "description": "Hub delivery location for shipments routed through a specific distribution hub. Leave it empty to let system decide it", "nullable": true }, "returnDelivered": { "type": "boolean", "description": "When true, the shipment is returned to sender automatically after a successful delivery confirmation." }, "deliveryUntil12": { "type": "boolean", "description": "When true, Requests delivery before 12:00 noon. Subject to service availability in the delivery area." }, "documentCollection": { "type": "boolean", "description": "Set true for Document collection service." }, "eDocumentCollection": { "type": "boolean", "description": "Set true for Electronic document collection service." }, "personalDelivery": { "type": "boolean", "description": "Set true for Personal delivery Service" }, "saturdayDelivery": { "type": "boolean", "description": "Set true for Saturday delivery service" }, "flexService": { "type": "boolean", "description": "Set true for Flex Service" }, "guaranteedDelivery": { "type": "boolean", "description": "Set true for Guaranteed delivery service" }, "virtualShipment": { "type": "boolean", "description": "Set true for Virtual shipment service" }, "isAutoRedirectRequested": { "type": "boolean", "description": "When true, the system automatically redirects the shipment to an parcelshop/parcellocker location within an available distance. Customer should be allowed to use this action" } }, "additionalProperties": false }, "ClientAPICreateShipmentRequestColliDto": { "type": "object", "properties": { "unitType": { "allOf": [ { "$ref": "#/components/schemas/PricingUnitType" } ], "description": "Unit type for pricing this individual package. Overrides the shipment-level UnitType when set.", "nullable": true }, "unitAmount": { "type": "number", "description": "Unit amount for pricing this individual package. Decimal numbers must use a dot (.) as the separator (e.g., 1234.56).", "format": "double", "nullable": true, "example": 0 }, "ref1": { "type": "string", "description": "Reference 1 value for this package (max 35 characters).", "nullable": true }, "ref2": { "type": "string", "description": "Reference 2 value for this package (max 35 characters).", "nullable": true }, "ref3": { "type": "string", "description": "Reference 3 value for this package (max 35 characters).", "nullable": true }, "refInt": { "type": "string", "description": "International reference for this package (max 35 characters).", "nullable": true }, "remark": { "type": "string", "description": "Remark specific to this package (max 150 characters).", "nullable": true }, "barcode": { "type": "string", "description": "Custom barcode to assign to this package. If omitted, the system generates one automatically.", "nullable": true } }, "additionalProperties": false }, "ClientAPICreateShipmentResult": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIResultStatus" } ], "description": "0 = OK, 1 = Error, 2 = ValidationFailed" }, "validations": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAPIValidation" }, "nullable": true }, "error": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIError" } ], "nullable": true }, "shipmentid": { "type": "integer", "description": "ID of the created shipment. Use this value with ShipmentsById to retrieve full shipment details.", "format": "int64", "example": 0 }, "pickuptime": { "type": "string", "description": "Assigned pickup start time. May change if the shipment is committed or pickup is requested at a later date.", "nullable": true }, "pickupendtime": { "type": "string", "description": "Assigned pickup end time. May change if the shipment is committed or pickup is requested at a later date.", "format": "date-time", "nullable": true }, "deliverytime": { "type": "string", "description": "Expected delivery start time, calculated based on the assigned pickup window.", "nullable": true }, "deliveryendtime": { "type": "string", "description": "Expected delivery end time, calculated based on the assigned pickup window.", "nullable": true }, "cargoIDs": { "type": "array", "items": { "type": "string" }, "description": "List of cargo IDs assigned to this shipment. Populated only for cargo-type shipments.", "nullable": true }, "traceID": { "type": "string", "description": "Correlation trace ID for this API call. Include this value when reporting issues for faster diagnosis.", "nullable": true } }, "additionalProperties": false }, "ClientAPICreateShipmentWithBarcodeRequestDto": { "required": [ "cosignee" ], "type": "object", "properties": { "senderID": { "type": "integer", "description": "Registered sender account ID. Can't be used with Sender field. If null Sender is not given, the authenticated customer's default sender is used.", "format": "int32", "nullable": true, "example": 0 }, "cosignee": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "description": "Recipient (consignee) address details. Consignee is a required field" }, "sender": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "description": "Sender address details. Can't be used with SenderId", "nullable": true }, "cosigneeNotifyType": { "allOf": [ { "$ref": "#/components/schemas/CosigneeNotifyTypes" } ], "description": "Notification channel for alerting the consignee about delivery (e.g., SMS, email).", "nullable": true }, "isSenderNonCustomer": { "type": "boolean", "description": "Set to true when the shipment is remote pickup", "nullable": true }, "deliveryParcelLocker": { "type": "string", "description": "Target parcel locker code for last-mile delivery. Mutually exclusive with DeliveryParcelShop.", "nullable": true }, "dropOffParcelLocker": { "type": "string", "description": "Parcel locker code where the sender will drop off the shipment. Mutually exclusive with DropOffParcelShop.", "nullable": true }, "numberOfCollies": { "type": "integer", "description": "Number of packages (collies) in the shipment (max 999). Can't be used with Collies field", "format": "int32", "nullable": true, "example": 0 }, "unitType": { "allOf": [ { "$ref": "#/components/schemas/PricingUnitType" } ], "description": "Unit type for shipment-level pricing. If null or not sent, the system default is used.", "nullable": true }, "unitAmount": { "type": "number", "description": "Unit amount for shipment-level pricing. Decimal numbers must use a dot (.) as the separator (e.g., 1234.56).", "format": "double", "nullable": true, "example": 0 }, "ref1": { "type": "string", "description": "Reference 1 value for the shipment (max 35 characters).", "nullable": true }, "ref2": { "type": "string", "description": "Reference 2 value for the shipment (max 35 characters).", "nullable": true }, "ref3": { "type": "string", "description": "Reference 3 value for the shipment (max 35 characters).", "nullable": true }, "refInt": { "type": "string", "description": "International reference for the shipment (max 35 characters).", "nullable": true }, "exWorksType": { "type": "integer", "description": "Ex-works collection type identifier. Must be 4 (PaidByReceiver)", "format": "int32", "nullable": true, "example": 0 }, "codValue": { "type": "number", "description": "Cash-on-delivery amount to collect from the consignee. Decimal numbers must use a dot (.) as the separator (e.g., 1234.56).", "format": "double", "nullable": true, "example": 0 }, "codCurrency": { "type": "integer", "description": "Currency code for the cash-on-delivery amount. Required when CODValue is set.", "format": "int32", "nullable": true, "example": 0 }, "codIban": { "type": "string", "description": "IBAN of the bank account to which COD funds will be transferred.", "nullable": true }, "codBicSwift": { "type": "string", "description": "BIC/SWIFT code for the COD bank transfer. Required for international IBAN accounts.", "nullable": true }, "dopService": { "type": "boolean", "description": "Package Opening Allowed service" }, "cargo": { "type": "boolean", "description": "Marks the shipment as cargo type, applying cargo-specific handling and routing rules." }, "returnDocument": { "type": "boolean", "description": "Attaches a return document to the shipment. The consignee must sign it upon delivery and it is returned to sender." }, "remark": { "type": "string", "description": "Shipment contents description or general remark (max 150 characters).", "nullable": true }, "pickupRemark": { "type": "string", "description": "Remark for the courier regarding shipment pickup (max 255 characters).", "nullable": true }, "deliveryRemark": { "type": "string", "description": "Remark for the courier regarding shipment delivery (max 255 characters).", "nullable": true }, "prefferedPickupTime": { "type": "string", "description": "Preferred pickup date and time. The system assigns the nearest available slot if the requested time is unavailable.", "format": "date-time", "nullable": true }, "dropOffParcelShop": { "type": "string", "description": "Parcel shop code where the sender will drop off the shipment. Mutually exclusive with DropOffParcelLocker.", "nullable": true }, "deliveryParcelShop": { "type": "string", "description": "Target parcel shop code for last-mile delivery. Mutually exclusive with DeliveryParcelLocker.", "nullable": true }, "pdfAttachmentBase64": { "type": "string", "description": "Base64-encoded PDF document to attach to the shipment. It is only used for commissioning shipments.", "nullable": true }, "commissionType": { "allOf": [ { "$ref": "#/components/schemas/CommissionTypeFlag" } ], "description": "Flag indicating which commission types apply to this shipment." }, "commissions": { "type": "array", "items": { "$ref": "#/components/schemas/CNCommission" }, "description": "List of commission entries associated with this shipment.", "nullable": true }, "collies": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAPICreateShipmentRequestColliDto" }, "description": "Individual package (colli) details. Use when packages differ in weight, references, or barcodes. Can't be used with numberofcollies field", "nullable": true }, "noSticker": { "type": "boolean", "description": "When true, suppresses label/sticker generation for this shipment.", "nullable": true }, "insuranceValue": { "type": "number", "description": "Declared monetary value of the shipment for insurance purposes. Decimal numbers must use a dot (.) as the separator (e.g., 1234.56).", "format": "double", "nullable": true, "example": 0 }, "insuranceCurrency": { "allOf": [ { "$ref": "#/components/schemas/CurrencyAttribute" } ], "description": "Currency of the declared insurance value.", "nullable": true }, "returnAddress": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "description": "Return address if delivery fails. Defaults to the sender address when not specified.", "nullable": true }, "deliveryLocation": { "allOf": [ { "$ref": "#/components/schemas/HubModel" } ], "description": "Hub delivery location for shipments routed through a specific distribution hub. Leave it empty to let system decide it", "nullable": true }, "returnDelivered": { "type": "boolean", "description": "When true, the shipment is returned to sender automatically after a successful delivery confirmation." }, "deliveryUntil12": { "type": "boolean", "description": "When true, Requests delivery before 12:00 noon. Subject to service availability in the delivery area." }, "documentCollection": { "type": "boolean", "description": "Set true for Document collection service." }, "eDocumentCollection": { "type": "boolean", "description": "Set true for Electronic document collection service." }, "personalDelivery": { "type": "boolean", "description": "Set true for Personal delivery Service" }, "saturdayDelivery": { "type": "boolean", "description": "Set true for Saturday delivery service" }, "flexService": { "type": "boolean", "description": "Set true for Flex Service" }, "guaranteedDelivery": { "type": "boolean", "description": "Set true for Guaranteed delivery service" }, "virtualShipment": { "type": "boolean", "description": "Set true for Virtual shipment service" }, "isAutoRedirectRequested": { "type": "boolean", "description": "When true, the system automatically redirects the shipment to an parcelshop/parcellocker location within an available distance. Customer should be allowed to use this action" }, "barcode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ClientAPICreateShipmentWithBarcodeResponseDto": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIResultStatus" } ], "description": "0 = OK, 1 = Error, 2 = ValidationFailed" }, "validations": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAPIValidation" }, "nullable": true }, "error": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIError" } ], "nullable": true }, "traceID": { "type": "string", "nullable": true }, "shipmentid": { "type": "integer", "format": "int64", "example": 0 } }, "additionalProperties": false }, "ClientAPIError": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0 }, "message": { "type": "string", "nullable": true }, "stackTrace": { "type": "string", "nullable": true }, "innerException": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIError" } ], "nullable": true }, "validations": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAPIValidation" }, "nullable": true }, "messageParams": { "type": "array", "items": { "type": "string" }, "nullable": true }, "payload": { "allOf": [ { "$ref": "#/components/schemas/JToken" } ], "nullable": true } }, "additionalProperties": false }, "ClientAPIGetDeliveryTimeRequestDto": { "type": "object", "properties": { "pickupDate": { "type": "string", "description": "Requested pickup date. If null, the nearest available pickup date is used.", "format": "date-time", "nullable": true }, "pickupCountryCode": { "type": "string", "description": "ISO country code of the pickup address.", "nullable": true }, "pickupZipCode": { "type": "string", "description": "Postal/zip code of the pickup address.", "nullable": true }, "pickupCity": { "type": "string", "description": "City of the pickup address.", "nullable": true }, "deliveryCountryCode": { "type": "string", "description": "ISO country code of the delivery address.", "nullable": true }, "deliveryZipCode": { "type": "string", "description": "Postal/zip code of the delivery address.", "nullable": true }, "deliveryCity": { "type": "string", "description": "City of the delivery address.", "nullable": true }, "overseasPrintsLabels": { "type": "boolean", "description": "Set to true when the shipment is an overseas shipment that prints its own labels. Affects which delivery time rules are applied.", "nullable": true } }, "additionalProperties": false }, "ClientAPIGetDeliveryTimeResponseDto": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIResultStatus" } ], "description": "0 = OK, 1 = Error, 2 = ValidationFailed" }, "validations": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAPIValidation" }, "nullable": true }, "error": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIError" } ], "nullable": true }, "traceID": { "type": "string", "nullable": true }, "data": { "allOf": [ { "$ref": "#/components/schemas/DeliveryTimes" } ], "description": "Calculated pickup and delivery time details for the requested route.", "nullable": true } }, "additionalProperties": false }, "ClientAPILayoutsResultDto": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIResultStatus" } ], "description": "0 = OK, 1 = Error, 2 = ValidationFailed" }, "validations": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAPIValidation" }, "nullable": true }, "error": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIError" } ], "nullable": true }, "traceID": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CNLayout" }, "nullable": true } }, "additionalProperties": false }, "ClientAPIObsoleteShipmentResultDto": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIResultStatus" } ], "description": "0 = OK, 1 = Error, 2 = ValidationFailed" }, "validations": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAPIValidation" }, "nullable": true }, "data": { "allOf": [ { "$ref": "#/components/schemas/CNObsoleteShipment" } ], "nullable": true }, "error": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIError" } ], "nullable": true }, "traceID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ClientAPIPickupDelyIntervalsResultDto": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIResultStatus" } ], "description": "0 = OK, 1 = Error, 2 = ValidationFailed" }, "validations": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAPIValidation" }, "nullable": true }, "error": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIError" } ], "nullable": true }, "traceID": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CNPickDelyIntervals" }, "description": "List of available pickup and delivery intervals grouped by postal code.", "nullable": true } }, "additionalProperties": false }, "ClientAPIPickupsListResultDto": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIResultStatus" } ], "description": "0 = OK, 1 = Error, 2 = ValidationFailed" }, "validations": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAPIValidation" }, "nullable": true }, "shipmentids": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 0 }, "description": "List of shipment IDs associated with this pickup.", "nullable": true }, "pickupdocument": { "type": "string", "description": "Base64-encoded PDF pickup document for this pickup entry.", "nullable": true }, "pickupinterval": { "allOf": [ { "$ref": "#/components/schemas/TimeIntervalDate" } ], "description": "Scheduled pickup time interval for this pickup entry.", "nullable": true }, "error": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIError" } ], "description": "Error details if the request failed.", "nullable": true }, "traceID": { "type": "string", "description": "Unique trace identifier for debugging and support purposes.", "nullable": true } }, "additionalProperties": false }, "ClientAPIPlacesResultDto": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIResultStatus" } ], "description": "0 = OK, 1 = Error, 2 = ValidationFailed" }, "validations": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAPIValidation" }, "nullable": true }, "error": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIError" } ], "nullable": true }, "traceID": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CNPlace" }, "nullable": true } }, "additionalProperties": false }, "ClientAPIPriceInfoRequestDto": { "type": "object", "properties": { "pickupDate": { "type": "string", "description": "Requested pickup date for the shipment.", "format": "date-time" }, "senderZipCode": { "type": "string", "description": "Sender's postal/zip code.", "nullable": true }, "senderCountryPrefix": { "type": "string", "description": "Sender's country ISO code (e.g., \"DK\").", "nullable": true }, "cosigneeZipCode": { "type": "string", "description": "Consignee's postal/zip code.", "nullable": true }, "consigneeCountryPrefix": { "type": "string", "description": "Consignee's country ISO code (e.g., \"DK\").", "nullable": true }, "billingUnit": { "type": "integer", "description": "Billing unit type ID used for pricing the shipment.", "format": "int32", "nullable": true, "example": 0 }, "shipmentWeight": { "type": "number", "description": "Total weight of the shipment in the specified billing unit.", "format": "double", "nullable": true, "example": 0 }, "countOfBillingUnits": { "type": "number", "description": "Number of billing units (e.g., pallets, kilograms).", "format": "double", "nullable": true, "example": 0 }, "numberOfCollies": { "type": "integer", "description": "Total number of packages (collies) in the shipment.", "format": "int32", "nullable": true, "example": 0 }, "weights": { "type": "array", "items": { "type": "number", "format": "double", "example": 0 }, "description": "List of individual package weights. Used when packages have different weights.", "nullable": true }, "dropOffParcelShop": { "type": "string", "description": "Parcel shop code where the sender will drop off the shipment.", "nullable": true }, "pickupParcelShop": { "type": "string", "description": "Parcel shop code from which the shipment will be picked up.", "nullable": true }, "allowSaturdayDelivery": { "type": "boolean", "description": "When true, enables Saturday delivery pricing.", "nullable": true }, "isCargo": { "type": "boolean", "description": "When true, applies cargo-type pricing rules.", "nullable": true }, "returnDocument": { "type": "boolean", "description": "When true, includes a return document service in the price calculation.", "nullable": true }, "codAmount": { "type": "number", "description": "Cash-on-delivery amount to collect from the consignee. Decimal numbers must use a dot (.) as the separator (e.g., 1234.56).", "format": "double", "nullable": true, "example": 0 }, "exWorks": { "type": "boolean", "description": "When true, applies ex-works pricing rules.", "nullable": true } }, "additionalProperties": false }, "ClientAPIPriceInfoResultDto": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIResultStatus" } ], "description": "0 = OK, 1 = Error, 2 = ValidationFailed" }, "validations": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAPIValidation" }, "nullable": true }, "error": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIError" } ], "nullable": true }, "traceID": { "type": "string", "nullable": true }, "data": { "allOf": [ { "$ref": "#/components/schemas/CNPriceInfo" } ], "description": "Pricing details returned for the request.", "nullable": true } }, "additionalProperties": false }, "ClientAPIRequestPickUpAtAddress": { "type": "object", "properties": { "shipmentIDs": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 0 }, "description": "List of shipment IDs to include in this pickup request. If empty or omitted, all available shipments are included.", "nullable": true }, "pickupName": { "type": "string", "description": "Name of the contact person at the pickup address.", "nullable": true }, "pickupCity": { "type": "string", "description": "City of the pickup address.", "nullable": true }, "pickupZipcode": { "type": "string", "description": "Postal/zip code of the pickup address.", "nullable": true }, "pickupStreetAndNumber": { "type": "string", "description": "Street name and number of the pickup address.", "nullable": true } }, "additionalProperties": false }, "ClientAPIRequestPickupResultDto": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIResultStatus" } ], "description": "0 = OK, 1 = Error, 2 = ValidationFailed" }, "validations": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAPIValidation" }, "nullable": true }, "shipmentids": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 0 }, "description": "List of shipment IDs included in the created pickup.", "nullable": true }, "pickupdocuments": { "type": "array", "items": { "type": "string" }, "description": "Base64-encoded PDF pickup documents generated for this request. One document per pickup list number.", "nullable": true }, "pickupintervals": { "type": "array", "items": { "$ref": "#/components/schemas/TimeIntervalDate" }, "description": "Available pickup time intervals for the scheduled pickup.", "nullable": true }, "pickupIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 0 }, "description": "List of pickup IDs created by this request.", "nullable": true }, "error": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIError" } ], "description": "Error details if the request failed.", "nullable": true }, "traceID": { "type": "string", "description": "Unique trace identifier for debugging and support purposes.", "nullable": true } }, "additionalProperties": false }, "ClientAPIResultStatus": { "enum": [ "OK", "Error", "ValidationFailed" ], "type": "string", "description": "0 = OK, 1 = Error, 2 = ValidationFailed" }, "ClientAPIReturnParcelResultDto": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIResultStatus" } ], "description": "0 = OK, 1 = Error, 2 = ValidationFailed" }, "validations": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAPIValidation" }, "nullable": true }, "error": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIError" } ], "nullable": true }, "traceID": { "type": "string", "nullable": true }, "shipmentId": { "type": "integer", "format": "int64", "example": 0 }, "labelsbase64": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ClientAPIRoutingInfoRequestDto": { "type": "object", "properties": { "countryCode": { "type": "string", "description": "ISO country code of the address to look up.", "nullable": true }, "streetAndNumber": { "type": "string", "description": "Street name and house number of the address to look up.", "nullable": true }, "place": { "type": "string", "description": "City/place of the address to look up.", "nullable": true }, "zipCode": { "type": "string", "description": "Postal/zip code of the address to look up.", "nullable": true } }, "additionalProperties": false }, "ClientAPIRoutingInfoResultDto": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIResultStatus" } ], "description": "0 = OK, 1 = Error, 2 = ValidationFailed" }, "validations": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAPIValidation" }, "nullable": true }, "error": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIError" } ], "nullable": true }, "traceID": { "type": "string", "nullable": true }, "routenr": { "type": "integer", "description": "Identifier of the delivery route assigned to the resolved address.", "format": "int32", "example": 0 }, "mandnr": { "type": "integer", "description": "ID of the hub/depot (mandant) that services the resolved address.", "format": "int32", "example": 0 }, "longtitude": { "type": "number", "description": "Longitude of the resolved address (rounded to 5 decimal places).", "format": "double", "example": 0 }, "latitude": { "type": "number", "description": "Latitude of the resolved address (rounded to 5 decimal places).", "format": "double", "example": 0 }, "cncenter": { "type": "integer", "description": "ID of the distribution center/hub that services the resolved address. Same value as mandnr.", "format": "int32", "example": 0 }, "shortcentername": { "type": "string", "description": "Short name of the hub/distribution center that services the resolved address.", "nullable": true }, "routebarcode": { "type": "string", "description": "Composite route barcode, built as \"{mandnr}-{routenr}\".", "nullable": true }, "index": { "type": "string", "description": "Reserved/legacy field, not currently populated.", "nullable": true } }, "additionalProperties": false }, "ClientAPIShipmentResult": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIResultStatus" } ], "description": "0 = OK, 1 = Error, 2 = ValidationFailed" }, "validations": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAPIValidation" }, "nullable": true }, "data": { "allOf": [ { "$ref": "#/components/schemas/CNShipment" } ], "description": "Shipment details returned for the request.", "nullable": true }, "error": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIError" } ], "description": "Error details if the request failed.", "nullable": true }, "traceID": { "type": "string", "description": "Unique trace identifier for debugging and support purposes.", "nullable": true } }, "additionalProperties": false }, "ClientAPIShipmentsResult": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIResultStatus" } ], "description": "0 = OK, 1 = Error, 2 = ValidationFailed" }, "validations": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAPIValidation" }, "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CNShipment" }, "description": "List of shipments returned for the request.", "nullable": true }, "error": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIError" } ], "description": "Error details if the request failed.", "nullable": true }, "traceID": { "type": "string", "description": "Unique trace identifier for debugging and support purposes.", "nullable": true } }, "additionalProperties": false }, "ClientAPIValidation": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0 }, "message": { "type": "string", "nullable": true }, "params": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ClientApiErrorCodes": { "type": "object", "properties": { "1024": { "description": "ShipmentNotFound" }, "1025": { "description": "SingleColliNotAllowedWithBarcode" }, "1026": { "description": "InvalidCargoIdLength" }, "1100": { "description": "ValidationFailed" }, "5000": { "description": "UnknownExternalError" }, "7000": { "description": "ApiKeyAuthFailed" }, "7011": { "description": "MissingConsigneeAddress" }, "7012": { "description": "ShipmentsNotFound" }, "7013": { "description": "CustomerNotFound" }, "7014": { "description": "ShipmentUpdateFailed" }, "7058": { "description": "DropOffCargoOrShipmentIdRequired" }, "7079": { "description": "ParcelshopOrPackageNumberRequired" }, "7080": { "description": "CommissionNotAllowedForCustomer" }, "7082": { "description": "ShipmentCanNotBeUpdated" }, "7083": { "description": "ShipmentAlreadyCommitted" }, "7084": { "description": "MissingFieldDate" }, "7085": { "description": "CancelEventParametersRequired" }, "7086": { "description": "InvalidOperationIdForParcelshop" }, "7089": { "description": "ShipmentNotInGivenParcelshopInventory" }, "7090": { "description": "ShipmentInventoryStatusInvalid" }, "7092": { "description": "CargoServiceDisabledForCustomer" }, "7093": { "description": "InternationalUserDomesticShipmentNotAllowed" }, "7094": { "description": "DomesticUserInternationalShipmentNotAllowed" }, "7215": { "description": "PickupNotFound" }, "7216": { "description": "CollieNotFound" }, "7217": { "description": "AddressNotFound" }, "7218": { "description": "CustomerUpdateFailed" }, "7219": { "description": "PriceInfoNotFound" }, "7220": { "description": "ParcelshopIdRequired" }, "7221": { "description": "CargoOrShipmentIdRequired" }, "7222": { "description": "HubNotFound" }, "7223": { "description": "ParcelDataNotFound" }, "7224": { "description": "ReturnAddressNotFound" }, "7225": { "description": "RequestBodyRequired" }, "7226": { "description": "DeliveryZipCodeRequired" }, "7227": { "description": "PickupZipCodeRequired" }, "7228": { "description": "NoUnprintedLabelsRemaining" }, "7229": { "description": "ShipmentAlreadyReturnShipment" }, "7230": { "description": "DeliveryParcelFailed" }, "7231": { "description": "ParcelCanNotBeReceived" }, "7232": { "description": "InventoryNotFoundForCargoId" }, "7233": { "description": "CustomerReturnLimitNotFound" }, "7234": { "description": "StickerAlreadyUsedOrNotFound" }, "7235": { "description": "ReturnStickersNotFound" }, "7236": { "description": "StickerDataNotFound" }, "7237": { "description": "ReturnParcelCanNotBeCreated" }, "7238": { "description": "WarehouseItemsNotFound" }, "7239": { "description": "WarehouseTrafficNotFound" }, "7240": { "description": "InvalidDeliveryParcelLocation" }, "7241": { "description": "InvalidDropoffParcelLocation" }, "7242": { "description": "OohNotFound" }, "7243": { "description": "InvalidShipmentDateInterval" }, "7244": { "description": "ShipmentCommitFailed" }, "7245": { "description": "CustomerPreferencesNotFound" }, "7246": { "description": "CustomerAddressOverwriteFailed" }, "7247": { "description": "ShipmentServicesUnavailable" }, "7248": { "description": "PickupRequestFailed" }, "7249": { "description": "ShipmentStatusCheckFailed" }, "7250": { "description": "ShipmentLabelNotFound" }, "7251": { "description": "RoutingInfoNotFound" }, "7252": { "description": "LabelLayoutNotFound" }, "7253": { "description": "InvalidCountryCode" }, "7254": { "description": "CountryServicesNotFound" }, "7255": { "description": "ShipmentCancelFailed" }, "7256": { "description": "PdfGenerationFailed" }, "7257": { "description": "ServiceShortCodeNotFound" }, "7258": { "description": "HolidaysNotFound" }, "7259": { "description": "ShipmentEventsNotFound" }, "7260": { "description": "InvalidReference" } }, "description": "Error codes that can appear in `Error.Code`. Property name is the numeric code; value is the error identifier." }, "ClientApiParcelShopsResultDto": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIResultStatus" } ], "description": "0 = OK, 1 = Error, 2 = ValidationFailed" }, "validations": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAPIValidation" }, "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CNParcelShop" }, "nullable": true }, "error": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIError" } ], "nullable": true }, "traceID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ClientApiSendersResultDto": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIResultStatus" } ], "description": "0 = OK, 1 = Error, 2 = ValidationFailed" }, "validations": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAPIValidation" }, "nullable": true }, "error": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIError" } ], "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/APISender" }, "nullable": true }, "traceID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ClientApiUserInfoResultDto": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIResultStatus" } ], "description": "0 = OK, 1 = Error, 2 = ValidationFailed" }, "validations": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAPIValidation" }, "nullable": true }, "error": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIError" } ], "nullable": true }, "overseasclientid": { "type": "integer", "format": "int32", "example": 0 }, "overseascargoclientid": { "type": "integer", "format": "int32", "example": 0 }, "webshopEnabled": { "type": "boolean" }, "webshopEnabledSenderInput": { "type": "boolean" }, "webshopReferrer": { "type": "string", "nullable": true }, "webshopMails": { "type": "string", "nullable": true }, "webshopMailType": { "type": "integer", "format": "int32", "nullable": true, "example": 0 }, "senders": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/APISender" }, "nullable": true }, "isInternationalUser": { "type": "boolean" }, "traceID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ClientApiValidationCodes": { "type": "object", "properties": { "2417": { "description": "Either SenderID or Sender structure can be used in one call, not both." }, "2418": { "description": "CosigneeCountryCode is mandatory!" }, "2419": { "description": "CosigneeZipcode je obvezen!" }, "2420": { "description": "CosigneeCity is mandatory!" }, "2421": { "description": "CosigneeName je predolg (max. 35 znakov)!" }, "2422": { "description": "CosigneeCountryCode is too long (3 character max)!" }, "2423": { "description": "CosigneeZipcode is too long (10 character max)!" }, "2424": { "description": "CosigneeCity is too long (35 character max)!" }, "2425": { "description": "CosigneeStreetAndNumber je predolg (max. 70 znakov)!" }, "2426": { "description": "CosigneeTelephone je predolg (max. 30 znakov)!" }, "2427": { "description": "CosigneeFax is too long (30 character max)!" }, "2428": { "description": "CosigneeNotifyGSM is too long (35 character max)!" }, "2429": { "description": "CosigneeNotifyEmail is too long (70 character max)!" }, "2430": { "description": "CosigneeNotificationType must be empty, 0, 1, 2 or 3!" }, "2431": { "description": "Either DeliveryParcelLocker or DeliveryParcelShop can be used in one call, not both." }, "2432": { "description": "Either DropOffParcelLocker or DropOffParcelShop can be used in one call, not both." }, "2433": { "description": "SenderName is mandatory for pickup!" }, "2434": { "description": "SenderCountryCode is mandatory!" }, "2435": { "description": "SenderZipcode is mandatory!" }, "2436": { "description": "Sender City is mandatory!" }, "2437": { "description": "Sender Name is too long (35 character max)!" }, "2438": { "description": "SenderCountryCode is too long (3 character max)!" }, "2439": { "description": "SenderZipcode is too long (10 character max)!" }, "2440": { "description": "Sender City is too long (35 character max)!" }, "2441": { "description": "SenderStreetAndNumber is too long (70 character max)!" }, "2442": { "description": "SenderTelephone is too long (30 character max)!" }, "2443": { "description": "SenderFax is too long (30 character max)!" }, "2444": { "description": "SenderNotifyGSM is too long (35 character max)!" }, "2445": { "description": "SenderNotifyEmail is too long (70 character max)!" }, "2446": { "description": "Either NumberOfCollies or Collies structure can be used in one call, not both." }, "2447": { "description": "UnitAmount can not be negative number" }, "2448": { "description": "NumberOfCollies can't be more than 999!" }, "2459": { "description": "numberofcolliestoremove size is bigger than exist collies!" }, "2460": { "description": "Ref1 is too long (35 character max)!" }, "2461": { "description": "Ref2 is too long (35 character max)!" }, "2462": { "description": "Ref3 is too long (35 character max)!" }, "2463": { "description": "RefInt is too long (35 character max)!" }, "2464": { "description": "Currency is mandatory if COD value is entered!" }, "2465": { "description": "Currency is not valid!" }, "2466": { "description": "Remark is too long (150 character max)!" }, "2467": { "description": "PickupRemark is too long (255 character max)!" }, "2468": { "description": "DeliveryRemark is too long (255 character max)!" }, "2469": { "description": "Invalid CommissionType: Value must be 0 (None), 1 (Document), 2 (Item), or 3 (DocumentAndItem)." }, "2470": { "description": "Commissions is mandatory if the CommissionType is either 'Item' or 'DocumentAndItem'." }, "2471": { "description": "PDFAttachmentBase64 is mandatory if the CommissionType is either 'Document' or 'DocumentAndItem'." }, "2472": { "description": "Invalid CommissionType: Cannot include Commissions for 'Document' CommissionType." }, "2473": { "description": "Invalid CommissionType: Cannot include PDFAttachmentBase64 for 'Item' CommissionType." }, "2474": { "description": "CommissionType must be 'DocumentAndItem' when both Commissions and PDFAttachmentBase64 are provided." }, "2475": { "description": "CommissionType must be 'Item' when only Commissions is provided." }, "2476": { "description": "CommissionType must be 'Document' when only PDFAttachmentBase64 is provided." }, "2477": { "description": "Both sender and consignee can not be international together!" }, "2478": { "description": "Country code is not eligible!" }, "2479": { "description": "City and zipcode do not match exactly!" }, "2480": { "description": "Given City and zipcode is not valid!" }, "2481": { "description": "Given City and zipcode is not valid! Multiple cities found with same name, need valid ZIP prefix." }, "2482": { "description": "Given City and zipcode is not valid! No cities found with matching ZIP prefix." }, "2483": { "description": "Given City and zipcode is not valid! Multiple cities found with same ZIP prefix." }, "2484": { "description": "Maximum 1 parcel is allowed for selected delivery locker." }, "2485": { "description": "Selected delivery point is not available for delivery." }, "2486": { "description": "Selected delivery point is not available for COD." }, "2487": { "description": "Selected delivery point is not available for ExWorks." }, "2488": { "description": "Selected dropoff point is not available for dropoff." }, "2489": { "description": "Selected dropoff point is not available for COD." }, "2490": { "description": "Selected dropoff point is not available for ExWorks." }, "2491": { "description": "Shipment has already printed." }, "2492": { "description": "Shipment has already cancelled." }, "2493": { "description": "Shipment has already committed." }, "2494": { "description": "Shipment has invalid commission status." }, "2497": { "description": "Shipment has not been printed yet." }, "2498": { "description": "Customer is not allowed to use commission service!" }, "2499": { "description": "Cargo service is disabled for this customer!" }, "2500": { "description": "International user must ship internationally!" }, "2501": { "description": "Non-international user must ship domestically!" }, "2502": { "description": "Invalid request parameters for pickup list! shipmentId or pickupslistnumber must be given" }, "2503": { "description": "NumberOfCollies must be greater than zero!" }, "2504": { "description": "Sender information is mandatory!" }, "2505": { "description": "Sender Name is mandatory!" }, "2506": { "description": "Sender Address is mandatory!" }, "2507": { "description": "Sender Address is too long (90 character max)!" }, "2508": { "description": "Sender PostalCode is mandatory!" }, "2509": { "description": "Sender PostalCode is too long (10 character max)!" }, "2510": { "description": "Sender's Phone is too long (35 character max)!" }, "2511": { "description": "Sender's Email is too long (70 character max)!" }, "2512": { "description": "Receiver information is mandatory!" }, "2513": { "description": "Receiver Name is mandatory!" }, "2514": { "description": "Receiver Name is too long (35 character max)!" }, "2515": { "description": "Receiver Address is mandatory!" }, "2516": { "description": "Receiver Address is too long (70 character max)!" }, "2517": { "description": "Receiver PostalCode is mandatory!" }, "2518": { "description": "Receiver PostalCode is too long (10 character max)!" }, "2519": { "description": "Receiver City is mandatory!" }, "2520": { "description": "Receiver City is too long (35 character max)!" }, "2521": { "description": "Receiver's Phone is too long (35 character max)!" }, "2522": { "description": "Receiver's Email is too long (70 character max)!" }, "2523": { "description": "The parcel is already returned!" }, "2524": { "description": "The shipment is not delivered yet!" }, "2525": { "description": "CosigneeStreetAndNumber is mandatory!" }, "2526": { "description": "Either OohId or NewAddress can be used in one call, not both." }, "2527": { "description": "OohId cannot be used together with skipPickup." }, "2528": { "description": "CosigneeZipcode is too short!" }, "2529": { "description": "SenderZipcode is too short!" }, "2530": { "description": "CosigneeZipcode format is invalid!" }, "2531": { "description": "SenderZipcode format is invalid!" }, "2532": { "description": "Parcelshop ID must be entered!" }, "2533": { "description": "Sticker or Shipment must be entered!" }, "2534": { "description": "Number of stickers must be greater than zero and less than or equal to 100!" }, "2535": { "description": "Sticker number must be entered!" }, "2536": { "description": "Return shipment creation failed!" }, "2537": { "description": "The selected OOH point is not active." }, "2538": { "description": "IBAN and BIC/Swift can only be used when COD is provided!" }, "2539": { "description": "UnitAmount is too high!" }, "2540": { "description": "Autoredirect preference is not approved for this API key" }, "2541": { "description": "Only national (0) insurance currency is allowed" }, "2542": { "description": "Required events are not found" }, "2543": { "description": "CosigneeName is mandatory!" }, "2544": { "description": "The requested services cannot be combined!" }, "2545": { "description": "The requested service is not available for this country!" }, "3001": { "description": "PackageNo is mandatory!" }, "3002": { "description": "OrderNo is mandatory!" }, "3003": { "description": "Only BusinessType 1 is currently supported." }, "3004": { "description": "PackageInfo is mandatory!" }, "3005": { "description": "PackageInfo Weight is mandatory and must be greater than 0!" }, "3006": { "description": "COD Currency is mandatory if COD value is entered!" }, "3007": { "description": "COD Currency is not valid!" } }, "description": "Validation codes that can appear in `Validations[]` when response `Status` is `2` (ValidationFailed). Property name is the numeric code; value is the message." }, "ClientApiWarehouseItemsResultDto": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIResultStatus" } ], "description": "0 = OK, 1 = Error, 2 = ValidationFailed" }, "validations": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAPIValidation" }, "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CNWarehouseItem" }, "description": "List of warehouse inventory items for the customer.", "nullable": true }, "error": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIError" } ], "description": "Error details if the request failed.", "nullable": true }, "traceID": { "type": "string", "description": "Unique trace identifier for debugging and support purposes.", "nullable": true } }, "additionalProperties": false }, "ClientApiWarehouseTrafficsResultDto": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIResultStatus" } ], "description": "0 = OK, 1 = Error, 2 = ValidationFailed" }, "validations": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAPIValidation" }, "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CNWarehouseTraffic" }, "description": "List of warehouse traffic records showing stock movements for the customer.", "nullable": true }, "error": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIError" } ], "description": "Error details if the request failed.", "nullable": true }, "traceID": { "type": "string", "description": "Unique trace identifier for debugging and support purposes.", "nullable": true } }, "additionalProperties": false }, "CommissionTypeFlag": { "enum": [ "None", "Document", "Item", "DocumentAndItem" ], "type": "string", "description": "0 = None, 1 = Document, 2 = Item, 3 = DocumentAndItem" }, "CommissioningItemType": { "enum": [ "ItemsPerBarcode", "SerialNumberTracking" ], "type": "string", "description": "0 = ItemsPerBarcode, 1 = SerialNumberTracking" }, "CosigneeNotifyTypes": { "enum": [ "NoNotifications", "Email", "SMS", "Both" ], "type": "string", "description": "0 = NoNotifications, 1 = Email, 2 = SMS, 3 = Both" }, "CountryCodeRequestDto": { "type": "object", "properties": { "countryCode": { "type": "string", "description": "Country code in ISO 3166-1 alpha-2 format (e.g., 'US' for the United States, 'DE' for Germany).", "nullable": true } }, "additionalProperties": false }, "CurrencyAttribute": { "enum": [ "National", "Euro", "CurrencyOfDestinationCountry", "MobilePaymentService", "CreditCard", "ReturnCashCRC" ], "type": "string", "description": "0 = National, 1 = Euro, 2 = CurrencyOfDestinationCountry, 3 = MobilePaymentService, 4 = CreditCard, 5 = ReturnCashCRC" }, "CustomerBffPublicEvents": { "type": "object", "properties": { "ABST": { "type": "integer", "description": "130", "readOnly": true }, "ADRU": { "type": "integer", "description": "80", "readOnly": true }, "BFRT": { "type": "integer", "description": "806", "readOnly": true }, "CASH": { "type": "integer", "description": "41", "readOnly": true }, "CLAC": { "type": "integer", "description": "331", "readOnly": true }, "CLAO": { "type": "integer", "description": "330", "readOnly": true }, "CODS": { "type": "integer", "description": "68", "readOnly": true }, "COPS": { "type": "integer", "description": "441", "readOnly": true }, "CUSC": { "type": "integer", "description": "205", "readOnly": true }, "CUSP": { "type": "integer", "description": "207", "readOnly": true }, "CUSR": { "type": "integer", "description": "206", "readOnly": true }, "DCOL": { "type": "integer", "description": "66", "readOnly": true }, "DDEF": { "type": "integer", "description": "8", "readOnly": true }, "DDSP": { "type": "integer", "description": "38", "readOnly": true }, "DELR": { "type": "integer", "description": "134", "readOnly": true }, "DELY": { "type": "integer", "description": "40", "readOnly": true }, "DEPO": { "type": "integer", "description": "70", "readOnly": true }, "DEPS": { "type": "integer", "description": "71", "readOnly": true }, "DEPT": { "type": "integer", "description": "72", "readOnly": true }, "DERC": { "type": "integer", "description": "73", "readOnly": true }, "DMGD": { "type": "integer", "description": "145", "readOnly": true }, "DOPS": { "type": "integer", "description": "470", "readOnly": true }, "DSPO": { "type": "integer", "description": "33", "readOnly": true }, "EMGY": { "type": "integer", "description": "95", "readOnly": true }, "ENTY": { "type": "integer", "description": "20", "readOnly": true }, "EXPS": { "type": "integer", "description": "190", "readOnly": true }, "FDLY": { "type": "integer", "description": "131", "readOnly": true }, "FRWD": { "type": "integer", "description": "280", "readOnly": true }, "IMPA": { "type": "integer", "description": "164", "readOnly": true }, "IMPI": { "type": "integer", "description": "200", "readOnly": true }, "INIT": { "type": "integer", "description": "10", "readOnly": true }, "IOD": { "type": "integer", "description": "42", "readOnly": true }, "IOND": { "type": "integer", "description": "43", "readOnly": true }, "LOST": { "type": "integer", "description": "62", "readOnly": true }, "MISS": { "type": "integer", "description": "9", "readOnly": true }, "NIGD": { "type": "integer", "description": "120", "readOnly": true }, "NLOC": { "type": "integer", "description": "160", "readOnly": true }, "NOPE": { "type": "integer", "description": "75", "readOnly": true }, "NRDY": { "type": "integer", "description": "76", "readOnly": true }, "NSYS": { "type": "integer", "description": "250", "readOnly": true }, "OVSZ": { "type": "integer", "description": "162", "readOnly": true }, "PABS": { "type": "integer", "description": "77", "readOnly": true }, "PADU": { "type": "integer", "description": "78", "readOnly": true }, "PDEF": { "type": "integer", "description": "998", "readOnly": true }, "PICK": { "type": "integer", "description": "44", "readOnly": true }, "PTIM": { "type": "integer", "description": "74", "readOnly": true }, "RCVU": { "type": "integer", "description": "110", "readOnly": true }, "REFU": { "type": "integer", "description": "100", "readOnly": true }, "RERT": { "type": "integer", "description": "290", "readOnly": true }, "RETS": { "type": "integer", "description": "260", "readOnly": true }, "RTWG": { "type": "integer", "description": "291", "readOnly": true }, "SRTF": { "type": "integer", "description": "96", "readOnly": true }, "STOR": { "type": "integer", "description": "300", "readOnly": true }, "TERM": { "type": "integer", "description": "299", "readOnly": true }, "TIME": { "type": "integer", "description": "90", "readOnly": true }, "TOTD": { "type": "integer", "description": "150", "readOnly": true }, "TOUR": { "type": "integer", "description": "30", "readOnly": true }, "TRAS": { "type": "integer", "description": "170", "readOnly": true }, "VACA": { "type": "integer", "description": "140", "readOnly": true }, "XDLY": { "type": "integer", "description": "132", "readOnly": true } }, "description": "Default event codes returned by BFF GET methods when the customer has no custom event preferences configured. Events outside this set are filtered out of responses." }, "DeliveryTimes": { "type": "object", "properties": { "sendDate": { "type": "string", "description": "Date the shipment is expected to be sent (dispatched) once picked up, based on the pickup route's availability.", "format": "date-time", "nullable": true }, "pickupDate": { "type": "string", "description": "First available pickup date for the requested pickup address, based on the pickup route's availability. Equals the requested PickupDate when that date is available.", "format": "date-time", "nullable": true }, "pickupZipCode": { "type": "string", "description": "Resolved postal/zip code of the pickup address, as recognized by the routing lookup.", "nullable": true }, "pickupCity": { "type": "string", "description": "Resolved city of the pickup address, as recognized by the routing lookup.", "nullable": true }, "deliveryZipCode": { "type": "string", "description": "Resolved postal/zip code of the delivery address, as recognized by the routing lookup.", "nullable": true }, "deliveryCity": { "type": "string", "description": "Resolved city of the delivery address, as recognized by the routing lookup.", "nullable": true }, "pickupIntervals": { "type": "array", "items": { "$ref": "#/components/schemas/TimeIntervalDate" }, "description": "Available pickup time windows for PickupDate.", "nullable": true }, "deliveryIntervals": { "type": "array", "items": { "$ref": "#/components/schemas/TimeIntervalDate" }, "description": "Available delivery time windows for the calculated delivery date.", "nullable": true }, "pickupPlaceValid": { "type": "boolean", "description": "Indicates whether the requested pickup address could be resolved to a valid, serviceable route." }, "deliveryPlaceValid": { "type": "boolean", "description": "Indicates whether the requested delivery address could be resolved to a valid, serviceable route." }, "isPickupPlaceExact": { "type": "boolean", "description": "True if the resolved pickup city and zip code exactly match the ones requested; false if the system fell back to the nearest serviceable match." }, "isDeliveryPlaceExact": { "type": "boolean", "description": "True if the resolved delivery city and zip code exactly match the ones requested; false if the system fell back to the nearest serviceable match." }, "pickupServiceFlags": { "type": "integer", "description": "Bitmask of coverage services (see CoverageServicesFlags) available for the pickup side of the route.", "format": "int32", "example": 0 }, "deliveryServiceFlags": { "type": "integer", "description": "Bitmask of coverage services (see CoverageServicesFlags) available for the delivery side of the route.", "format": "int32", "example": 0 } }, "additionalProperties": false }, "HubModel": { "type": "object", "properties": { "routeNumber": { "type": "integer", "format": "int32", "example": 0 }, "zipCode": { "type": "string", "nullable": true }, "routeName": { "type": "string", "nullable": true }, "hubId": { "type": "integer", "format": "int32", "example": 0 }, "hubName": { "type": "string", "nullable": true }, "hubShortName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ICommitShipmentResult": { "type": "object", "additionalProperties": false }, "ICommitShipmentResultClientAPIPrintShipmentsResultDto": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIResultStatus" } ], "description": "0 = OK, 1 = Error, 2 = ValidationFailed" }, "validations": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAPIValidation" }, "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ICommitShipmentResult" }, "nullable": true }, "labelsbase64": { "type": "string", "nullable": true }, "returnLabelsbase64": { "type": "string", "nullable": true }, "numberOfLabels": { "type": "integer", "format": "int32", "nullable": true, "example": 0 }, "error": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIError" } ], "nullable": true }, "traceID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "JToken": { "type": "array", "items": { "$ref": "#/components/schemas/JToken" } }, "OOHType": { "enum": [ "ParcelShop", "Locker", "SafeBox" ], "type": "string", "description": "0 = ParcelShop, 1 = Locker, 2 = SafeBox" }, "OriginalShipment": { "type": "object", "properties": { "fullCargoID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PricingUnitType": { "enum": [ "Weight", "Pallet", "Value", "Quantity", "PalletWeight", "Letter", "BoxA", "BoxB", "BoxC", "XLBox", "WeightPerUnit", "None", "All" ], "type": "string", "description": "0 = Weight, 4 = Pallet, 5 = Value, 7 = Quantity, 11 = PalletWeight, 12 = Letter, 13 = BoxA, 14 = BoxB, 15 = BoxC, 16 = XLBox, 17 = WeightPerUnit, -999 = None, -1 = All" }, "PrintRequestItem": { "type": "object", "properties": { "shipment": { "nullable": true }, "pickupsList": { "nullable": true }, "event": { "nullable": true }, "ordinal": { "type": "integer", "format": "int32", "example": 0 }, "total": { "type": "integer", "format": "int32", "example": 0 }, "shipmentID": { "type": "integer", "format": "int64", "example": 0 }, "cargoID": { "type": "string", "nullable": true }, "pickupsListId": { "nullable": true }, "eventTime": { "nullable": true }, "eventType": { "nullable": true }, "additional": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "ShipmentDataCargoId": { "type": "object", "properties": { "shipmentID": { "type": "integer", "format": "int64", "example": 0 }, "sdglfdNr": { "type": "integer", "format": "int64", "nullable": true, "example": 0 }, "landNr": { "type": "integer", "format": "int64", "nullable": true, "example": 0 }, "mandNr": { "type": "integer", "format": "int64", "nullable": true, "example": 0 } }, "additionalProperties": false }, "ShipmentDataCargoIdClientAPIPrintShipmentsResultDto": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIResultStatus" } ], "description": "0 = OK, 1 = Error, 2 = ValidationFailed" }, "validations": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAPIValidation" }, "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentDataCargoId" }, "nullable": true }, "labelsbase64": { "type": "string", "nullable": true }, "returnLabelsbase64": { "type": "string", "nullable": true }, "numberOfLabels": { "type": "integer", "format": "int32", "nullable": true, "example": 0 }, "error": { "allOf": [ { "$ref": "#/components/schemas/ClientAPIError" } ], "nullable": true }, "traceID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TimeIntervalDate": { "type": "object", "properties": { "from": { "type": "string", "description": "Start of the pickup/delivery interval (ISO 8601 datetime string).", "nullable": true }, "until": { "type": "string", "description": "End of the pickup/delivery interval (ISO 8601 datetime string).", "nullable": true } }, "additionalProperties": false }, "WarehouseTrafficOperation": { "enum": [ "SetInventory", "AddedQuantity", "RemovedQuantity", "CommissionEvent", "Canceled" ], "type": "string", "description": "0 = SetInventory, 1 = AddedQuantity, 3 = RemovedQuantity, 4 = CommissionEvent, 5 = Canceled" } }, "securitySchemes": { "apikey": { "type": "apiKey", "description": "API Key required for authentication.", "name": "apikey", "in": "query" } } }, "security": [ { "apikey": [ ] } ], "tags": [ { "name": "Integration Flows", "description": "Sequence diagrams showing which methods to call, and in which order, for each shipment integration pathway.\n\n### Standard Shipment\n\nClient prints out the label and orders pickup for the shipment.\n\n![Standard Shipment](/docs-assets/flows/standard-shipment-flow.svg)\n\n### Pickup at Third-Party Location\n\nClient creates a shipment that is to be picked up at another location. No label is printed and the shipment is picked up at the sender location.\n\n![Pickup at Third-Party Location](/docs-assets/flows/third-party-pickup-flow.svg)\n\n### Reprint Label\n\nReprints a label for a shipment that has already been committed.\n\n![Reprint Label](/docs-assets/flows/reprint-label-flow.svg)\n\n### Request Pickup at a Specific Address\n\nRequests pickup for committed shipments at an address other than the default, instead of using requestpickup.\n\n![Request Pickup at a Specific Address](/docs-assets/flows/request-pickup-at-address-flow.svg)\n\n### Find Shipments\n\nDifferent ways to look up shipments, depending on which identifier is available.\n\n![Find Shipments](/docs-assets/flows/get-shipment-flow.svg)\n\n### Parcel Shops Lookup\n\nLooks up available parcel shops and lockers for delivery or pickup.\n\n![Parcel Shops Lookup](/docs-assets/flows/lookup-parcelshops-flow.svg)\n\n### Places Lookup\n\nLooks up available delivery locations by name or zip code.\n\n![Places Lookup](/docs-assets/flows/lookup-places-flow.svg)\n\n" }, { "name": "LookupApi", "description": "Reference data: parcel shops, delivery points, geographic locations, label layouts, and routing information." }, { "name": "PickupApi", "description": "Pickup scheduling: request, list, and manage courier pickup appointments." }, { "name": "ShipmentApi", "description": "Shipment lifecycle management: create, update, commit, reprint labels, and cancel shipments." }, { "name": "ShipmentTrackingApi", "description": "Shipment tracking and retrieval: look up shipments by ID, reference number, or cargo ID." }, { "name": "UserApi", "description": "Account management: sender addresses, API user profile, and customer configuration." }, { "name": "WarehouseApi", "description": "Warehouse operations: inventory items, traffic records, and shipment ID map management." } ] }