Integrating with a delivery partner

Last updated 8 months ago

If you are integrating with an existing delivery partner you will be using the Spatula API to create and view Jobs.

Creating a job

When a job is ready to be sent to a delivery partner, it can be created using the create jobs endpoint.

Subscribing to updates

Webhooks receive notifications and status updates as jobs are updated and completed in the system. You can use the webhook endpoints to manage your webhooks. A successful integration should require only a single registered webhook to handle all job updates.

Cancellation

If you need to cancel a previously created job (e.g. your customer has cancelled an order) you can use the update job endpoint to post a cancellation.