← All schemas

SbPublicApiGetOrderResponse

snowbee.SbPublicApiGetOrderResponse

object · non-null

capturesarray of objectnon-nullrequired

Show item fields

amountstringnullableoptional

Captured amount

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

Example"747.50"

createdDatestringnullableoptional

Date the capture was created

• Format: date

Example"2024-06-15"

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 captured

• Format: BigDecimal

Example"2.0"

statusstringnon-nullrequired

Capture status

Allowed values"PENDING""CONFIRMED""FAILED"

currencyIsoCodestringnon-nullrequired

ISO 4217 currency code

Example"NOK"

customerIdstringnon-nullrequired

Customer ID associated with the order

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

deliveryAddressobjectnon-nullrequired

Show child fields

citystringnon-nullrequired

Example"Oslo"

countryIsoCodestringnon-nullrequired

ISO 3166-1 alpha-2 country code

Example"NO"

emailstringnullableoptional

Example"ola.nordmann@example.com"

namestringnon-nullrequired

Recipient name

Example"Ola Nordmann"

phonestringnullableoptional

Example"+4790123456"

postCodestringnon-nullrequired

Example"0123"

streetstringnon-nullrequired

Street address including house number

Example"Storgata 1"

externalOrderIdstringnullableoptional

External order ID from your e-commerce platform

Example"SHOP-123"

externalOrderNumberstringnullableoptional

External order number displayed to customer

Example"WEB-2024-00123"

freightobjectnullableoptional

Show child fields

carrierAgreementCodestringnon-nullrequired

Example"6838716034162098000"

carrierCodestringnon-nullrequired

Example"porterbuddy"

carrierNamestringnullableoptional

Example"Porterbuddy"

carrierProductCodestringnon-nullrequired

Example"8747679326213767168"

carrierProductNamestringnullableoptional

Example"Evening delivery"

carrierProductPayloadobjectnullableoptional

Provider-specific extra data

Show child fields

partnerNamestringnullableoptional

Partner name from provider

partnerNumberstringnullableoptional

Partner number from provider

freightVatRatestringnullableoptional

VAT rate for freight as a percentage

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

Example"25.00"

netFreightAmountstringnullableoptional

Net freight/shipping cost amount (excl. VAT)

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

Example"49.00"

idstringnon-nullrequired

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

invoiceAddressobjectnon-nullrequired

Show child fields

citystringnon-nullrequired

Example"Oslo"

countryIsoCodestringnon-nullrequired

ISO 3166-1 alpha-2 country code

Example"NO"

emailstringnon-nullrequired

Email for invoice delivery

Example"ola.nordmann@example.com"

namestringnon-nullrequired

Recipient name

Example"Ola Nordmann"

postCodestringnon-nullrequired

Example"0123"

streetstringnon-nullrequired

Street address including house number

Example"Storgata 1"

lineItemsarray of objectnon-nullrequired

Show item fields

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"

orderDatestringnon-nullrequired

Date the order was placed

• Format: date

Example"2024-06-15"

orderNumberstringnon-nullrequired

Human-readable order number

Example"SO-2024-00123"

orderStatusstringnon-nullrequired

Current status of the order

Allowed values"PLANNED""CLOSED""RELEASED"

receiptsarray of objectnon-nullrequired

Show item fields

createdDatestringnon-nullrequired

Date the receipt was created

• Format: date

Example"2024-06-15"

grossAmountstringnon-nullrequired

Gross amount including VAT

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

Example"747.50"

idstringnon-nullrequired

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

linesarray of objectnon-nullrequired

Show item fields

fulfilledQuantitystringnon-nullrequired

Quantity fulfilled/picked

• Format: BigDecimal

Example"2.0"

lineItemIdstringnon-nullrequired

Reference to order line item

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

quantitystringnon-nullrequired

Quantity invoiced

• Format: BigDecimal

Example"2.0"

netAmountstringnon-nullrequired

Net amount excluding VAT

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

Example"598.00"

refundsarray of objectnon-nullrequired

Show item fields

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"

shipmentsarray of objectnon-nullrequired

Show item fields

