PlentyONE Shop Docs

Appearance

@plentymarkets/shop-api / returnGetters

Variable: returnGetters ​

const returnGetters: object

Defined in: getters/returnGetters.ts:121

Type declaration ​

getDate() ​

getDate: (returnItem) => string

Parameters ​

returnItem ​

Order

Returns ​

string

getDefaultReturnReasonId() ​

getDefaultReturnReasonId: (data) => null | number

Parameters ​

data ​

OrderReturnsResponse

Returns ​

null | number

getFormattedPrice() ​

getFormattedPrice: (price) => string

Parameters ​

price ​

number

Returns ​

string

getId() ​

getId: (returnItem) => string

Parameters ​

returnItem ​

Order

Returns ​

string

getItemName() ​

getItemName: (item) => string

Parameters ​

item ​

OrderItem

Returns ​

string

getItemPrice() ​

getItemPrice: (item) => number

Parameters ​

item ​

OrderItem

Returns ​

number

getItemQty() ​

getItemQty: (item) => number

Parameters ​

item ​

OrderItem

Returns ​

number

getItems() ​

getItems: (returnItem) => OrderItem[]

Parameters ​

returnItem ​

Order

Returns ​

OrderItem[]

getItemSku() ​

getItemSku: (item) => string

Parameters ​

item ​

OrderItem

Returns ​

string

getItemVariationId() ​

getItemVariationId: (item) => number

Parameters ​

item ​

OrderItem

Returns ​

number

getOrderItemLink: (order, productId) => string

Parameters ​

order ​

Order

productId ​

number

Returns ​

string

getOrderItemReturnReason() ​

getOrderItemReturnReason: (returnItem) => null | OrderReturnReason

Parameters ​

returnItem ​

OrderItem

Returns ​

null | OrderReturnReason

getOrderItemReturnReasonId() ​

getOrderItemReturnReasonId: (returnItem) => number

Parameters ​

returnItem ​

OrderItem

Returns ​

number

getOrderItemReturnReasonName() ​

getOrderItemReturnReasonName: (returnItem) => string

Parameters ​

returnItem ​

OrderItem

Returns ​

string

getOrders() ​

getOrders: (returns) => Order[]

Parameters ​

returns ​

GetReturnsResponse

Returns ​

Order[]

getOrdersTotal() ​

getOrdersTotal: (returns) => number

Parameters ​

returns ​

GetOrdersResponse

Returns ​

number

getPagination() ​

getPagination: (returns) => AgnosticPagination

Parameters ​

returns ​

GetOrdersResponse

Returns ​

AgnosticPagination

getPrice() ​

getPrice: (returnItem) => number

Parameters ​

returnItem ​

Order

Returns ​

number

getReturnReasonId() ​

getReturnReasonId: (reason) => number

Parameters ​

reason ​

OrderReturnReason

Returns ​

number

getReturnReasonName() ​

getReturnReasonName: (reason) => string

Parameters ​

reason ​

OrderReturnReason

Returns ​

string

getReturnReasons() ​

getReturnReasons: (data) => OrderReturnReason[]

Parameters ​

data ​

OrderReturnsResponse

Returns ​

OrderReturnReason[]

getStatus() ​

getStatus: (returnItem) => string

Parameters ​

returnItem ​

Order

Returns ​

string