Developer docs

← All schemas

SbPublicApiRefundResponse

snowbee.SbPublicApiRefundResponse

object · non-null

createdDatestringnon-nullrequired

Date the refund was created

  • Format: date
Example"2024-06-20"
grossAmountstringnon-nullrequired

Gross refund amount including VAT

  • Format: BigDecimal
  • Pattern: ^-?\d+(\.\d{1,2})?$
Example"747.50"
grossReturnFeeAmountstringnon-nullrequired

Gross return fee amount including VAT

  • Format: BigDecimal
  • Pattern: ^-?\d+(\.\d{1,2})?$
Example"59.00"
idstringnon-nullrequired
Example"01234567-89ab-cdef-0123-456789abcdef"
linesarray of objectnon-nullrequired
Show item fields
lineItemIdstringnon-nullrequired

Reference to order line item

Example"01234567-89ab-cdef-0123-456789abcdef"
quantitystringnon-nullrequired

Quantity refunded

  • Format: BigDecimal
Example"1.0"
netAmountstringnon-nullrequired

Net refund amount excluding VAT

  • Format: BigDecimal
  • Pattern: ^-?\d+(\.\d{1,2})?$
Example"598.00"
netReturnFeeAmountstringnon-nullrequired

Net return fee amount excluding VAT

  • Format: BigDecimal
  • Pattern: ^-?\d+(\.\d{1,2})?$
Example"47.20"
statusstringnon-nullrequired

Refund status

Allowed values"OPEN""CLOSED"
View raw schema
{
  "type": "object",
  "properties": {
    "createdDate": {
      "type": "string",
      "format": "date",
      "description": "Date the refund was created",
      "example": "2024-06-20",
      "title": "LocalDate"
    },
    "grossAmount": {
      "type": "string",
      "format": "BigDecimal",
      "description": "Gross refund amount including VAT",
      "example": "747.50",
      "pattern": "^-?\\d+(\\.\\d{1,2})?$",
      "title": "BigDecimalAsString"
    },
    "grossReturnFeeAmount": {
      "type": "string",
      "format": "BigDecimal",
      "description": "Gross return fee amount including VAT",
      "example": "59.00",
      "pattern": "^-?\\d+(\\.\\d{1,2})?$",
      "title": "BigDecimalAsString"
    },
    "id": {
      "type": "string",
      "example": "01234567-89ab-cdef-0123-456789abcdef",
      "title": "String"
    },
    "lines": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/snowbee.SbPublicApiRefundLineResponse"
      },
      "title": "List<SbPublicApiRefundLineResponse>"
    },
    "netAmount": {
      "type": "string",
      "format": "BigDecimal",
      "description": "Net refund amount excluding VAT",
      "example": "598.00",
      "pattern": "^-?\\d+(\\.\\d{1,2})?$",
      "title": "BigDecimalAsString"
    },
    "netReturnFeeAmount": {
      "type": "string",
      "format": "BigDecimal",
      "description": "Net return fee amount excluding VAT",
      "example": "47.20",
      "pattern": "^-?\\d+(\\.\\d{1,2})?$",
      "title": "BigDecimalAsString"
    },
    "status": {
      "$ref": "#/components/schemas/snowbee.SbPublicApiRefundOrderStatus",
      "description": "Refund status"
    }
  },
  "required": [
    "createdDate",
    "grossAmount",
    "grossReturnFeeAmount",
    "id",
    "lines",
    "netAmount",
    "netReturnFeeAmount",
    "status"
  ],
  "title": "SbPublicApiRefundResponse"
}