> For the complete documentation index, see [llms.txt](https://docs.fulfillmenttools.com/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fulfillmenttools.com/documentation/by-pillar/order-management/order-event-history/process-history-log-endpoints.md).
# Process history log endpoints
## The ProcessHistoryLog object
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessHistoryLog":{"allOf":[{"$ref":"#/components/schemas/ProcessHistoryLogBase"}],"properties":{"eventType":{"$ref":"#/components/schemas/ProcessHistoryEventType"},"payload":{"description":"Payload varies based on eventType","nullable":true,"oneOf":[{"$ref":"#/components/schemas/RerouteLogPayload"},{"$ref":"#/components/schemas/RerouteLogPayloadBase"},{"$ref":"#/components/schemas/OrderCancellationPayload"},{"$ref":"#/components/schemas/OrderModificationPayloadBase"},{"$ref":"#/components/schemas/ConsumerAddressModifiedLogPayload"},{"$ref":"#/components/schemas/OrderModificationPreferredHandlingTimePayload"},{"$ref":"#/components/schemas/StatusReasonsPayload"},{"$ref":"#/components/schemas/OrderLineItemModifiedLogPayload"},{"$ref":"#/components/schemas/OperativeEntityPayloadBase"},{"$ref":"#/components/schemas/ExternalActionHistoryLogPayload"},{"$ref":"#/components/schemas/ParcelLabelCreationFailedPayload"},{"$ref":"#/components/schemas/OperativeEntityPickingDoneIncompletePayload"},{"$ref":"#/components/schemas/ReturnManagementPayloadBase"}],"type":"object"}},"required":["eventType"],"title":"ProcessHistoryLog","description":"ProcessHistoryLog"},"ProcessHistoryLogBase":{"properties":{"domain":{"$ref":"#/components/schemas/ProcessHistoryDomainType"},"domainRef":{"type":"string"},"eventCause":{"type":"string"},"id":{"type":"string"},"status":{"description":"Status can be OrderStatus, PickJobStatus, PackJobStatus, ParcelStatus, HandoverjobStatus, RoutingPlanStatus, ShipmentStatus, ItemReturnJobStatus or null","nullable":true,"type":"string"},"timestamp":{"description":"Timestamp of the moment at which this log entry was created.","format":"date-time","type":"string"},"type":{"description":"Can be ProcessHistoryLogTypeCommon or user-defined action type","type":"string"},"user":{"$ref":"#/components/schemas/ProcessHistoryLogUser"},"version":{"nullable":true,"type":"number"},"info":{"type":"string"}},"required":["id","type","domain","status","domainRef","version","user","timestamp"],"type":"object","title":"ProcessHistoryLogBase","description":"ProcessHistoryLogBase"},"ProcessHistoryDomainType":{"description":"The domain type of the process history entry","enum":["ORDER","ORDER_MODIFICATION","PICKJOB","PACKJOB","SERVICEJOB","PARCEL","HANDOVER","ROUTING_PLAN","EXTERNAL_ACTION","SHIPMENT","ITEM_RETURN"],"type":"string","title":"ProcessHistoryDomainType"},"ProcessHistoryLogUser":{"properties":{"username":{"type":"string"},"userRef":{"type":"string"}},"required":["userRef","username"],"type":"object","title":"ProcessHistoryLogUser","description":"ProcessHistoryLogUser"},"ProcessHistoryEventType":{"description":"Event types for process history","enum":["ORDER_CREATED","LOCKED_ORDER_CREATED","DELIVERY_PROMISE_CREATED","ORDER_CANCELLED","ORDER_FORCE_CANCELLED","ORDER_UNLOCKED","ORDER_CREATED_FROM_PROMISE","ORDER_MANUAL_REROUTE","UNROUTABLE_ITEMS_REROUTE","REROUTE_FAILED","ORDER_MANUAL_FACILITY_ASSIGNMENT","ORDER_TIME_TRIGGERED_REROUTE","ORDER_HAS_UNROUTABLE_ITEMS","ORDER_INACTIVITY_TIME_TRIGGERED_REROUTE","TASK_MANUAL_REROUTE","ORDER_MODIFICATION_REROUTE","PICKING_DONE_INCOMPLETE_REROUTE","CONSUMER_ADDRESS_CHANGED","ORDER_ITEM_AMOUNT_CHANGED","ORDER_ITEM_DELETED","ORDER_ITEM_ADDED","ORDER_PREFERRED_DATE_MODIFIED","OPERATIVE_TASK_CREATED","PICKING_IN_PROGRESS","PICKING_PAUSED","PICKING_DONE","PICKING_DONE_INCOMPLETE","PICKING_ABORTED_NO_ITEMS_PICKED","PICKING_RESET","PICKING_RESTART","PICKING_CANCELLED","PACKING_CREATED","PACKING_IN_PROGRESS","PACKING_DONE","PARCEL_CREATED","PARCEL_LABEL_REQUESTED","PARCEL_LABEL_CREATION_FAILED","HANDOVER_CREATED","HANDOVER_DONE","HANDOVER_DONE_WITH_REFUSED_ITEMS","HANDOVER_CANCELED","SERVICEJOB_CREATED","SERVICEJOB_IN_PROGRESS","SERVICEJOB_DONE","SERVICEJOB_CANCELED","ACTION_TRIGGERED","COMMENT_ADDED","RETURN_ANNOUNCED","RETURN_CANCELED","RETURN_FINISHED","REFUND_TRIGGERED"],"type":"string","title":"ProcessHistoryEventType"},"RerouteLogPayload":{"properties":{"rerouteDescription":{"$ref":"#/components/schemas/RerouteDescriptionHistoryLog"},"targetFacility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"}},"required":["targetFacility"],"type":"object","title":"RerouteLogPayload","description":"RerouteLogPayload"},"RerouteDescriptionHistoryLog":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"id":{"type":"string"},"reason":{"type":"string"},"version":{"type":"number"}},"required":["id","version"],"type":"object","title":"RerouteDescriptionHistoryLog","description":"RerouteDescriptionHistoryLog"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ProcessHistoryLogFacility":{"properties":{"facilityGroups":{"items":{"$ref":"#/components/schemas/ProcessHistoryLogFacilityGroup"},"type":"array"},"facilityRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"type":"object","title":"ProcessHistoryLogFacility","description":"ProcessHistoryLogFacility"},"ProcessHistoryLogFacilityGroup":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"facilityGroupRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"required":["facilityGroupRef","version","nameLocalized"],"type":"object","title":"ProcessHistoryLogFacilityGroup","description":"ProcessHistoryLogFacilityGroup"},"RerouteLogPayloadBase":{"properties":{"rerouteDescription":{"$ref":"#/components/schemas/RerouteDescriptionHistoryLog"}},"type":"object","title":"RerouteLogPayloadBase","description":"RerouteLogPayloadBase"},"OrderCancellationPayload":{"properties":{"cancelationReason":{"$ref":"#/components/schemas/CancelationReasonHistoryLog"}},"type":"object","title":"OrderCancellationPayload","description":"OrderCancellationPayload"},"CancelationReasonHistoryLog":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"id":{"type":"string"},"reason":{"type":"string"},"version":{"type":"number"}},"required":["id","version"],"type":"object","title":"CancelationReasonHistoryLog","description":"CancelationReasonHistoryLog"},"OrderModificationPayloadBase":{"properties":{"reason":{"type":"string"}},"type":"object","title":"OrderModificationPayloadBase","description":"OrderModificationPayloadBase"},"ConsumerAddressModifiedLogPayload":{"properties":{"changes":{"description":"List of address changes","items":{"$ref":"#/components/schemas/ConsumerAddressModifiedLogEntry"},"type":"array"}},"type":"object","title":"ConsumerAddressModifiedLogPayload","description":"ConsumerAddressModifiedLogPayload"},"ConsumerAddressModifiedLogEntry":{"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"changedFields":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"ConsumerAddressModifiedLogEntry","description":"ConsumerAddressModifiedLogEntry"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"OrderModificationPreferredHandlingTimePayload":{"allOf":[{"$ref":"#/components/schemas/OrderModificationPayloadBase"}],"properties":{"newPreferredHandlingTime":{"description":"Updated preferredHandlingTime value","format":"date-time","nullable":true,"type":"string"},"previousPreferredHandlingTime":{"description":"preferredHandlingTime value before an update","format":"date-time","nullable":true,"type":"string"}},"required":["previousPreferredHandlingTime","newPreferredHandlingTime"],"title":"OrderModificationPreferredHandlingTimePayload","description":"OrderModificationPreferredHandlingTimePayload"},"StatusReasonsPayload":{"properties":{"statusReason":{"allOf":[{"$ref":"#/components/schemas/OrderStatusReasonLog"}],"description":"Reason for the status change","type":"object"}},"type":"object","title":"StatusReasonsPayload","description":"StatusReasonsPayload"},"OrderStatusReasonLog":{"properties":{"reason":{"type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"type":"object","title":"OrderStatusReasonLog","description":"OrderStatusReasonLog"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"OrderLineItemModifiedLogPayload":{"allOf":[{"$ref":"#/components/schemas/OrderModificationPayloadBase"}],"properties":{"articles":{"description":"List of modified articles","items":{"$ref":"#/components/schemas/ArticleHistoryLog"},"type":"array"}},"title":"OrderLineItemModifiedLogPayload","description":"OrderLineItemModifiedLogPayload"},"ArticleHistoryLog":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"measurementUnit":{"properties":{"abbreviationLocalized":{"$ref":"#/components/schemas/LocaleString"}},"type":"object"},"newQuantity":{"type":"number"},"previousQuantity":{"type":"number"},"title":{"type":"string"}},"required":["title"],"type":"object","title":"ArticleHistoryLog","description":"ArticleHistoryLog"},"OperativeEntityPayloadBase":{"properties":{"facility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"},"shortId":{"type":"string"}},"required":["facility"],"type":"object","title":"OperativeEntityPayloadBase","description":"OperativeEntityPayloadBase"},"ExternalActionHistoryLogPayload":{"properties":{"groups":{"items":{"type":"string"},"type":"array"}},"required":["groups"],"type":"object","title":"ExternalActionHistoryLogPayload","description":"ExternalActionHistoryLogPayload"},"ParcelLabelCreationFailedPayload":{"allOf":[{"$ref":"#/components/schemas/OperativeEntityPayloadBase"}],"properties":{"errorMessage":{"type":"string"}},"required":["errorMessage"],"type":"object","title":"ParcelLabelCreationFailedPayload","description":"ParcelLabelCreationFailedPayload"},"OperativeEntityPickingDoneIncompletePayload":{"allOf":[{"$ref":"#/components/schemas/OperativeEntityPayloadBase"}],"properties":{"shortPickedItems":{"items":{"$ref":"#/components/schemas/OperativeEntityShortPickedItem"},"type":"array"}},"title":"OperativeEntityPickingDoneIncompletePayload","description":"OperativeEntityPickingDoneIncompletePayload"},"OperativeEntityShortPickedItem":{"properties":{"article":{"$ref":"#/components/schemas/ArticleHistoryLog"},"picked":{"type":"number"},"quantity":{"type":"number"},"shortPickReason":{"$ref":"#/components/schemas/PickLineShortPickReason"}},"required":["article","picked","quantity"],"type":"object","title":"OperativeEntityShortPickedItem","description":"OperativeEntityShortPickedItem"},"PickLineShortPickReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Localized reason"},"reason":{"description":"translated reasonLocalized according to the given locale","type":"string"}},"required":["reasonLocalized"],"title":"PickLineShortPickReason","description":"PickLineShortPickReason"},"ReturnManagementPayloadBase":{"properties":{"facility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"},"itemReturnJobsRef":{"type":"string"},"shortId":{"type":"string"}},"type":"object","title":"ReturnManagementPayloadBase","description":"ReturnManagementPayloadBase"}}}}
```
## Get process history logs
> This part of the API is in Beta status. For details, see the \API release lifecycle documentation\.\
\
Return all logs for a given process.
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"A process groups all entities of an order.","name":"Processes"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ProcessHistoryLogSort":{"description":"Attribute to order a process history log by","enum":["TIMESTAMP_DESC","TIMESTAMP_ASC","INFO_DESC","INFO_ASC","TYPE_ASC","TYPE_DESC","USERNAME_DESC","USERNAME_ASC","FACILITY_NAME_DESC","FACILITY_NAME_ASC"],"type":"string","xml":{"name":"ProcessHistoryLogSort"},"title":"ProcessHistoryLogSort"},"ProcessHistoryLogs":{"properties":{"historyLogs":{"items":{"$ref":"#/components/schemas/ProcessHistoryLog"},"maxItems":500,"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"type":"object","title":"ProcessHistoryLogs","description":"ProcessHistoryLogs"},"ProcessHistoryLog":{"allOf":[{"$ref":"#/components/schemas/ProcessHistoryLogBase"}],"properties":{"eventType":{"$ref":"#/components/schemas/ProcessHistoryEventType"},"payload":{"description":"Payload varies based on eventType","nullable":true,"oneOf":[{"$ref":"#/components/schemas/RerouteLogPayload"},{"$ref":"#/components/schemas/RerouteLogPayloadBase"},{"$ref":"#/components/schemas/OrderCancellationPayload"},{"$ref":"#/components/schemas/OrderModificationPayloadBase"},{"$ref":"#/components/schemas/ConsumerAddressModifiedLogPayload"},{"$ref":"#/components/schemas/OrderModificationPreferredHandlingTimePayload"},{"$ref":"#/components/schemas/StatusReasonsPayload"},{"$ref":"#/components/schemas/OrderLineItemModifiedLogPayload"},{"$ref":"#/components/schemas/OperativeEntityPayloadBase"},{"$ref":"#/components/schemas/ExternalActionHistoryLogPayload"},{"$ref":"#/components/schemas/ParcelLabelCreationFailedPayload"},{"$ref":"#/components/schemas/OperativeEntityPickingDoneIncompletePayload"},{"$ref":"#/components/schemas/ReturnManagementPayloadBase"}],"type":"object"}},"required":["eventType"],"title":"ProcessHistoryLog","description":"ProcessHistoryLog"},"ProcessHistoryLogBase":{"properties":{"domain":{"$ref":"#/components/schemas/ProcessHistoryDomainType"},"domainRef":{"type":"string"},"eventCause":{"type":"string"},"id":{"type":"string"},"status":{"description":"Status can be OrderStatus, PickJobStatus, PackJobStatus, ParcelStatus, HandoverjobStatus, RoutingPlanStatus, ShipmentStatus, ItemReturnJobStatus or null","nullable":true,"type":"string"},"timestamp":{"description":"Timestamp of the moment at which this log entry was created.","format":"date-time","type":"string"},"type":{"description":"Can be ProcessHistoryLogTypeCommon or user-defined action type","type":"string"},"user":{"$ref":"#/components/schemas/ProcessHistoryLogUser"},"version":{"nullable":true,"type":"number"},"info":{"type":"string"}},"required":["id","type","domain","status","domainRef","version","user","timestamp"],"type":"object","title":"ProcessHistoryLogBase","description":"ProcessHistoryLogBase"},"ProcessHistoryDomainType":{"description":"The domain type of the process history entry","enum":["ORDER","ORDER_MODIFICATION","PICKJOB","PACKJOB","SERVICEJOB","PARCEL","HANDOVER","ROUTING_PLAN","EXTERNAL_ACTION","SHIPMENT","ITEM_RETURN"],"type":"string","title":"ProcessHistoryDomainType"},"ProcessHistoryLogUser":{"properties":{"username":{"type":"string"},"userRef":{"type":"string"}},"required":["userRef","username"],"type":"object","title":"ProcessHistoryLogUser","description":"ProcessHistoryLogUser"},"ProcessHistoryEventType":{"description":"Event types for process history","enum":["ORDER_CREATED","LOCKED_ORDER_CREATED","DELIVERY_PROMISE_CREATED","ORDER_CANCELLED","ORDER_FORCE_CANCELLED","ORDER_UNLOCKED","ORDER_CREATED_FROM_PROMISE","ORDER_MANUAL_REROUTE","UNROUTABLE_ITEMS_REROUTE","REROUTE_FAILED","ORDER_MANUAL_FACILITY_ASSIGNMENT","ORDER_TIME_TRIGGERED_REROUTE","ORDER_HAS_UNROUTABLE_ITEMS","ORDER_INACTIVITY_TIME_TRIGGERED_REROUTE","TASK_MANUAL_REROUTE","ORDER_MODIFICATION_REROUTE","PICKING_DONE_INCOMPLETE_REROUTE","CONSUMER_ADDRESS_CHANGED","ORDER_ITEM_AMOUNT_CHANGED","ORDER_ITEM_DELETED","ORDER_ITEM_ADDED","ORDER_PREFERRED_DATE_MODIFIED","OPERATIVE_TASK_CREATED","PICKING_IN_PROGRESS","PICKING_PAUSED","PICKING_DONE","PICKING_DONE_INCOMPLETE","PICKING_ABORTED_NO_ITEMS_PICKED","PICKING_RESET","PICKING_RESTART","PICKING_CANCELLED","PACKING_CREATED","PACKING_IN_PROGRESS","PACKING_DONE","PARCEL_CREATED","PARCEL_LABEL_REQUESTED","PARCEL_LABEL_CREATION_FAILED","HANDOVER_CREATED","HANDOVER_DONE","HANDOVER_DONE_WITH_REFUSED_ITEMS","HANDOVER_CANCELED","SERVICEJOB_CREATED","SERVICEJOB_IN_PROGRESS","SERVICEJOB_DONE","SERVICEJOB_CANCELED","ACTION_TRIGGERED","COMMENT_ADDED","RETURN_ANNOUNCED","RETURN_CANCELED","RETURN_FINISHED","REFUND_TRIGGERED"],"type":"string","title":"ProcessHistoryEventType"},"RerouteLogPayload":{"properties":{"rerouteDescription":{"$ref":"#/components/schemas/RerouteDescriptionHistoryLog"},"targetFacility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"}},"required":["targetFacility"],"type":"object","title":"RerouteLogPayload","description":"RerouteLogPayload"},"RerouteDescriptionHistoryLog":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"id":{"type":"string"},"reason":{"type":"string"},"version":{"type":"number"}},"required":["id","version"],"type":"object","title":"RerouteDescriptionHistoryLog","description":"RerouteDescriptionHistoryLog"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ProcessHistoryLogFacility":{"properties":{"facilityGroups":{"items":{"$ref":"#/components/schemas/ProcessHistoryLogFacilityGroup"},"type":"array"},"facilityRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"type":"object","title":"ProcessHistoryLogFacility","description":"ProcessHistoryLogFacility"},"ProcessHistoryLogFacilityGroup":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"facilityGroupRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"required":["facilityGroupRef","version","nameLocalized"],"type":"object","title":"ProcessHistoryLogFacilityGroup","description":"ProcessHistoryLogFacilityGroup"},"RerouteLogPayloadBase":{"properties":{"rerouteDescription":{"$ref":"#/components/schemas/RerouteDescriptionHistoryLog"}},"type":"object","title":"RerouteLogPayloadBase","description":"RerouteLogPayloadBase"},"OrderCancellationPayload":{"properties":{"cancelationReason":{"$ref":"#/components/schemas/CancelationReasonHistoryLog"}},"type":"object","title":"OrderCancellationPayload","description":"OrderCancellationPayload"},"CancelationReasonHistoryLog":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"id":{"type":"string"},"reason":{"type":"string"},"version":{"type":"number"}},"required":["id","version"],"type":"object","title":"CancelationReasonHistoryLog","description":"CancelationReasonHistoryLog"},"OrderModificationPayloadBase":{"properties":{"reason":{"type":"string"}},"type":"object","title":"OrderModificationPayloadBase","description":"OrderModificationPayloadBase"},"ConsumerAddressModifiedLogPayload":{"properties":{"changes":{"description":"List of address changes","items":{"$ref":"#/components/schemas/ConsumerAddressModifiedLogEntry"},"type":"array"}},"type":"object","title":"ConsumerAddressModifiedLogPayload","description":"ConsumerAddressModifiedLogPayload"},"ConsumerAddressModifiedLogEntry":{"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"changedFields":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"ConsumerAddressModifiedLogEntry","description":"ConsumerAddressModifiedLogEntry"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"OrderModificationPreferredHandlingTimePayload":{"allOf":[{"$ref":"#/components/schemas/OrderModificationPayloadBase"}],"properties":{"newPreferredHandlingTime":{"description":"Updated preferredHandlingTime value","format":"date-time","nullable":true,"type":"string"},"previousPreferredHandlingTime":{"description":"preferredHandlingTime value before an update","format":"date-time","nullable":true,"type":"string"}},"required":["previousPreferredHandlingTime","newPreferredHandlingTime"],"title":"OrderModificationPreferredHandlingTimePayload","description":"OrderModificationPreferredHandlingTimePayload"},"StatusReasonsPayload":{"properties":{"statusReason":{"allOf":[{"$ref":"#/components/schemas/OrderStatusReasonLog"}],"description":"Reason for the status change","type":"object"}},"type":"object","title":"StatusReasonsPayload","description":"StatusReasonsPayload"},"OrderStatusReasonLog":{"properties":{"reason":{"type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"type":"object","title":"OrderStatusReasonLog","description":"OrderStatusReasonLog"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"OrderLineItemModifiedLogPayload":{"allOf":[{"$ref":"#/components/schemas/OrderModificationPayloadBase"}],"properties":{"articles":{"description":"List of modified articles","items":{"$ref":"#/components/schemas/ArticleHistoryLog"},"type":"array"}},"title":"OrderLineItemModifiedLogPayload","description":"OrderLineItemModifiedLogPayload"},"ArticleHistoryLog":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"measurementUnit":{"properties":{"abbreviationLocalized":{"$ref":"#/components/schemas/LocaleString"}},"type":"object"},"newQuantity":{"type":"number"},"previousQuantity":{"type":"number"},"title":{"type":"string"}},"required":["title"],"type":"object","title":"ArticleHistoryLog","description":"ArticleHistoryLog"},"OperativeEntityPayloadBase":{"properties":{"facility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"},"shortId":{"type":"string"}},"required":["facility"],"type":"object","title":"OperativeEntityPayloadBase","description":"OperativeEntityPayloadBase"},"ExternalActionHistoryLogPayload":{"properties":{"groups":{"items":{"type":"string"},"type":"array"}},"required":["groups"],"type":"object","title":"ExternalActionHistoryLogPayload","description":"ExternalActionHistoryLogPayload"},"ParcelLabelCreationFailedPayload":{"allOf":[{"$ref":"#/components/schemas/OperativeEntityPayloadBase"}],"properties":{"errorMessage":{"type":"string"}},"required":["errorMessage"],"type":"object","title":"ParcelLabelCreationFailedPayload","description":"ParcelLabelCreationFailedPayload"},"OperativeEntityPickingDoneIncompletePayload":{"allOf":[{"$ref":"#/components/schemas/OperativeEntityPayloadBase"}],"properties":{"shortPickedItems":{"items":{"$ref":"#/components/schemas/OperativeEntityShortPickedItem"},"type":"array"}},"title":"OperativeEntityPickingDoneIncompletePayload","description":"OperativeEntityPickingDoneIncompletePayload"},"OperativeEntityShortPickedItem":{"properties":{"article":{"$ref":"#/components/schemas/ArticleHistoryLog"},"picked":{"type":"number"},"quantity":{"type":"number"},"shortPickReason":{"$ref":"#/components/schemas/PickLineShortPickReason"}},"required":["article","picked","quantity"],"type":"object","title":"OperativeEntityShortPickedItem","description":"OperativeEntityShortPickedItem"},"PickLineShortPickReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Localized reason"},"reason":{"description":"translated reasonLocalized according to the given locale","type":"string"}},"required":["reasonLocalized"],"title":"PickLineShortPickReason","description":"PickLineShortPickReason"},"ReturnManagementPayloadBase":{"properties":{"facility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"},"itemReturnJobsRef":{"type":"string"},"shortId":{"type":"string"}},"type":"object","title":"ReturnManagementPayloadBase","description":"ReturnManagementPayloadBase"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/processes/{processId}/historylogs":{"get":{"description":"This part of the API is in Beta status. For details, see the API release lifecycle documentation.
Return all logs for a given process.","operationId":"getProcessHistoryLogs","parameters":[{"in":"path","name":"processId","required":true,"schema":{"type":"string"}},{"description":"A type parameter for filtering history logs","in":"query","name":"type","required":false,"schema":{"type":"string"}},{"description":"Reference to the username you want to get the corresponding history logs","in":"query","name":"username","required":false,"schema":{"type":"string"}},{"description":"Reference to the facility name you want to get the corresponding history logs","in":"query","name":"facilityName","required":false,"schema":{"type":"string"}},{"description":"all entities after given Id","in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}},{"description":"number of entities to show","in":"query","name":"size","required":false,"schema":{"default":25,"type":"integer"}},{"description":"query process history log orderBy","in":"query","name":"orderBy","required":false,"schema":{"$ref":"#/components/schemas/ProcessHistoryLogSort"}},{"description":"control whether you want to filter consecutive duplicate logs","in":"query","name":"filterConsecutiveDuplicates","required":false,"schema":{"default":true,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessHistoryLogs"}}},"description":"The process logs which were found in response body"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Get process history logs","tags":["Processes"]}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.fulfillmenttools.com/documentation/by-pillar/order-management/order-event-history/process-history-log-endpoints.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.