CoreApiSalesOrder

snowbee.coreapi.CoreApiSalesOrder

object · non-null

idstringnon-nullrequired

freightobjectnullableoptional

Show child fields

gross_amountstringnullableoptional: Format: BigDecimal
Example"100.0"
net_amountstringnon-nullrequired: Format: BigDecimal
Example"100.0"
vat_ratestringnullableoptional: Format: BigDecimal
Example"100.0"

fulfillmentobjectnon-nullrequired

Show child fields

statusstringnon-nullrequired: Allowed values"PENDING""PARTIALLY_FULFILLED""FULFILLED""CANCELLED"

invoicingobjectnon-nullrequired

Show child fields

statusstringnon-nullrequired: Allowed values"NOT_INVOICED""PARTIALLY_INVOICED""INVOICED"

linesarray of objectnon-nullrequired

Show item fields

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

referencestringnullableoptional

statusstringnon-nullrequired

versionintegernon-nullrequired

Format: int64

campaign_idstringnullableoptional

click_and_collect_cart_idstringnullableoptional

company_idstringnon-nullrequired

created_atstringnon-nullrequired

Format: ISO 8681 timestamp

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

currency_iso_codestringnon-nullrequired

customer_idstringnon-nullrequired

customer_typestringnon-nullrequired

Allowed values"B2B""B2C""COMPANY""RETAIL_STORE""ECOM_STORE"

delivery_addressobjectnon-nullrequired

Show child fields

citystringnon-nullrequired
emailstringnullableoptional
namestringnon-nullrequired
phonestringnullableoptional
streetstringnon-nullrequired
country_iso_codestringnon-nullrequired
post_codestringnon-nullrequired

discount_couponsarray of objectnon-nullrequired

Show item fields

amountstringnullableoptional: Format: BigDecimal
Example"100.0"
idstringnon-nullrequired
titlestringnullableoptional
can_be_applied_to_service_ordersbooleannon-nullrequired
discount_coupon_typestringnullableoptional
excluded_main_product_group_numbersarray of stringnon-nullrequired
external_referencestringnon-nullrequired
included_main_product_group_numbersarray of stringnon-nullrequired
loyalty_program_idstringnon-nullrequired

document_statusstringnon-nullrequired

ecom_store_idstringnullableoptional

exchange_ratestringnon-nullrequired

Format: BigDecimal

Example"100.0"

external_order_idstringnullableoptional

external_order_numberstringnullableoptional

fixed_invoice_due_datestringnullableoptional

Format: date

Example"2026-01-14"

internal_notestringnullableoptional

invoice_addressobjectnon-nullrequired

Show child fields

citystringnon-nullrequired
namestringnon-nullrequired
streetstringnon-nullrequired
country_iso_codestringnon-nullrequired
post_codestringnon-nullrequired

invoice_email_addressstringnullableoptional

is_retail_orderbooleannon-nullrequired

liable_to_vatbooleannon-nullrequired

modified_atstringnon-nullrequired

Format: ISO 8681 timestamp

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

note_to_customerstringnullableoptional

order_datestringnon-nullrequired

Format: date

Example"2026-01-14"

order_discount_amountstringnullableoptional

Format: BigDecimal

Example"100.0"

order_discount_percentagestringnullableoptional

Format: BigDecimal

Example"100.0"

organisational_unit_idstringnon-nullrequired

organisational_unit_typestringnon-nullrequired

Allowed values"DEPARTMENT""RETAIL_STORE""ECOM_STORE"

sales_order_numberstringnon-nullrequired

sales_order_type_idstringnon-nullrequired

sold_atstringnullableoptional

Format: ISO 8681 timestamp

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

sold_by_idstringnon-nullrequired

terms_of_delivery_for_tenant_idstringnullableoptional

terms_of_payment_idstringnon-nullrequired

total_gross_amountstringnullableoptional

Format: BigDecimal

Example"100.0"

total_net_amountstringnullableoptional

Format: BigDecimal

Example"100.0"

total_vat_amountstringnullableoptional

Format: BigDecimal

Example"100.0"

warehouse_idstringnon-nullrequired

