🔒 Create sales order line item V3

post

https://{xentralId}.xentral.biz/api/v3/salesOrders/{id}/lineItems

This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.

This endpoint requires the following scopes: salesOrder:update.

Create a new sales order line item.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Body Params

product

object

required

Product information.

quantity

float

required

Quantity of the line item.

name

string

length ≤ 255

Line item name. If not provided, the product name will be used.

number

string

length ≤ 255

Line item number. If not provided, the product number will be used.

description

string

Line item description. If not provided, the product description will be used.

countryOfOrigin

string

length ≤ 128

Country of origin for the product. If not provided, the product's country of origin will be used.

hsCode

string

length ≤ 128

Harmonized System (HS) code for the product. If not provided, the product's HS code will be used.

deliveryDate

date

Delivery date of the line item.

deliveryDateAsCalendarWeek

boolean

Defaults to false

Whether to show the delivery date as calendar week or explicit.

internalComment

string

Internal comment for the line item.

customerProductNumber

string

length ≤ 128

Customer product number for the line item.

discount

float

Discount percentage

price

object

Price information

taxLegalNotice

string

length ≤ 255

Legal notice regarding tax for this line item

printSettings

object

Print settings for this line item

externalNumber

string

length ≤ 255

External number for the line item, typically used for shop/web order line item references.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized

403

Forbidden

404

Not Found

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

201Create a new sales order line item.

400Failed validation

409Problem occurred

429Too Many Requests