Skip to main content

Update Order Reference

In addition to update an order reference in the initialize checkout and order validation calls, it is also possible to update the order reference for a Checkout session after a purchase has been successfully completed

Important

You can only update the Order Reference once after the purchase has been completed, and it must be done before the order is captured.

The order reference is updated by calling the Checkout API from your backend:

PUT /checkouts/{checkoutId}/reference HTTP/1.1
API Reference

See Update order reference for the request schema, examples and error reasons.

The reference value​

This is a reference to the order, like an order ID. If you update the reference after completing the purchase, the customer might not see it. However, you can still match it with the PurchaseIdentifier the customer sees.

Error responses​

The error reasons this endpoint can return are listed per status code in the API Reference. The Error codes page explains the HTTP status codes used across the Checkout API.