Edit line item

put

https://api.instellix.io/v2/orders/{orderIdent}/lineItems/{lineItemIdent}

A request to edit an existing line item within an order.

Path Params

orderIdent

string

required

length between 1 and 100

The ident of the order to edit a line item

lineItemIdent

string

required

Body Params

A request to update a line item. All the fields are optional - if provided, they will overwrite the value(with the exception of properties) Item properties will be merged based on property key(ident).

articleNumber

string | null

e.g. article number, SKU, ISBN, not unique. Max 32 Chars. Size must be between 0 and 32.

category

string

enum

required

Category of the line item, might be used for different tax rates. Must not be null.

debitCreditIndicator

string

enum

required

Determines if the given item has a debit or credit impact on your business. Must not be null.

Allowed:

deliveryDate

date-time | null

The planned delivery date.

description

string | null

Any additional description, might be printed on the document. Size must be between 0 and 255.

group

string | null

The group to which an item belongs. Max 64 chars. Size must be between 0 and 64.

name

string

required

length ≤ 255

Name of the item. Must not be blank. Size must be between 0 and 255.

operatingSiteIdent

string | null

Operating site of the item. Only predefined operating site identifiers are allowed.

originalRowTotalGross

object | null

A monetary amount along with a currency.

originalRowTotalNet

object | null

A monetary amount along with a currency.

performanceLocation

object | null

Where the service has been provided. Used for tax calculation and can be printed on documents.

periodEndDate

date-time | null

End date for line items that span a certain period of time. Supports ISO 8601 offset information.

periodStartDate

date-time | null

Start date for line items that span a certain period of time. Supports ISO 8601 offset information.

postTaxExtras

array of objects | null

Price reductions (e.g. voucher) applied to this line item. These extras don't reduce the tax amount.

postTaxExtras

preTaxExtras

array | null

Price reductions (e.g. voucher) applied to this line item that also reduce the tax amount.

preTaxExtras

properties

array of objects | null

Additional item properties

properties

rowTotalGross

object | null

A monetary amount along with a currency.

rowTotalNet

object | null

A monetary amount along with a currency.

serviceCountry

string | null

enum

deprecated

DEPRECATED. Deprecated: Use tax location and performance location instead. The country where the product or service was sold. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.

serviceLocation

object | null

deprecated

Deprecated: Use detailedTaxLocation and detailedPerformanceLocation instead. The location where the product or service was sold.

taxInformation

array of objects | null

All tax information for this order item.

taxInformation

taxLocation

object | null

Where the service is taxable. Can be provided, but might be overwritten during tax calculation.

taxScheme

string | null

enum

It defines tax trading procedure of an item.

Allowed:

type

string | null

enum

Type of the line item. Determines if this item was a service rendered to your customer (sales) or by your customer (self-billing)

Allowed:

unitPriceGross

object | null

A monetary amount along with a currency.

unitPriceNet

object

required

A monetary amount along with a currency.

unitQuantity

number

required

Number of units. Must not be null.

unitQuantityType

string

enum

required

The type of quantity that units are measured in. Will be one of:. Must not be null.

Responses

200Standard response for successful HTTP requests.

4XXerror response for all http error codes in range 4XX

5XXerror response for all http error codes in range 5XX