Completion

Creates an order completion for an in progress order base

Changed on

An order completion is automatically created upon completion of the following payment types:

<list type="bullet"> <item> <description> order embedded payment </description> </item> <item> <description> order redirect payment </description> </item> <item> <description> order payment card payment </description> </item> </list>

An order completion must be manually created for:

<list type="bullet"> <item> <description>Zero value orders</description> </item> <item> <description>Unpaid orders</description> </item> <item> <description>Orders paid entirely by order gift card payment or order member balance payment</description> </item> </list> #### Licenses Required
  • Vista.Ocapi
  • Vista.Ocapi.EmbeddedPayment
post/ocapi/v1/orders/{orderId}/completion

Request

Path parameters

orderIdstring required

The unique identifier of the in progress order base being completed

Headers

Connect-Region-Codestring

Region Code

Response

Success

OR

Changes

    • warning

      added the new Tab enum value to the // response property for the response status

    • warning

      added the new Tab enum value to the // response property for the response status