UNPKG

@shipengine/connect-order-source-api

Version:

This is the typescript/javascript definitions for the order source api

23 lines (22 loc) 944 B
import Joi from 'joi'; /** * @description A Custom Field Option describes a possible value that a store could * send as a `sales_order_field_mapping` during `sales_orders_export` requests */ export declare class CustomFieldOption { /** * @description The name of the field being requested, which will be sent as`custom_field_*` when chosen by the seller. * This value is expected to be unique per integration. */ Field: string; /** @description The name of this option to use in the UI */ DisplayName: string; /** @description Set to true if this option must be enabled by support */ IsAdmin?: boolean; /** * @description Set to true if this option shouldn't be shown in the UI. * This does not prevent the option from being sent to the API for stores which have already chosen it */ IsDeprecated?: boolean; } export declare const CustomFieldOptionSchema: Joi.ObjectSchema<any>;