Options
All
  • Public
  • Public/Protected
  • All
Menu

Module PushReturnOrder

Creates a returnorder with all specified data

It is required to send the identifier for the ReturnOrder of the external system by providing a BackendSystemID and a BackendID.

A return is based of an OriginalOrder. This order can be identifier by the OriginalBackendID or the OriginalOrderID. One of those is required.

If the stock is already received, set the AlreadyReceived to true. This will ship the order immediately.

If the stock is already received and the open amount should be refunded directly, set AutoRefund to true.

The Lines have to be identified by the original line, this should be done by providing the OriginalBackendID or the OriginalOrderLineID. If those are not available the CustomID of the product can be set, but matching based on that is not advised.

Index

Properties

Optional AlreadyReceived

AlreadyReceived: undefined | false | true

Ship the order immediately

Optional AutoRefund

AutoRefund: undefined | false | true

Try to refund the order immediately

BackendID

BackendID: string

A unique identifier for the order, within the context of given BackendSystemID

BackendSystemID

BackendSystemID: string

A code, free of choice for the calling 3rd party application creating the order

Optional CustomFields

CustomFields: undefined | {}

Optional IsCustomerReturn

IsCustomerReturn: undefined | false | true

If this order pending a customer return

Lines

Optional OriginalBackendID

OriginalBackendID: undefined | string

The unique identifier of the original order, within the context of given BackendSystemID

Optional OriginalOrderID

OriginalOrderID: undefined | number

Entity type: Order

Optional Remark

Remark: undefined | string

Remark on the order (optional)

Optional ReturnCosts

ReturnCosts: PushReturnCostsLine

Optional ReturnToOrganizationUnitBackendID

ReturnToOrganizationUnitBackendID: undefined | string

Identifier for the organizationunit where the stock will be returned

Optional StockOrganizationUnitID

StockOrganizationUnitID: undefined | number

Entity type: OrganizationUnit