Process Flow Trigger APIs¶

In some scenarios, the PPS operator process flow waits for external trigger(s) for some action. This section details such trigger APIs.

Warning

Having a synchronous external dependency in the process flow is not usually recommended because it can block the process flow and can cause a decrease in throughput.

Print Ready API¶

This API is useful for the cases when printing (e.g, invoice printing) for an order is done by a different system. This trigger endpoint can be used to notify GreyMatter that printing has been done and the process flow for that order/bin can resume.

POST /api-gateway/integration-service/wms-integration/butler/api/orders/print_ready/(externalServiceRequestId)¶

Request Headers:
	Content-Type – the request’s content-type has to be passed in this header Accept – the response content type depends on Accept header Authorization – OAuth token to authenticate
Parameters:	externalServiceRequestId (string) – `serviceRequest.externalServiceRequestId` which refers to the order.
Status Codes:	200 OK – Successful 404 Not Found – Service Request Id not found 400 Bad Request – Can be due to invalid order status

Example request:

POST /api-gateway/integration-service/wms-integration/butler/api/orders/print_ready/PICK-123 HTTP/1.1
Host: example.com
Content-Type: application/json
Accept: application/json, text/javascript

Example Response:

HTTP/1.1 200 OK