SalesOrdersExport()

This method exports a list of sales orders from an order source given a set of parameters.

Syntax

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

SalesOrdersExportRequest

A request to export a range of sales orders

NameTypeNullable?Description
auth

Auth

The authorization information necessary to fulfill this request.

criteria

SalesOrderExportCriteria

The criteria of which sales orders to retrieve

cursorstring

Information needed to get this current batch of orders if necessary, this will be set by the export sales order response if there are additional orders to be retrieved. @example "23", "65f3873f-8ece-4429-935d-e35cbeeab5d5"

sales_order_field_mappings

SalesOrderCustomFieldMappings

Allows for mapping of custom 3rd party SalesOrder fields to properties on RequestedFulfillmentExtensions

sales_order_status_mapping

SalesOrderStatusMapping[]

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

sales_order_status_mappings

SalesOrderCustomStatusMappings

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

SalesOrdersExportResponse

The response from an ExportSalesOrders method

NameTypeNullable?Description
cursorstring

Any information necessary to make the next call to retrieve orders (paging, etc). If all orders have been retrieved return undefined @example '343', 'f356bf8c-665d-4164-96ef-337876d958ea'

sales_orders

SalesOrder[]

A list of sales orders to be imported