GetProducts()

This method exports products from an order source given a set of parameters.

Syntax

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

GetProductsRequest

A request to get product information

NameTypeNullable?Description
auth

Auth

The authorization information necessary to fulfill this request.

product_ids

string[]

The product ids to get data for

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

GetProductsResponse

The response for the GetProducts method

NameTypeNullable?Description
products

Product[]

The list of Products