{ "openapi":"3.1.0", "info":{ "title":"Order Execution API specifications", "description":"REST APIs exposed by microservice", "contact":{ "name":"LEX API support", "email":"lex-l3@michelin.com" }, "version":"2.2.0", "x-microcks":{ "labels":[ { "entity":"LEX" } ] } }, "servers":[ { "url":"https://sandbox.api.michelin.com/mock-order-execution", "description":"Generated server url" } ], "security":[ { "bearerAuth":[ ] } ], "tags":[ { "name":"GET Operations", "description":"API to get events from LEX" }, { "name":"POST Operations", "description":"API to send events to LEX" } ], "paths":{ "-outbound/v2/shipped":{ "post":{ "tags":[ "POST Operations" ], "summary":"Post a shipped message to LEX", "operationId":"sendShippedFrom3PL", "requestBody":{ "description":"The shippedFrom3PL to send to LEX", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ShippedFrom3PLDto" }, "examples":{ "shipped":{ "description":"shipped", "value":{ "creationDateTime":"2023-06-07T14:15:00.000+02:00", "eventType":"SHIPMENT_CONFIRMATION", "shipmentId":"ShipmentID123", "sourceShipmentId":"SourceShipmentID456", "shipmentTrackingId":"TrackingID789", "shipmentTrackingUrl":"http://trackingurl.com/TrackingID789", "scacCode":"SCAC123", "carrierCode":"CarrierCode456", "carrierName":"CarrierNameXYZ", "carrierService":"Express", "shippedDateTime":"2023-06-07T15:00:00.000+02:00", "requestedShippedDateTime":"2023-06-07T12:00:00.000+02:00", "placeOfLoading":"UNLOCODE123", "placeOfDischarge":"UNLOCODE456", "transportUnitId":"ContainerID789", "shipFrom":{ "code":"ShipFromCode", "address":{ "address1":"123 Warehouse St", "city":"City", "state":"City", "isoCountry2Code":"st", "zipCode":"postalCode" } }, "lines":[ { "lineId":"1", "sourceLineId":"SourceLineID1", "itemCode":"477754_101", "itemType":"CAD", "itemDescription":"215/55 R17 94V TL ENERGY XM2 GRNX MIAIM RT", "subInventory":"SubInventory1", "productionCountryCode":"China", "dot":"2023W23", "customerPONumber":"PO12345", "customerPONumberLine":"PO12345-1", "customerPartNumber":"Part123", "customerPartNumberDescription":"Part Description", "requestedQuantity":10, "shippedQuantity":8, "notShippedQuantity":2, "quantityUOM":"PCS", "serialNumberList":[ "Serial123", "Serial124" ], "deliveryNoteNumber":"DN12345", "extraDatas":[ { "name":"Key1", "value":"Value1" }, { "name":"Key2", "value":"Value2" } ] }, { "lineId":"2", "sourceLineId":"SourceLineID2", "itemCode":"477755_102", "itemType":"Type2", "itemDescription":"215/55 R17 94V TL ENERGY XM2 GRNX MIAIM RT (Alternate)", "subInventory":"SubInventory2", "productionCountryCode":"USA", "dot":"2023W24", "customerPONumber":"PO67890", "customerPONumberLine":"PO67890-1", "customerPartNumber":"Part456", "customerPartNumberDescription":"Alternate Part Description", "requestedQuantity":20, "shippedQuantity":18, "notShippedQuantity":2, "quantityUOM":"PCS", "serialNumberList":[ "Serial125", "Serial126" ], "deliveryNoteNumber":"DN67890", "extraDatas":[ { "name":"Key3", "value":"Value3" }, { "name":"Key4", "value":"Value4" } ] } ], "extraDatas":[ { "name":"RootKey1", "value":"RootValue1" }, { "name":"RootKey2", "value":"RootValue2" } ] } } } } }, "required":true }, "responses":{ "200":{ "description":"Message successfully integrated", "content":{ "application/json":{ "examples":{ "Success":{ "description":"shippedFrom3PL successfully integrated", "value":{ "correlationId":"{{ correlation_id }}", "statusCode":"STOP_OK", "message":"End processing shipped with shipment id {{ shipment_id}}", "timestamp":"2025-06-03T10:02:19.1517009" } } } } } }, "400":{ "description":"Bad request", "content":{ "application/json":{ "examples":{ "Bad request":{ "description":"shippedFrom3PL not integrated", "value":{ "timestamp":"2025-06-03T10:09:48.1252892", "error":"Bad Request", "status":400, "message":"", "path":"https://sandbox.api.michelin.com/mock-order-execution-outbound/v2/shipped" } } } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "examples":{ "Unauthorized":{ "description":"Authentication failure", "value":{ "timestamp":"2025-06-03T10:10:42.7563806", "error":"Unauthorized", "status":401, "message":"Full authentication is required to access this resource", "path":"https://sandbox.api.michelin.com/mock-order-execution-outbound/v2/shipped" } } } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "examples":{ "Forbidden":{ "description":"Authorization failure", "value":{ "timestamp":"2025-06-03T10:18:25.932244", "error":"Access Denied", "status":403, "message":"Insufficient privileges", "path":"https://sandbox.api.michelin.com/mock-order-execution-outbound/v2/shipped" } } } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "examples":{ "Error":{ "description":"Internal server error", "value":{ "timestamp":"2025-06-03T10:18:25.932244", "error":"Internal server error", "status":500, "message":"Insufficient privileges", "path":"https://sandbox.api.michelin.com/mock-order-execution-outbound/v2/shipped" } } } } } } } } }, "-inbound/v2/received":{ "post":{ "tags":[ "POST Operations" ], "summary":"Post a received message to LEX", "operationId":"sendReceivedFrom3PL", "requestBody":{ "description":"The received to send to LEX", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ReceivedFrom3PLDto" }, "examples":{ "received":{ "description":"received", "value":{ "creationDateTime":"2023-06-07T14:15:00.000+02:00", "receivingId":"ReceivingID123", "sourceReceivingId":"SourceReceivingID456", "eventType":"RECEIVED_CONFIRMATION", "status":"RECEIVED", "receptionDateTime":"2023-06-07T15:00:00.000+02:00", "lines":[ { "lineId":"1", "sourceLineId":"SourceLineID1", "itemCode":"477754_101", "itemDescription":"215/55 R17 94V TL ENERGY XM2 GRNX", "subInventory":"SubInventory1", "expectedQuantity":10, "receivedQuantity":8, "quantityUOM":"PCS", "serialNumberList":[ "Serial123", "Serial124" ], "extraDatas":[ { "name":"LineKey1", "value":"LineValue1" }, { "name":"LineKey2", "value":"LineValue2" } ] }, { "lineId":"2", "sourceLineId":"SourceLineID2", "itemCode":"477755_102", "itemDescription":"215/55 R17 94V TL ENERGY XM2 GRNX (Alternate)", "subInventory":"SubInventory2", "expectedQuantity":20, "receivedQuantity":18, "quantityUOM":"PCS", "serialNumberList":[ "Serial125", "Serial126" ], "extraDatas":[ { "name":"LineKey3", "value":"LineValue3" } ] } ], "extraDatas":[ { "name":"RootKey1", "value":"RootValue1" }, { "name":"RootKey2", "value":"RootValue2" } ] } } } } }, "required":true }, "responses":{ "200":{ "description":"Message successfully integrated", "content":{ "application/json":{ "examples":{ "Success":{ "description":"receivedFrom3PL successfully integrated", "value":{ "correlationId":"{{ correlation_id }}", "statusCode":"STOP_OK", "message":"End processing received with receiving id {{ receiving_id}}", "timestamp":"2025-06-03T10:02:19.1517009" } } } } } }, "400":{ "description":"Bad request", "content":{ "application/json":{ "examples":{ "Bad request":{ "description":"ReceivedFrom3PL not integrated", "value":{ "timestamp":"2025-06-03T10:09:48.1252892", "error":"Bad Request", "status":400, "message":"", "path":"https://sandbox.api.michelin.com/mock-order-execution-inbound/v2/received" } } } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "examples":{ "Unauthorized":{ "description":"Authentication failure", "value":{ "timestamp":"2025-06-03T10:10:42.7563806", "error":"Unauthorized", "status":401, "message":"Full authentication is required to access this resource", "path":"https://sandbox.api.michelin.com/mock-order-execution-inbound/v2/received" } } } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "examples":{ "Forbidden":{ "description":"Authorization failure", "value":{ "timestamp":"2025-06-03T10:18:25.932244", "error":"Access Denied", "status":403, "message":"Insufficient privileges", "path":"https://sandbox.api.michelin.com/mock-order-execution-inbound/v2/received" } } } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "examples":{ "Error":{ "description":"Internal server error", "value":{ "timestamp":"2025-06-03T10:18:25.932244", "error":"Internal server error", "status":500, "message":"", "path":"https://sandbox.api.michelin.com/mock-order-execution-inbound/v2/received" } } } } } } } } }, "-outbound/v2/load":{ "get":{ "tags":[ "GET Operations" ], "summary":"Get the loads after minTimestamp", "operationId":"getLoadFor3PL", "parameters":[ { "name":"fetchSize", "in":"query", "description":"Number of elements to return (max=100, default=50)", "required":false, "schema":{ "type":"integer", "format":"int32", "default":50 } }, { "name":"minTimestamp", "in":"query", "description":"The min timestamp of the events shipment (Accepted format is timestamp or ISO_OFFSET_DATE_TIME)", "required":true, "schema":{ "type":"string", "default":"0" }, "example":"2023-05-27T08:18:58+02:00" } ], "responses":{ "200":{ "description":"Operation returns the list of loads from oldest to newest", "schema":{ "$ref":"#/components/schemas/ResultSetDtoLoadFor3PLDto" }, "content":{ "application/json":{ "examples":{ "Get load results":{ "description":"Get load results", "value":{ "correlationId":"99cb0a29-c999-48db-b973-3a80c0f29143", "creationDateTime":"2025-10-23T05:56:43.920Z", "source":"MICH", "target":"3PL", "sourceCreationDateTime":"2025-10-23T13:56:33Z", "createdBy":"H330960", "sourceLoadId":"451_TH_7D8_0175946", "loadId":"0175946", "sourceEventType":"PICK_REQUEST", "eventType":"LOAD", "routingInstructions":"routingInstructions", "scheduledShipDateTime":"2025-11-21T00:00:00Z", "scheduledShipByDateTime":"2025-11-21T00:00:00Z", "scheduledLoadingEndDateTime":"2025-11-21T00:00:00Z", "customerPONumber":"customerPONumber", "customerPONumberLine":"customerPONumberLine", "shipmentRequestType":"shipmentRequestType", "carrierCode":"SAS1", "carrierName":"SAS1", "carrierService":"Standard", "equipmentType":"HC40", "transportMode":"OCEAN", "status":"status", "priority":"priority", "shippingMethod":"shippingMethod", "serviceName":"serviceName", "shipFrom":{ "code":"451", "codeType":"organizationCode", "name":"451_OU", "inventoryOrgCode":"TRC", "inventoryOrgName":"TRC", "inventoryOrgType":"CW", "locationCode":"7D8_LOC", "locationName":"TRC", "logisticSiteCode":"TRC", "logisticSiteName":"TRC", "contactName":"contactName", "subInventory":"ONHAND", "gssSite":"LCH", "address":{ "address1":"TRC", "address2":"18140", "address3":"Michelin Siam 18140", "city":"city", "zipCode":"123456", "state":"state", "isoCountry2Code":"TH" } }, "shipTo":{ "code":"533", "codeType":"organizationCode", "name":"D80009077", "inventoryOrgCode":"TRC", "inventoryOrgName":"TRC", "inventoryOrgType":"CW", "locationCode":"3044027", "locationName":"MICHELIN AUSTRALIA PTY LTD", "contactName":"contactName", "kindOfCustomer":"kindOfCustomer", "market":"market", "gssSite":"gssSite", "subInventory":"ONHAND", "address":{ "address1":"SYDNEY RETREAD SERVICES", "address2":"UNIT7 54-56 STENNETT ROAD", "address3":"INGLEBUR", "city":"SYDNEY", "zipCode":"2565", "state":"state", "isoCountry2Code":"AU" } }, "billTo":{ "code":"451", "codeType":"organizationCode", "name":"451_OU", "address":{ "address1":"TRC", "address2":"18140", "address3":"Michelin Siam 18140", "city":"city", "zipCode":"123456", "state":"state", "isoCountry2Code":"TH" } }, "lines":[ { "lineId":"1", "sourceLineId":"0001", "deliveryId":"11597450", "deliveryLineId":"30630347", "routingInstructions":"routingInstructions", "shippingInstructions":"shippingInstructions", "logisticInstructions":"P..AUST..E2A", "stockOwner":"TRC", "factoryStockOwner":"factoryStockOwner", "customerPONumber":"THAU15286_25", "customerPOLineNumber":"001", "itemCode":"722222_101", "itemType":"CAD", "itemDescription":"CUSHION RUBBER SKIM L 14 - 30", "customerPartNumber":"722222_101", "customerPartNumberDescription":"customerPartNumberDescription", "shipFrom":{ "code":"451", "codeType":"organizationCode", "name":"451_OU", "inventoryOrgCode":"TRC", "inventoryOrgName":"TRC", "inventoryOrgType":"CW", "locationCode":"7D8_LOC", "locationName":"TRC", "logisticSiteCode":"TRC", "logisticSiteName":"TRC", "contactName":"contactName", "subInventory":"ONHAND", "gssSite":"LCH", "address":{ "address1":"TRC", "address2":"18140", "address3":"Michelin Siam 18140", "city":"city", "zipCode":"123456", "state":"state", "isoCountry2Code":"TH" } }, "shipTo":{ "code":"533", "codeType":"organizationCode", "name":"D80009077", "inventoryOrgCode":"TRC", "inventoryOrgName":"TRC", "inventoryOrgType":"CW", "locationCode":"3044027", "locationName":"MICHELIN AUSTRALIA PTY LTD", "contactName":"contactName", "kindOfCustomer":"kindOfCustomer", "market":"market", "gssSite":"gssSite", "subInventory":"ONHAND", "address":{ "address1":"SYDNEY RETREAD SERVICES", "address2":"UNIT7 54-56 STENNETT ROAD", "address3":"INGLEBUR", "city":"SYDNEY", "zipCode":"2565", "state":"state", "isoCountry2Code":"AU" } }, "billTo":{ "code":"451", "codeType":"organizationCode", "name":"451_OU", "address":{ "address1":"TRC", "address2":"18140", "address3":"Michelin Siam 18140", "city":"city", "zipCode":"123456", "state":"state", "isoCountry2Code":"TH" } }, "grossWeight":141.0, "netWeight":141.0, "weightUOM":"KG", "requestedQuantity":30.0, "requestedQuantityUOM":"EA", "scheduledDeliveryDateTimeMin":"2026-01-12T08:00:00Z", "scheduledDeliveryDateTimeMax":"2026-01-12T18:59:00Z", "scheduledShipDateTime":"2025-10-23T13:56:42Z", "scheduledLoadingEndDateTime":"2025-10-22T23:59:00Z", "shipmentMode":"LTL", "loadingSequenceOrder":"1", "orderNumber":"4510225075", "orderLineNumber":"1.1", "extraDatas":[ { "name":"extraData1", "value":"string" } ] } ] } } } } } }, "204":{ "description":"Operation returns nothing to fetch" }, "401":{ "description":"Not authenticated", "content":{ "application/json":{ "examples":{ "Unauthorized":{ "description":"Unauthorized", "value":{ "timestamp":"{{ timestamp }}", "error":"Unauthorized", "status":401, "message":"Full authentication is required to access this resource", "path":"https://sandbox.api.michelin.com/mock-order-execution-outbound/v2/load" } } } } } }, "403":{ "description":"Operation is not authorized: no subscription", "content":{ "application/json":{ "examples":{ "Forbidden":{ "description":"No subscription for the resource requested", "value":{ "timestamp":"{{ timestamp }}", "error":"Forbidden", "status":403, "message":"No subscription found for partnerId and event type SHIPMENT", "path":"https://sandbox.api.michelin.com/mock-order-execution-outbound/v2/load" } } } } } }, "400":{ "description":"Bad parameters", "content":{ "application/json":{ "examples":{ "Bad request":{ "description":"Bad request: check the API usage", "value":{ "timestamp":"{{ timestamp }}", "status":400, "error":"Bad Request", "message":"{{ errorMessage }}", "path":"https://sandbox.api.michelin.com/mock-order-execution-outbound/v2/load" } } } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "examples":{ "Error":{ "description":"Internal server error", "value":{ "timestamp":"{{ timestamp }}", "error":"Internal server error", "status":500, "message":"", "path":"https://sandbox.api.michelin.com/mock-order-execution-outbound/v2/load" } } } } } } } } }, "-outbound/v2/shipment":{ "get":{ "tags":[ "GET Operations" ], "summary":"Get the shipments after minTimestamp", "operationId":"getShipmentFor3PL", "parameters":[ { "name":"fetchSize", "in":"query", "description":"Number of elements to return (max=100, default=50)", "required":false, "schema":{ "type":"integer", "format":"int32", "default":50 } }, { "name":"minTimestamp", "in":"query", "description":"The min timestamp of the events shipment (Accepted format is timestamp or ISO_OFFSET_DATE_TIME)", "required":true, "schema":{ "type":"string", "default":"0" }, "example":"2023-05-27T08:18:58+02:00" } ], "responses":{ "200":{ "description":"Operation returns the list of shipments from oldest to newest", "schema":{ "$ref":"#/components/schemas/ResultSetDtoShipmentFor3PLDto" }, "content":{ "application/json":{ "examples":{ "Get shipment results":{ "description":"Get shipment results", "value":{ "correlationId":"e7290fdf-ac94-46ee-95c1-e08055c1f0a4", "latestTimestamp":1723552542014, "earliestTimestamp":1723552384967, "latestDateTime":"2024-08-13T12:35:42.014Z", "earliestDateTime":"2024-08-13T12:33:04.967Z", "fetchSize":2, "statusCode":"STOP_OK", "message":"Search query successful", "results":[ { "correlationId":"29db33cc-990e-47df-ba4b-cc941145a798", "value":{ "creationDateTime":"2024-08-13T12:33:04.967Z", "sourceCreationDateTime":"2022-02-04T21:20:04Z", "source":"E015673", "createdBy":"lex-3pl-preparedata-frombsc", "correlationId":"29db33cc-990e-47df-ba4b-cc941145a798", "sourceShipmentId":"WSTO-00017558", "shipmentId":"4360011118", "sourceEventType":"PICK_REQUEST", "extraDatas":null, "lines":[ { "createdBy":null, "lineId":"1", "sourceLineId":"10000", "orderNumber":"4360011118", "orderLineNumber":"10000", "shipFrom":{ "code":"540", "codeType":null, "name":"BSR-FRESH", "inventoryOrgCode":null, "inventoryOrgName":null, "inventoryOrgType":null, "organizationCode":null, "organizationName":null, "locationCode":null, "locationName":null, "logisticSiteCode":null, "logisticSiteName":null, "contactName":null, "subInventory":"BSR-FRESH", "gssSite":null, "address":{ "address1":"Calle 9 , 1430, Fatima, Pilar, Buenos Aires", "address2":" ", "address3":null, "city":"FATIMA", "zipCode":"1633", "state":null, "isoCountry2Code":"AR" }, "extraDatas":null }, "shipTo":{ "code":"35740", "codeType":null, "name":"DIESEL LANGE S.R.L", "inventoryOrgCode":null, "inventoryOrgName":null, "inventoryOrgType":null, "organizationCode":null, "organizationName":null, "locationCode":null, "locationName":null, "logisticSiteCode":null, "logisticSiteName":null, "contactName":null, "kindOfCustomer":null, "market":null, "gssSite":null, "subInventory":"BSR-FRES", "address":{ "address1":"Ruta Nacional A005 Km. 2,6 No 2.864", "address2":"", "address3":null, "city":"RIO CUARTO", "zipCode":"5800", "state":null, "isoCountry2Code":"AR" }, "extraDatas":null }, "billTo":{ "code":"35421", "codeType":null, "name":"DIESEL LANGE S.R.L", "address":null, "extraDatas":null }, "itemCode":"523567_101", "itemType":null, "itemDescription":"11.2 R24 114A8/111B TL POINT 8", "grossWeight":0, "weightUOM":null, "requestedQuantity":2, "requestedQuantityUOM":null, "logisticInstructions":" ", "scheduledShipDateTime":"2022-02-10T16:00:00Z", "scheduledShipByDateTime":"2022-02-09T16:00:00Z", "status":null, "priority":null, "carrierCode":null, "carrierName":null, "carrierService":"Standard", "shippingMethod":null, "transportMode":null, "customerPONumber":" ", "customerPOLineNumber":" ", "customerPartNumber":null, "customerPartNumberDescription":null, "productLine":null, "extraDatas":[ { "name":"partialShipping", "value":"N" }, { "name":"customerTransport", "value":"N" } ] }, { "createdBy":null, "lineId":"2", "sourceLineId":"20000", "orderNumber":"4360011118", "orderLineNumber":"20000", "shipFrom":{ "code":"542", "codeType":null, "name":"BSR-FRESH", "inventoryOrgCode":null, "inventoryOrgName":null, "inventoryOrgType":null, "organizationCode":null, "organizationName":null, "locationCode":null, "locationName":null, "logisticSiteCode":null, "logisticSiteName":null, "contactName":null, "subInventory":"BSR-FRESH", "gssSite":null, "address":{ "address1":"Calle 9 , 1430, Fatima, Pilar, Buenos Aires", "address2":" ", "address3":null, "city":"FATIMA", "zipCode":"1633", "state":null, "isoCountry2Code":"AR" }, "extraDatas":null }, "shipTo":{ "code":"35740", "codeType":null, "name":"DIESEL LANGE S.R.L", "inventoryOrgCode":null, "inventoryOrgName":null, "inventoryOrgType":null, "organizationCode":null, "organizationName":null, "locationCode":null, "locationName":null, "logisticSiteCode":null, "logisticSiteName":null, "contactName":null, "kindOfCustomer":null, "market":null, "gssSite":null, "subInventory":"BSR-FRES", "address":{ "address1":"Ruta Nacional A005 Km. 2,6 No 2.864", "address2":"", "address3":null, "city":"RIO CUARTO", "zipCode":"5800", "state":null, "isoCountry2Code":"AR" }, "extraDatas":null }, "billTo":{ "code":"35421", "codeType":null, "name":"DIESEL LANGE S.R.L", "address":null, "extraDatas":null }, "itemCode":"523568_101", "itemType":null, "itemDescription":"11.2 R25 114A8/111B TL POINT 8", "grossWeight":0, "weightUOM":null, "requestedQuantity":4, "requestedQuantityUOM":null, "logisticInstructions":" ", "scheduledShipDateTime":"2022-02-10T16:00:00Z", "scheduledShipByDateTime":"2022-02-09T16:00:00Z", "status":null, "priority":null, "carrierCode":null, "carrierName":null, "carrierService":"Standard", "shippingMethod":null, "transportMode":null, "customerPONumber":" ", "customerPOLineNumber":" ", "customerPartNumber":null, "customerPartNumberDescription":null, "productLine":null, "extraDatas":[ { "name":"partialShipping", "value":"N" }, { "name":"customerTransport", "value":"N" } ] } ] }, "timestamp":1723552384967 }, { "correlationId":"71700110-ffe4-4a99-b5e8-8e2cbaf6159e", "value":{ "creationDateTime":"2024-08-13T12:35:42.014Z", "sourceCreationDateTime":"2022-02-04T21:20:04Z", "source":"E015673", "createdBy":"lex-3pl-preparedata-frombsc", "correlationId":"71700110-ffe4-4a99-b5e8-8e2cbaf6159e", "sourceShipmentId":"WSTO-00017558", "shipmentId":"4360011118", "sourceEventType":"PICK_REQUEST", "extraDatas":null, "lines":[ { "createdBy":null, "lineId":"1", "sourceLineId":"10000", "orderNumber":"4360011118", "orderLineNumber":"10000", "shipFrom":{ "code":"540", "codeType":null, "name":"BSR-FRESH", "inventoryOrgCode":null, "inventoryOrgName":null, "inventoryOrgType":null, "organizationCode":null, "organizationName":null, "locationCode":null, "locationName":null, "logisticSiteCode":null, "logisticSiteName":null, "contactName":null, "subInventory":"BSR-FRESH", "gssSite":null, "address":{ "address1":"Calle 9 , 1430, Fatima, Pilar, Buenos Aires", "address2":" ", "address3":null, "city":"FATIMA", "zipCode":"1633", "state":null, "isoCountry2Code":"AR" }, "extraDatas":null }, "shipTo":{ "code":"35740", "codeType":null, "name":"DIESEL LANGE S.R.L", "inventoryOrgCode":null, "inventoryOrgName":null, "inventoryOrgType":null, "organizationCode":null, "organizationName":null, "locationCode":null, "locationName":null, "logisticSiteCode":null, "logisticSiteName":null, "contactName":null, "kindOfCustomer":null, "market":null, "gssSite":null, "subInventory":"BSR-FRES", "address":{ "address1":"Ruta Nacional A005 Km. 2,6 No 2.864", "address2":"", "address3":null, "city":"RIO CUARTO", "zipCode":"5800", "state":null, "isoCountry2Code":"AR" }, "extraDatas":null }, "billTo":{ "code":"35421", "codeType":null, "name":"DIESEL LANGE S.R.L", "address":null, "extraDatas":null }, "itemCode":"523567_101", "itemType":null, "itemDescription":"11.2 R24 114A8/111B TL POINT 8", "grossWeight":0, "weightUOM":null, "requestedQuantity":2, "requestedQuantityUOM":null, "logisticInstructions":" ", "scheduledShipDateTime":"2022-02-10T16:00:00Z", "scheduledShipByDateTime":"2022-02-09T16:00:00Z", "status":null, "priority":null, "carrierCode":null, "carrierName":null, "carrierService":"Standard", "shippingMethod":null, "transportMode":null, "customerPONumber":" ", "customerPOLineNumber":" ", "customerPartNumber":null, "customerPartNumberDescription":null, "productLine":null, "extraDatas":[ { "name":"partialShipping", "value":"N" }, { "name":"customerTransport", "value":"N" } ] }, { "createdBy":null, "lineId":"2", "sourceLineId":"20000", "orderNumber":"4360011118", "orderLineNumber":"20000", "shipFrom":{ "code":"542", "codeType":null, "name":"BSR-FRESH", "inventoryOrgCode":null, "inventoryOrgName":null, "inventoryOrgType":null, "organizationCode":null, "organizationName":null, "locationCode":null, "locationName":null, "logisticSiteCode":null, "logisticSiteName":null, "contactName":null, "subInventory":"BSR-FRESH", "gssSite":null, "address":{ "address1":"Calle 9 , 1430, Fatima, Pilar, Buenos Aires", "address2":" ", "address3":null, "city":"FATIMA", "zipCode":"1633", "state":null, "isoCountry2Code":"AR" }, "extraDatas":null }, "shipTo":{ "code":"35740", "codeType":null, "name":"DIESEL LANGE S.R.L", "inventoryOrgCode":null, "inventoryOrgName":null, "inventoryOrgType":null, "organizationCode":null, "organizationName":null, "locationCode":null, "locationName":null, "logisticSiteCode":null, "logisticSiteName":null, "contactName":null, "kindOfCustomer":null, "market":null, "gssSite":null, "subInventory":"BSR-FRES", "address":{ "address1":"Ruta Nacional A005 Km. 2,6 No 2.864", "address2":"", "address3":null, "city":"RIO CUARTO", "zipCode":"5800", "state":null, "isoCountry2Code":"AR" }, "extraDatas":null }, "billTo":{ "code":"35421", "codeType":null, "name":"DIESEL LANGE S.R.L", "address":null, "extraDatas":null }, "itemCode":"523568_101", "itemType":null, "itemDescription":"11.2 R25 114A8/111B TL POINT 8", "grossWeight":0, "weightUOM":null, "requestedQuantity":4, "requestedQuantityUOM":null, "logisticInstructions":" ", "scheduledShipDateTime":"2022-02-10T16:00:00Z", "scheduledShipByDateTime":"2022-02-09T16:00:00Z", "status":null, "priority":null, "carrierCode":null, "carrierName":null, "carrierService":"Standard", "shippingMethod":null, "transportMode":null, "customerPONumber":" ", "customerPOLineNumber":" ", "customerPartNumber":null, "customerPartNumberDescription":null, "productLine":null, "extraDatas":[ { "name":"partialShipping", "value":"N" }, { "name":"customerTransport", "value":"N" } ] } ] }, "timestamp":1723552542014 } ] } } } } } }, "204":{ "description":"Operation returns nothing to fetch" }, "401":{ "description":"Not authenticated", "content":{ "application/json":{ "examples":{ "Unauthorized":{ "description":"Unauthorized", "value":{ "timestamp":"{{ timestamp }}", "error":"Unauthorized", "status":401, "message":"Full authentication is required to access this resource", "path":"https://sandbox.api.michelin.com/mock-order-execution-outbound/v2/shipment" } } } } } }, "403":{ "description":"Operation is not authorized: no subscription", "content":{ "application/json":{ "examples":{ "Forbidden":{ "description":"No subscription for the resource requested", "value":{ "timestamp":"{{ timestamp }}", "error":"Forbidden", "status":403, "message":"No subscription found for partnerId and event type SHIPMENT", "path":"https://sandbox.api.michelin.com/mock-order-execution-outbound/v2/shipment" } } } } } }, "400":{ "description":"Bad parameters", "content":{ "application/json":{ "examples":{ "Bad request":{ "description":"Bad request: check the API usage", "value":{ "timestamp":"{{ timestamp }}", "status":400, "error":"Bad Request", "message":"{{ errorMessage }}", "path":"https://sandbox.api.michelin.com/mock-order-execution-outbound/v2/shipment" } } } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "examples":{ "Error":{ "description":"Internal server error", "value":{ "timestamp":"{{ timestamp }}", "error":"Internal server error", "status":500, "message":"", "path":"https://sandbox.api.michelin.com/mock-order-execution-outbound/v2/shipment" } } } } } } } } }, "-inbound/v2/return":{ "get":{ "tags":[ "GET Operations" ], "summary":"Get the return events after minTimestamp", "operationId":"getReturnFor3PL", "parameters":[ { "name":"fetchSize", "in":"query", "description":"Number of elements to return (max=100, default=50)", "required":false, "schema":{ "type":"integer", "format":"int32", "default":50 } }, { "name":"minTimestamp", "in":"query", "description":"The timestamp min of the events returnFor3PL (Accepted format is timestamp or ISO_OFFSET_DATE_TIME)", "required":true, "schema":{ "type":"string", "default":"0" }, "example":"2023-05-27T08:18:58+02:00" } ], "responses":{ "200":{ "description":"Operation returns the list of return events from oldest to newest", "schema":{ "$ref":"#/components/schemas/ResultSetDtoReturnFor3PLDto" }, "content":{ "application/json":{ "examples":{ "Get return results":{ "description":"Get return results", "value":{ "correlationId":"940fb691-4761-490f-b57f-ae580a619a0c", "latestTimestamp":1737384327838, "earliestTimestamp":1737384327838, "latestDateTime":"2025-01-20T14:45:27.838Z", "earliestDateTime":"2025-01-20T14:45:27.838Z", "fetchSize":1, "statusCode":"STOP_OK", "message":"Search query successful", "results":[ { "correlationId":"014b57bf-7114-4e34-8a3e-4478d5a1d5c5", "value":{ "creationDateTime":"2025-01-20T14:45:27.838Z", "sourceCreationDateTime":"2023-10-20T10:20:46Z", "source":"FOP", "correlationId":"014b57bf-7114-4e34-8a3e-4478d5a1d5c5", "createdBy":null, "returnId":"LEX00000000", "sourceReturnId":"542_OU-LEX00000000-MICH_RMA:36811", "sourceEventType":"RMABOOKED_REQUEST", "routingInstructions":"CLAIM2010", "lines":[ { "lineId":"1.1", "sourceLineId":"1.1", "customerPONumber":"", "customerPONumberLine":null, "sequenceNumber":1, "stockOwner":"IM", "collectFrom":{ "code":"92573", "codeType":"companyCode", "name":"Dongguan Guangtong Trading Company", "organizationCode":null, "organizationName":null, "locationCode":"0909090", "locationName":"Dongguan Guangtong Trading Company", "contactName":"Liu xinguo", "subInventory":"", "address":{ "address1":"Gate No. 6-10 E Building Zhong Shang Commercial Storage and Logistic distribution center ,Yanbu Guangfu Xingan Xian ( i.e. No. 28 Lian An Dong Tang Avenue ) Dali Town, Nanhai", "address2":"", "address3":"", "city":"", "zipCode":"012345", "state":"Ang Thong", "isoCountry2Code":"TH" }, "extraDatas":[ ] }, "shipTo":{ "code":"542", "codeType":"organizationCode", "name":"542_OU", "inventoryOrgCode":"815", "inventoryOrgName":"CW", "inventoryOrgType":"542_CN_815_CHQ_SH_CO", "organizationCode":null, "organizationName":null, "locationCode":"815", "locationName":"D72009145", "logisticSiteCode":"D72009145", "logisticSiteName":"SHY", "contactName":"", "kindOfCustomer":null, "market":null, "gssSite":"CHQ", "subInventory":null, "address":{ "address1":"", "address2":"", "address3":"", "city":"", "zipCode":"", "state":"", "isoCountry2Code":"CN" }, "extraDatas":[ ] }, "itemCode":"215487_105", "itemType":"CAD", "itemDescription":"235/50R17 96V TL PRIMACY3ST GRNX MI", "grossWeight":11.68, "netWeight":0, "weightUOM":"KG", "transportMode":"TRUCK", "carrierCode":"SINOSH", "carrierName":"SINOSH", "carrierService":"Standard", "requestedQuantity":1, "quantityUOM":"EA", "shippingInstructions":"" } ], "extraDatas":[ { "name":"rmaAutoReceipt", "value":"N" } ] }, "timestamp":1737384327838 } ] } } } } } }, "204":{ "description":"Operation returns nothing to fetch" }, "401":{ "description":"Not authenticated", "content":{ "application/json":{ "examples":{ "Unauthorized":{ "description":"Unauthorized", "value":{ "error":"Unauthorized", "timestamp":"{{ timestamp }}", "message":"Full authentication is required to access this resource", "status":401, "path":"https://sandbox.api.michelin.com/mock-order-execution-inbound/v2/return" } } } } } }, "403":{ "description":"Operation is not authorized: no subscription", "content":{ "application/json":{ "examples":{ "Forbidden":{ "description":"No subscription for the resource requested", "value":{ "timestamp":"{{ timestamp }}", "error":"Forbidden", "status":403, "message":"No subscription found for partnerId and event type RETURN", "path":"https://sandbox.api.michelin.com/mock-order-execution-inbound/v2/return" } } } } } }, "400":{ "description":"Bad parameters", "content":{ "application/json":{ "examples":{ "Bad request":{ "description":"Bad request: check the API usage", "value":{ "timestamp":"{{ timestamp }}", "status":400, "error":"Bad Request", "message":"{{ errorMessage }}", "path":"https://sandbox.api.michelin.com/mock-order-execution-inbound/v2/return" } } } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "examples":{ "Error":{ "description":"Internal server error", "value":{ "timestamp":"{{ timestamp }}", "error":"Internal server error", "status":500, "message":"", "path":"https://sandbox.api.michelin.com/mock-order-execution-inbound/v2/return" } } } } } } } } }, "-inbound/v2/receiving":{ "get":{ "tags":[ "GET Operations" ], "summary":"Get the receiving events after minTimestamp", "operationId":"getReceivingFor3PL", "parameters":[ { "name":"fetchSize", "in":"query", "description":"Number of elements to return (max=100, default=50)", "required":false, "schema":{ "type":"integer", "format":"int32", "default":50 } }, { "name":"minTimestamp", "in":"query", "description":"The timestamp min of the events receiving (Accepted format is timestamp or ISO_OFFSET_DATE_TIME)", "required":true, "schema":{ "type":"string", "default":"0" }, "example":"2023-05-27T08:18:58+02:00" } ], "responses":{ "200":{ "description":"Operation returns the list of receiving from oldest to newest", "schema":{ "$ref":"#/components/schemas/ResultSetDtoReceivingFor3PLDto" }, "content":{ "application/json":{ "examples":{ "Get receiving results":{ "description":"Get receiving results", "value":{ "correlationId":"8738cd26-88fa-45d1-b3f8-1f8c1c329f0b", "latestTimestamp":1721382204000, "earliestTimestamp":1721382204000, "latestDateTime":"2024-07-19T09:43:24Z", "earliestDateTime":"2024-07-19T09:43:24Z", "fetchSize":1, "statusCode":"STOP_OK", "message":"Search query successful", "results":[ { "correlationId":"83191b7c-1c4f-4e3c-b7b0-e30f9b39615c", "value":{ "creationDateTime":"2024-07-19T09:43:24Z", "sourceCreationDateTime":"2022-01-31T12:03:08Z", "createdBy":"lex-3pl-preparedata-frombsc", "source":"DEV-TECH-TESTS-PRIV", "correlationId":"733b55b2-afb4-47de-88d8-d5b778b192de", "receivingId":"WR-00001071", "sourceReceivingId":"3825407", "sourceEventType":"IMPORT", "portOfLoadingName":null, "portOfLoadingCode":null, "containerId":"JAP3B73", "sealId":"17005", "equipmentType":null, "transportMode":null, "shipDateTime":null, "scheduledArrivalDateTime":null, "scheduledDeliveryDateTime":null, "totalGrossWeight":0, "totalWeightUOM":null, "totalVolume":0, "totalVolumeUOM":null, "shippingInstructions":null, "routingInstructions":null, "incoterms":null, "portOfDischargeName":null, "portOfDischargeCode":null, "maritimeAirCompanyName":null, "maritimeAirCompanyCode":null, "maritimeAirCompanyNumber":null, "maritimeAirCompanyCountryCode":null, "scheduledMaritimeAirDepartureDateTime":null, "customerName":null, "customerCode":null, "consignmentNoteNumber":null, "status":null, "carrierCode":null, "carrierName":null, "carrierService":null, "freightCode":null, "shipFrom":{ "code":null, "codeType":null, "name":"SOC.MICHELIN DE PART.IND.E COM.LTDA.-414", "inventoryOrgCode":null, "inventoryOrgName":null, "inventoryOrgType":null, "organizationCode":null, "organizationName":null, "locationCode":null, "locationName":null, "logisticSiteCode":null, "logisticSiteName":null, "contactName":null, "subInventory":"BSR-FRESH", "gssSite":null, "address":{ "address1":null, "address2":null, "address3":null, "city":"Rio de Janeiro", "zipCode":null, "state":null, "isoCountry2Code":"BR" }, "extraDatas":null }, "shipTo":{ "code":"BSR", "codeType":null, "name":null, "inventoryOrgCode":null, "inventoryOrgName":null, "inventoryOrgType":null, "organizationCode":null, "organizationName":null, "locationCode":null, "locationName":null, "logisticSiteCode":null, "logisticSiteName":null, "contactName":null, "kindOfCustomer":null, "market":null, "gssSite":null, "subInventory":"FRESH", "address":null, "extraDatas":null }, "lines":[ { "lineId":"1", "sourceLineId":"10000", "itemCode":"523567_101", "itemType":null, "itemDescription":"11.2 R24 114A8/111B TL POINT 8", "customerPartNumber":null, "customerPartNumberDescription":null, "marketCode":null, "freightCode":null, "classificationCode":null, "dot":null, "zpCode":null, "factoryStockOwner":null, "stockOwner":null, "palletNumber":null, "quantity":2, "quantityUOM":"EA", "netWeight":0, "grossWeight":0, "weightUOM":null, "customerPONumber":"BRAR01875_21", "customerPOLineNumber":"21000", "customerPOPaymentTerm":null, "orderNumber":null, "deliveryId":null, "deliveryLineId":null, "equipmentType":null, "sourceDeliveryId":null, "sourceDeliveryLineId":null, "containerId":null, "scheduledShipDateTime":null, "productionCountryCode":"BR", "productionCountryName":null, "subInventory":"FRESH", "shipFrom":null, "extraDatas":null } ], "extraDatas":null, "occode":null, "odcode":null, "orcode":null }, "timestamp":1721382204000 } ] } } } } } }, "204":{ "description":"Operation returns nothing to fetch" }, "401":{ "description":"Not authenticated", "content":{ "application/json":{ "examples":{ "Unauthorized":{ "description":"Unauthorized", "value":{ "error":"Unauthorized", "timestamp":"{{ timestamp }}", "message":"Full authentication is required to access this resource", "status":401, "path":"https://sandbox.api.michelin.com/mock-order-execution-inbound/v2/receiving" } } } } } }, "403":{ "description":"Operation is not authorized: no subscription", "content":{ "application/json":{ "examples":{ "Forbidden":{ "description":"No subscription for the resource requested", "value":{ "timestamp":"{{ timestamp }}", "error":"Forbidden", "status":403, "message":"No subscription found for partnerId and event type RECEIVING", "path":"https://sandbox.api.michelin.com/mock-order-execution-inbound/v2/receiving" } } } } } }, "400":{ "description":"Bad parameters", "content":{ "application/json":{ "examples":{ "Bad request":{ "description":"Bad request: check the API usage", "value":{ "timestamp":"{{ timestamp }}", "status":400, "error":"Bad Request", "message":"{{ errorMessage }}", "path":"https://sandbox.api.michelin.com/mock-order-execution-inbound/v2/receiving" } } } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "examples":{ "Error":{ "description":"Internal server error", "value":{ "timestamp":"{{ timestamp }}", "error":"Internal server error", "status":500, "message":"", "path":"https://sandbox.api.michelin.com/mock-order-execution-inbound/v2/receiving" } } } } } } } } }, "-referential/v1/item":{ "get":{ "tags":[ "GET Operations" ], "summary":"Get the item events after minTimestamp", "operationId":"getItemFor3PL", "parameters":[ { "name":"fetchSize", "in":"query", "description":"Number of elements to return (max=100, default=50)", "required":false, "schema":{ "type":"integer", "format":"int32", "default":50 } }, { "name":"minTimestamp", "in":"query", "description":"The min timestamp of the events item (Accepted format is timestamp or ISO_OFFSET_DATE_TIME)", "required":true, "schema":{ "type":"string", "default":"0" }, "example":"2023-05-27T08:18:58+02:00" } ], "responses":{ "200":{ "description":"Operation returns the list of item from oldest to newest", "content":{ "application/json":{ "examples":{ "Get item results":{ "description":"Get item results", "value":{ "correlationId":"489abde2-fd30-4c8e-85ab-366008243b68", "latestTimestamp":1737384327838, "earliestTimestamp":1737384327838, "latestDateTime":"2025-01-20T14:45:27.838Z", "earliestDateTime":"2025-01-20T14:45:27.838Z", "fetchSize":1, "statusCode":"STOP_OK", "message":"Search query successful", "results":[ { "correlationId":"489abde2-fd30-4c8e-85ab-366008243b68", "value":{ "correlationId":"489abde2-fd30-4c8e-85ab-366008243b68", "creationDateTime":"2025-01-20T14:45:27.838Z", "sourceCreationDateTime":"2024-11-28T06:33:52Z", "source":"BSCAUS", "target":"CEVAAUS", "itemCode":"099207_102", "itemType":"CUSTOM", "itemDescription":"295/35 R21 107Y XL TL PILOT SPORT 4 SUV FRV MI", "eanCode":"3528709902072", "serialized":true, "grossWeight":15.32, "netWeight":15.32, "weightUOM":"KG", "volumeUOM":"M3", "width":295.0, "dimensionUOM":"MM" }, "timestamp":1737384327838 } ] } } } } } }, "204":{ "description":"Operation returns nothing to fetch" }, "401":{ "description":"Not authenticated", "content":{ "application/json":{ "examples":{ "Unauthorized":{ "description":"Unauthorized", "value":{ "error":"Unauthorized", "timestamp":"{{ timestamp }}", "message":"Full authentication is required to access this resource", "status":401, "path":"https://sandbox.api.michelin.com/mock-order-execution-referential/v1/item" } } } } } }, "403":{ "description":"Operation is not authorized: no subscription", "content":{ "application/json":{ "examples":{ "Forbidden":{ "description":"No subscription for the resource requested", "value":{ "timestamp":"{{ timestamp }}", "error":"Forbidden", "status":403, "message":"No subscription found for partnerId and event type ITEM", "path":"https://sandbox.api.michelin.com/mock-order-execution-referential/v1/item" } } } } } }, "400":{ "description":"Bad parameters", "content":{ "application/json":{ "examples":{ "Bad request":{ "description":"Bad request: check the API usage", "value":{ "timestamp":"{{ timestamp }}", "status":400, "error":"Bad Request", "message":"{{ errorMessage }}", "path":"https://sandbox.api.michelin.com/mock-order-execution-referential/v1/item" } } } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "examples":{ "Error":{ "description":"Internal server error", "value":{ "timestamp":"{{ timestamp }}", "error":"Internal server error", "status":500, "message":"", "path":"https://sandbox.api.michelin.com/mock-order-execution-referential/v1/item" } } } } } } } } } }, "components":{ "schemas":{ "AddressDto":{ "type":"object", "properties":{ "address1":{ "type":"string", "description":"Address Line1 of the address" }, "address2":{ "type":"string", "description":"Address Line2 of the address" }, "address3":{ "type":"string", "description":"Address Line3 of the address" }, "city":{ "type":"string", "description":"City of the address" }, "zipCode":{ "type":"string", "description":"zipCode of the address" }, "state":{ "type":"string", "description":"Sate of the address" }, "isoCountry2Code":{ "type":"string", "description":"iso2 country code of the address", "maxLength":2, "minLength":2 } }, "required":[ "address1", "city", "isoCountry2Code", "zipCode" ] }, "ExtraDataDto":{ "type":"object", "description":"Custom data in the format of name/value pair", "properties":{ "name":{ "type":"string", "description":"Name of the extra Data Field" }, "value":{ "type":"string", "description":"Value of the extra Data Field" } }, "required":[ "name", "value" ] }, "ShipFromDto":{ "type":"object", "description":"ShipFrom object", "properties":{ "code":{ "type":"string", "description":"ShipFrom Code as known in Michelin system" }, "codeType":{ "type":"string", "description":"Type of the ShipFrom Code as known in Michelin system (to identify the type of the code : MDMDID, InvOrg, LogisticPoint, ...)" }, "name":{ "type":"string", "description":"Free Text for ShipFrom Name" }, "inventoryOrgCode":{ "type":"string", "description":"ShipFrom InventoryOrganization Code" }, "inventoryOrgName":{ "type":"string", "description":"ShipFrom InventoryOrganization Name" }, "inventoryOrgType":{ "type":"string", "description":"ShipFrom InventoryOrganization Type" }, "organizationCode":{ "type":"string", "description":"ShipFrom Organization Code" }, "organizationName":{ "type":"string", "description":"ShipFrom Organization Name" }, "locationCode":{ "type":"string", "description":"ShipFrom Location Code" }, "locationName":{ "type":"string", "description":"ShipFrom Location Name" }, "logisticSiteCode":{ "type":"string", "description":"ShipFrom Logistic Site Code" }, "logisticSiteName":{ "type":"string", "description":"ShipFrom Logistic Site Name" }, "contactName":{ "type":"string", "description":"ShipFrom Contact Name" }, "subInventory":{ "type":"string", "description":"ShipFrom Sub Inventory" }, "gssSite":{ "type":"string", "description":"GSS Site Code" }, "address":{ "$ref":"#/components/schemas/AddressDto", "description":"ShipFrom address" }, "extraDatas":{ "type":"array", "description":"Freee Extras data", "items":{ "$ref":"#/components/schemas/ExtraDataDto" } } } }, "ShippedFrom3PLDto":{ "type":"object", "description":"Shipped object", "properties":{ "creationDateTime":{ "type":"string", "format":"date-time", "description":"Creation Date Time of the event in LEX" }, "eventType":{ "type":"string", "description":"Type of the event (ex: SHIPMENT_CONFIRMATION)" }, "shipmentId":{ "type":"string", "description":"Functional ID of the shipped" }, "sourceShipmentId":{ "type":"string", "description":"Functional ID of the shipment in the host system" }, "shipmentTrackingId":{ "type":"string", "description":"Tracking reference in 3PL system" }, "shipmentTrackingUrl":{ "type":"string", "description":"Tracking URL in 3PL system" }, "scacCode":{ "type":"string", "description":"Scac carier code" }, "carrierCode":{ "type":"string", "description":"Carrier code" }, "carrierName":{ "type":"string", "description":"Carrier name" }, "carrierService":{ "type":"string", "description":"Carrier service" }, "shippedDateTime":{ "type":"string", "format":"date-time", "description":"Date when the goods actually leave the warehouse (ISO 8601 date format)" }, "requestedShippedDateTime":{ "type":"string", "format":"date-time", "description":"Date when the goods should leave the warehouse (ISO 8601 date format)" }, "placeOfLoading":{ "type":"string", "description":"Port of loading (expected UNLocode)" }, "placeOfDischarge":{ "type":"string", "description":"Place of discharge (expected UNLocode)" }, "transportUnitId":{ "type":"string", "description":"Transport unit Reference ID (ex: container id)" }, "shipFrom":{ "$ref":"#/components/schemas/ShipFromDto", "description":"The ship from object" }, "lines":{ "type":"array", "description":"The shipped lines", "items":{ "$ref":"#/components/schemas/ShippedFrom3PLLineDto" } }, "extraDatas":{ "type":"array", "description":"Array of Couple Name/Value to let share extra datas not planned in the standard Model", "items":{ "$ref":"#/components/schemas/ExtraDataDto" } } }, "required":[ "shipmentId" ] }, "ShippedFrom3PLLineDto":{ "type":"object", "properties":{ "lineId":{ "type":"string", "description":"Line counter this is a key value with order" }, "sourceLineId":{ "type":"string", "description":"Line id from the host system" }, "itemCode":{ "type":"string", "description":"Code of the item to identify the required product (preferred CAD)" }, "itemType":{ "type":"string", "description":"ItemType to identify the required product" }, "itemDescription":{ "type":"string", "description":"Item Description" }, "subInventory":{ "type":"string", "description":"Free Text to identify the SubInventory" }, "productionCountryCode":{ "type":"string", "description":"ISO Code of the country of production" }, "dot":{ "type":"string", "description":"Dot value (week+year)" }, "customerPONumber":{ "type":"string", "description":"PurchaseOrder Number of the Customer" }, "customerPONumberLine":{ "type":"string", "description":"PurchaseOrder Line number of the Customer" }, "customerPartNumber":{ "type":"string", "description":"customerPartNumber as identified on the client side" }, "customerPartNumberDescription":{ "type":"string", "description":"customerPartNumber Description as identified on the client side" }, "requestedQuantity":{ "type":"integer", "format":"int32", "description":"Quantity requested" }, "shippedQuantity":{ "type":"integer", "format":"int32", "description":"Quantity shipped" }, "notShippedQuantity":{ "type":"integer", "format":"int32", "description":"Quantity not shipped" }, "quantityUOM":{ "type":"string", "description":"Quantity Unit Of Measure" }, "serialNumberList":{ "type":"array", "description":"Serial number of the items", "items":{ "type":"string" } }, "deliveryNoteNumber":{ "type":"string", "description":"Delivery note number reference from carrier (BL)" }, "extraDatas":{ "type":"array", "description":"Array of Couple Name/Value to let share extra datas not planned in the standard Model", "items":{ "$ref":"#/components/schemas/ExtraDataDto" } } }, "required":[ "itemCode" ] }, "ReceivedFrom3PLDto":{ "type":"object", "description":"Received object", "properties":{ "creationDateTime":{ "type":"string", "format":"date-time", "description":"Creation Date Time of the event in LEX" }, "receivingId":{ "type":"string", "description":"ID of the receiving (Should be the one given in the receiving event)" }, "eventType":{ "type":"string", "description":"Type of the event (ex: RECEIVED_CONFIRMATION)" }, "status":{ "type":"string", "description":"Free Text for the status of the Received" }, "receptionDateTime":{ "type":"string", "format":"date-time", "description":"Actual received date in UTC (ISO 8601 format)" }, "lines":{ "type":"array", "description":"The lines of the received", "items":{ "$ref":"#/components/schemas/ReceivedFrom3PLLineDto" } }, "extraDatas":{ "type":"array", "description":"Array of Couple Name/Value to let share extra datas not planned in the standard Model", "items":{ "$ref":"#/components/schemas/ExtraDataDto" } }, "sourceReceivingId":{ "type":"string", "description":"ID of the receiving in the 3PL solution" } }, "required":[ "receivingId" ] }, "ReceivedFrom3PLLineDto":{ "type":"object", "properties":{ "lineId":{ "type":"string", "description":"Line counter this is a key value with order" }, "sourceLineId":{ "type":"string", "description":"Line id from the host system" }, "itemCode":{ "type":"string", "description":"Code of the item to identify the required product (preferred CAD)" }, "itemDescription":{ "type":"string", "description":"Description of the item" }, "subInventory":{ "type":"string", "description":"Michelin sub inventory" }, "expectedQuantity":{ "type":"integer", "format":"int32", "description":"Expected Quantity from the receiving instruction" }, "receivedQuantity":{ "type":"integer", "format":"int32", "description":"Quantity really received in stock" }, "quantityUOM":{ "type":"string", "description":"Unit Of Measure" }, "serialNumberList":{ "type":"array", "description":"Serial number of the items", "items":{ "type":"string" } }, "extraDatas":{ "type":"array", "description":"Array of Couple Name/Value to let share extra datas not planned in the standard Model", "items":{ "$ref":"#/components/schemas/ExtraDataDto" } } }, "required":[ "itemCode" ] }, "BillToDto":{ "type":"object", "description":"BillTo object", "properties":{ "code":{ "type":"string", "description":"BillTo Code as known in Michelin system" }, "codeType":{ "type":"string", "description":"Type of the BillTo Code as known in Michelin system (to identify the type of the code : MDMDID, InvOrg, LogisticPoint, ...)" }, "name":{ "type":"string", "description":"Free Text for BillTo Name" }, "address":{ "$ref":"#/components/schemas/AddressDto", "description":"ShipFrom address" }, "extraDatas":{ "type":"array", "description":"Free Extras data", "items":{ "$ref":"#/components/schemas/ExtraDataDto" } } } }, "ResultDtoShipmentFor3PLDto":{ "type":"object", "properties":{ "correlationId":{ "type":"string", "description":"the correlation id of the message" }, "value":{ "$ref":"#/components/schemas/ShipmentFor3PLDto", "description":"the message" }, "timestamp":{ "type":"integer", "format":"int64" } } }, "ResultSetDtoShipmentFor3PLDto":{ "type":"object", "description":"The result returned by the GET API", "properties":{ "correlationId":{ "type":"string", "description":"The correlation id of the transaction GET" }, "latestTimestamp":{ "type":"integer", "format":"int64", "description":"The timestamp of the latest record returned in the result set" }, "earliestTimestamp":{ "type":"integer", "format":"int64", "description":"The timestamp of the earliest record returned in the result set" }, "latestDateTime":{ "type":"string", "format":"date-time", "description":"The ISO DateTime of the latest record returned in the result set" }, "earliestDateTime":{ "type":"string", "format":"date-time", "description":"The ISO DateTime of the latest record returned in the result set" }, "fetchSize":{ "type":"integer", "format":"int32", "description":"The number of result returned" }, "statusCode":{ "type":"string", "description":"The status code of the GET request with possible values: STOP_OK(=HTTP 200) \nSTOP_NO_CONTENT (=HTTP 204), UNAUTHORIZED (=HTTP 401), FORBIDDEN (=HTTP 403)", "enum":[ "START", "STOP_OK", "STOP_CREATED", "STOP_ACCEPTED", "STOP_NO_CONTENT", "STOP_PARTIAL", "STOP_IGNORE", "STOP_BAD_REQUEST", "STOP_NOT_FOUND", "STOP_FUNCTIONAL_ERROR", "STOP_TECHNICAL_ERROR" ] }, "message":{ "type":"string", "description":"The message result of the GET request" }, "results":{ "type":"array", "description":"The list of the results fetched", "items":{ "$ref":"#/components/schemas/ResultDtoShipmentFor3PLDto" } }, "earliestOrLatestTimestamp":{ "type":"integer", "format":"int64", "writeOnly":true } } }, "ShipToDto":{ "type":"object", "description":"ShipTo object", "properties":{ "code":{ "type":"string", "description":"ShipTo Code as known in Michelin system" }, "codeType":{ "type":"string", "description":"Type of the ShipTo Code as known in Michelin system (to identify the type of the code : MDMDID, InvOrg, LogisticPoint, ...)" }, "name":{ "type":"string", "description":"Free Text for ShipTo Name" }, "inventoryOrgCode":{ "type":"string", "description":"ShipTo InventoryOrganization Code" }, "inventoryOrgName":{ "type":"string", "description":"ShipTo InventoryOrganization Name" }, "inventoryOrgType":{ "type":"string", "description":"ShipTo InventoryOrganization Type" }, "organizationCode":{ "type":"string", "description":"ShipTo Organization Code" }, "organizationName":{ "type":"string", "description":"ShipTo Organization Name" }, "locationCode":{ "type":"string", "description":"ShipTo Location Code" }, "locationName":{ "type":"string", "description":"ShipTo Location Name" }, "logisticSiteCode":{ "type":"string", "description":"ShipTo Logistic Site Code" }, "logisticSiteName":{ "type":"string", "description":"ShipTo Logistic Site Name" }, "contactName":{ "type":"string", "description":"ShipTo Contact Name" }, "kindOfCustomer":{ "type":"string", "description":"ShipTo Kind of Customer" }, "market":{ "type":"string", "description":"Market of the ShipTo" }, "gssSite":{ "type":"string", "description":"GSS Site Code" }, "subInventory":{ "type":"string", "description":"ShipTo Sub Inventory" }, "address":{ "$ref":"#/components/schemas/AddressDto", "description":"ShipTo address" }, "extraDatas":{ "type":"array", "description":"Freee Extras data", "items":{ "$ref":"#/components/schemas/ExtraDataDto" } } } }, "ShipmentFor3PLDto":{ "type":"object", "description":"Shipment object", "properties":{ "creationDateTime":{ "type":"string", "format":"date-time", "description":"Creation Date Time of the event in LEX" }, "sourceCreationDateTime":{ "type":"string", "format":"date-time", "description":"Creation Date Time of the event (in the source System)" }, "source":{ "type":"string", "description":"Source Application of the Data" }, "target":{ "type":"string", "description":"Target Application of the Data" }, "createdBy":{ "type":"string", "description":"Message created By" }, "correlationId":{ "type":"string", "description":"Unique ID of the message (UUID)" }, "sourceShipmentId":{ "type":"string", "description":"ID of the shipment in the source solution (in case of mapping needed)" }, "shipmentId":{ "type":"string", "description":"ID of the shipment as known in Michelin system" }, "eventType":{ "type":"string", "description":"Type of the event (ex: PICK_REQUEST_DELIVERY" }, "sourceEventType":{ "type":"string", "description":"Event Type of the source Event (ex: PICK_REQUEST)" }, "extraDatas":{ "type":"array", "description":"Array of Couple Name/Value to let share extra data not planned in the standard Model", "items":{ "$ref":"#/components/schemas/ExtraDataDto" } }, "lines":{ "type":"array", "description":"the lines of shipment", "items":{ "$ref":"#/components/schemas/ShipmentLineDto" } } } }, "ShipmentLineDto":{ "type":"object", "properties":{ "createdBy":{ "type":"string", "description":"Message created By" }, "lineId":{ "type":"string", "description":"Line counter this is a key value with order of the line" }, "sourceLineId":{ "type":"string", "description":"Line id (in the source application)" }, "orderNumber":{ "type":"string", "description":"Order Number in the Michelin System" }, "orderLineNumber":{ "type":"string", "description":"Order Line Number in the Michelin System" }, "shipFrom":{ "$ref":"#/components/schemas/ShipFromDto", "description":"origin location of the shipment" }, "shipTo":{ "$ref":"#/components/schemas/ShipToDto", "description":"destination location of the shipment" }, "billTo":{ "$ref":"#/components/schemas/BillToDto", "description":"BillTo at delivery level" }, "itemCode":{ "type":"string", "description":"ItemCode to identify the required product" }, "itemType":{ "type":"string", "description":"ItemType to identify the required product" }, "itemDescription":{ "type":"string", "description":"Item Description" }, "grossWeight":{ "type":"number", "format":"double", "description":"Gross Weight of the product" }, "weightUOM":{ "type":"string", "description":"Free Text to manage Unit Of Measure" }, "requestedQuantity":{ "type":"number", "format":"double", "description":"Quantity in the shipping" }, "requestedQuantityUOM":{ "type":"string", "description":"Unit of Measure of the Requested Quantity" }, "logisticInstructions":{ "type":"string", "description":"FreeText for Logistic Instructions at PickExceptionLineDto Level" }, "scheduledShipDateTime":{ "type":"string", "format":"date-time", "description":"Date when the goods should leave the warehouse (Format : YYYY-MM-DDThh:mm:ssZ)" }, "scheduledShipByDateTime":{ "type":"string", "format":"date-time", "description":"ShipDate Requested by the client (Format : YYYY-MM-DDThh:mm:ssZ)" }, "status":{ "type":"string", "description":"Status of the shipping" }, "priority":{ "type":"string", "description":"Priority of the shipping" }, "carrierCode":{ "type":"string", "description":"Code of the carrier" }, "carrierName":{ "type":"string", "description":"Name of the carrier" }, "carrierService":{ "type":"string", "description":"Service of the carrier" }, "shippingMethod":{ "type":"string", "description":"Method used for the shipping" }, "transportMode":{ "type":"string", "description":"Mode used for the transport" }, "customerPONumber":{ "type":"string", "description":"PurchaseOrder Number of the Customer" }, "customerPOLineNumber":{ "type":"string", "description":"PurchaseOrder Line Number of the Customer" }, "customerPartNumber":{ "type":"string", "description":"customerPartNumber as identified on the client side" }, "customerPartNumberDescription":{ "type":"string", "description":"customerPartNumber Description as identified on the client side" }, "productLine":{ "type":"string", "description":"Product line of the item" }, "extraDatas":{ "type":"array", "description":"Free extra data", "items":{ "$ref":"#/components/schemas/ExtraDataDto" } } } }, "CollectFromDto":{ "type":"object", "properties":{ "code":{ "type":"string", "description":"CollectFrom Code as known in Michelin system" }, "codeType":{ "type":"string", "description":"Type of the CollectFrom Code as known in Michelin system (to identify the type of the code : MDMDID, InvOrg, LogisticPoint, ...)" }, "name":{ "type":"string", "description":"Free Text for CollectFrom Name" }, "organizationCode":{ "type":"string", "description":"CollectFrom Organization Code" }, "organizationName":{ "type":"string", "description":"CollectFrom Organization Name" }, "locationCode":{ "type":"string", "description":"CollectFrom Location Code" }, "locationName":{ "type":"string", "description":"CollectFrom Location Name" }, "contactName":{ "type":"string", "description":"CollectFrom Contact Name" }, "subInventory":{ "type":"string", "description":"CollectFrom Sub Inventory" }, "address":{ "$ref":"#/components/schemas/AddressDto", "description":"Address of the location of the collect" }, "extraDatas":{ "type":"array", "description":"Array of Couple Name/Value to let share extra datas not planned in the standard Model", "items":{ "$ref":"#/components/schemas/ExtraDataDto" } } } }, "ResultDtoReturnFor3PLDto":{ "type":"object", "properties":{ "correlationId":{ "type":"string", "description":"the correlation id of the message" }, "value":{ "$ref":"#/components/schemas/ReturnFor3PLDto", "description":"the message" }, "timestamp":{ "type":"integer", "format":"int64" } } }, "ResultSetDtoReturnFor3PLDto":{ "type":"object", "description":"The result returned by the GET API", "properties":{ "correlationId":{ "type":"string", "description":"The correlation id of the transaction GET" }, "latestTimestamp":{ "type":"integer", "format":"int64", "description":"The timestamp of the latest record returned in the result set" }, "earliestTimestamp":{ "type":"integer", "format":"int64", "description":"The timestamp of the earliest record returned in the result set" }, "latestDateTime":{ "type":"string", "format":"date-time", "description":"The ISO DateTime of the latest record returned in the result set" }, "earliestDateTime":{ "type":"string", "format":"date-time", "description":"The ISO DateTime of the latest record returned in the result set" }, "fetchSize":{ "type":"integer", "format":"int32", "description":"The number of result returned" }, "statusCode":{ "type":"string", "description":"The status code of the GET request with possible values: STOP_OK(=HTTP 200) \nSTOP_NO_CONTENT (=HTTP 204), UNAUTHORIZED (=HTTP 401), FORBIDDEN (=HTTP 403)", "enum":[ "START", "STOP_OK", "STOP_CREATED", "STOP_ACCEPTED", "STOP_NO_CONTENT", "STOP_PARTIAL", "STOP_IGNORE", "STOP_BAD_REQUEST", "STOP_NOT_FOUND", "STOP_FUNCTIONAL_ERROR", "STOP_TECHNICAL_ERROR" ] }, "message":{ "type":"string", "description":"The message result of the GET request" }, "results":{ "type":"array", "description":"The list of the results fetched", "items":{ "$ref":"#/components/schemas/ResultDtoReturnFor3PLDto" } }, "earliestOrLatestTimestamp":{ "type":"integer", "format":"int64", "writeOnly":true } } }, "ReturnFor3PLDto":{ "type":"object", "description":"Return object", "properties":{ "creationDateTime":{ "type":"string", "format":"date-time", "description":"Creation Date Time of the event in LEX" }, "sourceCreationDateTime":{ "type":"string", "format":"date-time", "description":"Creation Date Time of the event (in the source System)" }, "source":{ "type":"string", "description":"Source Application of the Data" }, "target":{ "type":"string", "description":"Target Application of the Data" }, "correlationId":{ "type":"string", "description":"Unique ID of the message (UUID)" }, "createdBy":{ "type":"string", "description":"Message created By" }, "returnId":{ "type":"string", "description":"ID of the return (Should be unique for the source)" }, "sourceReturnId":{ "type":"string", "description":"ID of the return request in the source solution (in case of mapping needed)" }, "eventType":{ "type":"string", "description":"Type of the event" }, "sourceEventType":{ "type":"string", "description":"Event Type of the source Event (ex: RMABOOKED_REQUEST)" }, "routingInstructions":{ "type":"string", "description":"FreeText for Routing Instructions at Header Level" }, "lines":{ "type":"array", "description":"List of return order", "items":{ "$ref":"#/components/schemas/ReturnLineDto" } }, "extraDatas":{ "type":"array", "description":"Free extra datas", "items":{ "$ref":"#/components/schemas/ExtraDataDto" } } } }, "ReturnLineDto":{ "type":"object", "properties":{ "lineId":{ "type":"string", "description":"Line counter this is a key value with order of the line" }, "sourceLineId":{ "type":"string", "description":"Line id from the host system" }, "customerPONumber":{ "type":"string", "description":"PurchaseOrder Number of the Customer" }, "customerPONumberLine":{ "type":"string", "description":"PurchaseOrder Number Line of the Customer" }, "sequenceNumber":{ "type":"number", "format":"double", "description":"Collect order sequence" }, "stockOwner":{ "type":"string", "description":"FreeText for stockOwner" }, "collectFrom":{ "$ref":"#/components/schemas/CollectFromDto", "description":"Origin location of the return order" }, "shipTo":{ "$ref":"#/components/schemas/ShipToDto", "description":"Destination location of the return order" }, "itemCode":{ "type":"string", "description":"ItemCode to identify the required product" }, "itemType":{ "type":"string", "description":"ItemType to identify the required product" }, "itemDescription":{ "type":"string", "description":"Item Description" }, "grossWeight":{ "type":"number", "format":"double", "description":"Gross Weight of the product" }, "netWeight":{ "type":"number", "format":"double", "description":"Net Weight of the product" }, "weightUOM":{ "type":"string", "description":"Free Text to manage Unit Of Measure" }, "transportMode":{ "type":"string", "description":"Mode used for the transport" }, "carrierCode":{ "type":"string", "description":"Code of the carrier" }, "carrierName":{ "type":"string", "description":"Name of the carrier" }, "carrierService":{ "type":"string", "description":"Service of the carrier" }, "requestedQuantity":{ "type":"number", "format":"double", "description":"Quantity in the shipping" }, "quantityUOM":{ "type":"string", "description":"Unit of Measure of the Requested Quantity" }, "shippingInstructions":{ "type":"string", "description":"The FreeText for Shipping Instructions at PickExceptionLineDto Level" } }, "required":[ "sourceLineId" ] }, "ReceivingFor3PLDto":{ "type":"object", "description":"Receiving object", "properties":{ "creationDateTime":{ "type":"string", "format":"date-time", "description":"Creation Date Time of the event in LEX" }, "sourceCreationDateTime":{ "type":"string", "format":"date-time", "description":"Creation Date Time of the event (in the source System)" }, "createdBy":{ "type":"string", "description":"Message created By" }, "source":{ "type":"string", "description":"Source Application of the Data" }, "target":{ "type":"string", "description":"Target Application of the Data" }, "correlationId":{ "type":"string", "description":"Unique ID of the message (UUID)" }, "receivingId":{ "type":"string", "description":"ID of the receiving (Should be unique for the source)" }, "sourceReceivingId":{ "type":"string", "description":"ID of the receiving as known in the host system" }, "eventType":{ "type":"string", "description":"Type of the event" }, "sourceEventType":{ "type":"string", "description":"Event Type of the source Event" }, "portOfLoadingName":{ "type":"string", "description":"Name of the port of loading" }, "portOfLoadingCode":{ "type":"string", "description":"Code of the port of loading" }, "containerId":{ "type":"string", "description":"Unique id of the container" }, "sealId":{ "type":"string", "description":"Seal id" }, "equipmentType":{ "type":"string", "description":"Equipment Type" }, "transportMode":{ "type":"string", "description":"Method used for the transport" }, "shipDateTime":{ "type":"string", "format":"date-time", "description":"Actual date of shipment (ISO format, UTC+0 time)" }, "scheduledArrivalDateTime":{ "type":"string", "format":"date-time", "description":"Scheduled estimate arrival date (ISO format, UTC+0 time)" }, "scheduledDeliveryDateTime":{ "type":"string", "format":"date-time", "description":"Scheduled arrival date in destination WH with L/T (ISO format, UTC+0 time)" }, "totalGrossWeight":{ "type":"number", "format":"double", "description":"Gross Weight of the the receiving" }, "totalWeightUOM":{ "type":"string", "description":"Free Text to manage Unit Of Measure" }, "totalVolume":{ "type":"number", "format":"double", "description":"Volume of the receiving" }, "totalVolumeUOM":{ "type":"string", "description":"Free Text to manage Unit Of Measure" }, "shippingInstructions":{ "type":"string", "description":"Instructions for the shipping" }, "routingInstructions":{ "type":"string", "description":"Instructions for the routing" }, "incoterms":{ "type":"string", "description":"Incoterms" }, "portOfDischargeName":{ "type":"string", "description":"Name of the port of discharge" }, "portOfDischargeCode":{ "type":"string", "description":"Code of the port of discharge" }, "maritimeAirCompanyName":{ "type":"string", "description":"Maritime or Air company name" }, "maritimeAirCompanyCode":{ "type":"string", "description":"Maritime or Air company code" }, "maritimeAirCompanyNumber":{ "type":"string", "description":"Maritime or Air company number" }, "maritimeAirCompanyCountryCode":{ "type":"string", "description":"Maritime or Air company iso2 country code" }, "scheduledMaritimeAirDepartureDateTime":{ "type":"string", "format":"date-time", "description":"Scheduled departure date for maritime or air transport (ISO format, UTC+0 time)" }, "customerName":{ "type":"string", "description":"Name of the customer" }, "customerCode":{ "type":"string", "description":"Code of the customer" }, "consignmentNoteNumber":{ "type":"string", "description":"Consignment Note Number" }, "status":{ "type":"string", "description":"Status of the receiving" }, "carrierCode":{ "type":"string", "description":"Code of the carrier" }, "carrierName":{ "type":"string", "description":"Name of the carrier" }, "carrierService":{ "type":"string", "description":"Service of the carrier" }, "freightCode":{ "type":"string", "description":"Service of the carrier" }, "shipFrom":{ "$ref":"#/components/schemas/ShipFromDto", "description":"Freight code for transport pricing classification" }, "shipTo":{ "$ref":"#/components/schemas/ShipToDto", "description":"The shipTo of the receiving" }, "lines":{ "type":"array", "description":"Delivery lines", "items":{ "$ref":"#/components/schemas/ReceivingLineDto" } }, "extraDatas":{ "type":"array", "description":"Free extra datas", "items":{ "$ref":"#/components/schemas/ExtraDataDto" } }, "odcode":{ "type":"string" }, "orcode":{ "type":"string" }, "occode":{ "type":"string" } } }, "ReceivingLineDto":{ "type":"object", "properties":{ "lineId":{ "type":"string", "description":"Line counter this is a key value with order of the line" }, "sourceLineId":{ "type":"string", "description":"Line id (in the source application)" }, "itemCode":{ "type":"string", "description":"ItemCode to identify the required product" }, "itemType":{ "type":"string", "description":"ItemType to identify the required product" }, "itemDescription":{ "type":"string", "description":"Item Description" }, "customerPartNumber":{ "type":"string", "description":"Item reference as identified on the customer side" }, "customerPartNumberDescription":{ "type":"string", "description":"Item Description as identified on the customer side" }, "marketCode":{ "type":"string", "description":"Market code" }, "freightCode":{ "type":"string", "description":"Freight code" }, "classificationCode":{ "type":"string", "description":"Classification code" }, "dot":{ "type":"string", "description":"dot" }, "zpCode":{ "type":"string", "description":"zpCode" }, "factoryStockOwner":{ "type":"string", "description":"factoryStockOwner" }, "stockOwner":{ "type":"string", "description":"FreeText for stockOwner" }, "palletNumber":{ "type":"string", "description":"FreeText for palletNumber" }, "quantity":{ "type":"number", "format":"double", "description":"Quantity of items" }, "quantityUOM":{ "type":"string", "description":"Free text for the quantity unit of measure" }, "netWeight":{ "type":"number", "format":"double", "description":"Estimated net weight of the items in the line" }, "grossWeight":{ "type":"number", "format":"double", "description":"Estimated gross weight of all the items in the line" }, "weightUOM":{ "type":"string", "description":"Free text for the weight unit of measure" }, "customerPONumber":{ "type":"string", "description":"PurchaseOrder Number of the Customer" }, "customerPOLineNumber":{ "type":"string", "description":"PurchaseOrder Number Line of the Customer" }, "customerPOPaymentTerm":{ "type":"string", "description":"PurchaseOrder payment term" }, "orderNumber":{ "type":"string", "description":"Order number" }, "deliveryId":{ "type":"string", "description":"Id of delivery" }, "deliveryLineId":{ "type":"string", "description":"Id of delivery line" }, "equipmentType":{ "type":"string", "description":"Equipment type" }, "sourceDeliveryId":{ "type":"string", "description":"Id of delivery in the source system" }, "sourceDeliveryLineId":{ "type":"string", "description":"Id of delivery line in the source system" }, "containerId":{ "type":"string", "description":"Id reference of the container or a box, pallet..." }, "scheduledShipDateTime":{ "type":"string", "format":"date-time", "description":"Scheduled date of shipment (ISO format, UTC+0 time)" }, "productionCountryCode":{ "type":"string", "description":"iso2 country code of production country" }, "productionCountryName":{ "type":"string", "description":"Name of production country" }, "subInventory":{ "type":"string", "description":"Storage Inventory Mode (specific CEVA)" }, "shipFrom":{ "$ref":"#/components/schemas/ShipFromDto", "description":"origin location of the receiving" }, "extraDatas":{ "type":"array", "description":"Free extra data", "items":{ "$ref":"#/components/schemas/ExtraDataDto" } } } }, "ResultDtoReceivingFor3PLDto":{ "type":"object", "properties":{ "correlationId":{ "type":"string", "description":"the correlation id of the message" }, "value":{ "$ref":"#/components/schemas/ReceivingFor3PLDto", "description":"the message" }, "timestamp":{ "type":"integer", "format":"int64" } } }, "ResultSetDtoReceivingFor3PLDto":{ "type":"object", "description":"The result returned by the GET API", "properties":{ "correlationId":{ "type":"string", "description":"The correlation id of the transaction GET" }, "latestTimestamp":{ "type":"integer", "format":"int64", "description":"The timestamp of the latest record returned in the result set" }, "earliestTimestamp":{ "type":"integer", "format":"int64", "description":"The timestamp of the earliest record returned in the result set" }, "latestDateTime":{ "type":"string", "format":"date-time", "description":"The ISO DateTime of the latest record returned in the result set" }, "earliestDateTime":{ "type":"string", "format":"date-time", "description":"The ISO DateTime of the latest record returned in the result set" }, "fetchSize":{ "type":"integer", "format":"int32", "description":"The number of result returned" }, "statusCode":{ "type":"string", "description":"The status code of the GET request with possible values: STOP_OK(=HTTP 200) \nSTOP_NO_CONTENT (=HTTP 204), UNAUTHORIZED (=HTTP 401), FORBIDDEN (=HTTP 403)", "enum":[ "START", "STOP_OK", "STOP_CREATED", "STOP_ACCEPTED", "STOP_NO_CONTENT", "STOP_PARTIAL", "STOP_IGNORE", "STOP_BAD_REQUEST", "STOP_NOT_FOUND", "STOP_FUNCTIONAL_ERROR", "STOP_TECHNICAL_ERROR" ] }, "message":{ "type":"string", "description":"The message result of the GET request" }, "results":{ "type":"array", "description":"The list of the results fetched", "items":{ "$ref":"#/components/schemas/ResultDtoReceivingFor3PLDto" } }, "earliestOrLatestTimestamp":{ "type":"integer", "format":"int64", "writeOnly":true } } }, "LoadFor3PLDto":{ "type":"object", "description":"Load object", "properties":{ "creationDateTime":{ "type":"string", "format":"date-time", "description":"Creation Date Time of the event in LEX" }, "sourceCreationDateTime":{ "type":"string", "format":"date-time", "description":"Creation Date Time of the event (in the source System)" }, "source":{ "type":"string", "description":"Source Application of the Data" }, "target":{ "type":"string", "description":"Target Application of the Data" }, "createdBy":{ "type":"string", "description":"Message created By" }, "correlationId":{ "type":"string", "description":"Unique ID of the message (UUID)" }, "sourceLoadId":{ "type":"string", "description":"ID of the Load in the source solution (in case of mapping needed)" }, "eventType":{ "type":"string", "description":"Type of the event (ex: PICK_REQUEST)" }, "sourceEventType":{ "type":"string", "description":"Event Type of the source Event (ex: PICK_REQUEST)" }, "loadId":{ "type":"string", "description":"ID of the load" }, "shipFrom":{ "$ref":"#/components/schemas/ShipFromDto", "description":"The shipFrom of the load (if only one pick)" }, "shipTo":{ "$ref":"#/components/schemas/ShipToDto", "description":"The shipTo of the load (if only one drop)" }, "billTo":{ "$ref":"#/components/schemas/BillToDto", "description":"The billTo of the load (if only one client)" }, "routingInstructions":{ "type":"string", "description":"The FreeText for Routing Instructions at Header Level" }, "shippingInstructions":{ "type":"string", "description":"The FreeText for Shipping Instructions at Header Level" }, "logisticInstructions":{ "type":"string", "description":"The FreeText for Logistic Instructions at Header Level" }, "scheduledShipDateTime":{ "type":"string", "format":"date-time", "description":"Date/Time when the goods should leave the warehouse (Format : ISO_OFFSET_DATE_TIME: YYYY-MM-DDThh:mm:ssZ)" }, "customerPONumber":{ "type":"string", "description":"PurchaseOrder Number of the Customer" }, "customerPONumberLine":{ "type":"string", "description":"PurchaseOrder Number Line of the Customer" }, "shipmentRequestType":{ "type":"string", "description":"Request Type of the order (String like for exemple XDC)" }, "carrierCode":{ "type":"string", "description":"Code of the carrier" }, "carrierName":{ "type":"string", "description":"Name of the carrier" }, "carrierService":{ "type":"string", "description":"Service of the carrier" }, "scheduledShipByDateTime":{ "type":"string", "format":"date-time", "description":"ShipDate Requested" }, "scheduledLoadingEndDateTime":{ "type":"string", "format":"date-time", "description":"DateTime to start Pickup" }, "status":{ "type":"string", "description":"Status of the shipping" }, "priority":{ "type":"string", "description":"Priority of the shipping" }, "equipmentType":{ "type":"string", "description":"Equipment Type (For example : T65)" }, "shippingMethod":{ "type":"string", "description":"Method used for the shipping" }, "transportMethod":{ "type":"string", "description":"Method used for the transport" }, "serviceName":{ "type":"string", "description":"Service level used for the transport" }, "lines":{ "type":"array", "description":"Delivery lines", "items":{ "$ref":"#/components/schemas/LoadLineDto" } }, "extraDatas":{ "type":"array", "description":"Free extra datas", "items":{ "$ref":"#/components/schemas/ExtraDataDto" } } } }, "LoadLineDto":{ "type":"object", "properties":{ "lineId":{ "type":"string", "description":"Line counter this is a key value with order of the line" }, "sourceLineId":{ "type":"string", "description":"Line id (in the source application)" }, "deliveryId":{ "type":"string", "description":"ID of the delivery as known in Michelin system" }, "deliveryLineId":{ "type":"string", "description":"ID of the delivery Line as known in Michelin system" }, "routingInstructions":{ "type":"string", "description":"FreeText for Routing Instructions at Line Level" }, "shippingInstructions":{ "type":"string", "description":"FreeText for Shipping Instructions at Line Level" }, "logisticInstructions":{ "type":"string", "description":"FreeText for Logistic Instructions at Line Level" }, "stockOwner":{ "type":"string", "description":"FreeText for stockOwner" }, "factoryStockOwner":{ "type":"string", "description":"FreeText for Factory StockOwner" }, "customerPONumber":{ "type":"string", "description":"PurchaseOrder Number of the Customer" }, "customerPOLineNumber":{ "type":"string", "description":"PurchaseOrder Line Number of the Customer" }, "itemCode":{ "type":"string", "description":"ItemCode to identify the required product" }, "itemType":{ "type":"string", "description":"ItemType to identify the required product" }, "itemDescription":{ "type":"string", "description":"Item Description" }, "customerPartNumber":{ "type":"string", "description":"customerPartNumber as identified on the client side" }, "customerPartNumberDescription":{ "type":"string", "description":"customerPartNumber Description as identified on the client side" }, "shipFrom":{ "$ref":"#/components/schemas/ShipFromDto", "description":"ShipFrom at delivery level" }, "shipTo":{ "$ref":"#/components/schemas/ShipToDto", "description":"ShipTo at delivery level" }, "billTo":{ "$ref":"#/components/schemas/BillToDto", "description":"BillTo at delivery level" }, "grossWeight":{ "type":"number", "format":"double", "description":"Gross Weight of the product" }, "netWeight":{ "type":"number", "format":"double", "description":"Net Weight of the product" }, "weightUOM":{ "type":"string", "description":"Free Text to manage Unit Of Measure" }, "requestedQuantity":{ "type":"number", "format":"double", "description":"Quantity in the shipping" }, "requestedQuantityUOM":{ "type":"string", "description":"Unit of Measure of the Requested Quantity" }, "scheduledDeliveryDateTimeMin":{ "type":"string", "format":"date-time", "description":"Delivery Due DateTime Min Timeslot (Format : YYYY-MM-DDThh:mm:ssZ)" }, "scheduledDeliveryDateTimeMax":{ "type":"string", "format":"date-time", "description":"Delivery Due DateTime Max Timeslot (Format : YYYY-MM-DDThh:mm:ssZ)" }, "scheduledShipDateTime":{ "type":"string", "format":"date-time", "description":"DateTime when the goods should leave the warehouse (Format : YYYY-MM-DDThh:mm:ssZ)" }, "scheduledLoadingEndDateTime":{ "type":"string", "format":"date-time", "description":"Date when the goods should be loaded in the truck and ready to leave from warehouse (Format : YYYY-MM-DDThh:mm:ssZ)" }, "shipmentMode":{ "type":"string", "description":"Free Text for shipment Mode - Dedicated, TruckLoad, LessThanTruckLoad" }, "loadingSequenceOrder":{ "type":"string", "description":"Order Loading Sequence" }, "orderNumber":{ "type":"string", "description":"Order Number in the Michelin System" }, "orderLineNumber":{ "type":"string", "description":"Order Line Number in the Michelin System" }, "extraDatas":{ "type":"array", "description":"Free extra data", "items":{ "$ref":"#/components/schemas/ExtraDataDto" } } } }, "ResultDtoLoadFor3PLDto":{ "type":"object", "properties":{ "correlationId":{ "type":"string", "description":"the correlation id of the message" }, "value":{ "$ref":"#/components/schemas/LoadFor3PLDto", "description":"the message" }, "timestamp":{ "type":"integer", "format":"int64" } } }, "ResultSetDtoLoadFor3PLDto":{ "type":"object", "description":"The result returned by the GET API", "properties":{ "correlationId":{ "type":"string", "description":"The correlation id of the transaction GET" }, "latestTimestamp":{ "type":"integer", "format":"int64", "description":"The timestamp of the latest record returned in the result set" }, "earliestTimestamp":{ "type":"integer", "format":"int64", "description":"The timestamp of the earliest record returned in the result set" }, "latestDateTime":{ "type":"string", "format":"date-time", "description":"The ISO DateTime of the latest record returned in the result set" }, "earliestDateTime":{ "type":"string", "format":"date-time", "description":"The ISO DateTime of the latest record returned in the result set" }, "fetchSize":{ "type":"integer", "format":"int32", "description":"The number of result returned" }, "statusCode":{ "type":"string", "description":"The status code of the GET request with possible values: STOP_OK(=HTTP 200) \nSTOP_NO_CONTENT (=HTTP 204), UNAUTHORIZED (=HTTP 401), FORBIDDEN (=HTTP 403)", "enum":[ "START", "STOP_OK", "STOP_CREATED", "STOP_ACCEPTED", "STOP_NO_CONTENT", "STOP_PARTIAL", "STOP_IGNORE", "STOP_BAD_REQUEST", "STOP_NOT_FOUND", "STOP_FUNCTIONAL_ERROR", "STOP_TECHNICAL_ERROR" ] }, "message":{ "type":"string", "description":"The message result of the GET request" }, "results":{ "type":"array", "description":"The list of the results fetched", "items":{ "$ref":"#/components/schemas/ResultDtoLoadFor3PLDto" } }, "earliestOrLatestTimestamp":{ "type":"integer", "format":"int64", "writeOnly":true } } }, "ItemFor3PLDto":{ "type":"object", "description":"Item object", "properties":{ "correlationId":{ "type":"string", "description":"Unique ID of the message (UUID)" }, "creationDateTime":{ "type":"string", "format":"date-time", "description":"Creation Date Time of the event in LEX" }, "sourceCreationDateTime":{ "type":"string", "format":"date-time", "description":"Creation Date Time of the event (in the source System)" }, "source":{ "type":"string", "description":"Source Application of the Data" }, "target":{ "type":"string", "description":"Target Application of the Data (ex: DHL)" }, "itemCode":{ "type":"string", "description":"Code of the Item in the source solution." }, "itemType":{ "type":"string", "description":"Type of the Code (CAI, CAD or CUSTOM if need target)" }, "itemDescription":{ "type":"string", "description":"Description of the item" }, "eanCode":{ "type":"string", "description":"Item EAN Code" }, "serialized":{ "type":"boolean", "description":"If the product will be able to be serialized (default: false)" }, "extraDatas":{ "type":"array", "description":"Array of Couple Name/Value to let share extra data not planned in the standard Model", "items":{ "$ref":"#/components/schemas/ExtraDataDto" } }, "Item gross weight":{ "type":"number", "format":"double" }, "Item net weight":{ "type":"number", "format":"double" }, "Unit Of Measure for weight":{ "type":"string" }, "Item gross volume":{ "type":"number", "format":"double" }, "Item net volume":{ "type":"number", "format":"double" }, "Unit Of Measure for volume":{ "type":"string" }, "Item length":{ "type":"number", "format":"double" }, "Item width":{ "type":"number", "format":"double" }, "Item height":{ "type":"number", "format":"double" }, "Unite Of Measure for dimension":{ "type":"string" } } }, "ResultDtoItemFor3PLDto":{ "type":"object", "properties":{ "correlationId":{ "type":"string", "description":"the correlation id of the message" }, "value":{ "$ref":"#/components/schemas/ItemFor3PLDto", "description":"the message" }, "timestamp":{ "type":"integer", "format":"int64" } } }, "ResultSetDtoItemFor3PLDto":{ "type":"object", "description":"The result returned by the GET API", "properties":{ "correlationId":{ "type":"string", "description":"The correlation id of the transaction GET" }, "latestTimestamp":{ "type":"integer", "format":"int64", "description":"The timestamp of the latest record returned in the result set" }, "earliestTimestamp":{ "type":"integer", "format":"int64", "description":"The timestamp of the earliest record returned in the result set" }, "latestDateTime":{ "type":"string", "format":"date-time", "description":"The ISO DateTime of the latest record returned in the result set" }, "earliestDateTime":{ "type":"string", "format":"date-time", "description":"The ISO DateTime of the latest record returned in the result set" }, "fetchSize":{ "type":"integer", "format":"int32", "description":"The number of result returned" }, "statusCode":{ "type":"string", "description":"The status code of the GET request with possible values: STOP_OK(=HTTP 200) \nSTOP_NO_CONTENT (=HTTP 204), UNAUTHORIZED (=HTTP 401), FORBIDDEN (=HTTP 403)", "enum":[ "START", "STOP_OK", "STOP_CREATED", "STOP_ACCEPTED", "STOP_NO_CONTENT", "STOP_PARTIAL", "STOP_IGNORE", "STOP_BAD_REQUEST", "STOP_NOT_FOUND", "STOP_FUNCTIONAL_ERROR", "STOP_TECHNICAL_ERROR" ] }, "message":{ "type":"string", "description":"The message result of the GET request" }, "results":{ "type":"array", "description":"The list of the results fetched", "items":{ "$ref":"#/components/schemas/ResultDtoItemFor3PLDto" } }, "earliestOrLatestTimestamp":{ "type":"integer", "format":"int64", "writeOnly":true } } }, "ResultDtoObject":{ "type":"object", "properties":{ "correlationId":{ "type":"string", "description":"the correlation id of the message" }, "value":{ "description":"the message" }, "timestamp":{ "type":"integer", "format":"int64" } } }, "ResultSetDtoObject":{ "type":"object", "description":"The result returned by the GET API", "properties":{ "correlationId":{ "type":"string", "description":"The correlation id of the transaction GET" }, "latestTimestamp":{ "type":"integer", "format":"int64", "description":"The timestamp of the latest record returned in the result set" }, "earliestTimestamp":{ "type":"integer", "format":"int64", "description":"The timestamp of the earliest record returned in the result set" }, "latestDateTime":{ "type":"string", "format":"date-time", "description":"The ISO DateTime of the latest record returned in the result set" }, "earliestDateTime":{ "type":"string", "format":"date-time", "description":"The ISO DateTime of the latest record returned in the result set" }, "fetchSize":{ "type":"integer", "format":"int32", "description":"The number of result returned" }, "statusCode":{ "type":"string", "description":"The status code of the GET request with possible values: STOP_OK(=HTTP 200) \nSTOP_NO_CONTENT (=HTTP 204), UNAUTHORIZED (=HTTP 401), FORBIDDEN (=HTTP 403)", "enum":[ "START", "STOP_OK", "STOP_CREATED", "STOP_ACCEPTED", "STOP_NO_CONTENT", "STOP_PARTIAL", "STOP_IGNORE", "STOP_BAD_REQUEST", "STOP_NOT_FOUND", "STOP_FUNCTIONAL_ERROR", "STOP_TECHNICAL_ERROR" ] }, "message":{ "type":"string", "description":"The message result of the GET request" }, "results":{ "type":"array", "description":"The list of the results fetched", "items":{ "$ref":"#/components/schemas/ResultDtoObject" } }, "earliestOrLatestTimestamp":{ "type":"integer", "format":"int64", "writeOnly":true } } } }, "securitySchemes":{ "bearerAuth":{ "type":"http", "name":"bearerAuth", "scheme":"bearer" } } } }