Developer docs

← All schemas

SbPublicApiDeliveryOptionResponse

snowbee.ecom.cart.SbPublicApiDeliveryOptionResponse

object · non-null

A way to get the cart delivered, priced live on the merchant's carrier agreement. Pass the carrier fields and amounts on as the checkout's freight block.

carrierAgreementCodestringnon-nullrequired
carrierCodestringnon-nullrequired
carrierNamestringnon-nullrequired
carrierProductCodestringnon-nullrequired
carrierProductNamestringnon-nullrequired
expectedDeliverystringnullableoptional

Carrier's expected delivery date

freightVatRatestringnon-nullrequired

VAT rate as a percentage; the checkout's freightVatRate

  • Format: BigDecimal
Example"100.0"
grossFreightAmountstringnon-nullrequired

Freight including VAT, what the shopper pays

  • Format: BigDecimal
Example"100.0"
netFreightAmountstringnon-nullrequired

Freight excluding VAT; the checkout's netFreightAmount

  • Format: BigDecimal
Example"100.0"
pickupPointRequiredbooleannon-nullrequired

The shopper must choose a pickup point; fetch them with POST /carts/{cartId}/pickup_points and send the choice as carrierProductPayload

workingDaysintegernullableoptional

Carrier's estimate of working days to delivery

  • Format: int32
View raw schema
{
  "type": "object",
  "description": "A way to get the cart delivered, priced live on the merchant's carrier agreement. Pass the carrier fields and amounts on as the checkout's freight block.",
  "properties": {
    "carrierAgreementCode": {
      "type": "string",
      "title": "String"
    },
    "carrierCode": {
      "type": "string",
      "title": "String"
    },
    "carrierName": {
      "type": "string",
      "title": "String"
    },
    "carrierProductCode": {
      "type": "string",
      "title": "String"
    },
    "carrierProductName": {
      "type": "string",
      "title": "String"
    },
    "expectedDelivery": {
      "type": [
        "null",
        "string"
      ],
      "description": "Carrier's expected delivery date",
      "title": "String"
    },
    "freightVatRate": {
      "type": "string",
      "format": "BigDecimal",
      "description": "VAT rate as a percentage; the checkout's freightVatRate",
      "example": "100.0",
      "title": "BigDecimalAsString"
    },
    "grossFreightAmount": {
      "type": "string",
      "format": "BigDecimal",
      "description": "Freight including VAT, what the shopper pays",
      "example": "100.0",
      "title": "BigDecimalAsString"
    },
    "netFreightAmount": {
      "type": "string",
      "format": "BigDecimal",
      "description": "Freight excluding VAT; the checkout's netFreightAmount",
      "example": "100.0",
      "title": "BigDecimalAsString"
    },
    "pickupPointRequired": {
      "type": "boolean",
      "description": "The shopper must choose a pickup point; fetch them with POST /carts/{cartId}/pickup_points and send the choice as carrierProductPayload",
      "title": "Boolean"
    },
    "workingDays": {
      "type": [
        "null",
        "integer"
      ],
      "format": "int32",
      "description": "Carrier's estimate of working days to delivery",
      "title": "Int"
    }
  },
  "required": [
    "carrierAgreementCode",
    "carrierCode",
    "carrierName",
    "carrierProductCode",
    "carrierProductName",
    "freightVatRate",
    "grossFreightAmount",
    "netFreightAmount",
    "pickupPointRequired"
  ],
  "title": "SbPublicApiDeliveryOptionResponse"
}