VerifyDeliveryOptions()

This method is called when a user is initiating the registration process to add delivery options.

Syntax

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

VerifyDeliveryOptionsRequest

A request to verify if a user's order source is configured properly for delivery options

NameTypeNullable?Description
auth

Auth

The authorization information necessary to fulfill this request.

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

VerifyDeliveryOptionsResponse

The response to a SupportsDeliveryOptions method

NameTypeNullable?Description
is_supportedboolean

Indicates whether or not a delivery option is supported