1 Action element
An action element is used as a callback for status changes during the actual production of an order. Currently it is possible to call specific URIs when a status change arises so that those events can be handled by the API user system properly. For that purpose the derrived action
StatusUriAction should be used.
1.1 Subtypes
1.1.1 StatusUriAction
Used when a specific URI should be called on a status change.
1.2 Status overview
- OrderArticle
- Cancelled: The order has been cancelled. This can be triggered by the customer or production side.
- Completed: The order has been completed. That means ordered, produced and shipped.
- PostProduction: The order has been printed and is now post processed, if the user requested a further processing.
- PrePoduction: The order is being prepared for printing. Print data is being checked and processed.
- Production: The order is currently in production.
- Shipment: The order item is currently being shipped. See detailed shipping stages under Shipment section.
- Payment
- Announced: The customer announced the payment. Can be used to speed up production for trustworthy customers.
- Overpaid: The customer paid too much.
- Paid: The customer has paid the order.
- Underpaid: The customer paid less than expected.
- Unpaid: The customer hasn't paid yet.
- PrintData
- CheckingData: The print data is currently being checked.
- DataDelivered: The customer has delivered new print data.
- DataReleased: The customer released print data that has been altered by the production.
- DataVerified: The print data has been successfully verified and can now be printed.
- Imposed: The print job has been imposed.
- ImpositionInProgress: The print job is currently being imposed.
- Printing: The print job is currently being printed.
- PrintingProof: A proof is being printed that needs to be confirmed by the customer before printing starts.
- ReadyForVerification: The print data is ready to be verified.
- WaitingForData: The production is currently waiting for new print data from the customer side.
- WaitingForProofRelease: The customer has to review and release the proof, so that the printing process can begin.
- Shipment
- NotShipped: The order has not been shipped yet.
- ReadyForShipment: The order is produced and now ready for shipment.
- Returned: The shipped package has returned to the sender. Can happen when the customer refuses to accept the package.
- Shipped: The order has been shipped and arrived at the shipping destination.
- Shipping: The order is currently being shipped.
1.3 Additional Features
When using the OrderArticle.Shipment status you can make use of additional parameters in your callback URI.
- $TrackingNumbers$ - Comma separated list of trackingnumbers
- $ShipmentProvider$ - Shipment provider shortcut (UPS, DHL etc.)
- $TrackingLink$ - Link to providers website to get a detailed tracking report, if supported by the provider
Those parameters can be placed anywhere in the URI and will be evaluated upon calling the URI.
1.3.1 Example
Callback URI provider by the API user:
http://host.com/statuscallback?provider=$ShipmentProvider$&number=$TrackingNumbers$&uri=$TrackingLink$
Will be evaluated upon calling the Callback URI to:
http://host.de/statuscallback?provider=UPS&number=1Z8F42W06892286440&uri=http%3a%2f%2fwwwapps.ups.com%2fWebTracking%2fprocessInputRequest%3fTypeOfInquiryNumber%3dT%26InquiryNumber1%3d1Z8F42W06892286440
1.4 Elements
| Name | Type | Datatype | Example | Default | Description |
|---|
| StatusType
| required
| string
| OrderArticle
| -
| Type of status.
|
| | OrderArticle: General status for an order item.
|
| | Payment: Status handling payment events.
|
| | PrintData: Status for data verification and other print data related events.
|
| | Shipment: Status to handle shipping events.
|
| Key
| required
| string
| Production
| -
| Status that needs to be tracked.
|
| Value
| required
| string
| -
| -
| URI that should be called when the requested status changes.
|
1.5 Example
XML:
<Action xsi:type="StatusUriAction">
<StatusType>OrderArticle</StatusType>
<Key>Shipment</Key>
<Value><![CDATA[http://userportal.com/CallMeWhenTheOrderIsShipping.php]]></Value>
</Action>