Order Management

Once a customer has completed their checkout experience with Zip, there are still several ways a partner may need to interact with Zip for the purposes of order management.

Below are the flows associated with these features, should you with to implement them within your backend.

Please note that this is NOT a requirement but is recommended

Refunds

1. The backoffice user accesses the order list screen in the backoffice system

2. Orders that are in an Approved state should have a refund option displayed alongside them

3. Orders that are in a Authorised state should have a rollback option displayed alongside them

4. If the refund option is clicked, the user is asked to confirm that they want to refund the order, including the amount to refund. Partial refunds are supported by the API. If the user confirms – then the /pos/order/{id}/refund
   API method must be called, and on success – the screen refreshed with the order status updated to Refunded (or similar)

Commit and Rollback

This section covers the merchant being able to manually commit or rollback authorised transactions where Capture Method is Authorisation / Capture for the integration.

1. The backoffice user accesses the order list screen in the backoffice system.

2. Orders that are in an Authorised state (because /pos/order was called and fulfilled with no follow up API call) will have two options alongside each of them – Commit and Rollback.

3. If the commit option is clicked, the user is asked to confirm that they want to capture the order. Partial captures are not supported by the API. If the user confirms – then the /pos/order/{id}/commit API method must be called, and on success – the screen refreshed with the order status updated to Processing (or similar)

4. If the void option is clicked, the user is asked to confirm that they want to cancel the order. Partial cancellations are supported by the API. If the user confirms, then the /pos/order/{id}/rollback API method must be called, and on success – the screen refreshed with the order status updated to Cancelled (or similar)