Sign in
Sales Order Refund Line Item

Update a specific refund line item for a sales order

put/api/sales-orders/{salesOrderId}/refund-line-items/{lineItemId}

Path parameters

salesOrderIdstring required
lineItemIdstring required

Request body

descriptionstring nullable

The refund line item description.

refundQuantitynumber double required

The quantity to be refunded.

refundAmountnumber double required

The refund amount.

accountingCodeIdstring nullable

Accounting code key identifier. Please reference /api/accounting-codes endpoint.

refundReasonCodeIdstring nullable

Refund reason code key identifier. Please reference /api/refund-reason-codes endpoint.

isReturnboolean nullable

Indicate if a return is expected.

returnQuantitynumber double nullable

The quantity to be returned.

externalReferencesobject nullable

Arbitrary key-value-pair like data that can be used to later on search for this line item.

Response

Refund line item

idstring required

Unique id associated to this entity.

refundedLineIdstring required

The related, original line id that was refunded.

namestring required

The line item name.

descriptionstring nullable

The refund line item description. Defaults to the item's description if none specified.

refundQuantitynumber double required

The quantity to be refunded.

refundAmountnumber double required

The refund amount.

accountingCodeIdstring nullable

Accounting code key identifier. Please reference /api/accounting-codes endpoint.

refundReasonCodeIdstring nullable

Refund reason code key identifier. Please reference /api/refund-reason-codes endpoint.

isReturnboolean nullable

Indicate if a return is expected.

returnQuantitynumber double nullable

The quantity to be returned.

externalReferencesobject nullable

Arbitrary key-value-pair like data that can be used to later on search for this line item.

numberinteger

Line number

Changes

No recorded changes to this endpoint across all 23 revisions of this API.