{"openapi":"3.0.1","info":{"title":"DVA API: WMS Integration","description":"The DVA API facilitates the submission of data related to incoming goods processes to the DVA service.\nThis data may include general information such as an incoming goods protocol, as well as line-item level data like quantity variances.\nIt is integrated into a \"DVA goods receipt\" which represents the contents of a DESADV or RECADV, enriched with data from various sources,\nincluding product master data, to provide comprehensive information to users.\n\n**Target Audience:** This API is designed for third-party systems to automatically provide data about the\nincoming goods process without user intervention. Note that if a DVA goods receipt\nalready exists in the system (e.g. created by a DESADV or RECADV), the data will be\noverwritten. The Goods Receipt will also automatically be acknowledged/signed, which means\nno changes can be made through the UI, but updates can still happen through the\nREST APIs `PUT /goods-receipts` endpoint.\n\n**Available Servers:**\n- Demo Environment: https://api.demo.dva.markant.services\n- Production Environment: https://api.dva.markant.services\n\n","contact":{"name":"DVA Support","email":"dva.support@de.markant.com"},"version":"v1.5"},"servers":[{"url":"https://api.demo.dva.markant.services","description":"Generated server url"}],"security":[{"oauth":[]}],"tags":[{"name":"Goods Receipts API","description":"Operations for managing goods receipts in the warehouse management system.\n\n**Authentication Required:** All endpoints require OAuth 2.0 Bearer token authentication.\n\n**Important:**  If a DVA goods receipt\nalready exists in the system (e.g. created by a DESADV), the data will be\noverwritten. The Goods Receipt will also automatically be acknowledged/signed, which means\nno changes can be made through the UI, but updates can still happen through the\nREST APIs `PUT /goods-receipts` endpoint.\n"},{"name":"Transports API","description":"Operations for providing transport documents and information to the DVA system.\n\n**Authentication Required:** All endpoints require OAuth 2.0 Bearer token authentication.\n\n**Important:** Transport documents are used to create goods receipt bundles containing\nconsignment information. The system will automatically process transport data and create\ncorresponding goods receipts for each consignment.\n"},{"name":"Delivery Notes API","description":"Operations for providing delivery notes for the DVA system.\n\n**Authentication Required:** All endpoints require OAuth 2.0 Bearer token authentication.\n\n**Important:** Delivery notes are used to create goods receipt bundles in the DVA system.\nThe system will automatically process the delivery note data and create corresponding goods receipts.\n"},{"name":"Line Items API","description":"Operations for managing line items within goods receipts. Line items represent individual products or articles within a delivery."}],"paths":{"/v1/goods-receipts/{goodsReceiptId}":{"get":{"tags":["Goods Receipts API"],"summary":"Get goods receipt by ID","description":"Retrieves a specific goods receipt by its unique identifier with complete details including receiving advice and line items. The goods receipt ID is typically returned from the create operation.","operationId":"getGoodsReceiptById","parameters":[{"name":"goodsReceiptId","in":"path","description":"Unique identifier of the goods receipt to retrieve","required":true,"schema":{"type":"string"},"example":"123e4567-e89b-12d3-a456-426614174000"}],"responses":{"401":{"description":"Unauthorized - Invalid or missing Bearer token"},"403":{"description":"Forbidden - Token valid but insufficient permissions"},"500":{"description":"Internal server error - Contact support if this persists"},"200":{"description":"Successfully retrieved goods receipt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoodsReceiptResponseDto"}}}},"404":{"description":"Not Found - Goods receipt with the specified ID does not exist"}},"security":[{"oauth":[]}]},"put":{"tags":["Goods Receipts API"],"summary":"Update goods receipt","description":"Updates an existing goods receipt with new receiving advice information. This operation replaces the current receiving advice data with the provided data. The goods receipt must exist and not be acknowledged/signed yet.","operationId":"updateGoodsReceipt","parameters":[{"name":"goodsReceiptId","in":"path","description":"Unique identifier of the goods receipt to update","required":true,"schema":{"type":"string"},"example":"123e4567-e89b-12d3-a456-426614174000"}],"requestBody":{"description":"Updated goods receipt data with receiving advice information. Must include all required fields as specified in the API documentation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoodsReceiptUpdateDto"}}},"required":true},"responses":{"401":{"description":"Unauthorized - Invalid or missing Bearer token"},"403":{"description":"Forbidden - Token valid but insufficient permissions, or goods receipt is already acknowledged"},"409":{"description":"Conflict - Invalid state transition or concurrent modification detected"},"200":{"description":"Successfully updated goods receipt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoodsReceiptResponseDto"}}}},"500":{"description":"Internal server error - Contact support if this persists"},"404":{"description":"Not Found - Goods receipt with the specified ID does not exist"},"400":{"description":"Bad Request - Invalid request body, missing mandatory fields, or malformed JSON"},"422":{"description":"Unprocessable Entity - Request data is valid JSON but contains business logic errors"}},"security":[{"oauth":[]}]}},"/v1/goods-receipts/{goodsReceiptId}/line-items/{lineItemId}":{"get":{"tags":["Line Items API"],"summary":"Get line item by ID","description":"Retrieve a specific line item by its unique identifier.","operationId":"getLineItemById","parameters":[{"name":"goodsReceiptId","in":"path","description":"Unique identifier of the goods receipt","required":true,"schema":{"type":"string"},"example":"123e4567-e89b-12d3-a456-426614174000"},{"name":"lineItemId","in":"path","description":"Unique identifier of the line item","required":true,"schema":{"type":"string"},"example":"987fcdeb-51a2-43d1-9c4f-123456789abc"}],"responses":{"401":{"description":"Unauthorized - Invalid or missing Bearer token"},"403":{"description":"Forbidden - Token valid but insufficient permissions"},"500":{"description":"Internal server error - Contact support if this persists"},"200":{"description":"Successfully retrieved line item","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItemResponseDto"}}}},"404":{"description":"Not Found - Goods receipt or line item with the specified ID does not exist"}},"security":[{"oauth":[]}]},"put":{"tags":["Line Items API"],"summary":"Update line item","description":"Update an existing line item with new data.","operationId":"updateLineItem","parameters":[{"name":"goodsReceiptId","in":"path","description":"Unique identifier of the goods receipt","required":true,"schema":{"type":"string"},"example":"123e4567-e89b-12d3-a456-426614174000"},{"name":"lineItemId","in":"path","description":"Unique identifier of the line item","required":true,"schema":{"type":"string"},"example":"987fcdeb-51a2-43d1-9c4f-123456789abc"}],"requestBody":{"description":"Updated line item data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItemUpdateDto"}}},"required":true},"responses":{"401":{"description":"Unauthorized - Invalid or missing Bearer token"},"400":{"description":"Bad Request - Invalid request body or missing mandatory fields"},"403":{"description":"Forbidden - Token valid but insufficient permissions"},"500":{"description":"Internal server error - Contact support if this persists"},"200":{"description":"Successfully updated line item","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItemResponseDto"}}}},"404":{"description":"Not Found - Goods receipt or line item with the specified ID does not exist"}},"security":[{"oauth":[]}]},"delete":{"tags":["Line Items API"],"summary":"Delete line item","description":"Delete a specific line item from a goods receipt. This operation cannot be undone.","operationId":"deleteLineItem","parameters":[{"name":"goodsReceiptId","in":"path","description":"Unique identifier of the goods receipt","required":true,"schema":{"type":"string"},"example":"123e4567-e89b-12d3-a456-426614174000"},{"name":"lineItemId","in":"path","description":"Unique identifier of the line item","required":true,"schema":{"type":"string"},"example":"987fcdeb-51a2-43d1-9c4f-123456789abc"}],"responses":{"401":{"description":"Unauthorized - Invalid or missing Bearer token"},"204":{"description":"Successfully deleted line item"},"403":{"description":"Forbidden - Token valid but insufficient permissions"},"500":{"description":"Internal server error - Contact support if this persists"},"404":{"description":"Not Found - Goods receipt or line item with the specified ID does not exist"}},"security":[{"oauth":[]}]}},"/v2/transports":{"post":{"tags":["Transports API"],"summary":"Upload transport document","description":"Creates a new goods receipt bundle from a transport document JSON payload.\n\nThis endpoint processes the transport document data and automatically creates:\n- A goods receipt bundle containing the transport information\n- Individual goods receipts for each consignment within the transport and merging data of matching delivery notes in our database.\n\nThe transport document must contain valid header and body information including:\n- Carrier and consignee information\n- Transport consignments with partner details\n- Delivery dates and reference numbers\n\n**Note:** Each consignment in the transport will result in a separate goods receipt\nthat can be managed independently in the DVA system.\n","operationId":"uploadTransport","requestBody":{"description":"Transport document data containing header and body information with consignments","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransportDto"}}},"required":true},"responses":{"200":{"description":"Transport document processed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransportResponseDto"}}}},"401":{"description":"Unauthorized - Invalid or missing Bearer token"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DVAErrorResponse"}}}},"400":{"description":"Bad Request - Invalid transport document data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DVAErrorResponse"}}}},"422":{"description":"Unprocessable Entity - Validation errors in transport document data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DVAErrorResponse"}}}},"403":{"description":"Forbidden - Token valid but insufficient permissions (requires DVA_ADMIN or IG_EDITOR role)"}},"security":[{"oauth":[]}]}},"/v2/transports/{transportId}/consignments/{consignmentId}/delivery-note":{"post":{"tags":["Transports API"],"summary":"Upload delivery note for transport consignment","description":"Uploads a delivery note document (PDF, image, etc.) as an attachment to a specific\nconsignment within a transport.\n\nThis endpoint allows you to attach the original delivery note document to a consignment\nthat was previously created from transport document JSON data.\n\n**Supported file types:** PDF, PNG, JPEG\n**Maximum file size:** 20MB\n\nThe uploaded file will be stored as an attachment with type `ORIGINAL_DELIVERY_NOTE`\nand linked to the specific consignment.\n","operationId":"uploadDeliveryNote","parameters":[{"name":"transportId","in":"path","description":"The unique identifier of the transport containing the consignment","required":true,"schema":{"type":"string"},"example":"12345678-1234-1234-1234-123456789012"},{"name":"consignmentId","in":"path","description":"The unique identifier of the consignment to attach the delivery note to","required":true,"schema":{"type":"string"},"example":"87654321-4321-4321-4321-210987654321"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["content"],"type":"object","properties":{"content":{"type":"string","description":"The delivery note file to upload. Supported formats: PDF, PNG, JPEG. Maximum size: 20MB","format":"binary"}}}}}},"responses":{"401":{"description":"Unauthorized - Invalid or missing Bearer token"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DVAErrorResponse"}}}},"400":{"description":"Bad Request - Invalid file or missing mandatory fields","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransportConsignmentDeliveryNoteUploadResponseDto"}}}},"404":{"description":"Not Found - Transport or consignment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DVAErrorResponse"}}}},"403":{"description":"Forbidden - Token valid but insufficient permissions"},"415":{"description":"Unsupported Media Type - File type not supported","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransportConsignmentDeliveryNoteUploadResponseDto"}}}},"200":{"description":"Delivery note uploaded successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransportConsignmentDeliveryNoteUploadResponseDto"}}}},"413":{"description":"Payload Too Large - File size exceeds maximum allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransportConsignmentDeliveryNoteUploadResponseDto"}}}}},"security":[{"oauth":[]}]}},"/v1/goods-receipts":{"get":{"tags":["Goods Receipts API"],"summary":"Get all goods receipts","description":"Retrieves a paginated list of all goods receipts in the system with their complete details including receiving advice information. Use pagination parameters to control the number of results and sorting. By default, goods receipts are sorted by creation date (createdAt) with the newest goods receipts first. For polling use cases, the modifiedAfter parameter can be used to retrieve only goods receipts that have been modified after a specific timestamp. Additional filters can be applied using orderNumber, deliveryNoteNumber, referenceNumber, and deliveryPartyGln (combined with AND logic).","operationId":"getAllGoodsReceipts","parameters":[{"name":"page","in":"query","description":"Zero-based page index (0..N)","required":false,"schema":{"minimum":0,"type":"integer","default":0}},{"name":"size","in":"query","description":"The size of the page to be returned","required":false,"schema":{"minimum":1,"type":"integer","default":10}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"modifiedAfter","in":"query","description":"Filter goods receipts modified after this timestamp. Use ISO 8601 format (e.g., 2024-01-15T10:00:00Z). Useful for polling to get only new/updated goods receipts.","required":false,"schema":{"type":"string","format":"date-time"},"example":"2024-01-15T10:00:00Z"},{"name":"acknowledgedAfter","in":"query","description":"Filter for goods receipts that have been acknowledged after this timestamp. Use ISO 8601 format (e.g., 2024-01-15T10:00:00Z). Useful for polling to get only acknowledged goods receipts.","required":false,"schema":{"type":"string","format":"date-time"},"example":"2024-01-15T10:00:00Z"},{"name":"orderNumber","in":"query","description":"Filter goods receipts by order number. When provided, only goods receipts with this exact order number will be returned.","required":false,"schema":{"type":"string"},"example":"ORD-2024-5678"},{"name":"deliveryNoteNumber","in":"query","description":"Filter goods receipts by delivery note number. When provided, only goods receipts with this exact delivery note number will be returned.","required":false,"schema":{"type":"string"},"example":"DN-2024-3456"},{"name":"referenceNumber","in":"query","description":"Filter goods receipts by reference number. When provided, only goods receipts with this exact reference number will be returned.","required":false,"schema":{"type":"string"},"example":"REF-2024-001234"},{"name":"deliveryPartyGln","in":"query","description":"Filter goods receipts by delivery party GLN. When provided, only goods receipts with this exact delivery party GLN will be returned.","required":false,"schema":{"type":"string"},"example":1234567890123}],"responses":{"401":{"description":"Unauthorized - Invalid or missing Bearer token"},"403":{"description":"Forbidden - Token valid but insufficient permissions"},"500":{"description":"Internal server error - Contact support if this persists"},"200":{"description":"Successfully retrieved goods receipts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModel"}}}},"400":{"description":"Bad Request - Invalid parameter format"}},"security":[{"oauth":[]}]},"post":{"tags":["Goods Receipts API"],"summary":"Create or replace goods receipt","description":"Create a new goods receipt or replace an existing goods receipt. The data corresponds to certain EANCOM segments and is used to create a DVA goods receipt.\n\n**Required Fields:**\n- orderNumber (mandatory)\n- deliveryNoteNumber (mandatory)\n- referenceNumber (mandatory)\n- deliveryParty.gln (mandatory)\n\n**Matching:**\nThe system attempts to match the incoming data against existing goods receipts scoped to the same `deliveryParty.gln`. Matching is score-based and uses fields such as `referenceNumber`, `orderNumber`, and `deliveryNoteNumber`. The `referenceNumber` carries the highest weight and is sufficient on its own to produce a match.\n\n**Behavior:**\n- If no matching goods receipt is found: Creates a new goods receipt\n- If a match is found and it is **not** acknowledged:\n\t- With override=false (default): Merges the incoming data into the existing goods receipt\n\t- With override=true and the `referenceNumber` matches: Deletes the existing goods receipt (and its attachments) and creates a new one\n- If a match is found and it is **already acknowledged**:\n\t- With override=true and the `referenceNumber` matches: Returns an error (override not allowed for acknowledged goods receipts)\n\t- Otherwise: Creates a new subsequent delivery linked to the existing goods receipt bundle\n","operationId":"createOrReplaceGoodsReceipt","parameters":[{"name":"override","in":"query","description":"Override flag to delete and recreate if a goods receipt with the same referenceNumber already exists. Default is false which merges data into existing goods receipt. Override is not allowed for already acknowledged goods receipts.","required":false,"schema":{"type":"boolean","default":false},"example":false}],"requestBody":{"description":"Goods receipt data to create, containing receiving advice information.\nRequired fields: orderNumber, deliveryNoteNumber, referenceNumber, deliveryParty.gln\nSee the full API documentation for detailed field descriptions and examples.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoodsReceiptCreateDto"}}},"required":true},"responses":{"401":{"description":"Unauthorized - Invalid or missing Bearer token"},"400":{"description":"Bad Request - Invalid request body, missing mandatory fields (orderNumber, deliveryNoteNumber, referenceNumber, deliveryParty.gln), or malformed JSON"},"201":{"description":"Created - Successfully created new goods receipt or subsequent delivery","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoodsReceiptIdResponseDto"}}}},"422":{"description":"Unprocessable Entity - Request data is valid JSON but contains business logic errors or invalid EANCOM data"},"403":{"description":"Forbidden - Token valid but insufficient permissions or user has no access to the specified deliveryParty.gln"},"500":{"description":"Internal server error - Contact support if this persists"}},"security":[{"oauth":[]}]}},"/v1/goods-receipts/{goodsReceiptId}/line-items":{"get":{"tags":["Line Items API"],"summary":"Get all line items","description":"Retrieve all line items for a specific goods receipt.","operationId":"getAllLineItems","parameters":[{"name":"goodsReceiptId","in":"path","description":"Unique identifier of the goods receipt","required":true,"schema":{"type":"string"},"example":"123e4567-e89b-12d3-a456-426614174000"}],"responses":{"401":{"description":"Unauthorized - Invalid or missing Bearer token"},"403":{"description":"Forbidden - Token valid but insufficient permissions"},"500":{"description":"Internal server error - Contact support if this persists"},"200":{"description":"Successfully retrieved line items","content":{"application/json":{}}},"404":{"description":"Not Found - Goods receipt with the specified ID does not exist"}},"security":[{"oauth":[]}]},"post":{"tags":["Line Items API"],"summary":"Create a new line item","description":"Add a new line item to an existing goods receipt. The line item ID will be generated by the system.","operationId":"createLineItem","parameters":[{"name":"goodsReceiptId","in":"path","description":"Unique identifier of the goods receipt","required":true,"schema":{"type":"string"},"example":"123e4567-e89b-12d3-a456-426614174000"}],"requestBody":{"description":"Line item data to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItemCreateDto"}}},"required":true},"responses":{"401":{"description":"Unauthorized - Invalid or missing Bearer token"},"400":{"description":"Bad Request - Invalid request body or missing mandatory fields"},"403":{"description":"Forbidden - Token valid but insufficient permissions"},"500":{"description":"Internal server error - Contact support if this persists"},"404":{"description":"Not Found - Goods receipt with the specified ID does not exist"},"201":{"description":"Successfully created line item","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItemIdResponseDto"}}}}},"security":[{"oauth":[]}]}},"/v1/goods-receipts/{goodsReceiptId}/line-items/{lineItemId}/attachments":{"post":{"tags":["Line Items API"],"summary":"Add attachment to line item","description":"Upload an attachment to a specific line item, e.g., images of damaged goods or product documentation.","operationId":"addAttachmentToLineItem","parameters":[{"name":"goodsReceiptId","in":"path","description":"Unique identifier of the goods receipt","required":true,"schema":{"type":"string"},"example":"123e4567-e89b-12d3-a456-426614174000"},{"name":"lineItemId","in":"path","description":"Unique identifier of the line item","required":true,"schema":{"type":"string"},"example":"987fcdeb-51a2-43d1-9c4f-123456789abc"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["content"],"type":"object","properties":{"content":{"type":"string","description":"File to upload as an attachment. Supported formats depend on system configuration.","format":"binary"}}}}}},"responses":{"401":{"description":"Unauthorized - Invalid or missing Bearer token"},"200":{"description":"OK - File uploaded successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentCreateResponseDto"}}}},"415":{"description":"Unsupported Media Type - File type is not allowed"},"403":{"description":"Forbidden - Token valid but insufficient permissions"},"500":{"description":"Internal server error - Contact support if this persists"},"400":{"description":"Bad Request - Invalid file type, file too large, or file validation failed"},"404":{"description":"Not Found - Goods receipt or line item with the specified ID does not exist"},"413":{"description":"Payload Too Large - File size exceeds the maximum allowed limit"}},"security":[{"oauth":[]}]}},"/v1/goods-receipts/{goodsReceiptId}/attachments":{"post":{"tags":["Goods Receipts API"],"summary":"Add attachment to goods receipt","description":"Upload an attachment to an existing goods receipt, e.g. a signed delivery note as PDF or images of damaged goods.\n\n**Supported file types:** Depends on system configuration, but typically includes PDF, PNG, JPG, etc.\n**File validation:** Files are validated for type, size, and content before upload.\n\n**Use cases:**\n- Signed delivery notes (PDF)\n- Photos of damaged goods (JPG, PNG)\n- Additional documentation related to the goods receipt\n","operationId":"addAttachmentToGoodsReceipt","parameters":[{"name":"goodsReceiptId","in":"path","description":"Unique identifier of the goods receipt to attach the file to","required":true,"schema":{"type":"string"},"example":"123e4567-e89b-12d3-a456-426614174000"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["content"],"type":"object","properties":{"content":{"type":"string","description":"File to upload as an attachment. Supported formats depend on system configuration but typically include PDF, PNG, JPG. Check file size limits with your system administrator.","format":"binary"}}}}}},"responses":{"401":{"description":"Unauthorized - Invalid or missing Bearer token"},"501":{"description":"Not Implemented - Feature is disabled by configuration"},"200":{"description":"OK - File uploaded successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentCreateResponseDto"}}}},"400":{"description":"Bad Request - Invalid file type, file too large, missing mandatory fields, or file validation failed"},"415":{"description":"Unsupported Media Type - File type is not allowed by the system configuration"},"403":{"description":"Forbidden - Token valid but insufficient permissions"},"500":{"description":"Internal server error - Contact support if this persists"},"404":{"description":"Not Found - Goods receipt with the specified ID does not exist"},"413":{"description":"Payload Too Large - File size exceeds the maximum allowed limit"}},"security":[{"oauth":[]}]}},"/v1/goods-receipts/{goodsReceiptId}/acknowledgement":{"post":{"tags":["Goods Receipts API"],"summary":"Sign/Acknowledge corresponding goods receipt bundle","description":"Sign/Acknowledge a goods receipt bundle by goodss receipt ID. This operation marks the goods receipt bundle as signed/acknowledged, meaning no further changes can be made through the UI / API.\n\n**Use cases:**\n- Finalize the goods receipt process after inspection and verification\n- Trigger events for downstream processing (e.g., inventory updates, notifications)\n\n**Important:** Once signed/acknowledged, the goods receipt cannot be modified or updated through the API or UI anymore.\n","operationId":"acknowledgeGoodsReceipt","parameters":[{"name":"goodsReceiptId","in":"path","description":"Unique identifier of the goods receipt to acknowledge","required":true,"schema":{"type":"string"},"example":"123e4567-e89b-12d3-a456-426614174000"}],"requestBody":{"description":"Acknowledgement data containing signatures, load carrier exchange check status, and optional comments.\nAll fields are optional but at least one should be provided to create a meaningful acknowledgement.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoodsReceiptAcknowledgeDto"}}},"required":true},"responses":{"401":{"description":"Unauthorized - Invalid or missing Bearer token"},"501":{"description":"Not Implemented - Feature is disabled by configuration"},"422":{"description":"Unprocessable Entity - Request data is valid JSON but contains business logic errors or validation failures","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DVAErrorResponse"}}}},"403":{"description":"Forbidden - Token valid but insufficient permissions"},"500":{"description":"Internal server error - Contact support if this persists"},"404":{"description":"Not Found - Goods receipt with the specified ID does not exist"},"200":{"description":"Successfully acknowledged goods receipt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoodsReceiptAcknowledgeResponseDto"}}}},"400":{"description":"Bad Request - Request validation failed, check the provided data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DVAErrorResponse"}}}}},"security":[{"oauth":[]}]}},"/v1/delivery-notes/{goodsReceiptId}/hard-copy":{"post":{"tags":["Delivery Notes API"],"summary":"Upload hard copy of delivery note","description":"Uploads a hard copy (PDF, image, etc.) of the delivery note as an attachment\nto the specified goods receipt.\n\nThis endpoint allows you to attach the original delivery note document to a goods receipt\nthat was previously created from delivery note JSON data.\n\n**Supported file types:** PDF, PNG, JPEG\n**Maximum file size:** 20MB\n","operationId":"createHardCopy","parameters":[{"name":"goodsReceiptId","in":"path","description":"The unique identifier of the goods receipt to attach the hard copy to","required":true,"schema":{"type":"string"},"example":"12345678-1234-1234-1234-123456789012"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["content"],"type":"object","properties":{"content":{"type":"string","description":"The delivery note hard copy file to upload. Supported formats: PDF, PNG, JPEG. Maximum size: 20MB","format":"binary"}}}}}},"responses":{"401":{"description":"Unauthorized - Invalid or missing Bearer token"},"404":{"description":"Not Found - Goods receipt not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DVAErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DVAErrorResponse"}}}},"200":{"description":"File uploaded successfully","content":{"text/plain":{"schema":{"type":"string","example":"File uploaded successfully."}}}},"403":{"description":"Forbidden - Token valid but insufficient permissions"},"415":{"description":"Unsupported Media Type - File type not supported","content":{"text/plain":{"schema":{"type":"string","example":"Unsupported file type"}}}},"400":{"description":"Bad Request - Invalid file or missing mandatory fields","content":{"text/plain":{"schema":{"type":"string","example":"Missing mandatory fields"}}}},"413":{"description":"Payload Too Large - File size exceeds maximum allowed","content":{"text/plain":{"schema":{"type":"string","example":"File size exceeds maximum allowed size"}}}}},"security":[{"oauth":[]}]}},"/v1/delivery-notes":{"post":{"tags":["Delivery Notes API"],"summary":"Create goods receipt bundle from delivery note JSON","description":"Creates a new goods receipt bundle from a delivery note JSON payload.\n\nThis endpoint processes the delivery note data and automatically creates:\n- A goods receipt bundle containing the delivery information\n\nThe delivery note must contain valid header and body information including:\n- Partner information (supplier, buyer, delivery party, etc.)\n- Delivery details (delivery note number, dates, etc.)\n- Package and line item information\n\n**Note:** If a goods receipt bundle already exists for the same delivery note number,\nthe system will return HTTP 208 (Already Reported) without creating a duplicate.\n","operationId":"createGoodsReceiptBundleFromDeliveryNoteJson","requestBody":{"description":"Delivery note data containing header and body information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryNoteDto"}}},"required":true},"responses":{"208":{"description":"Already Reported - Goods receipt bundle already exists for this delivery note"},"401":{"description":"Unauthorized - Invalid or missing Bearer token"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DVAErrorResponse"}}}},"400":{"description":"Bad Request - Invalid delivery note data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DVAErrorResponse"}}}},"201":{"description":"Goods receipt bundle created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryNoteCreateResponse"}}}},"403":{"description":"Forbidden - Token valid but insufficient permissions"},"422":{"description":"Unprocessable Entity - Validation errors in delivery note data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DVAErrorResponse"}}}}},"security":[{"oauth":[]}]}},"/v1/goods-receipts/{goodsReceiptId}/line-items/{lineItemId}/attachments/{attachmentId}":{"get":{"tags":["Line Items API"],"summary":"Get attachment content by ID","description":"Retrieve the content of a specific attachment associated with a line item.","operationId":"getAttachmentContent","parameters":[{"name":"goodsReceiptId","in":"path","description":"Unique identifier of the goods receipt","required":true,"schema":{"type":"string"},"example":"123e4567-e89b-12d3-a456-426614174000"},{"name":"lineItemId","in":"path","description":"Unique identifier of the line item","required":true,"schema":{"type":"string"},"example":"987fcdeb-51a2-43d1-9c4f-123456789abc"},{"name":"attachmentId","in":"path","description":"Unique identifier of the attachment","required":true,"schema":{"type":"string"},"example":"456e7890-f12b-34c5-d678-901234567abc"}],"responses":{"401":{"description":"Unauthorized - Invalid or missing Bearer token"},"404":{"description":"Not Found - Goods receipt, line item, or attachment with the specified ID does not exist"},"200":{"description":"Successfully retrieved attachment content","content":{"application/octet-stream":{}}},"403":{"description":"Forbidden - Token valid but insufficient permissions"},"500":{"description":"Internal server error - Contact support if this persists"}},"security":[{"oauth":[]}]},"delete":{"tags":["Line Items API"],"summary":"Delete attachment from line item","description":"Delete a specific attachment from a line item.","operationId":"deleteAttachment","parameters":[{"name":"goodsReceiptId","in":"path","description":"Unique identifier of the goods receipt","required":true,"schema":{"type":"string"},"example":"123e4567-e89b-12d3-a456-426614174000"},{"name":"lineItemId","in":"path","description":"Unique identifier of the line item","required":true,"schema":{"type":"string"},"example":"987fcdeb-51a2-43d1-9c4f-123456789abc"},{"name":"attachmentId","in":"path","description":"Unique identifier of the attachment","required":true,"schema":{"type":"string"},"example":"456e7890-f12b-34c5-d678-901234567abc"}],"responses":{"401":{"description":"Unauthorized - Invalid or missing Bearer token"},"404":{"description":"Not Found - Goods receipt, line item, or attachment with the specified ID does not exist"},"403":{"description":"Forbidden - Token valid but insufficient permissions"},"500":{"description":"Internal server error - Contact support if this persists"},"204":{"description":"Successfully deleted attachment"}},"security":[{"oauth":[]}]}},"/v1/goods-receipts/{goodsReceiptId}/attachments/{attachmentId}":{"get":{"tags":["Goods Receipts API"],"summary":"Get attachment content by ID","description":"Retrieves the content of a specific attachment associated with a goods receipt.\n\n**Use cases:**\n- Download signed delivery notes\n- View uploaded images of damaged goods\n- Access any file attachments related to the goods receipt\n\n**Response:** Returns the attachment file content with appropriate MIME type headers.\n","operationId":"getAttachmentContent_1","parameters":[{"name":"goodsReceiptId","in":"path","description":"Unique identifier of the goods receipt","required":true,"schema":{"type":"string"},"example":"123e4567-e89b-12d3-a456-426614174000"},{"name":"attachmentId","in":"path","description":"Unique identifier of the attachment to retrieve","required":true,"schema":{"type":"string"},"example":"987fcdeb-51a2-43d1-9c4f-123456789abc"}],"responses":{"401":{"description":"Unauthorized - Invalid or missing Bearer token"},"200":{"description":"Successfully retrieved attachment content","content":{"application/octet-stream":{}}},"403":{"description":"Forbidden - Token valid but insufficient permissions"},"500":{"description":"Internal server error - Contact support if this persists"},"404":{"description":"Not Found - Goods receipt or attachment with the specified ID does not exist"}},"security":[{"oauth":[]}]}}},"components":{"schemas":{"AddressDto":{"type":"object","properties":{"addressLine1":{"type":"string","description":"Primary address line (street name and house number)","example":"Musterstraße 123"},"addressLine2":{"type":"string","description":"Secondary address line (additional address information like apartment, suite, etc.)","example":"Gebäude A, 2. OG"},"stateProvinceCounty":{"type":"string","description":"State, province, or county information","example":"Brandenburg"},"zipcode":{"type":"string","description":"Postal/ZIP code","example":"12345"},"city":{"type":"string","description":"City name","example":"Berlin"},"countryCode":{"type":"string","description":"Country code (ISO 3166-1 alpha-2 format)","example":"DE"}},"description":"Physical address information for partner locations. Contains standard address components for delivery and contact purposes."},"GoodsReceiptProtocolDto":{"type":"object","properties":{"sanitation":{"type":"boolean","description":"Indicates whether sanitation and hygiene requirements were met during delivery inspection.","example":true},"papers":{"type":"boolean","description":"Indicates whether all required documentation and papers were present and correct.","example":true},"condition":{"type":"boolean","description":"Indicates whether the physical condition of goods met acceptance criteria.","example":true},"organicControlNumber":{"type":"boolean","description":"Indicates whether organic control number verification was completed successfully for organic products.","example":false},"bestBeforeDate":{"type":"boolean","description":"Indicates whether best before date verification was performed and products were within acceptable date ranges.","example":true},"temperatureCheck":{"type":"boolean","description":"Indicates whether temperature checks were performed for temperature-sensitive goods.","example":true},"temperatureValue":{"type":"number","description":"The actual temperature value measured during inspection, if temperature check was performed.","format":"double","example":4.5},"comment":{"type":"string","description":"Additional comments or observations made during the inspection process.","example":"All items in excellent condition. Minor packaging damage on 2 boxes but contents unaffected."}},"description":"Protocol containing inspection results and compliance checks performed during the goods receipt process. Used to document quality control and regulatory compliance verification."},"GoodsReceiptUpdateDto":{"type":"object","properties":{"referenceNumber":{"type":"string","description":"Reference number assigned by the goods management system (WWS). Unique identifier used for tracking and cross-referencing with external systems.","example":"REF-2024-001234"},"archiveNumber":{"type":"string","description":"Archive or barcode number used to match documents in ECM (Enterprise Content Management) and Mareko systems. This number enables document traceability across different platforms.","example":"ARC-789012345"},"receivingAdvice":{"$ref":"#/components/schemas/ReceivingAdviceUpdateDto"},"protocol":{"$ref":"#/components/schemas/GoodsReceiptProtocolDto"},"loadCarrierExchange":{"$ref":"#/components/schemas/LoadCarrierExchangeDto"},"assortments":{"type":"array","description":"List of assortment classifications to assign to this goods receipt. Assortments categorize goods by type such as fresh, dry, or frozen products.","example":["FRESH","DRY"],"items":{"type":"string","description":"Assortment type classification for goods receipt","example":"[\"FRESH\",\"DRY\"]","enum":["FRESH","MEAT","FRUITS_AND_VEGETABLES","DRY","FROZEN"],"x-enum-descriptions":{"FRUITS_AND_VEGETABLES":"Fruits and vegetables assortment","DRY":"Dry goods assortment","FROZEN":"Frozen goods assortment","FRESH":"Fresh goods assortment","MEAT":"Meat assortment"}}},"state":{"type":"string","description":"The initial state of the goods receipt bundle. Determines where the bundle appears on the Incoming Goods Board.","example":"DOCUMENT_REVIEW","enum":["ANNOUNCED_DELIVERIES","DOCUMENT_REVIEW","GATE_ASSIGNMENT","DELIVERIES_CONTROL"]}},"description":"Data transfer object for updating an existing goods receipt. Contains all updatable fields. The goods receipt ID is provided separately via the URL path parameter. All line items MUST include valid IDs."},"LineItemQuantityVarianceDto":{"type":"object","properties":{"acceptedQuantity":{"$ref":"#/components/schemas/QuantityDto"},"deliveredQuantity":{"$ref":"#/components/schemas/QuantityDto"},"reason":{"type":"string","description":"Reason codes for quantity variances and discrepancies according to EANCOM standards. Combines qualifiers from QVR6063 (Quantity type code), QVR4221 (Discrepancy nature identification), and QVR4295 (Change reason description). See: https://www.publikationen.gs1-germany.de/Complete/eancom_v9.3/profiles/ae/gesamt/recadv/en/html/","enum":["SHORT_SHIPPED","OVER_SHIPPED","DAMAGED","DELIVERED_TOO_LATE","GOODS_DELIVERED_TOO_EARLY","SHIPMENT_PARTIAL_CONSIDERED_COMPLETE_NO_BACKORDER","NOT_ORDERED","QUALITY_DEFECT_TRANSPORT_CARGO_UNIT","QUALITY_DEFECT_GOODS","SPOILAGE_OF_GOODS","UNREADABLE_BARCODE","MINIMUM_MAXIMUM_PRODUCT_DURABILITY_DATE_UNACCEPTABLE","DELIVERED_BUT_NOT_ADVISED","ARTICLE_NUMBER_UNKNOWN","DELIVERY_CONDITIONS_NOT_MET","REGULATORY_REQUIREMENTS_DISCREPANCIES","TRANSPORT_MEANS_TECHNICAL_FAILURE","ITEM_DISCONTINUED_BY_WHOLESALER","ITEM_NO_LONGER_PRODUCED","ITEM_OUT_OF_STOCK_AT_MANUFACTURER","NEXT_HIGHER_PACKAGING_QUANTITY","AVAILABLE_NOW","SHIPMENT_PARTIAL_BACK_ORDER_TO_FOLLOW","SHIPMENT_COMPLETE","SHIPMENT_INCLUDES_EXTRA_ITEMS_TO_MEET_PRICE_BREAK","CANCELLED_FROM_PREVIOUS_ORDER","SHIPMENT_COMPLETE_WITH_ADDITIONAL_QUANTITY","NEXT_CARRIER","SHIPMENT_COMPLETE_WITH_SUBSTITUTION","ITEM_CANCELLED","ITEM_REPRESENTS_SUBSTITUTION_FROM_ORIGINAL_ORDER","ITEM_OUT_OF_STOCK_AT_WHOLESALER","PURCHASE_ORDER_INQUIRY_UNSHIPPED_ITEMS_ONLY","PURCHASE_ORDER_INQUIRY_SPECIFIC_ITEMS","IN_PROCESS","ITEM_RATIONED","ITEM_TEMPORAIRLY_DISCONTINUED_BY_WHOLESALER","PACK_TO_CLOSEST_COMPLETE_LOGISTIC_PACKAGING_QUANTITY","PACK_TO_NEXT_LOWER_COMPLETE_LOGISTIC_QUANTITY","GRADE_DIFFERENCE_OUT_OF_TOLERANCE_LEVEL","UNIT_OF_MEASURE_DIFFERENCE","RECEIPT_TEMPERATURE_OUTSIDE_AGREED_RANGE"],"x-enum-descriptions":{"UNIT_OF_MEASURE_DIFFERENCE":"(UM) Unit of measure different from ordered","GOODS_DELIVERED_TOO_EARLY":"(AI) Goods delivered too early","DELIVERED_TOO_LATE":"(AG) Delivered later than the agreed delivery date","ITEM_NO_LONGER_PRODUCED":"(AB) Item discontinued and no longer in production","IN_PROCESS":"(PS) Being manufactured, scheduled to ship","DELIVERED_BUT_NOT_ADVISED":"(BO) Delivered without advance notification","MINIMUM_MAXIMUM_PRODUCT_DURABILITY_DATE_UNACCEPTABLE":"(PE) Durability date not acceptable","PACK_TO_NEXT_LOWER_COMPLETE_LOGISTIC_QUANTITY":"(UT) Pack to next lower complete packaging","QUALITY_DEFECT_TRANSPORT_CARGO_UNIT":"(BC) Equipment technical failure (damaged or wrong)","ITEM_OUT_OF_STOCK_AT_WHOLESALER":"(OW) Item not available at distribution point","PURCHASE_ORDER_INQUIRY_UNSHIPPED_ITEMS_ONLY":"(PO) Response about unshipped items only","PURCHASE_ORDER_INQUIRY_SPECIFIC_ITEMS":"(PP) Response about specific items subset","OVER_SHIPPED":"(AC) More goods shipped than contracted for delivery","NEXT_CARRIER":"(CN) Item will be shipped on next available carrier","SHIPMENT_PARTIAL_CONSIDERED_COMPLETE_NO_BACKORDER":"(CP) Quantity shipped is less than authorized, no plan to ship remaining","SHIPMENT_PARTIAL_BACK_ORDER_TO_FOLLOW":"(BP) Partial order held open, back order to follow","ITEM_RATIONED":"(RA) Product restricted due to limited availability","REGULATORY_REQUIREMENTS_DISCREPANCIES":"(OS) Item out of stock due to strike or force majeure","CANCELLED_FROM_PREVIOUS_ORDER":"(CK) Amount deleted from earlier schedule","DELIVERY_CONDITIONS_NOT_MET":"(AZ) Delivery conditions not met","AVAILABLE_NOW":"(AS) Material available, scheduled to ship at future date","QUALITY_DEFECT_GOODS":"(BE) Goods technical failure (instability, overhang, damage)","DAMAGED":"(AF) Part or all goods were delivered damaged","UNREADABLE_BARCODE":"(BK) Barcode not readable by scanning device","SHIPMENT_COMPLETE_WITH_ADDITIONAL_QUANTITY":"(CM) Quantity dispatched exceeds ordered quantity","SHIPMENT_COMPLETE":"(CC) Quantity dispatched fulfilled the order quantity","PACK_TO_CLOSEST_COMPLETE_LOGISTIC_PACKAGING_QUANTITY":"(US) Pack to closest complete packaging","NEXT_HIGHER_PACKAGING_QUANTITY":"(AH) Packed to next higher packaging quantity","ITEM_TEMPORAIRLY_DISCONTINUED_BY_WHOLESALER":"(TW) Temporarily not available from wholesaler","SHORT_SHIPPED":"(119) Part of the consignment was not shipped","ITEM_CANCELLED":"(IC) Item cancelled from order by buyer or supplier","ITEM_DISCONTINUED_BY_WHOLESALER":"(AA) Wholesaler no longer offers the product","RECEIPT_TEMPERATURE_OUTSIDE_AGREED_RANGE":"(BN) Temperature outside agreed range","ARTICLE_NUMBER_UNKNOWN":"(AUE) Article code (GTIN) is unknown","TRANSPORT_MEANS_TECHNICAL_FAILURE":"(BB) Transport means technical failure","SHIPMENT_COMPLETE_WITH_SUBSTITUTION":"(CS) Shipment complete with substitution","SHIPMENT_INCLUDES_EXTRA_ITEMS_TO_MEET_PRICE_BREAK":"(CE) Extra items to meet price break","GRADE_DIFFERENCE_OUT_OF_TOLERANCE_LEVEL":"(BG) Grade variation outside tolerance level","NOT_ORDERED":"(AT) Item or product was not ordered","SPOILAGE_OF_GOODS":"(BF) Change resulting from spoilage of goods","ITEM_REPRESENTS_SUBSTITUTION_FROM_ORIGINAL_ORDER":"(IS) Item substitutes originally ordered item","ITEM_OUT_OF_STOCK_AT_MANUFACTURER":"(AD) Item out of stock at manufacturer"}},"actionType":{"type":"string","description":"Action types for goods receipt line items according to EANCOM standards. See: https://www.publikationen.gs1-germany.de/Complete/eancom_v9.2/profiles/ae/gesamt/recadv/en/html/0628.htm#1RECADV/6063","enum":["RETURN","DESTRUCTION","RECEIVED_AND_ACCEPTED","COLLECTION_DESIRED"],"x-enum-descriptions":{"RETURN":"(195) Received, not accepted, to be returned","DESTRUCTION":"(196) Received, not accepted, to be destroyed","COLLECTION_DESIRED":"(201) Collection desired","RECEIVED_AND_ACCEPTED":"(194) Received and accepted"}},"comment":{"type":"string","description":"Additional comments regarding the quantity variance"},"userInput":{"$ref":"#/components/schemas/LineItemQuantityVarianceUserInputDto"}},"description":"Quantity variance information for line items, documenting differences between delivered and accepted quantities."},"LineItemQuantityVarianceUserInputDto":{"type":"object","properties":{"despatchedQuantity":{"type":"number","format":"double"},"deliveredQuantity":{"type":"number","format":"double"},"acceptedQuantity":{"type":"number","format":"double"},"unit":{"type":"string"}}},"LineItemUpdateDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the line item. Required when updating line items as part of a goods receipt bulk update. Optional for standalone line item updates where ID comes from URL path.","example":"550e8400-e29b-41d4-a716-446655440000"},"lineItemNumber":{"type":"string","description":"Line item number to uniquely identify this line item. The line item number iterates over the whole message starting with 1.","example":"2"},"hierarchyLevel":{"type":"string","description":"CPS Level - hierarchy level indicator"},"hierarchyLevelParent":{"type":"string","description":"CPS Parent - parent hierarchy level reference"},"gtin":{"type":"string","description":"Global Trade Item Number (GTIN) to uniquely identify this line item. A unique number, up to 14-digits.","example":"1234567890123"},"targetMarket":{"type":"string","description":"Target market identifier"},"articleNumberBuyer":{"type":"string","description":"Buyer specific article number for this item","example":"67890123"},"articleNumberSupplier":{"type":"string","description":"Supplier specific article number for this item","example":"67890123"},"ssccs":{"$ref":"#/components/schemas/SsccsDto"},"despatchedQuantity":{"$ref":"#/components/schemas/QuantityDto"},"orderedQuantity":{"$ref":"#/components/schemas/QuantityDto"},"bestBeforeDate":{"type":"string","description":"Best before date for this line item.","format":"date-time"},"organicControlNumber":{"type":"string","description":"ECO controlling agency (RFF+XC1). The article is a BIO product. The indication overwrites information of the heading section."},"hazardInformation":{"type":"string","description":"Hazard information containing Agreement concerning the International Carriage of Dangerous Goods by Road (ADR) related information like an UN number of the item"},"pharmacyProductNumber":{"type":"string","description":"Pharmacy Product Number holding the Product Registration Agency Code (PRA-Code)"},"articleDescription":{"type":"string","description":"Article description of this line item"},"quantityVariance":{"$ref":"#/components/schemas/LineItemQuantityVarianceDto"},"weightVariance":{"$ref":"#/components/schemas/LineItemWeightVarianceDto"},"batchNumber":{"type":"string","description":"Batch number supplementing the identification code of a product used to identify the specific production place and/or time of a product."}},"description":"Data transfer object for updating an existing line item. When used in bulk update operations (PUT /goods-receipts), the ID is required. When used in standalone operations (PUT /line-items), the ID comes from the URL path parameter."},"LineItemWeightVarianceDto":{"type":"object","properties":{"orderedWeightInKg":{"type":"number","description":"Ordered weight in kilograms","format":"double","example":478.2},"deliveredWeightInKg":{"type":"number","description":"Delivered weight in kilograms","format":"double","example":423.2}},"description":"Weight variance information for a line item, reported in kilograms."},"LoadCarrierDto":{"type":"object","properties":{"type":{"type":"string","description":"Type of load carrier used in goods transport","example":"EURO","enum":["EURO","CHEP","IPP","H1","DD","E1_E2","E1","E2","OTHER"],"x-enum-descriptions":{"DD":"DD type load carrier","OTHER":"Other type of load carrier","E1_E2":"E1/E2 combined type load carrier","IPP":"IPP pallet","H1":"H1 type load carrier","E1":"E1 type load carrier","EURO":"European standard pallet","E2":"E2 type load carrier","CHEP":"CHEP pallet"}},"quantityReceived":{"type":"integer","description":"Quantity of load carriers received","format":"int32","example":10},"quantityReturned":{"type":"integer","description":"Quantity of load carriers returned","format":"int32","example":8},"quantityDamaged":{"type":"integer","description":"Quantity of damaged load carriers","format":"int32","example":1}},"description":"Load carrier information including type and quantities"},"LoadCarrierExchangeDto":{"type":"object","properties":{"exchangedOneToOne":{"type":"boolean","description":"Whether load carriers were exchanged one-to-one","example":true},"couponIssued":{"type":"boolean","description":"Whether a coupon was issued for the exchange","example":false},"comment":{"type":"string","description":"Additional comments about the load carrier exchange","example":"Some pallets were damaged during transport"},"loadCarrierDetails":{"type":"array","description":"Detailed information about the load carriers involved in the exchange","items":{"$ref":"#/components/schemas/LoadCarrierDto"}}},"description":"Load carrier exchange information including exchange status and details"},"PartnerDto":{"required":["gln"],"type":"object","properties":{"gln":{"pattern":"[0-9]{13}","type":"string","description":"Global Location Number (GLN) - a unique identifier for business locations according to GS1 standards. 13-digit number used to identify partners in EDI transactions.","example":"4012345000013"},"name":{"type":"string","description":"Business name of the partner organization.","example":"ACME Supply Company GmbH"},"internalPartnerId":{"type":"string","description":"Internal partner identifier used for reference purposes (RFF+API). Not included in P&G DESADV messages.","example":"42"},"address":{"$ref":"#/components/schemas/AddressDto"},"vatNumber":{"type":"string","description":"VAT (Value Added Tax) number of the partner organization. Not included in P&G DESADV messages.","example":"DE-999999999"}},"description":"Partner information in the supply chain. Contains identification and address details for business partners like buyers, suppliers, delivery parties, etc."},"QuantityDto":{"type":"object","properties":{"amount":{"type":"number","description":"Numeric quantity value","format":"double","example":1242},"unit":{"type":"string","description":"Unit of measure for quantities according to EDI standard (UN/ECE Recommendation 20). Based on GS1 EANCOM standard.","example":"PCE","enum":["STK","Stück","ST","Karton","KRT","KT","CLT","CMT","CT","GL","GRM","INH","KGM","LTR","MGM","MLT","NAR","NRL","P1","PA","PCE","PF","PND","PR","PTN","TNE","VI","UNKNOWN"],"x-enum-descriptions":{"INH":"Inch. A unit of length equal to 25.4 millimetres.","PR":"Pair. Two articles which belong together but are not necessarily identical.","GRM":"Gram. A unit of mass equal to one thousandth of a kilogram.","PND":"Pound. A unit of mass equal to 16 ounces or approximately 0.4536 kilograms.","Stück":"(Deprecated) Stück (piece), mostly used in the German market, mapped to PCE. Use PCE instead.","NRL":"Number of rolls. A count representing the number of rolls.","CLT":"Centilitre. A unit of volume equal to one hundredth of a liter.","TNE":"Tonne (metric ton). Metric ton (1000kg).","STK":"(Deprecated) Stück (piece), mostly used in the German market, mapped to PCE. Use PCE instead.","LTR":"Litre. A unit of volume equal to one cubic decimetre (1 dm³).","PTN":"Portion. The number of portions into which a product may be broken for serving.","KRT":"(Deprecated) Karton (carton), mostly used in the German market, mapped to CT. Use CT instead.","Karton":"(Deprecated) Karton (carton), mostly used in the German market, mapped to CT. Use CT instead.","MLT":"Millilitre. A unit of volume equal to one thousandth of a litre.","ST":"(Deprecated) Stück (piece), mostly used in the German market, mapped to PCE. Use PCE instead.","P1":"Percent. Used to indicate measurements in terms of percentages.","GL":"Gram per litre. A unit of density expressed as grams per litre.","KT":"(Deprecated) Karton (carton), mostly used in the German market, mapped to CT. Use CT instead.","CMT":"Centimetre. A unit of length equal to one hundredth of a metre.","KGM":"Kilogram. A unit of mass equal to one thousand grams.","CT":"Carton.","PA":"Packet. A small package or container.","MGM":"Milligram. A unit of mass equal to one thousandth of a gram.","PCE":"Piece. A unit of count defining the number of pieces.","VI":"Vial. Small glass container.","PF":"Pallet (lift). A number of articles expressed in terms of pallets.","UNKNOWN":"Unknown unit of measure.","NAR":"Number of articles. A count representing the number of individual items."}}},"description":"Quantity information with value and unit of measure."},"ReceivingAdviceUpdateDto":{"required":["deliveryNoteNumber","deliveryParty","lineItems"],"type":"object","properties":{"documentNumber":{"type":"string","description":"Document number assigned by sender. This segment is used to indicate the type and function of a message and to transmit the identifying number (BGM).","example":"DESADV2024001234"},"orderNumber":{"type":"string","description":"Reference Order Number of buyer (ON).","example":"ORD-2024-5678"},"orderNumberSupplier":{"type":"string","description":"Reference Order Number of supplier (VN).","example":"SUP-ORD-9876"},"deliveryNoteNumber":{"type":"string","description":"Delivery Note Number (RFF+DQ).","example":"DN-2024-3456"},"documentDate":{"type":"string","description":"Date/time when the document/message was issued. This may include authentication (DTM+137).","format":"date-time"},"orderDate":{"type":"string","description":"Date or time on which the goods were ordered (only P&G specific field)","format":"date-time"},"despatchedDate":{"type":"string","description":"Date or time on which the goods are or are expected to be despatched or shipped (DTM+11).","format":"date-time"},"deliveryDateRequested":{"type":"string","description":"Date on which buyer requests goods to be delivered (DTM+2).","format":"date-time"},"deliveryDateActual":{"type":"string","description":"Actual delivery date/time (DTM+35). Date/time on which goods or consignment are delivered at their destination.","format":"date-time"},"deliveryDateEstimated":{"type":"string","description":"Date and/or time when the shipper of the goods expects delivery will take place (DTM+17).","format":"date-time"},"buyer":{"$ref":"#/components/schemas/PartnerDto"},"deliveryParty":{"$ref":"#/components/schemas/PartnerDto"},"supplier":{"$ref":"#/components/schemas/PartnerDto"},"shipFrom":{"$ref":"#/components/schemas/PartnerDto"},"organicControlNumber":{"type":"string","description":"ECO controlling agency (RFF+XC1).","example":"DE-ÖKO-001"},"carrier":{"$ref":"#/components/schemas/PartnerDto"},"despatchedPalletCount":{"type":"string","description":"Number of pallets dispatched in the shipment","example":"12"},"lineItems":{"type":"array","description":"List of individual line items included in this receiving advice. All line items MUST include valid IDs. Line items not included will be deleted.","items":{"$ref":"#/components/schemas/LineItemUpdateDto"}}},"description":"Receiving advice data for updating a goods receipt according to EANCOM DESADV standards. All line items MUST include valid IDs for update operations."},"SsccsDto":{"type":"object","properties":{"masterSscc":{"type":"string","description":"Master SSCC for multiple line items","example":"340353770000001234"},"ssccs":{"type":"array","description":"List of SSCCs for individual packages within a specific line item","example":["340353770000001234","340353770000001235"],"items":{"type":"string","description":"List of SSCCs for individual packages within a specific line item","example":"[\"340353770000001234\",\"340353770000001235\"]"}}},"description":"Serial Shipping Container Code (SSCC) information. The SSCC is an 18-digit number used to identify logistics units."},"GoodsReceiptAttachmentWithoutContentDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the attachment, generated by the system upon creation.","example":"550e8400-e29b-41d4-a716-446655440000"},"filename":{"type":"string","description":"Name of the attachment file.","example":"delivery_receipt.jpg"},"mimeFileType":{"type":"string","description":"MIME type of the attachment file.","example":"image/jpeg"},"attachmentType":{"type":"string","description":"Type of the attachment, indicating its purpose or content type.","example":"UPLOADED_BY_USER","enum":["ORIGINAL_DELIVERY_NOTE","ENRICHED_DELIVERY_NOTE","SIGNED_DELIVERY_NOTE","UPLOADED_BY_USER"]},"version":{"type":"integer","description":"Version of the attachment, used for tracking changes or updates.","format":"int64","example":1}},"description":"Attachments of a goods receipt without content, such as images or documents."},"GoodsReceiptResponseDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the goods receipt, generated by the system upon creation.","example":"550e8400-e29b-41d4-a716-446655440000"},"createdAt":{"type":"string","description":"Timestamp when the goods receipt was created in the system.","format":"date-time","example":"2024-01-15T10:30:00Z"},"referenceNumber":{"type":"string","description":"Reference number assigned by the goods management system (WWS). Unique identifier used for tracking and cross-referencing with external systems.","example":"REF-2024-001234"},"archiveNumber":{"type":"string","description":"Archive or barcode number used to match documents in ECM (Enterprise Content Management) and Mareko systems. This number enables document traceability across different platforms.","example":"ARC-789012345"},"assortments":{"type":"array","description":"List of assortment classifications assigned to this goods receipt. Assortments categorize goods by type such as fresh, dry, or frozen products.","example":["FRESH","DRY"],"items":{"type":"string","description":"Assortment type classification for goods receipt","example":"[\"FRESH\",\"DRY\"]","enum":["FRESH","MEAT","FRUITS_AND_VEGETABLES","DRY","FROZEN"],"x-enum-descriptions":{"FRUITS_AND_VEGETABLES":"Fruits and vegetables assortment","DRY":"Dry goods assortment","FROZEN":"Frozen goods assortment","FRESH":"Fresh goods assortment","MEAT":"Meat assortment"}}},"receivingAdvice":{"$ref":"#/components/schemas/ReceivingAdviceResponseDto"},"protocol":{"$ref":"#/components/schemas/GoodsReceiptProtocolDto"},"loadCarrierExchange":{"$ref":"#/components/schemas/LoadCarrierExchangeDto"},"attachments":{"type":"array","description":"Attachments related to the goods receipt, such as images or documents.","items":{"$ref":"#/components/schemas/GoodsReceiptAttachmentWithoutContentDto"}},"parentGoodsReceiptId":{"type":"string","description":"ID of the parent goods receipt if this is a subsequent delivery. Subsequent deliveries share the same orderNumber and deliveryNoteNumber but have a different referenceNumber.","example":"550e8400-e29b-41d4-a716-446655440001"},"childGoodsReceiptId":{"type":"string","description":"ID of the child goods receipt if this has a subsequent delivery. Subsequent deliveries share the same orderNumber and deliveryNoteNumber but have a different referenceNumber.","example":"550e8400-e29b-41d4-a716-446655440002"}},"description":"Data transfer object representing a goods receipt in API responses. Contains complete goods receipt information including system-generated fields."},"LineItemResponseDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the line item, generated by the system.","example":"550e8400-e29b-41d4-a716-446655440000"},"lineItemNumber":{"type":"string","description":"Line item number to uniquely identify this line item. The line item number iterates over the whole message starting with 1.","example":"2"},"hierarchyLevel":{"type":"string","description":"CPS Level - hierarchy level indicator"},"hierarchyLevelParent":{"type":"string","description":"CPS Parent - parent hierarchy level reference"},"gtin":{"type":"string","description":"Global Trade Item Number (GTIN) to uniquely identify this line item. A unique number, up to 14-digits.","example":"1234567890123"},"targetMarket":{"type":"string","description":"Target market identifier"},"articleNumberBuyer":{"type":"string","description":"Buyer specific article number for this item","example":"67890123"},"articleNumberSupplier":{"type":"string","description":"Supplier specific article number for this item","example":"67890123"},"ssccs":{"$ref":"#/components/schemas/SsccsDto"},"despatchedQuantity":{"$ref":"#/components/schemas/QuantityDto"},"orderedQuantity":{"$ref":"#/components/schemas/QuantityDto"},"bestBeforeDate":{"type":"string","description":"Best before date for this line item.","format":"date-time"},"organicControlNumber":{"type":"string","description":"ECO controlling agency (RFF+XC1). The article is a BIO product. The indication overwrites information of the heading section."},"hazardInformation":{"type":"string","description":"Hazard information containing Agreement concerning the International Carriage of Dangerous Goods by Road (ADR) related information like an UN number of the item"},"pharmacyProductNumber":{"type":"string","description":"Pharmacy Product Number holding the Product Registration Agency Code (PRA-Code)"},"articleDescription":{"type":"string","description":"Article description of this line item"},"quantityVariance":{"$ref":"#/components/schemas/LineItemQuantityVarianceDto"},"weightVariance":{"$ref":"#/components/schemas/LineItemWeightVarianceDto"},"batchNumber":{"type":"string","description":"Batch number supplementing the identification code of a product used to identify the specific production place and/or time of a product."},"attachments":{"type":"array","description":"Attachments associated with this line item","items":{"$ref":"#/components/schemas/GoodsReceiptAttachmentWithoutContentDto"}}},"description":"Data transfer object representing a line item in API responses. Contains complete line item information including system-generated fields."},"ReceivingAdviceResponseDto":{"type":"object","properties":{"documentNumber":{"type":"string","description":"Document number assigned by sender. This segment is used to indicate the type and function of a message and to transmit the identifying number (BGM).","example":"DESADV2024001234"},"orderNumber":{"type":"string","description":"Reference Order Number of buyer (ON).","example":"ORD-2024-5678"},"orderNumberSupplier":{"type":"string","description":"Reference Order Number of supplier (VN).","example":"SUP-ORD-9876"},"deliveryNoteNumber":{"type":"string","description":"Delivery Note Number (RFF+DQ).","example":"DN-2024-3456"},"documentDate":{"type":"string","description":"Date/time when the document/message was issued. This may include authentication (DTM+137).","format":"date-time"},"orderDate":{"type":"string","description":"Date or time on which the goods were ordered (only P&G specific field)","format":"date-time"},"despatchedDate":{"type":"string","description":"Date or time on which the goods are or are expected to be despatched or shipped (DTM+11).","format":"date-time"},"deliveryDateRequested":{"type":"string","description":"Date on which buyer requests goods to be delivered (DTM+2).","format":"date-time"},"deliveryDateActual":{"type":"string","description":"Actual delivery date/time (DTM+35). Date/time on which goods or consignment are delivered at their destination.","format":"date-time"},"deliveryDateEstimated":{"type":"string","description":"Date and/or time when the shipper of the goods expects delivery will take place (DTM+17).","format":"date-time"},"buyer":{"$ref":"#/components/schemas/PartnerDto"},"deliveryParty":{"$ref":"#/components/schemas/PartnerDto"},"supplier":{"$ref":"#/components/schemas/PartnerDto"},"shipFrom":{"$ref":"#/components/schemas/PartnerDto"},"organicControlNumber":{"type":"string","description":"ECO controlling agency (RFF+XC1).","example":"DE-ÖKO-001"},"carrier":{"$ref":"#/components/schemas/PartnerDto"},"despatchedPalletCount":{"type":"string","description":"Number of pallets dispatched in the shipment","example":"12"},"lineItems":{"type":"array","description":"List of individual line items included in this receiving advice. Each line item includes its unique ID.","items":{"$ref":"#/components/schemas/LineItemResponseDto"}}},"description":"Receiving advice data returned in API responses according to EANCOM DESADV standards. Contains complete delivery notification information including document references, dates, partners, and line items with their IDs."},"TransportBodyDto":{"required":["transportConsignments"],"type":"object","properties":{"transportConsignments":{"type":"array","description":"List of consignments included in this transport","items":{"$ref":"#/components/schemas/TransportConsignmentDto"}}},"description":"Transport body containing the list of consignments within the transport"},"TransportConsignmentDto":{"required":["consignor","deliveryNoteNumber","orderNumber"],"type":"object","properties":{"consignmentItemNumber":{"type":"string","description":"Sequential item number for this consignment within the transport","example":"1"},"orderNumber":{"type":"string","description":"Reference to the order number fulfilled by this consignment","example":"PO-2024-567890"},"deliveryNoteNumber":{"type":"string","description":"Delivery note number associated with this consignment","example":"DN-2024-001234"},"organicControlNumber":{"type":"string","description":"Organic control number for organic products","example":"DE-ÖKO-001"},"consignmentNumber":{"type":"string","description":"Consignment number (carrier shipment number)","example":"CARR-SHIP-2024-001"},"consignor":{"$ref":"#/components/schemas/TransportPartnerDto"},"buyer":{"$ref":"#/components/schemas/TransportPartnerDto"},"supplier":{"$ref":"#/components/schemas/TransportPartnerDto"},"deliveryDateRequested":{"type":"string","description":"Requested delivery date in ISO-8601 format (DTM+2)","format":"date-time","example":"2024-01-20T14:00:00Z"},"deliveryDateActual":{"type":"string","description":"Actual delivery date in ISO-8601 format (DTM+35)","format":"date-time","example":"2024-01-20T15:30:00Z"},"deliveryDateEstimated":{"type":"string","description":"Estimated delivery date in ISO-8601 format (DTM+17)","format":"date-time","example":"2024-01-20T14:00:00Z"}},"description":"Individual consignment within a transport containing delivery and partner information"},"TransportDto":{"required":["body","header"],"type":"object","properties":{"header":{"$ref":"#/components/schemas/TransportHeaderDto"},"body":{"$ref":"#/components/schemas/TransportBodyDto"}},"description":"Transport document containing header and body information for creating goods receipts from transport data"},"TransportHeaderDto":{"required":["consignee","deliveryDate"],"type":"object","properties":{"deliveryDate":{"type":"string","description":"Expected delivery date for the transport in ISO-8601 format","format":"date-time","example":"2024-01-20T14:00:00Z"},"carrier":{"$ref":"#/components/schemas/TransportPartnerDto"},"consignee":{"$ref":"#/components/schemas/TransportPartnerDto"}},"description":"Transport header information containing carrier details and delivery dates"},"TransportPartnerAddressDto":{"type":"object","properties":{"addressLine1":{"type":"string","description":"First line of the address (street and number)","example":"123 Main Street"},"addressLine2":{"type":"string","description":"Second line of the address (additional address information)","example":"Building A, Floor 2"},"stateProvinceCounty":{"type":"string","description":"State, province, or county","example":"Bavaria"},"zipcode":{"type":"string","description":"Postal code or ZIP code","example":"80331"},"city":{"type":"string","description":"City name","example":"Munich"},"countryCode":{"pattern":"^[A-Z]{2}$","type":"string","description":"ISO 3166-1 alpha-2 country code","example":"DE"}},"description":"Physical address information for transport partners"},"TransportPartnerDto":{"required":["gln"],"type":"object","properties":{"gln":{"pattern":"^[0-9]{13}$","type":"string","description":"Global Location Number (GLN) - unique identifier for the partner","example":"4012345000017"},"name":{"type":"string","description":"Partner name","example":"ACME Corporation Ltd."},"internalPartnerId":{"type":"string","description":"Internal partner identifier used by the organization","example":"ACME-001"},"address":{"$ref":"#/components/schemas/TransportPartnerAddressDto"},"vatNumber":{"type":"string","description":"VAT number of the partner","example":"DE123456789"},"rootGln":{"pattern":"^[0-9]{13}$","type":"string","description":"Root GLN for hierarchical partner structures","example":"4012345000000"}},"description":"Partner information for transport participants including identification and address details"},"TransportConsignmentResponseDto":{"type":"object","properties":{"consignmentId":{"type":"string","description":"Unique identifier of the created consignment (goods receipt ID)","example":"87654321-4321-4321-4321-210987654321"},"deliveryNoteNumber":{"type":"string","description":"Delivery note number associated with this consignment","example":"DN-2024-001234"},"orderNumber":{"type":"string","description":"Order number fulfilled by this consignment","example":"PO-2024-567890"},"organicControlNumber":{"type":"string","description":"Organic control number for organic products","example":"DE-ÖKO-001"},"consignmentNumber":{"type":"string","description":"Consignment number (carrier shipment number)","example":"CARR-SHIP-2024-001"}},"description":"Response information for a created consignment within a transport"},"TransportResponseDto":{"type":"object","properties":{"transportId":{"type":"string","description":"Unique identifier of the created transport (goods receipt bundle ID)","example":"12345678-1234-1234-1234-123456789012"},"consignments":{"type":"array","description":"List of consignments created from the transport document","items":{"$ref":"#/components/schemas/TransportConsignmentResponseDto"}}},"description":"Response containing the created transport information with consignment details"},"DVAErrorResponse":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message describing what went wrong","example":"Goods receipt with ID 'gr-123456-789' not found"},"errorCode":{"type":"string","description":"Machine-readable error code for programmatic error handling","example":"NOT_FOUND"},"parameters":{"type":"object","additionalProperties":{"type":"string","description":"Additional parameters and context information related to the error","example":"{\"id\":\"gr-123456-789\",\"entityType\":\"GoodsReceipt\"}"},"description":"Additional parameters and context information related to the error","example":{"id":"gr-123456-789","entityType":"GoodsReceipt"}},"invocationId":{"type":"string","description":"Unique identifier for this API request/invocation for tracing and debugging purposes","example":"req-abc123-def456-ghi789"}},"description":"Standard error response structure returned by all API endpoints when an error occurs"},"TransportConsignmentDeliveryNoteUploadResponseDto":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the upload was successful","example":true},"error":{"type":"string","description":"Error message if upload failed, null if successful","example":"File size exceeds maximum allowed"}},"description":"Response for delivery note upload operation indicating success or failure"},"GoodsReceiptCreateDto":{"required":["receivingAdvice","referenceNumber"],"type":"object","properties":{"referenceNumber":{"type":"string","description":"Reference number assigned by the warehouse management system (WMS). Unique identifier used for tracking and cross-referencing with external systems.","example":"REF-2024-001234"},"archiveNumber":{"type":"string","description":"Archive or barcode number used to match documents in ECM (Enterprise Content Management) and Markant Mareko systems. This number enables document traceability across different platforms.","example":"ARC-789012345"},"receivingAdvice":{"$ref":"#/components/schemas/ReceivingAdviceCreateDto"},"protocol":{"$ref":"#/components/schemas/GoodsReceiptProtocolDto"},"loadCarrierExchange":{"$ref":"#/components/schemas/LoadCarrierExchangeDto"},"assortments":{"type":"array","description":"List of assortment classifications to assign to this goods receipt. Assortments categorize goods by type such as fresh, dry, or frozen products.","example":["FRESH","DRY"],"items":{"type":"string","description":"Assortment type classification for goods receipt","example":"[\"FRESH\",\"DRY\"]","enum":["FRESH","MEAT","FRUITS_AND_VEGETABLES","DRY","FROZEN"],"x-enum-descriptions":{"FRUITS_AND_VEGETABLES":"Fruits and vegetables assortment","DRY":"Dry goods assortment","FROZEN":"Frozen goods assortment","FRESH":"Fresh goods assortment","MEAT":"Meat assortment"}}},"state":{"type":"string","description":"The initial state of the goods receipt bundle. Determines where the bundle appears on the Incoming Goods Board.","example":"ANNOUNCED_DELIVERIES","enum":["ANNOUNCED_DELIVERIES","DOCUMENT_REVIEW","GATE_ASSIGNMENT","DELIVERIES_CONTROL"]}},"description":"Data transfer object for creating a new goods receipt. Contains all necessary information to create a goods receipt from receiving advice data."},"LineItemCreateDto":{"type":"object","properties":{"lineItemNumber":{"type":"string","description":"Line item number to uniquely identify this line item. The line item number iterates over the whole message starting with 1.","example":"2"},"hierarchyLevel":{"type":"string","description":"CPS Level - hierarchy level indicator"},"hierarchyLevelParent":{"type":"string","description":"CPS Parent - parent hierarchy level reference"},"gtin":{"type":"string","description":"Global Trade Item Number (GTIN) to uniquely identify this line item. A unique number, up to 14-digits.","example":"1234567890123"},"targetMarket":{"type":"string","description":"Target market identifier"},"articleNumberBuyer":{"type":"string","description":"Buyer specific article number for this item","example":"67890123"},"articleNumberSupplier":{"type":"string","description":"Supplier specific article number for this item","example":"67890123"},"ssccs":{"$ref":"#/components/schemas/SsccsDto"},"despatchedQuantity":{"$ref":"#/components/schemas/QuantityDto"},"orderedQuantity":{"$ref":"#/components/schemas/QuantityDto"},"bestBeforeDate":{"type":"string","description":"Best before date for this line item.","format":"date-time"},"organicControlNumber":{"type":"string","description":"ECO controlling agency (RFF+XC1). The article is a BIO product. The indication overwrites information of the heading section."},"hazardInformation":{"type":"string","description":"Hazard information containing Agreement concerning the International Carriage of Dangerous Goods by Road (ADR) related information like an UN number of the item"},"pharmacyProductNumber":{"type":"string","description":"Pharmacy Product Number holding the Product Registration Agency Code (PRA-Code)"},"articleDescription":{"type":"string","description":"Article description of this line item"},"quantityVariance":{"$ref":"#/components/schemas/LineItemQuantityVarianceDto"},"weightVariance":{"$ref":"#/components/schemas/LineItemWeightVarianceDto"},"batchNumber":{"type":"string","description":"Batch number supplementing the identification code of a product used to identify the specific production place and/or time of a product."}},"description":"Data transfer object for creating a new line item. The ID will be generated by the system."},"ReceivingAdviceCreateDto":{"required":["deliveryNoteNumber","deliveryParty","orderNumber"],"type":"object","properties":{"documentNumber":{"type":"string","description":"Document number assigned by sender. This segment is used to indicate the type and function of a message and to transmit the identifying number (BGM).","example":"DESADV2024001234"},"orderNumber":{"type":"string","description":"Reference Order Number of buyer (ON).","example":"ORD-2024-5678"},"orderNumberSupplier":{"type":"string","description":"Reference Order Number of supplier (VN).","example":"SUP-ORD-9876"},"deliveryNoteNumber":{"type":"string","description":"Delivery Note Number (RFF+DQ).","example":"DN-2024-3456"},"documentDate":{"type":"string","description":"Date/time when the document/message was issued. This may include authentication (DTM+137).","format":"date-time"},"orderDate":{"type":"string","description":"Date or time on which the goods were ordered (only P&G specific field)","format":"date-time"},"despatchedDate":{"type":"string","description":"Date or time on which the goods are or are expected to be despatched or shipped (DTM+11).","format":"date-time"},"deliveryDateRequested":{"type":"string","description":"Date on which buyer requests goods to be delivered (DTM+2).","format":"date-time"},"deliveryDateActual":{"type":"string","description":"Actual delivery date/time (DTM+35). Date/time on which goods or consignment are delivered at their destination.","format":"date-time"},"deliveryDateEstimated":{"type":"string","description":"Date and/or time when the shipper of the goods expects delivery will take place (DTM+17).","format":"date-time"},"buyer":{"$ref":"#/components/schemas/PartnerDto"},"deliveryParty":{"$ref":"#/components/schemas/PartnerDto"},"supplier":{"$ref":"#/components/schemas/PartnerDto"},"shipFrom":{"$ref":"#/components/schemas/PartnerDto"},"organicControlNumber":{"type":"string","description":"ECO controlling agency (RFF+XC1).","example":"DE-ÖKO-001"},"carrier":{"$ref":"#/components/schemas/PartnerDto"},"despatchedPalletCount":{"type":"string","description":"Number of pallets dispatched in the shipment","example":"12"},"lineItems":{"type":"array","description":"List of individual line items included in this receiving advice. Line item IDs are not required and will be generated by the system.","items":{"$ref":"#/components/schemas/LineItemCreateDto"}}},"description":"Receiving advice data for creating a goods receipt according to EANCOM DESADV standards. Line items do not require IDs as they will be generated by the system."},"GoodsReceiptIdResponseDto":{"type":"object","properties":{"goodsReceiptId":{"type":"string","description":"Unique identifier of the goods receipt","example":"550e8400-e29b-41d4-a716-446655440000"}},"description":"Response containing the unique identifier of a goods receipt."},"LineItemIdResponseDto":{"type":"object","properties":{"lineItemId":{"type":"string","description":"Unique identifier of the created line item","example":"550e8400-e29b-41d4-a716-446655440000"}},"description":"Response containing the ID of a newly created line item"},"AttachmentCreateResponseDto":{"type":"object","properties":{"attachmentId":{"type":"string","description":"Unique identifier of the created attachment","example":"123e4567-e89b-12d3-a456-426614174000"}},"description":"Response containing the unique identifier of a created attachment."},"GoodsReceiptAcknowledgeDto":{"type":"object","properties":{"signatures":{"maxItems":2,"minItems":0,"type":"array","description":"List of signatures for the acknowledgement (optional)","example":[{"name":"John Doe","signatureContent":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...","type":"CLERK"}],"items":{"$ref":"#/components/schemas/SignatureCreateDto"}},"loadCarrierExchangeChecked":{"type":"boolean","description":"Whether load carrier exchange has been checked","example":true},"comment":{"maxLength":1000,"minLength":0,"type":"string","description":"Comment or additional information regarding the acknowledgement","example":"All items received in good condition"}},"description":"Acknowledgement of a goods receipt including signatures, load carrier exchange check, and comments"},"SignatureCreateDto":{"required":["signatureContent","type"],"type":"object","properties":{"name":{"type":"string","description":"Name of the person signing (optional)","example":"John Doe"},"signatureContent":{"type":"string","description":"Signature content as a Data URI (RFC 2397). Must start with 'data:image/png;base64,' followed by the base64-encoded PNG image data. The decoded image size must be ≤ 1MB.","example":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."},"type":{"type":"string","description":"Type of signature - either DRIVER or CLERK","example":"CLERK","enum":["DRIVER","CLERK"]}},"description":"Signature information for acknowledging a goods receipt","example":[{"name":"John Doe","signatureContent":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...","type":"CLERK"}]},"GoodsReceiptAcknowledgeResponseDto":{"type":"object","properties":{"goodsReceiptId":{"type":"string","description":"Unique identifier of the acknowledged goods receipt","example":"123e4567-e89b-12d3-a456-426614174000"},"goodsReceiptBundleId":{"type":"string","description":"Unique identifier of the goods receipt bundle that was acknowledged","example":"987fcdeb-51a2-43d1-9c4f-123456789abc"},"acknowledgedAt":{"type":"string","description":"Timestamp when the acknowledgement was created in ISO-8601 format","format":"date-time","example":"2024-01-20T15:30:00Z"},"acknowledgedBy":{"type":"string","description":"User who created the acknowledgement","example":"API-External-System"},"acknowledgementAccessKey":{"type":"string","description":"Unique access key for the acknowledgement, can be used to access proof of delivery documents","example":"ack-key-abc123def456"},"automaticallyCreated":{"type":"boolean","description":"Indicates whether the acknowledgement was created automatically","example":true}},"description":"Response containing acknowledgement confirmation details for a goods receipt"},"Address":{"type":"object","properties":{"addressLine1":{"type":"string","example":"Musterstraße 123"},"addressLine2":{"type":"string","example":"Gebäude A, 2. OG"},"stateProvinceCounty":{"type":"string","example":"Brandenburg"},"zipcode":{"type":"string","example":"12345"},"city":{"type":"string","example":"Berlin"},"countryCode":{"type":"string","example":"DE"}},"description":"Physical address of the partner"},"DeliveryNoteBodyDto":{"required":["packages"],"type":"object","properties":{"sscc":{"pattern":"^[0-9]{18}$","type":"string","description":"Serial Shipping Container Code for the whole delivery","example":"340353770000001234"},"packages":{"type":"array","description":"First level packages in the delivery hierarchy","items":{"$ref":"#/components/schemas/DeliveryNotePackageDto"}},"total":{"$ref":"#/components/schemas/DeliveryNoteTotal"}},"description":"Body information for the delivery note containing package structure and totals"},"DeliveryNoteDto":{"type":"object","properties":{"header":{"$ref":"#/components/schemas/DeliveryNoteHeaderDto"},"body":{"$ref":"#/components/schemas/DeliveryNoteBodyDto"}},"description":"Delivery note data containing header and body information for creating goods receipts"},"DeliveryNoteHeaderDto":{"required":["buyer","deliveryDate","deliveryNoteNumber","deliveryParty","supplier"],"type":"object","properties":{"supplier":{"$ref":"#/components/schemas/DeliveryNotePartner"},"sender":{"$ref":"#/components/schemas/DeliveryNotePartner"},"deliveryParty":{"$ref":"#/components/schemas/DeliveryNotePartner"},"buyer":{"$ref":"#/components/schemas/DeliveryNotePartner"},"carrier":{"$ref":"#/components/schemas/DeliveryNotePartner"},"deliveryNoteNumber":{"type":"string","description":"Delivery note number","example":"DN-2024-001234"},"orderNumber":{"type":"string","description":"Reference to the order number fulfilled by this delivery note","example":"PO-2024-567890"},"orderDate":{"type":"string","description":"Order date to the referenced order in ISO-8601 format","format":"date-time","example":"2024-01-15T10:30:00Z"},"deliveryDate":{"type":"string","description":"Date of the expected delivery in ISO-8601 format","format":"date-time","example":"2024-01-20T14:00:00Z"},"organicControlNumber":{"type":"string","description":"Organic Control Number","example":"DE-ÖKO-001"},"supplierShipmentNumber":{"type":"string","description":"The shipment number as transmitted by the supplier","example":"SHIP-2024-001"},"carrierShipmentNumber":{"type":"string","description":"The shipment number as transmitted by the carrier","example":"CARR-2024-001"},"fileTransferId":{"type":"string","description":"A file transfer ID which can be used and set by an API client","example":"FT-2024-001"}},"description":"Header information for the delivery note containing partner details and delivery metadata"},"DeliveryNoteLineItemDto":{"required":["gtin","quantity"],"type":"object","properties":{"lineItemNumber":{"minimum":1,"type":"integer","description":"Sequential number for the line item within the delivery note","format":"int32","example":1},"sscc":{"pattern":"^[0-9]{18}$","type":"string","description":"Serial Shipping Container Code for this specific line item","example":"340353770000001234"},"gtin":{"pattern":"^[0-9]{8,14}$","type":"string","description":"Global Trade Item Number (GTIN) to uniquely identify this product","example":"1234567890123"},"quantity":{"minimum":0,"type":"number","description":"Quantity of items in this line item","format":"double","example":10.0},"unit":{"$ref":"#/components/schemas/DeliveryNoteUnitType"},"packageType":{"$ref":"#/components/schemas/DeliveryNotePackageType"},"description":{"type":"string","description":"Human-readable description of the product","example":"Swiss chocolate bars"},"supplierItemNumber":{"type":"string","description":"Supplier-specific item number for this product","example":"SUP-67890123"},"buyerItemNumber":{"type":"string","description":"Buyer-specific item number for this product","example":"BUY-96251521"},"bestBeforeDate":{"type":"string","description":"Best before date of this product in ISO-8601 format","format":"date-time","example":"2024-12-31T23:59:59Z"},"batchNumber":{"type":"string","description":"Batch or lot number of this product","example":"BATCH-05.12345"},"pharmacyProductNumber":{"type":"string","description":"Pharmacy product number (PZN) for pharmaceutical products","example":"PZN-1234567"},"hazardInformation":{"type":"string","description":"Hazard information or warnings for dangerous goods","example":"Flammable liquid"},"organicControlNumber":{"type":"string","description":"Organic control number for organic products","example":"DE-ÖKO-001"},"subLineItems":{"type":"array","description":"Sub-line items that are part of this line item, typically used for pre-packed items","example":[],"items":{"$ref":"#/components/schemas/DeliveryNoteLineItemDto"}},"volume":{"$ref":"#/components/schemas/DeliveryNoteVolume"},"weight":{"$ref":"#/components/schemas/DeliveryNoteWeight"}},"description":"Line item information containing product details, quantities, and packaging information"},"DeliveryNotePackageDto":{"type":"object","properties":{"sscc":{"pattern":"^[0-9]{18}$","type":"string","description":"Serial Shipping Container Code for this package level","example":"340353770000001234"},"gtin":{"pattern":"^[0-9]{8,14}$","type":"string","description":"Global Trade Item Number (GTIN) for the package itself","example":"1234567890123"},"quantity":{"minimum":0,"type":"number","description":"Quantity of packages at this level","format":"double","example":5.0},"packageType":{"$ref":"#/components/schemas/DeliveryNotePackageType"},"description":{"type":"string","description":"Human-readable description of the package","example":"Euro pallet with mixed products"},"supplierItemNumber":{"type":"string","description":"Supplier-specific item number for this package","example":"SUP-PKG-001"},"buyerItemNumber":{"type":"string","description":"Buyer-specific item number for this package","example":"BUY-PKG-001"},"packages":{"type":"array","description":"Sub-packages contained within this package (hierarchical structure)","example":[],"items":{"$ref":"#/components/schemas/DeliveryNotePackageDto"}},"lineItems":{"type":"array","description":"Line items directly contained in this package","items":{"$ref":"#/components/schemas/DeliveryNoteLineItemDto"}},"volume":{"$ref":"#/components/schemas/DeliveryNoteVolume"},"weight":{"$ref":"#/components/schemas/DeliveryNoteWeight"}},"description":"Package information containing hierarchical packaging structure and contained items"},"DeliveryNotePackageType":{"type":"string","description":"Enumeration of supported package types for delivery notes","enum":["PALLET_EURO_1_1","PALLET_EURO_1_2","PALLET_EURO_1_4","PALLET_EURO_CHEP_BLUE","PALLET_EURO_LPR_RED","PALLET_ONE_WAY","MEAT_BOX_E1","MEAT_BOX_E2","MEAT_BOX_E3","OUTER_PACKAGING","CARTON","GS1_SMART_BOX","UNKNOWN"]},"DeliveryNotePartner":{"required":["gln"],"type":"object","properties":{"gln":{"pattern":"^[0-9]{13}$","type":"string","description":"Global Location Number (GLN) - unique identifier for the partner","example":"4012345000017"},"name":{"type":"string","description":"Partner name","example":"ACME Corporation Ltd."},"internalPartnerId":{"type":"string","description":"Internal partner identifier used by the organization","example":"ACME-001"},"address":{"$ref":"#/components/schemas/Address"},"vatNumber":{"type":"string","description":"VAT number of the partner","example":"DE123456789"},"rootGln":{"pattern":"^[0-9]{13}$","type":"string","description":"Root GLN for hierarchical partner structures","example":"4012345000000"}},"description":"Partner information including identification and address details"},"DeliveryNoteTotal":{"type":"object","properties":{"volume":{"$ref":"#/components/schemas/DeliveryNoteVolume"},"weight":{"$ref":"#/components/schemas/DeliveryNoteWeight"}},"description":"Total volume and weight information for the entire delivery"},"DeliveryNoteUnitType":{"type":"string","description":"Enumeration of supported unit types for the quantity of lineitems in delivery notes","example":"PCE","enum":["PCE","CT"]},"DeliveryNoteVolume":{"type":"object","properties":{"unitOfMeasurement":{"type":"string","description":"Unit of measurement for volume","example":"m³","enum":["m³","l","cm³","dm³"]},"gross":{"minimum":0,"type":"number","description":"Gross volume including packaging","format":"double","example":1.5}},"description":"Volume information with unit of measurement"},"DeliveryNoteWeight":{"type":"object","properties":{"unitOfMeasurement":{"type":"string","description":"Unit of measurement for weight","example":"kg","enum":["kg","g","t","lb","oz"]},"net":{"minimum":0,"type":"number","description":"Net weight excluding packaging","format":"double","example":25.5},"gross":{"minimum":0,"type":"number","description":"Gross weight including packaging","format":"double","example":27.8}},"description":"Weight information with unit of measurement including net and gross weights"},"DeliveryNoteCreateResponse":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the created goods receipt","example":"12345678-1234-1234-1234-123456789012"}},"description":"Response containing the ID of the created goods receipt from delivery note processing"},"PageMetadata":{"type":"object","properties":{"size":{"type":"integer","format":"int64"},"number":{"type":"integer","format":"int64"},"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int64"}}},"PagedModel":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}}},"securitySchemes":{"event-grid-code":{"type":"apiKey","description":"API key authentication for Event Grid endpoints","name":"code","in":"query"},"oauth":{"type":"oauth2","description":"OAuth 2.0 authentication using client credentials flow.\n\n**How to obtain a token:**\n1. Request M2M client credentials (clientId and clientSecret) from dva-support@markant.services.com\n2. Use the client credentials flow to get an access token from the token endpoint\n3. Include the access token as a Bearer token in the Authorization header\n\n**Token endpoint:** https://identity.markant.com/oauth/token\n\n**Example curl command:**\n```\ncurl --request POST \\\n\t--location 'https://identity.markant.com/oauth/token' \\\n\t--header 'Content-Type: application/x-www-form-urlencoded' \\\n\t--data-urlencode 'grant_type=client_credentials' \\\n\t--data-urlencode 'client_id=<clientId>' \\\n\t--data-urlencode 'client_secret=<clientSecret>' \\\n\t--data-urlencode 'audience=https://api.m.markant.com'\n```\n\n**Token validity:** 1 hour\n","flows":{"implicit":{"authorizationUrl":"https://identity.markant.com/authorize?audience=https://api.m.markant.com","tokenUrl":"https://identity.markant.com/oauth/token","scopes":{}}}}}}}