Developer docs

← All schemas

SbPublicApiOrderLineItemResponse

snowbee.SbPublicApiOrderLineItemResponse

object · non-null

barcodestringnullableoptional

Barcode (EAN/GTIN)

Example"1234567890123"
cancelledQuantitystringnullableoptional

Quantity cancelled after line closure; null while the line is open or fully shipped

  • Format: BigDecimal
Example"1.0"
discountstringnon-nullrequired

Discount percentage applied to this line

  • Format: BigDecimal
  • Pattern: ^-?\d+(\.\d{1,2})?$
Example"0.00"
estimatedDeliveryDatestringnon-nullrequired
  • Format: date
Example"2024-06-20"
fulfilledQuantitystringnon-nullrequired

Quantity fulfilled/shipped for this line

  • Format: BigDecimal
Example"2.0"
grossAmountstringnon-nullrequired

Gross amount including VAT

  • Format: BigDecimal
  • Pattern: ^-?\d+(\.\d{1,2})?$
Example"747.50"
idstringnon-nullrequired
Example"01234567-89ab-cdef-0123-456789abcdef"
netAmountstringnon-nullrequired

Net amount excluding VAT (quantity × netUnitPrice)

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

Net unit order discount amount applied to this line

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

Net unit price excluding VAT

  • Format: BigDecimal
  • Pattern: ^-?\d+(\.\d{1,2})?$
Example"299.00"
productNamestringnon-nullrequired
Example"Classic T-Shirt Black Medium"
quantitystringnon-nullrequired

Quantity ordered

  • Format: BigDecimal
Example"2.0"
returnTicketBarcodeUrlstringnullableoptional

URL to a Code128 barcode SVG image for this line's exchange label. The last path segment is the base64url encoding of the scannable barcode value "SO <order number> <line position>", which is what the barcode encodes, not the return ticket number above

Example"/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/barcodes/code128/U08gV0VCNDAwOTkwMyAy"
returnTicketNumberstringnon-nullrequired

Human readable return ticket number (exchange label code) for this line, the order number followed by the line position

Example"WEB40099032"
skuIdstringnon-nullrequired

SKU ID of the product

Example"01234567-89ab-cdef-0123-456789abcdef"
skuNumberstringnon-nullrequired
Example"PROD-BLK-M"
vatAmountstringnon-nullrequired

VAT amount

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

VAT rate as percentage

  • Format: BigDecimal
  • Pattern: ^-?\d+(\.\d{1,2})?$
Example"25.00"
View raw schema
{
  "type": "object",
  "properties": {
    "barcode": {
      "type": [
        "null",
        "string"
      ],
      "description": "Barcode (EAN/GTIN)",
      "example": "1234567890123",
      "title": "String"
    },
    "cancelledQuantity": {
      "type": [
        "null",
        "string"
      ],
      "format": "BigDecimal",
      "description": "Quantity cancelled after line closure; null while the line is open or fully shipped",
      "example": "1.0",
      "title": "BigDecimalAsString"
    },
    "discount": {
      "type": "string",
      "format": "BigDecimal",
      "description": "Discount percentage applied to this line",
      "example": "0.00",
      "pattern": "^-?\\d+(\\.\\d{1,2})?$",
      "title": "BigDecimalAsString"
    },
    "estimatedDeliveryDate": {
      "type": "string",
      "format": "date",
      "example": "2024-06-20",
      "title": "LocalDate"
    },
    "fulfilledQuantity": {
      "type": "string",
      "format": "BigDecimal",
      "description": "Quantity fulfilled/shipped for this line",
      "example": "2.0",
      "title": "BigDecimalAsString"
    },
    "grossAmount": {
      "type": "string",
      "format": "BigDecimal",
      "description": "Gross amount including VAT",
      "example": "747.50",
      "pattern": "^-?\\d+(\\.\\d{1,2})?$",
      "title": "BigDecimalAsString"
    },
    "id": {
      "type": "string",
      "example": "01234567-89ab-cdef-0123-456789abcdef",
      "title": "String"
    },
    "netAmount": {
      "type": "string",
      "format": "BigDecimal",
      "description": "Net amount excluding VAT (quantity × netUnitPrice)",
      "example": "598.00",
      "pattern": "^-?\\d+(\\.\\d{1,2})?$",
      "title": "BigDecimalAsString"
    },
    "netUnitOrderDiscountAmount": {
      "type": "string",
      "format": "BigDecimal",
      "description": "Net unit order discount amount applied to this line",
      "example": "10.00",
      "pattern": "^-?\\d+(\\.\\d{1,2})?$",
      "title": "BigDecimalAsString"
    },
    "netUnitPrice": {
      "type": "string",
      "format": "BigDecimal",
      "description": "Net unit price excluding VAT",
      "example": "299.00",
      "pattern": "^-?\\d+(\\.\\d{1,2})?$",
      "title": "BigDecimalAsString"
    },
    "productName": {
      "type": "string",
      "example": "Classic T-Shirt Black Medium",
      "title": "String"
    },
    "quantity": {
      "type": "string",
      "format": "BigDecimal",
      "description": "Quantity ordered",
      "example": "2.0",
      "title": "BigDecimalAsString"
    },
    "returnTicketBarcodeUrl": {
      "type": [
        "null",
        "string"
      ],
      "description": "URL to a Code128 barcode SVG image for this line's exchange label. The last path segment is the base64url encoding of the scannable barcode value \"SO <order number> <line position>\", which is what the barcode encodes, not the return ticket number above",
      "example": "/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/barcodes/code128/U08gV0VCNDAwOTkwMyAy",
      "title": "String"
    },
    "returnTicketNumber": {
      "type": "string",
      "description": "Human readable return ticket number (exchange label code) for this line, the order number followed by the line position",
      "example": "WEB40099032",
      "title": "String"
    },
    "skuId": {
      "type": "string",
      "description": "SKU ID of the product",
      "example": "01234567-89ab-cdef-0123-456789abcdef",
      "title": "String"
    },
    "skuNumber": {
      "type": "string",
      "example": "PROD-BLK-M",
      "title": "String"
    },
    "vatAmount": {
      "type": "string",
      "format": "BigDecimal",
      "description": "VAT amount",
      "example": "149.50",
      "pattern": "^-?\\d+(\\.\\d{1,2})?$",
      "title": "BigDecimalAsString"
    },
    "vatRate": {
      "type": "string",
      "format": "BigDecimal",
      "description": "VAT rate as percentage",
      "example": "25.00",
      "pattern": "^-?\\d+(\\.\\d{1,2})?$",
      "title": "BigDecimalAsString"
    }
  },
  "required": [
    "discount",
    "estimatedDeliveryDate",
    "fulfilledQuantity",
    "grossAmount",
    "id",
    "netAmount",
    "netUnitOrderDiscountAmount",
    "netUnitPrice",
    "productName",
    "quantity",
    "returnTicketNumber",
    "skuId",
    "skuNumber",
    "vatAmount",
    "vatRate"
  ],
  "title": "SbPublicApiOrderLineItemResponse"
}