Retrieve Documents

Logistic operators will use this API in order to retrieve documents id outbound from Campari. More precisely, this API provides the following document types: 1. PurchaseOrder 2. StockTransferOrder 3. ReturnOrder 4. SalesOrder 5. SalesDelivery 6. ReturnDelivery 7. TransferPosting 8. Factura 9. Boleta 10. StockTransferOrderOut 11. MaterialMaster 12. BillOfMaterial At each call, this API sends the list of all the pending documents posted by Campari ERP system. In order to get the full details of the documents, you should run in sequence the following APIs: 1. **Retrieve documents** to get the list of new pending documents; 2. **Retrieve documents by id** for each document found in the previous step. Once a document is retrieved, it is removed from the pending list; 3. **Processing confirmations** should be called to report any error (with “flow” field equal to document type such as SalesDelivery) when processing a document. In this case the corresponding document will be added again to the pending document list and will be retrieved in the next Retrieve Documents API call. #### Request URI

Copy

Query Parameter	Type	Mandatory	Description
logisticOperator	String	Y	Name of Logistic Operator
documentType	String	N	Type of document

#### Response Structure

Field	Type	Mandatory	Description	Technical Details
id	String	Y	Document unique identifier
creationDateTime	DateTime	Y	Document creation date and time	Format: YYYY-MM-DDThh:mm:ssZ

#### Response Examples If _documentType_ parameter is not specified, the API returns each id grouped by document type: { "PurchaseOrder": [ { "id": "4500453012", "creationDateTime": "2019-05-23T21:00:09+01:00" }, { "id": "4500453054", "creationDateTime": "2019-06-04T00:42:00+01:00" } ], "StockTransferOrder": [ { "id": "9000215999", "creationDateTime": "2023-02-24T11:30:03+01:00" } ], "ReturnOrder": [ { "id": "2612000727", "creationDateTime": "2019-05-24T00:11:05+01:00" } ], "SalesDelivery": [ { "id": "2614006784", "creationDateTime": "2019-05-24T03:11:07+01:00" } ], "ReturnDelivery": [ { "id": "2614006785", "creationDateTime": "2019-05-24T22:33:03+01:00" }, { "id": "2614005964", "creationDateTime": "2019-05-28T01:28:03+01:00" } ], "TransferPosting": [ { "id": "49000014592019", "creationDateTime": "2019-06-04T14:50:08+01:00" }, { "id": "49000014612019", "creationDateTime": "2019-06-04T15:01:02+01:00" }, { "id": "49000014562019", "creationDateTime": "2019-06-03T21:00:08+01:00" } ], "Factura": [ { "id": "2615000002", "creationDateTime": "2019-05-22T00:00:00+01:00" } ], "Boleta": [ { "id": "2615000582", "creationDateTime": "2019-05-22T00:00:00+01:00" }, { "id": "2615000580", "creationDateTime": "2019-05-22T00:00:00+01:00" } ], "MaterialMaster": [ { "id": "000000000000430534", "creationDateTime": "2023-02-20T15:13:01+01:00" }, { "id": "000000000000600951", "creationDateTime": "2023-02-24T06:25:09+01:00" }, { "id": "000000000000426297", "creationDateTime": "2023-02-27T08:43:01+01:00" } ], "StockTransferOrderOut": [ { "id": "9000215455", "creationDateTime": "2023-02-24T11:30:03+01:00" } ], "BillOfMaterial": [ { "id": "430533IT1L101", "creationDateTime": "2023-03-17T11:47:03+01:00" } ] } Copy Otherwise the API returns all id depending on the document type specified, e.g. documentType=“PurchaseOrder”: { "PurchaseOrder": [ { "id": "4500453012", "creationDateTime": "2019-05-23T21:00:09+01:00" }, { "id": "4500453054", "creationDateTime": "2019-06-04T00:42:00+01:00" } ] } Copy