Operation: DeliveryNoteQuery
- Michelle Zaczek (Unlicensed)
The element vcr:DeliveryNoteQueryRequest extends vct:RequestType with the following elements:
Name | Type/occurence | Description |
|---|---|---|
vcr:DateRange | Range for document date. | |
vcr:OrderID | xsd:normalizedString* | Document number(s) of the corresponding order(s). |
vcr:OrderConfirmationID | xsd:normalizedString* | Document number(s) of the corresponding order confirmations. |
The element vcr:DeliveryNoteQueryResponse extends vct:ResponseType with the optional vcr:DateRange element and a list of vcr:DeliveryNoteHeader elements. DeliveryNoteHeader consists of the following elements:
Name | Type/occurrence | Description |
|---|---|---|
vcr:DeliveryNoteID | xsd:string | Document number of the delivery note. |
cbc:IssueDate |
| Document date. |
vcr:Description | xsd:normalizedString? | Description. |
vcr:OrderID | xsd:normalizedString* | Corresponding orders. |
vcr:OrderConfirmationID | xsd:normalizedString* | Corresponding order confirmation. |
Rules: Server
A DeliveryNoteQueryRequest is to be processed as follows: All delivery notes to which the DateRange, OrderID and OrderConfirmationID search parameters apply are determined, as described in the section on document management.
The determined list of delivery notes must be returned in the DeliveryNoteQueryResponse; any limitations of the search result must be communicated via DateRange, as described in document management.
If the server supports the OrderID or OrderConfirmationID search parameters, each DeliveryNoteHeader element must also contain at least one non-empty OrderID or OrderConfirmationID element.
If the QueryRequest contains OrderID or OrderConfirmationID elements, whereas the server does not support these search parameters, a DeliveryNoteQueryResponse with ResponseCode 404 is conveyed.
If the server does not support one of the OrderID or OrderConfirmationID search parameters, it must declare this in the profile by means of UnsupportedQuery elements containing a DeliveryNote-OrderID or DeliveryNote-OrderConfirmationID.
Rules: Client
OrderID search parameters may be used only if the server profile has not declared an absence of support for these search parameters.
OrderConfirmationID search parameters may be used only if the server profile has not declared an absence of support for these search parameters.