SbPublicApiFreightInfo

snowbee.SbPublicApiFreightInfo

object · non-null

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"

View raw schema

{
  "type": "object",
  "properties": {
    "carrierAgreementCode": {
      "type": "string",
      "example": "6838716034162098000",
      "title": "String"
    },
    "carrierCode": {
      "type": "string",
      "example": "porterbuddy",
      "title": "String"
    },
    "carrierName": {
      "type": [
        "null",
        "string"
      ],
      "example": "Porterbuddy",
      "title": "String"
    },
    "carrierProductCode": {
      "type": "string",
      "example": "8747679326213767168",
      "title": "String"
    },
    "carrierProductName": {
      "type": [
        "null",
        "string"
      ],
      "example": "Evening delivery",
      "title": "String"
    },
    "carrierProductPayload": {
      "description": "Provider-specific extra data",
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/components/schemas/snowbee.SbPublicApiCarrierProductPayload"
        }
      ]
    },
    "freightVatRate": {
      "type": [
        "null",
        "string"
      ],
      "format": "BigDecimal",
      "description": "VAT rate for freight as a percentage",
      "example": "25.00",
      "title": "BigDecimalAsString"
    },
    "netFreightAmount": {
      "type": [
        "null",
        "string"
      ],
      "format": "BigDecimal",
      "description": "Net freight/shipping cost amount (excl. VAT)",
      "example": "49.00",
      "title": "BigDecimalAsString"
    }
  },
  "required": [
    "carrierAgreementCode",
    "carrierCode",
    "carrierProductCode"
  ],
  "title": "SbPublicApiFreightInfo"
}