CoreApiSalesOrderLine

snowbee.coreapi.CoreApiSalesOrderLine

object · non-null

fulfillmentobjectnon-nullrequired

Show child fields

statusstringnon-nullrequired: Allowed values"PENDING""PARTIALLY_FULFILLED""FULFILLED""CANCELLED"
cancelled_quantitystringnon-nullrequired: Format: BigDecimal
Example"100.0"
fulfilled_quantitystringnon-nullrequired: Format: BigDecimal
Example"100.0"
pending_quantitystringnon-nullrequired: Format: BigDecimal
Example"100.0"
picked_quantitystringnon-nullrequired: Format: BigDecimal
Example"100.0"
picking_in_progress_quantitystringnon-nullrequired: Format: BigDecimal
Example"100.0"
picking_list_idsarray of stringnon-nullrequired
shipment_idsarray of stringnon-nullrequired
shipped_quantitystringnon-nullrequired: Format: BigDecimal
Example"100.0"

idstringnon-nullrequired

invoicingobjectnon-nullrequired

Show child fields

statusstringnon-nullrequired: Allowed values"NOT_INVOICED""PARTIALLY_INVOICED""INVOICED"
invoice_idsarray of stringnon-nullrequired
invoice_line_idsarray of stringnon-nullrequired
invoiced_quantitystringnon-nullrequired: Format: BigDecimal
Example"100.0"

notestringnullableoptional

positionintegernon-nullrequired

Format: int32

prepaymentobjectnullableoptional

Show child fields

statusstringnon-nullrequired: Allowed values"PENDING""DELIVERED""CANCELLED"
applied_gross_amountstringnon-nullrequired: Format: BigDecimal
Example"100.0"
collected_gross_amountstringnon-nullrequired: Format: BigDecimal
Example"100.0"
configured_gross_amountstringnullableoptional: Format: BigDecimal
Example"100.0"
refunded_gross_amountstringnon-nullrequired: Format: BigDecimal
Example"100.0"
unapplied_gross_amountstringnon-nullrequired: Format: BigDecimal
Example"100.0"

versionintegernon-nullrequired

Format: int64

basic_net_unit_sales_pricestringnullableoptional

Format: BigDecimal

Example"100.0"

campaign_code_at_salestringnullableoptional

campaign_idstringnullableoptional

campaign_name_at_salestringnullableoptional

campaign_net_unit_sales_pricestringnullableoptional

Format: BigDecimal

Example"100.0"

company_idstringnon-nullrequired

confirmed_delivery_datestringnullableoptional

Format: date

Example"2026-01-14"

created_atstringnon-nullrequired

Format: ISO 8681 timestamp

Example"2025-10-28T12:37:42Z"

estimated_delivery_datestringnullableoptional

Format: date

Example"2026-01-14"

gift_card_idstringnullableoptional

gross_line_amountstringnullableoptional

Format: BigDecimal

Example"100.0"

line_discount_percentagestringnon-nullrequired

Format: BigDecimal

Example"100.0"

line_statusstringnon-nullrequired

line_typestringnon-nullrequired

Allowed values"PRODUCT""RESOURCE""GIFT_CARD""SERVICE_ORDER"

modified_atstringnon-nullrequired

Format: ISO 8681 timestamp

Example"2025-10-28T12:37:42Z"

net_line_amountstringnullableoptional

Format: BigDecimal

Example"100.0"

net_unit_consignment_pricestringnullableoptional

Format: BigDecimal

Example"100.0"

net_unit_order_discount_amountstringnon-nullrequired

Format: BigDecimal

Example"100.0"

net_unit_sales_pricestringnullableoptional

Format: BigDecimal

Example"100.0"

order_quantitystringnon-nullrequired

Format: BigDecimal

Example"100.0"

price_source_typestringnullableoptional

requested_delivery_datestringnullableoptional

Format: date

Example"2026-01-14"

resource_idstringnullableoptional

returned_sales_order_line_idstringnullableoptional

sales_processstringnon-nullrequired

Allowed values"NORMAL""RETURN""CLAIM"

service_order_idstringnullableoptional

sku_idstringnullableoptional

supply_sourcestringnullableoptional

unit_coststringnullableoptional

Stored unit cost in the owning company's currency

Format: BigDecimal

Example"100.0"

vat_amountstringnullableoptional

Format: BigDecimal

Example"100.0"

vat_ratestringnon-nullrequired

Format: BigDecimal

Example"100.0"

warehouse_idstringnon-nullrequired

View raw schema