View raw schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "title": "String"
    },
    "freight": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/components/schemas/snowbee.coreapi.CoreApiSalesOrderFreight"
        }
      ]
    },
    "fulfillment": {
      "$ref": "#/components/schemas/snowbee.coreapi.CoreApiSalesOrderFulfillment"
    },
    "invoicing": {
      "$ref": "#/components/schemas/snowbee.coreapi.CoreApiSalesOrderInvoicing"
    },
    "lines": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/snowbee.coreapi.CoreApiSalesOrderLine"
      },
      "title": "List<CoreApiSalesOrderLine>"
    },
    "reference": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "status": {
      "type": "string",
      "title": "String"
    },
    "version": {
      "type": "integer",
      "format": "int64",
      "title": "Long"
    },
    "campaign_id": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "click_and_collect_cart_id": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "company_id": {
      "type": "string",
      "title": "String"
    },
    "created_at": {
      "type": "string",
      "format": "ISO 8681 timestamp",
      "example": "2025-10-28T12:37:42Z",
      "title": "ISO8681"
    },
    "currency_iso_code": {
      "type": "string",
      "title": "String"
    },
    "customer_id": {
      "type": "string",
      "title": "String"
    },
    "customer_type": {
      "$ref": "#/components/schemas/snowbee.entities.utils.CustomerType"
    },
    "delivery_address": {
      "$ref": "#/components/schemas/snowbee.coreapi.CoreApiSalesOrderAddress"
    },
    "discount_coupons": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/snowbee.coreapi.CoreApiSalesOrderDiscountCoupon"
      },
      "title": "List<CoreApiSalesOrderDiscountCoupon>"
    },
    "document_status": {
      "type": "string",
      "title": "String"
    },
    "ecom_store_id": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "exchange_rate": {
      "type": "string",
      "format": "BigDecimal",
      "example": "100.0",
      "title": "BigDecimalAsString"
    },
    "external_order_id": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "external_order_number": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "fixed_invoice_due_date": {
      "type": [
        "null",
        "string"
      ],
      "format": "date",
      "example": "2026-01-14",
      "title": "LocalDate"
    },
    "internal_note": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "invoice_address": {
      "$ref": "#/components/schemas/snowbee.coreapi.CoreApiInvoiceAddress"
    },
    "invoice_email_address": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "is_retail_order": {
      "type": "boolean",
      "title": "Boolean"
    },
    "liable_to_vat": {
      "type": "boolean",
      "title": "Boolean"
    },
    "modified_at": {
      "type": "string",
      "format": "ISO 8681 timestamp",
      "example": "2025-10-28T12:37:42Z",
      "title": "ISO8681"
    },
    "note_to_customer": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "order_date": {
      "type": "string",
      "format": "date",
      "example": "2026-01-14",
      "title": "LocalDate"
    },
    "order_discount_amount": {
      "type": [
        "null",
        "string"
      ],
      "format": "BigDecimal",
      "example": "100.0",
      "title": "BigDecimalAsString"
    },
    "order_discount_percentage": {
      "type": [
        "null",
        "string"
      ],
      "format": "BigDecimal",
      "example": "100.0",
      "title": "BigDecimalAsString"
    },
    "organisational_unit_id": {
      "type": "string",
      "title": "String"
    },
    "organisational_unit_type": {
      "$ref": "#/components/schemas/snowbee.entities.utils.OrganisationalUnitType"
    },
    "sales_order_number": {
      "type": "string",
      "title": "String"
    },
    "sales_order_type_id": {
      "type": "string",
      "title": "String"
    },
    "sold_at": {
      "type": [
        "null",
        "string"
      ],
      "format": "ISO 8681 timestamp",
      "example": "2025-10-28T12:37:42Z",
      "title": "ISO8681"
    },
    "sold_by_id": {
      "type": "string",
      "title": "String"
    },
    "terms_of_delivery_for_tenant_id": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "terms_of_payment_id": {
      "type": "string",
      "title": "String"
    },
    "total_gross_amount": {
      "type": [
        "null",
        "string"
      ],
      "format": "BigDecimal",
      "example": "100.0",
      "title": "BigDecimalAsString"
    },
    "total_net_amount": {
      "type": [
        "null",
        "string"
      ],
      "format": "BigDecimal",
      "example": "100.0",
      "title": "BigDecimalAsString"
    },
    "total_vat_amount": {
      "type": [
        "null",
        "string"
      ],
      "format": "BigDecimal",
      "example": "100.0",
      "title": "BigDecimalAsString"
    },
    "warehouse_id": {
      "type": "string",
      "title": "String"
    }
  },
  "required": [
    "fulfillment",
    "id",
    "invoicing",
    "lines",
    "status",
    "version",
    "company_id",
    "created_at",
    "currency_iso_code",
    "customer_id",
    "customer_type",
    "delivery_address",
    "discount_coupons",
    "document_status",
    "exchange_rate",
    "invoice_address",
    "is_retail_order",
    "liable_to_vat",
    "modified_at",
    "order_date",
    "organisational_unit_id",
    "organisational_unit_type",
    "sales_order_number",
    "sales_order_type_id",
    "sold_by_id",
    "terms_of_payment_id",
    "warehouse_id"
  ],
  "title": "CoreApiSalesOrder"
}