POST/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/carts/{cartId}/checkout

Check out a cart Experimental

Creates an ordinary ecom sales order from the cart's lines at SnowBee's current prices and deletes the cart. Repeating the call for a cart that was already checked out returns the same order. A store that takes web payments requires the completed payment session; the authorisation is verified against the cart's current total.

Parameters

tenantIdpathstringnon-nullrequired
eComStoreIdpathstringnon-nullrequired
cartIdpathstringnon-nullrequired

Request body (required)

application/jsonobjectnon-null

Turn the cart into an order. The cart is re-quoted and its lines are handed to order intake priced, with the campaign each line was sold under; the cart id becomes the order's external id.

customerIdstringnullableoptional

Customer to place the order for; the store's default customer when omitted

deliveryAddressobjectnon-nullrequired

Show child fields

citystringnon-nullrequired: Example"Oslo"
countryIsoCodestringnon-nullrequired: ISO 3166-1 alpha-2 country code
Example"NO"
emailstringnullableoptional: Contact email for delivery notifications
Example"ola.nordmann@example.com"
namestringnon-nullrequired: Recipient name
Example"Ola Nordmann"
phonestringnullableoptional: Contact phone for delivery
Example"+4790123456"
postCodestringnon-nullrequired: Example"0123"
streetstringnon-nullrequired: Street address including house number
Example"Storgata 1"

externalOrderNumberstringnullableoptional

Order number shown to the shopper by the storefront, if any

freightobjectnullableoptional

Freight as chosen and priced in the carrier's checkout UI: carrier codes, net amount and VAT rate. Omit for orders without freight.

Show child fields

carrierAgreementCodestringnon-nullrequired

Example"6838716034162098000"

carrierCodestringnon-nullrequired

Example"porterbuddy"

carrierNamestringnullableoptional

Example"Porterbuddy"

carrierProductCodestringnon-nullrequired

Example"8747679326213767168"

carrierProductNamestringnullableoptional

Example"Evening delivery"

carrierProductPayloadobjectnullableoptional

Provider-specific extra data

Show child fields

partnerNamestringnullableoptional: Partner name from provider
partnerNumberstringnullableoptional: Partner number from provider

freightVatRatestringnullableoptional

VAT rate for freight as a percentage

Format: BigDecimal

Example"25.00"

netFreightAmountstringnullableoptional

Net freight/shipping cost amount (excl. VAT)

Format: BigDecimal

Example"49.00"

invoiceAddressobjectnon-nullrequired

Show child fields

citystringnon-nullrequired: Example"Oslo"
countryIsoCodestringnon-nullrequired: ISO 3166-1 alpha-2 country code
Example"NO"
emailstringnon-nullrequired: Email for invoice delivery
Example"ola.nordmann@example.com"
namestringnon-nullrequired: Recipient name
Example"Ola Nordmann"
postCodestringnon-nullrequired: Example"0123"
streetstringnon-nullrequired: Street address including house number
Example"Storgata 1"

paymentobjectnullableoptional

The payment session the shopper completed. Required when the store takes web payments, rejected otherwise.

Show child fields

paymentIdstringnon-nullrequired: paymentId from POST /carts/{cartId}/payment_session
sessionResultstringnon-nullrequired: sessionResult the Drop-in reported on completion

View schema definition

Responses

200Response

application/jsonobjectnon-null

The order a cart became. The cart itself is deleted.

orderIdstringnon-nullrequired: Sales order ID; read it with GET /orders/{orderId}
orderNumberstringnullableoptional: SnowBee's order number, the one to show the shopper

View schema definition

400Response

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition

401Response

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition

403Response

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition

404Response

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition

409The cart is expired

The cart is expired

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition

422Empty or unpriced cart, unknown SKU or customer, or incomplete freight

Empty or unpriced cart, unknown SKU or customer, or incomplete freight

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition