@shipengine/connect-order-source-api
Version:
This is the typescript/javascript definitions for the order source api
60 lines (59 loc) • 1.83 kB
TypeScript
import Joi from 'joi';
import { WeightUnit } from './weight';
export declare class SourceDetails {
/**
* @description The name of the plan the user is on
* @example "Plus Store Monthly"
*/
subscription_plan_name?: string;
/**
* @description The level of the plan the user is on
* @example "Gold"
*/
subscription_plan_level?: string;
/**
* @description The name for the order source
* @example "Justin's Flower Imporiuim"
*/
source_name?: string;
/**
* @description The email associated with the order source
* @example "justin@flowerimporium.com"
*/
email?: string;
/**
* @description The phone number associated with the order source
* @example "555-555-5555"
*/
phone?: string;
/**
* @description The locale of the user's account (ISO 639-1 standard language codes)
* @example "en-us"
*/
locale?: string;
/**
* @description The website of the order source
* @example "https://www.selling.com"
*/
website?: string;
/**
* @description Indicates whether the order source supports multiple ship from locations
* @example "true" or "false"
*/
multilocation_enabled?: 'true' | 'false';
/**
* @description The default unit of measurement for weight used by the order source
* @example "Gram", "Ounce", "Kilogram", "Pound"
*/
weight_unit?: WeightUnit;
/**
* @description The default currency code used by the order source (ISO 4217)
* @example "USD", "CAD", "EUR", "GBP"
*/
currency_code?: string;
/**
* @description Additional properties that will be sent back in subsequent requests
*/
[key: string]: string | undefined;
}
export declare const SourceDetailsSchema: Joi.ObjectSchema<any>;