captureIdstringnon-nullrequired

Reference to the capture (picking list) this shipment originated from

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

createdDatestringnullableoptional

Date the shipment was created

• Format: date

Example"2024-06-16"

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 shipped

• Format: BigDecimal

Example"2.0"

trackingNumberstringnullableoptional

Example"1Z999AA10123456784"

trackingUrlstringnullableoptional

Example"https://track.example.com/1Z999AA10123456784"

updatedAtstringnon-nullrequired

• Format: ISO 8681 timestamp

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

vouchersarray of objectnon-nullrequired

Show item fields

externalReferencestringnon-nullrequired

External reference for the voucher

Example"abc123-promo-uuid"

titlestringnullableoptional

Display name for the voucher

Example"Summer Sale 20%"

typestringnullableoptional

Example"PERCENTAGE"

valuestringnullableoptional

• Format: BigDecimal

Example"20.00"

{
  "type": "object",
  "properties": {
    "captures": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/snowbee.SbPublicApiCaptureResponse"
      },
      "title": "List<SbPublicApiCaptureResponse>"
    },
    "currencyIsoCode": {
      "type": "string",
      "description": "ISO 4217 currency code",
      "example": "NOK",
      "title": "String"
    },
    "customerId": {
      "type": "string",
      "description": "Customer ID associated with the order",
      "example": "01234567-89ab-cdef-0123-456789abcdef",
      "title": "String"
    },
    "deliveryAddress": {
      "$ref": "#/components/schemas/snowbee.SbPublicApiDeliveryAddressResponse"
    },
    "externalOrderId": {
      "type": [
        "null",
        "string"
      ],
      "description": "External order ID from your e-commerce platform",
      "example": "SHOP-123",
      "title": "String"
    },
    "externalOrderNumber": {
      "type": [
        "null",
        "string"
      ],
      "description": "External order number displayed to customer",
      "example": "WEB-2024-00123",
      "title": "String"
    },
    "freight": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/components/schemas/snowbee.SbPublicApiFreightResponse"
        }
      ]
    },
    "id": {
      "type": "string",
      "example": "01234567-89ab-cdef-0123-456789abcdef",
      "title": "String"
    },
    "invoiceAddress": {
      "$ref": "#/components/schemas/snowbee.SbPublicApiInvoiceAddressResponse"
    },
    "lineItems": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/snowbee.SbPublicApiOrderLineItemResponse"
      },
      "title": "List<SbPublicApiOrderLineItemResponse>"
    },
    "orderDate": {
      "type": "string",
      "format": "date",
      "description": "Date the order was placed",
      "example": "2024-06-15",
      "title": "LocalDate"
    },
    "orderNumber": {
      "type": "string",
      "description": "Human-readable order number",
      "example": "SO-2024-00123",
      "title": "String"
    },
    "orderStatus": {
      "$ref": "#/components/schemas/snowbee.SbPublicApiOrderStatus",
      "description": "Current status of the order"
    },
    "receipts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/snowbee.SbPublicApiReceiptResponse"
      },
      "title": "List<SbPublicApiReceiptResponse>"
    },
    "refunds": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/snowbee.SbPublicApiRefundResponse"
      },
      "title": "List<SbPublicApiRefundResponse>"
    },
    "shipments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/snowbee.SbPublicApiShipmentResponse"
      },
      "title": "List<SbPublicApiShipmentResponse>"
    },
    "updatedAt": {
      "type": "string",
      "format": "ISO 8681 timestamp",
      "example": "2025-10-28T12:37:42Z",
      "title": "ISO8681"
    },
    "vouchers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/snowbee.SbPublicApiVoucherResponse"
      },
      "title": "List<SbPublicApiVoucherResponse>"
    }
  },
  "required": [
    "captures",
    "currencyIsoCode",
    "customerId",
    "deliveryAddress",
    "id",
    "invoiceAddress",
    "lineItems",
    "orderDate",
    "orderNumber",
    "orderStatus",
    "receipts",
    "refunds",
    "shipments",
    "updatedAt",
    "vouchers"
  ],
  "title": "SbPublicApiGetOrderResponse"
}