RemoveDeliveryOptions()

This method is called when a user is removing delivery options from the order source.

Syntax

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

RemoveDeliveryOptionsRequest

A request to remove delivery options connection with an order source

NameTypeNullable?Description
auth

Auth

The authorization information necessary to fulfill this request.

connection_idstring

Identifier for the connection in the order source

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

RemoveDeliveryOptionsResponse

The response for a RemoveDeliveryOptions method

NameTypeNullable?Description
failure_reasonstring

The reason why removing this request failed.

succeededboolean

Indicates whether or not this request succeeded.