{ "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.3.0" }, "servers": [ { "url": "https://sandbox.api.michelin.com/mock-order-execution", "description": "Generated server url" } ], "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "POST Operations", "description": "API to send events to LEX" }, { "name": "GET Operations", "description": "API to get events from LEX" } ], "paths": { "-status/v1/subinventory": { "post": { "tags": [ "POST Operations" ], "summary": "Post a subinventory transfer message to LEX", "operationId": "sendSubInventoryFrom3PL", "requestBody": { "description": "The subinventory transfer to send to LEX", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubInventoryTransferFrom3PLDto" }, "examples": { "subinventory transfer": { "description": "subinventory transfer", "value": { "creationDateTime": "2025-12-16T09:05:00.070+02:00", "eventType": "INVADJ-STS", "reasonNoteCode": "LIBERATE", "toStockOwner": "NotMUA", "fromStockOwner": "MUA", "targetWhCode": "MUA", "messageType": "INVADJ-STS", "targetTransactionId": "0000011741", "status": "status", "lines": [ { "lineId": "1", "itemCode": "000154_101", "itemType": "CAD", "updatedQuantity": 3, "fromSubInventory": "IND_NLIB", "toSubInventory": "ONHAND", "eventDateTime": "2025-12-16T07:04:45.747+02:00", "quantityUOM": "EA", "factoryStockOwner": "15k", "lotNumber": "lotNumber", "lotQuantity": 0 } ] } } } } }, "required": true }, "responses": { "201": { "description": "Message successfully integrated", "content": { "application/json": { "examples": { "Success": { "description": "Success", "value": { "error": "Success", "timestamp": "2025-05-26T11:22:37.0045933", "message": "End processing subInventoryTransfer with targetTransactionId id {0}", "status": 201, "path": "/lex-generic-3pl-api-status/v1/subinventory" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "examples": { "Bad request": { "description": "Bad request", "value": { "error": "Bad request", "timestamp": "2025-05-26T11:22:37.0045933", "message": "Error while converting SubInventoryTransferFrom3PLDto to SubInventoryTransferFrom3PLAvro", "status": 400, "path": "/lex-generic-3pl-api-status/v1/subinventory" } } } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "examples": { "Unauthorized": { "description": "Unauthorized", "value": { "error": "Unauthorized", "timestamp": "2025-05-26T11:22:37.0045933", "message": "Full authentication is required to access this resource", "status": 401, "path": "/lex-generic-3pl-api-status/v1/subinventory" } } } } } }, "403": { "description": "Operation is not authorized: no subscription", "content": { "application/json": { "examples": { "Forbidden": { "description": "Forbidden", "value": { "error": "Forbidden", "timestamp": "2025-05-26T11:22:37.0045933", "message": "Accessing this resource if forbidden", "status": 403, "path": "/lex-generic-3pl-api-status/v1/subinventory" } } } } } }, "500": { "description": "Error while processing request", "content": { "application/json": { "examples": { "Internal server error": { "description": "Internal server error", "value": { "error": "Internal server error", "timestamp": "2025-05-26T11:22:37.0045933", "message": "Internal server error occurred while processing the subinventory message", "status": 500, "path": "/lex-generic-3pl-api-status/v1/subinventory" } } } } } } } } }, "-outbound/v2/shipped": { "post": { "tags": [ "POST Operations" ], "summary": "Post a shipped message to LEX", "operationId": "sendShippedFrom3PL", "requestBody": { "description": "The shipped to send to LEX", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippedFrom3PLDto" }, "examples": { "shippedFrom3PL": { "description": "shippedFrom3PL", "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": { "201": { "description": "Message successfully integrated", "content": { "application/json": { "examples": { "Success": { "description": "Success", "value": { "error": "Success", "timestamp": "2025-05-26T11:22:37.0045933", "message": "SHIPPED message processed successfully", "status": 201, "path": "/lex-generic-3pl-api-outbound/v2/shipped" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "examples": { "Bad request": { "description": "Bad request", "value": { "error": "Bad request", "timestamp": "2025-05-26T11:22:37.0045933", "message": "Error in the payload of the SHIPPED message", "status": 400, "path": "/lex-generic-3pl-api-outbound/v2/shipped" } } } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "examples": { "Unauthorized": { "description": "Unauthorized", "value": { "error": "Unauthorized", "timestamp": "2025-05-26T11:22:37.0045933", "message": "Full authentication is required to access this resource", "status": 401, "path": "/lex-generic-3pl-api-outbound/v2/shipped" } } } } } }, "403": { "description": "Operation is not authorized: no subscription", "content": { "application/json": { "examples": { "Forbidden": { "description": "Forbidden", "value": { "error": "Forbidden", "timestamp": "2025-05-26T11:22:37.0045933", "message": "Accessing this resource if forbidden", "status": 403, "path": "/lex-generic-3pl-api-outbound/v2/shipped" } } } } } }, "500": { "description": "Error while processing request", "content": { "application/json": { "examples": { "Internal server error": { "description": "Internal server error", "value": { "error": "Internal server error", "timestamp": "2025-05-26T11:22:37.0045933", "message": "Internal server error occurred while processing the SHIPPED message", "status": 500, "path": "/lex-generic-3pl-api-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", "stockOwner": "MUA", "factoryStockOwner": "15K", "receptionDateTime": "2023-06-07T15:00:00.000+02:00", "requester": { "name": "requester name", "code": "requester code", "id": "requester id", "contact": { "name": "contact name", "code": "contact code", "phone": "phone number", "mail": "mail@mail.org" } }, "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" ], "customerPONumber": "TH_12182714_25", "customerPOLineNumber": "1", "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" ], "customerPONumber": "TW_12182714_25", "customerPOLineNumber": "2", "extraDatas": [ { "name": "LineKey3", "value": "LineValue3" } ] } ], "extraDatas": [ { "name": "RootKey1", "value": "RootValue1" }, { "name": "RootKey2", "value": "RootValue2" } ] } } } } }, "required": true }, "responses": { "201": { "description": "Message successfully integrated", "content": { "application/json": { "examples": { "Success": { "description": "Success", "value": { "error": "Success", "timestamp": "2025-05-26T11:22:37.0045933", "message": "RECEIVED message processed successfully", "status": 201, "path": "/lex-generic-3pl-api-inbound/v2/received" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "examples": { "Bad request": { "description": "Bad request", "value": { "error": "Bad request", "timestamp": "2025-05-26T11:22:37.0045933", "message": "Error in the payload of the RECEIVED message", "status": 400, "path": "/lex-generic-3pl-api-inbound/v2/received" } } } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "examples": { "Unauthorized": { "description": "Unauthorized", "value": { "error": "Unauthorized", "timestamp": "2025-05-26T11:22:37.0045933", "message": "Full authentication is required to access this resource", "status": 401, "path": "/lex-generic-3pl-api-inbound/v2/received" } } } } } }, "403": { "description": "Operation is not authorized: no subscription", "content": { "application/json": { "examples": { "Forbidden": { "description": "Forbidden", "value": { "error": "Forbidden", "timestamp": "2025-05-26T11:22:37.0045933", "message": "Accessing this resource if forbidden", "status": 403, "path": "/lex-generic-3pl-api-inbound/v2/received" } } } } } }, "500": { "description": "Error while processing request", "content": { "application/json": { "examples": { "Internal server error": { "description": "Internal server error", "value": { "error": "Internal server error", "timestamp": "2025-05-26T11:22:37.0045933", "message": "Internal server error occurred while processing the RECEIVED message", "status": 500, "path": "/lex-generic-3pl-api-inbound/v2/received" } } } } } } } } }, "-outbound/v2/shipment": { "get": { "tags": [ "GET Operations" ], "summary": "Get the shipment events after minTimestamp (V2)", "operationId": "getShipmentFor3PLV2", "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" }, "example": "2023-05-27T08:18:58+02:00" } ], "responses": { "200": { "description": "Operation returns the list of shipments from oldest to newest", "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 } ] } } } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "examples": { "Unauthorized": { "description": "Unauthorized", "value": { "error": "Unauthorized", "timestamp": "2025-05-26T11:22:37.0045933", "message": "Full authentication is required to access this resource", "status": 401, "path": "/lex-generic-3pl-api-outbound/v2/shipment" } }, "Not authenticated": { "value": { "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": "Forbidden", "value": { "error": "Forbidden", "timestamp": "2025-05-26T11:22:37.0045933", "message": "No subscription found for partnerId and event type SHIPMENT", "status": 403, "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", "value": { "error": "Bad request", "timestamp": "2025-05-26T11:22:37.0045933", "message": "Check parameters", "status": 400, "path": "https://sandbox.api.michelin.com/mock-order-execution-outbound/v2/shipment" } } } } } }, "500": { "description": "Error while processing request", "content": { "application/json": { "examples": { "Internal server error": { "description": "Internal server error", "value": { "error": "Internal server error", "timestamp": "2025-05-26T11:22:37.0045933", "message": "Internal server error while processing the SHIPMENT request for partnerId ", "status": 500, "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 (V2)", "operationId": "getReturnFor3PLV2", "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" }, "example": "2023-05-27T08:18:58+02:00" } ], "responses": { "200": { "description": "Operation returns the list of return events from oldest to newest", "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 } ] } } } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "examples": { "Unauthorized": { "description": "Unauthorized", "value": { "error": "Unauthorized", "timestamp": "2025-05-26T11:22:37.0045933", "message": "Full authentication is required to access this resource", "status": 401, "path": "/lex-generic-3pl-api-inbound/v2/return" } }, "Not authenticated": { "value": { "path": "https://sandbox.api.michelin.com/mock-order-execution-outbound/v2/return" } } } } } }, "403": { "description": "Operation is not authorized: no subscription", "content": { "application/json": { "examples": { "Forbidden": { "description": "Forbidden", "value": { "error": "Forbidden", "timestamp": "2025-05-26T11:22:37.0045933", "message": "No subscription found for partnerId and event type RETURN", "status": 403, "path": "https://sandbox.api.michelin.com/mock-order-execution-outbound/v2/return" } } } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "examples": { "Bad request": { "description": "Bad request", "value": { "error": "Bad request", "timestamp": "2025-05-26T11:22:37.0045933", "message": "Check parameters", "status": 400, "path": "https://sandbox.api.michelin.com/mock-order-execution-outbound/v2/return" } } } } } }, "500": { "description": "Error while processing request", "content": { "application/json": { "examples": { "Internal server error": { "description": "Internal server error", "value": { "error": "Internal server error", "timestamp": "2025-05-26T11:22:37.0045933", "message": "Internal server error while processing the RETURN request for partnerId ", "status": 500, "path": "https://sandbox.api.michelin.com/mock-order-execution-outbound/v2/return" } } } } } } } } }, "-inbound/v2/receiving": { "get": { "tags": [ "GET Operations" ], "summary": "Get the receiving events after minTimestamp (V2)", "operationId": "getReceivingFor3PLV2", "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" }, "example": "2023-05-27T08:18:58+02:00" } ], "responses": { "200": { "description": "Operation returns the list of receiving from oldest to newest", "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": 3, "statusCode": "STOP_OK", "message": "Search query successful", "results": [ { "correlationId": "f41a8f64-010c-46f7-a861-c418995378a4", "creationDateTime": "2026-02-19T09:45:41.789Z", "source": "FOPACJ", "target": "MAERSKIDN", "receivingId": "TH_11775785_26", "sourceReceivingId": "8402737", "sourceCreationDateTime": "2026-02-19T09:45:19Z", "eventType": "PO_RECEIPT", "sourceEventType": "ASN", "shippedDateTime": "2026-02-19T16:52:41Z", "scheduledArrivalDateTime": "2026-03-06T08:00:00Z", "placeOfDischarge": "LOGID=IFOPACJparx01-zf5km-amnvb2;;REFID=ASN_TH_11775785_26;KEY=TH_11775785_26", "status": "EXPECTED", "createdBy": "-1", "transportUnit": { "id": "11775785", "equipmentType": "HC40", "number": "TRIU0503965", "totalNetWeight": 493.245, "totalQuantity": 89, "quantityUOM": "EA" }, "shipFrom": { "code": "622", "codeType": "companyCode", "name": "MICHELIN ASIA-PACIFIC IMPORT-EXPORT (SG) PTE LTD", "locationCode": "SG_INTRAGROUP", "address": {} }, "shipTo": { "code": "MUA", "codeType": "inventoryOrganisationCode", "name": "890_ID_MU2_MUA_WH_CO", "locationCode": "MU2_LOC", "subInventory": "ONHAND" }, "lines": [ { "lineId": "1", "sourceLineId": "1", "itemCode": "482738_101", "itemType": "CAD", "itemDescription": "225/80 R 17.5 XJE4 MIX ENERGY TL 123/122L VB MI", "classificationCode": "FG", "factoryStockOwner": "13L", "stockOwner": "MU2", "quantity": 15, "quantityUOM": "EA", "customerPONumber": "THID09746_25", "customerPOLineNumber": "3" }, { "lineId": "2", "sourceLineId": "2", "itemCode": "586050_102", "itemType": "CAD", "itemDescription": "7.50R16LT X MULTI HD Z TL 122/121L VM MI", "classificationCode": "FG", "factoryStockOwner": "13L", "stockOwner": "MU2", "quantity": 1, "quantityUOM": "EA", "customerPONumber": "THID09746_25", "customerPOLineNumber": "4" }, { "lineId": "3", "sourceLineId": "3", "itemCode": "586050_102", "itemType": "CAD", "itemDescription": "7.50R16LT X MULTI HD Z TL 122/121L VM MI", "classificationCode": "FG", "factoryStockOwner": "13L", "stockOwner": "MU2", "quantity": 73, "quantityUOM": "EA", "customerPONumber": "THID09746_25", "customerPOLineNumber": "4" } ] }, { "correlationId": "2aff36ee-f828-4246-8d03-4db822d9efef", "creationDateTime": "2026-02-23T08:51:42.919Z", "source": "AXAPTA", "target": "MAERSKIDN", "receivingId": "P2600060_20260223T155030", "sourceReceivingId": "P2600060_20260223T155030", "sourceCreationDateTime": "2026-02-23T08:50:30Z", "eventType": "PROD_RECEIPT_2W", "sourceEventType": "PROD_RECEIPT_2W", "status": "CREATE", "createdBy": "lex-3pl-preparedata-fromaxapta-api", "transportUnit": { "id": "P2600060", "equipmentType": "RSB", "number": "900005091", "totalQuantity": 16 }, "shipTo": { "code": "MUA", "subInventory": "IND_NLIB" }, "lines": [ { "lineId": "1", "itemCode": "222513_799", "itemType": "CAD", "itemDescription": "110/70-12,M/C,47S,MICHELIN,CITY,GRIP,2", "market": "RT", "classificationCode": "2R", "dot": "0126", "stockOwner": "MU1", "palletNumber": "P2600060", "quantity": 3, "quantityUOM": "EA", "productionCountryCode": "ID", "serialNumberList": [ "YY000013", "YY000014", "YY000021" ] }, { "lineId": "2", "itemCode": "222513_799", "itemType": "CAD", "itemDescription": "110/70-12,M/C,47S,MICHELIN,CITY,GRIP,2", "market": "RT", "classificationCode": "2R", "dot": "0226", "stockOwner": "MU1", "palletNumber": "P2600060", "quantity": 1, "quantityUOM": "EA", "productionCountryCode": "ID", "serialNumberList": [ "YY000009" ] }, { "lineId": "3", "itemCode": "222513_799", "itemType": "CAD", "itemDescription": "110/70-12,M/C,47S,MICHELIN,CITY,GRIP,2", "market": "RT", "classificationCode": "2R", "dot": "0326", "stockOwner": "MU1", "palletNumber": "P2600060", "quantity": 3, "quantityUOM": "EA", "productionCountryCode": "ID", "serialNumberList": [ "YY000005", "YY000016", "YY000027" ] }, { "lineId": "4", "itemCode": "222513_799", "itemType": "CAD", "itemDescription": "110/70-12,M/C,47S,MICHELIN,CITY,GRIP,2", "market": "RT", "classificationCode": "2R", "dot": "0426", "stockOwner": "MU1", "palletNumber": "P2600060", "quantity": 3, "quantityUOM": "EA", "productionCountryCode": "ID", "serialNumberList": [ "YY000015", "YY000023", "YY000025" ] }, { "lineId": "5", "itemCode": "222513_799", "itemType": "CAD", "itemDescription": "110/70-12,M/C,47S,MICHELIN,CITY,GRIP,2", "market": "RT", "classificationCode": "2R", "dot": "0526", "stockOwner": "MU1", "palletNumber": "P2600060", "quantity": 5, "quantityUOM": "EA", "productionCountryCode": "ID", "serialNumberList": [ "YY000017", "YY000018", "YY000022", "YY000024", "YY000026" ] }, { "lineId": "6", "itemCode": "222513_799", "itemType": "CAD", "itemDescription": "110/70-12,M/C,47S,MICHELIN,CITY,GRIP,2", "market": "RT", "classificationCode": "2R", "dot": "0626", "stockOwner": "MU1", "palletNumber": "P2600060", "quantity": 1, "quantityUOM": "EA", "productionCountryCode": "ID", "serialNumberList": [ "YY000019" ] } ] }, { "correlationId": "3937755b-c1c2-4f52-b57e-90ccb485329a", "creationDateTime": "2026-01-19T05:09:53.043Z", "source": "BSCAUS", "target": "CEVAAUS", "receivingId": "WRE26-00553", "sourceCreationDateTime": "2026-01-19T05:09:50Z", "sourceEventType": "INTERNAL_TRANSFER", "createdBy": "lex-3pl-preparedata-frombsc", "transportUnit": {}, "shipFrom": { "code": "Q01-FRESH", "name": "Q01-FRESH", "locationCode": "W01", "subInventory": "W01", "address": { "address1": "29 Sirett Street,Berrinba, QLD, 4117", "address2": "Q01-FRESH", "city": "BERRINBA", "zipCode": "4117", "isoCountry2Code": "AU" } }, "shipTo": { "code": "W01", "subInventory": "FRESH" }, "lines": [ { "lineId": "1", "sourceLineId": "10000", "itemCode": "012419_106", "itemDescription": "265/65 R17 112T TL LTX TRAIL ST MI", "quantity": 8, "quantityUOM": "EA", "customerPONumber": "TO-001129", "customerPOLineNumber": "10000" }, { "lineId": "2", "sourceLineId": "20000", "itemCode": "225739_115", "itemDescription": "215/60 R16 99V XL PRIMACY 5 MI", "quantity": 5, "quantityUOM": "EA", "customerPONumber": "TO-001129", "customerPOLineNumber": "20000" } ] } ] } } } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "examples": { "Unauthorized": { "description": "Unauthorized", "value": { "error": "Unauthorized", "timestamp": "2025-05-26T11:22:37.0045933", "message": "Full authentication is required to access this resource", "status": 401, "path": "/lex-generic-3pl-api-inbound/v2/receiving" } }, "Not authenticated": { "value": { "path": "https://sandbox.api.michelin.com/mock-order-execution-outbound/v2/receiving" } } } } } }, "403": { "description": "Operation is not authorized: no subscription", "content": { "application/json": { "examples": { "Forbidden": { "description": "Forbidden", "value": { "error": "Forbidden", "timestamp": "2025-05-26T11:22:37.0045933", "message": "No subscription found for partnerId and event type RECEIVING", "status": 403, "path": "https://sandbox.api.michelin.com/mock-order-execution-outbound/v2/receiving" } } } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "examples": { "Bad request": { "description": "Bad request", "value": { "error": "Bad request", "timestamp": "2025-05-26T11:22:37.0045933", "message": "Check parameters", "status": 400, "path": "https://sandbox.api.michelin.com/mock-order-execution-outbound/v2/receiving" } } } } } }, "500": { "description": "Error while processing request", "content": { "application/json": { "examples": { "Internal server error": { "description": "Internal server error", "value": { "error": "Internal server error", "timestamp": "2025-05-26T11:22:37.0045933", "message": "Internal server error while processing the RECEIVING request for partnerId ", "status": 500, "path": "https://sandbox.api.michelin.com/mock-order-execution-outbound/v2/receiving" } } } } } } } } }, "-outbound/v2/load": { "get": { "tags": [ "GET Operations" ], "summary": "Get the load events after minTimestamp (V2)", "operationId": "getLoadFor3PLV2", "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 load (Accepted format is timestamp or ISO_OFFSET_DATE_TIME)", "required": true, "schema": { "type": "string" }, "example": "2023-05-27T08:18:58+02:00" } ], "responses": { "200": { "description": "Operation returns the list of loads from oldest to newest", "content": { "application/json": { "examples": { "Get load results": { "description": "Get load 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": 1, "statusCode": "STOP_OK", "message": "Search query successful", "results": [ { "correlationId": "29db33cc-990e-47df-ba4b-cc941145a798", "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, "netWeight": 141, "weightUOM": "KG", "requestedQuantity": 30, "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" } ] } ] }, "timestamp": 1723552384967 } ] } } } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "examples": { "Unauthorized": { "description": "Unauthorized", "value": { "error": "Unauthorized", "timestamp": "2025-05-26T11:22:37.0045933", "message": "Full authentication is required to access this resource", "status": 401, "path": "/lex-generic-3pl-api-outbound/v2/load" } }, "Not authenticated": { "value": { "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": "Forbidden", "value": { "error": "Forbidden", "timestamp": "2025-05-26T11:22:37.0045933", "message": "No subscription found for partnerId and event type LOAD", "status": 403, "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", "value": { "error": "Bad request", "timestamp": "2025-05-26T11:22:37.0045933", "message": "Check parameters", "status": 400, "path": "https://sandbox.api.michelin.com/mock-order-execution-outbound/v2/load" } } } } } }, "500": { "description": "Error while processing request", "content": { "application/json": { "examples": { "Internal server error": { "description": "Internal server error", "value": { "error": "Internal server error", "timestamp": "2025-05-26T11:22:37.0045933", "message": "Internal server error while processing the LOAD request for partnerId ", "status": 500, "path": "https://sandbox.api.michelin.com/mock-order-execution-outbound/v2/load" } } } } } } } } }, "-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" }, "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, "dimensionUOM": "MM" }, "timestamp": 1737384327838 } ] } } } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "examples": { "Unauthorized": { "description": "Unauthorized", "value": { "error": "Unauthorized", "timestamp": "2025-05-26T11:22:37.0045933", "message": "Full authentication is required to access this resource", "status": 401, "path": "/lex-generic-3pl-api-referential/v1/item" } }, "Not authenticated": { "value": { "path": "https://sandbox.api.michelin.com/mock-order-execution-outbound/v2/item" } } } } } }, "403": { "description": "Operation is not authorized: no subscription", "content": { "application/json": { "examples": { "Forbidden": { "description": "Forbidden", "value": { "error": "Forbidden", "timestamp": "2025-05-26T11:22:37.0045933", "message": "No subscription found for partnerId and event type ITEM", "status": 403, "path": "https://sandbox.api.michelin.com/mock-order-execution-outbound/v2/item" } } } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "examples": { "Bad request": { "description": "Bad request", "value": { "error": "Bad request", "timestamp": "2025-05-26T11:22:37.0045933", "message": "Check parameters", "status": 400, "path": "https://sandbox.api.michelin.com/mock-order-execution-outbound/v2/item" } } } } } }, "500": { "description": "Error while processing request", "content": { "application/json": { "examples": { "Internal server error": { "description": "Internal server error", "value": { "error": "Internal server error", "timestamp": "2025-05-26T11:22:37.0045933", "message": "Internal server error while processing the ITEM request for partnerId ", "status": 500, "path": "https://sandbox.api.michelin.com/mock-order-execution-outbound/v2/item" } } } } } } } } } }, "components": { "schemas": { "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" ] }, "SubInventoryTransferFrom3PLDto": { "type": "object", "description": " SubInventoryTransfer object", "properties": { "creationDateTime": { "type": "string", "format": "date-time", "description": "Creation Date Time of the event from the partner (UTC)" }, "source": { "type": "string", "description": "Source Application of the Data (ex: DHL)" }, "eventType": { "type": "string", "description": "Type of the event" }, "status": { "type": "string", "description": "Status of the sub inventory" }, "messageType": { "type": "string", "description": "condition Update : INVADJ-ADJ = Adjustment / INVADJ-STS = subInventory" }, "reasonNoteCode": { "type": "string", "description": "Reason Note code value (ex: LIBERATE, OLD...)" }, "fromStockOwner": { "type": "string", "description": "Source stock owner" }, "toStockOwner": { "type": "string", "description": "Target stock owner" }, "targetTransactionId": { "type": "string", "description": "Transaction ID as defined by the 3PL partner (to be used as key reference value between the system)" }, "lines": { "type": "array", "description": "Lines of the SubInventoryTransfer", "items": { "$ref": "#/components/schemas/SubInventoryTransferLineDto" } }, "extraData": { "type": "array", "description": "List of Key/Value to let share extra datas not included in the standard Model", "items": { "$ref": "#/components/schemas/ExtraDataDto" } } }, "required": [ "messageType", "targetTransactionId" ] }, "SubInventoryTransferLineDto": { "type": "object", "description": " SubInventoryTransfer Line 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": "ItemCode to identify the product" }, "itemType": { "type": "string", "description": "ItemType to identify the product" }, "updatedQuantity": { "type": "integer", "format": "int32", "description": "Changed quantity (can be negative)" }, "quantityUOM": { "type": "string", "description": "Quantity Unit Of Measure" }, "fromSubInventory": { "type": "string", "description": "Free Text to identify the SubInventory" }, "toSubInventory": { "type": "string", "description": "Free Text to identify the SubInventory" }, "eventDateTime": { "type": "string", "format": "date-time", "description": "Event Date Time (ISO 8601 format, any timezone offset to UTC+0 time)" }, "factoryStockOwner": { "type": "string", "description": "Production factory stock owner, Code DOT (3 char.) in CT2" }, "lotNumber": { "type": "string", "description": "lot identifier" }, "lotQuantity": { "type": "integer", "format": "int32", "description": "Quantity of this lot" } }, "required": [ "itemCode" ] }, "ShipFromLiteDto": { "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": "ShipFrom Name" } } }, "ShippedFrom3PLDto": { "type": "object", "description": "Shipped object", "properties": { "creationDateTime": { "type": "string", "format": "date-time", "description": "Creation Date Time of the event in LEX" }, "source": { "type": "string", "description": "System emitter of the message" }, "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 format, any timezone offset to UTC+0 time)" }, "requestedShippedDateTime": { "type": "string", "format": "date-time", "description": "Date when the goods should leave the warehouse (ISO 8601 format, any timezone offset to UTC+0 time)" }, "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/ShipFromLiteDto", "description": "The ship from object" }, "lines": { "type": "array", "description": "The shipped lines", "items": { "$ref": "#/components/schemas/ShippedFrom3PLLineDto" } }, "sealNumberList": { "type": "array", "description": "List of seal number", "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": [ "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" }, "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" }, "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)" }, "shipToLogisticSite": { "type": "string", "description": "Ship to logistic site" }, "factoryStockOwner": { "type": "string", "description": "Factory stock owner" }, "countryOfOrigin": { "type": "string", "description": "Item's country of origin" }, "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" ] }, "ContactDto": { "type": "object", "description": "Contact or team which are responsible of the export request creation", "properties": { "name": { "type": "string", "description": "Contact name" }, "code": { "type": "string", "description": "Contact code" }, "phone": { "type": "string", "description": "Contact phone number" }, "mail": { "type": "string", "description": "Contact mail" } } }, "ReceivedFrom3PLDto": { "type": "object", "description": "Received object", "properties": { "creationDateTime": { "type": "string", "format": "date-time", "description": "Creation Date Time of the event in LEX" }, "source": { "type": "string", "description": "System emitter of the message" }, "receivingId": { "type": "string", "description": "ID of the receiving (Should be the one given in the receiving event)" }, "sourceReceivingId": { "type": "string", "description": "ID of the receiving in the 3PL solution" }, "eventType": { "type": "string", "description": "Type of the event (ex: RECEIVED_CONFIRMATION)" }, "status": { "type": "string", "description": "Free Text for the status of the Received" }, "stockOwner": { "type": "string", "description": "Stock owner" }, "factoryStockOwner": { "type": "string", "description": "Production factory stock owner, Code DOT (3 char.) in CT2" }, "receptionDateTime": { "type": "string", "format": "date-time", "description": "Actual received date (ISO 8601 format, any timezone offset to UTC+0 time)" }, "requester": { "$ref": "#/components/schemas/RequesterDto", "description": "System source information about origin of export request creation" }, "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" } } }, "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" } }, "customerPONumber": { "type": "string", "description": "Customer PO number reference" }, "customerPOLineNumber": { "type": "string", "description": "Customer PO line number reference" }, "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" ] }, "RequesterDto": { "type": "object", "description": "System source information about origin of export request creation", "properties": { "name": { "type": "string", "description": "Name of requester" }, "code": { "type": "string", "description": "Code of requester" }, "id": { "type": "string", "description": "id of requester" }, "contact": { "$ref": "#/components/schemas/ContactDto", "description": "Contact or team which are responsible of the export request creation" } } }, "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" ] }, "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" } } }, "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 } } }, "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 InventoryOrganisation Code" }, "inventoryOrgName": { "type": "string", "description": "ShipFrom InventoryOrganisation Name" }, "inventoryOrgType": { "type": "string", "description": "ShipFrom InventoryOrganisation Type" }, "organisationCode": { "type": "string", "description": "ShipFrom Organisation Code" }, "organisationName": { "type": "string", "description": "ShipFrom Organisation 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" } } }, "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 InventoryOrganisation Code" }, "inventoryOrgName": { "type": "string", "description": "ShipTo InventoryOrganisation Name" }, "inventoryOrgType": { "type": "string", "description": "ShipTo InventoryOrganisation Type" }, "organisationCode": { "type": "string", "description": "ShipTo Organisation Code" }, "organisationName": { "type": "string", "description": "ShipTo Organisation 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" } } }, "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)" }, "shippingInstructions": { "type": "string", "description": "FreeText for shipping Instructions at header level" }, "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" }, "market": { "type": "string", "description": "OE or RT customer market code" }, "grossWeight": { "type": "number", "format": "double", "description": "Gross Weight of the product" }, "weightUOM": { "type": "string", "description": "Free Text to manage Unit Of Measure" }, "requestedQuantity": { "type": "integer", "format": "int32", "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 line Level" }, "customerInstructions": { "type": "string", "description": "FreeText for customer instructions at line 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" }, "serialNumberList": { "type": "array", "description": "List of serial numbers", "items": { "type": "string" } }, "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" }, "organisationCode": { "type": "string", "description": "CollectFrom Organisation Code" }, "organisationName": { "type": "string", "description": "CollectFrom Organisation 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": "integer", "format": "int32", "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" }, "extraDatas": { "type": "array", "description": "Free extra datas", "items": { "$ref": "#/components/schemas/ExtraDataDto" } } }, "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" }, "placeOfLoading": { "type": "string", "description": "The place of loading" }, "shippedDateTime": { "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)" }, "placeOfDischarge": { "type": "string", "description": "The place of discharge" }, "scheduledDeliveryDateTime": { "type": "string", "format": "date-time", "description": "Scheduled arrival date in destination WH with L/T (ISO format, UTC+0 time)" }, "shippingInstructions": { "type": "string", "description": "Instructions for the shipping" }, "routingInstructions": { "type": "string", "description": "Instructions for the routing" }, "customerName": { "type": "string", "description": "Name of the customer" }, "customerCode": { "type": "string", "description": "Code of the customer" }, "deliveryNoteNumber": { "type": "string", "description": "Delivery note number" }, "status": { "type": "string", "description": "Status of the receiving" }, "transport": { "$ref": "#/components/schemas/TransportDto", "description": "Transport" }, "transportUnit": { "$ref": "#/components/schemas/TransportUnitDto", "description": "TransportUnit" }, "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" } } } }, "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" }, "market": { "type": "string", "description": "Market target of the item (ex: 10)" }, "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": "integer", "format": "int32", "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" }, "sourceDeliveryId": { "type": "string", "description": "Id of delivery in the source system" }, "sourceDeliveryLineId": { "type": "string", "description": "Id of delivery line in the source system" }, "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" }, "serialNumberList": { "type": "array", "description": "Serial number of the items", "items": { "type": "string" } }, "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 } } }, "TransportDto": { "type": "object", "description": "Transport object", "properties": { "name": { "type": "string", "description": "Name of transport means" }, "code": { "type": "string", "description": "Code of transport means (e.g. imo code)" }, "codeType": { "type": "string", "description": "Type of transport code e.g. IMO, SCAC" }, "type": { "type": "string", "description": "Type of transport means (vessel, plane, train, truck)" }, "transportMode": { "type": "string", "description": "Transport mode (ocean, air, rail)" }, "incotermsCode": { "type": "string", "description": "Code of incoterms" }, "incotermsLocation": { "type": "string", "description": "Incoterms location" }, "shippingCompanyCode": { "type": "string", "description": "Code of maritime or air company" }, "shippingCompanyName": { "type": "string", "description": "Name of maritime or air company" }, "shippingCompanyNumber": { "type": "string", "description": "Number of maritime or air company" }, "shippingCompanyCountryCode": { "type": "string", "description": "Country code of maritime or air company" }, "scheduledShippingCompanyDepartureDateTime": { "type": "string", "format": "date-time", "description": "Scheduled shipping company departure date time (ISO format, UTC+0 time)" }, "carrierCode": { "type": "string", "description": "Carrier code" }, "carrierName": { "type": "string", "description": "Carrier name" }, "carrierService": { "type": "string", "description": "Carrier service" }, "freightForwarderCode": { "type": "string", "description": "Freight forwarder code for transport pricing classification" } } }, "TransportUnitDto": { "type": "object", "description": "TransportUnit object", "properties": { "id": { "type": "string", "description": "Id of the transport unit (ex: container id)" }, "equipmentType": { "type": "string", "description": "Type of the transport unit (ex: HC40)" }, "number": { "type": "string", "description": "Number of the transport unit (ex: container number)" }, "totalGrossWeight": { "type": "number", "format": "double", "description": "Sum of items gross weight for each transportUnit" }, "totalNetWeight": { "type": "number", "format": "double", "description": "Sum of items net weight for each transportUnit" }, "totalWeightUOM": { "type": "string", "description": "Unit of measure" }, "totalVolume": { "type": "string", "description": "Sum of items volume for each transportUnit" }, "totalVolumeUOM": { "type": "string", "description": "Unit of measure" }, "totalQuantity": { "type": "integer", "format": "int32", "description": "Sum of items quantity for all lines" }, "quantityUOM": { "type": "string", "description": "Unit of measure" } } }, "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" }, "transportMode": { "type": "string", "description": "Mode used for the transport (sea, air, rail, road...)" }, "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" }, "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": "integer", "format": "int32", "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)" }, "grossWeight": { "type": "number", "format": "double", "description": "Item gross weight" }, "netWeight": { "type": "number", "format": "double", "description": "Item net weight" }, "weightUOM": { "type": "string", "description": "Unit Of Measure for weight" }, "grossVolume": { "type": "number", "format": "double", "description": "Item gross volume" }, "netVolume": { "type": "number", "format": "double", "description": "Item net volume" }, "volumeUOM": { "type": "string", "description": "Unit Of Measure for volume" }, "length": { "type": "number", "format": "double", "description": "Item length" }, "width": { "type": "number", "format": "double", "description": "Item width" }, "height": { "type": "number", "format": "double", "description": "Item height" }, "dimensionUOM": { "type": "string", "description": "Unite Of Measure for dimension" }, "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" } } } }, "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" } } } }