Creates an order completion for an in progress order base

An order completion is automatically created upon completion of a successful order embedded payment but must be manually created for zero value orders, unpaid orders or orders paid entirely by order gift card payment payments.

Licenses Required

  • Vista.Ocapi
  • Vista.Ocapi.EmbeddedPayment
Request
path Parameters
orderId
required
string

The unique identifier of the in progress order base being completed

header Parameters
Connect-Region-Code
string

Region Code

Responses
200

Success

400

Order cannot be completed.

404

Order does not exist.

post/ocapi/v1/orders/{orderId}/completion
Request samples
Response samples
application/json
{
  • "orderId": "string",
  • "orderType": "Standard",
  • "status": "Pending",
  • "transactionNumber": 0,
  • "updatedOrderExpiresAt": "2019-08-24T14:15:22Z"
}