Create sales order

customerIdstringnullableoptional

Customer ID to associate 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

Contact email for delivery notifications

Example"ola.nordmann@example.com"

namestringnon-nullrequired

Recipient name

Example"Ola Nordmann"

phonestringnullableoptional

Contact phone for delivery

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-ORD-12345"

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

Example"25.00"

netFreightAmountstringnullableoptional

Net freight/shipping cost amount (excl. VAT)

• Format: BigDecimal

Example"49.00"

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

Either skuId or skuNumber must be provided.

campaignCodestringnullableoptional

Code of the campaign this line was sold under, as returned by GET /campaigns. Send it on every line sold under a campaign. For a NORMAL campaign the line must be priced at that SKU's campaignPrice. For a THREE_FOR_TWO, price the line at the basket's answer -- the blended per-unit price after the offer, at most the SKU's normal price -- exactly as a cash register would. Rejected if the code is not a released campaign covering the SKU at the sale instant, or if the line's price does not bear the campaign out.

Example"SUMMER24"

netUnitOrderDiscountAmountstringnullableoptional

Per-unit reduction taken on top of netUnitPrice, such as a gift voucher or a coupon share spread across the order's lines. Not for a campaign price or any other markdown belonging in netUnitPrice: summed into one figure, a campaign markdown and a voucher cannot be told apart afterwards.

• Format: BigDecimal

Example"10.00"

netUnitPricestringnon-nullrequired

Price of one unit excluding VAT, as charged to the customer. Send the price after any campaign price or markdown -- not a list price. Where the line was sold under a campaign, this must be that campaign's campaignPrice from GET /campaigns.

• Format: BigDecimal

Example"299.00"

quantitystringnon-nullrequired

Quantity ordered

• Format: BigDecimal

Example"2.0"

skuIdstringnullableoptional

SKU ID of the product (provide either skuId or skuNumber)

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

skuNumberstringnullableoptional

SKU number/code of the product (provide either skuId or skuNumber)

Example"PROD-BLK-M"

vatRatestringnon-nullrequired

VAT rate as percentage

• Format: BigDecimal

Example"25.00"

vouchersarray of objectnullableoptional

Show item fields

externalReferencestringnon-nullrequired

External reference for the voucher (e.g. loyalty program promotion UUID)

Example"abc123-promo-uuid"

titlestringnullableoptional

Display name for the voucher

Example"Summer Sale 20%"

typestringnullableoptional

Allowed values"deleted"

valuestringnullableoptional

Discount value (percentage 0-100 or fixed amount)

• Format: BigDecimal

Example"20.00"

View schema definition