RegisterDeliveryOptions()

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

Syntax

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

RegisterDeliveryOptionsRequest

A request to register delivery options with an order source

NameTypeNullable?Description
auth

Auth

The authorization information necessary to fulfill this request.

callback_urlstring

Callback url to register with the order source

marketplace_keystring

Key to be returned in delivery options calls from the order source. This could be a GUID that is defined by the caller of the OrderSourceAPI and returned by the order source in later calls

option_keystring

Option set identifier to be returned in delivery options calls from 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 the request failed.

succeededboolean

Indicates whether or not the request succeeded