Skip to content

Creates an order completion for an in progress order base

Request

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

order embedded payment order redirect payment order payment card payment

An order completion must be manually created for:

Zero value ordersUnpaid ordersOrders paid entirely by order gift card payment or order member balance payment
#### Licenses Required
  • Vista.Ocapi
  • Vista.Ocapi.EmbeddedPayment
Path
orderIdstringrequired

The unique identifier of the in progress order base being completed

Headers
Connect-Region-Codestring

Region Code

curl -i -X POST \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/orders/{orderId}/completion' \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json
One of:

Represents the completion of an in progress order base

orderIdstring, non-emptyrequired

Gets the unique identifier of the in progress order base

orderTypestring(OrderType)required

Gets the type of the in progress order base

Enum:"Standard""GiftShop""Subscription""Tab"
statusstring(OrderCompletionStatus)required

Gets the status

Enum:"Pending""Completed""Failed"
transactionNumberinteger or null, (int32)

Gets the number generated by the site that can be used to identify and collect the transaction

updatedOrderExpiresAtstring or null, (date-time)

Gets the updated date and time that the in progress order base expires

Response
{
  "orderId": "string",
  "orderType": "Standard",
  "status": "Pending",
  "transactionNumber": 0,
  "updatedOrderExpiresAt": "2019-08-24T14:15:22Z"
}