{
  "type": "object",
  "properties": {
    "fulfillment": {
      "$ref": "#/components/schemas/snowbee.coreapi.CoreApiSalesOrderLineFulfillment"
    },
    "id": {
      "type": "string",
      "title": "String"
    },
    "invoicing": {
      "$ref": "#/components/schemas/snowbee.coreapi.CoreApiSalesOrderLineInvoicing"
    },
    "note": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "position": {
      "type": "integer",
      "format": "int32",
      "title": "Int"
    },
    "prepayment": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/components/schemas/snowbee.coreapi.CoreApiSalesOrderLinePrepayment"
        }
      ]
    },
    "version": {
      "type": "integer",
      "format": "int64",
      "title": "Long"
    },
    "basic_net_unit_sales_price": {
      "type": [
        "null",
        "string"
      ],
      "format": "BigDecimal",
      "example": "100.0",
      "title": "BigDecimalAsString"
    },
    "campaign_code_at_sale": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "campaign_id": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "campaign_name_at_sale": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "campaign_net_unit_sales_price": {
      "type": [
        "null",
        "string"
      ],
      "format": "BigDecimal",
      "example": "100.0",
      "title": "BigDecimalAsString"
    },
    "company_id": {
      "type": "string",
      "title": "String"
    },
    "confirmed_delivery_date": {
      "type": [
        "null",
        "string"
      ],
      "format": "date",
      "example": "2026-01-14",
      "title": "LocalDate"
    },
    "created_at": {
      "type": "string",
      "format": "ISO 8681 timestamp",
      "example": "2025-10-28T12:37:42Z",
      "title": "ISO8681"
    },
    "estimated_delivery_date": {
      "type": [
        "null",
        "string"
      ],
      "format": "date",
      "example": "2026-01-14",
      "title": "LocalDate"
    },
    "gift_card_id": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "gross_line_amount": {
      "type": [
        "null",
        "string"
      ],
      "format": "BigDecimal",
      "example": "100.0",
      "title": "BigDecimalAsString"
    },
    "line_discount_percentage": {
      "type": "string",
      "format": "BigDecimal",
      "example": "100.0",
      "title": "BigDecimalAsString"
    },
    "line_status": {
      "type": "string",
      "title": "String"
    },
    "line_type": {
      "$ref": "#/components/schemas/snowbee.entities.SalesOrderLineType"
    },
    "modified_at": {
      "type": "string",
      "format": "ISO 8681 timestamp",
      "example": "2025-10-28T12:37:42Z",
      "title": "ISO8681"
    },
    "net_line_amount": {
      "type": [
        "null",
        "string"
      ],
      "format": "BigDecimal",
      "example": "100.0",
      "title": "BigDecimalAsString"
    },
    "net_unit_consignment_price": {
      "type": [
        "null",
        "string"
      ],
      "format": "BigDecimal",
      "example": "100.0",
      "title": "BigDecimalAsString"
    },
    "net_unit_order_discount_amount": {
      "type": "string",
      "format": "BigDecimal",
      "example": "100.0",
      "title": "BigDecimalAsString"
    },
    "net_unit_sales_price": {
      "type": [
        "null",
        "string"
      ],
      "format": "BigDecimal",
      "example": "100.0",
      "title": "BigDecimalAsString"
    },
    "order_quantity": {
      "type": "string",
      "format": "BigDecimal",
      "example": "100.0",
      "title": "BigDecimalAsString"
    },
    "price_source_type": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "requested_delivery_date": {
      "type": [
        "null",
        "string"
      ],
      "format": "date",
      "example": "2026-01-14",
      "title": "LocalDate"
    },
    "resource_id": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "returned_sales_order_line_id": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "sales_process": {
      "$ref": "#/components/schemas/snowbee.entities.SalesProcess"
    },
    "service_order_id": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "sku_id": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "supply_source": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "unit_cost": {
      "type": [
        "null",
        "string"
      ],
      "format": "BigDecimal",
      "description": "Stored unit cost in the owning company's currency",
      "example": "100.0",
      "title": "BigDecimalAsString"
    },
    "vat_amount": {
      "type": [
        "null",
        "string"
      ],
      "format": "BigDecimal",
      "example": "100.0",
      "title": "BigDecimalAsString"
    },
    "vat_rate": {
      "type": "string",
      "format": "BigDecimal",
      "example": "100.0",
      "title": "BigDecimalAsString"
    },
    "warehouse_id": {
      "type": "string",
      "title": "String"
    }
  },
  "required": [
    "fulfillment",
    "id",
    "invoicing",
    "position",
    "version",
    "company_id",
    "created_at",
    "line_discount_percentage",
    "line_status",
    "line_type",
    "modified_at",
    "net_unit_order_discount_amount",
    "order_quantity",
    "sales_process",
    "vat_rate",
    "warehouse_id"
  ],
  "title": "CoreApiSalesOrderLine"
}