@shipengine/connect-order-source-api
Version:
This is the typescript/javascript definitions for the order source api
39 lines • 2.44 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.SalesOrdersExportRequest = exports.SalesOrderCustomStatusMappings = exports.SalesOrderCustomFieldMappings = exports.SalesOrderExportCriteria = void 0;
const request_base_1 = require("./request-base");
/** @description This represents the requested criteria for exporting order sources */
class SalesOrderExportCriteria {
/** @description The (ISO 8601) datetime (UTC) associated with the beginning of the range we would like to pull orders from @example "2021-03-31T18:21:14.858Z" */
from_date_time;
/** @description The (ISO 8601) datetime (UTC) associated with the end of the range we would like to pull orders from @example "2021-03-31T18:21:14.858Z" */
to_date_time;
}
exports.SalesOrderExportCriteria = SalesOrderExportCriteria;
/** @description Allows for mapping of custom 3rd party SalesOrder fields to properties on RequestedFulfillmentExtensions */
class SalesOrderCustomFieldMappings {
/** @description custom field 1 */
custom_field_1;
/** @description custom field 2 */
custom_field_2;
/** @description custom field 3 */
custom_field_3;
}
exports.SalesOrderCustomFieldMappings = SalesOrderCustomFieldMappings;
/** @description Seller specified mappings for custom statuses coming from the 3rd parties api and the SalesOrderStatus they should map to. */
class SalesOrderCustomStatusMappings {
}
exports.SalesOrderCustomStatusMappings = SalesOrderCustomStatusMappings;
/** @description A request to export a range of sales orders */
class SalesOrdersExportRequest extends request_base_1.RequestBase {
/** @description The criteria of which sales orders to retrieve */
criteria;
/** @description 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" */
cursor;
/** @description Allows for mapping of custom 3rd party SalesOrder fields to properties on RequestedFulfillmentExtensions */
sales_order_field_mappings;
/** @description seller specified mappings for custom statuses coming from the 3rd parties api and the SalesOrderStatus they should map to. */
sales_order_status_mappings;
}
exports.SalesOrdersExportRequest = SalesOrdersExportRequest;
//# sourceMappingURL=sales-orders-export-request.js.map