@shipengine/connect-order-source-api/lib/app/metadata/order-source-specification.d.ts

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

import { AccountConnectionSpecification } from './account-connection-specification';
import Joi from 'joi';
import { PackingSlipTemplateVersion } from '../../models/packing-slip-template-version';
import { CustomFieldOption, StoreSetting } from '../../models';
/** @description This represents a single branded order source within our system */
export declare class OrderSourceDefinition {
    /** @description This is a unique GUID identifier for this order source */
    Id: string;
    /** @description The branded name for this order source @example "Shopify", "eBay", "Amazon Canada" */
    Name: string;
    /** @description A human readable, snake cased identifier for this order source @example "shopify", "ebay", "amazon_ca" */
    ApiCode?: string;
    /** @description Indicates whether or not our system is allowed to send emails to customers */
    SendEmail: boolean;
    /** @deprecated This field is no longer used, supply CustomValueOptions instead */
    HasCustomMappings?: boolean;
    /** @description Indicates whether or not orders can be refreshed @deprecated This field will now be based off of whether or not SalesOrdersExport is implemented. */
    CanRefresh?: boolean;
    /** @description Indicates whether or not the order source allows sellers to leave feedback on customers */
    CanLeaveFeedback: boolean;
    /** @description Indicates whether or not the order source can confirm an order has been shipped @deprecated This field will now be based off of whether or not ShipmentNotification is implemented. */
    CanConfirmShipments?: boolean;
    /** @description Indicates that refreshing is disabled within our platform @deprecated This field will now be based off of whether or not SalesOrdersExport is implemented. */
    IsRefreshDisabled?: boolean;
    /** @description Indicates whether this order source allows for custom statuses on a seller by seller basis */
    HasCustomStatuses: boolean;
    /** @description Indicates whether or not a user is allowed to configure their own timezone */
    CanConfigureTimeZone: boolean;
    /** @description Indicates whether or not the order source has inventory levels */
    HasInventoryLevels?: boolean;
    /** @description Specifies account connection information */
    AccountConnection: AccountConnectionSpecification;
    /** @description Images that will be used for this branded order source */
    Images: {
        /** @description The full path to the logo used in modals and other areas of our platform for this order source. Use join(__dirname, '../assets/logo.svg') @example "/dev/integration/assets/ordersource1/logo.svg" */
        Logo: string;
        /** @description The full path to the icon used for this order source. Use join(__dirname, '../assets/logo.svg') @example "/dev/integration/assets/ordersource1/icon.svg" */
        Icon: string;
    };
    /** @description This lets the platform know which packing slip templates this order source supports */
    SupportedPackingSlipTemplateVersions?: PackingSlipTemplateVersion[];
    /** @description This tells the UI which options are available for custom fields */
    CustomFieldOptions?: CustomFieldOption[];
    /** @description Additional settings which can be configured outside of the registration modal */
    StoreSettings?: StoreSetting[];
}
export declare const OrderSourceDefinitionSchema: Joi.ObjectSchema<any>;