SbPublicApiCartCheckoutRequest

snowbee.ecom.cart.SbPublicApiCartCheckoutRequest

object · non-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 raw schema

{
  "type": "object",
  "description": "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.",
  "properties": {
    "customerId": {
      "type": [
        "null",
        "string"
      ],
      "description": "Customer to place the order for; the store's default customer when omitted",
      "title": "String"
    },
    "deliveryAddress": {
      "$ref": "#/components/schemas/snowbee.SbPublicApiDeliveryAddressRequest"
    },
    "externalOrderNumber": {
      "type": [
        "null",
        "string"
      ],
      "description": "Order number shown to the shopper by the storefront, if any",
      "title": "String"
    },
    "freight": {
      "description": "Freight as chosen and priced in the carrier's checkout UI: carrier codes, net amount and VAT rate. Omit for orders without freight.",
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/components/schemas/snowbee.SbPublicApiFreightInfo"
        }
      ]
    },
    "invoiceAddress": {
      "$ref": "#/components/schemas/snowbee.SbPublicApiInvoiceAddressRequest"
    },
    "payment": {
      "description": "The payment session the shopper completed. Required when the store takes web payments, rejected otherwise.",
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/components/schemas/snowbee.ecom.cart.SbPublicApiCartCheckoutPaymentRequest"
        }
      ]
    }
  },
  "required": [
    "deliveryAddress",
    "invoiceAddress"
  ],
  "title": "SbPublicApiCartCheckoutRequest"
}