burnbright/silvershop-dispatchit

Integration with New Zealand Couriers DispatchIT system.

2.1.0 2020-09-30 08:50 UTC

Requires

• silvershop/core: *
• silverstripe/cms: ~3.1
• silverstripe/framework: ~3.1

Replaces

• burnbright/silverstripe-shop-dispatchit: *

BSD-2-Clause

• Jeremy Shipman

• shop
• silverstripe
• dispatchit

README

Provides an endpoint for fetching files to use with a New Zealand Couriers printer.

Write a desktop script to call yoursite.com/dispatchitexporter, and then download everything from yoursite/assets/_dispatchitexports to the local folder for importing into dispatchit. This could be done via ssh connection. If you use this approach, it is recommended that you include .htaccess config to close the folder off from the web.

Alternatively, you can prevent writing output to the assets folder by adding the query param yoursite.com/dispatchitexporter?nofile=true.

Adding yoursite.com/dispatchitexporter?dryrun=true will both prevent files being written, and orders from being updated to mark them as having been exported for printing.

Authentication

Requests can be authenticated via Basic Auth, but Please Note: you should do basic auth over HTTPS to avoid authentication details from being snooped.

Create a new Member and add them to a Group with the permission "Access to address export API";

Authorise requests by providing the username and password credentials Basic Auth header.