# Gophr Documentation

> Comprehensive documentation for the Gophr Commercial API V2

## Guides
- [Environments](https://developers.gophr.com/docs/environments.md)
- [Authentication](https://developers.gophr.com/docs/authorisation.md)
- [Addresses](https://developers.gophr.com/docs/addresses.md)
- [Vehicle Types](https://developers.gophr.com/docs/vehicle-types.md)
- [Cancelling a Job](https://developers.gophr.com/docs/cancelling-a-job.md)
- [Updating a Delivery](https://developers.gophr.com/docs/updating-a-delivery.md)
- [Generate a Label](https://developers.gophr.com/docs/updating-a-delivery-copy.md)
- [Cancelling a Delivery](https://developers.gophr.com/docs/cancelling-a-delivery.md)
- [Webhooks](https://developers.gophr.com/docs/webhooks.md)
- [Returns and Failed Deliveries](https://developers.gophr.com/docs/returns-and-failed-deliveries.md)
- [Gophr Shopify App](https://developers.gophr.com/docs/gophr-shopify-app.md)

## API Reference
- [Get a Job](https://developers.gophr.com/reference/get-jobs-job_id.md): Get the details of a job with the id equal to the job_id passed in the URL.
- [Update a Job](https://developers.gophr.com/reference/patch-jobs-job_id.md): Allows a job to be updated to confirmed.
- [List Jobs](https://developers.gophr.com/reference/get-job.md): Get all jobs associated with the currently authenticated user.
- [Cancel a Job](https://developers.gophr.com/reference/post-jobs-job_id-cancel.md): Allows a job to be cancelled.
- [Create a Job](https://developers.gophr.com/reference/post-job-1.md): This endpoint allows you to create a job with a single pickup point and multiple drop off locations.
- [Create a Delivery](https://developers.gophr.com/reference/post-jobs-job_id-deliveries.md): This endpoint allows you to add a delivery to an existing job. The delivery consists of a pickup, dropoff and collection of parcels. **Note that adding deliveries to a job is not allowed once the job has been confirmed.**
- [List Deliveries](https://developers.gophr.com/reference/get-jobs-job_id-deliveries.md): This endpoint allows you to get a list of deliveries for a given job.
- [Get Delivery](https://developers.gophr.com/reference/get-jobs-job_id-deliveries-delivery_id.md): Get the detasils of a job delivery.
- [Update a Delivery](https://developers.gophr.com/reference/patch-jobs-job_id-deliveries-delivery_id.md): This endpoint allows you to update a delivery. All delivery fields can be updated while the job is in draft. You can continue updating certain fields after the job has been confirmed, as long as these updates do not affect the quote. This flexibility extends until the courier is at the delivery location. For more info check the **Updating a Delivery** page in the documentation
- [Cancel A Delivery](https://developers.gophr.com/reference/post-jobs-job_id-deliveries-delivery_id-cancel.md): Returns cancelation cost. **Note that cancelling deliveries is not allowed once the job has been confirmed.**
- [Generate a Label](https://developers.gophr.com/reference/post-jobs-job_id-deliveries-delivery_id-label.md): Returns label url.
- [List Parcels](https://developers.gophr.com/reference/get-jobs-job_id-deliveries-delivery_id-parcels-2.md): Returns a collection of parcels for the given delivery.
- [Create a Parcel](https://developers.gophr.com/reference/post-jobs-job_id-deliveries-delivery_id-parcels-2.md): Creates a parcel for the given delivery. **Note that adding parcels to a delivery is not allowed once the job has been confirmed.**
- [Get a Parcel](https://developers.gophr.com/reference/get-jobs-job_id-deliveries-delivery_id-parcels-parcel_id-2.md): Get the details of a given parcel.
- [Update a Parcel](https://developers.gophr.com/reference/patch-jobs-job_id-deliveries-delivery_id-parcels-parcel_id-2.md): Allows you to update a parcel. **Note that updating parcels is not allowed once the job has been confirmed.**
- [Delete a Parcel](https://developers.gophr.com/reference/delete-jobs-job_id-deliveries-delivery_id-parcels-parcel_id-2.md): Remove a parcel from a delivery. If the parcel count is  0 after deletion then the delivery will be cancelled. **Note that deleting parcels is not allowed once the job has been confirmed.**
- [Progress Delivery Status](https://developers.gophr.com/reference/post-jobs-job_id-progress-2.md): **This endpoint is for testing purposes only!**    Progress the status of a delivery.
- [Get a Quote](https://developers.gophr.com/reference/post-quotes-2.md): Endpoint returns a new quote for the given parameters.

## Recipes
- [Add Delivery To Job](https://developers.gophr.com/recipes/add-delivery-to-job.md)
- [Cancel A Delivery](https://developers.gophr.com/recipes/cancel-a-delivery.md)
- [Cancel A Job](https://developers.gophr.com/recipes/cancel-a-job.md)
- [Confirm A Job](https://developers.gophr.com/recipes/confirm-a-job.md)
- [Create A Job](https://developers.gophr.com/recipes/create-a-job.md)
- [Create Parcel](https://developers.gophr.com/recipes/create-parcel.md)
- [Delete a Parcel](https://developers.gophr.com/recipes/delete-a-parcel.md)
- [Generate A Delivery Label](https://developers.gophr.com/recipes/generate-a-delivery-label.md)
- [Get a Quote](https://developers.gophr.com/recipes/get-a-quote.md)
- [Update Parcel](https://developers.gophr.com/recipes/update-parcel.md)
- [Updating a Delivery](https://developers.gophr.com/recipes/updating-a-delivery.md)