snapcasterDevelopers

    API reference · Types

    StoreShippingOptionListResponse

    Part of the response of GET /shipping-options.

    Type: object

    Example

    Generated Schema example: Generated StoreShippingOptionListResponse
    {
  "success": true,
  "data": {
    "options": [
      {
        "id": 0,
        "shippingType": "letter_mail",
        "label": "string",
        "price": 0,
        "isTracked": true,
        "deliveryEstimateDays": 0,
        "consequences": {
          "buyerNonDeliveryProtection": true,
          "sellerBearsNonDeliveryRisk": true
        },
        "createdAt": "string",
        "updatedAt": "string"
      }
    ],
    "taxonomy": [
      {
        "code": "letter_mail",
        "displayName": "string",
        "label": "string",
        "tracked": true,
        "maxCards": 0,
        "defaultDeliveryEstimateDays": 0
      }
    ]
  }
}

    Fields

    success boolean required

    Whether the operation completed as requested.

    Constraints: allowed values: true

    data object required

    The operation or event payload.

    Show child fieldsHide child fields
    data.options StoreShippingOption[] required
    Show child fieldsHide child fields
    data.options[].id integer required
    data.options[].shippingType string or null required

    Constraints: allowed values: letter_mail, bubble_mail, box, null

    data.options[].label string required
    data.options[].price integer required

    The unit price in minor currency units.

    data.options[].isTracked boolean required
    data.options[].deliveryEstimateDays integer required
    data.options[].consequences object required
    Show child fieldsHide child fields
    data.options[].consequences.buyerNonDeliveryProtection boolean required

    Constraints: allowed values: true

    data.options[].consequences.sellerBearsNonDeliveryRisk boolean required
    data.options[].createdAt string or null required
    data.options[].updatedAt string or null required
    data.taxonomy StoreShippingType[] required
    Show child fieldsHide child fields
    data.taxonomy[].code string required

    The stable machine-readable code for this result.

    Constraints: allowed values: letter_mail, bubble_mail, box

    data.taxonomy[].displayName string required
    data.taxonomy[].label string required
    data.taxonomy[].tracked boolean required
    data.taxonomy[].maxCards integer or null required
    data.taxonomy[].defaultDeliveryEstimateDays integer required

    Used by