CancelSalesOrderItems()

This method is called when a items are requesting to be cancelled on the order if the order source supports it.

Syntax

module.exports = async function CancelSalesOrderItems(request) {
// Your code here
}
import {
CancelSalesOrderItemsRequest,
CancelSalesOrderItemsResponse
} from "@shipengine/connect-order-source-api";
export const CancelSalesOrderItems = async (
request: CancelSalesOrderItemsRequest
): Promise<CancelSalesOrderItemsResponse> => {
// Your code here
}

CancelSalesOrderItemsRequest

A request to cancel a number of sales order items in a sales order

NameTypeNullable?Description
auth

Auth

The authorization information necessary to fulfill this request.

notifications

CancelSalesOrderItemsNotification[]

The notifications.

sales_order_status_mapping

SalesOrderStatusMapping[]

seller specified mappings for custom statuses coming from the 3rd parties api and the SalesOrderStatus they should map to.

transaction_idstring

A randomly generated transaction ID, used to correlate the request and response

CancelSalesOrderItemsResponse

A response for the cancel action that was performed on any number of sales order items

NameTypeNullable?Description
results

CancelSalesOrderItemsResult[]

The results from this request.