Set Order Reference

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

Please Note

It is only allowed to set the Order Reference one time if the Purchase has already been completed

Set Order Reference Examples

/*
PUT /merchants/123/checkouts/1eec44b5-66d3-4058-a31f-3444229fb727/reference HTTP/1.1
Host: checkout-api-uat.collector.se
Content-Type: application/json
Authorization: SharedKey bXlVc2VybmFtZTpmN2E1ODA4MGQzZTk0M2VmNWYyMTZlMDE...
*/
{
"Reference": "ABCDEFGHJIKLMNOP"
}
Please Note

Please note that setting an Order Reference after a Purchase has been completed is slightly different from setting it before this state.

When a purchase has been completed, the object tied to the PurchaseIdentifier returned from Get Checkout Information will be given a new Order Number (the one you provide) when setting the Order Reference in retrospect.

Request properties

PropertyRequiredExplanation
ReferenceYesA reference to the order, i.e. order ID or similar. Note that the reference provided here will not be shown to the customer but can be correlated with the PurchaseIdentifier shown to the customer. Max 50 chars.