POST v3/baskets/{id}/confirm

Confirms an order. For system-owners, this can only be used for zero-value orders. Otherwise use . For agents, this should be used for all orders

Request Information

URI Parameters

Name	Description	Type	Additional information
id		string	Required

Body Parameters

OrderConfirmation

Name	Type	Additional information
SendConfirmationEmail	boolean	None.
PayWithStoredCardId	string	None.
PayWithStoredCardCv2	string	None.
PaymentChannel	PaymentChannel	None.
PayWithDefaultStoredCard	boolean	None.
HaveStoredCardId	boolean	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json

Sample:

{
  "sendConfirmationEmail": true,
  "payWithStoredCardId": "sample string 2",
  "payWithStoredCardCv2": "sample string 3",
  "paymentChannel": "Web",
  "payWithDefaultStoredCard": true,
  "haveStoredCardId": true
}

text/xml

Sample:

The response/request for text/xml format is no longer supported for this endpoint.

Response Information

Resource Description

HTTP Status 409 (Conflict) with the following error codes: * 11 if the basket requires payment to complete * 18 if the basket contains a membership subscription and the customer already has a subscription to that membership, and is not in the renewal period. (Note that this error code will normally occur when adding that membership to the basket, but could occur here if the membership was added to the basket before the customer was added to the basket)

Order

Name	Type	Additional information
Deliveries	Collection of Delivery	None.
TicketSubscriptions	Collection of OrderHistoryTicketSubscription	None.
FirstTransactionDate	date	None.
FirstTransactionDateUtc	date	None.
LastTransactionDate	date	None.
LastTransactionDateUtc	date	None.
TotalPaymentCharges	decimal number	None.
TotalDeliveryCharges	decimal number	None.
TotalTransactionCharges	decimal number	None.
Payments	Collection of Payment	None.
Refunds	Collection of Payment	None.
PrintAtHomeDocuments	Collection of PrintAtHomeDocument	None.
Id	string	None.
Attributes	There will be additional properties (custom to each client) with the prefix 'Attribute_'	None.
Total	decimal number	None.
Customer	Customer	None.
MerchandiseItems	Collection of MerchandiseItem	None.
Donations	Collection of Donation	None.
Notes	string	None.
Tickets	Collection of Ticket	None.
MembershipSubscriptions	Collection of MembershipSubscription	None.
GiftVouchers	Collection of GiftVoucher	None.
Charges	Collection of Charge	None.

Response Formats

application/json, text/xml

Sample:

Sample not available.