{"asyncapi":"2.6.0","info":{"title":"3pl update events","version":"1.0.0","description":"Events related to 3pl for creation and update shipments"},"channels":{"logistics/parcel_tracked":{"subscribe":{"message":{"$ref":"#/components/messages/logisticsParcelTracked"}}},"logistics/logistics_parcel":{"subscribe":{"message":{"$ref":"#/components/messages/logisticsParcel"}}},"logistics/logistics_shipment_status_changed":{"subscribe":{"message":{"$ref":"#/components/messages/logisticsShipmentStatusChanged"}}}},"components":{"messages":{"logisticsParcelTracked":{"payload":{"type":"object","properties":{"data":{"type":"object","properties":{"shipment":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the shipment.","example":"e37e88a7-f8ca-4455-849d-5a4e875af602"},"externalId":{"type":"string","description":"The external ID of the shipment.","example":104575919}}},"statusMetaData":{"type":"object","properties":{"dimensions":{"type":"object","properties":{"width":{"type":"string","example":"1"},"height":{"type":"string","example":"1"},"length":{"type":"string","example":"1"},"volume":{"type":"string","example":"1"},"sizeUOM":{"type":"string","enum":["m"]}}},"sorted":{"type":"boolean"},"weight":{"type":"object","properties":{"value":{"type":"string","exaple":10},"weightUOM":{"type":"string","example":"gm"}}},"service":{"type":"string","example":"CHEX"},"location":{"type":"object","properties":{"address":{"type":"string","example":"PUDAHUEL"},"countryCode":{"type":"string","example":"CL"},"latitud":{"type":"string","example":"0.00000000"},"longitud":{"type":"string","example":"0.00000000"}}},"ETA":{"type":"string","format":"date","example":"29-06-2023"},"cost":{"type":"object","properties":{"value":{"type":"number","example":2000},"currency":{"type":"string","example":"CLP"}}},"proofs":{"type":"object","properties":{"photos":{"type":"array","description":"List of values.","items":{"type":"string","example":["link1","link1"]}}}},"signture":{"type":"object","properties":{"photos":{"type":"array","description":"List of values.","items":{"type":"string","example":["link1","link1"]}}}}}},"parcel":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the parcel.","example":"51af2141-fb6e-4d8b-be3e-086b551af525"},"externalId":{"type":"string","description":"The external ID of the parcel.","example":2164902910},"number":{"type":"string","description":"The number of the parcel.","example":2164902910},"statuses":{"type":"array","description":"List of parcel statuses, this the historical of changes statuses.","items":{"type":"object","properties":{"status":{"type":"string","description":"The status of the shipment.","example":"DELIVERED"},"eventTime":{"type":"string","format":"date-time","description":"The timestamp of the status event."},"subStatuses":{"type":"array","description":"List of sub-statuses or status of parcels.","items":{"type":"object","properties":{"status":{"type":"string","description":"The sub-status of the parcel.","example":"DELIVERED_001"},"eventTime":{"type":"string","format":"date-time","description":"The timestamp of the sub-status event."},"recipient":{"type":"object","properties":{"receiverName":{"type":"string","example":"Ravi"},"receiverId":{"type":"string","example":"5678"}}},"rawStatuses":{"type":"array","description":"List the information sent by the carrier.","items":{"type":"object","properties":{"status":{"type":"string","description":"Native carrier name of the status.","example":"ENTREGADO"},"customInfo":{"type":"array","description":"Extra information about the status.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the custom information."},"values":{"type":"array","description":"List of values.","items":{"type":"string","description":"The value."}},"type":{"type":"string","description":"The type of the custom information."}}}}}}}}}}}}}}},"eventId":{"type":"string","description":"Event id from pubsub.","example":"b2e54e6f-d26b-404f-a771-19826795fd47"},"eventType":{"type":"string","description":"Event name.","example":"LOGISTICS_PARCEL_TRACKED"},"entityType":{"type":"string","description":"The type of the entity.","example":"LogisticsShipment"},"timestamp":{"type":"string","format":"date-time","description":"The timestamp of the event.","example":"1683470016586"},"datetime":{"type":"string","format":"date-time","description":"The datetime of the event.","example":"2023-05-07T14:33:36.586Z"},"mimeType":{"type":"string","description":"The MIME type of the event.","example":"application/json"},"version":{"type":"string","description":"The version of the event.","example":1},"country":{"type":"string","description":"The country associated with the shipment.","enum":["PE","CL","CO"],"example":"CL"},"commerce":{"type":"string","description":"The commerce associated with the shipment.","example":"FALABELLA"},"channel":{"type":"string","description":"The channel associated with the shipment.","example":"LOGISTICS"},"domain":{"type":"string","description":"The domain associated with the shipment.","example":"SCHN"},"capability":{"type":"string","description":"The capability associated with the shipment.","example":"TRMG"},"entityId":{"type":"string","description":"The entityId associated with the shipment.","example":2164902910},"tenantId":{"type":"string","description":"Id for validate the flow of the event.","example":"b0ea9675-3486-4b11-868e-0d383856ed3f"},"parcelStatus":{"type":"string","description":"Global status of the shipment","example":"DELIVERED"},"parcelSubStatus":{"type":"string","description":"most recently status of the parcel/ only applies in single shipment","example":"DELIVERED_001"},"eventReferenceKey":{"type":"string","description":"label of the event"},"eventReferenceValue":{"type":"string"}}}}}},"logisticsParcel":{"payload":{"type":"object","properties":{"data":{"type":"object","properties":{"shipment":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the shipment.","example":"20e7c6cf-0c1e-4de9-82d5-4e880cad956d"},"externalId":{"type":"string","description":"The external ID of the shipment.","example":712657258132}}},"parcel":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the parcel.","example":"c91e0cfe-dad1-4d2c-937a-21afc204d365"},"externalId":{"type":"string","description":"The external ID of the parcel.","example":712657258143},"number":{"type":"string","description":"The number of the parcel.","example":"PKG000004VPT2"},"statuses":{"type":"array","description":"List of parcel statuses.","items":{"type":"object","properties":{"status":{"type":"string","description":"The status of the shipment.","example":"OUT_FOR_DELIVERY"},"eventTime":{"type":"string","format":"date-time","description":"The timestamp of the status event."},"subStatuses":{"type":"array","description":"List of sub-statuses/ this is the parcel status.","items":{"type":"object","properties":{"status":{"type":"string","description":"The sub-status of the parcel.","example":"OUT_FOR_DELIVERY_001"},"eventTime":{"type":"string","format":"date-time","description":"The timestamp of the sub-status event."},"rawStatuses":{"type":"array","description":"Carrier Native information.","items":{"type":"object","properties":{"status":{"type":"string","description":"The raw status of the parcel.","example":"PIEZA EN RUTA AL  DESTINATARIO"},"customInfo":{"type":"array","description":"Custom information about the status.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the custom information."},"values":{"type":"array","description":"List of values.","items":{"type":"string","description":"The value."}},"type":{"type":"string","description":"The type of the custom information."}}}}}}}}}}}}}}},"eventId":{"type":"string","description":"Event id from pubsub.","example":"b2e54e6f-d26b-404f-a771-19826795fd47"},"eventType":{"type":"string","description":"Event name.","example":"LOGISTICS_PARCEL_TRACKED"},"entityType":{"type":"string","description":"The type of the entity.","example":"LogisticsShipment"},"timestamp":{"type":"string","format":"date-time","description":"The timestamp of the event.","example":"1683470016586"},"datetime":{"type":"string","format":"date-time","description":"The datetime of the event.","example":"2023-05-07T14:33:36.586Z"},"mimeType":{"type":"string","description":"The MIME type of the event.","example":"application/json"},"version":{"type":"string","description":"The version of the event.","example":1},"country":{"type":"string","description":"The country associated with the shipment.","enum":["PE","CL","CO"],"example":"CL"},"commerce":{"type":"string","description":"The commerce associated with the shipment.","example":"FALABELLA"},"channel":{"type":"string","description":"The channel associated with the shipment.","example":"LOGISTICS"},"domain":{"type":"string","description":"The domain associated with the shipment.","example":"SCHN"},"capability":{"type":"string","description":"The capability associated with the shipment.","example":"TRMG"},"entityId":{"type":"string","description":"The entityId associated with the shipment.","example":2164902910},"tenantId":{"type":"string","description":"Id for validate the flow of the event.","example":"b0ea9675-3486-4b11-868e-0d383856ed3f"},"parcelStatus":{"type":"string","description":"Global status of the shipment","example":"DELIVERED"},"parcelSubStatus":{"type":"string","description":"most recently status of the parcel/ only applies in single shipment","example":"DELIVERED_001"},"eventReferenceKey":{"type":"string","description":"label of the event"},"eventReferenceValue":{"type":"string"}}}}}},"logisticsShipmentStatusChanged":{"payload":{"type":"object","properties":{"data":{"type":"object","properties":{"shipment":{"type":"string","description":"The ID of the shipment.","example":"3abebbb9-b79a-4870-b9c0-c53a73b9d444"},"status":{"type":"object","properties":{"status":{"type":"string","description":"The status of the shipment.","example":"DELIVERED"},"eventTime":{"type":"string","format":"date-time","description":"The timestamp of the status event."},"index":{"type":"integer","description":"The index of the status event.","example":1}}},"parcels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the parcel.","example":"a93c64ca-c572-4575-a7b2-07ec6ac4cbde"},"status":{"type":"string","description":"The status of the parcel.","example":"DELIVERED"},"index":{"type":"integer","description":"The index of the parcel.","example":13}}}},"history":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The status in the shipment history.","example":"CREATED"},"eventTime":{"type":"string","format":"date-time","description":"The timestamp of the status event in the shipment history."},"index":{"type":"integer","description":"The index of the status event in the shipment history.","example":0}}}},"statusMetaData":{"type":"object","properties":{"dimensions":{"type":"object","properties":{"width":{"type":"string","example":"1"},"height":{"type":"string","example":"1"},"length":{"type":"string","example":"1"},"volume":{"type":"string","example":"1"},"sizeUOM":{"type":"string","enum":["m"]}}},"sorted":{"type":"boolean"},"weight":{"type":"object","properties":{"value":{"type":"string","exaple":10},"weightUOM":{"type":"string","example":"gm"}}},"service":{"type":"string","example":"CHEX"},"location":{"type":"object","properties":{"address":{"type":"string","example":"PUDAHUEL"},"countryCode":{"type":"string","example":"CL"},"latitud":{"type":"string","example":"0.00000000"},"longitud":{"type":"string","example":"0.00000000"}}},"ETA":{"type":"string","format":"date","example":"29-06-2023"},"cost":{"type":"object","properties":{"value":{"type":"number","example":2000},"currency":{"type":"string","example":"CLP"}}},"proofs":{"type":"object","properties":{"photos":{"type":"array","description":"List of values.","items":{"type":"string","example":["link1","link1"]}}}},"signture":{"type":"object","properties":{"photos":{"type":"array","description":"List of values.","items":{"type":"string","example":["link1","link1"]}}}},"recipient":{"type":"object","properties":{"receiverName":{"type":"string","example":"Ravi"},"receiverId":{"type":"string","example":"5678"}}}}},"eventId":{"type":"string","description":"The ID of the event from pubsub.","example":"99af8e12-1020-4869-846c-65d523c4c46c"},"eventType":{"type":"string","description":"The type of the event.","example":"LOGISTICS_SHIPMENT_STATUS_CHANGED"},"entityType":{"type":"string","description":"The type of the entity.","example":"LogisticsShipment"},"timestamp":{"type":"string","format":"date-time","description":"The timestamp of the event.","example":"1683470016586"},"datetime":{"type":"string","format":"date-time","description":"The datetime of the event.","example":"2023-05-07T14:33:36.586Z"},"mimeType":{"type":"string","description":"The MIME type of the event.","example":"application/json"},"version":{"type":"string","description":"The version of the event.","example":0.1},"country":{"type":"string","description":"The country associated with the event.","enum":["PE","CL","CO"],"example":"PE"},"commerce":{"type":"string","description":"The commerce associated with the event.","example":"FALABELLA"},"channel":{"type":"string","description":"The channel associated with the event.","example":"LOGISTICS"},"domain":{"type":"string","description":"The domain associated with the event.","example":"SCHN"},"capability":{"type":"string","description":"The capability associated with the event.","example":"TRMG"},"entityId":{"type":"string","description":"The ID of the entity.","example":7485785952},"tenantId":{"type":"string","description":"The ID of the tenant.","example":"f6adf6a4-7d13-4485-87dd-f78d5997543c"},"eventReferenceKey":{"type":"string","description":"The reference key of the event."},"eventReferenceValue":{"type":"string","description":"The reference value of the event."}}}}}}}}}