import { Extractor, Context, Response } from "./common"; interface Endpoint { expectStatus(v: number): Self; send(): Promise>; sendUnwrap(): Promise; clone(): Self; } export interface Achievements { add_contact_details: boolean; add_custom_domain: boolean; create_first_product: boolean; sign_up: boolean; } export interface Activity { /** Button text if there is a button */ button_text: string; /** Button URL if there is a button */ button_url: string; /** Date and time when activity was created */ created_at: string; /** Whether this activity is enabled or not */ enabled: boolean; /** Whether activity is ended based on server time */ ended: boolean; /** The date and time when the activity will end */ ends_at: string | null; /** Unique activity identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Image file for this activity */ image_file?: { id: string; } | File | null; /** Message of the card */ message: string; /** Whether activity is started based on server time */ started: boolean; /** Date and time when the activity becomes active */ starts_at: string; /** Title of the card */ title: string; /** Activity type */ type: ActivityType; /** Date and time when activity was last updated */ updated_at: string; } export interface ActivityPage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export declare type ActivityType = "event" | "help" | "legal" | "milestones" | "new_features" | "privacy" | "resources" | "security" | "setup_progress"; export interface Address { /** Mailing address */ address1: string; /** Additional line for mailing address */ address2: string; /** The city */ city: string; /** The company */ company: string; /** The country */ country?: { id: string; } | InfoCountry | null; /** Unique address identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Geographic coordinate specifying the north/south location of an address */ latitude: number; /** Geographic coordinate specifying the east/west location of an address */ longitude: number; /** The name */ name: string; /** The phone number */ phone: string; /** The plus code */ plus_code: string; /** The province */ province?: { id: string; } | InfoProvince | null; /** The zip or postal code */ zip: string; } export interface AddressCreate { /** Mailing address */ address1: string; /** Additional line for mailing address */ address2?: string | null; /** The city */ city: string; /** The company */ company?: string | null; /** The two-letter code for the country */ country: string; /** Unique address identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id?: string | null; /** The name */ name: string; /** The phone number */ phone?: string | null; /** The plus code */ plus_code?: string | null; /** The two-letter code for the province or state */ province: string; /** The zip or postal code */ zip: string; } export interface AddressShort { /** The city */ city: string; /** The country */ country?: { id: string; } | InfoCountry | null; /** Unique address identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Geographic coordinate specifying the north/south location of an address */ latitude: number; /** Geographic coordinate specifying the east/west location of an address */ longitude: number; /** The province */ province?: { id: string; } | InfoProvince | null; /** The zip or postal code */ zip: string; } export interface AddressShortCreate { /** The city */ city: string; /** The two-letter code for the country */ country: string; /** The two-letter code for the province or state */ province: string; /** The zip or postal code */ zip?: string | null; } export interface AddressVerification { address: Array; address1: string; address2: string; city: string; company: string; country: string; /** Formatted address as a newline separated string */ formatted_address: string; latitude: number; longitude: number; province: string; /** This field is used internally, it's always empty in public API */ raw_response: string; /** Address verification status */ status: AddressVerificationStatus; status_codes: Array; zip: string; /** ZIP / Postal code type */ zip_type: ZipCodeType; } export declare type AddressVerificationStatus = "error" | "invalid" | "pending" | "verified" | "warning"; export interface AnalyticsCustomReports { data: string; } export interface AnalyticsCustomReportsCreate { data: string; } export interface AnalyticsDashboard { data: string; } export interface AnalyticsDashboardCreate { data: string; } export interface AnalyticsQuery { query: string; variables: Array; } export interface AnalyticsReport { columns: Array; meta: Array; rows1: Array; rows2: Array; } export interface AnalyticsReportParameters { /** Report identifier to use associated query from */ report_id: string; variables: Array; } export interface AnalyticsReportRow { columns: Array; } export interface AnswerCreate { /** Whether flagging actions are ignored */ flag_ignore?: boolean | null; /** Publishing approval status */ status?: ApprovalStatus | null; /** Text of the answer */ text: string; } export interface AnswerModify { /** Whether flagging actions are ignored */ flag_ignore?: boolean | null; /** Publishing approval status */ status?: ApprovalStatus | null; /** Text of the answer */ text?: string | null; } export interface ApplePayDomain { domain: string; id: string; } export interface ApplePayDomainCreate { domain: string; } export interface ApplyGiftCard { /** Unique generated gift card code (shop owner/users only) */ gift_card_code: string; } export declare type ApprovalStatus = "approved" | "disapproved" | "pending"; export interface Attachment { /** Unique path of the attachment */ path: string; /** Publically accessible URL, valid for few hours */ url: string; } export interface AuditLog { /** Event type */ event: string; geo_accuracy_radius: number; geo_city: string; geo_continent: string; geo_continent_name: string; geo_country: string; geo_country_info?: { id: string; } | InfoCountry | null; geo_country_name: string; geo_latitude: number; geo_longitude: number; geo_metro_code: number; geo_region: string; geo_region_info?: { id: string; } | InfoProvince | null; geo_region_name: string; geo_timezone: string; geo_zipcode: string; /** IP address of the connection through which the API call was made */ ip_address: string; ip_domain: string; ip_isanonymousproxy: boolean; ip_isp: string; ip_issatelliteprovider: boolean; ip_netspeed: string; ip_organization: string; /** ID of the item affected if any */ item_id: string; /** ID of the parent item of the affected item if any */ parent_id: string; payload: string; session_id: string; /** Date and time when the API call was made */ timestamp: string; user?: { id: string; } | User | null; } export interface AuditLogPage { /** Total number of items in the collection */ count: number; items: Array; } export interface AuspostOptions { auth_key: string; } export interface AuspostOptionsCreate { auth_key: string; } export interface Blog { /** Images referenced by "raw_content". */ content_image_files: Array<{ id: string; } | File | null>; /** The date and time when blog was created, RFC 3339 format */ created_at: string; /** A unique blog identifier */ id: string; revisions: Array; /** The date and time when blog was last updated, RFC 3339 format */ updated_at: string; } export interface BlogExpandableItems { /** Generic array of expandable items */ items: Array<{ id: string; } | Blog | null>; } export declare type BlogFilterType = "any" | "draft" | "public"; export interface BlogPage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export interface BlogRevision { /** Topic of this revision */ blog_topic?: { id: string; } | BlogTopic | null; /** The date and time when blog revision was created, RFC 3339 format */ created_at: string; /** Images file for this blog revision */ image_files: Array<{ id: string; } | File | null>; /** 2-letter language code */ language: string; /** Meta description for SEO purposes */ meta_description: string; /** SEO-friendly title of the content block */ meta_title: string; /** Whether server thinks blog is published or not (depends on server time) */ published: boolean; /** The date and time when blog was published or null */ published_at: string | null; /** Raw content of the blog */ raw_content: string; /** Title of the blog */ title: string; /** The date and time when blog revision was last bumped, RFC 3339 format */ used_at: string; /** Author of the revision */ user?: { id: string; } | User | null; } export interface BlogTopic { /** The date and time when blog topic was created, RFC 3339 format */ created_at: string; /** A unique blog topic identifier */ id: string; /** Support topic title */ title: string; /** The date and time when blog topic was last updated, RFC 3339 format */ updated_at: string; } export declare type BlogsPageSortBy = "created_at" | "updated_at"; export interface Brand { /** Image files referenced by "raw_content". */ content_image_files: Array<{ id: string; } | File | null>; /** The date and time when the brand was created, RFC 3339 format */ created_at: string; /** Custom field objects extracted and ready for expansion */ custom_field_objects: CustomFieldObjects | null; custom_fields: Array; /** States whether or not the brand is featured */ featured: boolean; /** An URL-friendly unique string for the brand automatically generated from its title */ handle: string; /** Unique brand identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Image files for this brand */ image_files: Array<{ id: string; } | File | null>; /** Meta description for SEO purposes */ meta_description: string; /** SEO-friendly title of the brand */ meta_title: string; /** Whether server thinks brand is published or not (depends on server time) */ published: boolean; /** The date and time when the brand was published or null */ published_at: string | null; /** Raw content of the brand */ raw_content: string; /** The default order in which products on the brand page are listed */ sort_order: BrandSortOrder; /** The name of the brand */ title: string; /** The date and time when the brand was last updated, RFC 3339 format */ updated_at: string; /** Brand home page */ website: string; } export interface BrandCreate { custom_fields?: Array | null; /** States whether or not the brand is featured */ featured?: boolean | null; /** An URL-friendly unique string for the brand automatically generated from its title */ handle?: string | null; image_file_ids?: Array | null; /** Meta description for SEO purposes */ meta_description?: string | null; /** SEO-friendly title of the brand */ meta_title?: string | null; /** Whether server thinks brand is published or not (depends on server time) */ published?: boolean | null; /** The date and time when the brand was published or null */ published_at?: string | null; /** Raw content of the brand */ raw_content?: string | null; /** The default order in which products on the brand page are listed */ sort_order?: BrandSortOrder | null; /** The name of the brand */ title: string; /** Brand home page */ website?: string | null; } export interface BrandExpandableItems { /** Generic array of expandable items */ items: Array<{ id: string; } | Brand | null>; } export interface BrandModify { custom_fields?: Array | null; /** States whether or not the brand is featured */ featured?: boolean | null; /** An URL-friendly unique string for the brand automatically generated from its title */ handle?: string | null; image_file_ids?: Array | null; /** Meta description for SEO purposes */ meta_description?: string | null; /** SEO-friendly title of the brand */ meta_title?: string | null; /** Whether server thinks brand is published or not (depends on server time) */ published?: boolean | null; /** The date and time when the brand was published or null */ published_at?: string | null; /** Raw content of the brand */ raw_content?: string | null; /** The default order in which products on the brand page are listed */ sort_order?: BrandSortOrder | null; /** The name of the brand */ title?: string | null; /** Brand home page */ website?: string | null; } export interface BrandPage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export interface BrandSearchResult { /** Total number of items in the collection */ count: number; items: Array<{ id: string; } | Brand | null>; } export declare type BrandSortOrder = "created_at_asc" | "created_at_desc" | "manual" | "min_price_asc" | "min_price_desc" | "num_sold_desc" | "title_asc" | "title_desc"; export interface Branding { fields: Array; } export interface BrandingCreate { fields: Array; } export interface BrandingField { boolean: boolean | null; color: string | null; /** Whether to use this field value as a default one */ default: boolean; /** Description of the field */ description: string; font: string | null; /** Identifier of the field */ id: string; image_file?: { id: string; } | File | null; link: string | null; /** Name of the field */ name: string; radio: string | null; /** Available options for "radio" type */ radio_options: Array; string: string | null; text: string | null; /** Type of the field */ type: BrandingFieldType; } export interface BrandingFieldCreate { boolean?: boolean | null; color?: string | null; default?: boolean | null; font?: string | null; id: string; image_file_id?: string | null; link?: string | null; radio?: string | null; string?: string | null; text?: string | null; /** Type of the field */ type: BrandingFieldType; } export declare type BrandingFieldType = "boolean" | "color" | "font" | "image_file" | "link" | "radio" | "string" | "text"; export declare type BrandsPageSortBy = "created_at"; export interface BundleLineItem { /** Amount of items of a given variant in the bundle */ quantity: number; /** Product variant of the bundle line item */ variant?: { id: string; } | ProductVariant | null; } export interface BundleLineItemCreate { /** Amount of items of a given variant in the bundle */ quantity: number; /** A unique product variant identifier */ variant_id: string; } export interface BuyLink { /** Whether this link is enabled or not */ enabled: boolean; /** ID of the Buy Link, used as part of the URL */ id: string; line_items: Array; /** Human-friendly name of the Buy Link */ name: string; } export interface BuyLinkCreate { /** Whether this link is enabled or not */ enabled?: boolean | null; /** ID of the Buy Link, used as part of the URL */ id: string; line_items: Array; /** Human-friendly name of the Buy Link */ name: string; } export interface BuyLinkLineItem { /** Quantity of items to add to cart */ quantity: number; variant?: { id: string; } | ProductVariant | null; } export interface BuyLinkLineItemCreate { /** Quantity of items to add to cart */ quantity: number; /** A unique product variant identifier */ variant_id: string; } export interface BuyLinkModify { /** Whether this link is enabled or not */ enabled?: boolean | null; line_items?: Array | null; /** Human-friendly name of the Buy Link */ name?: string | null; } export interface CalculatedRefund { line_items: Array; shipping: CalculatedRefundShippingLine | null; } export interface CalculatedRefundLineItem { price: number; tax_city_tax: number; tax_country_tax: number; tax_county_tax: number; tax_excl_price: number; tax_incl_price: number; tax_province_tax: number; tax_special_tax: number; } export interface CalculatedRefundShippingLine { price: number; tax_city_tax: number; tax_country_tax: number; tax_county_tax: number; tax_excl_price: number; tax_incl_price: number; tax_province_tax: number; tax_special_tax: number; } export interface CanadapostOptions { contract_id: string; customer_number: string; password: string; user_id: string; } export interface CanadapostOptionsCreate { contract_id: string; customer_number: string; password: string; user_id: string; } export interface Category { /** Category ancestors */ ancestors: Array; /** Image files referenced by "raw_content". */ content_image_files: Array<{ id: string; } | File | null>; /** The date and time when the category was created, RFC 3339 format */ created_at: string; /** Custom field objects extracted and ready for expansion */ custom_field_objects: CustomFieldObjects | null; custom_fields: Array; /** States whether or not the category is featured */ featured: boolean; /** An URL-friendly unique string for the category automatically generated from its title */ handle: string; /** Whether category has children or not */ has_children: boolean; /** Unique category identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Images files for this category */ image_files: Array<{ id: string; } | File | null>; /** Meta description for SEO purposes */ meta_description: string; /** SEO-friendly title of the category */ meta_title: string; /** Whether server thinks category is published or not (depends on server time) */ published: boolean; /** The date and time when the category was published or null */ published_at: string | null; /** Raw content of the category */ raw_content: string; /** The default order in which products in the category appear */ sort_order: CategorySortOrder; /** The name of the category */ title: string; /** The date and time when the category was last updated, RFC 3339 format */ updated_at: string; } export interface CategoryAncestor { /** An URL-friendly unique string for the category automatically generated from its title */ handle: string; /** Unique category identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** The name of the category */ title: string; } export interface CategoryCount { category?: { id: string; } | Category | null; count: number; } export interface CategoryCreate { custom_fields?: Array | null; /** States whether or not the category is featured */ featured?: boolean | null; /** An URL-friendly unique string for the category automatically generated from its title */ handle?: string | null; image_file_ids?: Array | null; /** Meta description for SEO purposes */ meta_description?: string | null; /** SEO-friendly title of the category */ meta_title?: string | null; /** Parent category ID, specify it to create a nested category */ parent_id?: string | null; /** Whether server thinks category is published or not (depends on server time) */ published?: boolean | null; /** The date and time when the category was published or null */ published_at?: string | null; /** Raw content of the category */ raw_content?: string | null; /** The default order in which products in the category appear */ sort_order?: CategorySortOrder | null; /** The name of the category */ title: string; } export interface CategoryExpandableItems { /** Generic array of expandable items */ items: Array<{ id: string; } | Category | null>; } export interface CategoryModify { custom_fields?: Array | null; /** States whether or not the category is featured */ featured?: boolean | null; /** An URL-friendly unique string for the category automatically generated from its title */ handle?: string | null; image_file_ids?: Array | null; /** Meta description for SEO purposes */ meta_description?: string | null; /** SEO-friendly title of the category */ meta_title?: string | null; /** Parent category ID, specify it to create a nested category */ parent_id?: string | null; /** Whether server thinks category is published or not (depends on server time) */ published?: boolean | null; /** The date and time when the category was published or null */ published_at?: string | null; /** Raw content of the category */ raw_content?: string | null; /** The default order in which products in the category appear */ sort_order?: CategorySortOrder | null; /** The name of the category */ title?: string | null; } export interface CategorySearchResult { /** Total number of items in the collection */ count: number; items: Array<{ id: string; } | Category | null>; } export declare type CategorySortOrder = "created_at_asc" | "created_at_desc" | "manual" | "min_price_asc" | "min_price_desc" | "num_sold_desc" | "title_asc" | "title_desc"; export declare type CertStatus = "acquired" | "error" | "none"; export interface ContentBlock { /** The name of the person who created the content block */ author: string; /** Image files referenced by "raw_content". */ content_image_files: Array<{ id: string; } | File | null>; /** The date and time when the content block was created, RFC 3339 format */ created_at: string; /** Custom field objects extracted and ready for expansion */ custom_field_objects: CustomFieldObjects | null; custom_fields: Array; /** An URL-friendly unique string for the content block automatically generated from its title */ handle: string; /** Unique content block identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Whether this content block is a page or not (available through router path) */ is_page: boolean; /** Meta description for SEO purposes */ meta_description: string; /** SEO-friendly title of the content block */ meta_title: string; /** Whether server thinks content block is published or not (depends on server time) */ published: boolean; /** The date and time when the content block was published or null */ published_at: string | null; /** Raw content of the content block */ raw_content: string; /** The title of the content block */ title: string; /** The date and time when the content block was last updated, RFC 3339 format */ updated_at: string; } export interface ContentBlockCreate { /** The name of the person who created the content block */ author?: string | null; custom_fields?: Array | null; /** An URL-friendly unique string for the content block automatically generated from its title */ handle?: string | null; /** Whether this content block is a page or not (available through router path) */ is_page?: boolean | null; /** Meta description for SEO purposes */ meta_description?: string | null; /** SEO-friendly title of the content block */ meta_title?: string | null; /** Whether server thinks content block is published or not (depends on server time) */ published?: boolean | null; /** The date and time when the content block was published or null */ published_at?: string | null; /** Raw content of the content block */ raw_content?: string | null; /** The title of the content block */ title: string; } export interface ContentBlockExpandableItems { /** Generic array of expandable items */ items: Array<{ id: string; } | ContentBlock | null>; } export interface ContentBlockModify { /** The name of the person who created the content block */ author?: string | null; custom_fields?: Array | null; /** An URL-friendly unique string for the content block automatically generated from its title */ handle?: string | null; /** Whether this content block is a page or not (available through router path) */ is_page?: boolean | null; /** Meta description for SEO purposes */ meta_description?: string | null; /** SEO-friendly title of the content block */ meta_title?: string | null; /** Whether server thinks content block is published or not (depends on server time) */ published?: boolean | null; /** The date and time when the content block was published or null */ published_at?: string | null; /** Raw content of the content block */ raw_content?: string | null; /** The title of the content block */ title?: string | null; } export interface ContentBlockPage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export interface ContentBlockSearchResult { /** Total number of items in the collection */ count: number; items: Array<{ id: string; } | ContentBlock | null>; } export declare type ContentBlocksPageSortBy = "created_at" | "updated_at"; export interface ContentModel { /** Whether this content model is a built-in one */ builtin: boolean; /** Unique content model identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** JSON description of the model (as a string) */ json: string; /** Label of the content model for UI */ label: string; /** User provided name of the content, must be unique */ name: string; } export interface ContentModelCreate { /** JSON description of the model (as a string) */ json: string; /** Label of the content model for UI */ label: string; /** User provided name of the content, must be unique */ name: string; } export interface ContentModelModify { /** JSON description of the model (as a string) */ json?: string | null; /** Label of the content model for UI */ label?: string | null; } export interface Coupon { /** A discount code that can be entered by a customer on checkout */ code: string; /** The date and time when the coupon was created */ created_at: string; /** Unique coupon identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** A number of times this coupon was used */ times_used: number; } export interface CouponBulk { /** Dash every N characters */ dash_section_length?: number | null; /** Format of the generated coupon code */ format: CouponBulkFormat; /** Length of a generated coupon code (without prefix/suffix and dashes) */ length: number; /** Coupon code prefix */ prefix?: string | null; /** Amount of coupons to generate */ quantity: number; /** Coupon code suffix */ suffix?: string | null; } export declare type CouponBulkFormat = "alphabetic" | "alphanumeric" | "numeric"; export interface CouponCreate { /** A discount code that can be entered by a customer on checkout */ code: string; } export interface CouponPage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export declare type CouponsPageSortBy = "created_at"; export interface Currency { /** Additional fee to add when converting to and from this currency (in percents) */ conversion_fee: number | null; /** Currency info */ currency: CurrencyInfo; /** Custom exchange rate to use when converting from primary to this currency */ custom_exchange_rate: number | null; /** Whether it's allowed to place orders in this currency */ enabled: boolean; /** Automatic exchange rate to use when converting from primary to this currency */ exchange_rate: number; /** Currency formatting options */ format: CurrencyFormat; } export interface CurrencyCreate { /** Additional fee to add when converting to and from this currency (in percents) */ conversion_fee?: number | null; /** Currency code */ currency: string; /** Custom exchange rate to use when converting from primary to this currency */ custom_exchange_rate?: number | null; /** Whether it's allowed to place orders in this currency */ enabled?: boolean | null; /** Currency formatting options */ format?: CurrencyFormatCreate | null; } export interface CurrencyFormat { /** What to use as decimal separator */ decimal_separator: string; /** Whether to add decimals or not */ has_decimals: boolean; /** How number is assembled into a string, {} is replaced by the formatted number */ pattern: string; /** What to use as thousands separator */ thousands_separator: string; } export interface CurrencyFormatCreate { /** What to use as decimal separator */ decimal_separator?: string | null; /** Whether to add decimals or not */ has_decimals?: boolean | null; /** How number is assembled into a string, {} is replaced by the formatted number */ pattern: string; /** What to use as thousands separator */ thousands_separator?: string | null; } export interface CurrencyInfo { /** Currency code */ code: string; /** Currency name */ name: string; /** UTF-8 currency symbol */ symbol: string; /** Factor to convert currency to minor currency (e.g. to convert dollar to cents factor of 100 is used) */ to_minor: number; } export interface CurrencyModify { /** Additional fee to add when converting to and from this currency (in percents) */ conversion_fee?: number | null; /** Custom exchange rate to use when converting from primary to this currency */ custom_exchange_rate?: number | null; /** Whether it's allowed to place orders in this currency */ enabled?: boolean | null; /** Currency formatting options */ format?: CurrencyFormatCreate | null; } export interface CurrencyPrice { /** Currency code */ currency: string; /** The minimum advertised price of the product variant */ map_price: number; /** The price of the product variant */ price: number; /** The retail cost of the product variant */ retail_price: number; /** Special price for a product that can be active during a selected period of time */ sale_price: number; tiered_pricing: TieredPricing | null; } export interface CustomField { /** Name */ name: string; /** Value */ value: string; } export interface CustomFieldCreate { /** Name */ name: string; /** Value */ value: string; } export interface CustomFieldObjects { /** Brands referenced by "custom_fields". */ brands: Array<{ id: string; } | Brand | null>; /** Categories referenced by "custom_fields". */ categories: Array<{ id: string; } | Category | null>; /** Content Blocks referenced by "custom_fields". */ content_blocks: Array<{ id: string; } | ContentBlock | null>; /** Files referenced by "custom_fields". */ files: Array<{ id: string; } | File | null>; /** Products referenced by "custom_fields". */ products: Array<{ id: string; } | Product | null>; /** Variants referenced by "custom_fields". */ variants: Array<{ id: string; } | ProductVariant | null>; } export interface Customer { /** Indicates whether the customer has consented to be sent marketing material via email */ accepts_marketing: boolean; /** Saved customer addresses for quick form filling */ addresses: Array
; /** The date and time when the customer information was created */ created_at: string; /** Customer group customer belongs to */ customer_group?: { id: string; } | CustomerGroup | null; /** Default billing address identifier */ default_billing_address_id: string; /** Default stripe payment source id */ default_payment_source_id: string | null; /** Default shipping address identifier */ default_shipping_address_id: string; /** The date and time when the customer was deleted */ deleted_at: string | null; /** The name to display for other customers (under product reviews and such) */ display_name: string; /** The email address of the customer */ email: string; /** Token used for email confirmation */ email_confirmation_token: string; /** Whether customer's email address was confirmed or not */ email_confirmed: boolean; /** Unique customer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Inferred locale of the customer, free-form string in Accept-Language HTTP header format */ inferred_locale: string; /** Whether or not customer's email address looks suspicious (fraud) */ is_disposable_email: boolean; /** Whether or not customer is a guest or not (has password) */ is_guest: boolean; /** Preferred language of the customer */ language?: { id: string; } | InfoLanguage | null; /** Last order customer reserved */ last_order?: { id: string; } | Order | null; metadata: Array; /** The mobile phone number of the customer (used for notifications) */ mobile: string; /** Whether to notify customer via mobile phone or not */ mobile_notifications: boolean; /** Name of the customer */ name: string; /** OAuth2 provider used for registering this account */ oauth_provider?: CustomerOAuthProviderKind; /** The number of orders associated with this customer */ order_count: number; /** Whether customer has password defined */ password_defined: boolean; /** Currency customer prefers */ preferred_currency: string; /** Indicates whether the customer desires to get reminder emails */ reminder_messages: boolean; /** Stripe customer id, if customer is registered with stripe gateway */ stripe_customer_id: string | null; /** Token that gives access to subscription fields */ sub_access_token: string; /** Marks customer as tax-exempt, customer will not be charged any taxes */ tax_exempt: boolean; /** Name of the time zone the customer is in */ timezone: string; /** The total amount of money that the customer has spent at the shop */ total_spent: number; /** The date and time when the customer information was updated */ updated_at: string; } export interface CustomerBalance { /** Customer balance amounts per-currency */ balance: Array; /** Last order customer reserved */ last_order?: { id: string; } | Order | null; /** The number of orders associated with this customer */ order_count: number; /** The total amount of money that the customer has spent at the shop */ total_spent: number; } export interface CustomerBalanceCreate { /** Amount to add/subtract to customer balance */ amount: number; /** Comment describing the change */ comment?: string | null; /** Currency code of the amount to add/subtract (shop's primary by default) */ currency?: string | null; } export interface CustomerBalanceHistory { /** Amount that was added or subtracted from customer's balance in shop currency */ amount: number; /** Balance at the moment of submitting transaction (after transaction was applied) */ balance: number; /** Arbitrary comment describing the transaction */ comment: string; /** Date and time change was performed and recorded */ created_at: string; /** Currency code */ currency: string; /** Unique customer balance history item identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Source of the credit/debit */ source: CustomerBalanceSource; /** First source argument, used for comment formatting */ source_arg1: string; /** Second source argument, used for comment formatting */ source_arg2: string; } export interface CustomerBalanceHistoryPage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export interface CustomerBalancePerCurrency { /** Amount of money customer has on his balance in particular currency */ amount: number; /** Currency code */ currency: string; } export declare type CustomerBalanceSource = "gift_card" | "order" | "other"; export declare type CustomerCategory = "accepts_marketing" | "any" | "repeat_customer"; export interface CustomerCreate { /** Indicates whether the customer has consented to be sent marketing material via email */ accepts_marketing?: boolean | null; addresses?: Array | null; /** Customer group id, can only be set by shop admins */ customer_group_id?: string | null; /** Default billing address identifier */ default_billing_address_id?: string | null; /** Default shipping address identifier */ default_shipping_address_id?: string | null; /** The name to display for other customers (under product reviews and such) */ display_name?: string | null; /** The email address of the customer */ email: string; /** Whether customer's email address was confirmed or not */ email_confirmed?: boolean | null; /** If customer is created as a result of import process, this is import process owner ID */ import_id?: string | null; /** If customer is created as a result of import process, this is import index (e.g. CSV line) */ import_index?: number | null; /** Whether or not customer's email address looks suspicious (fraud) */ is_disposable_email?: boolean | null; /** Preferred language of the customer */ language?: string | null; metadata?: Array | null; /** The mobile phone number of the customer (used for notifications) */ mobile?: string | null; /** Whether to notify customer via mobile phone or not */ mobile_notifications?: boolean | null; /** Name of the customer */ name?: string | null; /** The customer's password */ password?: string | null; /** Currency customer prefers */ preferred_currency?: string | null; /** Indicates whether the customer desires to get reminder emails */ reminder_messages?: boolean | null; /** Marks customer as tax-exempt, customer will not be charged any taxes */ tax_exempt?: boolean | null; /** Name of the time zone the customer is in */ timezone?: string | null; /** Timezone hint. When provided it overrides timezone field, but only if it's correct. If it's incorrect, the value is ignored. */ timezone_hint?: string | null; } export interface CustomerExpandableItems { /** Generic array of expandable items */ items: Array<{ id: string; } | Customer | null>; } export interface CustomerFavorite { /** Price to compare the variant price with for price notification */ comparison_price: number | null; /** The date and time when favorite was created */ created_at: string; /** Customer this favorite belongs to */ customer?: { id: string; } | Customer | null; /** Unique customer favorite identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Whether inventory notifications are enabled */ inventory_notification: boolean; /** Whether price notifications are enabled */ price_notification: boolean; /** The item customer added to favorites */ variant?: { id: string; } | ProductVariant | null; } export interface CustomerFavoriteCreate { /** Whether inventory notifications are enabled */ inventory_notification?: boolean | null; /** Whether price notifications are enabled */ price_notification?: boolean | null; /** Unique variant identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ variant_id: string; } export interface CustomerFavoriteModify { /** Whether inventory notifications are enabled */ inventory_notification?: boolean | null; /** Whether price notifications are enabled */ price_notification?: boolean | null; } export interface CustomerFavoritePage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export interface CustomerGroup { /** The date and time when the customer group was created */ created_at: string; /** Unique customer group identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Name of the customer group */ name: string; /** Makes all customers in the customer group as tax-exempt, customers will not be charged any taxes */ tax_exempt: boolean; /** The date and time when the customer group was updated */ updated_at: string; } export interface CustomerGroupCreate { /** Name of the customer group */ name: string; /** Makes all customers in the customer group as tax-exempt, customers will not be charged any taxes */ tax_exempt?: boolean | null; } export interface CustomerGroupModify { /** Name of the customer group */ name?: string | null; /** Makes all customers in the customer group as tax-exempt, customers will not be charged any taxes */ tax_exempt?: boolean | null; } export interface CustomerGroupPrice { /** Customer group this price is for */ customer_group?: { id: string; } | CustomerGroup | null; /** Price specific to given customer group */ price: number; tiered_pricing: TieredPricing | null; } export interface CustomerInventory { /** Date and time item was added to inventory */ created_at: string; /** Customer this inventory item belongs to */ customer?: { id: string; } | Customer | null; /** Date and time item was disabled */ disabled_at: string | null; /** Total amount of times it is allowed to download the digital product */ download_limit?: number; /** Amount of times the digital product was downloaded */ downloaded_times?: number; /** Email that was sent to notify customer about this item (you can use it to perform a resend) */ email_message?: { id: string; } | Message | null; /** Date and time when item expires */ expires_at: string | null; /** Amount of money gift card represents */ gift_card_amount?: number; /** Unique generated gift card code (shop owner/users only) */ gift_card_code?: string; /** Unique generated gift card code (last 4 symbols) */ gift_card_code_last4?: string; /** Whether gift card was used or not */ gift_card_used?: boolean; /** Unique customer inventory item identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Order this inventory item originated from */ order?: { id: string; } | Order | null; /** Type of item */ type: CustomerInventoryType; /** Date and time when the item was last modified */ updated_at: string; /** Product variant of this inventory item */ variant?: { id: string; } | ProductVariant | null; } export interface CustomerInventoryCreate { /** Unique customer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ customer_id: string; /** A unique product variant identifier */ variant_id: string; } export interface CustomerInventoryExpandableItems { /** Generic array of expandable items */ items: Array<{ id: string; } | CustomerInventory | null>; } export declare type CustomerInventoryItemTypeParam = "any" | "disabled" | "enabled" | "gift_card_not_used" | "gift_card_used"; export interface CustomerInventoryModify { /** Whehter item is disabled or not */ disabled?: boolean | null; /** Date and time when item expires */ expires_at?: string | null; } export interface CustomerInventoryPage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export declare type CustomerInventoryPageSortBy = "created_at"; export interface CustomerInventorySearchResult { /** Total number of items in the collection */ count: number; items: Array<{ id: string; } | CustomerInventory | null>; } export declare type CustomerInventoryType = "digital_good" | "gift_card"; export declare type CustomerInventoryTypeFilter = "digital_good" | "gift_card"; export declare type CustomerInventoryTypeParam = "digital_good" | "gift_card"; export interface CustomerModify { /** Indicates whether the customer has consented to be sent marketing material via email */ accepts_marketing?: boolean | null; addresses?: Array | null; /** Customer group id, can only be set by shop admins */ customer_group_id?: string | null; /** Default billing address index */ default_billing_address_id?: string | null; /** Default stripe payment source id */ default_payment_source_id?: string | null; /** Default shipping address index */ default_shipping_address_id?: string | null; /** The name to display for other customers (under product reviews and such) */ display_name?: string | null; /** Whether customer's email address was confirmed or not */ email_confirmed?: boolean | null; /** Whether or not customer's email address looks suspicious (fraud) */ is_disposable_email?: boolean | null; /** Preferred language of the customer */ language?: string | null; metadata?: Array | null; /** The mobile phone number of the customer (used for notifications) */ mobile?: string | null; /** Whether to notify customer via mobile phone or not */ mobile_notifications?: boolean | null; /** Name of the customer */ name?: string | null; /** Currency customer prefers */ preferred_currency?: string | null; /** Indicates whether the customer desires to get reminder emails */ reminder_messages?: boolean | null; /** Marks customer as tax-exempt, customer will not be charged any taxes */ tax_exempt?: boolean | null; /** Name of the time zone the customer is in */ timezone?: string | null; } export interface CustomerOAuthProvider { /** OAuth2 client ID */ client_id: string; /** OAuth2 client secret */ client_secret: string; /** OAuth provider kind for customer login */ kind: CustomerOAuthProviderKind; } export interface CustomerOAuthProviderCreate { /** OAuth2 client ID */ client_id: string; /** OAuth2 client secret */ client_secret: string; /** OAuth provider kind for customer login */ kind: CustomerOAuthProviderKind; } export declare type CustomerOAuthProviderKind = "apple" | "facebook" | "gitlab" | "google" | "twitter"; export interface CustomerPage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export interface CustomerPasswordReset { /** The email address of the customer */ email: string; } export interface CustomerPaymentSource { /** Billing city */ address_city: string; /** Billing address country code */ address_country: string; /** Billing address country info if available */ address_country_info?: { id: string; } | InfoCountry | null; /** Billing address line 1 */ address_line1: string; /** Billing address line 2 */ address_line2: string; /** Billing address state code */ address_state: string; /** Billing address state info if available */ address_state_info?: { id: string; } | InfoProvince | null; /** Billing zip or postal code */ address_zip: string; /** Credit card brand */ brand: string; /** Credit card expiration month */ exp_month: number; /** Credit card expiration year */ exp_year: number; /** Stripe payment method id */ id: string; /** Last 4 digits of the credit card number */ last4: string; /** Name of the card holder */ name: string; /** Unique customer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ stripe_customer_id: string; } export interface CustomerPaymentSourceCreate { /** Stripe.js credit card payment method id */ payment_method: string; } export interface CustomerPaymentSourceModify { /** Billing city */ address_city?: string | null; /** Billing address country code */ address_country?: string | null; /** Billing address line 1 */ address_line1?: string | null; /** Billing address line 2 */ address_line2?: string | null; /** Billing address state code */ address_state?: string | null; /** Billing zip or postal code */ address_zip?: string | null; /** Credit card expiration month */ exp_month?: number | null; /** Credit card expiration year */ exp_year?: number | null; /** Name of the card holder */ name?: string | null; } export declare type CustomerReviewReminder = "custom" | "never" | "seven_days" | "thirty_days"; export interface CustomerSearchResult { /** Total number of items in the collection */ count: number; items: Array<{ id: string; } | Customer | null>; } export declare type CustomersPageSortBy = "created_at" | "updated_at"; export interface DataFeed { /** Align the generation time to this week day (1 to 31) */ align_day: number; /** Align the generation time to this minute offset (-2880 to 2880) */ align_minute: number; /** Align the generation time to this week day (0 to 6, Monday is 0) */ align_weekday: number; fields: Array; /** File name of the data feed without extension */ filename: string; /** A script to filter the products/variants (JavaScript) */ filter_script: string; /** The date and time when the data feed will be generated next, RFC 3339 format */ generate_at: string; /** The date and time when the data feed was last generated, RFC 3339 format */ generated_at: string; /** Unique data feed identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** The name of the data feed */ name: string; options: Array; /** Password for http basic auth protected access */ password: string; /** How often data feed is updated */ schedule: DataFeedSchedule; /** Status of the data feed */ status: DataFeedStatus; /** Custom footer template to use for generating the data feed */ template_footer: string; /** Custom header template to use for generating the data feed */ template_header: string; /** Custom item template to use for generating the data feed */ template_item: string; /** URL for accessing the feed data */ url: string; /** User name for http basic auth protected access */ username: string; } export interface DataFeedCreate { /** Align the generation time to this week day (1 to 31) */ align_day?: number | null; /** Align the generation time to this minute offset (-2880 to 2880) */ align_minute?: number | null; /** Align the generation time to this week day (0 to 6, Monday is 0) */ align_weekday?: number | null; fields?: Array | null; /** File name of the data feed without extension */ filename?: string | null; /** A script to filter the products/variants (JavaScript) */ filter_script?: string | null; /** The name of the data feed */ name: string; options?: Array | null; /** Password for http basic auth protected access */ password?: string | null; /** How often data feed is updated */ schedule?: DataFeedSchedule | null; /** Custom footer template to use for generating the data feed */ template_footer?: string | null; /** Custom header template to use for generating the data feed */ template_header?: string | null; /** Custom item template to use for generating the data feed */ template_item?: string | null; /** User name for http basic auth protected access */ username?: string | null; } export interface DataFeedField { /** Free form formatter configuration */ config: string; /** Formatter id, must match the id of the entry from corresponding meta API output */ id: string; /** Name of the field in the feed data */ name: string; } export interface DataFeedFieldCreate { /** Free form formatter configuration */ config: string; /** Formatter id, must match the id of the entry from corresponding meta API output */ id: string; /** Name of the field in the feed data */ name: string; } export interface DataFeedModify { /** Align the generation time to this week day (1 to 31) */ align_day?: number | null; /** Align the generation time to this minute offset (-2880 to 2880) */ align_minute?: number | null; /** Align the generation time to this week day (0 to 6, Monday is 0) */ align_weekday?: number | null; fields?: Array | null; /** File name of the data feed without extension */ filename?: string | null; /** A script to filter the products/variants (JavaScript) */ filter_script?: string | null; /** The name of the data feed */ name?: string | null; options?: Array | null; /** Password for http basic auth protected access */ password?: string | null; /** How often data feed is updated */ schedule?: DataFeedSchedule | null; /** Custom footer template to use for generating the data feed */ template_footer?: string | null; /** Custom header template to use for generating the data feed */ template_header?: string | null; /** Custom item template to use for generating the data feed */ template_item?: string | null; /** User name for http basic auth protected access */ username?: string | null; } export interface DataFeedPreview { fields: Array; /** A script to filter the products/variants (JavaScript) */ filter_script?: string | null; options: Array; /** Custom footer template to use for generating the data feed */ template_footer?: string | null; /** Custom header template to use for generating the data feed */ template_header?: string | null; /** Custom item template to use for generating the data feed */ template_item?: string | null; /** A unique product variant identifier */ variant_id: string; } export declare type DataFeedSchedule = "daily" | "hourly" | "monthly" | "weekly"; export declare type DataFeedStatus = "generated" | "generating" | "pending"; export interface Device { /** The date and time when the user first logged in using this device, RFC 3339 format */ created_at: string; /** Device ID */ device_id: string; /** Unique device identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; info: IPAndUAInfo; /** IP address used in conjunction with this device */ ip: string; /** The date and time when the user last logged in using this device, RFC 3339 format */ logged_in_at: string; /** Whether this device is marked as trusted */ trusted: boolean; /** User-Agent string */ user_agent: string; } export interface DeviceModify { /** Whether this device is marked as trusted */ trusted?: boolean | null; } export declare type DiscountPrice = "follows_shop_settings" | "tax_exclusive"; export interface Domain { /** The date and time when the SSL certificate for domain expires, RFC 3339 format */ cert_expires_at: string | null; /** The date and time when the SSL certificate was queued for retrieval, RFC 3339 format */ cert_queued_at: string | null; /** The date and time when the SSL certificate was last acquired, RFC 3339 format */ cert_renewed_at: string | null; /** SSL certificated retrieval status */ cert_status: CertStatus; /** The date and time when the domain was added, RFC 3339 format */ created_at: string; /** The date and time when DNS instructions email was last sent, RFC 3339 format */ dns_instructions_sent_at: string | null; /** Domain itself */ domain: string; /** Returns effective top level domain + 1 for this domain or empty string if it cannot be determined */ etldp1: string; field_status: Array; /** Unique domain identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Whether the domain is correctly configured or not (discovered via DNS request) */ valid: boolean; } export interface DomainCreate { /** Domain itself */ domain: string; } export interface DomainFieldStatus { current: string; expected: string; field: string; } export interface DomainSendInstructions { recipients: Array; } export interface EmailRecipient { /** Email address to send instructions to */ email: string; /** Name of the recipient */ name?: string | null; } export interface ExportOptions { /** Format to use for date and time formatting (uses Go library specification) */ date_and_time_format: string; /** Format to use for date formatting (uses Go library specification) */ date_format: string; length_unit?: LengthUnit | null; /** Timezone to use with date and time formatting */ timezone: string; weight_unit?: WeightUnit | null; } export declare type FavoriteSortBy = "created_at"; export declare type FavoriteType = "inventory" | "price"; export interface FedexOptions { account_number: string; key: string; meter_number: string; password: string; } export interface FedexOptionsCreate { account_number: string; key: string; meter_number: string; password: string; } export interface File { /** CRC32 checksum of the original file */ crc32: number; /** The date and time when the file was created, RFC 3339 format */ created_at: string; /** A unique file identifier */ id: string; /** Alt title of the image */ image_alt: string; /** Average color of the image */ image_color: string; /** Duration of the video in milliseconds if file is a video */ image_duration: number; /** Base64 miniature of the image suitable for inline rendering (webp file format) */ image_fallback: string; /** Height of the image if file is an image */ image_height: number; /** Width of the image if file is an image */ image_width: number; /** Task this file is/was processed by */ imported_from_task?: { id: string; } | ShardedTask | null; /** Is file a binary? (images are always binary) */ is_binary: boolean; /** Is file an image? */ is_image: boolean; /** Whether this file is owned by something */ is_owned: boolean; /** Was file uploaded? */ is_uploaded: boolean; /** Is file a video? */ is_video: boolean; /** MD5 hash of the original file */ md5: string; /** MIME type of the file */ mime: string; /** Human-friendly name of the file */ name: string; /** Internal storage path of the file */ path: string; /** Whether file is pinned or not */ pinned: boolean; /** Publically available CDN URL of a file */ public_url: string; /** Size of the file in bytes (string, because graphql is limited to int32) */ size: string; /** File storage type */ storage: FileStorage; /** Internal path of the file in temporary storage, used internally, had to be exposed */ temp_path: string; } export interface FileCreate { /** Base64 encoded file or image */ base64?: string | null; /** Override default content type of the file */ content_type?: string | null; /** Alt title of the image */ image_alt?: string | null; /** Filename, will be used to construct a unique file path */ name?: string | null; /** Whether file is pinned or not */ pinned?: boolean | null; /** Size of the file to be uploaded (deferred uploads) */ size?: string | null; /** File storage type */ storage?: FileStorage | null; /** Text if the file is a plain text file */ text?: string | null; /** An URL to download file or image from */ url?: string | null; } export interface FileExpandableItems { /** Generic array of expandable items */ items: Array<{ id: string; } | File | null>; } export interface FileIDAndURL { /** A unique file identifier */ file_id: string; /** Publically accessible URL, valid for few hours */ url: string; } export interface FileModify { /** Alt title of the image */ image_alt?: string | null; /** Whether file is pinned or not */ pinned?: boolean | null; } export interface FilePage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export interface FileQuery { /** Restrict search to only images */ only_images?: boolean | null; /** Restrict search to uploaded private files */ only_uploaded_private_files?: boolean | null; /** Search query string */ query?: string | null; } export interface FileSearchResult { /** Total number of items in the collection */ count: number; items: Array<{ id: string; } | File | null>; } export declare type FileStorage = "general" | "private"; export interface FileURL { /** Publically accessible URL, valid for few hours */ url: string; } export declare type FilesPageSortBy = "created_at"; export interface ForeignShardedTask { /** The task */ task?: { id: string; } | ShardedTask | null; } export interface FulfillmentLineItem { /** Unique inventory location identifier (destination) */ dest_inventory_location_id: string; /** Inventory items that were created with this fulfillment */ inventory_items: Array<{ id: string; } | CustomerInventory | null>; /** Unique inventory location identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ inventory_location_id: string; /** Unique line item identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ line_item_id: string; /** Amount of items that will be shipped with this fulfillment */ quantity: number; /** Number of items returned */ returned: number; /** Unique variant identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ variant_id: string; } export declare type FulfillmentService = "manual"; export interface FulfillmentTrackingEvent { /** City of the event (comes from shipping provider) */ city: string; /** Shipping provider-specific code of the event */ code: string; /** Country code of the event (comes from shipping provider) */ country: string; /** Country info if available */ country_info?: { id: string; } | InfoCountry | null; /** The date and time when the event was created (possibly inaccurate) */ created_at: string; /** Free form description of the event */ description: string; /** Whether this event was added during last update or not */ is_new: boolean; /** Province code of the event (comes from shipping provider) */ province: string; /** Province info if available */ province_info?: { id: string; } | InfoProvince | null; /** The date and time when the event was received */ received_at: string; /** Event status */ status: TrackingEventStatus; /** Zip or postal code of the event (comes from shipping provider) */ zip: string; } export interface FulfillmentTrackingEventCreate { /** City of the event (comes from shipping provider) */ city?: string | null; /** Shipping provider-specific code of the event */ code?: string | null; /** Country code of the event (comes from shipping provider) */ country?: string | null; /** Free form description of the event */ description?: string | null; /** Province code of the event (comes from shipping provider) */ province?: string | null; /** Event status */ status?: TrackingEventStatus | null; /** Zip or postal code of the event (comes from shipping provider) */ zip?: string | null; } export declare type FulfillmentType = "digital_good" | "gift_card" | "physical"; export interface Gateway { /** The date and time when the gateway was created */ created_at: string; /** A list of currencies enabled for this gateway */ currencies: Array; /** Whether this gateway is enabled or not */ enabled: boolean; /** Unique gateway identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; manual: GatewayManual | null; paypal: GatewayPaypal | null; stripe: GatewayStripe | null; test: GatewayTest | null; /** Whether gateway test mode is enabled */ test_mode: boolean; /** Gateway type */ type: GatewayType; /** The date and time when the gateway was updated */ updated_at: string; /** Gateway visibility mode */ visibility: GatewayVisibility; } export interface GatewayCreate { /** A list of currencies enabled for this gateway */ currencies?: Array | null; /** Whether this gateway is enabled or not */ enabled?: boolean | null; manual?: GatewayManualCreate | null; paypal?: GatewayPaypalCreate | null; stripe?: GatewayStripeCreate | null; test?: GatewayTestCreate | null; /** Whether gateway test mode is enabled */ test_mode?: boolean | null; /** Gateway type */ type: GatewayType; /** Gateway visibility mode */ visibility?: GatewayVisibility | null; } export interface GatewayCurrency { code: string; /** Maximum order amount for this gateway to be eligible (or 0 if undefined) */ max: number; /** Minimum order amount for this gateway to be eligible (or 0 if undefined) */ min: number; } export interface GatewayCurrencyCreate { code: string; /** Maximum order amount for this gateway to be eligible (or 0 if undefined) */ max: number; /** Minimum order amount for this gateway to be eligible (or 0 if undefined) */ min: number; } export interface GatewayManual { /** Short description of the manual payment method */ description: string; /** Long description of the manual payment method with detailed instructions */ details: string; /** Name of the manual payment method */ name: string; /** Use this gateway for $0 total orders exclusively */ only_zero_orders: boolean; } export interface GatewayManualCreate { /** Short description of the manual payment method */ description: string; /** Long description of the manual payment method with detailed instructions */ details: string; /** Name of the manual payment method */ name: string; /** Use this gateway for $0 total orders exclusively */ only_zero_orders: boolean; } export interface GatewayModify { /** A list of currencies enabled for this gateway */ currencies?: Array | null; /** Whether this gateway is enabled or not */ enabled?: boolean | null; manual?: GatewayManualCreate | null; paypal?: GatewayPaypalCreate | null; stripe?: GatewayStripeCreate | null; test?: GatewayTestCreate | null; /** Whether gateway test mode is enabled */ test_mode?: boolean | null; /** Gateway visibility mode */ visibility?: GatewayVisibility | null; } export interface GatewayPaypal { /** Automatically capture authorized orders */ auto_capture: boolean; /** Enable/disable credit cards per-type */ cards: GatewayPaypalCards; client_id: string; /** Enable/disable funding options */ funding: GatewayPaypalFunding; merchant_id: string; /** Send about to expire authorized orders notification (when auto_capture is false) */ send_authorized_order_notifications: boolean; } export interface GatewayPaypalCards { amex: boolean; discover: boolean; elo: boolean; hiper: boolean; jcb: boolean; mastercard: boolean; visa: boolean; } export interface GatewayPaypalCardsCreate { amex: boolean; discover: boolean; elo: boolean; hiper: boolean; jcb: boolean; mastercard: boolean; visa: boolean; } export interface GatewayPaypalCreate { /** Automatically capture authorized orders */ auto_capture: boolean; /** Enable/disable credit cards per-type */ cards: GatewayPaypalCardsCreate; /** Enable/disable funding options */ funding: GatewayPaypalFundingCreate; merchant_id: string; /** Send about to expire authorized orders notification (when auto_capture is false) */ send_authorized_order_notifications: boolean; } export interface GatewayPaypalFunding { card: boolean; credit: boolean; sepa: boolean; } export interface GatewayPaypalFundingCreate { card: boolean; credit: boolean; sepa: boolean; } export interface GatewayStripe { /** Account id of the connected stripe account */ account_id: string; /** Enable/disable Amex Express Checkout */ amex_express_checkout: GatewayStripeAmexExpressCheckout; /** Automatically capture authorized orders */ auto_capture: boolean; /** Whether it's allowed to tokenize (save) cards for future use or not */ card_tokenization: boolean; /** Enable/disable credit cards per-type */ cards: GatewayStripeCards; /** Enable/disable Masterpass */ masterpass: GatewayStripeMasterpass; /** Use stripe's MOTO options on payment intent transaction */ moto: boolean; /** Enable/disable additional payment methods */ payment_methods: GatewayStripePaymentMethods; /** Trunkery publishable stripe api key (use it together with account_id) */ publishable_key: string; /** Send about to expire authorized orders notification (when auto_capture is false) */ send_authorized_order_notifications: boolean; /** Enable/disable Visa Checkout */ visa_checkout: GatewayStripeVisaCheckout; } export interface GatewayStripeAmexExpressCheckout { client_id: string; enabled: boolean; } export interface GatewayStripeAmexExpressCheckoutCreate { client_id: string; enabled: boolean; } export interface GatewayStripeCards { amex: boolean; diners: boolean; discover: boolean; jcb: boolean; mastercard: boolean; unionpay: boolean; visa: boolean; } export interface GatewayStripeCardsCreate { amex: boolean; diners: boolean; discover: boolean; jcb: boolean; mastercard: boolean; unionpay: boolean; visa: boolean; } export interface GatewayStripeCreate { /** Enable/disable Amex Express Checkout */ amex_express_checkout: GatewayStripeAmexExpressCheckoutCreate; /** Automatically capture authorized orders */ auto_capture: boolean; /** Whether it's allowed to tokenize (save) cards for future use or not */ card_tokenization: boolean; /** Enable/disable credit cards per-type */ cards: GatewayStripeCardsCreate; code: string; /** Enable/disable Masterpass */ masterpass: GatewayStripeMasterpassCreate; /** Use stripe's MOTO options on payment intent transaction */ moto: boolean; /** Enable/disable additional payment methods */ payment_methods: GatewayStripePaymentMethodsCreate; /** Send about to expire authorized orders notification (when auto_capture is false) */ send_authorized_order_notifications: boolean; /** Enable/disable Visa Checkout */ visa_checkout: GatewayStripeVisaCheckoutCreate; } export interface GatewayStripeMasterpass { checkout_id: string; enabled: boolean; } export interface GatewayStripeMasterpassCreate { checkout_id: string; enabled: boolean; } export interface GatewayStripePaymentMethods { alipay: boolean; bancontact: boolean; eps: boolean; giropay: boolean; ideal: boolean; multibanco: boolean; p24: boolean; sofort: boolean; wechat: boolean; } export interface GatewayStripePaymentMethodsCreate { alipay: boolean; bancontact: boolean; eps: boolean; giropay: boolean; ideal: boolean; multibanco: boolean; p24: boolean; sofort: boolean; wechat: boolean; } export interface GatewayStripeVisaCheckout { checkout_id: string; enabled: boolean; } export interface GatewayStripeVisaCheckoutCreate { checkout_id: string; enabled: boolean; } export interface GatewayTest { /** Automatically capture authorized orders */ auto_capture: boolean; /** Name of the test gateway */ name: string; /** Send about to expire authorized orders notification (when auto_capture is false) */ send_authorized_order_notifications: boolean; } export interface GatewayTestCreate { /** Automatically capture authorized orders */ auto_capture: boolean; /** Name of the test gateway */ name: string; /** Send about to expire authorized orders notification (when auto_capture is false) */ send_authorized_order_notifications: boolean; } export declare type GatewayType = "manual" | "paypal" | "stripe" | "test"; export declare type GatewayVisibility = "hide" | "show"; export interface GenericExport { columns?: Array | null; /** A script to filter the export items (JavaScript) */ filter_script?: string | null; ids?: Array | null; options?: ExportOptions | null; zip?: boolean | null; } export interface GenericImport { columns?: Array | null; file_id: string; options?: ImportOptions | null; skip_header?: boolean | null; } export interface IPAndUAInfo { br_family: string; br_version: string; country: InfoCountry | null; dvce_brand: string; dvce_family: string; dvce_model: string; geo_accuracy_radius: number; geo_city: string; geo_continent: string; geo_continent_name: string; geo_country: string; geo_country_name: string; geo_latitude: number; geo_longitude: number; geo_metro_code: number; geo_region: string; geo_region_name: string; geo_timezone: string; geo_zipcode: string; ip_domain: string; ip_isanonymousproxy: boolean; ip_isp: string; ip_issatelliteprovider: boolean; ip_netspeed: string; ip_organization: string; os_family: string; os_version: string; province: InfoProvince | null; } export declare type ImageType = "image"; export interface ImportOptions { /** Format to use for date and time formatting (uses Go library specification) */ date_and_time_format: string; /** Format to use for date formatting (uses Go library specification) */ date_format: string; /** Timezone to use with date and time formatting */ timezone: string; } export interface InfoCSVColumn { /** Human-friendly description of accepted values */ accepts: string; /** Associated GraphQL API fields using form: Type.field */ api: Array; /** Array nesting level */ array: number; /** Default value of this CSV column */ default_value: string; /** Description of the column */ description: string; /** A set of examples of valid column values */ examples: Array; /** Human friendly name of the column */ human_name: string; /** Whether the column is an id column (when present and defined will cause object modification instead of creation) */ is_id: boolean; /** Whether this column is main */ main: boolean; /** Is this column mandatory? */ mandatory: boolean; /** Name of the column */ name: string; /** Synonyms of the column, could be used for automatic column mapping */ synonyms: Array; /** Type name of the column (implementation-dependent) */ type_name: string; /** Whether the column is used during export */ used_in_export: boolean; /** Whether the column is used during import */ used_in_import: boolean; } export interface InfoCSVFormat { columns: Array; /** Human friendly name of the model */ human_name: string; } export interface InfoCarrierPackaging { grams: number; height: number; length: number; max_grams: number; name: string; provider: string; /** Type of the shipping provider */ type: ShippingProviderType; width: number; } export interface InfoCountry { /** The ISO 3166-1 alpha-2 two-letter country code for the country */ code: string; /** Continent of the country */ continent: string; /** Default currency of the country */ currency: string; dedup_fields: Array; /** Format of the address for this country */ display_format: string; /** Format of the address form for this country */ form_format: string; /** Whether country has provinces */ has_province: boolean; /** Whether country has postal codes */ has_zip: boolean; /** Unique country identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; labels: InfoCountryLabels; /** Name of the country */ name: string; /** Phone code prefix of the country */ phone: string; } export interface InfoCountryDedupField { field: string; separator: string; } export interface InfoCountryLabels { address1: string; address2: string; city: string; company: string; country: string; name: string; phone: string; province: string; zip: string; } export interface InfoCurrency { /** Currency code */ code: string; /** Currency formatting options */ currency_format: CurrencyFormat | null; /** Currency name */ name: string; /** UTF-8 currency symbol */ symbol: string; /** Factor to convert currency to minor currency (e.g. to convert dollar to cents factor of 100 is used) */ to_minor: number; } export interface InfoDataFeedField { /** Human-friendly description of the field config */ config_description: string; /** Human-friendly description of the field */ description: string; /** Unique id of the field */ id: string; /** Human-friendly name of the field */ name: string; /** Whether this field formatter uses config or not */ uses_config: boolean; } export interface InfoDataFeedPreset { consumer_fields: Array; fields: Array; /** Unique data feed preset id */ id: string; /** Name of the data feed preset */ name: string; options: Array; /** Footer template to apply to data feed */ template_footer: string; /** Header template to apply to data feed */ template_header: string; /** Item template to apply to data feed */ template_item: string; /** URL that is related to the data feed */ url: string; } export interface InfoDataFeedPresetField { /** Category of a consumer field */ category: string; /** Name of the consumer field */ name: string; } export interface InfoDataFeeds { fields: Array; presets: Array; } export interface InfoHSCode { sections: Array; } export interface InfoHSCodeChapter { /** Chapter code */ code: string; headings: Array; /** Chapter name */ name: string; } export interface InfoHSCodeHeading { /** Heading code */ code: string; /** Heading name */ name: string; subheadings: Array; } export interface InfoHSCodeSection { chapters: Array; /** Section name */ name: string; } export interface InfoHSCodeSubheading { /** Subheading code */ code: string; /** Subheading name */ name: string; } export interface InfoLanguage { /** The ISO ISO 639-1 language code */ code: string; /** Unique language identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Name of the language */ name: string; /** Name of the language in english */ name_en: string; /** Name of the language in its own language */ name_native: string; } export interface InfoMccCode { combined_description: string; edited_description: string; irs_description: string; irs_reportable: string; mcc: string; usda_description: string; } export interface InfoPermission { bit: number; is_read: boolean; name: string; } export interface InfoProvince { /** The standard abbreviation for the state or province */ code: string; /** Unique province identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Name of the province */ name: string; } export interface InfoRole { /** Special built-in role identifier */ id: string; /** The name of the role */ name: string; /** A set of permission bits describing this role */ permissions: Array; } export interface InfoShippingProvider { /** Reflection info for shipping provider specific set of options */ fields: Array; /** Nice name of the shipping provider */ name: string; /** List of known shipping provider serivces */ services: Array; /** API unique type for this shipping provider (used in shipping providers API) */ type: string; } export interface InfoTimezone { /** Country codes of countries this timezone spans across */ countries: Array; /** Name of the timezone */ name: string; /** Formatted offset from GMT of the given timezone */ offset: string; } export interface InfoWebhook { event_type: string; fields: Array; } export interface InventoryLocation { /** Address of the inventory location (warehouse) */ address: Address; /** The date and time when the inventory location was created */ created_at: string; /** Whether customer collection is allowed or not */ customer_collection: boolean; /** Whether inventory location is enabled or not */ enabled: boolean; hours: Array; /** Unique inventory location identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** The maximum amount of time the inventory location will take to fulfill the order */ lead_time_hours_max: number | null; /** The minimum amount of time the inventory location will take to fulfill the order */ lead_time_hours_min: number | null; /** Name of the inventory location */ name: string; /** Valid hours of the location for current and next weeks (according to server time) */ relevant_hours: Array; special_hours: Array; /** The date and time when the inventory location was updated */ updated_at: string; } export interface InventoryLocationCreate { /** Address of the inventory location (warehouse) */ address: AddressCreate; /** Whether customer collection is allowed or not */ customer_collection?: boolean | null; /** Whether inventory location is enabled or not */ enabled?: boolean | null; hours?: Array | null; /** The maximum amount of time the inventory location will take to fulfill the order */ lead_time_hours_max?: number | null; /** The minimum amount of time the inventory location will take to fulfill the order */ lead_time_hours_min?: number | null; /** Name of the inventory location */ name: string; special_hours?: Array | null; } export interface InventoryLocationDateRange { /** Lower day boundary (inclusive, 1-based) */ day_from: number; /** Upper day boundary (inclusive, 1-based) */ day_to: number; /** Lower month boundary (inclusive, 1-based) */ month_from: number; /** Upper month boundary (inclusive, 1-based) */ month_to: number; /** Description of the range */ name: string; /** Lower year boundary (inclusive, 0 when recurring) */ year_from: number; /** Upper year boundary (inclusive, 0 when recurring) */ year_to: number; } export interface InventoryLocationDateRangeCreate { /** Lower day boundary (inclusive, 1-based) */ day_from: number; /** Upper day boundary (inclusive, 1-based) */ day_to: number; /** Lower month boundary (inclusive, 1-based) */ month_from: number; /** Upper month boundary (inclusive, 1-based) */ month_to: number; /** Description of the range */ name: string; /** Lower year boundary (inclusive, 0 when recurring) */ year_from: number; /** Upper year boundary (inclusive, 0 when recurring) */ year_to: number; } export interface InventoryLocationDayHour { /** Lower minute boundary (inclusive) */ minute_from: number; /** Upper minute boundary (inclusive) */ minute_to: number; } export interface InventoryLocationDayHourCreate { /** Lower minute boundary (inclusive) */ minute_from: number; /** Upper minute boundary (inclusive) */ minute_to: number; } export interface InventoryLocationHour { /** Week day of the interval, starting with 0 (Monday) */ day: number; /** Lower minute boundary (inclusive) */ minute_from: number; /** Upper minute boundary (inclusive) */ minute_to: number; } export interface InventoryLocationHourCreate { /** Week day of the interval, starting with 0 (Monday) */ day: number; /** Lower minute boundary (inclusive) */ minute_from: number; /** Upper minute boundary (inclusive) */ minute_to: number; } export interface InventoryLocationMigrate { /** Inventory location id to migrate inventory from. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ from_inventory_location_id: string; /** Inventory location id to migrate inventory to. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ to_inventory_location_id: string; } export interface InventoryLocationModify { /** Address of the inventory location (warehouse) */ address?: AddressCreate | null; /** Whether customer collection is allowed or not */ customer_collection?: boolean | null; /** Whether inventory location is enabled or not */ enabled?: boolean | null; hours?: Array | null; /** The maximum amount of time the inventory location will take to fulfill the order */ lead_time_hours_max?: number | null; /** The minimum amount of time the inventory location will take to fulfill the order */ lead_time_hours_min?: number | null; /** Name of the inventory location */ name?: string | null; special_hours?: Array | null; } export interface InventoryLocationRelevantHours { /** Month day, starting with 1 */ day: number; hours: Array; /** Month number, starting with 1 */ month: number; } export interface InventoryLocationSpecialHours { date_ranges: Array; hours: Array; } export interface InventoryLocationSpecialHoursCreate { date_ranges: Array; hours: Array; } export declare type InventoryLogType = "fulfillment_canceled" | "fulfillment_completed" | "fulfillment_created" | "manual_adjustment" | "migrate" | "order_cancel_reservation" | "order_reserved" | "purchase_order_created" | "purchase_order_received" | "purchase_order_rejected" | "restock" | "return" | "scheduled_fulfillment_cancel_reservation" | "scheduled_fulfillment_reserved" | "transfer_created" | "transfer_received" | "transfer_rejected"; export declare type InventoryManagement = "automatic" | "manual"; export declare type InventoryPolicy = "continue" | "deny"; export interface InventoryRule { conditions: Array; /** Unique inventory rule identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** How inventory location should be picked */ inventory_strategy: InventoryStrategy; /** Whether to allow picking multiple locations per order */ multiple_locations: boolean; /** Name of the inventory rule */ name: string; /** Whether to consider customer selected pickup location before anything else */ prefer_pickup_location: boolean; /** Priority of the rule (rule with higher priority is to be evaluated first) */ priority: number; /** Whether to allow splitting bundle line items across multiple locations */ split_bundle_items: boolean; /** Whether to allow splitting individual line items across multiple locations */ split_line_items: boolean; zones: Array; } export interface InventoryRuleCondition { /** Customer group to match against */ customer_group?: { id: string; } | CustomerGroup | null; /** Whether this location is the default one (its address is used for tax calc) */ default: boolean; /** Target inventory location */ inventory_location?: { id: string; } | InventoryLocation | null; } export interface InventoryRuleConditionCreate { /** Unique customer group identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ customer_group_id?: string | null; /** Whether this location is the default one (its address is used for tax calc) */ default?: boolean | null; /** Unique inventory location identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ inventory_location_id: string; } export interface InventoryRuleCreate { conditions?: Array | null; /** How inventory location should be picked */ inventory_strategy?: InventoryStrategy | null; /** Whether to allow picking multiple locations per order */ multiple_locations?: boolean | null; /** Name of the inventory rule */ name: string; /** Whether to consider customer selected pickup location before anything else */ prefer_pickup_location?: boolean | null; /** Priority of the rule (rule with higher priority is to be evaluated first) */ priority?: number | null; /** Whether to allow splitting bundle line items across multiple locations */ split_bundle_items?: boolean | null; /** Whether to allow splitting individual line items across multiple locations */ split_line_items?: boolean | null; zones?: Array | null; } export interface InventoryRuleModify { conditions?: Array | null; /** How inventory location should be picked */ inventory_strategy?: InventoryStrategy | null; /** Whether to allow picking multiple locations per order */ multiple_locations?: boolean | null; /** Name of the inventory rule */ name?: string | null; /** Whether to consider customer selected pickup location before anything else */ prefer_pickup_location?: boolean | null; /** Priority of the rule (rule with higher priority is to be evaluated first) */ priority?: number | null; /** Whether to allow splitting bundle line items across multiple locations */ split_bundle_items?: boolean | null; /** Whether to allow splitting individual line items across multiple locations */ split_line_items?: boolean | null; zones?: Array | null; } export declare type InventoryStockStatus = "in_stock" | "low" | "out_of_stock"; export declare type InventoryStockStatusAggregated = "in_stock" | "low" | "mixed" | "out_of_stock"; export declare type InventoryStrategy = "closest" | "most_available" | "order"; export interface Invitation { /** The date and time when the user invitation was created, RFC 3339 format */ created_at: string; /** Email of the invited user */ email: string; /** The date and time when the user invitation email was sent, RFC 3339 format */ email_sent_at: string | null; /** Unique identifier for a user invitation */ id: string; /** Name of the user (used when sending an email) */ name: string; /** A set of permission bits to set for a user when he accepts an invite */ permissions: Array; /** A set of roles to set for a user when he accepts an invite */ roles: Array<{ id: string; } | Role | null>; } export interface InvitationCreate { /** Email of the invited user */ email: string; /** Name of the user (used when sending an email) */ name?: string | null; /** A set of permission bits to set for a user when he accepts an invite */ permissions?: Array | null; /** A set of roles to set for a user when he accepts an invite */ role_ids?: Array | null; } export interface Invoice { /** Amount due of the invoice (TODO) */ amount_due: number; /** Client secret (for a case when action is required) */ client_secret: string; /** The date and time when the invoice was created */ date: string; /** The date on which payment for this invoice is due */ date_due: string; /** Ending balance of the user (TODO) */ ending_balance: number; /** Unique invoice id */ id: string; lines: Array; /** User-friendly invoice number */ number: string; source_brand: string; source_last4: string; /** Starting balance of the user (TODO) */ starting_balance: number; /** Invoice status */ status: InvoiceStatus; /** Subtotal sum of the invoice (TODO) */ subtotal: number; /** Total sum of the invoice (TODO) */ total: number; } export interface InvoiceLine { /** Amount of the line item */ amount: number; /** Description of the line item */ description: string; /** The date and time when the period of the invoice line item ends */ period_end: string; /** The date and time when the period of the invoice line item starts */ period_start: string; /** Plan id for invoices of "subscription" type */ plan_id?: string; /** Plan name for invoices of "subscription" type */ plan_name?: string; /** Quantity of the line item */ quantity: number; /** Type of the invoice line item */ type: string; } export interface InvoicePage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export declare type InvoiceStatus = "canceled" | "processing" | "requires_action" | "requires_payment_method" | "succeeded"; export declare type InvoiceType = "any" | "nonzero"; export declare type JurisdictionSlot = "city" | "country" | "county" | "province" | "special" | "tax_system"; export interface Key { /** The date and time when the key was created, RFC3339 format */ created_at: string; /** The date and time when the key expires, RFC3339 format */ expires_at: string; /** Unique key identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** The name of the key */ name: string; /** A set of permission bits valid for this key */ permissions: Array; /** Roles this key inherits permission bits from */ roles: Array<{ id: string; } | Role | null>; /** Javascript Web Token itself */ token: string; /** Unique user identifier (owner of the key) */ user_id: string; } export interface KeyCreate { /** The date and time when the key expires, RFC3339 format */ expires_at?: string | null; /** The name of the key */ name?: string | null; /** A set of permission bits valid for this key */ permissions?: Array | null; role_ids?: Array | null; } export interface KeyModify { /** The name of the key */ name?: string | null; /** A set of permission bits valid for this key */ permissions?: Array | null; role_ids?: Array | null; } export interface KeyValue { /** Key */ key: string; /** Value */ value: string; } export interface KeyValueCreate { /** Key */ key: string; /** Value */ value: string; } export declare type LengthUnit = "cm" | "ft" | "in" | "m" | "mm"; export interface LineItemField { choice_index: number; field_index: number; label: string; /** Type of the field */ type: ProductFieldType; value: string; } export interface LineItemFieldCreate { choice_index: number; field_index: number; label: string; /** Type of the field */ type: ProductFieldType; value: string; } export interface MediaFile { /** The media file itself */ file?: { id: string; } | File | null; /** Thumbnail file for this media file if available */ thumbnail_file?: { id: string; } | File | null; } export interface MediaFileCreate { /** Media file ID */ file_id: string; /** Thumbnail file ID */ thumbnail_file_id?: string | null; } export interface Menu { /** The date and time when menu was created, RFC 3339 format */ created_at: string; /** Custom field objects extracted and ready for expansion */ custom_field_objects: CustomFieldObjects | null; custom_fields: Array; /** Menu handle (you can lookup menu using a handle) */ handle: string; /** A unique menu identifier */ id: string; /** Menu items */ items: Array; /** Menu name */ name: string; /** The date and time when menu was last updated, RFC 3339 format */ updated_at: string; } export interface MenuCreate { custom_fields?: Array | null; /** Menu handle (you can lookup menu using a handle) */ handle?: string | null; /** Menu items */ items?: Array | null; /** Menu name */ name: string; } export interface MenuItem { /** Category this menu item refers to */ category?: { id: string; } | Category | null; /** Content block this menu item refers to */ content_block?: { id: string; } | ContentBlock | null; /** Unique menu item identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** HTTP(S) link */ link: string | null; /** Arbitrary text value for meta type */ meta: string | null; /** Name of the menu item */ name: string; /** Index of the parent item if any */ parent_index: number; /** Product this menu item refers to */ product?: { id: string; } | Product | null; /** Search query */ query: string | null; /** Type of the menu item */ type: MenuItemType; } export interface MenuItemCreate { /** Unique category identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ category_id?: string | null; /** Unique content block identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ content_block_id?: string | null; /** Unique menu item identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id?: string | null; /** HTTP(S) link */ link?: string | null; /** Arbitrary text value for meta type */ meta?: string | null; /** Name of the menu item */ name: string; /** Index of the parent item if any */ parent_index?: number | null; /** Unique product identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ product_id?: string | null; /** Search query */ query?: string | null; /** Type of the menu item */ type: MenuItemType; } export declare type MenuItemType = "category" | "content_block" | "empty" | "link" | "meta" | "product" | "search"; export interface MenuModify { custom_fields?: Array | null; /** Menu handle (you can lookup menu using a handle) */ handle?: string | null; item_titles_i18n?: Array | null; /** Menu items */ items?: Array | null; /** Menu name */ name?: string | null; } export interface MenuPage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export declare type MenusPageSortBy = "created_at" | "updated_at"; export interface Message { /** The date and time when message entry was created */ created_at: string; /** Unique message identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** The date and time when send attempt was made */ sent_at: string | null; /** The status of message */ sent_status: SentStatus; /** Type of the message */ type: MessageType; } export declare type MessageType = "email" | "sms"; export interface MinCurrencyPrice { /** Currency code */ currency: string; /** Minimum price of all product variants for given currency */ min_price: number; } export interface MinCustomerGroupPrice { customer_group?: { id: string; } | CustomerGroup | null; /** Minimum price of all product variants for given customer group */ min_price: number; } export interface Note { /** The date and time when the note was created */ created_at: string; /** Unique note identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** The note body */ text: string; /** The date and time when the note was updated */ updated_at: string; user?: { id: string; } | User | null; } export interface NoteCreate { /** Note text */ text: string; } export interface NoteModify { /** Note text */ text?: string | null; } export declare type OAuth2Provider = "github" | "gitlab" | "google"; export interface Option { /** A unique human-readable option identifier */ id: string; /** Metadata of the option */ meta: string; /** Name of the option */ name: string; /** Option values */ values: Array; } export interface OptionCreate { /** A unique human-readable option identifier */ id: string; /** Metadata of the option */ meta?: string | null; /** Name of the option */ name: string; /** Option values */ values: Array; } export interface OptionModify { /** Metadata of the option */ meta?: string | null; /** Name of the option */ name?: string | null; /** Option values */ values?: Array | null; } export interface OptionSet { /** A unique option set identifier */ id: string; /** Name of the option set */ name: string; /** Option IDs of options which belong to a set */ options: Array; } export interface OptionSetCreate { /** Name of the option set */ name: string; /** Option IDs of options which belong to a set */ options: Array; } export interface OptionSetModify { /** Name of the option set */ name?: string | null; /** Option IDs of options which belong to a set */ options?: Array | null; } export interface OptionValue { /** A unique human-readable option value identifier */ id: string; /** Metadata of the option value */ meta: string; /** Name of the option value */ name: string; } export interface OptionValueCreate { /** A unique human-readable option value identifier */ id: string; /** Metadata of the option value */ meta?: string | null; /** Name of the option value */ name: string; } export interface OptionalInt { value: number; } export interface OptionalIntCreate { value: number; } export interface Order { /** The date and time when the order was last abandoned */ abandoned_at: string | null; /** Abandoned order recovery email message (you can use it to perform a resend) */ abandoned_email_message?: { id: string; } | Message | null; /** The date and time when order was considered for recovery email notification */ abandoned_email_processed_at: string | null; /** Number of times this order was abandoned */ abandoned_times: number; /** The date and time when order payment authorization expires */ authorization_expires_at: string | null; /** Billing address of the order */ billing_address: Address | null; /** Short version of the billing address */ billing_address_short?: { id: string; } | AddressShort | null; /** Order calculation log */ calc_log: Array; /** Whether order was successfully "calculated" or not */ calculated: boolean; /** The reason why the order was canceled */ cancel_reason: OrderCancelReason | null; /** The date and time when the order was canceled or null */ canceled_at: string | null; /** Pending payment intent secret when gateway is "stripe" */ client_secret: string; /** The date and time when the order was closed or null */ closed_at: string | null; /** Coupon associated with the order (when "discount_code" is provided and resolved) */ coupon?: { id: string; } | Coupon | null; /** The date and time when the order was created */ created_at: string; /** Currency code */ currency: string; /** Customer who created the order */ customer?: { id: string; } | Customer | null; /** Amount of money spent on the customer balance */ customer_balance_spent: number; /** Customer email, used in no auth order flows */ customer_email: string | null; /** Coupon code if set */ discount_code: string | null; /** Whether discount price follows tax_inclusive_prices option or is always tax exclusive */ discount_price: DiscountPrice; display: OrderDisplay | null; /** Numerical draft order identifier unique to the shop */ draft_number: number; /** Financial status of the order */ financial_status: OrderFinancialStatus; /** The date and time when the order was completely fulfilled */ fulfilled_at: string | null; /** Fulfillment status of the order */ fulfillment_status: OrderFulfillmentStatus; /** Gateway picked for this order */ gateway?: { id: string; } | Gateway | null; /** Gateway type */ gateway_type: GatewayType | null; /** Order history */ history: Array; /** A unique order identifier */ id: string; /** Due date and time for order's invoice */ invoice_due_date: string | null; /** Invoice email message (you can use it to perform a resend) */ invoice_email_message?: { id: string; } | Message | null; /** Order line items */ line_items: Array; /** The date and time when the order was marked as lost */ lost_at: string | null; /** The mobile phone number of the customer (used for notifications) */ mobile: string; /** Whether to notify customer via mobile phone or not */ mobile_notifications: boolean; /** Numerical order identifier unique to the shop */ number: number; /** Whether server thinks order is on hold or not (depends on server time) */ on_hold: boolean; /** The date and time when order is no longer considered on hold */ on_hold_until: string | null; packaging_detail: Array; /** The date and time when the order was transitioned to one of the payment states */ paid_at: string | null; /** Email that was sent on payment (you can use it to perform a resend) */ paid_email_message?: { id: string; } | Message | null; payment_detail: PaymentDetail | null; /** Conversion rate from order's currency to shop's primary currency */ primary_rate: number; /** Promotion associated with the order (when "discount_code" is provided and resolved) */ promotion?: { id: string; } | Promotion | null; /** Whether this order is considered as recovered (before entering paid state it was abandoned) */ recovered: boolean; /** The date and time when the order resources were reserved */ reserved_at: string | null; /** The date and time when the order was last restored from being abandoned */ restored_at: string | null; /** Review reminder email message (you can use it to perform a resend) */ review_reminder_email_message?: { id: string; } | Message | null; /** The date and time when order was considered for review reminder email notification */ review_reminder_email_processed_at: string | null; /** Risk evaluation result for this order */ risk?: { id: string; } | OrderRisk | null; rule_eval_detail: OrderRuleEvalDetail; selected_shipping_rates: Array; /** Should customer receive fulfillment-related notifications or not */ send_fulfillment_notifications: boolean; /** Should customer receive order-related notifications or not */ send_order_notifications: boolean; /** Shipping address of the order */ shipping_address: Address | null; /** Shipping address override */ shipping_address_override: Address | null; /** Short version of the shipping address */ shipping_address_short?: { id: string; } | AddressShort | null; /** Verification status of the shipping address */ shipping_address_verification: AddressVerification | null; shipping_detail: ShippingDetail | null; /** Shipping price */ shipping_price: number; /** A list of available shipping rates and shipping providers (only after they were calculated) */ shipping_rate_groups: Array | null; /** Where the order originated from */ source_name: OrderSourceName; /** State of an order */ state: OrderState; /** Subscription associated with this order */ subscription?: { id: string; } | Subscription | null; /** Price of the order before shipping and taxes */ subtotal_price: number; /** When to round the calculated tax */ sum_tax_after: SumTaxAfter; /** Whether prices include the tax or not */ tax_inclusive_prices: boolean; /** Difference between sum of rounded values and rounded sum for taxes */ tax_rounding: number; /** The total amount of the discounts to be applied to the price of the order */ total_discounts: number; /** The sum of all the prices of all the items in the order (before any discounts, taxes and shipping) */ total_line_items_price: number; /** The sum of all the prices of all the items in the order, taxes and discounts included */ total_price: number; /** The sum of all the taxes applied to the order */ total_tax: number; /** The sum of all the weights of the line items in the order, in grams */ total_weight: number; unpacked_items: Array; /** The date and time when the order was last modified */ updated_at: string; /** Conversion rate from order's currency to USD */ usd_rate: number; /** User who created the order */ user?: { id: string; } | User | null; /** UUID for this order, used for anonymous users authorization */ uuid: string; } export interface OrderBundleLineItemDetail { /** Whether inventory of the variant is managed or not */ managed: boolean; /** A unique product identifier */ product_id: string; /** Amount of items of a given variant in the bundle */ quantity_per_bundle: number; /** Type of the variant */ type: VariantType; /** A unique product variant identifier */ variant_id: string; } export interface OrderCalcLog { comment: string; group: string; key: string; value: string; } export interface OrderCancel { /** Whether to archive order or not */ archive?: boolean | null; /** Whether to notify customer about order cancellation via email or not */ notify?: boolean | null; /** The reason why the order was canceled */ reason?: OrderCancelReason | null; refund?: OrderRefund | null; } export declare type OrderCancelReason = "customer" | "fraud" | "inventory" | "malformed_shipping_address" | "other" | "price_error" | "risk" | "shipping_price_error" | "tax_error" | "undeliverable_shipping_address" | "unsupported_po_box_address"; export interface OrderCreate { /** Billing address of an order */ billing_address?: AddressCreate | null; /** Billing address of an order (short) */ billing_address_short_id?: string | null; /** Valid order id to clone from, if used all other parameters are ignored */ clone_from_id?: string | null; /** Currency to calculate the order in */ currency?: string | null; /** Customer email, used in no auth order flows */ customer_email?: string | null; /** Customer id order belongs to, if customer creates an order this parameter is ignored */ customer_id?: string | null; /** A discount code that can be entered by a customer on checkout */ discount_code?: string | null; /** Gateway used */ gateway_id?: string | null; /** Order line items */ line_items?: Array | null; /** The mobile phone number of the customer (used for notifications) */ mobile?: string | null; /** Whether to notify customer via mobile phone or not */ mobile_notifications?: boolean | null; /** Should customer receive fulfillment-related notifications or not */ send_fulfillment_notifications?: boolean | null; /** Should customer receive order-related notifications or not */ send_order_notifications?: boolean | null; /** Shipping address of an order */ shipping_address?: AddressCreate | null; /** Shipping address of an order (short) */ shipping_address_short_id?: string | null; shipping_rate_ids?: Array | null; /** Subscription associated with this order */ subscription_id?: string | null; } export interface OrderDetailsLineItemInventory { /** Amount of items available for fulfillment */ fulfillable_quantity: number; /** Inventory location where the inventory was allocated at */ inventory_location_id: string; /** Amount of items allocated */ quantity: number; /** Variant allocated (relevant for bundle items) */ variant_id: string; } export interface OrderDisplay { /** How much the customer must pay for the order, as will be displayed during checkout */ amount_due: number; /** Customer balance spent as will be displayed during checkout */ customer_balance_spent: number; /** Total discount as will be displayed during checkout */ discount: number; /** Amount paid (sum of manual payments or captured payment amount) */ paid: number; /** Shipping price as will be displayed during checkout */ shipping: number; /** Subtotal amount as will be displayed during checkout */ subtotal: number; /** Total tax as will be displayed during checkout */ tax: number; /** Total price as will be displayed during checkout */ total: number; } export interface OrderExpandableItems { /** Generic array of expandable items */ items: Array<{ id: string; } | Order | null>; } export declare type OrderFinancialStatus = "authorized" | "paid" | "partially_paid" | "partially_refunded" | "refunded" | "unpaid" | "voided"; export interface OrderFulfillment { /** The date and time when the fulfillment was canceled or null */ canceled_at: string | null; /** The date and time when the fulfillment was created */ created_at: string; /** Whether fulfillment represents digital items fulfillment, physical otherwise */ digital: boolean; /** The date and time when the fulfillment was disabled or null */ disabled_at: string | null; /** Whether to notify customer about fulfillment creation or not */ email: boolean; /** The date and time when the shipment is expected to be delivered (upper boundary) */ expected_at_max: string | null; /** The date and time when the shipment is expected to be delivered (lower boundary) */ expected_at_min: string | null; /** Unique fulfillment identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Array of line items associated with the fulfillment */ line_items: Array; /** Destination pickup inventory location */ pickup_inventory_location?: { id: string; } | InventoryLocation | null; /** Type of the shipping provider (use "fixed" as "other") */ shipping_provider_type: ShippingProviderType; /** The name of the shipping company */ tracking_company: string; tracking_events: Array; /** Shipping number, provided by the shipping company */ tracking_number: string; /** The URLs to track the fulfillment */ tracking_url: string; /** The date and time when the fulfillment was last modified */ updated_at: string; } export interface OrderFulfillmentCreate { /** Whether to notify customer about fulfillment creation or not */ email?: boolean | null; /** Array of line items associated with the fulfillment */ line_items?: Array | null; /** Destination pickup inventory location */ pickup_inventory_location_id?: string | null; /** Scheduled fulfillment to use when creating this fulfillment. Requires scheduled_fulfillment_line_items. */ scheduled_fulfillment_id?: string | null; /** Specifies where to allocate unreserved items at */ scheduled_fulfillment_line_items?: Array | null; /** Type of the shipping provider */ shipping_provider_type?: ShippingProviderType | null; /** This fulfullment is associated with the given subscription. */ subscription_id?: string | null; /** The name of the shipping company */ tracking_company?: string | null; /** Shipping number, provided by the shipping company */ tracking_number?: string | null; /** The URLs to track the fulfillment */ tracking_url?: string | null; } export interface OrderFulfillmentLineItemCreate { /** Unique inventory location identifier (destination) */ dest_inventory_location_id: string; /** Unique inventory location identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ inventory_location_id: string; /** Unique line item identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ line_item_id: string; /** Amount of items that will be shipped with this fulfillment */ quantity: number; /** A unique product variant identifier */ variant_id: string; } export interface OrderFulfillmentModify { /** Whether to notify customer about fulfillment creation or not */ email?: boolean | null; /** Destination pickup inventory location */ pickup_inventory_location_id?: string | null; /** Type of the shipping provider */ shipping_provider_type?: ShippingProviderType | null; /** The name of the shipping company */ tracking_company?: string | null; /** Shipping number, provided by the shipping company */ tracking_number?: string | null; /** The URLs to track the fulfillment */ tracking_url?: string | null; } export declare type OrderFulfillmentStatus = "fulfilled" | "partial" | "unfulfilled"; export interface OrderHistory { /** Type of the history entry */ action: OrderHistoryAction; authorize_transaction: OrderHistoryAuthorizeTransaction | null; cancel: OrderHistoryCancel | null; capture_transaction: OrderHistoryCaptureTransaction | null; /** The date and time when the history entry was created */ created_at: string; /** Customer responsible for this action */ customer?: { id: string; } | Customer | null; fulfillment_canceled: OrderHistoryFulfillmentCanceled | null; fulfillment_completed: OrderHistoryFulfillmentCompleted | null; fulfillment_created: OrderHistoryFulfillmentCreated | null; fulfillment_modified: OrderHistoryFulfillmentModified | null; manual_payment: OrderHistoryManualPayment | null; manual_refund: OrderHistoryManualRefund | null; refund_transaction: OrderHistoryRefundTransaction | null; restock: OrderHistoryRestock | null; state_change: OrderHistoryChange | null; /** User responsible for this action */ user?: { id: string; } | User | null; void_transaction: OrderHistoryRefundTransaction | null; } export declare type OrderHistoryAction = "abandon" | "authorize_transaction" | "cancel" | "capture_transaction" | "close" | "customer_balance_refund" | "fulfillment_canceled" | "fulfillment_completed" | "fulfillment_created" | "fulfillment_modified" | "manual_payment" | "manual_refund" | "open" | "refund_transaction" | "restock" | "state_change" | "unabandon" | "undo_coupon_usage" | "void_transaction"; export interface OrderHistoryAuthorizeTransaction { /** Amount authorized */ amount: number; /** External transaction identifier (gateway-specific) */ external_id: string; /** Gateway token */ gateway_token: string; /** Whether gateway was in test mode */ test: boolean; /** Transaction token */ token: string; } export interface OrderHistoryCancel { email_message?: { id: string; } | Message | null; /** The reason why the order was canceled */ reason: OrderCancelReason | null; } export interface OrderHistoryCaptureTransaction { /** Amount captured */ amount: number; /** External transaction identifier (gateway-specific) */ external_id: string; /** Gateway token */ gateway_token: string; /** Whether gateway was in test mode */ test: boolean; /** Transaction token */ token: string; } export interface OrderHistoryChange { /** Previous value */ from: string; /** Name of the value */ name: string; /** New value */ to: string; } export interface OrderHistoryFulfillmentCanceled { /** Unique fulfillment identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ fulfillment_id: string; } export interface OrderHistoryFulfillmentCompleted { /** Unique fulfillment identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ fulfillment_id: string; } export interface OrderHistoryFulfillmentCreated { email_message?: { id: string; } | Message | null; /** Unique fulfillment identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ fulfillment_id: string; } export interface OrderHistoryFulfillmentModified { changes: Array; email_message?: { id: string; } | Message | null; /** Unique fulfillment identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ fulfillment_id: string; } export interface OrderHistoryManualPayment { /** Amount paid */ amount: number; } export interface OrderHistoryManualRefund { /** Amount refunded */ amount: number; customer_balance: number; email_message?: { id: string; } | Message | null; /** Refund fee */ fee: number; line_items: Array; /** Reason why order is refunded */ refund_reason: OrderRefundReason | null; /** Reported refund amount */ reported_amount: number; } export interface OrderHistoryRefundLineItem { /** Amount refunded for given line item (goes into stats) */ amount: number; /** Refund fee */ fee: number; /** Unique order line item identifier */ line_item_id: string; /** Amount of items refunded */ quantity: number; /** Unique variant identifier */ variant_id: string; } export interface OrderHistoryRefundTransaction { /** Amount refunded */ amount: number; customer_balance: number; email_message?: { id: string; } | Message | null; /** External transaction identifier (gateway-specific) */ external_id: string; /** Refund fee */ fee: number; /** Gateway token */ gateway_token: string; line_items: Array; /** Reason why order is refunded */ refund_reason: OrderRefundReason | null; /** Transaction token */ token: string; } export interface OrderHistoryRestock { line_items: Array; } export interface OrderHistoryRestockLineItem { /** Unique inventory location identifier (destination) */ dest_inventory_location_id: string; /** Unique fulfillment id */ fulfillment_id: string; /** Unique inventory location identifier */ inventory_location_id: string; /** Unique order line item identifier */ line_item_id: string; /** Amount of items restocked */ quantity: number; /** Unique variant identifier */ variant_id: string; } export interface OrderLineItem { detail: OrderLineItemDetail | null; /** Discount preview for automatically applied promotions */ discount_preview: number; field_set?: { id: string; } | ProductFieldSet | null; fields: Array; /** The amount available for fulfillment */ fulfillable_quantity: number; /** How far along an order is in terms line items fulfilled */ fulfillment_status: OrderLineItemFulfillmentStatus; /** Unique line item identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** The number of products that were purchased */ quantity: number; /** If subscription was initiated by this line item, this is the one */ subscription?: { id: string; } | Subscription | null; /** Product subscription plan index if subscription needs to be initiated, -1 for no subscription */ subscription_plan_index: number; /** Product variant for this line item */ variant?: { id: string; } | ProductVariant | null; } export interface OrderLineItemCreate { field_set_id?: string | null; fields?: Array | null; /** The number of products that were purchased */ quantity: number; /** Product subscription plan index if subscription needs to be initiated, -1 for no subscription */ subscription_plan_index?: SubscriptionPlanIndex | null; /** A unique product variant identifier */ variant_id: string; } export interface OrderLineItemDetail { bundle_items: Array; /** Discount applied to this line item */ discount: number; /** Discount rule name selected for this line item */ discount_rule_name: string; /** Discount portion of the calculated tax */ discount_tax: number; inventory: Array; /** Whether inventory of the variant is managed or not */ managed: boolean; /** Original price (depends on price source, e.g. could be price before sale price was applied) */ original_price: number; /** Price of the line item */ price: number; /** Where the price of the line item comes from */ price_source: string; tax: TaxDetail | null; /** Tax exclusive price of the line item */ tax_excl_price: number; /** Tax inclusive price of the line item */ tax_incl_price: number; /** Type of the variant */ type: VariantType; } export declare type OrderLineItemFulfillmentStatus = "fulfilled" | "partial" | "unfulfilled"; export interface OrderModify { /** Billing address of an order */ billing_address?: AddressCreate | null; /** Billing address of an order (short) */ billing_address_short_id?: string | null; /** Currency to calculate the order in */ currency?: string | null; /** Customer email, used in no auth order flows */ customer_email?: string | null; /** Customer id order belongs to, if customer creates an order this parameter is ignored */ customer_id?: string | null; /** A discount code that can be entered by a customer on checkout */ discount_code?: string | null; /** Gateway used */ gateway_id?: string | null; /** Order line items */ line_items?: Array | null; /** The mobile phone number of the customer (used for notifications) */ mobile?: string | null; /** Whether to notify customer via mobile phone or not */ mobile_notifications?: boolean | null; /** Should customer receive fulfillment-related notifications or not */ send_fulfillment_notifications?: boolean | null; /** Should customer receive order-related notifications or not */ send_order_notifications?: boolean | null; /** Shipping address of an order */ shipping_address?: AddressCreate | null; /** Shipping address of an order (short) */ shipping_address_short_id?: string | null; shipping_rate_ids?: Array | null; /** Subscription associated with this order */ subscription_id?: string | null; } export interface OrderOverride { /** Geographic coordinate specifying the north/south location of an address */ shipping_address_latitude?: number | null; /** Geographic coordinate specifying the east/west location of an address */ shipping_address_longitude?: number | null; /** Shipping address override */ shipping_address_override?: AddressCreate | null; } export interface OrderPage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export interface OrderPayment { /** Confirm pending payment intent */ confirm?: boolean | null; /** Use it to perform gateway payment */ credit_card?: OrderPaymentCreditCard | null; /** Use it to perform manual payment */ manual?: OrderPaymentManual | null; /** Use it to perform gateway payment (when gateway type is "stripe") */ payment_method?: string | null; /** Use it to perform gateway payment (when gateway type is "paypal") */ paypal?: OrderPaymentPaypal | null; /** Use it to perform gateway payment (when gateway type is "stripe") */ source?: string | null; /** Use it to perform gateway payment (when gateway type is "stripe", for saved cards) */ stripe?: OrderPaymentStripe | null; /** Use it to perform gateway payment (when gateway type is "stripe") */ token?: string | null; } export interface OrderPaymentCreditCard { /** Expiration month */ month: number; /** Name on the card */ name: string; /** Credit card number */ number: string; /** Credit card verification value (CVV) */ verification_value: string; /** Expiration year */ year: number; } export interface OrderPaymentManual { /** Amount of money paid manually */ amount: number; } export interface OrderPaymentPaypal { /** PayPal order id */ order_id: string; /** Patch the order with final price before authorizing */ patch: boolean; } export interface OrderPaymentStripe { /** Stripe customer id to apply charge to */ customer_id: string; /** Stripe payment source id to apply charge to */ source_id: string; } export interface OrderRefund { /** Amount of money to refund to customer's balance */ customer_balance?: number | null; /** Whether to perform full refund or not */ full_refund?: boolean | null; /** Whether to perform full restock or not */ full_restock?: boolean | null; line_items?: Array | null; /** Whether to notify customer about refund via email or not */ notify?: boolean | null; /** Reason why order is refunded */ reason?: OrderRefundReason | null; shipping?: OrderRefundShipping | null; /** Undo coupon and promotion usage, does nothing but decrements "times used" property on the coupon and promotion */ undo_coupon_usage?: boolean | null; } export interface OrderRefundLineItem { /** Destination inventory location id */ dest_inventory_location_id?: string | null; /** Fulfillment id */ fulfillment_id?: string | null; /** Inventory location id */ inventory_location_id?: string | null; /** Line item id */ line_item_id: string; /** Amount to refund for this line item */ refund_amount?: number | null; /** Refund fee (won't be included in refund payment) */ refund_fee?: number | null; /** Amount of items to restock */ restock_quantity?: number | null; /** Variant id */ variant_id?: string | null; } export declare type OrderRefundReason = "adjustment" | "courtesy_adjustment" | "customer_canceled" | "customer_discretionary_return" | "delivered_late_by_carrier" | "fee_adjustment" | "late_shipment_credit" | "no_inventory" | "order_canceled" | "other" | "price_error" | "product_arrived_damaged" | "product_not_as_described" | "shipping_cost_adjustment" | "tax_adjustment" | "undeliverable_shipping_address" | "wrong_product_shipped"; export interface OrderRefundShipping { /** Amount to refund for shipping price */ refund_amount: number; /** Refund fee (won't be included in refund payment) */ refund_fee: number; } export interface OrderRestock { /** Whether to perform full restock or not */ full_restock?: boolean | null; /** Line items to restock */ line_items?: Array | null; } export interface OrderRestockLineItem { /** Destination inventory location id */ dest_inventory_location_id?: string | null; /** Fulfillment id */ fulfillment_id?: string | null; /** Inventory location id */ inventory_location_id?: string | null; /** Line item id */ line_item_id: string; /** Amount of items to restock */ restock_quantity?: number | null; /** Line item id */ variant_id?: string | null; } export interface OrderRisk { billing_address: OrderRiskBillingAddress | null; /** The date and time when the risk score was created */ created_at: string; /** Display this score or not */ display: boolean; /** Whether this score comes from an external service or from an internal one */ external: boolean; /** Message describing the problem with order */ message: string; /** If order was canceled or not by risk evaluation service */ order_canceled: boolean; /** Unique order identifier this risk belongs to */ order_id: string; /** Risk level classification */ risk_level: RiskLevel; /** Risk score, from 0.0 to 1.0, 0 is the lowest risk, 1 is maximum risk */ score: number; shipping: OrderRiskShipping | null; shipping_address: OrderRiskShippingAddress | null; } export interface OrderRiskBillingAddress { /** Distance to IP location (in meters) */ distance_to_ip_location: number; /** Does billing address country match IP country? */ is_in_ip_country: boolean; } export interface OrderRiskBillingAddressCreate { distance_to_ip_location: number; is_in_ip_country: boolean; } export interface OrderRiskCreate { billing_address?: OrderRiskBillingAddressCreate | null; /** Display this score or not */ display?: boolean | null; /** Whether this score comes from an external service or from an internal one */ external?: boolean | null; /** Message describing the problem with order */ message?: string | null; /** If order was canceled or not by risk evaluation service */ order_canceled?: boolean | null; /** Risk level classification */ risk_level: RiskLevel; /** Risk score, from 0.0 to 1.0, 0 is the lowest risk, 1 is maximum risk */ score: number; shipping?: OrderRiskShippingCreate | null; shipping_address?: OrderRiskShippingAddressCreate | null; } export interface OrderRiskShipping { /** Shipping price divided by total line items price (suspicious if > 1) */ cost_factor: number; } export interface OrderRiskShippingAddress { /** Distance to billing address (in meters) */ distance_to_billing_address: number; /** Distance to IP location (in meters) */ distance_to_ip_location: number; /** Does shipping address country match IP country? */ is_in_ip_country: boolean; } export interface OrderRiskShippingAddressCreate { distance_to_billing_address: number; distance_to_ip_location: number; is_in_ip_country: boolean; } export interface OrderRiskShippingCreate { cost_factor: number; } export interface OrderRuleEvalDetail { discountable: string; line_items: Array; order: string; shipping: string; } export interface OrderSearchResult { /** Total number of items in the collection */ count: number; items: Array<{ id: string; } | Order | null>; } export declare type OrderSourceName = "admin" | "subscription" | "web"; export declare type OrderState = "authorize_payment" | "capture_payment" | "cart" | "manual_payment" | "reserved"; export declare type OrderType = "abandoned" | "any" | "archived" | "canceled" | "draft" | "open" | "paid" | "unfulfilled" | "unpaid"; export declare type OrdersPageSortBy = "created_at" | "updated_at"; export interface PDFSignature { signature: string; } export interface Packaging { /** Whether this packaging is enabled or not */ enabled: boolean; /** The weight of the empty packaging in grams */ grams: number; /** Height of the packaging in millimeters */ height: number; /** Unique packaging identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** A list of inventory locations this packaging is allowed to be used with */ inventory_locations: Array<{ id: string; } | InventoryLocation | null>; /** Length of the packaging in millimeters */ length: number; /** The maximum weight this packaging can hold (excluding its own weight) */ max_grams: number; /** Name of the packaging */ name: string; /** A list shipping providers this packaging is allowed to be used with */ shipping_providers: Array<{ id: string; } | ShippingProvider | null>; /** Width of the packaging in millimeters */ width: number; } export interface PackagingCreate { /** Whether this packaging is enabled or not */ enabled?: boolean | null; /** The weight of the empty packaging in grams */ grams?: number | null; /** Height of the packaging in millimeters */ height?: number | null; inventory_location_ids?: Array | null; /** Length of the packaging in millimeters */ length?: number | null; /** The maximum weight this packaging can hold (excluding its own weight) */ max_grams?: number | null; /** Name of the packaging */ name: string; shipping_provider_ids?: Array | null; /** Width of the packaging in millimeters */ width?: number | null; } export interface PackagingModify { /** Whether this packaging is enabled or not */ enabled?: boolean | null; /** The weight of the empty packaging in grams */ grams?: number | null; /** Height of the packaging in millimeters */ height?: number | null; inventory_location_ids?: Array | null; /** Length of the packaging in millimeters */ length?: number | null; /** The maximum weight this packaging can hold (excluding its own weight) */ max_grams?: number | null; /** Name of the packaging */ name?: string | null; shipping_provider_ids?: Array | null; /** Width of the packaging in millimeters */ width?: number | null; } export interface PackedBox { /** The weight of the empty packaging in grams */ grams: number; /** Height of the packaging in millimeters */ height: number; inventory_location_id: string; items: Array; /** Length of the packaging in millimeters */ length: number; /** The maximum weight this packaging can hold (excluding its own weight) */ max_grams: number; /** Name of the packaging */ name: string; /** Width of the packaging in millimeters */ width: number; } export interface PackedItem { grams: number; height: number; length: number; line_item_id: string; variant_id: string; width: number; x: number; y: number; z: number; } export interface PaymentDetail { bancontact: PaymentDetailBancontact | null; card: PaymentDetailCard | null; client: PaymentDetailClient; eps: PaymentDetailEps | null; /** A number of failed payment attempts */ failed_attempts: number; giropay: PaymentDetailGiropay | null; ideal: PaymentDetailIdeal | null; masterpass: PaymentDetailMasterpass | null; multibanco: PaymentDetailMultibanco | null; p24: PaymentDetailP24 | null; /** Stripe's payment method id (if any) */ payment_method_id: string | null; sofort: PaymentDetailSofort | null; /** Type of the payment detail */ type: PaymentDetailType; visa_checkout: PaymentDetailVisaCheckout | null; } export interface PaymentDetailBancontact { bank_code: string; bank_name: string; bic: string; iban_last4: string; preferred_language: string; verified_name: string; } export interface PaymentDetailCard { /** Address line1 check from stripe */ address_line1_check: string; /** Address postal code check from stripe */ address_postal_code_check: string; /** The response code from AVS */ avs_result_code: string; /** The issuer identification number (IIN), formerly known as bank identification number (BIN) */ bin: string; /** The name of the company who issued the customer's credit card */ company: PaymentDetailCardCompany; /** Credit card's country */ country?: { id: string; } | InfoCountry | null; /** CVC check from stripe */ cvc_check: string; /** The response code from the credit card company indicating whether the customer entered the card verification value, correctly */ cvv_result_code: string; /** Credit card's expiration month */ exp_month: number; /** Credit card's expiration year */ exp_year: number; /** Card fingerprint from stripe */ fingerprint: string; /** The type of card from stripe */ funding: PaymentDetailCardFunding; /** The customer's credit card last 4 digits */ last4: string; } export declare type PaymentDetailCardCompany = "amex" | "diners" | "discover" | "elo" | "hiper" | "jcb" | "mastercard" | "other" | "unionpay" | "visa"; export declare type PaymentDetailCardFunding = "credit" | "debit" | "other" | "prepaid"; export interface PaymentDetailClient { /** Browser's accept language at the moment of payment */ accept_language: string; /** Browser IP at the moment of payment */ browser_ip: string; /** Resolved info based on IP and UserAgent */ ip_and_ua: IPAndUAInfo | null; /** Client's session identifier */ session_id: string; /** Browser's user agent at the moment of payment */ user_agent: string; } export interface PaymentDetailEps { verified_name: string; } export interface PaymentDetailGiropay { bank_code: string; bank_name: string; bic: string; verified_name: string; } export interface PaymentDetailIdeal { bank: string; bic: string; iban_last4: string; verified_name: string; } export interface PaymentDetailMasterpass { email: string; name: string; } export interface PaymentDetailMultibanco { entity: string; reference: string; } export interface PaymentDetailP24 { reference: string; verified_name: string; } export interface PaymentDetailSofort { bank_code: string; bank_name: string; bic: string; country: string; iban_last4: string; verified_name: string; } export declare type PaymentDetailType = "alipay" | "amex_express_checkout" | "apple_pay" | "bancontact" | "card" | "eps" | "giropay" | "google_pay" | "ideal" | "manual" | "masterpass" | "multibanco" | "p24" | "paypal" | "samsung_pay" | "sofort" | "visa_checkout" | "wechat"; export interface PaymentDetailVisaCheckout { email: string; name: string; } export interface PaymentMethod { /** Credit card */ credit_card: PaymentMethodCreditCard; /** Unique payment method identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; } export interface PaymentMethodCreate { /** Stripe payment method token */ token?: string | null; } export interface PaymentMethodCreditCard { /** Billing city */ address_city: string; /** Billing address country code */ address_country: string; /** Billing address country info if available */ address_country_info?: { id: string; } | InfoCountry | null; /** Billing address line 1 */ address_line1: string; /** Billing address line 2 */ address_line2: string; /** Billing address state code */ address_state: string; /** Billing address state info if available */ address_state_info?: { id: string; } | InfoProvince | null; /** Billing zip or postal code */ address_zip: string; /** Credit card brand */ brand: string; /** Credit card expiration month */ exp_month: number; /** Credit card expiration year */ exp_year: number; /** Stripe payment source id */ id: string; /** Last 4 digits of the credit card number */ last4: string; /** Name of the card holder */ name: string; } export interface PaymentMethodModify { /** Billing city */ address_city?: string | null; /** Billing address country code */ address_country?: string | null; /** Billing address line 1 */ address_line1?: string | null; /** Billing address line 2 */ address_line2?: string | null; /** Billing address state code */ address_state?: string | null; /** Billing zip or postal code */ address_zip?: string | null; /** Credit card expiration month */ exp_month?: number | null; /** Credit card expiration year */ exp_year?: number | null; /** Name of the card holder */ name?: string | null; } export interface Plan { abandoned_order_notifications: boolean; admin_only: boolean; analytics: PlanAnalyticsFlags; annual: boolean; api_requests_capacity: number; api_requests_per_second: number; api_token: boolean; card_tokenization: boolean; gift_card: boolean; inventory_location_limit: number; language_limit: number; monthly_orders: number; monthly_returns: number; multiple_currencies: boolean; order_fee: number; /** Unique plan identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ plan_id: string; /** Plan name */ plan_name: string; price: number; price_annual: number; product_limit: number; real_time_shipping_rates: boolean; return_fee: number; risk_evaluation: boolean; storage_limit: number; testing_only: boolean; transaction_fee: number; user_limit: number; } export interface PlanAnalyticsFlags { abandoned_orders: boolean; customers: boolean; insights: boolean; marketing: boolean; merchandising: boolean; orders: boolean; purchase_funnel: boolean; sales_tax_report: boolean; store_search: boolean; } export interface PlanCreate { /** Unique payment method identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ payment_method_id?: string | null; /** Unique plan identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ plan_id: string; /** Stripe payment method token */ token?: string | null; } export interface PlanPreview { /** Unique plan identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ plan_id: string; } export interface Product { /** Cached product analytics data, far from realtime (updated every N hours) */ analytics: ProductAnalytics; /** Average review score, from 0 to 9 (inclusive, both ends) */ average_score: number; average_scores: Array; /** List of countries, allowed or denied depending on ban mode */ ban_countries: Array; /** Ban mode for country-based banning */ ban_mode: ProductBanMode; /** Brand of the product */ brand?: { id: string; } | Brand | null; /** A set of category resource links product belongs to */ categories: Array<{ id: string; } | Category | null>; /** Image files referenced by "raw_content". */ content_image_files: Array<{ id: string; } | File | null>; /** The date and time when the product was created, RFC 3339 format */ created_at: string; /** Custom field objects extracted and ready for expansion */ custom_field_objects: CustomFieldObjects | null; custom_fields: Array; field_set?: { id: string; } | ProductFieldSet | null; /** Google Product Category numeric code */ google_product_category_code: number; /** Google Product Category human-friendly name */ google_product_category_name: string; /** A human-friendly unique string for the product automatically generated from its title */ handle: string; /** A unique product identifier */ id: string; /** Maximum of variant inventory counts */ max_inventory_count: number; /** Maximum amount of items customer can buy within one order */ maximum_quantity: number | null; /** Meta description for SEO purposes */ meta_description: string; /** SEO-friendly title of the product */ meta_title: string; /** Minimum currency prices of all variants */ min_currency_prices: Array; /** Minimum customer group prices of all variants */ min_customer_group_prices: Array; /** Minimum of variant inventory counts */ min_inventory_count: number; /** Minimum price of all product variants */ min_price: number; /** Minimum amount of items customer must order to buy a product */ minimum_quantity: number | null; /** Number of customers which don't recommend this product (simple vote) */ no_count: number; /** Whether server thinks product is published or not (depends on server time) */ published: boolean; /** The date and time when the product was published or null */ published_at: string | null; /** Raw content of the product */ raw_content: string; /** Number of customers which don't recommend this product (reviews) */ recommended_no_count: number; /** Number of customers which recommend this product (reviews) */ recommended_yes_count: number; /** What to do if customer wants to return the product */ return_mode: ProductReturnMode; /** Total amount of reviews for this product */ review_count: number; review_dimension_set?: { id: string; } | ReviewDimensionSet | null; /** Whether this product can only be used with a subscription or not */ subscription_only: boolean; subscription_plans: Array; /** Sum of variant inventory counts (only positive ones) */ sum_inventory_count: number; survey_answers_summary: Array; /** How to apply tiered pricing */ tiered_pricing_mode: TieredPricingMode; /** The name of the product */ title: string; /** The date and time when the product was last updated, RFC 3339 format */ updated_at: string; /** Variants of the product */ variants: Array<{ id: string; } | ProductVariant | null>; /** Number of customers which recommend this product (simple vote) */ yes_count: number; } export interface ProductAnalytics { /** Number of products sold in past 180 days */ sales: number; /** Number of visits in past 30 days */ visits: number; } export declare type ProductBanMode = "allow_all_but" | "deny_all_but"; export interface ProductCreate { /** List of countries, allowed or denied depending on ban mode */ ban_countries?: Array | null; /** Ban mode for country-based banning */ ban_mode?: ProductBanMode | null; /** A brand of the product */ brand_id?: string | null; /** A set of category resource links product belongs to */ category_ids?: Array | null; custom_fields?: Array | null; /** Field set for this product */ field_set_id?: string | null; /** Google Product Category numeric code */ google_product_category_code?: number | null; /** A human-friendly unique string for the product automatically generated from its title */ handle?: string | null; /** If product is created as a result of import process, this is import process owner ID */ import_id?: string | null; /** If product is created as a result of import process, this is import index (e.g. CSV line) */ import_index?: number | null; /** Maximum amount of items customer can buy within one order */ maximum_quantity?: number | null; /** Meta description for SEO purposes */ meta_description?: string | null; /** SEO-friendly title of the product */ meta_title?: string | null; /** Minimum amount of items customer must order to buy a product */ minimum_quantity?: number | null; /** Whether server thinks product is published or not (depends on server time) */ published?: boolean | null; /** The date and time when the product was published or null */ published_at?: string | null; /** Raw content of the product */ raw_content?: string | null; /** What to do if customer wants to return the product */ return_mode?: ProductReturnMode | null; /** Review dimension set for this product */ review_dimension_set_id?: string | null; /** Whether this product can only be used with a subscription or not */ subscription_only?: boolean | null; /** Available subscription plans */ subscription_plans?: Array | null; /** How to apply tiered pricing */ tiered_pricing_mode?: TieredPricingMode | null; /** The name of the product */ title: string; } export interface ProductExpandableItems { /** Generic array of expandable items */ items: Array<{ id: string; } | Product | null>; } export interface ProductField { /** A set of choices for "choice" field type */ choices: Array; /** Label of the field */ label: string; /** Whether field is required or not */ required: boolean; /** Type of the field */ type: ProductFieldType; } export interface ProductFieldCreate { /** A set of choices for "choice" field type */ choices?: Array | null; /** Label of the field */ label: string; /** Whether field is required or not */ required?: boolean | null; /** Type of the field */ type: ProductFieldType; } export interface ProductFieldSet { fields: Array; /** A unique field set identifier */ id: string; /** Name of the field set */ name: string; } export interface ProductFieldSetCreate { fields: Array; /** Name of the field set */ name: string; } export interface ProductFieldSetModify { fields?: Array | null; /** Name of the field set */ name?: string | null; } export declare type ProductFieldType = "checkbox" | "choice" | "file" | "number" | "string" | "text"; export interface ProductModify { /** List of countries, allowed or denied depending on ban mode */ ban_countries?: Array | null; /** Ban mode for country-based banning */ ban_mode?: ProductBanMode | null; /** A brand of the product */ brand_id?: string | null; /** A set of category resource links product belongs to */ category_ids?: Array | null; custom_fields?: Array | null; /** Field set for this product */ field_set_id?: string | null; /** Google Product Category numeric code */ google_product_category_code?: number | null; /** A human-friendly unique string for the product automatically generated from its title */ handle?: string | null; /** Maximum amount of items customer can buy within one order */ maximum_quantity?: number | null; /** Meta description for SEO purposes */ meta_description?: string | null; /** SEO-friendly title of the product */ meta_title?: string | null; /** Minimum amount of items customer must order to buy a product */ minimum_quantity?: number | null; /** Whether server thinks product is published or not (depends on server time) */ published?: boolean | null; /** The date and time when the product was published or null */ published_at?: string | null; /** Raw content of the product */ raw_content?: string | null; /** What to do if customer wants to return the product */ return_mode?: ProductReturnMode | null; /** Review dimension set for this product */ review_dimension_set_id?: string | null; /** Whether this product can only be used with a subscription or not */ subscription_only?: boolean | null; /** Available subscription plans */ subscription_plans?: Array | null; /** How to apply tiered pricing */ tiered_pricing_mode?: TieredPricingMode | null; /** The name of the product */ title?: string | null; } export interface ProductPage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export interface ProductQuestion { /** Answers for this question */ answers: Array<{ id: string; } | ProductQuestionAnswer | null>; /** The date and time when the question was created, RFC 3339 format */ created_at: string; /** Customer who wrote the question */ customer?: { id: string; } | Customer | null; /** Language detected for this question */ detected_language?: { id: string; } | InfoLanguage | null; email_message?: { id: string; } | Message | null; /** Number of times this question was flagged */ flag_count: number; /** Whether flagging actions are ignored */ flag_ignore: boolean; /** Unique question identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Number of times this question was voted no */ no_count: number; /** Product this question is about */ product?: { id: string; } | Product | null; /** Rating based on yes/no votes (yes_count minus no_count) */ rating: number; /** Publishing approval status */ status: ApprovalStatus; /** Text of the question */ text: string; /** The date and time when the question was last updated, RFC 3339 format */ updated_at: string; /** Number of times this question was voted yes */ yes_count: number; } export interface ProductQuestionAnswer { /** The date and time when the answer was created, RFC 3339 format */ created_at: string; /** Author of the question answer */ customer?: { id: string; } | Customer | null; /** Language detected for this question answer */ detected_language?: { id: string; } | InfoLanguage | null; email_message?: { id: string; } | Message | null; /** Number of times this answer was flagged */ flag_count: number; /** Whether flagging actions are ignored */ flag_ignore: boolean; /** Unique answer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Number of times this answer was voted no */ no_count: number; /** Product of the question this answer is for */ product?: { id: string; } | Product | null; /** Question this answer is for */ question?: { id: string; } | ProductQuestion | null; /** Publishing approval status */ status: ApprovalStatus; /** Text of the answer */ text: string; /** The date and time when the answer was last updated, RFC 3339 format */ updated_at: string; /** Author of the question answer */ user?: { id: string; } | User | null; /** Number of times this answer was voted yes */ yes_count: number; } export interface ProductQuestionAnswerPage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export interface ProductQuestionCreate { /** Unique customer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ customer_id?: string | null; /** Whether flagging actions are ignored */ flag_ignore?: boolean | null; /** A unique product identifier */ product_id: string; /** Publishing approval status */ status?: ApprovalStatus | null; /** Text of the question */ text: string; } export interface ProductQuestionExpandableItems { /** Generic array of expandable items */ items: Array<{ id: string; } | ProductQuestion | null>; } export interface ProductQuestionModify { /** Whether flagging actions are ignored */ flag_ignore?: boolean | null; /** Publishing approval status */ status?: ApprovalStatus | null; /** Text of the question */ text?: string | null; } export interface ProductQuestionPage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export interface ProductQuestionSearchResult { /** Total number of items in the collection */ count: number; items: Array<{ id: string; } | ProductQuestion | null>; } export declare type ProductQuestionsAnswersPageSortBy = "created_at"; export declare type ProductQuestionsPageSortBy = "created_at"; export declare type ProductReturnMode = "allowed" | "not_allowed"; export interface ProductReview { /** Answers for this review */ answers: Array<{ id: string; } | ProductReviewAnswer | null>; /** Average review score, from 0 to 9 (inclusive, both ends) */ average_score: number; /** The date and time when the review was created, RFC 3339 format */ created_at: string; /** Author of the review */ customer?: { id: string; } | Customer | null; /** Language detected for this review */ detected_language?: { id: string; } | InfoLanguage | null; email_message?: { id: string; } | Message | null; /** Number of times this review was flagged */ flag_count: number; /** Whether flagging actions are ignored */ flag_ignore: boolean; /** Unique review identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Image files for this review */ image_files: Array<{ id: string; } | File | null>; /** Number of times this review was voted no */ no_count: number; /** Product this review is for */ product?: { id: string; } | Product | null; /** Rating based on yes/no votes (yes_count minus no_count) */ rating: number; /** Whether customer voted or not and how */ recommended: StorefrontCustomerVote; scores: Array; /** Publishing approval status */ status: ApprovalStatus; survey_answers: Array; /** Text of the review */ text: string; /** Title of the review */ title: string; /** The date and time when the review was last updated, RFC 3339 format */ updated_at: string; /** Whether customer has completed orders with given product or not */ verified_purchase: boolean; /** Number of times this review was voted yes */ yes_count: number; } export interface ProductReviewAnswer { /** The date and time when the answer was created, RFC 3339 format */ created_at: string; /** Language detected for this review answer */ detected_language?: { id: string; } | InfoLanguage | null; email_message?: { id: string; } | Message | null; /** Number of times this answer was flagged */ flag_count: number; /** Whether flagging actions are ignored */ flag_ignore: boolean; /** Unique answer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Number of times this answer was voted no */ no_count: number; /** Product of the review this answer is for */ product?: { id: string; } | Product | null; /** The review this answer is for */ review?: { id: string; } | ProductReview | null; /** Publishing approval status */ status: ApprovalStatus; /** Text of the answer */ text: string; /** The date and time when the answer was last updated, RFC 3339 format */ updated_at: string; /** Author of the answer */ user?: { id: string; } | User | null; /** Number of times this answer was voted yes */ yes_count: number; } export interface ProductReviewAnswerPage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export interface ProductReviewAnswerSummary { /** Amount of answers for this question */ count: number; /** Stats per word or per answer (depending on question kind), empty key is a special "other" group for word stats. Only top N words are aggregated. */ histogram: Array; /** Survey question this summary is about */ survey_question?: { id: string; } | SurveyQuestion | null; } export interface ProductReviewAverageScore { /** Amount of samples for this dimension */ count: number; histogram: Array; /** Review dimension this average score is calculated for */ review_dimension?: { id: string; } | ReviewDimension | null; /** Average review score, from 0 to 9 (inclusive, both ends) */ score: number; /** Sum of all scores */ sum: number; } export interface ProductReviewCreate { /** Unique customer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ customer_id?: string | null; /** Whether flagging actions are ignored */ flag_ignore?: boolean | null; image_file_ids?: Array | null; /** A unique product identifier */ product_id: string; /** Whether customer voted or not and how */ recommended?: StorefrontCustomerVote | null; scores?: Array | null; /** Publishing approval status */ status?: ApprovalStatus | null; survey_answers?: Array | null; /** Text of the review */ text: string; /** Title of the review */ title: string; } export interface ProductReviewExpandableItems { /** Generic array of expandable items */ items: Array<{ id: string; } | ProductReview | null>; } export interface ProductReviewModify { /** Whether flagging actions are ignored */ flag_ignore?: boolean | null; image_file_ids?: Array | null; /** Whether customer voted or not and how */ recommended?: StorefrontCustomerVote | null; scores?: Array | null; /** Publishing approval status */ status?: ApprovalStatus | null; survey_answers?: Array | null; /** Text of the review */ text?: string | null; /** Title of the review */ title?: string | null; } export interface ProductReviewPage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export interface ProductReviewScore { /** Review dimension this score belongs to */ review_dimension?: { id: string; } | ReviewDimension | null; /** Review score, from 0 to 9 (inclusive, both ends) */ score: number; } export interface ProductReviewScoreCreate { /** A unique review dimension identifier */ review_dimension_id: string; /** Review score, from 0 to 9 (inclusive, both ends) */ score: number; } export interface ProductReviewSearchResult { /** Total number of items in the collection */ count: number; items: Array<{ id: string; } | ProductReview | null>; } export interface ProductReviewSurveyAnswer { answer: string; answer_index: number; survey_question?: { id: string; } | SurveyQuestion | null; } export interface ProductReviewSurveyAnswerCreate { answer: string; answer_index: number; /** Unique survey question identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ survey_question_id: string; } export declare type ProductReviewsAnswersPageSortBy = "created_at"; export declare type ProductReviewsPageSortBy = "created_at"; export interface ProductSearchOptionAgg { /** Number of occurrences in the aggregation */ count: number; /** ID of the option */ name: string; /** Values */ values: Array; } export interface ProductSearchOptionValueAgg { /** Number of occurrences in the aggregation */ count: number; /** ID of the option value */ name: string; } export interface ProductSearchResult { /** Categories aggregation, id => count pairs */ categories: Array; /** Total number of search results hits */ count: number; /** Products on the current page */ items: Array<{ id: string; } | Product | null>; /** Key of the last item for keyset based iteration */ last_key: string; /** Options aggregation */ options: Array; /** Maximum price for given search conditions */ price_max: number; /** Minimum price for given search conditions */ price_min: number; } export interface ProductVariant { /** File attachment for digital good product variants */ attachment?: { id: string; } | File | null; /** The barcode, UPC or ISBN number for the product */ barcode: string; /** Items in the bundle */ bundle_line_items: Array; /** The cost price of the product variant */ cost_price: number; /** Country of origin (ISO 3166-1 alpha-2) */ country_of_origin?: { id: string; } | InfoCountry | null; /** The date and time when the variant was created, RFC 3339 format */ created_at: string; /** List of prices specific to currencies */ currency_prices: Array; custom_fields: Array; /** List of prices specific to customer groups */ customer_group_prices: Array; /** Whether discount can be applied to this variant or not */ discountable: boolean; /** Amount of days the product is available for download after purchase (digital product), 0 if not limited */ expiration_days: number; /** Service who is doing the fulfillment */ fulfillment_service: FulfillmentService; /** The weight of the product variant in grams */ grams: number; /** Height of the product (in millimeters) used which can be used when calculating shipping costs */ height: number; /** Harmonized System (HS) Code */ hs_code: string; /** A unique product variant identifier */ id: string; /** Inventory associated with this product variant */ inventory?: { id: string; } | VariantInventory | null; /** Variant inventory count */ inventory_count: number; /** Specifies whether or not system tracks the number of items in stock for this product variant */ inventory_management: InventoryManagement; /** Specifies whether or not customers are allowed to place an order for a product variant when it's out of stock */ inventory_policy: InventoryPolicy; /** Whether this variant is a default variant of a product */ is_default: boolean; /** Length of the product (in millimeters) used which can be used when calculating shipping costs */ length: number; /** Linked media files for this variant. Media files of a closest variant (option-wise) will be provided if variant lacks own media files. */ linked_media_files: Array; /** The minimum advertised price of the product variant */ map_price: number; /** Maximum number of downloads (digital product), 0 if not limited */ max_downloads: number; /** Media files for this variant */ media_files: Array; /** Moving average cost calculated from purchase orders */ moving_average_cost: number; /** List of options */ options: Array; /** The order of the product variant in the list of product variants */ position: number; /** The price of the product variant */ price: number; /** Product this variant belongs to */ product?: { id: string; } | Product | null; /** The retail cost of the product variant */ retail_price: number; /** Special price for a product that can be active during a selected period of time */ sale_price: number; /** Whether sale price is eligible or not according to server's idea of time */ sale_price_eligible: boolean; /** Lower date boundary when sale price is active */ sale_price_from: string | null; /** Upper date boundary when sale price is active */ sale_price_to: string | null; /** A unique identifier for the product variant in the shop (stock keeping unit) */ sku: string; /** List of suppliers for this variant */ suppliers: Array; /** Tax class of this variant */ tax_class: string | null; /** Specifies whether or not a tax is charged when the product variant is sold */ taxable: boolean; tiered_pricing: TieredPricing | null; /** Type of the variant */ type: VariantType; /** The date and time when the variant was last updated, RFC 3339 format */ updated_at: string; /** Width of the product (in millimeters) used which can be used when calculating shipping costs */ width: number; } export interface ProductVariantCreate { /** Attachment file ID */ attachment_id?: string | null; /** The barcode, UPC or ISBN number for the product */ barcode?: string | null; /** Items in the bundle */ bundle_line_items?: Array | null; /** The cost price of the product variant */ cost_price?: number | null; /** Country of origin (ISO 3166-1 alpha-2) */ country_of_origin?: string | null; /** List of prices specific to currencies */ currency_prices?: Array | null; custom_fields?: Array | null; /** List of prices specific to customer groups */ customer_group_prices?: Array | null; /** Whether discount can be applied to this variant or not */ discountable?: boolean | null; /** Amount of days the product is available for download after purchase (digital product), 0 if not limited */ expiration_days?: number | null; /** Service who is doing the fulfillment */ fulfillment_service?: FulfillmentService | null; /** The weight of the product variant in grams */ grams?: number | null; /** Height of the product (in millimeters) used which can be used when calculating shipping costs */ height?: number | null; /** Harmonized System (HS) Code */ hs_code?: string | null; /** Specifies whether or not system tracks the number of items in stock for this product variant */ inventory_management?: InventoryManagement | null; /** Specifies whether or not customers are allowed to place an order for a product variant when it's out of stock */ inventory_policy?: InventoryPolicy | null; /** Whether this variant is a default variant of a product */ is_default?: boolean | null; /** Length of the product (in millimeters) used which can be used when calculating shipping costs */ length?: number | null; /** The minimum advertised price of the product variant */ map_price?: number | null; /** Maximum number of downloads (digital product), 0 if not limited */ max_downloads?: number | null; /** Media files for this variant */ media_files?: Array | null; /** List of options */ options?: Array | null; /** The order of the product variant in the list of product variants */ position?: number | null; /** The price of the product variant */ price?: number | null; /** A unique product identifier */ product_id?: string | null; /** The retail cost of the product variant */ retail_price?: number | null; /** Special price for a product that can be active during a selected period of time */ sale_price?: number | null; /** Lower date boundary when sale price is active */ sale_price_from?: string | null; /** Upper date boundary when sale price is active */ sale_price_to?: string | null; /** A unique identifier for the product variant in the shop (stock keeping unit) */ sku: string; /** List of suppliers for this variant */ suppliers?: Array | null; /** Tax class of this variant */ tax_class?: string | null; /** Specifies whether or not a tax is charged when the product variant is sold */ taxable?: boolean | null; tiered_pricing?: TieredPricingCreate | null; /** Type of the variant */ type?: VariantType | null; /** Width of the product (in millimeters) used which can be used when calculating shipping costs */ width?: number | null; } export interface ProductVariantModify { /** Attachment file ID */ attachment_id?: string | null; /** The barcode, UPC or ISBN number for the product */ barcode?: string | null; /** Items in the bundle */ bundle_line_items?: Array | null; /** The cost price of the product variant */ cost_price?: number | null; /** Country of origin (ISO 3166-1 alpha-2) */ country_of_origin?: string | null; /** List of prices specific to currencies */ currency_prices?: Array | null; custom_fields?: Array | null; /** List of prices specific to customer groups */ customer_group_prices?: Array | null; /** Whether discount can be applied to this variant or not */ discountable?: boolean | null; /** Amount of days the product is available for download after purchase (digital product), 0 if not limited */ expiration_days?: number | null; /** Service who is doing the fulfillment */ fulfillment_service?: FulfillmentService | null; /** The weight of the product variant in grams */ grams?: number | null; /** Height of the product (in millimeters) used which can be used when calculating shipping costs */ height?: number | null; /** Harmonized System (HS) Code */ hs_code?: string | null; /** Specifies whether or not system tracks the number of items in stock for this product variant */ inventory_management?: InventoryManagement | null; /** Specifies whether or not customers are allowed to place an order for a product variant when it's out of stock */ inventory_policy?: InventoryPolicy | null; /** Whether this variant is a default variant of a product */ is_default?: boolean | null; /** Length of the product (in millimeters) used which can be used when calculating shipping costs */ length?: number | null; /** The minimum advertised price of the product variant */ map_price?: number | null; /** Maximum number of downloads (digital product), 0 if not limited */ max_downloads?: number | null; /** Media files for this variant */ media_files?: Array | null; /** List of options */ options?: Array | null; /** The order of the product variant in the list of product variants */ position?: number | null; /** The price of the product variant */ price?: number | null; /** The retail cost of the product variant */ retail_price?: number | null; /** Special price for a product that can be active during a selected period of time */ sale_price?: number | null; /** Lower date boundary when sale price is active */ sale_price_from?: string | null; /** Upper date boundary when sale price is active */ sale_price_to?: string | null; /** A unique identifier for the product variant in the shop (stock keeping unit) */ sku?: string | null; /** List of suppliers for this variant */ suppliers?: Array | null; /** Tax class of this variant */ tax_class?: string | null; /** Specifies whether or not a tax is charged when the product variant is sold */ taxable?: boolean | null; tiered_pricing?: TieredPricingCreate | null; /** Type of the variant */ type?: VariantType | null; /** Width of the product (in millimeters) used which can be used when calculating shipping costs */ width?: number | null; } export interface ProductVariantPage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export interface ProductVariantSearchResult { /** Total number of items in the collection */ count: number; items: Array<{ id: string; } | ProductVariant | null>; } export declare type ProductVariantsPageSortBy = "created_at"; export declare type ProductsPageSortBy = "created_at" | "updated_at"; export declare type ProfileImage = "auto" | "file"; export interface Promotion { /** When promotion is applied to order, add this many of add_variant_id to line items */ add_quantity: number | null; /** This product variant will be added to the order when promotion triggers */ add_variant?: { id: string; } | ProductVariant | null; /** Automatically apply this promotion */ auto_apply: boolean; /** The date and time when the promotion was created */ created_at: string; /** Currency code */ currency: string; /** Whether this promotion is active or not */ enabled: boolean; /** Whether promotion is ended based on server time */ ended: boolean; /** The date and time when the promotion will end */ ends_at: string | null; /** Unique promotion identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** The maximum number of times a promotion may apply to orders */ max_uses_per_coupon: number | null; /** The maximum number of uses per-customer */ max_uses_per_customer: number | null; /** The maximum number of uses per order */ max_uses_per_order: number | null; /** Name of the promotion */ name: string; /** Priority when automatically applying promotions, higher number takes precedence */ priority: number; /** Possible parameters for this promotion */ rules: Array; /** Whether promotion is started based on server time */ started: boolean; /** The date and time when the promotion starts at */ starts_at: string; /** Total number of times this promotion was used by all customers */ times_used: number; /** The date and time when the promotion was updated */ updated_at: string; } export interface PromotionCondition { /** Amount of money in shop's currency */ amount?: number; category?: { id: string; } | Category | null; customer_group?: { id: string; } | CustomerGroup | null; operator: RuleOperator; /** Index of the parent condition in this array */ parent_index?: number; product?: { id: string; } | Product | null; /** Quantity parameter */ quantity?: number; shipping_provider?: { id: string; } | ShippingProvider | null; /** Type of the condition */ type: PromotionConditionType; variant?: { id: string; } | ProductVariant | null; } export interface PromotionConditionCreate { /** Amount of money in shop's currency */ amount?: number | null; /** Category id, used depending on condition type */ category_id?: string | null; condition?: any; conditions?: Array | null; /** Customer group id, used depending on condition type */ customer_group_id?: string | null; operator?: RuleOperator; /** Product id, used depending on condition type */ product_id?: string | null; /** Quantity parameter */ quantity?: number | null; /** Shipping provider id, used depending on condition type */ shipping_provider_id?: string | null; /** Type of the condition */ type: PromotionConditionType; /** Variant id, used depending on condition type */ variant_id?: string | null; } export declare type PromotionConditionType = "and" | "customer_belongs_to_group" | "item_belongs_to_category" | "item_is_product" | "item_is_variant" | "not" | "or" | "order_has_product" | "order_has_product_from_category" | "order_has_variant" | "order_total" | "orders" | "param" | "return_window" | "shipping_address_country" | "shipping_provider_is"; export interface PromotionCreate { /** When promotion is applied to order, add this many of add_variant_id to line items */ add_quantity?: number | null; /** Variant id to add to line items of an order when promotion is used */ add_variant_id?: string | null; /** Automatically apply this promotion */ auto_apply?: boolean | null; /** Currency code used for all order-related prices defined in the promotion */ currency?: string | null; /** Whether this promotion is active or not */ enabled?: boolean | null; /** The date and time when the promotion will end */ ends_at?: string | null; /** The maximum number of times a promotion may apply to orders */ max_uses_per_coupon?: number | null; /** The maximum number of uses per-customer */ max_uses_per_customer?: number | null; /** The maximum number of uses per order */ max_uses_per_order?: number | null; /** Name of the promotion */ name: string; /** Priority when automatically applying promotions, higher number takes precedence */ priority?: number | null; /** Possible parameters for this promotion */ rules?: Array | null; /** The date and time when the promotion starts at */ starts_at?: string | null; } export interface PromotionExpandableItems { /** Generic array of expandable items */ items: Array<{ id: string; } | Promotion | null>; } export interface PromotionModify { /** When promotion is applied to order, add this many of add_variant_id to line items */ add_quantity?: number | null; /** Variant id to add to line items of an order when promotion is used */ add_variant_id?: string | null; /** Automatically apply this promotion */ auto_apply?: boolean | null; /** Currency code used for all order-related prices defined in the promotion */ currency?: string | null; /** Whether this promotion is active or not */ enabled?: boolean | null; /** The date and time when the promotion will end */ ends_at?: string | null; /** The maximum number of times a promotion may apply to orders */ max_uses_per_coupon?: number | null; /** The maximum number of uses per-customer */ max_uses_per_customer?: number | null; /** The maximum number of uses per order */ max_uses_per_order?: number | null; /** Name of the promotion */ name?: string | null; /** Priority when automatically applying promotions, higher number takes precedence */ priority?: number | null; rule_names_i18n?: Array | null; /** Possible parameters for this promotion */ rules?: Array | null; /** The date and time when the promotion starts at */ starts_at?: string | null; } export interface PromotionPage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export interface PromotionRule { conditions: Array; /** Unique promotion rule identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Name of the promotion rule */ name: string; /** The type of the promotion rule */ type: PromotionType; /** Percentage or fixed amount off depending on promotion rule type */ value: number; } export interface PromotionRuleCreate { condition?: PromotionConditionCreate | null; /** Unique promotion rule identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id?: string | null; /** Name of the promotion rule */ name?: string | null; /** The type of the promotion rule */ type: PromotionType; /** Percentage or fixed amount off depending on promotion rule type */ value: number; } export interface PromotionSearchResult { /** Total number of items in the collection */ count: number; items: Array<{ id: string; } | Promotion | null>; } export declare type PromotionType = "item_fixed_amount_off" | "item_percentage_off" | "order_fixed_amount_off" | "order_percentage_off" | "shipping_fixed_amount_off" | "shipping_percentage_off"; export declare type PromotionsPageSortBy = "created_at"; export declare type PromotionsPageStatus = "active" | "any" | "expired" | "inactive"; export declare type PublishedStatus = "any" | "published" | "unpublished"; export interface PurchaseOrder { /** Billing address */ bill_to: Address | null; /** Date and time when purchase order was created */ created_at: string; /** Currency code */ currency: string; /** Order date */ date: string; /** Whether purchase order is in a draft state or not */ draft: boolean; email_message?: { id: string; } | Message | null; /** Date and time when purchase order shipment is expected */ expected_at: string; /** Supplier this purchase order refers to */ from_supplier?: { id: string; } | Supplier | null; /** Unique purchase order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; line_items: Array; /** Purchase order sequential number */ number: number; /** Arbitrary reference string */ reference: string; /** Whether to send this PO to supplier via email or not (when submitted) */ send_email: boolean; /** Shipping price */ shipping: number; /** Status of the purchase order */ status: PurchaseOrderStatus; /** Note that will be visible to supplier (as part of the email) */ supplier_note: string; /** Whether prices include the tax or not */ tax_inclusive_prices: boolean; /** Destination inventory location */ to_inventory_location?: { id: string; } | InventoryLocation | null; /** Date and time when purchase order was last updated */ updated_at: string; } export declare type PurchaseOrderCategory = "any" | "closed" | "draft" | "not_received" | "open" | "partially_received" | "past_due" | "received"; export interface PurchaseOrderCreate { /** Bill to address */ bill_to?: AddressCreate | null; /** Currency code */ currency?: string | null; /** Order date */ date?: string | null; /** Whether purchase order is in a draft state or not */ draft?: boolean | null; /** Date and time when purchase order shipment is expected */ expected_at?: string | null; /** Unique supplier id (source) */ from_supplier_id?: string | null; line_items?: Array | null; /** Arbitrary reference string */ reference?: string | null; /** Whether to send this PO to supplier via email or not (when submitted) */ send_email?: boolean | null; /** Shipping price */ shipping?: number | null; /** Note that will be visible to supplier (as part of the email) */ supplier_note?: string | null; /** Whether prices include the tax or not */ tax_inclusive_prices?: boolean | null; /** Unique inventory location id (destination) */ to_inventory_location_id?: string | null; } export interface PurchaseOrderExpandableItems { /** Generic array of expandable items */ items: Array<{ id: string; } | PurchaseOrder | null>; } export interface PurchaseOrderLineItem { code: string; cost: number; /** Amount of items to receive */ quantity: number; /** Amount of items received */ received: number; /** Amount of items which will not be received */ rejected: number; tax: number; /** Product variant for this line item */ variant?: { id: string; } | ProductVariant | null; } export interface PurchaseOrderLineItemCreate { /** Line item code */ code: string; /** Line item cost */ cost: number; /** Amount of items to transfer */ quantity: number; /** Line item tax (in percents) */ tax: number; /** A unique product variant identifier */ variant_id: string; } export interface PurchaseOrderLineItemPartial { /** Amount of items to apply action to */ quantity: number; /** A unique product variant identifier */ variant_id: string; } export interface PurchaseOrderLog { items: Array; } export interface PurchaseOrderLogItem { /** Date and time transfer log entry was created */ created_at: string; line_items: Array; reason: string; /** Type of the log entry */ type: PurchaseOrderLogType; /** User responsible for the action */ user?: { id: string; } | User | null; } export interface PurchaseOrderLogLineItem { quantity: number; variant_id: string; } export declare type PurchaseOrderLogType = "closed" | "created" | "opened" | "received" | "rejected" | "undrafted"; export interface PurchaseOrderModify { /** Bill to address */ bill_to?: AddressCreate | null; /** Currency code */ currency?: string | null; /** Order date */ date?: string | null; /** Whether purchase order is in a draft state or not */ draft?: boolean | null; /** Date and time when purchase order shipment is expected */ expected_at?: string | null; /** Unique supplier id (source) */ from_supplier_id?: string | null; line_items?: Array | null; /** Arbitrary reference string */ reference?: string | null; /** Whether to send this PO to supplier via email or not (when submitted) */ send_email?: boolean | null; /** Shipping price */ shipping?: number | null; /** Note that will be visible to supplier (as part of the email) */ supplier_note?: string | null; /** Whether prices include the tax or not */ tax_inclusive_prices?: boolean | null; /** Unique inventory location id (destination) */ to_inventory_location_id?: string | null; } export interface PurchaseOrderPage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export interface PurchaseOrderReceive { line_items?: Array | null; /** Mark all items as received */ receive_all?: boolean | null; } export interface PurchaseOrderReject { line_items?: Array | null; /** What happened to items? */ reason?: string | null; /** Mark all items as rejected */ reject_all?: boolean | null; } export interface PurchaseOrderSearchResult { /** Total number of items in the collection */ count: number; items: Array<{ id: string; } | PurchaseOrder | null>; } export declare type PurchaseOrderStatus = "closed" | "not_received" | "partially_received" | "received"; export declare type PurchaseOrdersPageSortBy = "created_at"; export interface Query { /** Search query string */ query?: string | null; } export interface QuickbooksAccount { /** Unique account identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Account name */ name: string; /** Account subtype */ subtype: string; /** Account type */ type: string; } export interface QuickbooksLog { /** Date and time when message was added to log */ created_at: string; /** The message */ message: string; } export interface QuickbooksSettings { /** Quickbooks company name if connected */ company_name: string; /** Whether Quickbooks integration is active or not */ connected: boolean; /** Deposit To account identifier */ deposit_to_account: string; /** Whether syncing is enabled or not */ enabled: boolean; /** Product Sales account identifier */ product_sales_account: string; /** Date and time when customers were last synced */ synced_customers_at: string; /** Date and time when orders were last synced */ synced_orders_at: string; /** Date and time when products were last synced */ synced_products_at: string; tax_map: Array; } export interface QuickbooksSettingsCreate { /** Deposit To account identifier */ deposit_to_account?: string | null; /** Whether syncing is enabled or not */ enabled?: boolean | null; /** Product Sales account identifier */ product_sales_account?: string | null; /** Date and time when customers were last synced */ synced_customers_at?: string | null; /** Date and time when orders were last synced */ synced_orders_at?: string | null; /** Date and time when products were last synced */ synced_products_at?: string | null; tax_map?: Array | null; } export interface QuickbooksTaxMap { /** Tax code id from quickbooks */ tax_code_id: string; /** Tax rate name from trunkery tax rules */ tax_rate_name: string; } export interface QuickbooksTaxMapCreate { /** Tax code id from quickbooks */ tax_code_id: string; /** Tax rate name from trunkery tax rules */ tax_rate_name: string; } export interface QuickbooksTaxRate { components: Array; /** Description of the tax rate */ description: string; /** Unique identifier of the tax rate */ id: string; /** Name of the tax rate */ name: string; } export interface QuickbooksTaxRateComponent { /** Description of the component */ description: string; /** Unique identifier of the component */ id: string; /** Name of the component */ name: string; /** Tax rate of the component */ rate: number; /** Order in which tax is applied */ tax_order: number; /** How tax is applied */ tax_type_applicable: TaxTypeApplicable; } export interface RecoveryOTP { /** Recovery one-time password code */ code: string; } export declare type ReindexingStatus = "done" | "queued" | "reindexing"; export interface Request { attachments: Array; fields: Array; } export interface RequestAttachment { name: string; path: string; } export interface Return { /** The date and time when the return was approved */ approved_at: string | null; /** The date and time when the return was closed */ closed_at: string | null; /** The date and time when the return was created */ created_at: string; /** Whether to refund to customer balance */ customer_balance: boolean; /** The date and time when the inbound shipment is expected to be delivered (upper boundary) */ expected_at_max: string | null; /** The date and time when the inbound shipment is expected to be delivered (lower boundary) */ expected_at_min: string | null; history: Array; /** A unique return identifier */ id: string; /** Event status */ inbound_tracking: TrackingEventStatus; /** The date and time when the return was inspected */ inspected_at: string | null; label_file?: { id: string; } | File | null; line_items: Array; /** A unique return number */ number: number; order?: { id: string; } | Order | null; /** The date and time when the return was received */ received_at: string | null; /** Whether to refund shipping charge or not */ refund_shipping_charge: boolean; /** The date and time when the return was refunded */ refunded_at: string | null; /** Reason why a return was rejected */ reject_reason: string; /** The date and time when the return was rejected */ rejected_at: string | null; /** Whether to restock items to inventory or not */ restock_items_to_inventory: boolean; return_address: Address | null; /** What address customers will use for returns */ return_address_type: ReturnPolicyAddressType; return_fee: ReturnPolicyReturnFee | null; return_fee_value: number; return_inventory_location?: { id: string; } | InventoryLocation | null; return_policy?: { id: string; } | ReturnPolicy | null; /** Whether to generate label or not */ reverse_logistics: ReverseLogistics; /** Description for a custom reverse logistics option */ reverse_logistics_desc: string; /** Name for a custom reverse logistics option */ reverse_logistics_name: string; /** Type of the shipping provider (use "fixed" as "other") */ shipping_provider_type: ShippingProviderType | null; /** State of a return */ state: ReturnState; /** The name of the shipping company */ tracking_company: string; tracking_events: Array; /** Shipping number, provided by the shipping company */ tracking_number: string; /** The URLs to track the fulfillment */ tracking_url: string; /** The date and time when the return was last modified */ updated_at: string; } export declare type ReturnApproval = "automatic" | "manual"; export interface ReturnApprove { /** Label file ID */ label_file_id?: string | null; /** Type of the shipping provider */ shipping_provider_type?: ShippingProviderType | null; /** The name of the shipping company */ tracking_company?: string | null; /** Shipping number, provided by the shipping company */ tracking_number?: string | null; /** The URLs to track the fulfillment */ tracking_url?: string | null; } export declare type ReturnCategory = "any" | "approved" | "archived" | "inspected" | "received" | "refunded" | "rejected" | "requested"; export interface ReturnCheck { /** Whether this inspection is complete or not */ checked: boolean; /** Fulfillment id */ fulfillment_id: string; /** Unique return inspection identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ inspection_id: string; /** Line item id */ line_item_id: string; /** A unique product variant identifier */ variant_id: string; } export interface ReturnCreate { /** Whether to refund to customer balance */ customer_balance?: boolean | null; line_items: Array; /** A unique order identifier */ order_id: string; /** Unique return policy identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ return_policy_id: string; /** Index of the shipping option within return policy */ shipping_option_index: number; } export interface ReturnHistory { /** Type of the history entry */ action: ReturnHistoryAction; /** The date and time when the history entry was created */ created_at: string; customer?: { id: string; } | Customer | null; user?: { id: string; } | User | null; } export declare type ReturnHistoryAction = "approved" | "closed" | "created" | "inspected" | "opened" | "received" | "refunded" | "rejected"; export interface ReturnInspection { /** Return inspection description */ description: string; /** Whether return inspection is enabled or not */ enabled: boolean; /** Unique return inspection identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; } export interface ReturnInspectionCreate { /** Return inspection description (custom reasons only) */ description: string; /** Whether return inspection is enabled or not */ enabled?: boolean | null; } export interface ReturnInspectionModify { /** Return inspection description (custom reasons only) */ description?: string | null; /** Whether return inspection is enabled or not */ enabled?: boolean | null; } export interface ReturnLineItem { /** Fulfillment id */ fulfillment_id: string; inspections: Array; /** Line item id */ line_item_id: string; /** Unique return reason identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ reason: ReturnReasonType; /** Amount of items to return */ return_quantity: number; variant?: { id: string; } | ProductVariant | null; } export interface ReturnLineItemCreate { /** Fulfillment id */ fulfillment_id: string; /** Line item id */ line_item_id: string; /** Unique return reason identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ reason: ReturnReasonType; /** Amount of items to return */ return_quantity: number; /** A unique product variant identifier */ variant_id: string; } export interface ReturnLineItemInspection { checked: boolean; inspection?: { id: string; } | ReturnInspection | null; } export interface ReturnPage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export interface ReturnPolicy { conditions: Array; /** Currency code used for all prices defined in the policy */ currency: string; /** Whether this return policy is enabled or not */ enabled: boolean; /** Unique return policy identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; inspection_ids: Array; /** Name of the return policy */ name: string; /** Priority of the policy (policy with higher priority is to be evaluated first) */ priority: number; /** What kind of refund method is allowed */ refund_option: ReturnPolicyRefundOption; shipping_options: Array; } export declare type ReturnPolicyAddressType = "custom" | "inventory_location" | "origin"; export interface ReturnPolicyCondition { /** Amount of money in shop's currency */ amount?: number; category?: { id: string; } | Category | null; country?: { id: string; } | InfoCountry | null; customer_group?: { id: string; } | CustomerGroup | null; operator: RuleOperator; /** Index of the parent condition in this array */ parent_index?: number; product?: { id: string; } | Product | null; /** Quantity parameter */ quantity?: number; shipping_provider?: { id: string; } | ShippingProvider | null; /** Type of the condition */ type: PromotionConditionType; variant?: { id: string; } | ProductVariant | null; } export interface ReturnPolicyConditionCreate { /** Amount of money in shop's currency */ amount?: number | null; /** Category id, used depending on condition type */ category_id?: string | null; /** Negated condition, used for 'not' type */ condition?: any; /** Set of conditions to apply boolean operator to, used for 'and' and 'or' */ conditions?: Array | null; /** Country code */ country?: string | null; /** Customer group id, used depending on condition type */ customer_group_id?: string | null; operator?: RuleOperator; /** Product id, used depending on condition type */ product_id?: string | null; /** Quantity parameter */ quantity?: number | null; /** Shipping provider id, used depending on condition type */ shipping_provider_id?: string | null; /** Type of the condition */ type: PromotionConditionType; /** Variant id, used depending on condition type */ variant_id?: string | null; } export interface ReturnPolicyCreate { condition?: ReturnPolicyConditionCreate | null; /** Currency code used for all prices defined in the policy */ currency?: string | null; /** Whether this return policy is enabled or not */ enabled?: boolean | null; inspection_ids?: Array | null; /** Name of the return policy */ name: string; /** Priority of the policy (policy with higher priority is to be evaluated first) */ priority?: number | null; /** What kind of refund method is allowed */ refund_option?: ReturnPolicyRefundOption | null; shipping_options?: Array | null; } export interface ReturnPolicyModify { condition?: ReturnPolicyConditionCreate | null; /** Currency code used for all prices defined in the policy */ currency?: string | null; /** Whether this return policy is enabled or not */ enabled?: boolean | null; inspection_ids?: Array | null; /** Name of the return policy */ name?: string | null; /** Priority of the policy (policy with higher priority is to be evaluated first) */ priority?: number | null; /** What kind of refund method is allowed */ refund_option?: ReturnPolicyRefundOption | null; shipping_options?: Array | null; } export declare type ReturnPolicyRefundOption = "both" | "customer_balance" | "original_payment_method"; export declare type ReturnPolicyReturnFee = "cost_of_label" | "fixed_amount" | "free" | "percentage"; export interface ReturnPolicyShippingOption { /** Address this return option refers to, if "address_type" is "custom". */ address: Address | null; /** What address customers will use for returns */ address_type: ReturnPolicyAddressType; /** Inventory location this return option refers to, if "address_type" is "inventory_location". */ inventory_location?: { id: string; } | InventoryLocation | null; /** Whether to refund shipping charge or not */ refund_shipping_charge: boolean; /** Whether to restock items to inventory or not */ restock_items_to_inventory: boolean; /** Return approval policy */ return_approval: ReturnApproval; return_fee: ReturnPolicyReturnFee; return_fee_value: number; /** Whether to generate label or not */ reverse_logistics: ReverseLogistics; /** Description for a custom reverse logistics option */ reverse_logistics_desc: string; /** Name for a custom reverse logistics option */ reverse_logistics_name: string; /** The name of the shipping company */ tracking_company: string; } export interface ReturnPolicyShippingOptionCreate { /** Return shipping address */ address?: AddressCreate | null; /** What address customers will use for returns */ address_type?: ReturnPolicyAddressType | null; /** Unique inventory location identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ inventory_location_id?: string | null; /** Whether to refund shipping charge or not */ refund_shipping_charge?: boolean | null; /** Whether to restock items to inventory or not */ restock_items_to_inventory?: boolean | null; /** Return approval policy */ return_approval?: ReturnApproval | null; return_fee: ReturnPolicyReturnFee; return_fee_value: number; /** Whether to generate label or not */ reverse_logistics?: ReverseLogistics | null; /** Description for a custom reverse logistics option */ reverse_logistics_desc?: string | null; /** Name for a custom reverse logistics option */ reverse_logistics_name?: string | null; /** The name of the shipping company */ tracking_company?: string | null; } export interface ReturnReason { /** Return reason description (custom reasons only) */ description: string; /** Whether return reason is enabled or not */ enabled: boolean; /** Unique return reason identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: ReturnReasonType; } export interface ReturnReasonCreate { /** Return reason description (custom reasons only) */ description: string; /** Whether return reason is enabled or not */ enabled?: boolean | null; /** Unique return reason identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: ReturnReasonType; } export interface ReturnReasonModify { /** Return reason description (custom reasons only) */ description?: string | null; /** Whether return reason is enabled or not */ enabled?: boolean | null; } export declare type ReturnReasonType = "arrived_damaged" | "arrived_too_late" | "custom_reason_1" | "custom_reason_10" | "custom_reason_11" | "custom_reason_12" | "custom_reason_13" | "custom_reason_14" | "custom_reason_15" | "custom_reason_16" | "custom_reason_17" | "custom_reason_18" | "custom_reason_19" | "custom_reason_2" | "custom_reason_20" | "custom_reason_21" | "custom_reason_22" | "custom_reason_23" | "custom_reason_24" | "custom_reason_25" | "custom_reason_26" | "custom_reason_27" | "custom_reason_28" | "custom_reason_29" | "custom_reason_3" | "custom_reason_30" | "custom_reason_4" | "custom_reason_5" | "custom_reason_6" | "custom_reason_7" | "custom_reason_8" | "custom_reason_9" | "different_from_description" | "found_lower_price" | "item_didnt_fit" | "item_was_defective" | "no_longer_needed" | "not_satisfied_with_quality" | "other_reason" | "wrong_item_received"; export interface ReturnReceive { /** Unique inventory location identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ inventory_location_id: string; } export interface ReturnRefund { /** Refund amount (doesn't include fee and customer balance portion) */ amount: number; /** How much to refund to customer balance */ customer_balance: number; /** Refund fee */ fee: number; } export declare type ReturnState = "approved" | "inspected" | "received" | "refunded" | "rejected" | "request"; export interface ReturnTrackingEvent { /** City of the event (comes from shipping provider) */ city: string; /** Shipping provider-specific code of the event */ code: string; /** Country code of the event (comes from shipping provider) */ country: string; /** Country info if available */ country_info?: { id: string; } | InfoCountry | null; /** The date and time when the event was created (possibly inaccurate) */ created_at: string; /** Free form description of the event */ description: string; /** Whether this event was added during last update or not */ is_new: boolean; /** Province code of the event (comes from shipping provider) */ province: string; /** Province info if available */ province_info?: { id: string; } | InfoProvince | null; /** The date and time when the event was received */ received_at: string; /** Event status */ status: TrackingEventStatus; /** Zip or postal code of the event (comes from shipping provider) */ zip: string; } export declare type ReturnsPageSortBy = "created_at"; export declare type ReverseLogistics = "custom" | "generate_label" | "no_label"; export interface ReviewDimension { /** A unique review dimension identifier */ id: string; /** Name of the review dimension */ name: string; } export interface ReviewDimensionCreate { /** Name of the review dimension */ name: string; } export interface ReviewDimensionModify { /** Name of the review dimension */ name?: string | null; } export interface ReviewDimensionSet { /** A unique review dimension set identifier */ id: string; /** Name of the review dimension set */ name: string; /** Overall review dimension */ overall_review_dimension?: { id: string; } | ReviewDimension | null; /** Review dimensions from this set */ review_dimensions: Array<{ id: string; } | ReviewDimension | null>; /** Additional questions for the review */ survey_questions: Array<{ id: string; } | SurveyQuestion | null>; } export interface ReviewDimensionSetCreate { /** Name of the review dimension set */ name: string; /** A unique review dimension identifier */ overall_review_dimension_id?: string | null; review_dimension_ids: Array; survey_question_ids?: Array | null; } export interface ReviewDimensionSetModify { /** Name of the review dimension set */ name?: string | null; /** A unique review dimension identifier */ overall_review_dimension_id?: string | null; review_dimension_ids?: Array | null; survey_question_ids?: Array | null; } export interface ReviewSettings { /** If certain words are acceptable by your audience, you can override them using this parameter */ acceptable_word_list: Array; /** Automatically approve reviews */ approve_reviews: boolean; /** Approve reviews only above certain score threshold */ approve_threshold: number; /** Additional list of bad words (we also have internal undisclosed list of words we filter against) */ bad_word_list: Array; /** Whether to send an email asking customer for a product review */ customer_reminder: CustomerReviewReminder; /** When "customer_reminder" is "custom", this is the number of days to wait before sending an email */ customer_reminder_days: number; /** Default review dimension set */ default_review_dimension_set?: { id: string; } | ReviewDimensionSet | null; /** Filter text for explicit content */ filter_content: boolean; } export interface ReviewSettingsCreate { /** If certain words are acceptable by your audience, you can override them using this parameter */ acceptable_word_list?: Array | null; /** Automatically approve reviews */ approve_reviews?: boolean | null; /** Approve reviews only above certain score threshold */ approve_threshold?: number | null; /** Additional list of bad words (we also have internal undisclosed list of words we filter against) */ bad_word_list?: Array | null; /** Whether to send an email asking customer for a product review */ customer_reminder?: CustomerReviewReminder | null; /** When "customer_reminder" is "custom", this is the number of days to wait before sending an email */ customer_reminder_days?: number | null; /** Default review dimension set unique identifier */ default_review_dimension_set_id?: string | null; /** Filter text for explicit content */ filter_content?: boolean | null; } export declare type RiskLevel = "high" | "low" | "medium"; export interface Role { /** The date and time when the role was created, RFC 3339 format */ created_at: string; /** Unique role identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** The name of the role */ name: string; /** A set of permission bits describing this role */ permissions: Array; /** The date and time when the role was last updated, RFC 3339 format */ updated_at: string; } export interface RoleCreate { /** The name of the role */ name?: string | null; /** A set of permission bits describing this role */ permissions?: Array | null; } export interface RoleModify { /** The name of the role */ name?: string | null; /** A set of permission bits describing this role */ permissions?: Array | null; } export declare type RuleOperator = "eq" | "ge" | "gt" | "le" | "lt" | "ne" | "un"; export interface ScheduledFulfillment { /** Whether to notify customer about fulfillment creation or not */ email: boolean; /** Unique scheduled fulfillment identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Array of line items associated with the fulfillment */ line_items: Array; /** Human-friendly description of the scheduled fulfillment */ name: string; /** Destination pickup inventory location */ pickup_inventory_location?: { id: string; } | InventoryLocation | null; /** Date and time this fulfillment is scheduled for */ scheduled_at: string; /** Type of the shipping provider (use "fixed" as "other") */ shipping_provider_type: ShippingProviderType; /** Subscription associated with this scheduled fulfillment */ subscription?: { id: string; } | Subscription | null; /** The name of the shipping company */ tracking_company: string; /** Shipping number, provided by the shipping company */ tracking_number: string; /** The URLs to track the fulfillment */ tracking_url: string; } export interface ScheduledFulfillmentCreate { /** Whether to notify customer about fulfillment creation or not */ email?: boolean | null; /** Array of line items associated with the fulfillment */ line_items: Array; /** Human-friendly description of the scheduled fulfillment */ name?: string | null; /** Destination pickup inventory location */ pickup_inventory_location_id?: string | null; /** Date and time this fulfillment is scheduled for */ scheduled_at?: string | null; /** Type of the shipping provider */ shipping_provider_type?: ShippingProviderType | null; /** Subscription associated with this scheduled fulfillment */ subscription_id?: string | null; /** The name of the shipping company */ tracking_company?: string | null; /** Shipping number, provided by the shipping company */ tracking_number?: string | null; /** The URLs to track the fulfillment */ tracking_url?: string | null; } export interface ScheduledFulfillmentLineItem { /** Unique inventory location identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ inventory_location_id: string; /** Unique line item identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ line_item_id: string; /** Amount of items that is scheduled for future fulfillment */ quantity: number; /** Inventory location where this line item was reserved at (if that's the case) */ reserved_inventory_location?: { id: string; } | InventoryLocation | null; /** Unique variant identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ variant_id: string; } export interface ScheduledFulfillmentLineItemCreate { /** Unique inventory location identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ inventory_location_id: string; /** Unique line item identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ line_item_id: string; /** Amount of items that will be shipped with this fulfillment */ quantity: number; /** A unique product variant identifier */ variant_id: string; } export interface ScheduledFulfillmentModify { /** Whether to notify customer about fulfillment creation or not */ email?: boolean | null; /** Array of line items associated with the fulfillment */ line_items?: Array | null; /** Human-friendly description of the scheduled fulfillment */ name?: string | null; /** Destination pickup inventory location */ pickup_inventory_location_id?: string | null; /** Date and time this fulfillment is scheduled for */ scheduled_at?: string | null; /** Type of the shipping provider */ shipping_provider_type?: ShippingProviderType | null; /** Subscription associated with this scheduled fulfillment */ subscription_id?: string | null; /** The name of the shipping company */ tracking_company?: string | null; /** Shipping number, provided by the shipping company */ tracking_number?: string | null; /** The URLs to track the fulfillment */ tracking_url?: string | null; } export interface ScheduledFulfillmentReserve { line_items: Array; } export interface ScheduledFulfillmentReserveLineItemCreate { /** Unique inventory location identifier (destination) */ dest_inventory_location_id: string; /** Unique line item identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ line_item_id: string; /** A unique product variant identifier */ variant_id?: string | null; } export declare type SearchBrandsSortBy = "created_at" | "title" | "updated_at"; export declare type SearchCategoriesSortBy = "created_at" | "title" | "updated_at"; export declare type SearchContentBlocksSortBy = "created_at" | "title" | "updated_at"; export declare type SearchCustomerInventorySortBy = "created_at"; export declare type SearchCustomersSortBy = "created_at" | "email" | "last_order" | "name" | "order_count" | "total_spent" | "updated_at"; export declare type SearchFilesSortBy = "created_at" | "mime" | "name" | "size"; export declare type SearchOp = "and" | "eq" | "ge" | "gt" | "le" | "lt" | "ne" | "not" | "or"; export interface SearchOption { /** Value of the option (if boolean) */ boolean?: boolean | null; /** Override nesting level context (when automatic logic gives undesired results) */ context?: string | null; /** Name of the option */ name?: string | null; /** Value is nil */ nil?: boolean | null; /** Value is now (rfc3339 time value, server's idea of now) */ now?: boolean | null; /** Value of the option (if number) */ number?: number | null; /** Combining or comparison operator */ op: SearchOp; /** Index of the parent option (usually "and", "or", "not"), -1 if no parent */ parent_index?: number | null; /** Value of the option (if text) */ text?: string | null; /** Value is number zero */ zero?: boolean | null; } export declare type SearchOrdersSortBy = "canceled_at" | "closed_at" | "created_at" | "customer" | "financial_status" | "fulfillment_status" | "number" | "paid_at" | "total_price" | "updated_at"; export declare type SearchProductsSortBy = "brand" | "created_at" | "max_inventory_count" | "min_inventory_count" | "min_price" | "published_at" | "rating" | "sales" | "sum_inventory_count" | "title" | "updated_at" | "visits"; export declare type SearchPromotionsSortBy = "created_at" | "currency" | "ends_at" | "starts_at" | "times_used"; export declare type SearchPurchaseOrdersSortBy = "created_at" | "expected_at" | "from_supplier" | "number" | "status" | "to_inventory_location" | "updated_at"; export declare type SearchQuestionsSortBy = "created_at" | "customer" | "product" | "rating" | "updated_at"; export declare type SearchReviewsSortBy = "average_score" | "created_at" | "customer" | "product" | "rating" | "title" | "updated_at"; export declare type SearchSubscriptionsSortBy = "created_at"; export declare type SearchSuppliersSortBy = "created_at" | "name"; export declare type SearchTransfersSortBy = "created_at" | "expected_at" | "from_inventory_location" | "number" | "status" | "to_inventory_location" | "updated_at"; export declare type SearchVariantsSortBy = "available" | "bin_location" | "committed" | "created_at" | "incoming" | "low_stock_level" | "on_hand" | "sku" | "title"; export declare type SentStatus = "error" | "not_attempted" | "successfully_sent" | "trial_limit"; export interface ShardedTask { /** The date and time when the task was created, RFC 3339 format */ created_at: string; /** Description of the task */ description: string; error_spans: Array; /** Token which grants you access to CSV import error report */ error_token: string; errors: Array; /** Unique sharded task identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Additional info about a CSV import task (if the task is one) */ import_info: ShardedTaskCSVImportInfo | null; /** Whether the worker has finished working on a task or not */ is_done: boolean; /** Name of the task */ name: string; progress: ShardedTaskProgress; /** File this task results with (e.g. CSV export tasks) */ result_file?: { id: string; } | File | null; /** Seconds since last update according to server's notion of time */ stale_seconds: number; /** The date and time when the task was last updated, RFC 3339 format */ updated_at: string; } export interface ShardedTaskCSVImportInfo { /** A list of columns that were used during import */ columns: Array; /** Whether import data contains CSV header or not */ header: boolean; /** A file which was used as input for the task */ input_file?: { id: string; } | File | null; /** Name of the model used during import */ model: string; } export interface ShardedTaskError { message: string; meta: string; } export interface ShardedTaskExpandableItems { /** Generic array of expandable items */ items: Array<{ id: string; } | ShardedTask | null>; } export interface ShardedTaskProgress { num_complete: number; num_failed: number; num_total: number; percentage: number; } export interface ShardedTaskSpan { /** upper boundary (inclusive) */ max: number; /** lower boundary (inclusive) */ min: number; } export interface ShippingDetail { /** Discount amount applied to shipping rate */ discount: number; /** Discount rule name selected for shipping rate */ discount_rule_name: string; /** Discount portion of the calculated tax */ discount_tax: number; /** Shipping rate price */ price: number; tax: TaxDetail | null; /** Tax exclusive shipping rate price */ tax_excl_price: number; /** Tax inclusive shipping rate price */ tax_incl_price: number; /** Name of the selected shipping rate */ title: string; } export interface ShippingProvider { auspost_options: AuspostOptions | null; canadapost_options: CanadapostOptions | null; /** The date and time when the shipping provider was created, RFC 3339 format */ created_at: string; /** Currency code */ currency: string; /** Whether delivery date is guaranteed or not (fixed providers) */ delivery_date_guaranteed: boolean | null; /** Maximum days it would take to deliver a package (fixed providers) */ delivery_days_max: number | null; /** Minimum days it would take to deliver a package (fixed providers) */ delivery_days_min: number | null; /** Description text visible to the customer */ description: string; fedex_options: FedexOptions | null; /** Unique identifier for shipping provider */ id: string; /** The maximum amount of time the inventory location will take to fulfill the order using this shipping provider */ lead_time_hours_max: number | null; /** The minimum amount of time the inventory location will take to fulfill the order using this shipping provider */ lead_time_hours_min: number | null; /** Name of the shipping provider */ name: string; /** Shipping rate for fixed providers */ rate: number | null; /** For non-fixed shipping provider types, fixed amount to add on top of the rate */ surcharge_fixed: number; /** For non-fixed shipping provider types, percentage to add on top of the rate */ surcharge_percentage: number; /** Whether shipping provider test mode is enabled */ test: boolean; /** Is it allowed to use this shipping provider for tracking requests? */ tracking: boolean; /** Type of the shipping provider */ type: ShippingProviderType; /** The date and time when the shipping provider was last updated, RFC 3339 format */ updated_at: string; ups_options: UPSOptions | null; usps_options: USPSOptions | null; /** Shipping rate whilelist for non-fixed providers */ whitelist: Array | null; } export interface ShippingProviderCreate { auspost_options?: AuspostOptionsCreate | null; canadapost_options?: CanadapostOptionsCreate | null; /** Currency code for shipping provider to use */ currency?: string | null; /** Whether delivery date is guaranteed or not (fixed providers) */ delivery_date_guaranteed?: boolean | null; /** Maximum days it would take to deliver a package (fixed providers) */ delivery_days_max?: number | null; /** Minimum days it would take to deliver a package (fixed providers) */ delivery_days_min?: number | null; /** Description text visible to the customer */ description?: string | null; fedex_options?: FedexOptionsCreate | null; /** The maximum amount of time the inventory location will take to fulfill the order using this shipping provider */ lead_time_hours_max?: number | null; /** The minimum amount of time the inventory location will take to fulfill the order using this shipping provider */ lead_time_hours_min?: number | null; /** Name of the shipping provider */ name: string; /** Shipping rate for fixed providers */ rate?: number | null; /** For non-fixed shipping provider types, fixed amount to add on top of the rate */ surcharge_fixed?: number | null; /** For non-fixed shipping provider types, percentage to add on top of the rate */ surcharge_percentage?: number | null; /** Whether shipping provider test mode is enabled */ test?: boolean | null; /** Is it allowed to use this shipping provider for tracking requests? */ tracking?: boolean | null; /** Type of the shipping provider */ type: ShippingProviderType; ups_options?: UPSOptionsCreate | null; usps_options?: USPSOptionsCreate | null; /** Shipping rate whilelist for non-fixed providers */ whitelist?: Array | null; } export interface ShippingProviderField { /** Nice name for UI */ label: string; /** Whether the field is mandatory or not */ mandatory: boolean; /** Option name */ name: string; options?: Array | null; /** Is is safe to show a field value (for passwords) */ safe: boolean; /** Whether to put this field onto a service levels pane */ service_levels_pane: boolean; /** Tooltip for UI */ tooltip?: string | null; /** Type of the option, matches HTML somewhat */ type: ShippingProviderFieldType; } export interface ShippingProviderFieldOption { /** Nice name for UI */ label: string; /** Value name */ name: string; } export declare type ShippingProviderFieldType = "checkbox" | "select" | "text"; export interface ShippingProviderModify { auspost_options?: AuspostOptionsCreate | null; canadapost_options?: CanadapostOptionsCreate | null; /** Currency code for shipping provider to use */ currency?: string | null; /** Whether delivery date is guaranteed or not (fixed providers) */ delivery_date_guaranteed?: boolean | null; /** Maximum days it would take to deliver a package (fixed providers) */ delivery_days_max?: number | null; /** Minimum days it would take to deliver a package (fixed providers) */ delivery_days_min?: number | null; /** Description text visible to the customer */ description?: string | null; fedex_options?: FedexOptionsCreate | null; /** The maximum amount of time the inventory location will take to fulfill the order using this shipping provider */ lead_time_hours_max?: number | null; /** The minimum amount of time the inventory location will take to fulfill the order using this shipping provider */ lead_time_hours_min?: number | null; /** Name of the shipping provider */ name?: string | null; /** Shipping rate for fixed providers */ rate?: number | null; /** For non-fixed shipping provider types, fixed amount to add on top of the rate */ surcharge_fixed?: number | null; /** For non-fixed shipping provider types, percentage to add on top of the rate */ surcharge_percentage?: number | null; /** Whether shipping provider test mode is enabled */ test?: boolean | null; /** Is it allowed to use this shipping provider for tracking requests? */ tracking?: boolean | null; /** Type of the shipping provider */ type?: ShippingProviderType | null; ups_options?: UPSOptionsCreate | null; usps_options?: USPSOptionsCreate | null; /** Shipping rate whilelist for non-fixed providers */ whitelist?: Array | null; } export interface ShippingProviderService { /** Unique code for a shipping provider service */ code: string; /** Nice name of the shipping provider service */ name: string; } export interface ShippingProviderTestAddress { /** address1 */ address1?: string; /** address2 */ address2?: string; /** city */ city?: string; /** company */ company?: string; /** country */ country?: string; /** name */ name?: string; /** phone */ phone?: string; /** province */ province?: string; /** zip */ zip?: string; } export interface ShippingProviderTestPackage { height: number; length: number; weight: number; width: number; } export interface ShippingProviderTestRate { amount: number; currency: string; delivery_date_guaranteed: boolean; delivery_date_max: string; delivery_date_min: string; name: string; service: string; } export interface ShippingProviderTestResult { from_address: ShippingProviderTestAddress; packages: Array; rates: Array; to_address: ShippingProviderTestAddress; } export declare type ShippingProviderType = "auspost" | "canadapost" | "fedex" | "fixed" | "pickup" | "ups" | "usps"; export interface ShippingProviderWhitelist { /** Shipping rate service code must match this pattern if it's not empty */ service_code_pattern: string; /** Shipping rate service name must match this pattern if it's not empty */ service_name_pattern: string; } export interface ShippingProviderWhitelistCreate { /** Shipping rate service code must match this pattern if it's not empty */ service_code_pattern?: string | null; /** Shipping rate service name must match this pattern if it's not empty */ service_name_pattern?: string | null; } export interface ShippingRate { /** Whether delivery date is guaranteed or not */ delivery_date_guaranteed: boolean; /** Upper boundary of delivery date */ delivery_date_max: string; /** Lower boundary of delivery date */ delivery_date_min: string; /** Whether shipping rate is discountable or not */ discountable: boolean; /** A unique shipping rate identifier */ id: string; /** The maximum amount of time the inventory location will take to fulfill the order */ lead_time_hours_max: number; /** The minimum amount of time the inventory location will take to fulfill the order */ lead_time_hours_min: number; /** Name of the shipping rate */ name: string; /** Associated inventory location (for pickup shipping providers) */ pickup_inventory_location?: { id: string; } | InventoryLocation | null; /** Rate of the shipping rate (in cents) */ rate: number; /** Shipping provider this shipping rate originates from */ shipping_provider?: { id: string; } | ShippingProvider | null; /** Whether shipping rate is taxable or not */ taxable: boolean; } export interface ShippingRateGroup { items: Array; shipping_rates: Array; } export interface ShippingRateGroupItem { /** Unique line item identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ line_item_id: string; /** Unique line item identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ quantity: number; /** Unique line item identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ variant_id: string; } export declare type ShippingRateGroupPolicy = "default_location" | "most_items" | "multiple_groups" | "shop_address"; export interface ShippingRule { conditions: Array; /** What to do with multiple shipping rate groups */ group_policy: ShippingRateGroupPolicy; /** Unique shipping rule identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Name of the shipping rule */ name: string; /** Priority of the rule (rule with higher priority is to be evaluated first) */ priority: number; zones: Array; } export interface ShippingRuleCondition { /** Whether or not discount can be applied to shipping rate originating from this rule */ discountable: boolean; /** Lower price boundary of this shipping rule condition (inclusive) */ price_from: number | null; /** Upper price boundary of this shipping rule condition (exclusive) */ price_to: number | null; shipping_provider?: { id: string; } | ShippingProvider | null; /** Whether or not this shipping rule is taxable */ taxable: boolean; /** Lower weight boundary of this shipping rule condition (inclusive) */ weight_from: number | null; /** Upper weight boundary of this shipping rule condition (exclusive) */ weight_to: number | null; } export interface ShippingRuleConditionCreate { /** Whether or not discount can be applied to shipping rate originating from this rule */ discountable?: boolean | null; /** Lower price boundary of this shipping rule condition (inclusive) */ price_from?: number | null; /** Upper price boundary of this shipping rule condition (exclusive) */ price_to?: number | null; /** Unique identifier for shipping provider */ shipping_provider_id?: string | null; /** Whether or not this shipping rule is taxable */ taxable?: boolean | null; /** Lower weight boundary of this shipping rule condition (inclusive) */ weight_from?: number | null; /** Upper weight boundary of this shipping rule condition (exclusive) */ weight_to?: number | null; } export interface ShippingRuleCreate { conditions?: Array | null; /** What to do with multiple shipping rate groups */ group_policy?: ShippingRateGroupPolicy | null; /** Name of the shipping rule */ name: string; /** Priority of the rule (rule with higher priority is to be evaluated first) */ priority?: number | null; zones?: Array | null; } export interface ShippingRuleModify { conditions?: Array | null; /** What to do with multiple shipping rate groups */ group_policy?: ShippingRateGroupPolicy | null; /** Name of the shipping rule */ name?: string | null; /** Priority of the rule (rule with higher priority is to be evaluated first) */ priority?: number | null; zones?: Array | null; } export declare type ShippingTaxMethod = "custom" | "highest" | "weighted"; export interface Shop { /** Shop's trunkery.app sub-domain, must be unique */ app_domain: string; /** Class of the user in context of a given shop */ class: UserClass | null; /** The date and time when the shop was created, RFC 3339 format */ created_at: string; /** Currency code */ currency: string; /** Reason, why shop was deleted */ delete_reason: ShopDeleteReason | null; /** The date and time when the shop was deleted, RFC 3339 format */ deleted_at: string | null; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Owner of the shop */ owner?: { id: string; } | User | null; /** User's permission bits in this shop */ permissions: Array | null; /** Persistent shop's trunkery.app sub-domain, never changes, used for CNAME DNS configuration */ persistent_app_domain: string; /** Selected primary domain or app_domain by default */ primary_domain?: { id: string; } | Domain | null; /** Whether shop is in test mode or not */ test: boolean; /** The date and time when the shop was last updated, RFC 3339 format */ updated_at: string; } export interface ShopCreate { /** Shop's trunkery.app sub-domain, must be unique */ app_domain?: string | null; /** Currency code */ currency?: string | null; language?: string | null; /** Name of the shop */ name: string; /** Email for shop notifications */ notification_email?: string | null; /** Unique identifier for the subscription plan a customer is on */ plan_id?: string | null; /** Address of the shop */ shop_address: AddressCreate; /** Whether shop is in test mode or not */ test?: boolean | null; } export declare type ShopDeleteReason = "fraud" | "policy_violation" | "subscription_payment" | "subscription_trial" | "user" | "user_not_enough_money" | "user_something_else" | "user_too_expensive" | "user_too_hard" | "user_went_competitor"; export declare type ShopDeleteReasonParam = "fraud" | "policy_violation" | "subscription_payment" | "subscription_trial" | "user" | "user_not_enough_money" | "user_something_else" | "user_too_expensive" | "user_too_hard" | "user_went_competitor"; export declare type ShopIndustry = "accessories" | "antiques" | "appliances" | "art_and_craft_supplies" | "art_gallery" | "auto_parts" | "baby_products" | "beauty_and_cosmetics" | "bikes" | "books" | "bridal" | "candy" | "clothing" | "computers" | "dont_know_yet" | "fabric" | "flowers" | "food" | "fragrances" | "groceries" | "hardware_and_tools" | "health_store_and_supplements" | "home_furnishings" | "jewelry" | "lingerie" | "medical_supplies" | "music" | "musical_instruments" | "nonprofit_and_charity" | "office_supplies" | "other" | "outdoor_gear" | "personal_care" | "pet_supplies" | "pharmacy" | "shoes" | "software" | "sporting_and_gym_goods" | "supermarkets" | "toys" | "video_games" | "videos" | "wine_and_alcohol_and_liquor"; export interface ShopModify { /** Shop's trunkery.app sub-domain, must be unique */ app_domain?: string | null; /** Unique domain identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ primary_domain_id?: string | null; } export declare type ShopPreviousService = "big_commerce" | "ibm_websphere_commerce" | "magento" | "none" | "other_free" | "other_paid" | "presta_shop" | "salesforce_commerce_cloud" | "shopify" | "squarespace" | "volusion" | "woo_commerce"; export declare type ShopRevenue = "dont_know_yet" | "from_100000_to_400000" | "from_10000_to_30000" | "from_30000_to_50000" | "from_400000_to_700000" | "from_50000_to_80000" | "from_700000_to_1000000" | "from_80000_to_100000" | "gt_1000000" | "lt_10000" | "zero"; export interface ShopSettings { achievements: Achievements; /** Whether to verify shipping addresses on paid orders */ address_verification: boolean; /** Whether to automatically apply shipping address verification result to shipping address */ address_verification_auto: boolean; /** Automatically close completed orders (fulfilled/paid) */ auto_close: boolean; /** Automatically fulfill digital items of captured orders */ auto_fulfill: boolean; /** Whether subscriptions should automatically reserve scheduled fulfillments or not */ auto_reserve_subscription: boolean; /** Billing address of the shop */ billing_address: Address; /** Whether to keep prices consistent across borders (only relevant for tax inclusive prices) */ consistent_prices: boolean; /** The date and time when the shop was created, RFC 3339 format */ created_at: string; /** Additional text to add to a shop billing invoice */ custom_invoice_text: string; /** Whether customer is allowed to pause subscriptions */ customer_can_pause_subscription: boolean; /** Whether customer is allowed to skip subscription ticks */ customer_can_skip_subscription: boolean; /** OAuth2 providers for customer auth */ customer_oauth_providers: Array; /** Shop's customer service email address */ customer_service_email: string; /** Default payment method */ default_payment_method?: { id: string; } | PaymentMethod | null; /** Default tax rule */ default_tax_rule?: { id: string; } | TaxRule | null; /** Whether discount price follows tax_inclusive_prices option or is always tax exclusive */ discount_price: DiscountPrice; features: ShopSettingsFeatures; /** Whether gift cards are enabled or not (not available on Micro) */ gift_card_enabled: boolean; /** If not null, created gift cards will expire after given amount of seconds */ gift_card_expiration_seconds: number | null; /** Implicit languages shop works with (e.g. if shop contians en-AU, en becomes an implicit language) */ implicit_languages: Array<{ id: string; } | InfoLanguage | null>; /** Whether shop was created indirectly for a client */ indirect: boolean; /** Industry this shop belongs to */ industry: ShopIndustry; /** Default invoice due date days to add when sending invoice */ invoice_due_date_days: number; /** Primary language of the shop */ language?: { id: string; } | InfoLanguage | null; /** Languages shop works with (you can override many text fields with language-specific variants) */ languages: Array<{ id: string; } | InfoLanguage | null>; /** Name of the shop */ name: string; /** Email for shop notifications */ notification_email: string; notifications: ShopSettingsNotifications; /** When order is on hold, customer can cancel the order and shop owner cannot fulfill the order */ on_hold_order_window_minutes: number; /** Automatically cancel orders with risk score higher than this number (if non-null) */ order_risk_cancel_threshold: number | null; /** Notify shop owner about orders with risk score higher than this number (if non-null) */ order_risk_warning_threshold: number | null; /** Password used for shop password protection (cannot be disabled while in trial period) */ password: string | null; /** Message displayed on a "password" page when password protection is on */ password_message: string | null; /** Shop's previous service prior to registeration */ previous_service: ShopPreviousService; /** Whether product reviews are enabled or not (not available on Micro) */ product_review_enabled: boolean; /** The date and time when shop was last reindexed */ reindexed_at: string | null; /** Search reindexing status */ reindexing_status: ReindexingStatus; /** Revenue of the shop prior to registeration */ revenue: ShopRevenue; /** When customer abandons an order, notify him after that period of time */ send_abandoned_email_after_seconds: number; /** Minimum order price to send abandoned order email for */ send_abandoned_email_min_price: number; /** Tax class used for tax selection when 'shipping_tax_method' is 'custom' */ shipping_tax_class: string | null; /** Method that is used to calculate shipping tax */ shipping_tax_method: ShippingTaxMethod; /** Address of the shop */ shop_address: Address; /** Starting number for orders */ start_number: number; subscription: ShopSettingsSubscription; /** Custom retry schedule in days if subscription fails, use default if empty */ subscription_retries_schedule: Array; /** Custom retry schedule in hours if daily subscription fails, use default if empty */ subscription_retries_schedule_daily: Array; /** Whether subtotal includes tax or not (only affects display, not the API's "subtotal") */ subtotal_includes_tax: boolean; /** When to round the calculated tax */ sum_tax_after: SumTaxAfter; /** Tax calculation should be based on */ tax_based_on: TaxBasedOn; /** True if prices are tax inclusive, false if exclusive */ tax_inclusive_prices: boolean; /** How the tax line is displayed. E.g. "Tax" or "Sale Tax" */ tax_label: string; /** Name of the time zone the shop is in */ timezone: string; /** True if shop is in trial period */ trial: boolean; } export interface ShopSettingsCreate { /** Whether to verify shipping addresses on paid orders */ address_verification?: boolean | null; /** Whether to automatically apply shipping address verification result to shipping address */ address_verification_auto?: boolean | null; /** Automatically close completed orders (fulfilled/paid) */ auto_close?: boolean | null; /** Automatically fulfill digital items of captured orders */ auto_fulfill?: boolean | null; /** Whether subscriptions should automatically reserve scheduled fulfillments or not */ auto_reserve_subscription?: boolean | null; /** Billing address of the shop */ billing_address?: AddressCreate | null; /** Whether to keep prices consistent across borders (only relevant for tax inclusive prices) */ consistent_prices?: boolean | null; /** Additional text to add to a shop billing invoice */ custom_invoice_text?: string | null; /** Whether customer is allowed to pause subscriptions */ customer_can_pause_subscription?: boolean | null; /** Whether customer is allowed to skip subscription ticks */ customer_can_skip_subscription?: boolean | null; /** OAuth2 providers for customer auth */ customer_oauth_providers?: Array | null; /** Shop's customer service email address */ customer_service_email?: string | null; /** Unique payment method identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ default_payment_method_id?: string | null; /** Unique tax rule identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ default_tax_rule_id?: string | null; /** Whether discount price follows tax_inclusive_prices option or is always tax exclusive */ discount_price?: DiscountPrice | null; /** Whether gift cards are enabled or not (not available on Micro) */ gift_card_enabled?: boolean | null; /** If not null, created gift cards will expire after given amount of seconds */ gift_card_expiration_seconds?: number | null; /** Whether shop was created indirectly for a client */ indirect?: boolean | null; /** Industry this shop belongs to */ industry?: ShopIndustry | null; /** Default invoice due date days to add when sending invoice */ invoice_due_date_days?: number | null; language?: string | null; /** Languages shop works with (you can override many text fields with language-specific variants) */ languages?: Array | null; /** Name of the shop */ name?: string | null; /** Email for shop notifications */ notification_email?: string | null; notifications?: ShopSettingsNotificationsCreate | null; /** When order is on hold, customer can cancel the order and shop owner cannot fulfill the order */ on_hold_order_window_minutes?: number | null; /** Automatically cancel orders with risk score higher than this number (if non-null) */ order_risk_cancel_threshold?: number | null; /** Notify shop owner about orders with risk score higher than this number (if non-null) */ order_risk_warning_threshold?: number | null; /** Password used for shop password protection (cannot be disabled while in trial period) */ password?: string | null; /** Message displayed on a "password" page when password protection is on */ password_message?: string | null; /** Shop's previous service prior to registeration */ previous_service?: ShopPreviousService | null; /** Whether product reviews are enabled or not (not available on Micro) */ product_review_enabled?: boolean | null; /** Revenue of the shop prior to registeration */ revenue?: ShopRevenue | null; /** When customer abandons an order, notify him after that period of time */ send_abandoned_email_after_seconds?: number | null; /** Minimum order price to send abandoned order email for */ send_abandoned_email_min_price?: number | null; /** Tax class used for tax selection when 'shipping_tax_method' is 'custom' */ shipping_tax_class?: string | null; /** Method that is used to calculate shipping tax */ shipping_tax_method?: ShippingTaxMethod | null; /** Address of the shop */ shop_address?: AddressCreate | null; /** Starting number for orders */ start_number?: number | null; /** Custom retry schedule in days if subscription fails, use default if empty */ subscription_retries_schedule?: Array | null; /** Custom retry schedule in hours if daily subscription fails, use default if empty */ subscription_retries_schedule_daily?: Array | null; /** Whether subtotal includes tax or not (only affects display, not the API's "subtotal") */ subtotal_includes_tax?: boolean | null; /** When to round the calculated tax */ sum_tax_after?: SumTaxAfter | null; /** Tax calculation should be based on */ tax_based_on?: TaxBasedOn | null; /** True if prices are tax inclusive, false if exclusive */ tax_inclusive_prices?: boolean | null; /** How the tax line is displayed. E.g. "Tax" or "Sale Tax" */ tax_label?: string | null; /** Name of the time zone the shop is in */ timezone?: string | null; /** Timezone hint. When provided it overrides timezone field, but only if it's correct. If it's incorrect, the value is ignored. */ timezone_hint?: string | null; } export interface ShopSettingsFeatures { /** Whether "analytics" feature is enabled or not */ analytics: boolean; /** Whether "analytics_items_cache" feature is enabled or not */ analytics_items_cache: boolean; /** Whether "avalara" feature is enabled or not */ avalara: boolean; /** Whether "gateways" feature is enabled or not */ gateways: boolean; /** Whether "quickbooks" feature is enabled or not */ quickbooks: boolean; /** Whether "taxjar" feature is enabled or not */ taxjar: boolean; /** Whether "xero" feature is enabled or not */ xero: boolean; } export interface ShopSettingsNotifications { /** Whether to send "auth_order_notification" email notifications or not */ auth_order_notification: boolean; /** Whether to send "email_abandoned_checkout" email notifications or not */ email_abandoned_checkout: boolean; /** Whether to send "email_customer_inventory_notification" email notifications or not */ email_customer_inventory_notification: boolean; /** Whether to send "email_order_canceled" email notifications or not */ email_order_canceled: boolean; /** Whether to send "email_order_confirmation" email notifications or not */ email_order_confirmation: boolean; /** Whether to send "email_product_review_reminder" email notifications or not */ email_product_review_reminder: boolean; /** Whether to send "email_refund_notification" email notifications or not */ email_refund_notification: boolean; /** Whether to send "email_return_approved" email notifications or not */ email_return_approved: boolean; /** Whether to send "email_return_created" email notifications or not */ email_return_created: boolean; /** Whether to send "email_return_rejected" email notifications or not */ email_return_rejected: boolean; /** Whether to send "email_shipping_confirmation_digital_good" email notifications or not */ email_shipping_confirmation_digital_good: boolean; /** Whether to send "email_shipping_confirmation_gift_card" email notifications or not */ email_shipping_confirmation_gift_card: boolean; /** Whether to send "email_shipping_confirmation_physical" email notifications or not */ email_shipping_confirmation_physical: boolean; /** Whether to send "email_shipping_update" email notifications or not */ email_shipping_update: boolean; /** Whether to send "email_tracking_attempt_fail" email notifications or not */ email_tracking_attempt_fail: boolean; /** Whether to send "email_tracking_available_for_pickup" email notifications or not */ email_tracking_available_for_pickup: boolean; /** Whether to send "email_tracking_delivered" email notifications or not */ email_tracking_delivered: boolean; /** Whether to send "email_tracking_exception" email notifications or not */ email_tracking_exception: boolean; /** Whether to send "email_tracking_in_transit" email notifications or not */ email_tracking_in_transit: boolean; /** Whether to send "email_tracking_info_received" email notifications or not */ email_tracking_info_received: boolean; /** Whether to send "email_tracking_out_for_delivery" email notifications or not */ email_tracking_out_for_delivery: boolean; /** Whether to send "email_tracking_unknown" email notifications or not */ email_tracking_unknown: boolean; /** Whether to send "new_order_notification" email notifications or not */ new_order_notification: boolean; /** Whether to send "new_return_notification" email notifications or not */ new_return_notification: boolean; /** Whether to send "purchase_order" email notifications or not */ purchase_order: boolean; /** Whether to send "sms_fulfillment_created" email notifications or not */ sms_fulfillment_created: boolean; /** Whether to send "sms_tracking_attempt_fail" email notifications or not */ sms_tracking_attempt_fail: boolean; /** Whether to send "sms_tracking_available_for_pickup" email notifications or not */ sms_tracking_available_for_pickup: boolean; /** Whether to send "sms_tracking_delivered" email notifications or not */ sms_tracking_delivered: boolean; /** Whether to send "sms_tracking_out_for_delivery" email notifications or not */ sms_tracking_out_for_delivery: boolean; /** Whether to send "sms_tracking_unknown" email notifications or not */ sms_tracking_unknown: boolean; /** Whether to send "variant_low_stock" email notifications or not */ variant_low_stock: boolean; } export interface ShopSettingsNotificationsCreate { /** Whether to send "auth_order_notification" email notifications or not */ auth_order_notification?: boolean | null; /** Whether to send "email_abandoned_checkout" email notifications or not */ email_abandoned_checkout?: boolean | null; /** Whether to send "email_customer_inventory_notification" email notifications or not */ email_customer_inventory_notification?: boolean | null; /** Whether to send "email_order_canceled" email notifications or not */ email_order_canceled?: boolean | null; /** Whether to send "email_order_confirmation" email notifications or not */ email_order_confirmation?: boolean | null; /** Whether to send "email_product_review_reminder" email notifications or not */ email_product_review_reminder?: boolean | null; /** Whether to send "email_refund_notification" email notifications or not */ email_refund_notification?: boolean | null; /** Whether to send "email_return_approved" email notifications or not */ email_return_approved?: boolean | null; /** Whether to send "email_return_created" email notifications or not */ email_return_created?: boolean | null; /** Whether to send "email_return_rejected" email notifications or not */ email_return_rejected?: boolean | null; /** Whether to send "email_shipping_confirmation_digital_good" email notifications or not */ email_shipping_confirmation_digital_good?: boolean | null; /** Whether to send "email_shipping_confirmation_gift_card" email notifications or not */ email_shipping_confirmation_gift_card?: boolean | null; /** Whether to send "email_shipping_confirmation_physical" email notifications or not */ email_shipping_confirmation_physical?: boolean | null; /** Whether to send "email_shipping_update" email notifications or not */ email_shipping_update?: boolean | null; /** Whether to send "email_tracking_attempt_fail" email notifications or not */ email_tracking_attempt_fail?: boolean | null; /** Whether to send "email_tracking_available_for_pickup" email notifications or not */ email_tracking_available_for_pickup?: boolean | null; /** Whether to send "email_tracking_delivered" email notifications or not */ email_tracking_delivered?: boolean | null; /** Whether to send "email_tracking_exception" email notifications or not */ email_tracking_exception?: boolean | null; /** Whether to send "email_tracking_in_transit" email notifications or not */ email_tracking_in_transit?: boolean | null; /** Whether to send "email_tracking_info_received" email notifications or not */ email_tracking_info_received?: boolean | null; /** Whether to send "email_tracking_out_for_delivery" email notifications or not */ email_tracking_out_for_delivery?: boolean | null; /** Whether to send "email_tracking_unknown" email notifications or not */ email_tracking_unknown?: boolean | null; /** Whether to send "new_order_notification" email notifications or not */ new_order_notification?: boolean | null; /** Whether to send "new_return_notification" email notifications or not */ new_return_notification?: boolean | null; /** Whether to send "purchase_order" email notifications or not */ purchase_order?: boolean | null; /** Whether to send "sms_fulfillment_created" email notifications or not */ sms_fulfillment_created?: boolean | null; /** Whether to send "sms_tracking_attempt_fail" email notifications or not */ sms_tracking_attempt_fail?: boolean | null; /** Whether to send "sms_tracking_available_for_pickup" email notifications or not */ sms_tracking_available_for_pickup?: boolean | null; /** Whether to send "sms_tracking_delivered" email notifications or not */ sms_tracking_delivered?: boolean | null; /** Whether to send "sms_tracking_out_for_delivery" email notifications or not */ sms_tracking_out_for_delivery?: boolean | null; /** Whether to send "sms_tracking_unknown" email notifications or not */ sms_tracking_unknown?: boolean | null; /** Whether to send "variant_low_stock" email notifications or not */ variant_low_stock?: boolean | null; } export interface ShopSettingsSubscription { /** Is client-side user action required */ action_required: boolean; /** Upper boundary for collected fee items payment, defines when charge is forced */ billing_threshold: number; /** Total amount of fee payments collected for next invoice */ fee_amount: number; /** The timestamp for last acknowledged metered item in an invoice */ last_fee_invoice_date: string | null; /** The date and time when plan period ends */ period_end: string | null; /** The date and time when plan period started */ period_start: string | null; /** Unique identifier for the subscription plan a customer is on */ plan_id: string; /** True if shop is in trial period */ trial: boolean; /** The date and time when usage plan period ends */ usage_period_end: string | null; /** The date and time when usage plan period started */ usage_period_start: string | null; } export interface ShopShort { class: UserClass | null; /** Reason, why shop was deleted */ delete_reason: ShopDeleteReason | null; /** The date and time when the shop was deleted, RFC 3339 format */ deleted_at: string | null; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Name of the shop */ name: string; /** User's permission bits in this shop */ permissions: Array | null; /** Whether shop is in test mode or not */ test: boolean | null; } export interface ShopShortPage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export interface SmsMessageSummary { /** Number of messages sent to this country */ count: number; /** The two-letter code for the country */ country: string; /** Price per message in USD cents */ price_per_message: number; } export declare type StorefrontCustomerVote = "not_voted" | "voted_no" | "voted_yes"; export interface Subscription { /** Which billing address to use */ billing_address: SubscriptionParam; /** Custom billing address identifier */ billing_address_id: string; /** The date and time when the subscription was created */ created_at: string; /** Custom billing address for subscription */ custom_billing_address: Address | null; /** Custom shipping address for subscription */ custom_shipping_address: Address | null; /** Customer this subscription belongs to */ customer?: { id: string; } | Customer | null; /** Error state of the subscription */ error: SubscriptionError; /** How many errors happened as a result of retry attempts */ error_count: number; /** Additional information about last error in unspecified format */ error_meta: Array; /** Unique subscription identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Last order this subscription created */ last_order?: { id: string; } | Order | null; /** When this subscription is due to update */ next_at: string; /** Seconds offset from "next_at" to accommodate for the business logic. Negative for pre-paid subscriptions, because scheduled fulfillment is created ahead of time. Positive for subscriptions in error state, this is a retry logic. */ next_offset: number; /** Order this subscription originates from */ origin_order?: { id: string; } | Order | null; /** Which payment source to use */ payment_source: SubscriptionParam; /** Custom shipping address identifier */ payment_source_id: string; /** The order awaiting payment confirmation when state is "pending_payment" */ pending_order?: { id: string; } | Order | null; /** The number of items customer subscribed to */ quantity: number; /** Which shipping address to use */ shipping_address: SubscriptionParam; /** Custom shipping address identifier */ shipping_address_id: string; /** State of the subscription */ state: SubscriptionState; /** A subscription plan customer picked for this subscription */ subscription_plan: SubscriptionPlan; /** How many successful ticks (billing and fulfillment events) happened for this subscription */ tick_count: number; /** Product variant the customer subscribed to */ variant?: { id: string; } | ProductVariant | null; } export interface SubscriptionEdit { /** Which billing address to use */ billing_address?: SubscriptionParam | null; /** Custom billing address identifier */ billing_address_id?: string | null; /** Custom billing address for subscription */ custom_billing_address?: AddressCreate | null; /** Custom shipping address for subscription */ custom_shipping_address?: AddressCreate | null; /** Which payment source to use */ payment_source?: SubscriptionParam | null; /** Custom shipping address identifier */ payment_source_id?: string | null; /** Which shipping address to use */ shipping_address?: SubscriptionParam | null; /** Custom shipping address identifier */ shipping_address_id?: string | null; } export declare type SubscriptionError = "currency_not_allowed" | "gateway_not_supported" | "invalid_product_quantity" | "invalid_shop_destination" | "no_inventory" | "ok" | "out_of_stock" | "product_banned" | "realtime_shipping_rates_failure" | "saved_card_not_found" | "shop_misconfigured" | "transaction_error" | "unrecognized_error"; export interface SubscriptionExpandableItems { /** Generic array of expandable items */ items: Array<{ id: string; } | Subscription | null>; } export interface SubscriptionPage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export declare type SubscriptionParam = "custom" | "default" | "origin_order"; export interface SubscriptionPlan { /** Specifies how annual and monthly subscriptions should be aligned */ align_day_of_month: OptionalInt | null; /** Specifies how weekly subscriptions should be aligned */ align_day_of_week: OptionalInt | null; /** Specifies how annual, monthly and daily subscriptions should be aligned */ align_hour: OptionalInt | null; /** Specifies how annual subscriptions should be aligned */ align_month: OptionalInt | null; /** Billing interval count */ billing_interval_count: number; /** Whether it's possible to apply a discount to a product (given that subscription is used) */ discountable: boolean; /** Fulfillment interval count */ fulfillment_interval_count: number; /** Interval for subscription plan */ interval: SubscriptionPlanInterval; /** A maxiumum amount of billing cycles */ limit: number; /** First purchase price value */ price1: number; /** First purchase price percentage value */ price1_percentage: number; /** First purchase price type */ price1_type: SubscriptionPlanPriceType; /** Non-first purchases price value */ price2: number; /** Non-first purchases price percentage value */ price2_percentage: number; /** Non-first purchases price type */ price2_type: SubscriptionPlanPriceType; } export interface SubscriptionPlanCreate { /** Specifies how annual and monthly subscriptions should be aligned */ align_day_of_month?: OptionalIntCreate | null; /** Specifies how weekly subscriptions should be aligned */ align_day_of_week?: OptionalIntCreate | null; /** Specifies how annual, monthly and daily subscriptions should be aligned */ align_hour?: OptionalIntCreate | null; /** Specifies how annual subscriptions should be aligned */ align_month?: OptionalIntCreate | null; /** Billing interval count */ billing_interval_count: number; /** Whether it's possible to apply a discount to a product (given that subscription is used) */ discountable?: boolean | null; /** Fulfillment interval count */ fulfillment_interval_count: number; /** Interval for subscription plan */ interval: SubscriptionPlanInterval; /** A maxiumum amount of billing cycles */ limit?: number | null; /** First purchase price value */ price1?: number | null; /** First purchase price percentage value */ price1_percentage?: number | null; /** First purchase price type */ price1_type: SubscriptionPlanPriceType; /** Non-first purchases price value */ price2?: number | null; /** Non-first purchases price percentage value */ price2_percentage?: number | null; /** Non-first purchases price type */ price2_type: SubscriptionPlanPriceType; } export interface SubscriptionPlanIndex { value: number; } export declare type SubscriptionPlanInterval = "annually" | "daily" | "monthly" | "weekly"; export declare type SubscriptionPlanPriceType = "fixed_off" | "percentage_off" | "price"; export interface SubscriptionSearchResult { /** Total number of items in the collection */ count: number; items: Array<{ id: string; } | Subscription | null>; } export declare type SubscriptionState = "active" | "canceled" | "done" | "error" | "failed" | "past_due" | "paused" | "pending" | "pending_payment" | "skip_next"; export declare type SubscriptionsPageSortBy = "created_at"; export declare type SumTaxAfter = "jurisdiction" | "line_item" | "order"; export interface Supplier { /** Address of the supplier */ address: Address; /** Date and time supplier was created */ created_at: string; /** Default supplier currency */ currency: string; /** Email of the supplier */ email: string; /** Unique supplier identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Name of the supplier */ name: string; /** Supplier home page */ url: string; } export interface SupplierCreate { /** Address of the supplier */ address: AddressCreate; /** Default supplier currency */ currency?: string | null; /** Email of the supplier */ email?: string | null; /** Name of the supplier */ name: string; /** Supplier home page */ url?: string | null; } export interface SupplierExpandableItems { /** Generic array of expandable items */ items: Array<{ id: string; } | Supplier | null>; } export interface SupplierModify { /** Address of the supplier */ address?: AddressCreate | null; /** Default supplier currency */ currency?: string | null; /** Email of the supplier */ email?: string | null; /** Name of the supplier */ name?: string | null; /** Supplier home page */ url?: string | null; } export interface SupplierPage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export interface SupplierSearchResult { /** Total number of items in the collection */ count: number; items: Array<{ id: string; } | Supplier | null>; } export declare type SuppliersPageSortBy = "created_at"; export interface SupportArticle { /** Image files referenced by "raw_content". */ content_image_files: Array<{ id: string; } | File | null>; /** The date and time when support article was created, RFC 3339 format */ created_at: string; /** A unique support article identifier */ id: string; /** Article rating from 0 to 100 */ rating: number; revisions: Array; /** The date and time when support article was last updated, RFC 3339 format */ updated_at: string; /** Was your vote positive or negative */ vote: boolean; /** Whether you voted or not */ voted: boolean; } export interface SupportArticleExpandableItems { /** Generic array of expandable items */ items: Array<{ id: string; } | SupportArticle | null>; } export declare type SupportArticleFilterType = "any" | "draft" | "internal" | "public"; export interface SupportArticlePage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export interface SupportArticleRevision { /** The date and time when support article revision was created, RFC 3339 format */ created_at: string; /** Whether support article is internal or not */ internal: boolean; keywords: Array; /** 2-letter language code */ language: string; /** Meta description for SEO purposes */ meta_description: string; /** SEO-friendly title of the content block */ meta_title: string; /** Whether server thinks support article is published or not (depends on server time) */ published: boolean; /** The date and time when support article was published or null */ published_at: string | null; /** Raw content of the support article */ raw_content: string; /** Articles related to this article */ related_articles: Array<{ id: string; } | SupportArticle | null>; /** Topic of this revision */ support_topic?: { id: string; } | SupportTopic | null; /** Title of the support article */ title: string; /** The date and time when support article revision was last bumped, RFC 3339 format */ used_at: string; /** Author of this revision */ user?: { id: string; } | User | null; } export declare type SupportArticlesPageSortBy = "created_at" | "updated_at"; export interface SupportTopic { /** The date and time when support topic was created, RFC 3339 format */ created_at: string; /** A unique support topic identifier */ id: string; /** Support topic title */ title: string; /** The date and time when support topic was last updated, RFC 3339 format */ updated_at: string; } export interface SurveyQuestion { /** A set of possible survey question answers (for predefined kind) */ answers: Array; /** Unique survey question identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** A kind of a survey question */ kind: SurveyQuestionKind; /** Metadata of the option */ meta: string; /** The survey question itself */ name: string; } export interface SurveyQuestionCreate { answers?: Array | null; /** A kind of a survey question */ kind: SurveyQuestionKind; /** Metadata of the option */ meta?: string | null; /** The survey question itself */ name: string; } export declare type SurveyQuestionKind = "arbitrary" | "predefined"; export interface SurveyQuestionModify { answers?: Array | null; /** A kind of a survey question */ kind?: SurveyQuestionKind | null; /** Metadata of the option */ meta?: string | null; /** The survey question itself */ name?: string | null; } export interface Task { /** The date and time when the task was created, RFC 3339 format */ created_at: string; /** A unique task identifier */ id: string; /** Whether the worker has finished working on a task or not */ is_done: boolean; /** Total amount of lines submitted */ lines: number; /** Amount of lines successfully processed */ lines_complete: number; /** Approximate rate of processing (in lines per second) */ lines_per_second: number; /** Amount of lines skipped */ lines_skipped: number; /** Messages of the task */ messages: Array; /** Name of the result */ result_name: string | null; /** Signed download URL for tasks with results (export tasks) */ signed_url: string | null; /** Type of the task */ type: TaskType; /** The date and time when the task was last updated, RFC 3339 format */ updated_at: string; } export interface TaskCreate { /** Total amount of lines submitted */ lines: number; /** Path where the resulting file is stored */ path?: string | null; /** Name of the result */ result_name?: string | null; /** Type of the task */ type: TaskType; } export interface TaskMessage { /** The date and time when the task message was created, RFC 3339 format */ created_at: string; /** Message text */ message: string; /** Type of the message */ type: TaskMessageType; } export interface TaskMessageCreate { /** Message text */ message?: string | null; /** Type of the message */ type: TaskMessageType; } export declare type TaskMessageType = "error" | "info" | "warning"; export interface TaskModify { /** Increment total amount of lines to work on */ add_lines?: number | null; /** Increment amount of lines successfully processed */ add_lines_complete?: number | null; /** Increment amount of lines skipped */ add_lines_skipped?: number | null; /** Add messages to the task */ add_messages?: Array | null; /** Automatically mark task as done when it reaches "lines" count */ auto_done?: boolean | null; /** Whether the worker has finished working on a task or not */ is_done?: boolean | null; /** Total amount of lines submitted */ lines?: number | null; /** Amount of lines successfully processed */ lines_complete?: number | null; /** Amount of lines skipped */ lines_skipped?: number | null; /** Path where the resulting file is stored */ path?: string | null; /** Name of the result */ result_name?: string | null; } export declare type TaskType = "analytics_customers_csv_export" | "analytics_orders_csv_export" | "analytics_products_csv_export" | "analytics_tax_report_csv_export" | "analytics_variants_csv_export" | "audit_log_csv_export" | "audit_log_json_export" | "customer_csv_export" | "customer_csv_import" | "customer_inventory_export" | "inventory_rule_csv_export" | "inventory_rule_csv_import" | "order_csv_export" | "product_csv_export" | "product_csv_import" | "shipping_rule_csv_export" | "shipping_rule_csv_import" | "supplier_csv_export" | "supplier_csv_import" | "tax_rule_csv_export" | "tax_rule_csv_import" | "variant_inventory_csv_export" | "variant_inventory_csv_import"; export declare type TaskTypeParam = "analytics_customers_csv_export" | "analytics_orders_csv_export" | "analytics_products_csv_export" | "analytics_tax_report_csv_export" | "analytics_variants_csv_export" | "audit_log_csv_export" | "audit_log_json_export" | "customer_csv_export" | "customer_csv_import" | "customer_inventory_export" | "inventory_rule_csv_export" | "inventory_rule_csv_import" | "order_csv_export" | "product_csv_export" | "product_csv_import" | "shipping_rule_csv_export" | "shipping_rule_csv_import" | "supplier_csv_export" | "supplier_csv_import" | "tax_rule_csv_export" | "tax_rule_csv_import" | "variant_inventory_csv_export" | "variant_inventory_csv_import"; export declare type TaxBasedOn = "billing_address" | "customer_billing_address" | "customer_shipping_address" | "customer_shipping_or_billing_address" | "shipping_origin_address" | "shop_address"; export interface TaxDetail { /** Amount of city jurisdiction tax applied */ city_tax: number; /** Whether city tax rate is compound */ city_tax_is_compound: boolean; /** City jurisdiction tax name from matching tax rule */ city_tax_name: string; /** City tax rate (in percents) */ city_tax_rate: number; /** The two-letter code for the country */ country: string; /** Amount of country jurisdiction tax applied */ country_tax: number; /** Country jurisdiction tax name from matching tax rule */ country_tax_name: string; /** Country tax rate (in percents) */ country_tax_rate: number; /** Amount of county jurisdiction tax applied */ county_tax: number; /** Whether county tax rate is compound */ county_tax_is_compound: boolean; /** County jurisdiction tax name from matching tax rule */ county_tax_name: string; /** County tax rate (in percents) */ county_tax_rate: number; /** Name of the matching tax rule */ name: string; /** The two-letter code for the province or state */ province: string; /** Amount of province jurisdiction tax applied */ province_tax: number; /** Whether province tax rate is compound */ province_tax_is_compound: boolean; /** Province jurisdiction tax name from matching tax rule */ province_tax_name: string; /** Province tax rate (in percents) */ province_tax_rate: number; /** Shipping tax class used */ shipping_tax_class: string; /** Method that is used to calculate shipping tax */ shipping_tax_method: ShippingTaxMethod | null; /** Amount of special jurisdiction tax applied */ special_tax: number; /** Whether special tax rate is compound */ special_tax_is_compound: boolean; /** Special jurisdiction tax name from matching tax rule */ special_tax_name: string; /** Special tax rate (in percents) */ special_tax_rate: number; /** Tax rounding error remainder */ tax_rounding: number; } export interface TaxRule { conditions: Array; /** Unique tax rule identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Name of the tax rule */ name: string; /** Priority of the rule (rule with higher priority is to be evaluated first) */ priority: number; zones: Array; } export interface TaxRuleCondition { /** Whether this tax rate is compound or not */ compound: boolean; /** Customer group to match against */ customer_group?: { id: string; } | CustomerGroup | null; /** Name of the tax rate */ name: string | null; /** Tax rate (in percents) */ rate: number | null; /** Tax jurisdiction slot to apply this tax rate to */ slot: JurisdictionSlot | null; /** Tax class to trigger this rule on */ tax_class: string | null; } export interface TaxRuleConditionCreate { /** Whether this tax rate is compound or not */ compound?: boolean | null; /** Unique customer group identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ customer_group_id?: string | null; /** Name of the tax rate */ name?: string | null; /** Tax rate (in percents) */ rate?: number | null; /** Tax jurisdiction slot to apply this tax rate to */ slot?: JurisdictionSlot | null; /** Tax class to trigger this rule on */ tax_class?: string | null; } export interface TaxRuleCreate { conditions?: Array | null; /** Name of the tax rule */ name: string; /** Priority of the rule (rule with higher priority is to be evaluated first) */ priority?: number | null; zones?: Array | null; } export interface TaxRuleModify { conditions?: Array | null; /** Name of the tax rule */ name?: string | null; /** Priority of the rule (rule with higher priority is to be evaluated first) */ priority?: number | null; zones?: Array | null; } export interface TaxSystem { /** Whether to commit tax system transaction */ commit: boolean; /** Company code (Avalara) */ company_code: string; /** Default tax code to use for products */ default_product_tax_code: string; /** Default tax code to use for shipping */ default_shipping_tax_code: string; /** Tax system type */ type: string | null; } export interface TaxSystemCreate { /** Whether to commit tax system transaction */ commit?: boolean | null; /** Company code (Avalara) */ company_code?: string | null; credentials?: Array | null; /** Default tax code to use for products */ default_product_tax_code?: string | null; /** Default tax code to use for shipping */ default_shipping_tax_code?: string | null; /** Tax system type */ type: string; } export declare type TaxTypeApplicable = "TaxOnAmount" | "TaxOnAmountPlusTax" | "TaxOnTax"; export interface TestEmail { created_at: string; from_email: string; from_name: string; html: string; id: string; subject: string; to_email: string; to_name: string; } export interface TestEmailPage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export interface TestSms { created_at: string; id: string; phone: string; sender: string; text: string; } export interface TestSmsPage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export interface TieredPricing { /** Tiered pricing model */ model: TieredPricingModel; /** Price tiers */ tiers: Array; } export interface TieredPricingCreate { /** Tiered pricing model */ model: TieredPricingModel; /** Price tiers */ tiers: Array; } export declare type TieredPricingMode = "all_variants" | "per_variant"; export declare type TieredPricingModel = "graduated" | "volume"; export interface TieredPricingTier { /** Lower quantity boundary (inclusive), -1 if undefined */ from: number; /** Price per unit for this tier */ price: number; /** Upper quantity boundary (inclusive), -1 if undefined */ to: number; } export interface TieredPricingTierCreate { /** Lower quantity boundary (inclusive), -1 if undefined */ from: number; /** Price per unit for this tier */ price: number; /** Upper quantity boundary (inclusive), -1 if undefined */ to: number; } export interface Token { /** JWT */ token: string; } export interface TokenAndUserID { /** JWT */ token: string; /** Set to true when two factor auth is enabled, "token" will be empty */ two_factor_enabled: boolean; /** Unique user identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ user_id: string; } export declare type TrackingEventStatus = "attempt_fail" | "available_for_pickup" | "delivered" | "exception" | "in_transit" | "info_received" | "out_for_delivery" | "unknown"; export interface Transfer { /** Date and time item was added to inventory */ created_at: string; /** User who created this transfer */ created_by?: { id: string; } | User | null; /** Whether transfer is in a draft state or not */ draft: boolean; /** Date and time when transfer arrival is expected */ expected_at: string; /** Inventory location to transfer item from */ from_inventory_location?: { id: string; } | InventoryLocation | null; /** Unique transfer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; line_items: Array; /** Transfer sequential number */ number: number; /** Arbitrary reference string */ reference: string; /** Status of the transfer */ status: TransferStatus; /** Inventory location to transfer item to */ to_inventory_location?: { id: string; } | InventoryLocation | null; /** Date and time when the order was last modified */ updated_at: string; } export declare type TransferCategory = "any" | "closed" | "not_received" | "partially_received" | "past_due" | "received"; export interface TransferCreate { /** Whether transfer is in a draft state or not */ draft?: boolean | null; /** Date and time when transfer arrival is expected */ expected_at?: string | null; /** Unique inventory location id (source) */ from_inventory_location_id?: string | null; line_items?: Array | null; /** Arbitrary reference string */ reference?: string | null; /** Unique inventory location id (destination) */ to_inventory_location_id?: string | null; } export interface TransferExpandableItems { /** Generic array of expandable items */ items: Array<{ id: string; } | Transfer | null>; } export interface TransferLineItem { /** Amount of items to transfer */ quantity: number; /** Amount of items received */ received: number; /** Amount of items rejected */ rejected: number; /** Product variant of this line item */ variant?: { id: string; } | ProductVariant | null; } export interface TransferLineItemCreate { /** Amount of items to transfer */ quantity: number; /** A unique product variant identifier */ variant_id: string; } export interface TransferLog { items: Array; } export interface TransferLogItem { /** Date and time transfer log entry was created */ created_at: string; line_items: Array; reason: string; /** Type of the log entry */ type: TransferLogType; /** User responsible for the action */ user?: { id: string; } | User | null; } export interface TransferLogLineItem { quantity: number; variant_id: string; } export declare type TransferLogType = "closed" | "created" | "opened" | "received" | "rejected" | "undrafted"; export interface TransferModify { /** Whether transfer is in a draft state or not */ draft?: boolean | null; /** Date and time when transfer arrival is expected */ expected_at?: string | null; /** Unique inventory location id (source) */ from_inventory_location_id?: string | null; line_items?: Array | null; /** Arbitrary reference string */ reference?: string | null; /** Unique inventory location id (destination) */ to_inventory_location_id?: string | null; } export interface TransferPage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export interface TransferReceive { line_items?: Array | null; /** Mark all items as received */ receive_all?: boolean | null; } export interface TransferReject { line_items?: Array | null; /** What happened to items? */ reason?: string | null; /** Mark all items as rejected */ reject_all?: boolean | null; } export interface TransferSearchResult { /** Total number of items in the collection */ count: number; items: Array<{ id: string; } | Transfer | null>; } export declare type TransferStatus = "closed" | "not_received" | "partially_received" | "received"; export declare type TransfersPageSortBy = "created_at"; export interface TwoFactor { /** TOTP URL for 2FA */ url: string; } export interface TwoFactorConfig { /** Call the phone with a voice message instead of using SMS messages */ call?: boolean | null; /** Country code if using local phone number */ country?: string | null; /** Use this phone number for two factor auth */ phone?: string | null; } export interface UIPreference { key: string; value: string; } export interface UIPreferenceCreate { key: string; value: string; } export interface UPSOptions { access_license_number: string; account_number: string; imperial: boolean; negotiated_rates: boolean; password: string; pickup_type: string; user_id: string; } export interface UPSOptionsCreate { access_license_number: string; account_number: string; imperial: boolean; negotiated_rates: boolean; password: string; pickup_type: string; user_id: string; } export interface USPSOptions { container: string; service: string; user_id: string; } export interface USPSOptionsCreate { container: string; service: string; user_id: string; } export interface UnifiedSearchResult { brands: Array<{ id: string; } | Brand | null>; categories: Array<{ id: string; } | Category | null>; content_blocks: Array<{ id: string; } | ContentBlock | null>; customer_inventory: Array<{ id: string; } | CustomerInventory | null>; customers: Array<{ id: string; } | Customer | null>; files: Array<{ id: string; } | File | null>; orders: Array<{ id: string; } | Order | null>; products: Array<{ id: string; } | Product | null>; promotions: Array<{ id: string; } | Promotion | null>; purchase_orders: Array<{ id: string; } | PurchaseOrder | null>; questions: Array<{ id: string; } | ProductQuestion | null>; reviews: Array<{ id: string; } | ProductReview | null>; scores: Array; subscriptions: Array<{ id: string; } | Subscription | null>; suppliers: Array<{ id: string; } | Supplier | null>; transfers: Array<{ id: string; } | Transfer | null>; } export interface UnifiedSearchResultScore { id: string; score: number; } export interface UnpackedItem { line_item_id: string; quantity: number; variant_id: string; } export interface UsageStat { /** Number of items used */ count: number; /** Kind of the item */ kind: string; /** Number of free items for this kind */ num_free_items: number; /** Price per item in USD cents */ price_per_item: number; } export interface User { /** Raw content with user's bio */ bio_raw_content: string; /** Class of the user in context of a given shop */ class?: UserClass; /** The date and time when the user was created, RFC 3339 format */ created_at: string; /** Default shop identifier */ default_shop_id: string | null; /** Display name of the user (customers will see it) */ display_name: string; /** Email of the user */ email: string; /** Whether email was confirmed or not */ email_confirmed: boolean; /** Confirmation email for this user */ email_message?: { id: string; } | Message | null; /** Unique identifier for a user */ id: string; /** Inferred locale of the user, free-form string in Accept-Language HTTP header format */ inferred_locale: string; /** Whether user was invited or not (available only after initial POST request) */ invited?: boolean; /** Preferred language of the user */ language?: { id: string; } | InfoLanguage | null; /** The date and time when the user last logged in, RFC 3339 format */ logged_in_at: string; /** Name of the user */ name: string; /** OAuth2 provider used for registering this account */ oauth_provider?: OAuth2Provider; /** Whether user has password defined */ password_defined: boolean; /** A set of permission bits in context of a given shop */ permissions?: Array; /** Which profile image should be used */ profile_image: ProfileImage; /** Preferred color for auto profile image */ profile_image_color: number; /** A set of roles in context of a given shop */ roles?: Array<{ id: string; } | Role | null>; /** Whether user is suspended in context of a given shop */ suspended?: boolean; /** Name of the time zone the user is in */ timezone: string; /** Valid auth token (available only after initial POST request) */ token?: string; /** The date and time when the user agreed to TOS, RFC 3339 format */ tos_agreed: string; /** Whether two factor auth is enabled or not */ two_factor_enabled: boolean; /** The date and time when the user was last updated, RFC 3339 format */ updated_at: string; user_file: UserFile | null; } export declare type UserClass = "admin" | "user"; export interface UserCreate { /** Raw content with user's bio */ bio_raw_content?: string | null; /** Display name of the user (customers will see it) */ display_name?: string | null; /** Email of the user */ email?: string | null; language?: string | null; /** Name of the user */ name?: string | null; /** OAuth2 authorization code provided by the provider */ oauth_code?: string | null; /** OAuth2 provider used for registering this account */ oauth_provider?: OAuth2Provider | null; /** The user's password */ password?: string | null; /** Name of the time zone the user is in */ timezone?: string | null; /** Timezone hint. When provided it overrides timezone field, but only if it's correct. If it's incorrect, the value is ignored. */ timezone_hint?: string | null; /** It has to be set to true and signifies that you agree with Trunkery TOS */ tos_agree: boolean; } export interface UserFile { /** CRC32 checksum of the original file */ crc32: number; /** The date and time when the file was created, RFC 3339 format */ created_at: string; /** Alt title of the image */ image_alt: string; /** Average color of the image */ image_color: string; /** Base64 miniature of the image suitable for inline rendering (webp file format) */ image_fallback: string; /** Height of the image if file is an image */ image_height: number; /** Width of the image if file is an image */ image_width: number; /** MD5 hash of the original file */ md5: string; /** MIME type of the file */ mime: string; /** Human-friendly name of the file */ name: string; /** Internal storage path of the file */ path: string; /** Publically available CDN URL of a file */ public_url: string; /** Size of the file in bytes */ size: number; /** Unique user identifier this file belongs to */ user_id: string; } export interface UserFileCreate { /** Base64 encoded file or image */ base64?: string | null; /** Override default content type of the file */ content_type?: string | null; /** Alt title of the image */ image_alt?: string | null; /** Filename, will be used to construct a unique file path */ name?: string | null; /** Text if the file is a plain text file */ text?: string | null; /** An URL to download file or image from */ url?: string | null; } export interface UserLogin { /** Email of the user */ email?: string | null; /** Your device fingerprint (internal, temporary, used for debug purposes) */ fingerprint?: string | null; /** OAuth2 authorization code provided by the provider */ oauth_code?: string | null; /** OAuth2 provider used for registering this account */ oauth_provider?: OAuth2Provider | null; /** The user's password */ password?: string | null; /** Timezone hint. Used as a hint when implicitly creating the user. */ timezone_hint?: string | null; /** It has to be set to true and signifies that you agree with Trunkery TOS */ tos_agree?: boolean | null; /** Whether to mark device as trusted upon successful login */ trusted?: boolean | null; /** Two factor auth verification code */ two_factor_code?: string | null; } export interface UserModify { /** Raw content with user's bio */ bio_raw_content?: string | null; /** Default shop identifier */ default_shop_id?: string | null; /** Display name of the user (customers will see it) */ display_name?: string | null; language?: string | null; /** Name of the user */ name?: string | null; /** A set of permission bits in context of a given shop */ permissions?: Array | null; /** Which profile image should be used */ profile_image?: ProfileImage | null; /** Preferred color for auto profile image */ profile_image_color?: number | null; /** A set of roles in context of a given shop */ role_ids?: Array | null; /** Whether user is suspended for a given shop or not */ suspended?: boolean | null; /** Name of the time zone the user is in */ timezone?: string | null; /** It has to be set to true and signifies that you agree with updated Trunkery TOS */ tos_agree?: boolean | null; } export interface UserPasswordReset { /** Email of the user */ email: string; } export interface UserPasswordResetComplete { /** Six-digit code you got via email */ code: string; /** Email of the user */ email: string; /** The user's password */ password: string; } export interface UserPasswordResetVerify { /** Six-digit code you got via email */ code: string; /** Email of the user */ email: string; } export interface VariantCurrencyPrice { /** Currency code to define the price in */ currency: string; /** The minimum advertised price of the product variant */ map_price?: number | null; /** The price of the product variant */ price: number; /** The retail cost of the product variant */ retail_price?: number | null; /** Special price for a product that can be active during a selected period of time */ sale_price?: number | null; tiered_pricing?: TieredPricingCreate | null; } export interface VariantCustomerGroupPrice { /** Unique customer group identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ customer_group_id: string; /** Price specific to given customer group */ price: number; tiered_pricing?: TieredPricingCreate | null; } export interface VariantInventory { /** Total amount of items available for orders to reserve (essentially: on_hand - committed) */ available: number; /** Total amount of items reserved by paid orders */ committed: number; /** Unique variant inventory identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Total amount of incoming items */ incoming: number; locations: Array; /** Total amount of items in the inventory */ on_hand: number; /** Aggregated stock status of all inventory locations */ status: InventoryStockStatusAggregated; /** Product variant this inventory refers to */ variant?: { id: string; } | ProductVariant | null; } export interface VariantInventoryCreate { /** Amount of items to add to inventory (can be negative to subtract items) */ add?: number | null; /** Physical location of the inventory item in a shops warehouse */ bin_location?: string | null; /** Whether to enable or disable this variant inventory cell */ enabled?: boolean | null; /** Unique inventory location identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ inventory_location_id: string; /** Low stock level (if non-zero, when to notify shop owner about low stock level) */ low_stock_level?: number | null; /** Amount of items to set inventory to */ set?: number | null; } export interface VariantInventoryLocation { /** Amount of items available for orders to reserve (essentially: on_hand - committed) */ available: number; /** Physical location of the inventory item in a shops warehouse */ bin_location: string; /** Amount of items reserved by paid orders */ committed: number; /** Incoming items */ incoming: number; /** The inventory location */ inventory_location?: { id: string; } | InventoryLocation | null; /** Low stock level (if non-zero, when to notify shop owner about low stock level) */ low_stock_level: number; /** Amount of items in the inventory */ on_hand: number; /** Stock status of this inventory location */ status: InventoryStockStatus; } export interface VariantInventoryLog { /** Link argument #1 for nice string formatting */ arg1: string; /** Link argument #2 for nice string formatting */ arg2: string; /** Value of the "committed", after difference was applied */ committed: number; /** Difference applied to "committed" */ committed_diff: number; /** Date and time inventory log entry was created */ created_at: string; /** Customer responsible for the action */ customer?: { id: string; } | Customer | null; /** Value of the "incoming", after difference was applied */ incoming: number; /** Difference applied to "incoming" */ incoming_diff: number; /** Subject inventory location */ inventory_location?: { id: string; } | InventoryLocation | null; /** Value of the "on_hand", after difference was applied */ on_hand: number; /** Difference applied to "on_hand" */ on_hand_diff: number; /** Inventory log entry type */ type: InventoryLogType; /** User responsible for the action */ user?: { id: string; } | User | null; } export interface VariantInventoryLogPage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export declare type VariantInventoryLogPageSortBy = "created_at"; export interface VariantOption { /** A unique human-readable option identifier */ option_id: string; /** A human-readable name of the option if available */ option_name: string; /** A unique human-readable option value identifier */ option_value_id: string; /** A human-readable name of the option value if available */ option_value_name: string; } export interface VariantOptionCreate { /** A unique human-readable option identifier */ option_id: string; /** A unique human-readable option value identifier */ option_value_id: string; } export interface VariantSupplier { /** Supplier code */ code: string; /** Cost of the variant */ cost: number; /** Default inventory location for purchase orders */ inventory_location?: { id: string; } | InventoryLocation | null; /** Number of seconds it takes for this variant to arrive */ lead_time: number; /** Default PO quantity for this variant */ quantity: number; /** The supplier */ supplier?: { id: string; } | Supplier | null; } export interface VariantSupplierCreate { /** Supplier code */ code?: string | null; /** Cost of the variant */ cost?: number | null; /** Unique inventory location identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ inventory_location_id?: string | null; /** Number of seconds it takes for this variant to arrive */ lead_time?: number | null; /** Default PO quantity for this variant */ quantity?: number | null; /** Unique supplier identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ supplier_id: string; } export declare type VariantType = "bundle" | "digital_good" | "gift_card" | "physical" | "service"; export declare type VariantTypeFilter = "bundle" | "digital_good" | "gift_card" | "physical" | "service"; export interface Webhook { /** Whether this webhook is enabled or not */ enabled: boolean; /** Unique webhook identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Webhook endpoint URL */ url: string; /** Send only these event types, when empty - send all */ whitelist: Array; } export declare type WebhookAttemptOutcome = "not_attempted" | "success" | "unknown_error" | "unsuccessful_http_request" | "unsuccessful_http_response_code" | "webhook_disabled"; export interface WebhookCreate { /** Whether this webhook is enabled or not */ enabled?: boolean | null; /** Webhook endpoint URL */ url: string; whitelist?: Array | null; } export interface WebhookEvent { /** Date and time when webhook event was created */ created_at: string; /** Event type */ event_type: string; /** Unique webhook event identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ id: string; /** Payload JSON */ payload: string; status: Array; } export interface WebhookEventPage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export interface WebhookEventStatus { /** Number of attempts made for this webhook */ attempt_count: number; /** Date and time when last webhook event send attempt was made */ attempted_at: string; /** Webhook event this status originates from */ event?: { id: string; } | WebhookEvent | null; /** What happened on last attempt */ last_attempt_outcome: WebhookAttemptOutcome; /** Webhook an attempt to send this event is made through */ webhook?: { id: string; } | Webhook | null; } export interface WebhookEventStatusPage { /** Total number of items in the collection */ count: number; items: Array; /** Key of the last item for keyset based iteration */ last_key: string; } export interface WebhookModify { /** Whether this webhook is enabled or not */ enabled?: boolean | null; /** Webhook endpoint URL */ url?: string | null; /** Send only these event types, when empty - send all */ whitelist?: Array | null; } export declare type WeightUnit = "g" | "kg" | "lbs" | "oz"; export interface XeroAccount { /** Unique account identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ account_id: string; /** Account class */ class: string; /** Account code */ code: string; /** Account name */ name: string; /** Whether account can have payments applied to it */ payments: boolean; /** Account type */ type: string; } export declare type XeroInvoiceStatus = "AUTHORISED" | "DRAFT"; export interface XeroLog { /** Date and time when message was added to log */ created_at: string; /** The message */ message: string; } export interface XeroPaymentMap { /** Account code from xero */ account_code: string; /** Account ID from xero */ account_id: string; gateway?: { id: string; } | Gateway | null; } export interface XeroPaymentMapCreate { /** Account code from xero */ account_code?: string | null; /** Account ID from xero */ account_id?: string | null; /** Unique gateway identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ gateway_id?: string | null; } export interface XeroSettings { /** Whether Xero integration is active or not */ connected: boolean; /** Customer balance account code */ customer_balance_account_code: string; /** Create daily summary invoices instead of an invoice per order */ daily_summary: boolean; /** Daily summary prefix to use when creating an order number */ daily_summary_prefix: string; /** Discount account code */ discount_account_code: string; /** Whether syncing is enabled or not */ enabled: boolean; /** Create xero invoices in this status */ invoice_status: XeroInvoiceStatus; /** Xero organization name if connected */ organization_name: string; payment_map: Array; /** Refund adjustment account code */ refund_adjustment_account_code: string; /** Rounding account code */ rounding_account_code: string; /** Sales account code */ sales_account_code: string; /** Salexs tax account code */ sales_tax_account_code: string; /** Shipping account code */ shipping_account_code: string; /** Date and time when customers were last synced */ synced_customers_at: string; /** Date and time when orders were last synced */ synced_orders_at: string; /** Date and time when products were last synced */ synced_products_at: string; tax_map: Array; /** Use single customer instead of exported ones (disables customer syncing as well) */ use_single_customer: boolean; } export interface XeroSettingsCreate { /** Customer balance account code */ customer_balance_account_code?: string | null; /** Create daily summary invoices instead of an invoice per order */ daily_summary?: boolean | null; /** Daily summary prefix to use when creating an order number */ daily_summary_prefix?: string | null; /** Discount account code */ discount_account_code?: string | null; /** Whether syncing is enabled or not */ enabled?: boolean | null; /** Create xero invoices in this status */ invoice_status?: XeroInvoiceStatus | null; payment_map?: Array | null; /** Refund adjustment account code */ refund_adjustment_account_code?: string | null; /** Rounding account code */ rounding_account_code?: string | null; /** Sales account code */ sales_account_code?: string | null; /** Salexs tax account code */ sales_tax_account_code?: string | null; /** Shipping account code */ shipping_account_code?: string | null; /** Date and time when customers were last synced */ synced_customers_at?: string | null; /** Date and time when orders were last synced */ synced_orders_at?: string | null; /** Date and time when products were last synced */ synced_products_at?: string | null; tax_map?: Array | null; /** Use single customer instead of exported ones (disables customer syncing as well) */ use_single_customer?: boolean | null; } export interface XeroTaxMap { /** Tax rate name from trunkery tax rules */ tax_rate_name: string; /** Tax type from xero */ tax_type: string; } export interface XeroTaxMapCreate { /** Tax rate name from trunkery tax rules */ tax_rate_name: string; /** Tax type from xero */ tax_type: string; } export interface XeroTaxRate { components: Array; /** Name of the tax rate */ name: string; /** Effective tax rate */ rate: number; /** Xero tax type */ tax_type: string; } export interface XeroTaxRateComponent { /** Whether component is compound or not */ compound: boolean; /** Name of the component */ name: string; /** Tax rate of the component */ rate: number; } export declare type ZipCodeType = "military" | "po_box" | "regular" | "unique"; export interface Zone { country?: { id: string; } | InfoCountry | null; /** Whether to exclude this zone, or otherwise to include */ exclude: boolean | null; province?: { id: string; } | InfoProvince | null; /** The zip or postal code, or a glob pattern for one */ zip_pattern: string | null; } export interface ZoneCreate { /** The ISO 3166-1 alpha-2 two-letter country code for the country */ country?: string | null; /** Whether to exclude this zone, or otherwise to include */ exclude?: boolean | null; /** The standard abbreviation for the state or province */ province?: string | null; /** The zip or postal code, or a glob pattern for one */ zip_pattern?: string | null; } export interface ActivityPageExpansionMap { "items.image_file"?: true | FileExpansionMap; } export interface AddressShortExpansionMap { "country"?: true; "province"?: true; } export interface AuditLogPageExpansionMap { "items.geo_country_info"?: true; "items.geo_region_info"?: true; "items.user"?: true | UserExpansionMap; } export interface BlogExpansionMap { "content_image_files"?: true | FileExpansionMap; "revisions.blog_topic"?: true; "revisions.image_files"?: true | FileExpansionMap; "revisions.user"?: true | UserExpansionMap; } export interface BlogExpandableItemsExpansionMap { "items"?: true | BlogExpansionMap; } export interface BlogPageExpansionMap { "items.content_image_files"?: true | FileExpansionMap; "items.revisions.blog_topic"?: true; "items.revisions.image_files"?: true | FileExpansionMap; "items.revisions.user"?: true | UserExpansionMap; } export interface BrandExpansionMap { "content_image_files"?: true | FileExpansionMap; "custom_field_objects.brands"?: true | BrandExpansionMap; "custom_field_objects.categories"?: true | CategoryExpansionMap; "custom_field_objects.content_blocks"?: true | ContentBlockExpansionMap; "custom_field_objects.files"?: true | FileExpansionMap; "custom_field_objects.products"?: true | ProductExpansionMap; "custom_field_objects.variants"?: true | ProductVariantExpansionMap; "image_files"?: true | FileExpansionMap; } export interface BrandExpandableItemsExpansionMap { "items"?: true | BrandExpansionMap; } export interface BrandPageExpansionMap { "items.content_image_files"?: true | FileExpansionMap; "items.custom_field_objects.brands"?: true | BrandExpansionMap; "items.custom_field_objects.categories"?: true | CategoryExpansionMap; "items.custom_field_objects.content_blocks"?: true | ContentBlockExpansionMap; "items.custom_field_objects.files"?: true | FileExpansionMap; "items.custom_field_objects.products"?: true | ProductExpansionMap; "items.custom_field_objects.variants"?: true | ProductVariantExpansionMap; "items.image_files"?: true | FileExpansionMap; } export interface BrandSearchResultExpansionMap { "items"?: true | BrandExpansionMap; } export interface BrandingExpansionMap { "fields.image_file"?: true | FileExpansionMap; } export interface BuyLinkExpansionMap { "line_items.variant"?: true | ProductVariantExpansionMap; } export interface CategoryExpansionMap { "content_image_files"?: true | FileExpansionMap; "custom_field_objects.brands"?: true | BrandExpansionMap; "custom_field_objects.categories"?: true | CategoryExpansionMap; "custom_field_objects.content_blocks"?: true | ContentBlockExpansionMap; "custom_field_objects.files"?: true | FileExpansionMap; "custom_field_objects.products"?: true | ProductExpansionMap; "custom_field_objects.variants"?: true | ProductVariantExpansionMap; "image_files"?: true | FileExpansionMap; } export interface CategoryExpandableItemsExpansionMap { "items"?: true | CategoryExpansionMap; } export interface CategorySearchResultExpansionMap { "items"?: true | CategoryExpansionMap; } export interface ContentBlockExpansionMap { "content_image_files"?: true | FileExpansionMap; "custom_field_objects.brands"?: true | BrandExpansionMap; "custom_field_objects.categories"?: true | CategoryExpansionMap; "custom_field_objects.content_blocks"?: true | ContentBlockExpansionMap; "custom_field_objects.files"?: true | FileExpansionMap; "custom_field_objects.products"?: true | ProductExpansionMap; "custom_field_objects.variants"?: true | ProductVariantExpansionMap; } export interface ContentBlockExpandableItemsExpansionMap { "items"?: true | ContentBlockExpansionMap; } export interface ContentBlockPageExpansionMap { "items.content_image_files"?: true | FileExpansionMap; "items.custom_field_objects.brands"?: true | BrandExpansionMap; "items.custom_field_objects.categories"?: true | CategoryExpansionMap; "items.custom_field_objects.content_blocks"?: true | ContentBlockExpansionMap; "items.custom_field_objects.files"?: true | FileExpansionMap; "items.custom_field_objects.products"?: true | ProductExpansionMap; "items.custom_field_objects.variants"?: true | ProductVariantExpansionMap; } export interface ContentBlockSearchResultExpansionMap { "items"?: true | ContentBlockExpansionMap; } export interface CustomerExpansionMap { "addresses.country"?: true; "addresses.province"?: true; "customer_group"?: true; "language"?: true; "last_order"?: true | OrderExpansionMap; } export interface CustomerBalanceExpansionMap { "last_order"?: true | OrderExpansionMap; } export interface CustomerExpandableItemsExpansionMap { "items"?: true | CustomerExpansionMap; } export interface CustomerFavoriteExpansionMap { "customer"?: true | CustomerExpansionMap; "variant"?: true | ProductVariantExpansionMap; } export interface CustomerFavoritePageExpansionMap { "items.customer"?: true | CustomerExpansionMap; "items.variant"?: true | ProductVariantExpansionMap; } export interface CustomerInventoryExpansionMap { "customer"?: true | CustomerExpansionMap; "email_message"?: true; "order"?: true | OrderExpansionMap; "variant"?: true | ProductVariantExpansionMap; } export interface CustomerInventoryExpandableItemsExpansionMap { "items"?: true | CustomerInventoryExpansionMap; } export interface CustomerInventoryPageExpansionMap { "items.customer"?: true | CustomerExpansionMap; "items.email_message"?: true; "items.order"?: true | OrderExpansionMap; "items.variant"?: true | ProductVariantExpansionMap; } export interface CustomerInventorySearchResultExpansionMap { "items"?: true | CustomerInventoryExpansionMap; } export interface CustomerPageExpansionMap { "items.addresses.country"?: true; "items.addresses.province"?: true; "items.customer_group"?: true; "items.language"?: true; "items.last_order"?: true | OrderExpansionMap; } export interface CustomerPaymentSourceExpansionMap { "address_country_info"?: true; "address_state_info"?: true; } export interface CustomerSearchResultExpansionMap { "items"?: true | CustomerExpansionMap; } export interface FileExpansionMap { "imported_from_task"?: true; } export interface FileExpandableItemsExpansionMap { "items"?: true | FileExpansionMap; } export interface FilePageExpansionMap { "items.imported_from_task"?: true; } export interface FileSearchResultExpansionMap { "items"?: true | FileExpansionMap; } export interface ForeignShardedTaskExpansionMap { "task"?: true; } export interface InventoryLocationExpansionMap { "address.country"?: true; "address.province"?: true; } export interface InventoryRuleExpansionMap { "conditions.customer_group"?: true; "conditions.inventory_location"?: true | InventoryLocationExpansionMap; "zones.country"?: true; "zones.province"?: true; } export interface InvitationExpansionMap { "roles"?: true; } export interface KeyExpansionMap { "roles"?: true; } export interface MenuExpansionMap { "custom_field_objects.brands"?: true | BrandExpansionMap; "custom_field_objects.categories"?: true | CategoryExpansionMap; "custom_field_objects.content_blocks"?: true | ContentBlockExpansionMap; "custom_field_objects.files"?: true | FileExpansionMap; "custom_field_objects.products"?: true | ProductExpansionMap; "custom_field_objects.variants"?: true | ProductVariantExpansionMap; "items.category"?: true | CategoryExpansionMap; "items.content_block"?: true | ContentBlockExpansionMap; "items.product"?: true | ProductExpansionMap; } export interface MenuPageExpansionMap { "items.custom_field_objects.brands"?: true | BrandExpansionMap; "items.custom_field_objects.categories"?: true | CategoryExpansionMap; "items.custom_field_objects.content_blocks"?: true | ContentBlockExpansionMap; "items.custom_field_objects.files"?: true | FileExpansionMap; "items.custom_field_objects.products"?: true | ProductExpansionMap; "items.custom_field_objects.variants"?: true | ProductVariantExpansionMap; "items.items.category"?: true | CategoryExpansionMap; "items.items.content_block"?: true | ContentBlockExpansionMap; "items.items.product"?: true | ProductExpansionMap; } export interface NoteExpansionMap { "user"?: true | UserExpansionMap; } export interface OrderExpansionMap { "abandoned_email_message"?: true; "billing_address.country"?: true; "billing_address.province"?: true; "billing_address_short"?: true | AddressShortExpansionMap; "coupon"?: true; "customer"?: true | CustomerExpansionMap; "gateway"?: true; "history.cancel.email_message"?: true; "history.customer"?: true | CustomerExpansionMap; "history.fulfillment_created.email_message"?: true; "history.fulfillment_modified.email_message"?: true; "history.manual_refund.email_message"?: true; "history.refund_transaction.email_message"?: true; "history.user"?: true | UserExpansionMap; "history.void_transaction.email_message"?: true; "invoice_email_message"?: true; "line_items.field_set"?: true; "line_items.subscription"?: true | SubscriptionExpansionMap; "line_items.variant"?: true | ProductVariantExpansionMap; "paid_email_message"?: true; "payment_detail.card.country"?: true; "promotion"?: true | PromotionExpansionMap; "review_reminder_email_message"?: true; "risk"?: true; "selected_shipping_rates.pickup_inventory_location"?: true | InventoryLocationExpansionMap; "selected_shipping_rates.shipping_provider"?: true; "shipping_address.country"?: true; "shipping_address.province"?: true; "shipping_address_override.country"?: true; "shipping_address_override.province"?: true; "shipping_address_short"?: true | AddressShortExpansionMap; "shipping_rate_groups.shipping_rates.pickup_inventory_location"?: true | InventoryLocationExpansionMap; "shipping_rate_groups.shipping_rates.shipping_provider"?: true; "subscription"?: true | SubscriptionExpansionMap; "user"?: true | UserExpansionMap; } export interface OrderExpandableItemsExpansionMap { "items"?: true | OrderExpansionMap; } export interface OrderFulfillmentExpansionMap { "line_items.inventory_items"?: true | CustomerInventoryExpansionMap; "pickup_inventory_location"?: true | InventoryLocationExpansionMap; "tracking_events.country_info"?: true; "tracking_events.province_info"?: true; } export interface OrderPageExpansionMap { "items.abandoned_email_message"?: true; "items.billing_address.country"?: true; "items.billing_address.province"?: true; "items.billing_address_short"?: true | AddressShortExpansionMap; "items.coupon"?: true; "items.customer"?: true | CustomerExpansionMap; "items.gateway"?: true; "items.history.cancel.email_message"?: true; "items.history.customer"?: true | CustomerExpansionMap; "items.history.fulfillment_created.email_message"?: true; "items.history.fulfillment_modified.email_message"?: true; "items.history.manual_refund.email_message"?: true; "items.history.refund_transaction.email_message"?: true; "items.history.user"?: true | UserExpansionMap; "items.history.void_transaction.email_message"?: true; "items.invoice_email_message"?: true; "items.line_items.field_set"?: true; "items.line_items.subscription"?: true | SubscriptionExpansionMap; "items.line_items.variant"?: true | ProductVariantExpansionMap; "items.paid_email_message"?: true; "items.payment_detail.card.country"?: true; "items.promotion"?: true | PromotionExpansionMap; "items.review_reminder_email_message"?: true; "items.risk"?: true; "items.selected_shipping_rates.pickup_inventory_location"?: true | InventoryLocationExpansionMap; "items.selected_shipping_rates.shipping_provider"?: true; "items.shipping_address.country"?: true; "items.shipping_address.province"?: true; "items.shipping_address_override.country"?: true; "items.shipping_address_override.province"?: true; "items.shipping_address_short"?: true | AddressShortExpansionMap; "items.shipping_rate_groups.shipping_rates.pickup_inventory_location"?: true | InventoryLocationExpansionMap; "items.shipping_rate_groups.shipping_rates.shipping_provider"?: true; "items.subscription"?: true | SubscriptionExpansionMap; "items.user"?: true | UserExpansionMap; } export interface OrderSearchResultExpansionMap { "items"?: true | OrderExpansionMap; } export interface PackagingExpansionMap { "inventory_locations"?: true | InventoryLocationExpansionMap; "shipping_providers"?: true; } export interface PaymentMethodExpansionMap { "credit_card.address_country_info"?: true; "credit_card.address_state_info"?: true; } export interface ProductExpansionMap { "average_scores.review_dimension"?: true; "brand"?: true | BrandExpansionMap; "categories"?: true | CategoryExpansionMap; "content_image_files"?: true | FileExpansionMap; "custom_field_objects.brands"?: true | BrandExpansionMap; "custom_field_objects.categories"?: true | CategoryExpansionMap; "custom_field_objects.content_blocks"?: true | ContentBlockExpansionMap; "custom_field_objects.files"?: true | FileExpansionMap; "custom_field_objects.products"?: true | ProductExpansionMap; "custom_field_objects.variants"?: true | ProductVariantExpansionMap; "field_set"?: true; "min_customer_group_prices.customer_group"?: true; "review_dimension_set"?: true | ReviewDimensionSetExpansionMap; "survey_answers_summary.survey_question"?: true; "variants"?: true | ProductVariantExpansionMap; } export interface ProductExpandableItemsExpansionMap { "items"?: true | ProductExpansionMap; } export interface ProductPageExpansionMap { "items.average_scores.review_dimension"?: true; "items.brand"?: true | BrandExpansionMap; "items.categories"?: true | CategoryExpansionMap; "items.content_image_files"?: true | FileExpansionMap; "items.custom_field_objects.brands"?: true | BrandExpansionMap; "items.custom_field_objects.categories"?: true | CategoryExpansionMap; "items.custom_field_objects.content_blocks"?: true | ContentBlockExpansionMap; "items.custom_field_objects.files"?: true | FileExpansionMap; "items.custom_field_objects.products"?: true | ProductExpansionMap; "items.custom_field_objects.variants"?: true | ProductVariantExpansionMap; "items.field_set"?: true; "items.min_customer_group_prices.customer_group"?: true; "items.review_dimension_set"?: true | ReviewDimensionSetExpansionMap; "items.survey_answers_summary.survey_question"?: true; "items.variants"?: true | ProductVariantExpansionMap; } export interface ProductQuestionExpansionMap { "answers"?: true | ProductQuestionAnswerExpansionMap; "customer"?: true | CustomerExpansionMap; "detected_language"?: true; "email_message"?: true; "product"?: true | ProductExpansionMap; } export interface ProductQuestionAnswerExpansionMap { "customer"?: true | CustomerExpansionMap; "detected_language"?: true; "email_message"?: true; "product"?: true | ProductExpansionMap; "question"?: true | ProductQuestionExpansionMap; "user"?: true | UserExpansionMap; } export interface ProductQuestionAnswerPageExpansionMap { "items.customer"?: true | CustomerExpansionMap; "items.detected_language"?: true; "items.email_message"?: true; "items.product"?: true | ProductExpansionMap; "items.question"?: true | ProductQuestionExpansionMap; "items.user"?: true | UserExpansionMap; } export interface ProductQuestionExpandableItemsExpansionMap { "items"?: true | ProductQuestionExpansionMap; } export interface ProductQuestionPageExpansionMap { "items.answers"?: true | ProductQuestionAnswerExpansionMap; "items.customer"?: true | CustomerExpansionMap; "items.detected_language"?: true; "items.email_message"?: true; "items.product"?: true | ProductExpansionMap; } export interface ProductQuestionSearchResultExpansionMap { "items"?: true | ProductQuestionExpansionMap; } export interface ProductReviewExpansionMap { "answers"?: true | ProductReviewAnswerExpansionMap; "customer"?: true | CustomerExpansionMap; "detected_language"?: true; "email_message"?: true; "image_files"?: true | FileExpansionMap; "product"?: true | ProductExpansionMap; "scores.review_dimension"?: true; "survey_answers.survey_question"?: true; } export interface ProductReviewAnswerExpansionMap { "detected_language"?: true; "email_message"?: true; "product"?: true | ProductExpansionMap; "review"?: true | ProductReviewExpansionMap; "user"?: true | UserExpansionMap; } export interface ProductReviewAnswerPageExpansionMap { "items.detected_language"?: true; "items.email_message"?: true; "items.product"?: true | ProductExpansionMap; "items.review"?: true | ProductReviewExpansionMap; "items.user"?: true | UserExpansionMap; } export interface ProductReviewExpandableItemsExpansionMap { "items"?: true | ProductReviewExpansionMap; } export interface ProductReviewPageExpansionMap { "items.answers"?: true | ProductReviewAnswerExpansionMap; "items.customer"?: true | CustomerExpansionMap; "items.detected_language"?: true; "items.email_message"?: true; "items.image_files"?: true | FileExpansionMap; "items.product"?: true | ProductExpansionMap; "items.scores.review_dimension"?: true; "items.survey_answers.survey_question"?: true; } export interface ProductReviewSearchResultExpansionMap { "items"?: true | ProductReviewExpansionMap; } export interface ProductSearchResultExpansionMap { "categories.category"?: true | CategoryExpansionMap; "items"?: true | ProductExpansionMap; } export interface ProductVariantExpansionMap { "attachment"?: true | FileExpansionMap; "bundle_line_items.variant"?: true | ProductVariantExpansionMap; "country_of_origin"?: true; "customer_group_prices.customer_group"?: true; "inventory"?: true | VariantInventoryExpansionMap; "linked_media_files.file"?: true | FileExpansionMap; "linked_media_files.thumbnail_file"?: true | FileExpansionMap; "media_files.file"?: true | FileExpansionMap; "media_files.thumbnail_file"?: true | FileExpansionMap; "product"?: true | ProductExpansionMap; "suppliers.inventory_location"?: true | InventoryLocationExpansionMap; "suppliers.supplier"?: true | SupplierExpansionMap; } export interface ProductVariantPageExpansionMap { "items.attachment"?: true | FileExpansionMap; "items.bundle_line_items.variant"?: true | ProductVariantExpansionMap; "items.country_of_origin"?: true; "items.customer_group_prices.customer_group"?: true; "items.inventory"?: true | VariantInventoryExpansionMap; "items.linked_media_files.file"?: true | FileExpansionMap; "items.linked_media_files.thumbnail_file"?: true | FileExpansionMap; "items.media_files.file"?: true | FileExpansionMap; "items.media_files.thumbnail_file"?: true | FileExpansionMap; "items.product"?: true | ProductExpansionMap; "items.suppliers.inventory_location"?: true | InventoryLocationExpansionMap; "items.suppliers.supplier"?: true | SupplierExpansionMap; } export interface ProductVariantSearchResultExpansionMap { "items"?: true | ProductVariantExpansionMap; } export interface PromotionExpansionMap { "add_variant"?: true | ProductVariantExpansionMap; "rules.conditions.category"?: true | CategoryExpansionMap; "rules.conditions.customer_group"?: true; "rules.conditions.product"?: true | ProductExpansionMap; "rules.conditions.shipping_provider"?: true; "rules.conditions.variant"?: true | ProductVariantExpansionMap; } export interface PromotionExpandableItemsExpansionMap { "items"?: true | PromotionExpansionMap; } export interface PromotionPageExpansionMap { "items.add_variant"?: true | ProductVariantExpansionMap; "items.rules.conditions.category"?: true | CategoryExpansionMap; "items.rules.conditions.customer_group"?: true; "items.rules.conditions.product"?: true | ProductExpansionMap; "items.rules.conditions.shipping_provider"?: true; "items.rules.conditions.variant"?: true | ProductVariantExpansionMap; } export interface PromotionSearchResultExpansionMap { "items"?: true | PromotionExpansionMap; } export interface PurchaseOrderExpansionMap { "bill_to.country"?: true; "bill_to.province"?: true; "email_message"?: true; "from_supplier"?: true | SupplierExpansionMap; "line_items.variant"?: true | ProductVariantExpansionMap; "to_inventory_location"?: true | InventoryLocationExpansionMap; } export interface PurchaseOrderExpandableItemsExpansionMap { "items"?: true | PurchaseOrderExpansionMap; } export interface PurchaseOrderLogExpansionMap { "items.user"?: true | UserExpansionMap; } export interface PurchaseOrderPageExpansionMap { "items.bill_to.country"?: true; "items.bill_to.province"?: true; "items.email_message"?: true; "items.from_supplier"?: true | SupplierExpansionMap; "items.line_items.variant"?: true | ProductVariantExpansionMap; "items.to_inventory_location"?: true | InventoryLocationExpansionMap; } export interface PurchaseOrderSearchResultExpansionMap { "items"?: true | PurchaseOrderExpansionMap; } export interface ReturnExpansionMap { "history.customer"?: true | CustomerExpansionMap; "history.user"?: true | UserExpansionMap; "label_file"?: true | FileExpansionMap; "line_items.inspections.inspection"?: true; "line_items.variant"?: true | ProductVariantExpansionMap; "order"?: true | OrderExpansionMap; "return_address.country"?: true; "return_address.province"?: true; "return_inventory_location"?: true | InventoryLocationExpansionMap; "return_policy"?: true | ReturnPolicyExpansionMap; "tracking_events.country_info"?: true; "tracking_events.province_info"?: true; } export interface ReturnPageExpansionMap { "items.history.customer"?: true | CustomerExpansionMap; "items.history.user"?: true | UserExpansionMap; "items.label_file"?: true | FileExpansionMap; "items.line_items.inspections.inspection"?: true; "items.line_items.variant"?: true | ProductVariantExpansionMap; "items.order"?: true | OrderExpansionMap; "items.return_address.country"?: true; "items.return_address.province"?: true; "items.return_inventory_location"?: true | InventoryLocationExpansionMap; "items.return_policy"?: true | ReturnPolicyExpansionMap; "items.tracking_events.country_info"?: true; "items.tracking_events.province_info"?: true; } export interface ReturnPolicyExpansionMap { "conditions.category"?: true | CategoryExpansionMap; "conditions.country"?: true; "conditions.customer_group"?: true; "conditions.product"?: true | ProductExpansionMap; "conditions.shipping_provider"?: true; "conditions.variant"?: true | ProductVariantExpansionMap; "shipping_options.address.country"?: true; "shipping_options.address.province"?: true; "shipping_options.inventory_location"?: true | InventoryLocationExpansionMap; } export interface ReviewDimensionSetExpansionMap { "overall_review_dimension"?: true; "review_dimensions"?: true; "survey_questions"?: true; } export interface ReviewSettingsExpansionMap { "default_review_dimension_set"?: true | ReviewDimensionSetExpansionMap; } export interface ScheduledFulfillmentExpansionMap { "line_items.reserved_inventory_location"?: true | InventoryLocationExpansionMap; "pickup_inventory_location"?: true | InventoryLocationExpansionMap; "subscription"?: true | SubscriptionExpansionMap; } export interface ShardedTaskExpandableItemsExpansionMap { "items"?: true; } export interface ShippingRuleExpansionMap { "conditions.shipping_provider"?: true; "zones.country"?: true; "zones.province"?: true; } export interface ShopExpansionMap { "owner"?: true | UserExpansionMap; "primary_domain"?: true; } export interface ShopSettingsExpansionMap { "billing_address.country"?: true; "billing_address.province"?: true; "default_payment_method"?: true | PaymentMethodExpansionMap; "default_tax_rule"?: true | TaxRuleExpansionMap; "implicit_languages"?: true; "language"?: true; "languages"?: true; "shop_address.country"?: true; "shop_address.province"?: true; } export interface SubscriptionExpansionMap { "custom_billing_address.country"?: true; "custom_billing_address.province"?: true; "custom_shipping_address.country"?: true; "custom_shipping_address.province"?: true; "customer"?: true | CustomerExpansionMap; "last_order"?: true | OrderExpansionMap; "origin_order"?: true | OrderExpansionMap; "pending_order"?: true | OrderExpansionMap; "variant"?: true | ProductVariantExpansionMap; } export interface SubscriptionExpandableItemsExpansionMap { "items"?: true | SubscriptionExpansionMap; } export interface SubscriptionPageExpansionMap { "items.custom_billing_address.country"?: true; "items.custom_billing_address.province"?: true; "items.custom_shipping_address.country"?: true; "items.custom_shipping_address.province"?: true; "items.customer"?: true | CustomerExpansionMap; "items.last_order"?: true | OrderExpansionMap; "items.origin_order"?: true | OrderExpansionMap; "items.pending_order"?: true | OrderExpansionMap; "items.variant"?: true | ProductVariantExpansionMap; } export interface SubscriptionSearchResultExpansionMap { "items"?: true | SubscriptionExpansionMap; } export interface SupplierExpansionMap { "address.country"?: true; "address.province"?: true; } export interface SupplierExpandableItemsExpansionMap { "items"?: true | SupplierExpansionMap; } export interface SupplierPageExpansionMap { "items.address.country"?: true; "items.address.province"?: true; } export interface SupplierSearchResultExpansionMap { "items"?: true | SupplierExpansionMap; } export interface SupportArticleExpansionMap { "content_image_files"?: true | FileExpansionMap; "revisions.related_articles"?: true | SupportArticleExpansionMap; "revisions.support_topic"?: true; "revisions.user"?: true | UserExpansionMap; } export interface SupportArticleExpandableItemsExpansionMap { "items"?: true | SupportArticleExpansionMap; } export interface SupportArticlePageExpansionMap { "items.content_image_files"?: true | FileExpansionMap; "items.revisions.related_articles"?: true | SupportArticleExpansionMap; "items.revisions.support_topic"?: true; "items.revisions.user"?: true | UserExpansionMap; } export interface TaxRuleExpansionMap { "conditions.customer_group"?: true; "zones.country"?: true; "zones.province"?: true; } export interface TransferExpansionMap { "created_by"?: true | UserExpansionMap; "from_inventory_location"?: true | InventoryLocationExpansionMap; "line_items.variant"?: true | ProductVariantExpansionMap; "to_inventory_location"?: true | InventoryLocationExpansionMap; } export interface TransferExpandableItemsExpansionMap { "items"?: true | TransferExpansionMap; } export interface TransferLogExpansionMap { "items.user"?: true | UserExpansionMap; } export interface TransferPageExpansionMap { "items.created_by"?: true | UserExpansionMap; "items.from_inventory_location"?: true | InventoryLocationExpansionMap; "items.line_items.variant"?: true | ProductVariantExpansionMap; "items.to_inventory_location"?: true | InventoryLocationExpansionMap; } export interface TransferSearchResultExpansionMap { "items"?: true | TransferExpansionMap; } export interface UnifiedSearchResultExpansionMap { "brands"?: true | BrandExpansionMap; "categories"?: true | CategoryExpansionMap; "content_blocks"?: true | ContentBlockExpansionMap; "customer_inventory"?: true | CustomerInventoryExpansionMap; "customers"?: true | CustomerExpansionMap; "files"?: true | FileExpansionMap; "orders"?: true | OrderExpansionMap; "products"?: true | ProductExpansionMap; "promotions"?: true | PromotionExpansionMap; "purchase_orders"?: true | PurchaseOrderExpansionMap; "questions"?: true | ProductQuestionExpansionMap; "reviews"?: true | ProductReviewExpansionMap; "subscriptions"?: true | SubscriptionExpansionMap; "suppliers"?: true | SupplierExpansionMap; "transfers"?: true | TransferExpansionMap; } export interface UserExpansionMap { "email_message"?: true; "language"?: true; "roles"?: true; } export interface VariantInventoryExpansionMap { "locations.inventory_location"?: true | InventoryLocationExpansionMap; "variant"?: true | ProductVariantExpansionMap; } export interface VariantInventoryLogPageExpansionMap { "items.customer"?: true | CustomerExpansionMap; "items.inventory_location"?: true | InventoryLocationExpansionMap; "items.user"?: true | UserExpansionMap; } export interface WebhookEventExpansionMap { "status.event"?: true | WebhookEventExpansionMap; "status.webhook"?: true; } export interface WebhookEventPageExpansionMap { "items.status.event"?: true | WebhookEventExpansionMap; "items.status.webhook"?: true; } export interface WebhookEventStatusPageExpansionMap { "items.event"?: true | WebhookEventExpansionMap; "items.webhook"?: true; } export interface XeroSettingsExpansionMap { "payment_map.gateway"?: true; } export interface EndpointActivitiesPage extends Endpoint { /** Output filtering */ fields(v: Array): EndpointActivitiesPage; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointActivitiesPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointActivitiesPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointActivitiesPage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointActivitiesPage; expand(v: ActivityPageExpansionMap): EndpointActivitiesPage; extract(v: Extractor): EndpointActivitiesPage; } export interface EndpointAddressesShort extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointAddressesShort; /** List of short address ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointAddressesShort; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointAddressesShort; expand(v: AddressShortExpansionMap): EndpointAddressesShort; extract(v: Extractor>): EndpointAddressesShort; } export interface EndpointAddressesShortCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointAddressesShortCreate; data(v: Array): EndpointAddressesShortCreate; expand(v: AddressShortExpansionMap): EndpointAddressesShortCreate; extract(v: Extractor>): EndpointAddressesShortCreate; } export interface EndpointAnalyticsAudit extends Endpoint { /** Output filtering */ fields(v: Array): EndpointAnalyticsAudit; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointAnalyticsAudit; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointAnalyticsAudit; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointAnalyticsAudit; /** Filter results by a user id */ user_id(v: string): EndpointAnalyticsAudit; expand(v: AuditLogPageExpansionMap): EndpointAnalyticsAudit; extract(v: Extractor): EndpointAnalyticsAudit; } export interface EndpointAnalyticsAuditExport extends Endpoint { /** Whether to use CSV format or not (JSON otherwise) */ csv(v: boolean): EndpointAnalyticsAuditExport; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointAnalyticsAuditExport; /** Filter results by a user id */ user_id(v: string): EndpointAnalyticsAuditExport; expand(v: ForeignShardedTaskExpansionMap): EndpointAnalyticsAuditExport; extract(v: Extractor): EndpointAnalyticsAuditExport; } export interface EndpointAnalyticsCustomReport extends Endpoint { /** Analyze only, don't execute */ analyze_only(v: boolean): EndpointAnalyticsCustomReport; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointAnalyticsCustomReport; data(v: AnalyticsQuery): EndpointAnalyticsCustomReport; extract(v: Extractor): EndpointAnalyticsCustomReport; } export interface EndpointAnalyticsCustomReports extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointAnalyticsCustomReports; extract(v: Extractor): EndpointAnalyticsCustomReports; } export interface EndpointAnalyticsCustomReportsCreate extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointAnalyticsCustomReportsCreate; data(v: AnalyticsCustomReportsCreate): EndpointAnalyticsCustomReportsCreate; extract(v: Extractor): EndpointAnalyticsCustomReportsCreate; } export interface EndpointAnalyticsDashboardLayout extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointAnalyticsDashboardLayout; extract(v: Extractor): EndpointAnalyticsDashboardLayout; } export interface EndpointAnalyticsDashboardLayoutCreate extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointAnalyticsDashboardLayoutCreate; data(v: AnalyticsDashboardCreate): EndpointAnalyticsDashboardLayoutCreate; extract(v: Extractor): EndpointAnalyticsDashboardLayoutCreate; } export interface EndpointAnalyticsGeoip extends Endpoint { extract(v: Extractor): EndpointAnalyticsGeoip; } export interface EndpointAnalyticsReport extends Endpoint { /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointAnalyticsReport; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointAnalyticsReport; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointAnalyticsReport; data(v: AnalyticsReportParameters): EndpointAnalyticsReport; extract(v: Extractor): EndpointAnalyticsReport; } export interface EndpointAnalyticsReportExport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointAnalyticsReportExport; data(v: AnalyticsReportParameters): EndpointAnalyticsReportExport; expand(v: ForeignShardedTaskExpansionMap): EndpointAnalyticsReportExport; extract(v: Extractor): EndpointAnalyticsReportExport; } export interface EndpointAttachments extends Endpoint { extract(v: Extractor): EndpointAttachments; } export interface EndpointAuthConfirm extends Endpoint { /** Confirmation token that was delivered via email */ token(v: string): EndpointAuthConfirm; } export interface EndpointAuthLogin extends Endpoint { data(v: UserLogin): EndpointAuthLogin; extract(v: Extractor): EndpointAuthLogin; } export interface EndpointAuthPasswordComplete extends Endpoint { data(v: UserPasswordResetComplete): EndpointAuthPasswordComplete; } export interface EndpointAuthPasswordReset extends Endpoint { data(v: UserPasswordReset): EndpointAuthPasswordReset; } export interface EndpointAuthPasswordVerify extends Endpoint { data(v: UserPasswordResetVerify): EndpointAuthPasswordVerify; } export interface EndpointAuthRefresh extends Endpoint { data(v: Token): EndpointAuthRefresh; extract(v: Extractor): EndpointAuthRefresh; } export interface EndpointAutocompleteCustomers extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointAutocompleteCustomers; data(v: Query): EndpointAutocompleteCustomers; expand(v: CustomerExpandableItemsExpansionMap): EndpointAutocompleteCustomers; extract(v: Extractor): EndpointAutocompleteCustomers; } export interface EndpointAutocompleteProducts extends Endpoint { /** Ignore bundle variant types */ ignore_bundles(v: boolean): EndpointAutocompleteProducts; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointAutocompleteProducts; /** Filter output by variant type */ type(v: VariantTypeFilter): EndpointAutocompleteProducts; data(v: Query): EndpointAutocompleteProducts; expand(v: ProductExpandableItemsExpansionMap): EndpointAutocompleteProducts; extract(v: Extractor): EndpointAutocompleteProducts; } export interface EndpointBlogs extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointBlogs; /** List of blog ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointBlogs; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointBlogs; expand(v: BlogExpansionMap): EndpointBlogs; extract(v: Extractor>): EndpointBlogs; } export interface EndpointBlogsPage extends Endpoint { /** Output filtering */ fields(v: Array): EndpointBlogsPage; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointBlogsPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointBlogsPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointBlogsPage; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: BlogsPageSortBy): EndpointBlogsPage; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointBlogsPage; /** Filter blogs output by a type */ type(v: BlogFilterType): EndpointBlogsPage; expand(v: BlogPageExpansionMap): EndpointBlogsPage; extract(v: Extractor): EndpointBlogsPage; } export interface EndpointBranding extends Endpoint { /** Output filtering */ fields(v: Array): EndpointBranding; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointBranding; expand(v: BrandingExpansionMap): EndpointBranding; extract(v: Extractor): EndpointBranding; } export interface EndpointBrandingCreate extends Endpoint { /** Output filtering */ fields(v: Array): EndpointBrandingCreate; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointBrandingCreate; data(v: BrandingCreate): EndpointBrandingCreate; expand(v: BrandingExpansionMap): EndpointBrandingCreate; extract(v: Extractor): EndpointBrandingCreate; } export interface EndpointBrandingDefault extends Endpoint { /** Output filtering */ fields(v: Array): EndpointBrandingDefault; expand(v: BrandingExpansionMap): EndpointBrandingDefault; extract(v: Extractor): EndpointBrandingDefault; } export interface EndpointBrandsDelete extends Endpoint { /** List of brand ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointBrandsDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointBrandsDelete; } export interface EndpointBrands extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointBrands; /** List of brand ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointBrands; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointBrands; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointBrands; expand(v: BrandExpansionMap): EndpointBrands; extract(v: Extractor>): EndpointBrands; } export interface EndpointBrandsCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointBrandsCreate; /** List of brand ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointBrandsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointBrandsCreate; data(v: Array): EndpointBrandsCreate; expand(v: BrandExpansionMap): EndpointBrandsCreate; extract(v: Extractor>): EndpointBrandsCreate; } export interface EndpointBrandsModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointBrandsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointBrandsModify; data(v: Array): EndpointBrandsModify; expand(v: BrandExpansionMap): EndpointBrandsModify; extract(v: Extractor>): EndpointBrandsModify; } export interface EndpointBrandsExport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointBrandsExport; data(v: GenericExport): EndpointBrandsExport; expand(v: ForeignShardedTaskExpansionMap): EndpointBrandsExport; extract(v: Extractor): EndpointBrandsExport; } export interface EndpointBrandsImport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointBrandsImport; data(v: GenericImport): EndpointBrandsImport; expand(v: ForeignShardedTaskExpansionMap): EndpointBrandsImport; extract(v: Extractor): EndpointBrandsImport; } export interface EndpointBrandsPage extends Endpoint { /** Filter output by creation date, upper boundary */ created_at_max(v: string): EndpointBrandsPage; /** Filter output by creation date, lower boundary */ created_at_min(v: string): EndpointBrandsPage; /** If set, show only featured brands */ featured(v: boolean): EndpointBrandsPage; /** Output filtering */ fields(v: Array): EndpointBrandsPage; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointBrandsPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointBrandsPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointBrandsPage; /** Filter output by publication date, upper boundary */ published_at_max(v: string): EndpointBrandsPage; /** Filter output by publication date, lower boundary */ published_at_min(v: string): EndpointBrandsPage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointBrandsPage; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: BrandsPageSortBy): EndpointBrandsPage; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointBrandsPage; /** Filter output by published status */ status(v: PublishedStatus): EndpointBrandsPage; /** Filter output by last update date, upper boundary */ updated_at_max(v: string): EndpointBrandsPage; /** Filter output by last update date, lower boundary */ updated_at_min(v: string): EndpointBrandsPage; expand(v: BrandPageExpansionMap): EndpointBrandsPage; extract(v: Extractor): EndpointBrandsPage; } export interface EndpointBuyLinksDelete extends Endpoint { /** List of buy link ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointBuyLinksDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointBuyLinksDelete; } export interface EndpointBuyLinks extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointBuyLinks; /** List of buy link ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointBuyLinks; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointBuyLinks; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointBuyLinks; expand(v: BuyLinkExpansionMap): EndpointBuyLinks; extract(v: Extractor>): EndpointBuyLinks; } export interface EndpointBuyLinksCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointBuyLinksCreate; /** List of buy link ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointBuyLinksModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointBuyLinksCreate; data(v: Array): EndpointBuyLinksCreate; expand(v: BuyLinkExpansionMap): EndpointBuyLinksCreate; extract(v: Extractor>): EndpointBuyLinksCreate; } export interface EndpointBuyLinksModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointBuyLinksModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointBuyLinksModify; data(v: Array): EndpointBuyLinksModify; expand(v: BuyLinkExpansionMap): EndpointBuyLinksModify; extract(v: Extractor>): EndpointBuyLinksModify; } export interface EndpointBuyLinksExport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointBuyLinksExport; data(v: GenericExport): EndpointBuyLinksExport; expand(v: ForeignShardedTaskExpansionMap): EndpointBuyLinksExport; extract(v: Extractor): EndpointBuyLinksExport; } export interface EndpointBuyLinksImport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointBuyLinksImport; data(v: GenericImport): EndpointBuyLinksImport; expand(v: ForeignShardedTaskExpansionMap): EndpointBuyLinksImport; extract(v: Extractor): EndpointBuyLinksImport; } export interface EndpointCategoriesDelete extends Endpoint { /** List of category ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointCategoriesDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCategoriesDelete; } export interface EndpointCategories extends Endpoint> { /** Unique category identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ children_of(v: string): EndpointCategories; /** If set, show only featured categories */ featured(v: boolean): EndpointCategories; /** Output filtering */ fields(v: Array): EndpointCategories; /** List of category ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointCategories; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointCategories; /** If set, show only published categories */ published(v: boolean): EndpointCategories; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCategories; expand(v: CategoryExpansionMap): EndpointCategories; extract(v: Extractor>): EndpointCategories; } export interface EndpointCategoriesCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointCategoriesCreate; /** List of category ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointCategoriesModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCategoriesCreate; data(v: Array): EndpointCategoriesCreate; expand(v: CategoryExpansionMap): EndpointCategoriesCreate; extract(v: Extractor>): EndpointCategoriesCreate; } export interface EndpointCategoriesModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointCategoriesModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCategoriesModify; data(v: Array): EndpointCategoriesModify; expand(v: CategoryExpansionMap): EndpointCategoriesModify; extract(v: Extractor>): EndpointCategoriesModify; } export interface EndpointCategoriesExport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCategoriesExport; data(v: GenericExport): EndpointCategoriesExport; expand(v: ForeignShardedTaskExpansionMap): EndpointCategoriesExport; extract(v: Extractor): EndpointCategoriesExport; } export interface EndpointCategoriesImport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCategoriesImport; data(v: GenericImport): EndpointCategoriesImport; expand(v: ForeignShardedTaskExpansionMap): EndpointCategoriesImport; extract(v: Extractor): EndpointCategoriesImport; } export interface EndpointContentBlocksDelete extends Endpoint { /** List of content block ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointContentBlocksDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointContentBlocksDelete; } export interface EndpointContentBlocks extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointContentBlocks; /** List of content block ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointContentBlocks; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointContentBlocks; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointContentBlocks; expand(v: ContentBlockExpansionMap): EndpointContentBlocks; extract(v: Extractor>): EndpointContentBlocks; } export interface EndpointContentBlocksCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointContentBlocksCreate; /** List of content block ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointContentBlocksModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointContentBlocksCreate; data(v: Array): EndpointContentBlocksCreate; expand(v: ContentBlockExpansionMap): EndpointContentBlocksCreate; extract(v: Extractor>): EndpointContentBlocksCreate; } export interface EndpointContentBlocksModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointContentBlocksModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointContentBlocksModify; data(v: Array): EndpointContentBlocksModify; expand(v: ContentBlockExpansionMap): EndpointContentBlocksModify; extract(v: Extractor>): EndpointContentBlocksModify; } export interface EndpointContentBlocksExport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointContentBlocksExport; data(v: GenericExport): EndpointContentBlocksExport; expand(v: ForeignShardedTaskExpansionMap): EndpointContentBlocksExport; extract(v: Extractor): EndpointContentBlocksExport; } export interface EndpointContentBlocksImport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointContentBlocksImport; data(v: GenericImport): EndpointContentBlocksImport; expand(v: ForeignShardedTaskExpansionMap): EndpointContentBlocksImport; extract(v: Extractor): EndpointContentBlocksImport; } export interface EndpointContentBlocksPage extends Endpoint { /** Filter output by creation date, upper boundary */ created_at_max(v: string): EndpointContentBlocksPage; /** Filter output by creation date, lower boundary */ created_at_min(v: string): EndpointContentBlocksPage; /** Output filtering */ fields(v: Array): EndpointContentBlocksPage; /** Filter output by content block handle */ handle(v: string): EndpointContentBlocksPage; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointContentBlocksPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointContentBlocksPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointContentBlocksPage; /** Filter output by publication date, upper boundary */ published_at_max(v: string): EndpointContentBlocksPage; /** Filter output by publication date, lower boundary */ published_at_min(v: string): EndpointContentBlocksPage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointContentBlocksPage; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: ContentBlocksPageSortBy): EndpointContentBlocksPage; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointContentBlocksPage; /** Filter output by published status */ status(v: PublishedStatus): EndpointContentBlocksPage; /** Filter output by content block title */ title(v: string): EndpointContentBlocksPage; /** Filter output by last update date, upper boundary */ updated_at_max(v: string): EndpointContentBlocksPage; /** Filter output by last update date, lower boundary */ updated_at_min(v: string): EndpointContentBlocksPage; expand(v: ContentBlockPageExpansionMap): EndpointContentBlocksPage; extract(v: Extractor): EndpointContentBlocksPage; } export interface EndpointContentModelsDelete extends Endpoint { /** Output filtering */ fields(v: Array): EndpointContentModelsDelete; /** List of content model ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointContentModelsDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointContentModelsDelete; } export interface EndpointContentModels extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointContentModels; /** List of content model ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointContentModels; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointContentModels; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointContentModels; extract(v: Extractor>): EndpointContentModels; } export interface EndpointContentModelsCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointContentModelsCreate; /** List of content model ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointContentModelsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointContentModelsCreate; data(v: Array): EndpointContentModelsCreate; extract(v: Extractor>): EndpointContentModelsCreate; } export interface EndpointContentModelsModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointContentModelsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointContentModelsModify; data(v: Array): EndpointContentModelsModify; extract(v: Extractor>): EndpointContentModelsModify; } export interface EndpointCountries extends Endpoint> { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCountries; extract(v: Extractor>): EndpointCountries; } export interface EndpointCouponsDelete extends Endpoint { /** List of coupon ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointCouponsDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCouponsDelete; } export interface EndpointCoupons extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointCoupons; /** List of coupon ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointCoupons; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointCoupons; /** Unique promotion identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ promotion_id(v: string): EndpointCoupons; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCoupons; extract(v: Extractor>): EndpointCoupons; } export interface EndpointCouponsCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointCouponsCreate; /** Unique promotion identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ promotion_id(v: string): EndpointCouponsCreate; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCouponsCreate; data(v: Array): EndpointCouponsCreate; extract(v: Extractor>): EndpointCouponsCreate; } export interface EndpointCouponsGenerate extends Endpoint { /** Unique promotion identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ promotion_id(v: string): EndpointCouponsGenerate; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCouponsGenerate; data(v: CouponBulk): EndpointCouponsGenerate; } export interface EndpointCouponsPage extends Endpoint { /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointCouponsPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointCouponsPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointCouponsPage; /** Unique promotion identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ promotion_id(v: string): EndpointCouponsPage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCouponsPage; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: CouponsPageSortBy): EndpointCouponsPage; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointCouponsPage; extract(v: Extractor): EndpointCouponsPage; } export interface EndpointCurrenciesDelete extends Endpoint { /** List of currency ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointCurrenciesDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCurrenciesDelete; } export interface EndpointCurrencies extends Endpoint> { /** List of currency ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointCurrencies; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointCurrencies; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCurrencies; extract(v: Extractor>): EndpointCurrencies; } export interface EndpointCurrenciesCreate extends Endpoint> { /** List of currency ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointCurrenciesModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCurrenciesCreate; data(v: Array): EndpointCurrenciesCreate; extract(v: Extractor>): EndpointCurrenciesCreate; } export interface EndpointCurrenciesModify extends Endpoint> { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCurrenciesModify; data(v: Array): EndpointCurrenciesModify; extract(v: Extractor>): EndpointCurrenciesModify; } export interface EndpointCustomerBalance extends Endpoint { /** Unique customer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ customer_id(v: string): EndpointCustomerBalance; /** Output filtering */ fields(v: Array): EndpointCustomerBalance; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomerBalance; expand(v: CustomerBalanceExpansionMap): EndpointCustomerBalance; extract(v: Extractor): EndpointCustomerBalance; } export interface EndpointCustomerBalanceApplyGiftCard extends Endpoint { /** Unique customer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ customer_id(v: string): EndpointCustomerBalanceApplyGiftCard; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomerBalanceApplyGiftCard; data(v: ApplyGiftCard): EndpointCustomerBalanceApplyGiftCard; } export interface EndpointCustomerBalanceHistory extends Endpoint { /** Filter history by currency */ currency(v: string): EndpointCustomerBalanceHistory; /** Unique customer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ customer_id(v: string): EndpointCustomerBalanceHistory; /** Output filtering */ fields(v: Array): EndpointCustomerBalanceHistory; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointCustomerBalanceHistory; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointCustomerBalanceHistory; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointCustomerBalanceHistory; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomerBalanceHistory; extract(v: Extractor): EndpointCustomerBalanceHistory; } export interface EndpointCustomerBalanceTransactionCreate extends Endpoint { /** Unique customer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ customer_id(v: string): EndpointCustomerBalanceTransactionCreate; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomerBalanceTransactionCreate; data(v: CustomerBalanceCreate): EndpointCustomerBalanceTransactionCreate; } export interface EndpointCustomerGroupsDelete extends Endpoint { /** List of customer group ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointCustomerGroupsDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomerGroupsDelete; } export interface EndpointCustomerGroups extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointCustomerGroups; /** List of customer group ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointCustomerGroups; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointCustomerGroups; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomerGroups; extract(v: Extractor>): EndpointCustomerGroups; } export interface EndpointCustomerGroupsCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointCustomerGroupsCreate; /** List of customer group ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointCustomerGroupsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomerGroupsCreate; data(v: Array): EndpointCustomerGroupsCreate; extract(v: Extractor>): EndpointCustomerGroupsCreate; } export interface EndpointCustomerGroupsModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointCustomerGroupsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomerGroupsModify; data(v: Array): EndpointCustomerGroupsModify; extract(v: Extractor>): EndpointCustomerGroupsModify; } export interface EndpointCustomerGroupsExport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomerGroupsExport; data(v: GenericExport): EndpointCustomerGroupsExport; expand(v: ForeignShardedTaskExpansionMap): EndpointCustomerGroupsExport; extract(v: Extractor): EndpointCustomerGroupsExport; } export interface EndpointCustomerGroupsImport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomerGroupsImport; data(v: GenericImport): EndpointCustomerGroupsImport; expand(v: ForeignShardedTaskExpansionMap): EndpointCustomerGroupsImport; extract(v: Extractor): EndpointCustomerGroupsImport; } export interface EndpointCustomerInventory extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointCustomerInventory; /** List of inventory item ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointCustomerInventory; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointCustomerInventory; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomerInventory; expand(v: CustomerInventoryExpansionMap): EndpointCustomerInventory; extract(v: Extractor>): EndpointCustomerInventory; } export interface EndpointCustomerInventoryCreate extends Endpoint> { /** List of inventory item ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointCustomerInventoryModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomerInventoryCreate; data(v: Array): EndpointCustomerInventoryCreate; expand(v: CustomerInventoryExpansionMap): EndpointCustomerInventoryCreate; extract(v: Extractor>): EndpointCustomerInventoryCreate; } export interface EndpointCustomerInventoryModify extends Endpoint> { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomerInventoryModify; data(v: Array): EndpointCustomerInventoryModify; expand(v: CustomerInventoryExpansionMap): EndpointCustomerInventoryModify; extract(v: Extractor>): EndpointCustomerInventoryModify; } export interface EndpointCustomerInventoryDownload extends Endpoint { /** Unique customer inventory item identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ customer_inventory_id(v: string): EndpointCustomerInventoryDownload; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomerInventoryDownload; extract(v: Extractor): EndpointCustomerInventoryDownload; } export interface EndpointCustomerInventoryExport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomerInventoryExport; /** Filter output by inventory type */ type(v: CustomerInventoryTypeParam): EndpointCustomerInventoryExport; data(v: GenericExport): EndpointCustomerInventoryExport; expand(v: ForeignShardedTaskExpansionMap): EndpointCustomerInventoryExport; extract(v: Extractor): EndpointCustomerInventoryExport; } export interface EndpointCustomerInventoryPage extends Endpoint { /** Unique customer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ customer_id(v: string): EndpointCustomerInventoryPage; /** Output filtering */ fields(v: Array): EndpointCustomerInventoryPage; /** Filter output by inventory item type */ item_type(v: CustomerInventoryItemTypeParam): EndpointCustomerInventoryPage; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointCustomerInventoryPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointCustomerInventoryPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointCustomerInventoryPage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomerInventoryPage; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: CustomerInventoryPageSortBy): EndpointCustomerInventoryPage; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointCustomerInventoryPage; /** Filter output by inventory type */ type(v: CustomerInventoryTypeParam): EndpointCustomerInventoryPage; expand(v: CustomerInventoryPageExpansionMap): EndpointCustomerInventoryPage; extract(v: Extractor): EndpointCustomerInventoryPage; } export interface EndpointCustomerInventoryNotesDelete extends Endpoint { /** Unique customer inventory item identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ customer_inventory_id(v: string): EndpointCustomerInventoryNotesDelete; /** List of inventory item note ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointCustomerInventoryNotesDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomerInventoryNotesDelete; } export interface EndpointCustomerInventoryNotes extends Endpoint> { /** Unique customer inventory item identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ customer_inventory_id(v: string): EndpointCustomerInventoryNotes; /** Output filtering */ fields(v: Array): EndpointCustomerInventoryNotes; /** List of inventory item note ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointCustomerInventoryNotes; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomerInventoryNotes; expand(v: NoteExpansionMap): EndpointCustomerInventoryNotes; extract(v: Extractor>): EndpointCustomerInventoryNotes; } export interface EndpointCustomerInventoryNotesCreate extends Endpoint> { /** Unique customer inventory item identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ customer_inventory_id(v: string): EndpointCustomerInventoryNotesCreate; /** Output filtering */ fields(v: Array): EndpointCustomerInventoryNotesCreate; /** List of inventory item note ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointCustomerInventoryNotesModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomerInventoryNotesCreate; data(v: Array): EndpointCustomerInventoryNotesCreate; expand(v: NoteExpansionMap): EndpointCustomerInventoryNotesCreate; extract(v: Extractor>): EndpointCustomerInventoryNotesCreate; } export interface EndpointCustomerInventoryNotesModify extends Endpoint> { /** Unique customer inventory item identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ customer_inventory_id(v: string): EndpointCustomerInventoryNotesModify; /** Output filtering */ fields(v: Array): EndpointCustomerInventoryNotesModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomerInventoryNotesModify; data(v: Array): EndpointCustomerInventoryNotesModify; expand(v: NoteExpansionMap): EndpointCustomerInventoryNotesModify; extract(v: Extractor>): EndpointCustomerInventoryNotesModify; } export interface EndpointCustomerNotesDelete extends Endpoint { /** Unique customer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ customer_id(v: string): EndpointCustomerNotesDelete; /** List of customer note ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointCustomerNotesDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomerNotesDelete; } export interface EndpointCustomerNotes extends Endpoint> { /** Unique customer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ customer_id(v: string): EndpointCustomerNotes; /** Output filtering */ fields(v: Array): EndpointCustomerNotes; /** List of customer note ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointCustomerNotes; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomerNotes; expand(v: NoteExpansionMap): EndpointCustomerNotes; extract(v: Extractor>): EndpointCustomerNotes; } export interface EndpointCustomerNotesCreate extends Endpoint> { /** Unique customer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ customer_id(v: string): EndpointCustomerNotesCreate; /** Output filtering */ fields(v: Array): EndpointCustomerNotesCreate; /** List of customer note ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointCustomerNotesModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomerNotesCreate; data(v: Array): EndpointCustomerNotesCreate; expand(v: NoteExpansionMap): EndpointCustomerNotesCreate; extract(v: Extractor>): EndpointCustomerNotesCreate; } export interface EndpointCustomerNotesModify extends Endpoint> { /** Unique customer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ customer_id(v: string): EndpointCustomerNotesModify; /** Output filtering */ fields(v: Array): EndpointCustomerNotesModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomerNotesModify; data(v: Array): EndpointCustomerNotesModify; expand(v: NoteExpansionMap): EndpointCustomerNotesModify; extract(v: Extractor>): EndpointCustomerNotesModify; } export interface EndpointCustomersDelete extends Endpoint { /** List of customer ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointCustomersDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomersDelete; } export interface EndpointCustomers extends Endpoint> { /** Include deleted items into result where applicable */ deleted(v: boolean): EndpointCustomers; /** Output filtering */ fields(v: Array): EndpointCustomers; /** List of customer ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointCustomers; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointCustomers; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomers; expand(v: CustomerExpansionMap): EndpointCustomers; extract(v: Extractor>): EndpointCustomers; } export interface EndpointCustomersCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointCustomersCreate; /** List of customer ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointCustomersModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomersCreate; data(v: Array): EndpointCustomersCreate; expand(v: CustomerExpansionMap): EndpointCustomersCreate; extract(v: Extractor>): EndpointCustomersCreate; } export interface EndpointCustomersModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointCustomersModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomersModify; data(v: Array): EndpointCustomersModify; expand(v: CustomerExpansionMap): EndpointCustomersModify; extract(v: Extractor>): EndpointCustomersModify; } export interface EndpointCustomersAuthPasswordReset extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomersAuthPasswordReset; data(v: CustomerPasswordReset): EndpointCustomersAuthPasswordReset; } export interface EndpointCustomersExport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomersExport; data(v: GenericExport): EndpointCustomersExport; expand(v: ForeignShardedTaskExpansionMap): EndpointCustomersExport; extract(v: Extractor): EndpointCustomersExport; } export interface EndpointCustomersImport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomersImport; data(v: GenericImport): EndpointCustomersImport; expand(v: ForeignShardedTaskExpansionMap): EndpointCustomersImport; extract(v: Extractor): EndpointCustomersImport; } export interface EndpointCustomersPage extends Endpoint { /** Filter output by creation date, upper boundary */ created_at_max(v: string): EndpointCustomersPage; /** Filter output by creation date, lower boundary */ created_at_min(v: string): EndpointCustomersPage; /** Show only customers from a certain customer group */ customer_group_id(v: string): EndpointCustomersPage; /** Include deleted items into result where applicable */ deleted(v: boolean): EndpointCustomersPage; /** Output filtering */ fields(v: Array): EndpointCustomersPage; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointCustomersPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointCustomersPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointCustomersPage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomersPage; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: CustomersPageSortBy): EndpointCustomersPage; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointCustomersPage; /** Filter customers output by a customer type */ type(v: CustomerCategory): EndpointCustomersPage; /** Filter output by last update date, upper boundary */ updated_at_max(v: string): EndpointCustomersPage; /** Filter output by last update date, lower boundary */ updated_at_min(v: string): EndpointCustomersPage; expand(v: CustomerPageExpansionMap): EndpointCustomersPage; extract(v: Extractor): EndpointCustomersPage; } export interface EndpointCustomersPaymentSourcesDelete extends Endpoint { /** Unique customer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ customer_id(v: string): EndpointCustomersPaymentSourcesDelete; /** List of customer payment source ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointCustomersPaymentSourcesDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomersPaymentSourcesDelete; } export interface EndpointCustomersPaymentSources extends Endpoint> { /** Unique customer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ customer_id(v: string): EndpointCustomersPaymentSources; /** Output filtering */ fields(v: Array): EndpointCustomersPaymentSources; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomersPaymentSources; expand(v: CustomerPaymentSourceExpansionMap): EndpointCustomersPaymentSources; extract(v: Extractor>): EndpointCustomersPaymentSources; } export interface EndpointCustomersPaymentSourcesCreate extends Endpoint> { /** Unique customer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ customer_id(v: string): EndpointCustomersPaymentSourcesCreate; /** Output filtering */ fields(v: Array): EndpointCustomersPaymentSourcesCreate; /** List of customer payment source ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointCustomersPaymentSourcesModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomersPaymentSourcesCreate; data(v: Array): EndpointCustomersPaymentSourcesCreate; expand(v: CustomerPaymentSourceExpansionMap): EndpointCustomersPaymentSourcesCreate; extract(v: Extractor>): EndpointCustomersPaymentSourcesCreate; } export interface EndpointCustomersPaymentSourcesModify extends Endpoint> { /** Unique customer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ customer_id(v: string): EndpointCustomersPaymentSourcesModify; /** Output filtering */ fields(v: Array): EndpointCustomersPaymentSourcesModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointCustomersPaymentSourcesModify; data(v: Array): EndpointCustomersPaymentSourcesModify; expand(v: CustomerPaymentSourceExpansionMap): EndpointCustomersPaymentSourcesModify; extract(v: Extractor>): EndpointCustomersPaymentSourcesModify; } export interface EndpointDataFeedsDelete extends Endpoint { /** List of data feed ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointDataFeedsDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointDataFeedsDelete; } export interface EndpointDataFeeds extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointDataFeeds; /** List of data feed ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointDataFeeds; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointDataFeeds; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointDataFeeds; extract(v: Extractor>): EndpointDataFeeds; } export interface EndpointDataFeedsCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointDataFeedsCreate; /** List of data feed ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointDataFeedsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointDataFeedsCreate; data(v: Array): EndpointDataFeedsCreate; extract(v: Extractor>): EndpointDataFeedsCreate; } export interface EndpointDataFeedsModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointDataFeedsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointDataFeedsModify; data(v: Array): EndpointDataFeedsModify; extract(v: Extractor>): EndpointDataFeedsModify; } export interface EndpointDataFeedsPreview extends Endpoint> { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointDataFeedsPreview; data(v: DataFeedPreview): EndpointDataFeedsPreview; extract(v: Extractor>): EndpointDataFeedsPreview; } export interface EndpointDevicesDelete extends Endpoint { /** Output filtering */ fields(v: Array): EndpointDevicesDelete; /** List of device ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointDevicesDelete; } export interface EndpointDevices extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointDevices; extract(v: Extractor>): EndpointDevices; } export interface EndpointDevices extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointDevices; /** List of device ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointDevices; data(v: Array): EndpointDevices; extract(v: Extractor>): EndpointDevices; } export interface EndpointDomainsDelete extends Endpoint { /** List of domain ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointDomainsDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointDomainsDelete; } export interface EndpointDomains extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointDomains; /** List of domain ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointDomains; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointDomains; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointDomains; extract(v: Extractor>): EndpointDomains; } export interface EndpointDomainsCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointDomainsCreate; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointDomainsCreate; data(v: Array): EndpointDomainsCreate; extract(v: Extractor>): EndpointDomainsCreate; } export interface EndpointDomainsFetchCert extends Endpoint { /** Unique domain identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ domain_id(v: string): EndpointDomainsFetchCert; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointDomainsFetchCert; } export interface EndpointDomainsSendInstructions extends Endpoint { /** Unique domain identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ domain_id(v: string): EndpointDomainsSendInstructions; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointDomainsSendInstructions; data(v: DomainSendInstructions): EndpointDomainsSendInstructions; } export interface EndpointEmailMessagesDelete extends Endpoint { /** List of test email ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointEmailMessagesDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointEmailMessagesDelete; } export interface EndpointEmailMessagesPage extends Endpoint { /** Output filtering */ fields(v: Array): EndpointEmailMessagesPage; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointEmailMessagesPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointEmailMessagesPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointEmailMessagesPage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointEmailMessagesPage; extract(v: Extractor): EndpointEmailMessagesPage; } export interface EndpointFavoritesDelete extends Endpoint { /** Unique customer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ customer_id(v: string): EndpointFavoritesDelete; /** List of favorite ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointFavoritesDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointFavoritesDelete; } export interface EndpointFavorites extends Endpoint> { /** Unique customer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ customer_id(v: string): EndpointFavorites; /** Output filtering */ fields(v: Array): EndpointFavorites; /** List of favorite ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointFavorites; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointFavorites; expand(v: CustomerFavoriteExpansionMap): EndpointFavorites; extract(v: Extractor>): EndpointFavorites; } export interface EndpointFavoritesCreate extends Endpoint> { /** Unique customer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ customer_id(v: string): EndpointFavoritesCreate; /** Output filtering */ fields(v: Array): EndpointFavoritesCreate; /** List of favorite ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointFavoritesModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointFavoritesCreate; data(v: Array): EndpointFavoritesCreate; expand(v: CustomerFavoriteExpansionMap): EndpointFavoritesCreate; extract(v: Extractor>): EndpointFavoritesCreate; } export interface EndpointFavoritesModify extends Endpoint> { /** Unique customer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ customer_id(v: string): EndpointFavoritesModify; /** Output filtering */ fields(v: Array): EndpointFavoritesModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointFavoritesModify; data(v: Array): EndpointFavoritesModify; expand(v: CustomerFavoriteExpansionMap): EndpointFavoritesModify; extract(v: Extractor>): EndpointFavoritesModify; } export interface EndpointFavoritesPage extends Endpoint { /** Show only favorites of a certain customer */ customer_id(v: string): EndpointFavoritesPage; /** Output filtering */ fields(v: Array): EndpointFavoritesPage; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointFavoritesPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointFavoritesPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointFavoritesPage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointFavoritesPage; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: FavoriteSortBy): EndpointFavoritesPage; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointFavoritesPage; /** Filter favorites by a type */ type(v: FavoriteType): EndpointFavoritesPage; expand(v: CustomerFavoritePageExpansionMap): EndpointFavoritesPage; extract(v: Extractor): EndpointFavoritesPage; } export interface EndpointFilesDelete extends Endpoint { /** List of file ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointFilesDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointFilesDelete; } export interface EndpointFiles extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointFiles; /** List of file ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointFiles; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointFiles; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointFiles; expand(v: FileExpansionMap): EndpointFiles; extract(v: Extractor>): EndpointFiles; } export interface EndpointFilesCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointFilesCreate; /** List of file ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointFilesModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointFilesCreate; data(v: Array): EndpointFilesCreate; expand(v: FileExpansionMap): EndpointFilesCreate; extract(v: Extractor>): EndpointFilesCreate; } export interface EndpointFilesModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointFilesModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointFilesModify; data(v: Array): EndpointFilesModify; expand(v: FileExpansionMap): EndpointFilesModify; extract(v: Extractor>): EndpointFilesModify; } export interface EndpointFilesDownload extends Endpoint> { /** List of file ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointFilesDownload; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointFilesDownload; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointFilesDownload; extract(v: Extractor>): EndpointFilesDownload; } export interface EndpointFilesLookup extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointFilesLookup; /** Hashes to lookup files by */ hashes(v: Array): EndpointFilesLookup; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointFilesLookup; expand(v: FileExpansionMap): EndpointFilesLookup; extract(v: Extractor>): EndpointFilesLookup; } export interface EndpointFilesPage extends Endpoint { /** Output filtering */ fields(v: Array): EndpointFilesPage; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointFilesPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointFilesPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointFilesPage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointFilesPage; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: FilesPageSortBy): EndpointFilesPage; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointFilesPage; /** Filter files by storage type */ storage(v: FileStorage): EndpointFilesPage; /** Filter files by type */ type(v: ImageType): EndpointFilesPage; /** Filter files by upload status */ uploaded(v: boolean): EndpointFilesPage; expand(v: FilePageExpansionMap): EndpointFilesPage; extract(v: Extractor): EndpointFilesPage; } export interface EndpointFilesSign extends Endpoint { /** Unique invoice identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ invoice_id(v: string): EndpointFilesSign; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointFilesSign; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointFilesSign; extract(v: Extractor): EndpointFilesSign; } export interface EndpointFilesUpload extends Endpoint { /** Output filtering */ fields(v: Array): EndpointFilesUpload; /** Unique file identifier to begin upload of. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ file_id(v: string): EndpointFilesUpload; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointFilesUpload; extract(v: Extractor): EndpointFilesUpload; } export interface EndpointFilesUploaded extends Endpoint { /** Output filtering */ fields(v: Array): EndpointFilesUploaded; /** Unique file identifier to begin upload of. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ file_id(v: string): EndpointFilesUploaded; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointFilesUploaded; expand(v: FileExpansionMap): EndpointFilesUploaded; extract(v: Extractor): EndpointFilesUploaded; } export interface EndpointGatewaysDelete extends Endpoint { /** List of gateway ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointGatewaysDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointGatewaysDelete; } export interface EndpointGateways extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointGateways; /** List of gateway ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointGateways; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointGateways; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointGateways; /** Filter results by gateway type */ type(v: GatewayType): EndpointGateways; extract(v: Extractor>): EndpointGateways; } export interface EndpointGatewaysCreate extends Endpoint> { /** List of gateway ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointGatewaysModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointGatewaysCreate; data(v: Array): EndpointGatewaysCreate; extract(v: Extractor>): EndpointGatewaysCreate; } export interface EndpointGatewaysModify extends Endpoint> { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointGatewaysModify; data(v: Array): EndpointGatewaysModify; extract(v: Extractor>): EndpointGatewaysModify; } export interface EndpointGatewaysApplePayDomainsDelete extends Endpoint { /** List of domain ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointGatewaysApplePayDomainsDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointGatewaysApplePayDomainsDelete; } export interface EndpointGatewaysApplePayDomains extends Endpoint> { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointGatewaysApplePayDomains; extract(v: Extractor>): EndpointGatewaysApplePayDomains; } export interface EndpointGatewaysApplePayDomainsCreate extends Endpoint> { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointGatewaysApplePayDomainsCreate; data(v: Array): EndpointGatewaysApplePayDomainsCreate; extract(v: Extractor>): EndpointGatewaysApplePayDomainsCreate; } export interface EndpointGatewaysPaypal extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointGatewaysPaypal; /** Whether to use sandbox API */ test(v: boolean): EndpointGatewaysPaypal; extract(v: Extractor): EndpointGatewaysPaypal; } export interface EndpointInfoAllProvinces extends Endpoint> { extract(v: Extractor>): EndpointInfoAllProvinces; } export interface EndpointInfoCarrierPackaging extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointInfoCarrierPackaging; extract(v: Extractor>): EndpointInfoCarrierPackaging; } export interface EndpointInfoContentModels extends Endpoint> { extract(v: Extractor>): EndpointInfoContentModels; } export interface EndpointInfoCountries extends Endpoint> { extract(v: Extractor>): EndpointInfoCountries; } export interface EndpointInfoCsvFormat extends Endpoint { /** Name of the format to return */ name(v: string): EndpointInfoCsvFormat; extract(v: Extractor): EndpointInfoCsvFormat; } export interface EndpointInfoCurrencies extends Endpoint> { extract(v: Extractor>): EndpointInfoCurrencies; } export interface EndpointInfoDataFeeds extends Endpoint { extract(v: Extractor): EndpointInfoDataFeeds; } export interface EndpointInfoHsCodes extends Endpoint { /** Output filtering */ fields(v: Array): EndpointInfoHsCodes; extract(v: Extractor): EndpointInfoHsCodes; } export interface EndpointInfoLanguages extends Endpoint> { extract(v: Extractor>): EndpointInfoLanguages; } export interface EndpointInfoMccCodes extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointInfoMccCodes; extract(v: Extractor>): EndpointInfoMccCodes; } export interface EndpointInfoPermissions extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointInfoPermissions; extract(v: Extractor>): EndpointInfoPermissions; } export interface EndpointInfoPlans extends Endpoint> { extract(v: Extractor>): EndpointInfoPlans; } export interface EndpointInfoProvinces extends Endpoint> { /** Country code */ country_code(v: string): EndpointInfoProvinces; extract(v: Extractor>): EndpointInfoProvinces; } export interface EndpointInfoRoles extends Endpoint> { extract(v: Extractor>): EndpointInfoRoles; } export interface EndpointInfoShippingProviders extends Endpoint> { extract(v: Extractor>): EndpointInfoShippingProviders; } export interface EndpointInfoTimezones extends Endpoint> { extract(v: Extractor>): EndpointInfoTimezones; } export interface EndpointInfoWebhooks extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointInfoWebhooks; extract(v: Extractor>): EndpointInfoWebhooks; } export interface EndpointInventoryLocations extends Endpoint> { /** Whether to include disabled inventory locations */ disabled(v: boolean): EndpointInventoryLocations; /** Output filtering */ fields(v: Array): EndpointInventoryLocations; /** List of inventory location ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointInventoryLocations; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointInventoryLocations; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointInventoryLocations; expand(v: InventoryLocationExpansionMap): EndpointInventoryLocations; extract(v: Extractor>): EndpointInventoryLocations; } export interface EndpointInventoryLocationsCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointInventoryLocationsCreate; /** List of inventory location ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointInventoryLocationsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointInventoryLocationsCreate; data(v: Array): EndpointInventoryLocationsCreate; expand(v: InventoryLocationExpansionMap): EndpointInventoryLocationsCreate; extract(v: Extractor>): EndpointInventoryLocationsCreate; } export interface EndpointInventoryLocationsModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointInventoryLocationsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointInventoryLocationsModify; data(v: Array): EndpointInventoryLocationsModify; expand(v: InventoryLocationExpansionMap): EndpointInventoryLocationsModify; extract(v: Extractor>): EndpointInventoryLocationsModify; } export interface EndpointInventoryLocationsExport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointInventoryLocationsExport; data(v: GenericExport): EndpointInventoryLocationsExport; expand(v: ForeignShardedTaskExpansionMap): EndpointInventoryLocationsExport; extract(v: Extractor): EndpointInventoryLocationsExport; } export interface EndpointInventoryLocationsImport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointInventoryLocationsImport; data(v: GenericImport): EndpointInventoryLocationsImport; expand(v: ForeignShardedTaskExpansionMap): EndpointInventoryLocationsImport; extract(v: Extractor): EndpointInventoryLocationsImport; } export interface EndpointInventoryLocationsMigrate extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointInventoryLocationsMigrate; data(v: InventoryLocationMigrate): EndpointInventoryLocationsMigrate; expand(v: ForeignShardedTaskExpansionMap): EndpointInventoryLocationsMigrate; extract(v: Extractor): EndpointInventoryLocationsMigrate; } export interface EndpointInventoryLocationsToggle extends Endpoint { /** Whether to enable or disable inventory cells */ enable(v: boolean): EndpointInventoryLocationsToggle; /** Unique inventory location identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ inventory_location_id(v: string): EndpointInventoryLocationsToggle; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointInventoryLocationsToggle; expand(v: ForeignShardedTaskExpansionMap): EndpointInventoryLocationsToggle; extract(v: Extractor): EndpointInventoryLocationsToggle; } export interface EndpointInventoryRulesDelete extends Endpoint { /** List of inventory rule ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointInventoryRulesDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointInventoryRulesDelete; } export interface EndpointInventoryRules extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointInventoryRules; /** List of inventory rule ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointInventoryRules; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointInventoryRules; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointInventoryRules; expand(v: InventoryRuleExpansionMap): EndpointInventoryRules; extract(v: Extractor>): EndpointInventoryRules; } export interface EndpointInventoryRulesCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointInventoryRulesCreate; /** List of inventory rule ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointInventoryRulesModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointInventoryRulesCreate; data(v: Array): EndpointInventoryRulesCreate; expand(v: InventoryRuleExpansionMap): EndpointInventoryRulesCreate; extract(v: Extractor>): EndpointInventoryRulesCreate; } export interface EndpointInventoryRulesModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointInventoryRulesModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointInventoryRulesModify; data(v: Array): EndpointInventoryRulesModify; expand(v: InventoryRuleExpansionMap): EndpointInventoryRulesModify; extract(v: Extractor>): EndpointInventoryRulesModify; } export interface EndpointInventoryRulesExport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointInventoryRulesExport; data(v: GenericExport): EndpointInventoryRulesExport; expand(v: ForeignShardedTaskExpansionMap): EndpointInventoryRulesExport; extract(v: Extractor): EndpointInventoryRulesExport; } export interface EndpointInventoryRulesImport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointInventoryRulesImport; data(v: GenericImport): EndpointInventoryRulesImport; expand(v: ForeignShardedTaskExpansionMap): EndpointInventoryRulesImport; extract(v: Extractor): EndpointInventoryRulesImport; } export interface EndpointInvitationsDelete extends Endpoint { /** List of invitation ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointInvitationsDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointInvitationsDelete; } export interface EndpointInvitations extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointInvitations; /** List of invitation ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointInvitations; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointInvitations; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointInvitations; expand(v: InvitationExpansionMap): EndpointInvitations; extract(v: Extractor>): EndpointInvitations; } export interface EndpointInvitationsCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointInvitationsCreate; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointInvitationsCreate; data(v: Array): EndpointInvitationsCreate; expand(v: InvitationExpansionMap): EndpointInvitationsCreate; extract(v: Extractor>): EndpointInvitationsCreate; } export interface EndpointInvitationsAccept extends Endpoint> { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ accept_shop_id(v: string): EndpointInvitationsAccept; /** Output filtering */ fields(v: Array): EndpointInvitationsAccept; /** List of invitation ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointInvitationsAccept; expand(v: InvitationExpansionMap): EndpointInvitationsAccept; extract(v: Extractor>): EndpointInvitationsAccept; } export interface EndpointInvoices extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointInvoices; /** List of invoice ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointInvoices; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointInvoices; extract(v: Extractor>): EndpointInvoices; } export interface EndpointInvoicesPage extends Endpoint { /** Output filtering */ fields(v: Array): EndpointInvoicesPage; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointInvoicesPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointInvoicesPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointInvoicesPage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointInvoicesPage; /** Filter invoices by type */ type(v: InvoiceType): EndpointInvoicesPage; extract(v: Extractor): EndpointInvoicesPage; } export interface EndpointKeysDelete extends Endpoint { /** List of key ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointKeysDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointKeysDelete; } export interface EndpointKeys extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointKeys; /** List of key ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointKeys; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointKeys; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointKeys; expand(v: KeyExpansionMap): EndpointKeys; extract(v: Extractor>): EndpointKeys; } export interface EndpointKeysCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointKeysCreate; /** List of key ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointKeysModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointKeysCreate; data(v: Array): EndpointKeysCreate; expand(v: KeyExpansionMap): EndpointKeysCreate; extract(v: Extractor>): EndpointKeysCreate; } export interface EndpointKeysModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointKeysModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointKeysModify; data(v: Array): EndpointKeysModify; expand(v: KeyExpansionMap): EndpointKeysModify; extract(v: Extractor>): EndpointKeysModify; } export interface EndpointMenusDelete extends Endpoint { /** List of menu ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointMenusDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointMenusDelete; } export interface EndpointMenus extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointMenus; /** List of menu ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointMenus; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointMenus; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointMenus; expand(v: MenuExpansionMap): EndpointMenus; extract(v: Extractor>): EndpointMenus; } export interface EndpointMenusCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointMenusCreate; /** List of menu ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointMenusModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointMenusCreate; data(v: Array): EndpointMenusCreate; expand(v: MenuExpansionMap): EndpointMenusCreate; extract(v: Extractor>): EndpointMenusCreate; } export interface EndpointMenusModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointMenusModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointMenusModify; data(v: Array): EndpointMenusModify; expand(v: MenuExpansionMap): EndpointMenusModify; extract(v: Extractor>): EndpointMenusModify; } export interface EndpointMenusExport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointMenusExport; data(v: GenericExport): EndpointMenusExport; expand(v: ForeignShardedTaskExpansionMap): EndpointMenusExport; extract(v: Extractor): EndpointMenusExport; } export interface EndpointMenusImport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointMenusImport; data(v: GenericImport): EndpointMenusImport; expand(v: ForeignShardedTaskExpansionMap): EndpointMenusImport; extract(v: Extractor): EndpointMenusImport; } export interface EndpointMenusPage extends Endpoint { /** Filter output by creation date, upper boundary */ created_at_max(v: string): EndpointMenusPage; /** Filter output by creation date, lower boundary */ created_at_min(v: string): EndpointMenusPage; /** Output filtering */ fields(v: Array): EndpointMenusPage; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointMenusPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointMenusPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointMenusPage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointMenusPage; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: MenusPageSortBy): EndpointMenusPage; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointMenusPage; /** Filter output by last update date, upper boundary */ updated_at_max(v: string): EndpointMenusPage; /** Filter output by last update date, lower boundary */ updated_at_min(v: string): EndpointMenusPage; expand(v: MenuPageExpansionMap): EndpointMenusPage; extract(v: Extractor): EndpointMenusPage; } export interface EndpointMessage extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointMessage; /** List of message ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointMessage; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointMessage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointMessage; extract(v: Extractor>): EndpointMessage; } export interface EndpointMessage extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointMessage; /** List of message ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointMessage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointMessage; extract(v: Extractor>): EndpointMessage; } export interface EndpointOptionSetsDelete extends Endpoint { /** List of option set ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointOptionSetsDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOptionSetsDelete; } export interface EndpointOptionSets extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointOptionSets; /** List of option set ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointOptionSets; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointOptionSets; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOptionSets; extract(v: Extractor>): EndpointOptionSets; } export interface EndpointOptionSetsCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointOptionSetsCreate; /** List of option set ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointOptionSetsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOptionSetsCreate; data(v: Array): EndpointOptionSetsCreate; extract(v: Extractor>): EndpointOptionSetsCreate; } export interface EndpointOptionSetsModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointOptionSetsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOptionSetsModify; data(v: Array): EndpointOptionSetsModify; extract(v: Extractor>): EndpointOptionSetsModify; } export interface EndpointOptionSetsExport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOptionSetsExport; data(v: GenericExport): EndpointOptionSetsExport; expand(v: ForeignShardedTaskExpansionMap): EndpointOptionSetsExport; extract(v: Extractor): EndpointOptionSetsExport; } export interface EndpointOptionSetsImport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOptionSetsImport; data(v: GenericImport): EndpointOptionSetsImport; expand(v: ForeignShardedTaskExpansionMap): EndpointOptionSetsImport; extract(v: Extractor): EndpointOptionSetsImport; } export interface EndpointOptionsDelete extends Endpoint { /** List of option ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointOptionsDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOptionsDelete; } export interface EndpointOptions extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointOptions; /** List of option ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointOptions; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointOptions; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOptions; extract(v: Extractor>): EndpointOptions; } export interface EndpointOptionsCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointOptionsCreate; /** List of option ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointOptionsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOptionsCreate; data(v: Array): EndpointOptionsCreate; extract(v: Extractor>): EndpointOptionsCreate; } export interface EndpointOptionsModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointOptionsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOptionsModify; data(v: Array): EndpointOptionsModify; extract(v: Extractor>): EndpointOptionsModify; } export interface EndpointOptionsExport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOptionsExport; data(v: GenericExport): EndpointOptionsExport; expand(v: ForeignShardedTaskExpansionMap): EndpointOptionsExport; extract(v: Extractor): EndpointOptionsExport; } export interface EndpointOptionsImport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOptionsImport; data(v: GenericImport): EndpointOptionsImport; expand(v: ForeignShardedTaskExpansionMap): EndpointOptionsImport; extract(v: Extractor): EndpointOptionsImport; } export interface EndpointOrderFulfillments extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointOrderFulfillments; /** List of fulfillment ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointOrderFulfillments; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointOrderFulfillments; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointOrderFulfillments; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrderFulfillments; expand(v: OrderFulfillmentExpansionMap): EndpointOrderFulfillments; extract(v: Extractor>): EndpointOrderFulfillments; } export interface EndpointOrderFulfillmentsCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointOrderFulfillmentsCreate; /** List of fulfillment ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointOrderFulfillmentsModify; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointOrderFulfillmentsCreate; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrderFulfillmentsCreate; /** When automatically creating a fulfillment, use only items from given category */ type(v: FulfillmentType): EndpointOrderFulfillmentsCreate; data(v: Array): EndpointOrderFulfillmentsCreate; expand(v: OrderFulfillmentExpansionMap): EndpointOrderFulfillmentsCreate; extract(v: Extractor>): EndpointOrderFulfillmentsCreate; } export interface EndpointOrderFulfillmentsModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointOrderFulfillmentsModify; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointOrderFulfillmentsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrderFulfillmentsModify; /** When automatically creating a fulfillment, use only items from given category */ type(v: FulfillmentType): EndpointOrderFulfillmentsModify; data(v: Array): EndpointOrderFulfillmentsModify; expand(v: OrderFulfillmentExpansionMap): EndpointOrderFulfillmentsModify; extract(v: Extractor>): EndpointOrderFulfillmentsModify; } export interface EndpointOrderFulfillmentsCancel extends Endpoint { /** Output filtering */ fields(v: Array): EndpointOrderFulfillmentsCancel; /** Unique order fulfillment identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ fulfillment_id(v: string): EndpointOrderFulfillmentsCancel; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointOrderFulfillmentsCancel; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrderFulfillmentsCancel; expand(v: OrderFulfillmentExpansionMap): EndpointOrderFulfillmentsCancel; extract(v: Extractor): EndpointOrderFulfillmentsCancel; } export interface EndpointOrderFulfillmentsComplete extends Endpoint { /** Output filtering */ fields(v: Array): EndpointOrderFulfillmentsComplete; /** Unique order fulfillment identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ fulfillment_id(v: string): EndpointOrderFulfillmentsComplete; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointOrderFulfillmentsComplete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrderFulfillmentsComplete; expand(v: OrderFulfillmentExpansionMap): EndpointOrderFulfillmentsComplete; extract(v: Extractor): EndpointOrderFulfillmentsComplete; } export interface EndpointOrderFulfillmentsEventsCreate extends Endpoint { /** Output filtering */ fields(v: Array): EndpointOrderFulfillmentsEventsCreate; /** Unique order fulfillment identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ fulfillment_id(v: string): EndpointOrderFulfillmentsEventsCreate; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointOrderFulfillmentsEventsCreate; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrderFulfillmentsEventsCreate; data(v: Array): EndpointOrderFulfillmentsEventsCreate; expand(v: OrderFulfillmentExpansionMap): EndpointOrderFulfillmentsEventsCreate; extract(v: Extractor): EndpointOrderFulfillmentsEventsCreate; } export interface EndpointOrderNotesDelete extends Endpoint { /** List of order note ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointOrderNotesDelete; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointOrderNotesDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrderNotesDelete; } export interface EndpointOrderNotes extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointOrderNotes; /** List of order note ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointOrderNotes; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointOrderNotes; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrderNotes; expand(v: NoteExpansionMap): EndpointOrderNotes; extract(v: Extractor>): EndpointOrderNotes; } export interface EndpointOrderNotesCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointOrderNotesCreate; /** List of order note ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointOrderNotesModify; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointOrderNotesCreate; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrderNotesCreate; data(v: Array): EndpointOrderNotesCreate; expand(v: NoteExpansionMap): EndpointOrderNotesCreate; extract(v: Extractor>): EndpointOrderNotesCreate; } export interface EndpointOrderNotesModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointOrderNotesModify; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointOrderNotesModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrderNotesModify; data(v: Array): EndpointOrderNotesModify; expand(v: NoteExpansionMap): EndpointOrderNotesModify; extract(v: Extractor>): EndpointOrderNotesModify; } export interface EndpointOrderRisksDelete extends Endpoint { /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointOrderRisksDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrderRisksDelete; } export interface EndpointOrderRisks extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointOrderRisks; /** List of order ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointOrderRisks; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointOrderRisks; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrderRisks; extract(v: Extractor>): EndpointOrderRisks; } export interface EndpointOrderRisksCreate extends Endpoint { /** Output filtering */ fields(v: Array): EndpointOrderRisksCreate; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointOrderRisksCreate; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrderRisksCreate; data(v: OrderRiskCreate): EndpointOrderRisksCreate; extract(v: Extractor): EndpointOrderRisksCreate; } export interface EndpointOrdersDelete extends Endpoint { /** List of order ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointOrdersDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrdersDelete; } export interface EndpointOrders extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointOrders; /** List of order ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointOrders; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointOrders; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrders; uuid(v: string): EndpointOrders; expand(v: OrderExpansionMap): EndpointOrders; extract(v: Extractor>): EndpointOrders; } export interface EndpointOrdersCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointOrdersCreate; /** List of order ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointOrdersModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrdersCreate; updated_at(v: string): EndpointOrdersCreate; uuid(v: string): EndpointOrdersCreate; data(v: Array): EndpointOrdersCreate; expand(v: OrderExpansionMap): EndpointOrdersCreate; extract(v: Extractor>): EndpointOrdersCreate; } export interface EndpointOrdersModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointOrdersModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrdersModify; updated_at(v: string): EndpointOrdersModify; uuid(v: string): EndpointOrdersModify; data(v: Array): EndpointOrdersModify; expand(v: OrderExpansionMap): EndpointOrdersModify; extract(v: Extractor>): EndpointOrdersModify; } export interface EndpointOrdersAllocateNumber extends Endpoint { /** Output filtering */ fields(v: Array): EndpointOrdersAllocateNumber; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointOrdersAllocateNumber; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrdersAllocateNumber; uuid(v: string): EndpointOrdersAllocateNumber; expand(v: OrderExpansionMap): EndpointOrdersAllocateNumber; extract(v: Extractor): EndpointOrdersAllocateNumber; } export interface EndpointOrdersCalculate extends Endpoint { /** Output filtering */ fields(v: Array): EndpointOrdersCalculate; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointOrdersCalculate; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrdersCalculate; uuid(v: string): EndpointOrdersCalculate; expand(v: OrderExpansionMap): EndpointOrdersCalculate; extract(v: Extractor): EndpointOrdersCalculate; } export interface EndpointOrdersCalculateRefund extends Endpoint { /** Output filtering */ fields(v: Array): EndpointOrdersCalculateRefund; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointOrdersCalculateRefund; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrdersCalculateRefund; data(v: OrderRefund | null): EndpointOrdersCalculateRefund; extract(v: Extractor): EndpointOrdersCalculateRefund; } export interface EndpointOrdersCancel extends Endpoint { /** Output filtering */ fields(v: Array): EndpointOrdersCancel; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointOrdersCancel; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrdersCancel; data(v: OrderCancel): EndpointOrdersCancel; expand(v: OrderExpansionMap): EndpointOrdersCancel; extract(v: Extractor): EndpointOrdersCancel; } export interface EndpointOrdersCancelReservation extends Endpoint { /** Output filtering */ fields(v: Array): EndpointOrdersCancelReservation; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointOrdersCancelReservation; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrdersCancelReservation; uuid(v: string): EndpointOrdersCancelReservation; expand(v: OrderExpansionMap): EndpointOrdersCancelReservation; extract(v: Extractor): EndpointOrdersCancelReservation; } export interface EndpointOrdersCapture extends Endpoint { /** Output filtering */ fields(v: Array): EndpointOrdersCapture; /** Force capture (marks order as captured without performing a transaction) */ force(v: boolean): EndpointOrdersCapture; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointOrdersCapture; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrdersCapture; expand(v: OrderExpansionMap): EndpointOrdersCapture; extract(v: Extractor): EndpointOrdersCapture; } export interface EndpointOrdersClose extends Endpoint { /** Output filtering */ fields(v: Array): EndpointOrdersClose; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointOrdersClose; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrdersClose; } export interface EndpointOrdersDownload extends Endpoint { /** Unique customer inventory item identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ customer_inventory_id(v: string): EndpointOrdersDownload; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointOrdersDownload; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrdersDownload; uuid(v: string): EndpointOrdersDownload; extract(v: Extractor): EndpointOrdersDownload; } export interface EndpointOrdersExport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrdersExport; data(v: GenericExport): EndpointOrdersExport; expand(v: ForeignShardedTaskExpansionMap): EndpointOrdersExport; extract(v: Extractor): EndpointOrdersExport; } export interface EndpointOrdersOpen extends Endpoint { /** Output filtering */ fields(v: Array): EndpointOrdersOpen; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointOrdersOpen; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrdersOpen; } export interface EndpointOrdersOverride extends Endpoint { /** Output filtering */ fields(v: Array): EndpointOrdersOverride; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointOrdersOverride; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrdersOverride; uuid(v: string): EndpointOrdersOverride; data(v: OrderOverride): EndpointOrdersOverride; expand(v: OrderExpansionMap): EndpointOrdersOverride; extract(v: Extractor): EndpointOrdersOverride; } export interface EndpointOrdersPage extends Endpoint { /** Include only cart orders or otherwise only full orders */ cart(v: boolean): EndpointOrdersPage; /** Filter output by creation date, upper boundary */ created_at_max(v: string): EndpointOrdersPage; /** Filter output by creation date, lower boundary */ created_at_min(v: string): EndpointOrdersPage; /** Filter output by customer */ customer_id(v: string): EndpointOrdersPage; /** Output filtering */ fields(v: Array): EndpointOrdersPage; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointOrdersPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointOrdersPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointOrdersPage; /** Filter output by payment date, upper boundary */ paid_at_max(v: string): EndpointOrdersPage; /** Filter output by payment date, lower boundary */ paid_at_min(v: string): EndpointOrdersPage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrdersPage; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: OrdersPageSortBy): EndpointOrdersPage; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointOrdersPage; /** Filter output by subscription */ subscription_id(v: string): EndpointOrdersPage; /** Filter output by order type */ type(v: OrderType): EndpointOrdersPage; /** Filter output by last update date, upper boundary */ updated_at_max(v: string): EndpointOrdersPage; /** Filter output by last update date, lower boundary */ updated_at_min(v: string): EndpointOrdersPage; expand(v: OrderPageExpansionMap): EndpointOrdersPage; extract(v: Extractor): EndpointOrdersPage; } export interface EndpointOrdersPay extends Endpoint { /** Output filtering */ fields(v: Array): EndpointOrdersPay; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointOrdersPay; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrdersPay; uuid(v: string): EndpointOrdersPay; data(v: OrderPayment): EndpointOrdersPay; expand(v: OrderExpansionMap): EndpointOrdersPay; extract(v: Extractor): EndpointOrdersPay; } export interface EndpointOrdersRefund extends Endpoint { /** Output filtering */ fields(v: Array): EndpointOrdersRefund; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointOrdersRefund; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrdersRefund; data(v: OrderRefund | null): EndpointOrdersRefund; expand(v: OrderExpansionMap): EndpointOrdersRefund; extract(v: Extractor): EndpointOrdersRefund; } export interface EndpointOrdersReserve extends Endpoint { /** Output filtering */ fields(v: Array): EndpointOrdersReserve; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointOrdersReserve; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrdersReserve; uuid(v: string): EndpointOrdersReserve; expand(v: OrderExpansionMap): EndpointOrdersReserve; extract(v: Extractor): EndpointOrdersReserve; } export interface EndpointOrdersRestock extends Endpoint { /** Output filtering */ fields(v: Array): EndpointOrdersRestock; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointOrdersRestock; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrdersRestock; data(v: OrderRestock): EndpointOrdersRestock; expand(v: OrderExpansionMap): EndpointOrdersRestock; extract(v: Extractor): EndpointOrdersRestock; } export interface EndpointOrdersSendInvoice extends Endpoint { due_date(v: string): EndpointOrdersSendInvoice; /** Output filtering */ fields(v: Array): EndpointOrdersSendInvoice; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointOrdersSendInvoice; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrdersSendInvoice; uuid(v: string): EndpointOrdersSendInvoice; expand(v: OrderExpansionMap): EndpointOrdersSendInvoice; extract(v: Extractor): EndpointOrdersSendInvoice; } export interface EndpointOrdersSendReminder extends Endpoint { /** Output filtering */ fields(v: Array): EndpointOrdersSendReminder; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointOrdersSendReminder; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointOrdersSendReminder; uuid(v: string): EndpointOrdersSendReminder; expand(v: OrderExpansionMap): EndpointOrdersSendReminder; extract(v: Extractor): EndpointOrdersSendReminder; } export interface EndpointPackagingDelete extends Endpoint { /** Output filtering */ fields(v: Array): EndpointPackagingDelete; /** List of packaging ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointPackagingDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPackagingDelete; } export interface EndpointPackaging extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointPackaging; /** List of packaging ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointPackaging; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointPackaging; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPackaging; expand(v: PackagingExpansionMap): EndpointPackaging; extract(v: Extractor>): EndpointPackaging; } export interface EndpointPackagingCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointPackagingCreate; /** List of packaging ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointPackagingModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPackagingCreate; data(v: Array): EndpointPackagingCreate; expand(v: PackagingExpansionMap): EndpointPackagingCreate; extract(v: Extractor>): EndpointPackagingCreate; } export interface EndpointPackagingModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointPackagingModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPackagingModify; data(v: Array): EndpointPackagingModify; expand(v: PackagingExpansionMap): EndpointPackagingModify; extract(v: Extractor>): EndpointPackagingModify; } export interface EndpointPackagingExport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPackagingExport; data(v: GenericExport): EndpointPackagingExport; expand(v: ForeignShardedTaskExpansionMap): EndpointPackagingExport; extract(v: Extractor): EndpointPackagingExport; } export interface EndpointPackagingImport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPackagingImport; data(v: GenericImport): EndpointPackagingImport; expand(v: ForeignShardedTaskExpansionMap): EndpointPackagingImport; extract(v: Extractor): EndpointPackagingImport; } export interface EndpointPaymentMethodsDelete extends Endpoint { /** List of payment method ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointPaymentMethodsDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPaymentMethodsDelete; } export interface EndpointPaymentMethods extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointPaymentMethods; /** List of payment method ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointPaymentMethods; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointPaymentMethods; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPaymentMethods; expand(v: PaymentMethodExpansionMap): EndpointPaymentMethods; extract(v: Extractor>): EndpointPaymentMethods; } export interface EndpointPaymentMethodsCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointPaymentMethodsCreate; /** List of payment method ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointPaymentMethodsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPaymentMethodsCreate; data(v: Array): EndpointPaymentMethodsCreate; expand(v: PaymentMethodExpansionMap): EndpointPaymentMethodsCreate; extract(v: Extractor>): EndpointPaymentMethodsCreate; } export interface EndpointPaymentMethodsModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointPaymentMethodsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPaymentMethodsModify; data(v: Array): EndpointPaymentMethodsModify; expand(v: PaymentMethodExpansionMap): EndpointPaymentMethodsModify; extract(v: Extractor>): EndpointPaymentMethodsModify; } export interface EndpointPlan extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPlan; extract(v: Extractor): EndpointPlan; } export interface EndpointPlanCreate extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPlanCreate; data(v: PlanCreate): EndpointPlanCreate; } export interface EndpointPlanConfirm extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPlanConfirm; } export interface EndpointPlanPreview extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPlanPreview; data(v: PlanPreview): EndpointPlanPreview; extract(v: Extractor): EndpointPlanPreview; } export interface EndpointProductFieldSetsDelete extends Endpoint { /** List of product field set ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointProductFieldSetsDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductFieldSetsDelete; } export interface EndpointProductFieldSets extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointProductFieldSets; /** List of product field set ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointProductFieldSets; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointProductFieldSets; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductFieldSets; extract(v: Extractor>): EndpointProductFieldSets; } export interface EndpointProductFieldSetsCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointProductFieldSetsCreate; /** List of product field set ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointProductFieldSetsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductFieldSetsCreate; data(v: Array): EndpointProductFieldSetsCreate; extract(v: Extractor>): EndpointProductFieldSetsCreate; } export interface EndpointProductFieldSetsModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointProductFieldSetsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductFieldSetsModify; data(v: Array): EndpointProductFieldSetsModify; extract(v: Extractor>): EndpointProductFieldSetsModify; } export interface EndpointProductFieldSetsExport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductFieldSetsExport; data(v: GenericExport): EndpointProductFieldSetsExport; expand(v: ForeignShardedTaskExpansionMap): EndpointProductFieldSetsExport; extract(v: Extractor): EndpointProductFieldSetsExport; } export interface EndpointProductFieldSetsImport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductFieldSetsImport; data(v: GenericImport): EndpointProductFieldSetsImport; expand(v: ForeignShardedTaskExpansionMap): EndpointProductFieldSetsImport; extract(v: Extractor): EndpointProductFieldSetsImport; } export interface EndpointProductQuestionsDelete extends Endpoint { /** List of product question ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointProductQuestionsDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductQuestionsDelete; } export interface EndpointProductQuestions extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointProductQuestions; /** List of product question ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointProductQuestions; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointProductQuestions; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductQuestions; expand(v: ProductQuestionExpansionMap): EndpointProductQuestions; extract(v: Extractor>): EndpointProductQuestions; } export interface EndpointProductQuestionsCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointProductQuestionsCreate; /** List of product question ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointProductQuestionsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductQuestionsCreate; data(v: Array): EndpointProductQuestionsCreate; expand(v: ProductQuestionExpansionMap): EndpointProductQuestionsCreate; extract(v: Extractor>): EndpointProductQuestionsCreate; } export interface EndpointProductQuestionsModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointProductQuestionsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductQuestionsModify; data(v: Array): EndpointProductQuestionsModify; expand(v: ProductQuestionExpansionMap): EndpointProductQuestionsModify; extract(v: Extractor>): EndpointProductQuestionsModify; } export interface EndpointProductQuestionsAnswersDelete extends Endpoint { /** Output filtering */ fields(v: Array): EndpointProductQuestionsAnswersDelete; /** List of product question answer ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointProductQuestionsAnswersDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductQuestionsAnswersDelete; } export interface EndpointProductQuestionsAnswers extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointProductQuestionsAnswers; /** List of product question answer ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointProductQuestionsAnswers; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointProductQuestionsAnswers; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductQuestionsAnswers; expand(v: ProductQuestionAnswerExpansionMap): EndpointProductQuestionsAnswers; extract(v: Extractor>): EndpointProductQuestionsAnswers; } export interface EndpointProductQuestionsAnswersCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointProductQuestionsAnswersCreate; /** List of product question answer ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointProductQuestionsAnswersModify; /** Subject question identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ question_id(v: string): EndpointProductQuestionsAnswersCreate; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductQuestionsAnswersCreate; data(v: Array): EndpointProductQuestionsAnswersCreate; expand(v: ProductQuestionAnswerExpansionMap): EndpointProductQuestionsAnswersCreate; extract(v: Extractor>): EndpointProductQuestionsAnswersCreate; } export interface EndpointProductQuestionsAnswersModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointProductQuestionsAnswersModify; /** Subject question identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ question_id(v: string): EndpointProductQuestionsAnswersModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductQuestionsAnswersModify; data(v: Array): EndpointProductQuestionsAnswersModify; expand(v: ProductQuestionAnswerExpansionMap): EndpointProductQuestionsAnswersModify; extract(v: Extractor>): EndpointProductQuestionsAnswersModify; } export interface EndpointProductQuestionsAnswersPage extends Endpoint { /** Filter output by customer */ customer_id(v: string): EndpointProductQuestionsAnswersPage; /** Output filtering */ fields(v: Array): EndpointProductQuestionsAnswersPage; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointProductQuestionsAnswersPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointProductQuestionsAnswersPage; /** Filter by flag count (inclusive) */ min_flag_count(v: number): EndpointProductQuestionsAnswersPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointProductQuestionsAnswersPage; /** Filter output by product */ product_id(v: string): EndpointProductQuestionsAnswersPage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductQuestionsAnswersPage; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: ProductQuestionsAnswersPageSortBy): EndpointProductQuestionsAnswersPage; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointProductQuestionsAnswersPage; /** Publishing approval status */ status(v: ApprovalStatus): EndpointProductQuestionsAnswersPage; expand(v: ProductQuestionAnswerPageExpansionMap): EndpointProductQuestionsAnswersPage; extract(v: Extractor): EndpointProductQuestionsAnswersPage; } export interface EndpointProductQuestionsPage extends Endpoint { /** Filter output by customer */ customer_id(v: string): EndpointProductQuestionsPage; /** Output filtering */ fields(v: Array): EndpointProductQuestionsPage; /** Filter output by language */ language(v: string): EndpointProductQuestionsPage; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointProductQuestionsPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointProductQuestionsPage; /** Filter by flag count (inclusive) */ min_flag_count(v: number): EndpointProductQuestionsPage; /** Filter output by customer (negative) */ not_customer_id(v: string): EndpointProductQuestionsPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointProductQuestionsPage; /** Filter output by product */ product_id(v: string): EndpointProductQuestionsPage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductQuestionsPage; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: ProductQuestionsPageSortBy): EndpointProductQuestionsPage; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointProductQuestionsPage; /** Publishing approval status */ status(v: ApprovalStatus): EndpointProductQuestionsPage; expand(v: ProductQuestionPageExpansionMap): EndpointProductQuestionsPage; extract(v: Extractor): EndpointProductQuestionsPage; } export interface EndpointProductReviewsDelete extends Endpoint { /** List of product review ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointProductReviewsDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductReviewsDelete; } export interface EndpointProductReviews extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointProductReviews; /** List of product review ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointProductReviews; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointProductReviews; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductReviews; expand(v: ProductReviewExpansionMap): EndpointProductReviews; extract(v: Extractor>): EndpointProductReviews; } export interface EndpointProductReviewsCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointProductReviewsCreate; /** List of product review ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointProductReviewsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductReviewsCreate; data(v: Array): EndpointProductReviewsCreate; expand(v: ProductReviewExpansionMap): EndpointProductReviewsCreate; extract(v: Extractor>): EndpointProductReviewsCreate; } export interface EndpointProductReviewsModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointProductReviewsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductReviewsModify; data(v: Array): EndpointProductReviewsModify; expand(v: ProductReviewExpansionMap): EndpointProductReviewsModify; extract(v: Extractor>): EndpointProductReviewsModify; } export interface EndpointProductReviewsAnswersDelete extends Endpoint { /** Output filtering */ fields(v: Array): EndpointProductReviewsAnswersDelete; /** List of product review answer ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointProductReviewsAnswersDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductReviewsAnswersDelete; } export interface EndpointProductReviewsAnswers extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointProductReviewsAnswers; /** List of product review answer ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointProductReviewsAnswers; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointProductReviewsAnswers; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductReviewsAnswers; expand(v: ProductReviewAnswerExpansionMap): EndpointProductReviewsAnswers; extract(v: Extractor>): EndpointProductReviewsAnswers; } export interface EndpointProductReviewsAnswersCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointProductReviewsAnswersCreate; /** List of product review answer ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointProductReviewsAnswersModify; /** Subject review identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ review_id(v: string): EndpointProductReviewsAnswersCreate; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductReviewsAnswersCreate; data(v: Array): EndpointProductReviewsAnswersCreate; expand(v: ProductReviewAnswerExpansionMap): EndpointProductReviewsAnswersCreate; extract(v: Extractor>): EndpointProductReviewsAnswersCreate; } export interface EndpointProductReviewsAnswersModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointProductReviewsAnswersModify; /** Subject review identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ review_id(v: string): EndpointProductReviewsAnswersModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductReviewsAnswersModify; data(v: Array): EndpointProductReviewsAnswersModify; expand(v: ProductReviewAnswerExpansionMap): EndpointProductReviewsAnswersModify; extract(v: Extractor>): EndpointProductReviewsAnswersModify; } export interface EndpointProductReviewsAnswersPage extends Endpoint { /** Output filtering */ fields(v: Array): EndpointProductReviewsAnswersPage; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointProductReviewsAnswersPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointProductReviewsAnswersPage; /** Filter by flag count (inclusive) */ min_flag_count(v: number): EndpointProductReviewsAnswersPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointProductReviewsAnswersPage; /** Filter output by product */ product_id(v: string): EndpointProductReviewsAnswersPage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductReviewsAnswersPage; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: ProductReviewsAnswersPageSortBy): EndpointProductReviewsAnswersPage; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointProductReviewsAnswersPage; /** Publishing approval status */ status(v: ApprovalStatus): EndpointProductReviewsAnswersPage; expand(v: ProductReviewAnswerPageExpansionMap): EndpointProductReviewsAnswersPage; extract(v: Extractor): EndpointProductReviewsAnswersPage; } export interface EndpointProductReviewsPage extends Endpoint { /** Filter output by customer */ customer_id(v: string): EndpointProductReviewsPage; /** Output filtering */ fields(v: Array): EndpointProductReviewsPage; /** Filter output by language */ language(v: string): EndpointProductReviewsPage; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointProductReviewsPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointProductReviewsPage; /** Filter by flag count (inclusive) */ min_flag_count(v: number): EndpointProductReviewsPage; /** Filter output by customer (negative) */ not_customer_id(v: string): EndpointProductReviewsPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointProductReviewsPage; /** Filter output by product */ product_id(v: string): EndpointProductReviewsPage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductReviewsPage; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: ProductReviewsPageSortBy): EndpointProductReviewsPage; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointProductReviewsPage; /** Publishing approval status */ status(v: ApprovalStatus): EndpointProductReviewsPage; expand(v: ProductReviewPageExpansionMap): EndpointProductReviewsPage; extract(v: Extractor): EndpointProductReviewsPage; } export interface EndpointProductReviewsSettings extends Endpoint { /** Output filtering */ fields(v: Array): EndpointProductReviewsSettings; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductReviewsSettings; expand(v: ReviewSettingsExpansionMap): EndpointProductReviewsSettings; extract(v: Extractor): EndpointProductReviewsSettings; } export interface EndpointProductReviewsSettingsCreate extends Endpoint { /** Output filtering */ fields(v: Array): EndpointProductReviewsSettingsCreate; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductReviewsSettingsCreate; data(v: ReviewSettingsCreate): EndpointProductReviewsSettingsCreate; expand(v: ReviewSettingsExpansionMap): EndpointProductReviewsSettingsCreate; extract(v: Extractor): EndpointProductReviewsSettingsCreate; } export interface EndpointProductVariantsDelete extends Endpoint { /** List of product variant ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointProductVariantsDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductVariantsDelete; } export interface EndpointProductVariants extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointProductVariants; /** List of product variant ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointProductVariants; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointProductVariants; /** Unique product identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ product_id(v: string): EndpointProductVariants; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductVariants; expand(v: ProductVariantExpansionMap): EndpointProductVariants; extract(v: Extractor>): EndpointProductVariants; } export interface EndpointProductVariantsCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointProductVariantsCreate; /** List of product variant ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointProductVariantsModify; /** Unique product identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ product_id(v: string): EndpointProductVariantsCreate; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductVariantsCreate; data(v: Array): EndpointProductVariantsCreate; expand(v: ProductVariantExpansionMap): EndpointProductVariantsCreate; extract(v: Extractor>): EndpointProductVariantsCreate; } export interface EndpointProductVariantsModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointProductVariantsModify; /** Unique product identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ product_id(v: string): EndpointProductVariantsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductVariantsModify; data(v: Array): EndpointProductVariantsModify; expand(v: ProductVariantExpansionMap): EndpointProductVariantsModify; extract(v: Extractor>): EndpointProductVariantsModify; } export interface EndpointProductVariantsPage extends Endpoint { /** Output filtering */ fields(v: Array): EndpointProductVariantsPage; /** Ignore bundle type variants */ ignore_bundles(v: boolean): EndpointProductVariantsPage; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointProductVariantsPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointProductVariantsPage; /** Show only variants which have no inventory entry */ no_inventory(v: boolean): EndpointProductVariantsPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointProductVariantsPage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductVariantsPage; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: ProductVariantsPageSortBy): EndpointProductVariantsPage; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointProductVariantsPage; expand(v: ProductVariantPageExpansionMap): EndpointProductVariantsPage; extract(v: Extractor): EndpointProductVariantsPage; } export interface EndpointProductsDelete extends Endpoint { /** List of product ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointProductsDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductsDelete; } export interface EndpointProducts extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointProducts; /** List of product ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointProducts; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointProducts; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProducts; expand(v: ProductExpansionMap): EndpointProducts; extract(v: Extractor>): EndpointProducts; } export interface EndpointProductsCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointProductsCreate; /** List of product ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointProductsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductsCreate; data(v: Array): EndpointProductsCreate; expand(v: ProductExpansionMap): EndpointProductsCreate; extract(v: Extractor>): EndpointProductsCreate; } export interface EndpointProductsModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointProductsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductsModify; data(v: Array): EndpointProductsModify; expand(v: ProductExpansionMap): EndpointProductsModify; extract(v: Extractor>): EndpointProductsModify; } export interface EndpointProductsExport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductsExport; data(v: GenericExport): EndpointProductsExport; expand(v: ForeignShardedTaskExpansionMap): EndpointProductsExport; extract(v: Extractor): EndpointProductsExport; } export interface EndpointProductsImport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductsImport; data(v: GenericImport): EndpointProductsImport; expand(v: ForeignShardedTaskExpansionMap): EndpointProductsImport; extract(v: Extractor): EndpointProductsImport; } export interface EndpointProductsPage extends Endpoint { /** Filter output by brand */ brand_id(v: string): EndpointProductsPage; /** Filter output by product category */ category_id(v: string): EndpointProductsPage; /** Filter output by creation date, upper boundary */ created_at_max(v: string): EndpointProductsPage; /** Filter output by creation date, lower boundary */ created_at_min(v: string): EndpointProductsPage; /** Output filtering */ fields(v: Array): EndpointProductsPage; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointProductsPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointProductsPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointProductsPage; /** Filter output by publication date, upper boundary */ published_at_max(v: string): EndpointProductsPage; /** Filter output by publication date, lower boundary */ published_at_min(v: string): EndpointProductsPage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProductsPage; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: ProductsPageSortBy): EndpointProductsPage; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointProductsPage; /** Filter output by published status */ status(v: PublishedStatus): EndpointProductsPage; /** Filter output by last update date, upper boundary */ updated_at_max(v: string): EndpointProductsPage; /** Filter output by last update date, lower boundary */ updated_at_min(v: string): EndpointProductsPage; expand(v: ProductPageExpansionMap): EndpointProductsPage; extract(v: Extractor): EndpointProductsPage; } export interface EndpointPromotionsDelete extends Endpoint { /** List of promotion ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointPromotionsDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPromotionsDelete; } export interface EndpointPromotions extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointPromotions; /** Use flat output format instead of a recursive one */ flat(v: boolean): EndpointPromotions; /** List of promotion ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointPromotions; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointPromotions; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPromotions; expand(v: PromotionExpansionMap): EndpointPromotions; extract(v: Extractor>): EndpointPromotions; } export interface EndpointPromotionsCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointPromotionsCreate; /** Use flat output format instead of a recursive one */ flat(v: boolean): EndpointPromotionsCreate; /** List of promotion ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointPromotionsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPromotionsCreate; data(v: Array): EndpointPromotionsCreate; expand(v: PromotionExpansionMap): EndpointPromotionsCreate; extract(v: Extractor>): EndpointPromotionsCreate; } export interface EndpointPromotionsModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointPromotionsModify; /** Use flat output format instead of a recursive one */ flat(v: boolean): EndpointPromotionsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPromotionsModify; data(v: Array): EndpointPromotionsModify; expand(v: PromotionExpansionMap): EndpointPromotionsModify; extract(v: Extractor>): EndpointPromotionsModify; } export interface EndpointPromotionsExport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPromotionsExport; data(v: GenericExport): EndpointPromotionsExport; expand(v: ForeignShardedTaskExpansionMap): EndpointPromotionsExport; extract(v: Extractor): EndpointPromotionsExport; } export interface EndpointPromotionsImport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPromotionsImport; data(v: GenericImport): EndpointPromotionsImport; expand(v: ForeignShardedTaskExpansionMap): EndpointPromotionsImport; extract(v: Extractor): EndpointPromotionsImport; } export interface EndpointPromotionsPage extends Endpoint { /** Filter output by creation date, upper boundary */ created_at_max(v: string): EndpointPromotionsPage; /** Filter output by creation date, lower boundary */ created_at_min(v: string): EndpointPromotionsPage; /** Output filtering */ fields(v: Array): EndpointPromotionsPage; /** Use flat output format instead of a recursive one */ flat(v: boolean): EndpointPromotionsPage; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointPromotionsPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointPromotionsPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointPromotionsPage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPromotionsPage; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: PromotionsPageSortBy): EndpointPromotionsPage; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointPromotionsPage; /** Filter promotions output by status */ status(v: PromotionsPageStatus): EndpointPromotionsPage; /** Filter output by last update date, upper boundary */ updated_at_max(v: string): EndpointPromotionsPage; /** Filter output by last update date, lower boundary */ updated_at_min(v: string): EndpointPromotionsPage; expand(v: PromotionPageExpansionMap): EndpointPromotionsPage; extract(v: Extractor): EndpointPromotionsPage; } export interface EndpointProvinces extends Endpoint> { /** Country code */ country_code(v: string): EndpointProvinces; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointProvinces; extract(v: Extractor>): EndpointProvinces; } export interface EndpointPurchaseOrderNotesDelete extends Endpoint { /** List of purchase order note ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointPurchaseOrderNotesDelete; /** Unique purchase order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ purchase_order_id(v: string): EndpointPurchaseOrderNotesDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPurchaseOrderNotesDelete; } export interface EndpointPurchaseOrderNotes extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointPurchaseOrderNotes; /** List of purchase order note ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointPurchaseOrderNotes; /** Unique purchase order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ purchase_order_id(v: string): EndpointPurchaseOrderNotes; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPurchaseOrderNotes; expand(v: NoteExpansionMap): EndpointPurchaseOrderNotes; extract(v: Extractor>): EndpointPurchaseOrderNotes; } export interface EndpointPurchaseOrderNotesCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointPurchaseOrderNotesCreate; /** List of purchase order note ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointPurchaseOrderNotesModify; /** Unique purchase order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ purchase_order_id(v: string): EndpointPurchaseOrderNotesCreate; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPurchaseOrderNotesCreate; data(v: Array): EndpointPurchaseOrderNotesCreate; expand(v: NoteExpansionMap): EndpointPurchaseOrderNotesCreate; extract(v: Extractor>): EndpointPurchaseOrderNotesCreate; } export interface EndpointPurchaseOrderNotesModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointPurchaseOrderNotesModify; /** Unique purchase order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ purchase_order_id(v: string): EndpointPurchaseOrderNotesModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPurchaseOrderNotesModify; data(v: Array): EndpointPurchaseOrderNotesModify; expand(v: NoteExpansionMap): EndpointPurchaseOrderNotesModify; extract(v: Extractor>): EndpointPurchaseOrderNotesModify; } export interface EndpointPurchaseOrdersDelete extends Endpoint { /** List of purchase order ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointPurchaseOrdersDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPurchaseOrdersDelete; } export interface EndpointPurchaseOrders extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointPurchaseOrders; /** List of purchase order ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointPurchaseOrders; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointPurchaseOrders; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPurchaseOrders; expand(v: PurchaseOrderExpansionMap): EndpointPurchaseOrders; extract(v: Extractor>): EndpointPurchaseOrders; } export interface EndpointPurchaseOrdersCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointPurchaseOrdersCreate; /** List of purchase order ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointPurchaseOrdersModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPurchaseOrdersCreate; data(v: Array): EndpointPurchaseOrdersCreate; expand(v: PurchaseOrderExpansionMap): EndpointPurchaseOrdersCreate; extract(v: Extractor>): EndpointPurchaseOrdersCreate; } export interface EndpointPurchaseOrdersModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointPurchaseOrdersModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPurchaseOrdersModify; data(v: Array): EndpointPurchaseOrdersModify; expand(v: PurchaseOrderExpansionMap): EndpointPurchaseOrdersModify; extract(v: Extractor>): EndpointPurchaseOrdersModify; } export interface EndpointPurchaseOrdersClose extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointPurchaseOrdersClose; /** List of purchase order ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointPurchaseOrdersClose; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPurchaseOrdersClose; expand(v: PurchaseOrderExpansionMap): EndpointPurchaseOrdersClose; extract(v: Extractor>): EndpointPurchaseOrdersClose; } export interface EndpointPurchaseOrdersExport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPurchaseOrdersExport; data(v: GenericExport): EndpointPurchaseOrdersExport; expand(v: ForeignShardedTaskExpansionMap): EndpointPurchaseOrdersExport; extract(v: Extractor): EndpointPurchaseOrdersExport; } export interface EndpointPurchaseOrdersImport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPurchaseOrdersImport; data(v: GenericImport): EndpointPurchaseOrdersImport; expand(v: ForeignShardedTaskExpansionMap): EndpointPurchaseOrdersImport; extract(v: Extractor): EndpointPurchaseOrdersImport; } export interface EndpointPurchaseOrdersLog extends Endpoint { /** Output filtering */ fields(v: Array): EndpointPurchaseOrdersLog; /** Unique purchase order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ purchase_order_id(v: string): EndpointPurchaseOrdersLog; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPurchaseOrdersLog; expand(v: PurchaseOrderLogExpansionMap): EndpointPurchaseOrdersLog; extract(v: Extractor): EndpointPurchaseOrdersLog; } export interface EndpointPurchaseOrdersOpen extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointPurchaseOrdersOpen; /** List of purchase order ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointPurchaseOrdersOpen; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPurchaseOrdersOpen; expand(v: PurchaseOrderExpansionMap): EndpointPurchaseOrdersOpen; extract(v: Extractor>): EndpointPurchaseOrdersOpen; } export interface EndpointPurchaseOrdersPage extends Endpoint { /** Output filtering */ fields(v: Array): EndpointPurchaseOrdersPage; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointPurchaseOrdersPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointPurchaseOrdersPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointPurchaseOrdersPage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPurchaseOrdersPage; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: PurchaseOrdersPageSortBy): EndpointPurchaseOrdersPage; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointPurchaseOrdersPage; /** Filter output by supplier */ supplier_id(v: string): EndpointPurchaseOrdersPage; /** Filter purchase orders output by a purchase order type */ type(v: PurchaseOrderCategory): EndpointPurchaseOrdersPage; expand(v: PurchaseOrderPageExpansionMap): EndpointPurchaseOrdersPage; extract(v: Extractor): EndpointPurchaseOrdersPage; } export interface EndpointPurchaseOrdersReceive extends Endpoint { /** Output filtering */ fields(v: Array): EndpointPurchaseOrdersReceive; /** Unique purchase order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ purchase_order_id(v: string): EndpointPurchaseOrdersReceive; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPurchaseOrdersReceive; data(v: PurchaseOrderReceive): EndpointPurchaseOrdersReceive; expand(v: PurchaseOrderExpansionMap): EndpointPurchaseOrdersReceive; extract(v: Extractor): EndpointPurchaseOrdersReceive; } export interface EndpointPurchaseOrdersReject extends Endpoint { /** Output filtering */ fields(v: Array): EndpointPurchaseOrdersReject; /** Unique purchase order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ purchase_order_id(v: string): EndpointPurchaseOrdersReject; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointPurchaseOrdersReject; data(v: PurchaseOrderReject): EndpointPurchaseOrdersReject; expand(v: PurchaseOrderExpansionMap): EndpointPurchaseOrdersReject; extract(v: Extractor): EndpointPurchaseOrdersReject; } export interface EndpointQuickbooksDelete extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointQuickbooksDelete; } export interface EndpointQuickbooks extends Endpoint { /** Output filtering */ fields(v: Array): EndpointQuickbooks; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointQuickbooks; extract(v: Extractor): EndpointQuickbooks; } export interface EndpointQuickbooksCreate extends Endpoint { /** Output filtering */ fields(v: Array): EndpointQuickbooksCreate; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointQuickbooksCreate; data(v: QuickbooksSettingsCreate): EndpointQuickbooksCreate; extract(v: Extractor): EndpointQuickbooksCreate; } export interface EndpointQuickbooksAccounts extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointQuickbooksAccounts; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointQuickbooksAccounts; extract(v: Extractor>): EndpointQuickbooksAccounts; } export interface EndpointQuickbooksAuthorize extends Endpoint { /** OAuth verification code */ code(v: string): EndpointQuickbooksAuthorize; /** Quickbooks realm ID */ realm_id(v: string): EndpointQuickbooksAuthorize; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointQuickbooksAuthorize; } export interface EndpointQuickbooksLog extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointQuickbooksLog; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointQuickbooksLog; extract(v: Extractor>): EndpointQuickbooksLog; } export interface EndpointQuickbooksTaxRates extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointQuickbooksTaxRates; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointQuickbooksTaxRates; extract(v: Extractor>): EndpointQuickbooksTaxRates; } export interface EndpointRequests extends Endpoint { data(v: Request): EndpointRequests; } export interface EndpointReturnInspectionsDelete extends Endpoint { /** Output filtering */ fields(v: Array): EndpointReturnInspectionsDelete; /** List of return reason ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointReturnInspectionsDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReturnInspectionsDelete; } export interface EndpointReturnInspections extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointReturnInspections; /** List of return reason ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointReturnInspections; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointReturnInspections; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReturnInspections; extract(v: Extractor>): EndpointReturnInspections; } export interface EndpointReturnInspectionsCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointReturnInspectionsCreate; /** List of return reason ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointReturnInspectionsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReturnInspectionsCreate; data(v: Array): EndpointReturnInspectionsCreate; extract(v: Extractor>): EndpointReturnInspectionsCreate; } export interface EndpointReturnInspectionsModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointReturnInspectionsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReturnInspectionsModify; data(v: Array): EndpointReturnInspectionsModify; extract(v: Extractor>): EndpointReturnInspectionsModify; } export interface EndpointReturnInspectionsAddDefault extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReturnInspectionsAddDefault; } export interface EndpointReturnNotesDelete extends Endpoint { /** List of return note ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointReturnNotesDelete; /** Unique return identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ return_id(v: string): EndpointReturnNotesDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReturnNotesDelete; } export interface EndpointReturnNotes extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointReturnNotes; /** List of return note ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointReturnNotes; /** Unique return identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ return_id(v: string): EndpointReturnNotes; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReturnNotes; expand(v: NoteExpansionMap): EndpointReturnNotes; extract(v: Extractor>): EndpointReturnNotes; } export interface EndpointReturnNotesCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointReturnNotesCreate; /** List of return note ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointReturnNotesModify; /** Unique return identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ return_id(v: string): EndpointReturnNotesCreate; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReturnNotesCreate; data(v: Array): EndpointReturnNotesCreate; expand(v: NoteExpansionMap): EndpointReturnNotesCreate; extract(v: Extractor>): EndpointReturnNotesCreate; } export interface EndpointReturnNotesModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointReturnNotesModify; /** Unique return identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ return_id(v: string): EndpointReturnNotesModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReturnNotesModify; data(v: Array): EndpointReturnNotesModify; expand(v: NoteExpansionMap): EndpointReturnNotesModify; extract(v: Extractor>): EndpointReturnNotesModify; } export interface EndpointReturnPoliciesDelete extends Endpoint { /** List of return policy ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointReturnPoliciesDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReturnPoliciesDelete; } export interface EndpointReturnPolicies extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointReturnPolicies; /** List of return policy ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointReturnPolicies; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointReturnPolicies; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReturnPolicies; expand(v: ReturnPolicyExpansionMap): EndpointReturnPolicies; extract(v: Extractor>): EndpointReturnPolicies; } export interface EndpointReturnPoliciesCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointReturnPoliciesCreate; /** List of return policy ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointReturnPoliciesModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReturnPoliciesCreate; data(v: Array): EndpointReturnPoliciesCreate; expand(v: ReturnPolicyExpansionMap): EndpointReturnPoliciesCreate; extract(v: Extractor>): EndpointReturnPoliciesCreate; } export interface EndpointReturnPoliciesModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointReturnPoliciesModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReturnPoliciesModify; data(v: Array): EndpointReturnPoliciesModify; expand(v: ReturnPolicyExpansionMap): EndpointReturnPoliciesModify; extract(v: Extractor>): EndpointReturnPoliciesModify; } export interface EndpointReturnReasonsDelete extends Endpoint { /** Output filtering */ fields(v: Array): EndpointReturnReasonsDelete; /** List of return reason ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointReturnReasonsDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReturnReasonsDelete; } export interface EndpointReturnReasons extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointReturnReasons; /** List of return reason ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointReturnReasons; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointReturnReasons; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReturnReasons; extract(v: Extractor>): EndpointReturnReasons; } export interface EndpointReturnReasonsCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointReturnReasonsCreate; /** List of return reason ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointReturnReasonsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReturnReasonsCreate; data(v: Array): EndpointReturnReasonsCreate; extract(v: Extractor>): EndpointReturnReasonsCreate; } export interface EndpointReturnReasonsModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointReturnReasonsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReturnReasonsModify; data(v: Array): EndpointReturnReasonsModify; extract(v: Extractor>): EndpointReturnReasonsModify; } export interface EndpointReturnReasonsAddDefault extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReturnReasonsAddDefault; } export interface EndpointReturns extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointReturns; /** List of return ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointReturns; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointReturns; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReturns; expand(v: ReturnExpansionMap): EndpointReturns; extract(v: Extractor>): EndpointReturns; } export interface EndpointReturnsCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointReturnsCreate; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReturnsCreate; data(v: Array): EndpointReturnsCreate; expand(v: ReturnExpansionMap): EndpointReturnsCreate; extract(v: Extractor>): EndpointReturnsCreate; } export interface EndpointReturnsApprove extends Endpoint { /** Output filtering */ fields(v: Array): EndpointReturnsApprove; /** Unique return identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ return_id(v: string): EndpointReturnsApprove; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReturnsApprove; data(v: ReturnApprove): EndpointReturnsApprove; expand(v: ReturnExpansionMap): EndpointReturnsApprove; extract(v: Extractor): EndpointReturnsApprove; } export interface EndpointReturnsCheck extends Endpoint { /** Output filtering */ fields(v: Array): EndpointReturnsCheck; /** Unique return identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ return_id(v: string): EndpointReturnsCheck; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReturnsCheck; data(v: Array): EndpointReturnsCheck; expand(v: ReturnExpansionMap): EndpointReturnsCheck; extract(v: Extractor): EndpointReturnsCheck; } export interface EndpointReturnsClose extends Endpoint { /** Output filtering */ fields(v: Array): EndpointReturnsClose; /** Unique return identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ return_id(v: string): EndpointReturnsClose; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReturnsClose; expand(v: ReturnExpansionMap): EndpointReturnsClose; extract(v: Extractor): EndpointReturnsClose; } export interface EndpointReturnsFindPolicy extends Endpoint { /** Output filtering */ fields(v: Array): EndpointReturnsFindPolicy; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointReturnsFindPolicy; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReturnsFindPolicy; expand(v: ReturnPolicyExpansionMap): EndpointReturnsFindPolicy; extract(v: Extractor): EndpointReturnsFindPolicy; } export interface EndpointReturnsInspect extends Endpoint { /** Output filtering */ fields(v: Array): EndpointReturnsInspect; /** Unique return identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ return_id(v: string): EndpointReturnsInspect; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReturnsInspect; expand(v: ReturnExpansionMap): EndpointReturnsInspect; extract(v: Extractor): EndpointReturnsInspect; } export interface EndpointReturnsOpen extends Endpoint { /** Output filtering */ fields(v: Array): EndpointReturnsOpen; /** Unique return identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ return_id(v: string): EndpointReturnsOpen; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReturnsOpen; expand(v: ReturnExpansionMap): EndpointReturnsOpen; extract(v: Extractor): EndpointReturnsOpen; } export interface EndpointReturnsPage extends Endpoint { /** Output filtering */ fields(v: Array): EndpointReturnsPage; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointReturnsPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointReturnsPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointReturnsPage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReturnsPage; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: ReturnsPageSortBy): EndpointReturnsPage; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointReturnsPage; /** Filter return output by a return type */ type(v: ReturnCategory): EndpointReturnsPage; expand(v: ReturnPageExpansionMap): EndpointReturnsPage; extract(v: Extractor): EndpointReturnsPage; } export interface EndpointReturnsReceive extends Endpoint { /** Output filtering */ fields(v: Array): EndpointReturnsReceive; /** Unique return identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ return_id(v: string): EndpointReturnsReceive; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReturnsReceive; data(v: ReturnReceive): EndpointReturnsReceive; expand(v: ReturnExpansionMap): EndpointReturnsReceive; extract(v: Extractor): EndpointReturnsReceive; } export interface EndpointReturnsRefund extends Endpoint { /** Output filtering */ fields(v: Array): EndpointReturnsRefund; /** Unique return identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ return_id(v: string): EndpointReturnsRefund; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReturnsRefund; data(v: ReturnRefund): EndpointReturnsRefund; expand(v: ReturnExpansionMap): EndpointReturnsRefund; extract(v: Extractor): EndpointReturnsRefund; } export interface EndpointReturnsReject extends Endpoint { /** Output filtering */ fields(v: Array): EndpointReturnsReject; /** Reject reason */ reason(v: string): EndpointReturnsReject; /** Unique return identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ return_id(v: string): EndpointReturnsReject; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReturnsReject; expand(v: ReturnExpansionMap): EndpointReturnsReject; extract(v: Extractor): EndpointReturnsReject; } export interface EndpointReviewDimensionSetsDelete extends Endpoint { /** List of review dimension set ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointReviewDimensionSetsDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReviewDimensionSetsDelete; } export interface EndpointReviewDimensionSets extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointReviewDimensionSets; /** List of review dimension set ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointReviewDimensionSets; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointReviewDimensionSets; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReviewDimensionSets; expand(v: ReviewDimensionSetExpansionMap): EndpointReviewDimensionSets; extract(v: Extractor>): EndpointReviewDimensionSets; } export interface EndpointReviewDimensionSetsCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointReviewDimensionSetsCreate; /** List of review dimension set ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointReviewDimensionSetsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReviewDimensionSetsCreate; data(v: Array): EndpointReviewDimensionSetsCreate; expand(v: ReviewDimensionSetExpansionMap): EndpointReviewDimensionSetsCreate; extract(v: Extractor>): EndpointReviewDimensionSetsCreate; } export interface EndpointReviewDimensionSetsModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointReviewDimensionSetsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReviewDimensionSetsModify; data(v: Array): EndpointReviewDimensionSetsModify; expand(v: ReviewDimensionSetExpansionMap): EndpointReviewDimensionSetsModify; extract(v: Extractor>): EndpointReviewDimensionSetsModify; } export interface EndpointReviewDimensionsDelete extends Endpoint { /** List of review dimension ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointReviewDimensionsDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReviewDimensionsDelete; } export interface EndpointReviewDimensions extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointReviewDimensions; /** List of review dimension ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointReviewDimensions; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointReviewDimensions; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReviewDimensions; extract(v: Extractor>): EndpointReviewDimensions; } export interface EndpointReviewDimensionsCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointReviewDimensionsCreate; /** List of review dimension ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointReviewDimensionsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReviewDimensionsCreate; data(v: Array): EndpointReviewDimensionsCreate; extract(v: Extractor>): EndpointReviewDimensionsCreate; } export interface EndpointReviewDimensionsModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointReviewDimensionsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointReviewDimensionsModify; data(v: Array): EndpointReviewDimensionsModify; extract(v: Extractor>): EndpointReviewDimensionsModify; } export interface EndpointRolesDelete extends Endpoint { /** List of role ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointRolesDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointRolesDelete; } export interface EndpointRoles extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointRoles; /** List of role ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointRoles; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointRoles; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointRoles; extract(v: Extractor>): EndpointRoles; } export interface EndpointRolesCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointRolesCreate; /** List of role ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointRolesModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointRolesCreate; data(v: Array): EndpointRolesCreate; extract(v: Extractor>): EndpointRolesCreate; } export interface EndpointRolesModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointRolesModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointRolesModify; data(v: Array): EndpointRolesModify; extract(v: Extractor>): EndpointRolesModify; } export interface EndpointScheduledFulfillmentsDelete extends Endpoint { /** List of scheduled fulfillment ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointScheduledFulfillmentsDelete; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointScheduledFulfillmentsDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointScheduledFulfillmentsDelete; } export interface EndpointScheduledFulfillments extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointScheduledFulfillments; /** List of scheduled fulfillment ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointScheduledFulfillments; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointScheduledFulfillments; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointScheduledFulfillments; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointScheduledFulfillments; expand(v: ScheduledFulfillmentExpansionMap): EndpointScheduledFulfillments; extract(v: Extractor>): EndpointScheduledFulfillments; } export interface EndpointScheduledFulfillmentsCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointScheduledFulfillmentsCreate; /** List of scheduled fulfillment ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointScheduledFulfillmentsModify; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointScheduledFulfillmentsCreate; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointScheduledFulfillmentsCreate; data(v: Array): EndpointScheduledFulfillmentsCreate; expand(v: ScheduledFulfillmentExpansionMap): EndpointScheduledFulfillmentsCreate; extract(v: Extractor>): EndpointScheduledFulfillmentsCreate; } export interface EndpointScheduledFulfillmentsModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointScheduledFulfillmentsModify; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointScheduledFulfillmentsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointScheduledFulfillmentsModify; data(v: Array): EndpointScheduledFulfillmentsModify; expand(v: ScheduledFulfillmentExpansionMap): EndpointScheduledFulfillmentsModify; extract(v: Extractor>): EndpointScheduledFulfillmentsModify; } export interface EndpointScheduledFulfillmentsCancelReservation extends Endpoint { /** Output filtering */ fields(v: Array): EndpointScheduledFulfillmentsCancelReservation; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointScheduledFulfillmentsCancelReservation; /** Unique scheduled fulfillment identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ scheduled_fulfillment_id(v: string): EndpointScheduledFulfillmentsCancelReservation; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointScheduledFulfillmentsCancelReservation; expand(v: ScheduledFulfillmentExpansionMap): EndpointScheduledFulfillmentsCancelReservation; extract(v: Extractor): EndpointScheduledFulfillmentsCancelReservation; } export interface EndpointScheduledFulfillmentsReserve extends Endpoint { /** Output filtering */ fields(v: Array): EndpointScheduledFulfillmentsReserve; /** Unique order identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ order_id(v: string): EndpointScheduledFulfillmentsReserve; /** Unique scheduled fulfillment identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ scheduled_fulfillment_id(v: string): EndpointScheduledFulfillmentsReserve; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointScheduledFulfillmentsReserve; data(v: ScheduledFulfillmentReserve): EndpointScheduledFulfillmentsReserve; expand(v: ScheduledFulfillmentExpansionMap): EndpointScheduledFulfillmentsReserve; extract(v: Extractor): EndpointScheduledFulfillmentsReserve; } export interface EndpointSearchBrands extends Endpoint { /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointSearchBrands; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointSearchBrands; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSearchBrands; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: SearchBrandsSortBy): EndpointSearchBrands; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointSearchBrands; data(v: Array): EndpointSearchBrands; expand(v: BrandSearchResultExpansionMap): EndpointSearchBrands; extract(v: Extractor): EndpointSearchBrands; } export interface EndpointSearchCategories extends Endpoint { /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointSearchCategories; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointSearchCategories; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSearchCategories; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: SearchCategoriesSortBy): EndpointSearchCategories; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointSearchCategories; data(v: Array): EndpointSearchCategories; expand(v: CategorySearchResultExpansionMap): EndpointSearchCategories; extract(v: Extractor): EndpointSearchCategories; } export interface EndpointSearchContentBlocks extends Endpoint { /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointSearchContentBlocks; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointSearchContentBlocks; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSearchContentBlocks; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: SearchContentBlocksSortBy): EndpointSearchContentBlocks; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointSearchContentBlocks; data(v: Array): EndpointSearchContentBlocks; expand(v: ContentBlockSearchResultExpansionMap): EndpointSearchContentBlocks; extract(v: Extractor): EndpointSearchContentBlocks; } export interface EndpointSearchCustomerInventory extends Endpoint { /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointSearchCustomerInventory; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointSearchCustomerInventory; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSearchCustomerInventory; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: SearchCustomerInventorySortBy): EndpointSearchCustomerInventory; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointSearchCustomerInventory; data(v: Array): EndpointSearchCustomerInventory; expand(v: CustomerInventorySearchResultExpansionMap): EndpointSearchCustomerInventory; extract(v: Extractor): EndpointSearchCustomerInventory; } export interface EndpointSearchCustomers extends Endpoint { /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointSearchCustomers; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointSearchCustomers; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSearchCustomers; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: SearchCustomersSortBy): EndpointSearchCustomers; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointSearchCustomers; data(v: Array): EndpointSearchCustomers; expand(v: CustomerSearchResultExpansionMap): EndpointSearchCustomers; extract(v: Extractor): EndpointSearchCustomers; } export interface EndpointSearchFiles extends Endpoint { /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointSearchFiles; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointSearchFiles; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSearchFiles; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: SearchFilesSortBy): EndpointSearchFiles; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointSearchFiles; data(v: Array): EndpointSearchFiles; expand(v: FileSearchResultExpansionMap): EndpointSearchFiles; extract(v: Extractor): EndpointSearchFiles; } export interface EndpointSearchOrders extends Endpoint { /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointSearchOrders; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointSearchOrders; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSearchOrders; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: SearchOrdersSortBy): EndpointSearchOrders; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointSearchOrders; data(v: Array): EndpointSearchOrders; expand(v: OrderSearchResultExpansionMap): EndpointSearchOrders; extract(v: Extractor): EndpointSearchOrders; } export interface EndpointSearchProducts extends Endpoint { /** Whether to include aggregations into results or not */ aggregations(v: boolean): EndpointSearchProducts; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointSearchProducts; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointSearchProducts; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointSearchProducts; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSearchProducts; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: SearchProductsSortBy): EndpointSearchProducts; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointSearchProducts; data(v: Array): EndpointSearchProducts; expand(v: ProductSearchResultExpansionMap): EndpointSearchProducts; extract(v: Extractor): EndpointSearchProducts; } export interface EndpointSearchPromotions extends Endpoint { /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointSearchPromotions; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointSearchPromotions; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSearchPromotions; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: SearchPromotionsSortBy): EndpointSearchPromotions; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointSearchPromotions; data(v: Array): EndpointSearchPromotions; expand(v: PromotionSearchResultExpansionMap): EndpointSearchPromotions; extract(v: Extractor): EndpointSearchPromotions; } export interface EndpointSearchPurchaseOrders extends Endpoint { /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointSearchPurchaseOrders; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointSearchPurchaseOrders; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSearchPurchaseOrders; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: SearchPurchaseOrdersSortBy): EndpointSearchPurchaseOrders; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointSearchPurchaseOrders; data(v: Array): EndpointSearchPurchaseOrders; expand(v: PurchaseOrderSearchResultExpansionMap): EndpointSearchPurchaseOrders; extract(v: Extractor): EndpointSearchPurchaseOrders; } export interface EndpointSearchQuestions extends Endpoint { /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointSearchQuestions; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointSearchQuestions; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSearchQuestions; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: SearchQuestionsSortBy): EndpointSearchQuestions; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointSearchQuestions; data(v: Array): EndpointSearchQuestions; expand(v: ProductQuestionSearchResultExpansionMap): EndpointSearchQuestions; extract(v: Extractor): EndpointSearchQuestions; } export interface EndpointSearchReindex extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSearchReindex; } export interface EndpointSearchReviews extends Endpoint { /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointSearchReviews; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointSearchReviews; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSearchReviews; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: SearchReviewsSortBy): EndpointSearchReviews; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointSearchReviews; data(v: Array): EndpointSearchReviews; expand(v: ProductReviewSearchResultExpansionMap): EndpointSearchReviews; extract(v: Extractor): EndpointSearchReviews; } export interface EndpointSearchSubscriptions extends Endpoint { /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointSearchSubscriptions; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointSearchSubscriptions; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSearchSubscriptions; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: SearchSubscriptionsSortBy): EndpointSearchSubscriptions; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointSearchSubscriptions; data(v: Array): EndpointSearchSubscriptions; expand(v: SubscriptionSearchResultExpansionMap): EndpointSearchSubscriptions; extract(v: Extractor): EndpointSearchSubscriptions; } export interface EndpointSearchSuppliers extends Endpoint { /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointSearchSuppliers; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointSearchSuppliers; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSearchSuppliers; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: SearchSuppliersSortBy): EndpointSearchSuppliers; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointSearchSuppliers; data(v: Array): EndpointSearchSuppliers; expand(v: SupplierSearchResultExpansionMap): EndpointSearchSuppliers; extract(v: Extractor): EndpointSearchSuppliers; } export interface EndpointSearchTransfers extends Endpoint { /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointSearchTransfers; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointSearchTransfers; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSearchTransfers; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: SearchTransfersSortBy): EndpointSearchTransfers; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointSearchTransfers; data(v: Array): EndpointSearchTransfers; expand(v: TransferSearchResultExpansionMap): EndpointSearchTransfers; extract(v: Extractor): EndpointSearchTransfers; } export interface EndpointSearchUnified extends Endpoint { /** Output filtering */ filter(v: Array): EndpointSearchUnified; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSearchUnified; data(v: Query): EndpointSearchUnified; expand(v: UnifiedSearchResultExpansionMap): EndpointSearchUnified; extract(v: Extractor): EndpointSearchUnified; } export interface EndpointSearchVariants extends Endpoint { /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointSearchVariants; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointSearchVariants; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSearchVariants; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: SearchVariantsSortBy): EndpointSearchVariants; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointSearchVariants; data(v: Array): EndpointSearchVariants; expand(v: ProductVariantSearchResultExpansionMap): EndpointSearchVariants; extract(v: Extractor): EndpointSearchVariants; } export interface EndpointShardedTasks extends Endpoint { /** Output filtering */ fields(v: Array): EndpointShardedTasks; /** List of sharded task ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointShardedTasks; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointShardedTasks; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointShardedTasks; expand(v: ShardedTaskExpandableItemsExpansionMap): EndpointShardedTasks; extract(v: Extractor): EndpointShardedTasks; } export interface EndpointShippingProvidersDelete extends Endpoint { /** List of shipping provider ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointShippingProvidersDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointShippingProvidersDelete; } export interface EndpointShippingProviders extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointShippingProviders; /** List of shipping provider ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointShippingProviders; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointShippingProviders; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointShippingProviders; extract(v: Extractor>): EndpointShippingProviders; } export interface EndpointShippingProvidersCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointShippingProvidersCreate; /** List of shipping provider ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointShippingProvidersModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointShippingProvidersCreate; data(v: Array): EndpointShippingProvidersCreate; extract(v: Extractor>): EndpointShippingProvidersCreate; } export interface EndpointShippingProvidersModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointShippingProvidersModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointShippingProvidersModify; data(v: Array): EndpointShippingProvidersModify; extract(v: Extractor>): EndpointShippingProvidersModify; } export interface EndpointShippingProvidersTest extends Endpoint { /** Output filtering */ fields(v: Array): EndpointShippingProvidersTest; /** Unique shipping provider identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shipping_provider_id(v: string): EndpointShippingProvidersTest; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointShippingProvidersTest; extract(v: Extractor): EndpointShippingProvidersTest; } export interface EndpointShippingRulesDelete extends Endpoint { /** List of shipping rule ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointShippingRulesDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointShippingRulesDelete; } export interface EndpointShippingRules extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointShippingRules; /** List of shipping rule ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointShippingRules; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointShippingRules; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointShippingRules; expand(v: ShippingRuleExpansionMap): EndpointShippingRules; extract(v: Extractor>): EndpointShippingRules; } export interface EndpointShippingRulesCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointShippingRulesCreate; /** List of shipping rule ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointShippingRulesModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointShippingRulesCreate; data(v: Array): EndpointShippingRulesCreate; expand(v: ShippingRuleExpansionMap): EndpointShippingRulesCreate; extract(v: Extractor>): EndpointShippingRulesCreate; } export interface EndpointShippingRulesModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointShippingRulesModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointShippingRulesModify; data(v: Array): EndpointShippingRulesModify; expand(v: ShippingRuleExpansionMap): EndpointShippingRulesModify; extract(v: Extractor>): EndpointShippingRulesModify; } export interface EndpointShippingRulesExport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointShippingRulesExport; data(v: GenericExport): EndpointShippingRulesExport; expand(v: ForeignShardedTaskExpansionMap): EndpointShippingRulesExport; extract(v: Extractor): EndpointShippingRulesExport; } export interface EndpointShippingRulesImport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointShippingRulesImport; data(v: GenericImport): EndpointShippingRulesImport; expand(v: ForeignShardedTaskExpansionMap): EndpointShippingRulesImport; extract(v: Extractor): EndpointShippingRulesImport; } export interface EndpointShopsDelete extends Endpoint { /** Reason why shop was deleted */ reason(v: ShopDeleteReasonParam): EndpointShopsDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointShopsDelete; } export interface EndpointShops extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointShops; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointShops; expand(v: ShopExpansionMap): EndpointShops; extract(v: Extractor>): EndpointShops; } export interface EndpointShopsCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointShopsCreate; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointShopsModify; data(v: Array): EndpointShopsCreate; expand(v: ShopExpansionMap): EndpointShopsCreate; extract(v: Extractor>): EndpointShopsCreate; } export interface EndpointShopsModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointShopsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointShopsModify; data(v: Array): EndpointShopsModify; expand(v: ShopExpansionMap): EndpointShopsModify; extract(v: Extractor>): EndpointShopsModify; } export interface EndpointShopsDropCache extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointShopsDropCache; } export interface EndpointShopsPage extends Endpoint { /** Output filtering */ fields(v: Array): EndpointShopsPage; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointShopsPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointShopsPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointShopsPage; extract(v: Extractor): EndpointShopsPage; } export interface EndpointShopsPreferences extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointShopsPreferences; /** Get only preferences with the following keys */ keys(v: Array): EndpointShopsPreferences; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointShopsPreferences; extract(v: Extractor>): EndpointShopsPreferences; } export interface EndpointShopsPreferencesCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointShopsPreferencesCreate; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointShopsPreferencesCreate; data(v: Array): EndpointShopsPreferencesCreate; extract(v: Extractor>): EndpointShopsPreferencesCreate; } export interface EndpointShopsSettings extends Endpoint { /** Output filtering */ fields(v: Array): EndpointShopsSettings; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointShopsSettings; expand(v: ShopSettingsExpansionMap): EndpointShopsSettings; extract(v: Extractor): EndpointShopsSettings; } export interface EndpointShopsSettingsCreate extends Endpoint { /** Output filtering */ fields(v: Array): EndpointShopsSettingsCreate; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointShopsSettingsCreate; data(v: ShopSettingsCreate): EndpointShopsSettingsCreate; expand(v: ShopSettingsExpansionMap): EndpointShopsSettingsCreate; extract(v: Extractor): EndpointShopsSettingsCreate; } export interface EndpointSlugify extends Endpoint { /** Text to slugify */ text(v: string): EndpointSlugify; extract(v: Extractor): EndpointSlugify; } export interface EndpointSmsMessagesDelete extends Endpoint { /** List of test sms ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointSmsMessagesDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSmsMessagesDelete; } export interface EndpointSmsMessagesPage extends Endpoint { /** Output filtering */ fields(v: Array): EndpointSmsMessagesPage; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointSmsMessagesPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointSmsMessagesPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointSmsMessagesPage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSmsMessagesPage; extract(v: Extractor): EndpointSmsMessagesPage; } export interface EndpointSmsSentSummary extends Endpoint> { /** Upper boundary */ sent_at_max(v: string): EndpointSmsSentSummary; /** Lower boundary */ sent_at_min(v: string): EndpointSmsSentSummary; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSmsSentSummary; extract(v: Extractor>): EndpointSmsSentSummary; } export interface EndpointSubscriptions extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointSubscriptions; /** List of subscription ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointSubscriptions; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointSubscriptions; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSubscriptions; expand(v: SubscriptionExpansionMap): EndpointSubscriptions; extract(v: Extractor>): EndpointSubscriptions; } export interface EndpointSubscriptionsCancel extends Endpoint { /** Output filtering */ fields(v: Array): EndpointSubscriptionsCancel; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSubscriptionsCancel; /** Unique subscription identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ subscription_id(v: string): EndpointSubscriptionsCancel; expand(v: SubscriptionExpansionMap): EndpointSubscriptionsCancel; extract(v: Extractor): EndpointSubscriptionsCancel; } export interface EndpointSubscriptionsEdit extends Endpoint { /** Output filtering */ fields(v: Array): EndpointSubscriptionsEdit; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSubscriptionsEdit; /** Unique subscription identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ subscription_id(v: string): EndpointSubscriptionsEdit; data(v: SubscriptionEdit): EndpointSubscriptionsEdit; expand(v: SubscriptionExpansionMap): EndpointSubscriptionsEdit; extract(v: Extractor): EndpointSubscriptionsEdit; } export interface EndpointSubscriptionsPage extends Endpoint { /** Filter output by customer */ customer_id(v: string): EndpointSubscriptionsPage; /** Output filtering */ fields(v: Array): EndpointSubscriptionsPage; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointSubscriptionsPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointSubscriptionsPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointSubscriptionsPage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSubscriptionsPage; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: SubscriptionsPageSortBy): EndpointSubscriptionsPage; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointSubscriptionsPage; expand(v: SubscriptionPageExpansionMap): EndpointSubscriptionsPage; extract(v: Extractor): EndpointSubscriptionsPage; } export interface EndpointSubscriptionsPause extends Endpoint { /** Output filtering */ fields(v: Array): EndpointSubscriptionsPause; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSubscriptionsPause; /** Unique subscription identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ subscription_id(v: string): EndpointSubscriptionsPause; expand(v: SubscriptionExpansionMap): EndpointSubscriptionsPause; extract(v: Extractor): EndpointSubscriptionsPause; } export interface EndpointSubscriptionsResume extends Endpoint { /** Output filtering */ fields(v: Array): EndpointSubscriptionsResume; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSubscriptionsResume; /** Unique subscription identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ subscription_id(v: string): EndpointSubscriptionsResume; expand(v: SubscriptionExpansionMap): EndpointSubscriptionsResume; extract(v: Extractor): EndpointSubscriptionsResume; } export interface EndpointSubscriptionsSkipNext extends Endpoint { /** Output filtering */ fields(v: Array): EndpointSubscriptionsSkipNext; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSubscriptionsSkipNext; /** Unique subscription identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ subscription_id(v: string): EndpointSubscriptionsSkipNext; expand(v: SubscriptionExpansionMap): EndpointSubscriptionsSkipNext; extract(v: Extractor): EndpointSubscriptionsSkipNext; } export interface EndpointSuggestBlogs extends Endpoint { data(v: Query): EndpointSuggestBlogs; expand(v: BlogExpandableItemsExpansionMap): EndpointSuggestBlogs; extract(v: Extractor): EndpointSuggestBlogs; } export interface EndpointSuggestBrands extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSuggestBrands; data(v: Query): EndpointSuggestBrands; expand(v: BrandExpandableItemsExpansionMap): EndpointSuggestBrands; extract(v: Extractor): EndpointSuggestBrands; } export interface EndpointSuggestCategories extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSuggestCategories; data(v: Query): EndpointSuggestCategories; expand(v: CategoryExpandableItemsExpansionMap): EndpointSuggestCategories; extract(v: Extractor): EndpointSuggestCategories; } export interface EndpointSuggestContentBlocks extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSuggestContentBlocks; data(v: Query): EndpointSuggestContentBlocks; expand(v: ContentBlockExpandableItemsExpansionMap): EndpointSuggestContentBlocks; extract(v: Extractor): EndpointSuggestContentBlocks; } export interface EndpointSuggestCustomerInventory extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSuggestCustomerInventory; /** Filter output by customer inventory item type */ type(v: CustomerInventoryTypeFilter): EndpointSuggestCustomerInventory; data(v: Query): EndpointSuggestCustomerInventory; expand(v: CustomerInventoryExpandableItemsExpansionMap): EndpointSuggestCustomerInventory; extract(v: Extractor): EndpointSuggestCustomerInventory; } export interface EndpointSuggestCustomers extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSuggestCustomers; data(v: Query): EndpointSuggestCustomers; expand(v: CustomerExpandableItemsExpansionMap): EndpointSuggestCustomers; extract(v: Extractor): EndpointSuggestCustomers; } export interface EndpointSuggestFiles extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSuggestFiles; data(v: FileQuery): EndpointSuggestFiles; expand(v: FileExpandableItemsExpansionMap): EndpointSuggestFiles; extract(v: Extractor): EndpointSuggestFiles; } export interface EndpointSuggestOrders extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSuggestOrders; data(v: Query): EndpointSuggestOrders; expand(v: OrderExpandableItemsExpansionMap): EndpointSuggestOrders; extract(v: Extractor): EndpointSuggestOrders; } export interface EndpointSuggestProducts extends Endpoint { /** Ignore bundle variant types */ ignore_bundles(v: boolean): EndpointSuggestProducts; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSuggestProducts; data(v: Query): EndpointSuggestProducts; expand(v: ProductExpandableItemsExpansionMap): EndpointSuggestProducts; extract(v: Extractor): EndpointSuggestProducts; } export interface EndpointSuggestPromotions extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSuggestPromotions; data(v: Query): EndpointSuggestPromotions; expand(v: PromotionExpandableItemsExpansionMap): EndpointSuggestPromotions; extract(v: Extractor): EndpointSuggestPromotions; } export interface EndpointSuggestPurchaseOrders extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSuggestPurchaseOrders; data(v: Query): EndpointSuggestPurchaseOrders; expand(v: PurchaseOrderExpandableItemsExpansionMap): EndpointSuggestPurchaseOrders; extract(v: Extractor): EndpointSuggestPurchaseOrders; } export interface EndpointSuggestQuestions extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSuggestQuestions; data(v: Query): EndpointSuggestQuestions; expand(v: ProductQuestionExpandableItemsExpansionMap): EndpointSuggestQuestions; extract(v: Extractor): EndpointSuggestQuestions; } export interface EndpointSuggestReviews extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSuggestReviews; data(v: Query): EndpointSuggestReviews; expand(v: ProductReviewExpandableItemsExpansionMap): EndpointSuggestReviews; extract(v: Extractor): EndpointSuggestReviews; } export interface EndpointSuggestSubscriptions extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSuggestSubscriptions; data(v: Query): EndpointSuggestSubscriptions; expand(v: SubscriptionExpandableItemsExpansionMap): EndpointSuggestSubscriptions; extract(v: Extractor): EndpointSuggestSubscriptions; } export interface EndpointSuggestSuppliers extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSuggestSuppliers; data(v: Query): EndpointSuggestSuppliers; expand(v: SupplierExpandableItemsExpansionMap): EndpointSuggestSuppliers; extract(v: Extractor): EndpointSuggestSuppliers; } export interface EndpointSuggestSupportArticles extends Endpoint { data(v: Query): EndpointSuggestSupportArticles; expand(v: SupportArticleExpandableItemsExpansionMap): EndpointSuggestSupportArticles; extract(v: Extractor): EndpointSuggestSupportArticles; } export interface EndpointSuggestTransfers extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSuggestTransfers; data(v: Query): EndpointSuggestTransfers; expand(v: TransferExpandableItemsExpansionMap): EndpointSuggestTransfers; extract(v: Extractor): EndpointSuggestTransfers; } export interface EndpointSuppliersDelete extends Endpoint { /** List of supplier ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointSuppliersDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSuppliersDelete; } export interface EndpointSuppliers extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointSuppliers; /** List of supplier ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointSuppliers; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointSuppliers; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSuppliers; expand(v: SupplierExpansionMap): EndpointSuppliers; extract(v: Extractor>): EndpointSuppliers; } export interface EndpointSuppliersCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointSuppliersCreate; /** List of supplier ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointSuppliersModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSuppliersCreate; data(v: Array): EndpointSuppliersCreate; expand(v: SupplierExpansionMap): EndpointSuppliersCreate; extract(v: Extractor>): EndpointSuppliersCreate; } export interface EndpointSuppliersModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointSuppliersModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSuppliersModify; data(v: Array): EndpointSuppliersModify; expand(v: SupplierExpansionMap): EndpointSuppliersModify; extract(v: Extractor>): EndpointSuppliersModify; } export interface EndpointSuppliersExport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSuppliersExport; data(v: GenericExport): EndpointSuppliersExport; expand(v: ForeignShardedTaskExpansionMap): EndpointSuppliersExport; extract(v: Extractor): EndpointSuppliersExport; } export interface EndpointSuppliersImport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSuppliersImport; data(v: GenericImport): EndpointSuppliersImport; expand(v: ForeignShardedTaskExpansionMap): EndpointSuppliersImport; extract(v: Extractor): EndpointSuppliersImport; } export interface EndpointSuppliersPage extends Endpoint { /** Output filtering */ fields(v: Array): EndpointSuppliersPage; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointSuppliersPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointSuppliersPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointSuppliersPage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSuppliersPage; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: SuppliersPageSortBy): EndpointSuppliersPage; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointSuppliersPage; expand(v: SupplierPageExpansionMap): EndpointSuppliersPage; extract(v: Extractor): EndpointSuppliersPage; } export interface EndpointSupportArticles extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointSupportArticles; /** List of support article ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointSupportArticles; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointSupportArticles; expand(v: SupportArticleExpansionMap): EndpointSupportArticles; extract(v: Extractor>): EndpointSupportArticles; } export interface EndpointSupportArticlesPage extends Endpoint { /** Output filtering */ fields(v: Array): EndpointSupportArticlesPage; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointSupportArticlesPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointSupportArticlesPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointSupportArticlesPage; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: SupportArticlesPageSortBy): EndpointSupportArticlesPage; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointSupportArticlesPage; /** Filter support articles output by a type */ type(v: SupportArticleFilterType): EndpointSupportArticlesPage; expand(v: SupportArticlePageExpansionMap): EndpointSupportArticlesPage; extract(v: Extractor): EndpointSupportArticlesPage; } export interface EndpointSupportArticlesVote extends Endpoint { /** Unique support article identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ support_article_id(v: string): EndpointSupportArticlesVote; /** Should be "yes" or "no" */ vote(v: string): EndpointSupportArticlesVote; } export interface EndpointSurveyQuestionsDelete extends Endpoint { /** List of survey question ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointSurveyQuestionsDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSurveyQuestionsDelete; } export interface EndpointSurveyQuestions extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointSurveyQuestions; /** List of survey question ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointSurveyQuestions; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointSurveyQuestions; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSurveyQuestions; extract(v: Extractor>): EndpointSurveyQuestions; } export interface EndpointSurveyQuestionsCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointSurveyQuestionsCreate; /** List of survey question ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointSurveyQuestionsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSurveyQuestionsCreate; data(v: Array): EndpointSurveyQuestionsCreate; extract(v: Extractor>): EndpointSurveyQuestionsCreate; } export interface EndpointSurveyQuestionsModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointSurveyQuestionsModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSurveyQuestionsModify; data(v: Array): EndpointSurveyQuestionsModify; extract(v: Extractor>): EndpointSurveyQuestionsModify; } export interface EndpointSurveyQuestionsExport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSurveyQuestionsExport; data(v: GenericExport): EndpointSurveyQuestionsExport; expand(v: ForeignShardedTaskExpansionMap): EndpointSurveyQuestionsExport; extract(v: Extractor): EndpointSurveyQuestionsExport; } export interface EndpointSurveyQuestionsImport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointSurveyQuestionsImport; data(v: GenericImport): EndpointSurveyQuestionsImport; expand(v: ForeignShardedTaskExpansionMap): EndpointSurveyQuestionsImport; extract(v: Extractor): EndpointSurveyQuestionsImport; } export interface EndpointTasksDelete extends Endpoint { /** List of shop task ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointTasksDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTasksDelete; } export interface EndpointTasks extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointTasks; /** List of shop task ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointTasks; /** Include only incomplete tasks */ incomplete(v: boolean): EndpointTasks; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointTasks; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTasks; /** Filter tasks by type */ type(v: TaskTypeParam): EndpointTasks; extract(v: Extractor>): EndpointTasks; } export interface EndpointTasksCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointTasksCreate; /** List of shop task ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointTasksModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTasksCreate; data(v: Array): EndpointTasksCreate; extract(v: Extractor>): EndpointTasksCreate; } export interface EndpointTasksModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointTasksModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTasksModify; data(v: Array): EndpointTasksModify; extract(v: Extractor>): EndpointTasksModify; } export interface EndpointTasksResult extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTasksResult; /** Unique task identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ task_id(v: string): EndpointTasksResult; extract(v: Extractor): EndpointTasksResult; } export interface EndpointTaxClasses extends Endpoint> { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTaxClasses; extract(v: Extractor>): EndpointTaxClasses; } export interface EndpointTaxRulesDelete extends Endpoint { /** List of tax rule ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointTaxRulesDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTaxRulesDelete; } export interface EndpointTaxRules extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointTaxRules; /** List of tax rule ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointTaxRules; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointTaxRules; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTaxRules; expand(v: TaxRuleExpansionMap): EndpointTaxRules; extract(v: Extractor>): EndpointTaxRules; } export interface EndpointTaxRulesCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointTaxRulesCreate; /** List of tax rule ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointTaxRulesModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTaxRulesCreate; data(v: Array): EndpointTaxRulesCreate; expand(v: TaxRuleExpansionMap): EndpointTaxRulesCreate; extract(v: Extractor>): EndpointTaxRulesCreate; } export interface EndpointTaxRulesModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointTaxRulesModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTaxRulesModify; data(v: Array): EndpointTaxRulesModify; expand(v: TaxRuleExpansionMap): EndpointTaxRulesModify; extract(v: Extractor>): EndpointTaxRulesModify; } export interface EndpointTaxRulesAddDefault extends Endpoint { /** Country ISO code to add tax rules for */ country(v: string): EndpointTaxRulesAddDefault; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTaxRulesAddDefault; } export interface EndpointTaxRulesExport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTaxRulesExport; data(v: GenericExport): EndpointTaxRulesExport; expand(v: ForeignShardedTaskExpansionMap): EndpointTaxRulesExport; extract(v: Extractor): EndpointTaxRulesExport; } export interface EndpointTaxRulesImport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTaxRulesImport; data(v: GenericImport): EndpointTaxRulesImport; expand(v: ForeignShardedTaskExpansionMap): EndpointTaxRulesImport; extract(v: Extractor): EndpointTaxRulesImport; } export interface EndpointTaxSystemDelete extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTaxSystemDelete; } export interface EndpointTaxSystem extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTaxSystem; extract(v: Extractor): EndpointTaxSystem; } export interface EndpointTaxSystemCreate extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTaxSystemCreate; data(v: TaxSystemCreate): EndpointTaxSystemCreate; extract(v: Extractor): EndpointTaxSystemCreate; } export interface EndpointTaxSystemTest extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTaxSystemTest; extract(v: Extractor): EndpointTaxSystemTest; } export interface EndpointTransferNotesDelete extends Endpoint { /** List of transfer note ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointTransferNotesDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTransferNotesDelete; /** Unique transfer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ transfer_id(v: string): EndpointTransferNotesDelete; } export interface EndpointTransferNotes extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointTransferNotes; /** List of transfer note ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointTransferNotes; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTransferNotes; /** Unique transfer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ transfer_id(v: string): EndpointTransferNotes; expand(v: NoteExpansionMap): EndpointTransferNotes; extract(v: Extractor>): EndpointTransferNotes; } export interface EndpointTransferNotesCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointTransferNotesCreate; /** List of transfer note ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointTransferNotesModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTransferNotesCreate; /** Unique transfer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ transfer_id(v: string): EndpointTransferNotesCreate; data(v: Array): EndpointTransferNotesCreate; expand(v: NoteExpansionMap): EndpointTransferNotesCreate; extract(v: Extractor>): EndpointTransferNotesCreate; } export interface EndpointTransferNotesModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointTransferNotesModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTransferNotesModify; /** Unique transfer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ transfer_id(v: string): EndpointTransferNotesModify; data(v: Array): EndpointTransferNotesModify; expand(v: NoteExpansionMap): EndpointTransferNotesModify; extract(v: Extractor>): EndpointTransferNotesModify; } export interface EndpointTransfersDelete extends Endpoint { /** List of transfer ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointTransfersDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTransfersDelete; } export interface EndpointTransfers extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointTransfers; /** List of transfer ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointTransfers; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointTransfers; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTransfers; expand(v: TransferExpansionMap): EndpointTransfers; extract(v: Extractor>): EndpointTransfers; } export interface EndpointTransfersCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointTransfersCreate; /** List of transfer ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointTransfersModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTransfersCreate; data(v: Array): EndpointTransfersCreate; expand(v: TransferExpansionMap): EndpointTransfersCreate; extract(v: Extractor>): EndpointTransfersCreate; } export interface EndpointTransfersModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointTransfersModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTransfersModify; data(v: Array): EndpointTransfersModify; expand(v: TransferExpansionMap): EndpointTransfersModify; extract(v: Extractor>): EndpointTransfersModify; } export interface EndpointTransfersClose extends Endpoint { /** Output filtering */ fields(v: Array): EndpointTransfersClose; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTransfersClose; /** Unique transfer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ transfer_id(v: string): EndpointTransfersClose; expand(v: TransferExpansionMap): EndpointTransfersClose; extract(v: Extractor): EndpointTransfersClose; } export interface EndpointTransfersExport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTransfersExport; data(v: GenericExport): EndpointTransfersExport; expand(v: ForeignShardedTaskExpansionMap): EndpointTransfersExport; extract(v: Extractor): EndpointTransfersExport; } export interface EndpointTransfersImport extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTransfersImport; data(v: GenericImport): EndpointTransfersImport; expand(v: ForeignShardedTaskExpansionMap): EndpointTransfersImport; extract(v: Extractor): EndpointTransfersImport; } export interface EndpointTransfersLog extends Endpoint { /** Output filtering */ fields(v: Array): EndpointTransfersLog; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTransfersLog; /** Unique transfer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ transfer_id(v: string): EndpointTransfersLog; expand(v: TransferLogExpansionMap): EndpointTransfersLog; extract(v: Extractor): EndpointTransfersLog; } export interface EndpointTransfersOpen extends Endpoint { /** Output filtering */ fields(v: Array): EndpointTransfersOpen; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTransfersOpen; /** Unique transfer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ transfer_id(v: string): EndpointTransfersOpen; expand(v: TransferExpansionMap): EndpointTransfersOpen; extract(v: Extractor): EndpointTransfersOpen; } export interface EndpointTransfersPage extends Endpoint { /** Output filtering */ fields(v: Array): EndpointTransfersPage; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointTransfersPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointTransfersPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointTransfersPage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTransfersPage; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: TransfersPageSortBy): EndpointTransfersPage; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointTransfersPage; /** Filter transfers output by a transfer type */ type(v: TransferCategory): EndpointTransfersPage; expand(v: TransferPageExpansionMap): EndpointTransfersPage; extract(v: Extractor): EndpointTransfersPage; } export interface EndpointTransfersReceive extends Endpoint { /** Output filtering */ fields(v: Array): EndpointTransfersReceive; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTransfersReceive; /** Unique transfer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ transfer_id(v: string): EndpointTransfersReceive; data(v: TransferReceive): EndpointTransfersReceive; expand(v: TransferExpansionMap): EndpointTransfersReceive; extract(v: Extractor): EndpointTransfersReceive; } export interface EndpointTransfersReject extends Endpoint { /** Output filtering */ fields(v: Array): EndpointTransfersReject; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointTransfersReject; /** Unique transfer identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ transfer_id(v: string): EndpointTransfersReject; data(v: TransferReject): EndpointTransfersReject; expand(v: TransferExpansionMap): EndpointTransfersReject; extract(v: Extractor): EndpointTransfersReject; } export interface EndpointUsage extends Endpoint> { /** Upper boundary */ max(v: string): EndpointUsage; /** Lower boundary */ min(v: string): EndpointUsage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointUsage; extract(v: Extractor>): EndpointUsage; } export interface EndpointUserFilesDelete extends Endpoint { /** Unique user identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ user_id(v: string): EndpointUserFilesDelete; } export interface EndpointUserFiles extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointUserFiles; /** List of user ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointUserFiles; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointUserFiles; extract(v: Extractor>): EndpointUserFiles; } export interface EndpointUserFilesCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointUserFilesCreate; /** Unique user identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ user_id(v: string): EndpointUserFilesCreate; data(v: Array): EndpointUserFilesCreate; extract(v: Extractor>): EndpointUserFilesCreate; } export interface EndpointUsersDelete extends Endpoint { /** List of user ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointUsersDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointUsersDelete; } export interface EndpointUsers extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointUsers; /** List of user ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointUsers; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointUsers; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointUsers; expand(v: UserExpansionMap): EndpointUsers; extract(v: Extractor>): EndpointUsers; } export interface EndpointUsersCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointUsersCreate; /** List of user ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointUsersModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointUsersCreate; data(v: Array): EndpointUsersCreate; expand(v: UserExpansionMap): EndpointUsersCreate; extract(v: Extractor>): EndpointUsersCreate; } export interface EndpointUsersModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointUsersModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointUsersModify; data(v: Array): EndpointUsersModify; expand(v: UserExpansionMap): EndpointUsersModify; extract(v: Extractor>): EndpointUsersModify; } export interface EndpointUsersOauthDelete extends Endpoint { } export interface EndpointUsersOauth extends Endpoint { /** OAuth2 authorization code provided by the provider */ code(v: string): EndpointUsersOauth; /** OAuth2 provider used for registering this account */ provider(v: OAuth2Provider): EndpointUsersOauth; } export interface EndpointUsersTwoFactorDelete extends Endpoint { /** 2FA Code */ code(v: string): EndpointUsersTwoFactorDelete; } export interface EndpointUsersTwoFactor extends Endpoint { data(v: TwoFactorConfig): EndpointUsersTwoFactor; extract(v: Extractor): EndpointUsersTwoFactor; } export interface EndpointUsersTwoFactorBackupPhone extends Endpoint { data(v: TwoFactorConfig): EndpointUsersTwoFactorBackupPhone; } export interface EndpointUsersTwoFactorRecoveryCodes extends Endpoint> { /** 2FA Code */ code(v: string): EndpointUsersTwoFactorRecoveryCodes; extract(v: Extractor>): EndpointUsersTwoFactorRecoveryCodes; } export interface EndpointUsersTwoFactorRecoveryCodesShow extends Endpoint> { /** 2FA Code */ code(v: string): EndpointUsersTwoFactorRecoveryCodesShow; extract(v: Extractor>): EndpointUsersTwoFactorRecoveryCodesShow; } export interface EndpointUsersTwoFactorValidate extends Endpoint> { /** 2FA App Code */ app_code(v: string): EndpointUsersTwoFactorValidate; /** 2FA Phone Code */ phone_code(v: string): EndpointUsersTwoFactorValidate; extract(v: Extractor>): EndpointUsersTwoFactorValidate; } export interface EndpointVariantInventoryDelete extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointVariantInventoryDelete; /** Unique variant identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ variant_id(v: string): EndpointVariantInventoryDelete; } export interface EndpointVariantInventory extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointVariantInventory; /** List of variant ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointVariantInventory; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointVariantInventory; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointVariantInventory; expand(v: VariantInventoryExpansionMap): EndpointVariantInventory; extract(v: Extractor>): EndpointVariantInventory; } export interface EndpointVariantInventoryCreate extends Endpoint { /** Output filtering */ fields(v: Array): EndpointVariantInventoryCreate; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointVariantInventoryCreate; /** Unique variant identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ variant_id(v: string): EndpointVariantInventoryCreate; data(v: Array): EndpointVariantInventoryCreate; expand(v: VariantInventoryExpansionMap): EndpointVariantInventoryCreate; extract(v: Extractor): EndpointVariantInventoryCreate; } export interface EndpointVariantInventoryLogPage extends Endpoint { /** Output filtering */ fields(v: Array): EndpointVariantInventoryLogPage; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointVariantInventoryLogPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointVariantInventoryLogPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointVariantInventoryLogPage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointVariantInventoryLogPage; /** Whether to sort output in some specific way. See also: [Pagination](/overview/concepts/pagination) */ sort_by(v: VariantInventoryLogPageSortBy): EndpointVariantInventoryLogPage; /** Whether to use descending sort order. See also: [Pagination](/overview/concepts/pagination) */ sort_desc(v: boolean): EndpointVariantInventoryLogPage; /** Unique variant identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ variant_id(v: string): EndpointVariantInventoryLogPage; expand(v: VariantInventoryLogPageExpansionMap): EndpointVariantInventoryLogPage; extract(v: Extractor): EndpointVariantInventoryLogPage; } export interface EndpointWebhooksDelete extends Endpoint { /** List of webhook ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointWebhooksDelete; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointWebhooksDelete; } export interface EndpointWebhooks extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointWebhooks; /** List of webhook ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointWebhooks; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointWebhooks; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointWebhooks; extract(v: Extractor>): EndpointWebhooks; } export interface EndpointWebhooksCreate extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointWebhooksCreate; /** List of webhook ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointWebhooksModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointWebhooksCreate; data(v: Array): EndpointWebhooksCreate; extract(v: Extractor>): EndpointWebhooksCreate; } export interface EndpointWebhooksModify extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointWebhooksModify; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointWebhooksModify; data(v: Array): EndpointWebhooksModify; extract(v: Extractor>): EndpointWebhooksModify; } export interface EndpointWebhooksEvents extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointWebhooksEvents; /** List of webhook event ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ ids(v: Array): EndpointWebhooksEvents; /** When asking for multiple items, allow returning less than was asked (in case some are missing) */ loose(v: boolean): EndpointWebhooksEvents; expand(v: WebhookEventExpansionMap): EndpointWebhooksEvents; extract(v: Extractor>): EndpointWebhooksEvents; } export interface EndpointWebhooksEventsPage extends Endpoint { /** Output filtering */ fields(v: Array): EndpointWebhooksEventsPage; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointWebhooksEventsPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointWebhooksEventsPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointWebhooksEventsPage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointWebhooksEventsPage; expand(v: WebhookEventPageExpansionMap): EndpointWebhooksEventsPage; extract(v: Extractor): EndpointWebhooksEventsPage; } export interface EndpointWebhooksStatusPage extends Endpoint { /** Output filtering */ fields(v: Array): EndpointWebhooksStatusPage; /** Key of the last item from previous page. See also: [Pagination](/overview/concepts/pagination) */ last_key(v: string): EndpointWebhooksStatusPage; /** Return up to N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ limit(v: number): EndpointWebhooksStatusPage; /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */ offset(v: number): EndpointWebhooksStatusPage; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointWebhooksStatusPage; /** Filter results by a webhook id */ webhook_id(v: string): EndpointWebhooksStatusPage; expand(v: WebhookEventStatusPageExpansionMap): EndpointWebhooksStatusPage; extract(v: Extractor): EndpointWebhooksStatusPage; } export interface EndpointXeroDelete extends Endpoint { /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointXeroDelete; } export interface EndpointXero extends Endpoint { /** Output filtering */ fields(v: Array): EndpointXero; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointXero; expand(v: XeroSettingsExpansionMap): EndpointXero; extract(v: Extractor): EndpointXero; } export interface EndpointXeroCreate extends Endpoint { /** Output filtering */ fields(v: Array): EndpointXeroCreate; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointXeroCreate; data(v: XeroSettingsCreate): EndpointXeroCreate; expand(v: XeroSettingsExpansionMap): EndpointXeroCreate; extract(v: Extractor): EndpointXeroCreate; } export interface EndpointXeroAccounts extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointXeroAccounts; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointXeroAccounts; extract(v: Extractor>): EndpointXeroAccounts; } export interface EndpointXeroAuthorize extends Endpoint { /** OAuth verification code */ code(v: string): EndpointXeroAuthorize; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointXeroAuthorize; } export interface EndpointXeroLog extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointXeroLog; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointXeroLog; extract(v: Extractor>): EndpointXeroLog; } export interface EndpointXeroTaxRates extends Endpoint> { /** Output filtering */ fields(v: Array): EndpointXeroTaxRates; /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */ shop_id(v: string): EndpointXeroTaxRates; extract(v: Extractor>): EndpointXeroTaxRates; } export interface ReqFunction { (ctx: Context, v: "GET:activities/page.json"): EndpointActivitiesPage; (ctx: Context, v: "GET:addresses/short.json"): EndpointAddressesShort; (ctx: Context, v: "POST:addresses/short.json"): EndpointAddressesShortCreate; (ctx: Context, v: "GET:analytics/audit.json"): EndpointAnalyticsAudit; (ctx: Context, v: "POST:analytics/audit/export.json"): EndpointAnalyticsAuditExport; (ctx: Context, v: "POST:analytics/custom_report.json"): EndpointAnalyticsCustomReport; (ctx: Context, v: "GET:analytics/custom_reports.json"): EndpointAnalyticsCustomReports; (ctx: Context, v: "POST:analytics/custom_reports.json"): EndpointAnalyticsCustomReportsCreate; (ctx: Context, v: "GET:analytics/dashboard_layout.json"): EndpointAnalyticsDashboardLayout; (ctx: Context, v: "POST:analytics/dashboard_layout.json"): EndpointAnalyticsDashboardLayoutCreate; (ctx: Context, v: "GET:analytics/geoip.json"): EndpointAnalyticsGeoip; (ctx: Context, v: "POST:analytics/report.json"): EndpointAnalyticsReport; (ctx: Context, v: "POST:analytics/report/export.json"): EndpointAnalyticsReportExport; (ctx: Context, v: "POST:attachments.json"): EndpointAttachments; (ctx: Context, v: "POST:auth/confirm.json"): EndpointAuthConfirm; (ctx: Context, v: "POST:auth/login.json"): EndpointAuthLogin; (ctx: Context, v: "POST:auth/password/complete.json"): EndpointAuthPasswordComplete; (ctx: Context, v: "POST:auth/password/reset.json"): EndpointAuthPasswordReset; (ctx: Context, v: "POST:auth/password/verify.json"): EndpointAuthPasswordVerify; (ctx: Context, v: "POST:auth/refresh.json"): EndpointAuthRefresh; (ctx: Context, v: "POST:autocomplete/customers.json"): EndpointAutocompleteCustomers; (ctx: Context, v: "POST:autocomplete/products.json"): EndpointAutocompleteProducts; (ctx: Context, v: "GET:blogs.json"): EndpointBlogs; (ctx: Context, v: "GET:blogs/page.json"): EndpointBlogsPage; (ctx: Context, v: "GET:branding.json"): EndpointBranding; (ctx: Context, v: "POST:branding.json"): EndpointBrandingCreate; (ctx: Context, v: "GET:branding/default.json"): EndpointBrandingDefault; (ctx: Context, v: "DELETE:brands.json"): EndpointBrandsDelete; (ctx: Context, v: "GET:brands.json"): EndpointBrands; (ctx: Context, v: "POST:brands.json"): EndpointBrandsCreate; (ctx: Context, v: "POST:brands/export.json"): EndpointBrandsExport; (ctx: Context, v: "POST:brands/import.json"): EndpointBrandsImport; (ctx: Context, v: "GET:brands/page.json"): EndpointBrandsPage; (ctx: Context, v: "DELETE:buy_links.json"): EndpointBuyLinksDelete; (ctx: Context, v: "GET:buy_links.json"): EndpointBuyLinks; (ctx: Context, v: "POST:buy_links.json"): EndpointBuyLinksCreate; (ctx: Context, v: "POST:buy_links/export.json"): EndpointBuyLinksExport; (ctx: Context, v: "POST:buy_links/import.json"): EndpointBuyLinksImport; (ctx: Context, v: "DELETE:categories.json"): EndpointCategoriesDelete; (ctx: Context, v: "GET:categories.json"): EndpointCategories; (ctx: Context, v: "POST:categories.json"): EndpointCategoriesCreate; (ctx: Context, v: "POST:categories/export.json"): EndpointCategoriesExport; (ctx: Context, v: "POST:categories/import.json"): EndpointCategoriesImport; (ctx: Context, v: "DELETE:content_blocks.json"): EndpointContentBlocksDelete; (ctx: Context, v: "GET:content_blocks.json"): EndpointContentBlocks; (ctx: Context, v: "POST:content_blocks.json"): EndpointContentBlocksCreate; (ctx: Context, v: "POST:content_blocks/export.json"): EndpointContentBlocksExport; (ctx: Context, v: "POST:content_blocks/import.json"): EndpointContentBlocksImport; (ctx: Context, v: "GET:content_blocks/page.json"): EndpointContentBlocksPage; (ctx: Context, v: "DELETE:content_models.json"): EndpointContentModelsDelete; (ctx: Context, v: "GET:content_models.json"): EndpointContentModels; (ctx: Context, v: "POST:content_models.json"): EndpointContentModelsCreate; (ctx: Context, v: "GET:countries.json"): EndpointCountries; (ctx: Context, v: "DELETE:coupons.json"): EndpointCouponsDelete; (ctx: Context, v: "GET:coupons.json"): EndpointCoupons; (ctx: Context, v: "POST:coupons.json"): EndpointCouponsCreate; (ctx: Context, v: "POST:coupons/generate.json"): EndpointCouponsGenerate; (ctx: Context, v: "GET:coupons/page.json"): EndpointCouponsPage; (ctx: Context, v: "DELETE:currencies.json"): EndpointCurrenciesDelete; (ctx: Context, v: "GET:currencies.json"): EndpointCurrencies; (ctx: Context, v: "POST:currencies.json"): EndpointCurrenciesCreate; (ctx: Context, v: "GET:customer_balance.json"): EndpointCustomerBalance; (ctx: Context, v: "POST:customer_balance/apply_gift_card.json"): EndpointCustomerBalanceApplyGiftCard; (ctx: Context, v: "GET:customer_balance/history.json"): EndpointCustomerBalanceHistory; (ctx: Context, v: "POST:customer_balance/transaction.json"): EndpointCustomerBalanceTransactionCreate; (ctx: Context, v: "DELETE:customer_groups.json"): EndpointCustomerGroupsDelete; (ctx: Context, v: "GET:customer_groups.json"): EndpointCustomerGroups; (ctx: Context, v: "POST:customer_groups.json"): EndpointCustomerGroupsCreate; (ctx: Context, v: "POST:customer_groups/export.json"): EndpointCustomerGroupsExport; (ctx: Context, v: "POST:customer_groups/import.json"): EndpointCustomerGroupsImport; (ctx: Context, v: "GET:customer_inventory.json"): EndpointCustomerInventory; (ctx: Context, v: "POST:customer_inventory.json"): EndpointCustomerInventoryCreate; (ctx: Context, v: "POST:customer_inventory/download.json"): EndpointCustomerInventoryDownload; (ctx: Context, v: "POST:customer_inventory/export.json"): EndpointCustomerInventoryExport; (ctx: Context, v: "GET:customer_inventory/page.json"): EndpointCustomerInventoryPage; (ctx: Context, v: "DELETE:customer_inventory_notes.json"): EndpointCustomerInventoryNotesDelete; (ctx: Context, v: "GET:customer_inventory_notes.json"): EndpointCustomerInventoryNotes; (ctx: Context, v: "POST:customer_inventory_notes.json"): EndpointCustomerInventoryNotesCreate; (ctx: Context, v: "DELETE:customer_notes.json"): EndpointCustomerNotesDelete; (ctx: Context, v: "GET:customer_notes.json"): EndpointCustomerNotes; (ctx: Context, v: "POST:customer_notes.json"): EndpointCustomerNotesCreate; (ctx: Context, v: "DELETE:customers.json"): EndpointCustomersDelete; (ctx: Context, v: "GET:customers.json"): EndpointCustomers; (ctx: Context, v: "POST:customers.json"): EndpointCustomersCreate; (ctx: Context, v: "POST:customers/auth/password/reset.json"): EndpointCustomersAuthPasswordReset; (ctx: Context, v: "POST:customers/export.json"): EndpointCustomersExport; (ctx: Context, v: "POST:customers/import.json"): EndpointCustomersImport; (ctx: Context, v: "GET:customers/page.json"): EndpointCustomersPage; (ctx: Context, v: "DELETE:customers/payment_sources.json"): EndpointCustomersPaymentSourcesDelete; (ctx: Context, v: "GET:customers/payment_sources.json"): EndpointCustomersPaymentSources; (ctx: Context, v: "POST:customers/payment_sources.json"): EndpointCustomersPaymentSourcesCreate; (ctx: Context, v: "DELETE:data_feeds.json"): EndpointDataFeedsDelete; (ctx: Context, v: "GET:data_feeds.json"): EndpointDataFeeds; (ctx: Context, v: "POST:data_feeds.json"): EndpointDataFeedsCreate; (ctx: Context, v: "POST:data_feeds/preview.json"): EndpointDataFeedsPreview; (ctx: Context, v: "DELETE:devices.json"): EndpointDevicesDelete; (ctx: Context, v: "GET:devices.json"): EndpointDevices; (ctx: Context, v: "POST:devices.json"): EndpointDevices; (ctx: Context, v: "DELETE:domains.json"): EndpointDomainsDelete; (ctx: Context, v: "GET:domains.json"): EndpointDomains; (ctx: Context, v: "POST:domains.json"): EndpointDomainsCreate; (ctx: Context, v: "POST:domains/fetch_cert.json"): EndpointDomainsFetchCert; (ctx: Context, v: "POST:domains/send_instructions.json"): EndpointDomainsSendInstructions; (ctx: Context, v: "DELETE:email/messages.json"): EndpointEmailMessagesDelete; (ctx: Context, v: "GET:email/messages/page.json"): EndpointEmailMessagesPage; (ctx: Context, v: "DELETE:favorites.json"): EndpointFavoritesDelete; (ctx: Context, v: "GET:favorites.json"): EndpointFavorites; (ctx: Context, v: "POST:favorites.json"): EndpointFavoritesCreate; (ctx: Context, v: "GET:favorites/page.json"): EndpointFavoritesPage; (ctx: Context, v: "DELETE:files.json"): EndpointFilesDelete; (ctx: Context, v: "GET:files.json"): EndpointFiles; (ctx: Context, v: "POST:files.json"): EndpointFilesCreate; (ctx: Context, v: "GET:files/download.json"): EndpointFilesDownload; (ctx: Context, v: "GET:files/lookup.json"): EndpointFilesLookup; (ctx: Context, v: "GET:files/page.json"): EndpointFilesPage; (ctx: Context, v: "POST:files/sign.json"): EndpointFilesSign; (ctx: Context, v: "POST:files/upload.json"): EndpointFilesUpload; (ctx: Context, v: "POST:files/uploaded.json"): EndpointFilesUploaded; (ctx: Context, v: "DELETE:gateways.json"): EndpointGatewaysDelete; (ctx: Context, v: "GET:gateways.json"): EndpointGateways; (ctx: Context, v: "POST:gateways.json"): EndpointGatewaysCreate; (ctx: Context, v: "DELETE:gateways/apple_pay_domains.json"): EndpointGatewaysApplePayDomainsDelete; (ctx: Context, v: "GET:gateways/apple_pay_domains.json"): EndpointGatewaysApplePayDomains; (ctx: Context, v: "POST:gateways/apple_pay_domains.json"): EndpointGatewaysApplePayDomainsCreate; (ctx: Context, v: "POST:gateways/paypal.json"): EndpointGatewaysPaypal; (ctx: Context, v: "GET:info/all_provinces.json"): EndpointInfoAllProvinces; (ctx: Context, v: "GET:info/carrier_packaging.json"): EndpointInfoCarrierPackaging; (ctx: Context, v: "GET:info/content_models.json"): EndpointInfoContentModels; (ctx: Context, v: "GET:info/countries.json"): EndpointInfoCountries; (ctx: Context, v: "GET:info/csv_format.json"): EndpointInfoCsvFormat; (ctx: Context, v: "GET:info/currencies.json"): EndpointInfoCurrencies; (ctx: Context, v: "GET:info/data_feeds.json"): EndpointInfoDataFeeds; (ctx: Context, v: "GET:info/hs_codes.json"): EndpointInfoHsCodes; (ctx: Context, v: "GET:info/languages.json"): EndpointInfoLanguages; (ctx: Context, v: "GET:info/mcc_codes.json"): EndpointInfoMccCodes; (ctx: Context, v: "GET:info/permissions.json"): EndpointInfoPermissions; (ctx: Context, v: "GET:info/plans.json"): EndpointInfoPlans; (ctx: Context, v: "GET:info/provinces.json"): EndpointInfoProvinces; (ctx: Context, v: "GET:info/roles.json"): EndpointInfoRoles; (ctx: Context, v: "GET:info/shipping_providers.json"): EndpointInfoShippingProviders; (ctx: Context, v: "GET:info/timezones.json"): EndpointInfoTimezones; (ctx: Context, v: "GET:info/webhooks.json"): EndpointInfoWebhooks; (ctx: Context, v: "GET:inventory_locations.json"): EndpointInventoryLocations; (ctx: Context, v: "POST:inventory_locations.json"): EndpointInventoryLocationsCreate; (ctx: Context, v: "POST:inventory_locations/export.json"): EndpointInventoryLocationsExport; (ctx: Context, v: "POST:inventory_locations/import.json"): EndpointInventoryLocationsImport; (ctx: Context, v: "POST:inventory_locations/migrate.json"): EndpointInventoryLocationsMigrate; (ctx: Context, v: "POST:inventory_locations/toggle.json"): EndpointInventoryLocationsToggle; (ctx: Context, v: "DELETE:inventory_rules.json"): EndpointInventoryRulesDelete; (ctx: Context, v: "GET:inventory_rules.json"): EndpointInventoryRules; (ctx: Context, v: "POST:inventory_rules.json"): EndpointInventoryRulesCreate; (ctx: Context, v: "POST:inventory_rules/export.json"): EndpointInventoryRulesExport; (ctx: Context, v: "POST:inventory_rules/import.json"): EndpointInventoryRulesImport; (ctx: Context, v: "DELETE:invitations.json"): EndpointInvitationsDelete; (ctx: Context, v: "GET:invitations.json"): EndpointInvitations; (ctx: Context, v: "POST:invitations.json"): EndpointInvitationsCreate; (ctx: Context, v: "POST:invitations/accept.json"): EndpointInvitationsAccept; (ctx: Context, v: "GET:invoices.json"): EndpointInvoices; (ctx: Context, v: "GET:invoices/page.json"): EndpointInvoicesPage; (ctx: Context, v: "DELETE:keys.json"): EndpointKeysDelete; (ctx: Context, v: "GET:keys.json"): EndpointKeys; (ctx: Context, v: "POST:keys.json"): EndpointKeysCreate; (ctx: Context, v: "DELETE:menus.json"): EndpointMenusDelete; (ctx: Context, v: "GET:menus.json"): EndpointMenus; (ctx: Context, v: "POST:menus.json"): EndpointMenusCreate; (ctx: Context, v: "POST:menus/export.json"): EndpointMenusExport; (ctx: Context, v: "POST:menus/import.json"): EndpointMenusImport; (ctx: Context, v: "GET:menus/page.json"): EndpointMenusPage; (ctx: Context, v: "GET:message.json"): EndpointMessage; (ctx: Context, v: "POST:message.json"): EndpointMessage; (ctx: Context, v: "DELETE:option_sets.json"): EndpointOptionSetsDelete; (ctx: Context, v: "GET:option_sets.json"): EndpointOptionSets; (ctx: Context, v: "POST:option_sets.json"): EndpointOptionSetsCreate; (ctx: Context, v: "POST:option_sets/export.json"): EndpointOptionSetsExport; (ctx: Context, v: "POST:option_sets/import.json"): EndpointOptionSetsImport; (ctx: Context, v: "DELETE:options.json"): EndpointOptionsDelete; (ctx: Context, v: "GET:options.json"): EndpointOptions; (ctx: Context, v: "POST:options.json"): EndpointOptionsCreate; (ctx: Context, v: "POST:options/export.json"): EndpointOptionsExport; (ctx: Context, v: "POST:options/import.json"): EndpointOptionsImport; (ctx: Context, v: "GET:order_fulfillments.json"): EndpointOrderFulfillments; (ctx: Context, v: "POST:order_fulfillments.json"): EndpointOrderFulfillmentsCreate; (ctx: Context, v: "POST:order_fulfillments/cancel.json"): EndpointOrderFulfillmentsCancel; (ctx: Context, v: "POST:order_fulfillments/complete.json"): EndpointOrderFulfillmentsComplete; (ctx: Context, v: "POST:order_fulfillments/events.json"): EndpointOrderFulfillmentsEventsCreate; (ctx: Context, v: "DELETE:order_notes.json"): EndpointOrderNotesDelete; (ctx: Context, v: "GET:order_notes.json"): EndpointOrderNotes; (ctx: Context, v: "POST:order_notes.json"): EndpointOrderNotesCreate; (ctx: Context, v: "DELETE:order_risks.json"): EndpointOrderRisksDelete; (ctx: Context, v: "GET:order_risks.json"): EndpointOrderRisks; (ctx: Context, v: "POST:order_risks.json"): EndpointOrderRisksCreate; (ctx: Context, v: "DELETE:orders.json"): EndpointOrdersDelete; (ctx: Context, v: "GET:orders.json"): EndpointOrders; (ctx: Context, v: "POST:orders.json"): EndpointOrdersCreate; (ctx: Context, v: "POST:orders/allocate_number.json"): EndpointOrdersAllocateNumber; (ctx: Context, v: "POST:orders/calculate.json"): EndpointOrdersCalculate; (ctx: Context, v: "POST:orders/calculate_refund.json"): EndpointOrdersCalculateRefund; (ctx: Context, v: "POST:orders/cancel.json"): EndpointOrdersCancel; (ctx: Context, v: "POST:orders/cancel_reservation.json"): EndpointOrdersCancelReservation; (ctx: Context, v: "POST:orders/capture.json"): EndpointOrdersCapture; (ctx: Context, v: "POST:orders/close.json"): EndpointOrdersClose; (ctx: Context, v: "POST:orders/download.json"): EndpointOrdersDownload; (ctx: Context, v: "POST:orders/export.json"): EndpointOrdersExport; (ctx: Context, v: "POST:orders/open.json"): EndpointOrdersOpen; (ctx: Context, v: "POST:orders/override.json"): EndpointOrdersOverride; (ctx: Context, v: "GET:orders/page.json"): EndpointOrdersPage; (ctx: Context, v: "POST:orders/pay.json"): EndpointOrdersPay; (ctx: Context, v: "POST:orders/refund.json"): EndpointOrdersRefund; (ctx: Context, v: "POST:orders/reserve.json"): EndpointOrdersReserve; (ctx: Context, v: "POST:orders/restock.json"): EndpointOrdersRestock; (ctx: Context, v: "POST:orders/send_invoice.json"): EndpointOrdersSendInvoice; (ctx: Context, v: "POST:orders/send_reminder.json"): EndpointOrdersSendReminder; (ctx: Context, v: "DELETE:packaging.json"): EndpointPackagingDelete; (ctx: Context, v: "GET:packaging.json"): EndpointPackaging; (ctx: Context, v: "POST:packaging.json"): EndpointPackagingCreate; (ctx: Context, v: "POST:packaging/export.json"): EndpointPackagingExport; (ctx: Context, v: "POST:packaging/import.json"): EndpointPackagingImport; (ctx: Context, v: "DELETE:payment_methods.json"): EndpointPaymentMethodsDelete; (ctx: Context, v: "GET:payment_methods.json"): EndpointPaymentMethods; (ctx: Context, v: "POST:payment_methods.json"): EndpointPaymentMethodsCreate; (ctx: Context, v: "GET:plan.json"): EndpointPlan; (ctx: Context, v: "POST:plan.json"): EndpointPlanCreate; (ctx: Context, v: "POST:plan/confirm.json"): EndpointPlanConfirm; (ctx: Context, v: "POST:plan/preview.json"): EndpointPlanPreview; (ctx: Context, v: "DELETE:product_field_sets.json"): EndpointProductFieldSetsDelete; (ctx: Context, v: "GET:product_field_sets.json"): EndpointProductFieldSets; (ctx: Context, v: "POST:product_field_sets.json"): EndpointProductFieldSetsCreate; (ctx: Context, v: "POST:product_field_sets/export.json"): EndpointProductFieldSetsExport; (ctx: Context, v: "POST:product_field_sets/import.json"): EndpointProductFieldSetsImport; (ctx: Context, v: "DELETE:product_questions.json"): EndpointProductQuestionsDelete; (ctx: Context, v: "GET:product_questions.json"): EndpointProductQuestions; (ctx: Context, v: "POST:product_questions.json"): EndpointProductQuestionsCreate; (ctx: Context, v: "DELETE:product_questions/answers.json"): EndpointProductQuestionsAnswersDelete; (ctx: Context, v: "GET:product_questions/answers.json"): EndpointProductQuestionsAnswers; (ctx: Context, v: "POST:product_questions/answers.json"): EndpointProductQuestionsAnswersCreate; (ctx: Context, v: "GET:product_questions/answers/page.json"): EndpointProductQuestionsAnswersPage; (ctx: Context, v: "GET:product_questions/page.json"): EndpointProductQuestionsPage; (ctx: Context, v: "DELETE:product_reviews.json"): EndpointProductReviewsDelete; (ctx: Context, v: "GET:product_reviews.json"): EndpointProductReviews; (ctx: Context, v: "POST:product_reviews.json"): EndpointProductReviewsCreate; (ctx: Context, v: "DELETE:product_reviews/answers.json"): EndpointProductReviewsAnswersDelete; (ctx: Context, v: "GET:product_reviews/answers.json"): EndpointProductReviewsAnswers; (ctx: Context, v: "POST:product_reviews/answers.json"): EndpointProductReviewsAnswersCreate; (ctx: Context, v: "GET:product_reviews/answers/page.json"): EndpointProductReviewsAnswersPage; (ctx: Context, v: "GET:product_reviews/page.json"): EndpointProductReviewsPage; (ctx: Context, v: "GET:product_reviews/settings.json"): EndpointProductReviewsSettings; (ctx: Context, v: "POST:product_reviews/settings.json"): EndpointProductReviewsSettingsCreate; (ctx: Context, v: "DELETE:product_variants.json"): EndpointProductVariantsDelete; (ctx: Context, v: "GET:product_variants.json"): EndpointProductVariants; (ctx: Context, v: "POST:product_variants.json"): EndpointProductVariantsCreate; (ctx: Context, v: "GET:product_variants/page.json"): EndpointProductVariantsPage; (ctx: Context, v: "DELETE:products.json"): EndpointProductsDelete; (ctx: Context, v: "GET:products.json"): EndpointProducts; (ctx: Context, v: "POST:products.json"): EndpointProductsCreate; (ctx: Context, v: "POST:products/export.json"): EndpointProductsExport; (ctx: Context, v: "POST:products/import.json"): EndpointProductsImport; (ctx: Context, v: "GET:products/page.json"): EndpointProductsPage; (ctx: Context, v: "DELETE:promotions.json"): EndpointPromotionsDelete; (ctx: Context, v: "GET:promotions.json"): EndpointPromotions; (ctx: Context, v: "POST:promotions.json"): EndpointPromotionsCreate; (ctx: Context, v: "POST:promotions/export.json"): EndpointPromotionsExport; (ctx: Context, v: "POST:promotions/import.json"): EndpointPromotionsImport; (ctx: Context, v: "GET:promotions/page.json"): EndpointPromotionsPage; (ctx: Context, v: "GET:provinces.json"): EndpointProvinces; (ctx: Context, v: "DELETE:purchase_order_notes.json"): EndpointPurchaseOrderNotesDelete; (ctx: Context, v: "GET:purchase_order_notes.json"): EndpointPurchaseOrderNotes; (ctx: Context, v: "POST:purchase_order_notes.json"): EndpointPurchaseOrderNotesCreate; (ctx: Context, v: "DELETE:purchase_orders.json"): EndpointPurchaseOrdersDelete; (ctx: Context, v: "GET:purchase_orders.json"): EndpointPurchaseOrders; (ctx: Context, v: "POST:purchase_orders.json"): EndpointPurchaseOrdersCreate; (ctx: Context, v: "POST:purchase_orders/close.json"): EndpointPurchaseOrdersClose; (ctx: Context, v: "POST:purchase_orders/export.json"): EndpointPurchaseOrdersExport; (ctx: Context, v: "POST:purchase_orders/import.json"): EndpointPurchaseOrdersImport; (ctx: Context, v: "GET:purchase_orders/log.json"): EndpointPurchaseOrdersLog; (ctx: Context, v: "POST:purchase_orders/open.json"): EndpointPurchaseOrdersOpen; (ctx: Context, v: "GET:purchase_orders/page.json"): EndpointPurchaseOrdersPage; (ctx: Context, v: "POST:purchase_orders/receive.json"): EndpointPurchaseOrdersReceive; (ctx: Context, v: "POST:purchase_orders/reject.json"): EndpointPurchaseOrdersReject; (ctx: Context, v: "DELETE:quickbooks.json"): EndpointQuickbooksDelete; (ctx: Context, v: "GET:quickbooks.json"): EndpointQuickbooks; (ctx: Context, v: "POST:quickbooks.json"): EndpointQuickbooksCreate; (ctx: Context, v: "GET:quickbooks/accounts.json"): EndpointQuickbooksAccounts; (ctx: Context, v: "POST:quickbooks/authorize.json"): EndpointQuickbooksAuthorize; (ctx: Context, v: "GET:quickbooks/log.json"): EndpointQuickbooksLog; (ctx: Context, v: "GET:quickbooks/tax_rates.json"): EndpointQuickbooksTaxRates; (ctx: Context, v: "POST:requests.json"): EndpointRequests; (ctx: Context, v: "DELETE:return_inspections.json"): EndpointReturnInspectionsDelete; (ctx: Context, v: "GET:return_inspections.json"): EndpointReturnInspections; (ctx: Context, v: "POST:return_inspections.json"): EndpointReturnInspectionsCreate; (ctx: Context, v: "POST:return_inspections/add_default.json"): EndpointReturnInspectionsAddDefault; (ctx: Context, v: "DELETE:return_notes.json"): EndpointReturnNotesDelete; (ctx: Context, v: "GET:return_notes.json"): EndpointReturnNotes; (ctx: Context, v: "POST:return_notes.json"): EndpointReturnNotesCreate; (ctx: Context, v: "DELETE:return_policies.json"): EndpointReturnPoliciesDelete; (ctx: Context, v: "GET:return_policies.json"): EndpointReturnPolicies; (ctx: Context, v: "POST:return_policies.json"): EndpointReturnPoliciesCreate; (ctx: Context, v: "DELETE:return_reasons.json"): EndpointReturnReasonsDelete; (ctx: Context, v: "GET:return_reasons.json"): EndpointReturnReasons; (ctx: Context, v: "POST:return_reasons.json"): EndpointReturnReasonsCreate; (ctx: Context, v: "POST:return_reasons/add_default.json"): EndpointReturnReasonsAddDefault; (ctx: Context, v: "GET:returns.json"): EndpointReturns; (ctx: Context, v: "POST:returns.json"): EndpointReturnsCreate; (ctx: Context, v: "POST:returns/approve.json"): EndpointReturnsApprove; (ctx: Context, v: "POST:returns/check.json"): EndpointReturnsCheck; (ctx: Context, v: "POST:returns/close.json"): EndpointReturnsClose; (ctx: Context, v: "GET:returns/find_policy.json"): EndpointReturnsFindPolicy; (ctx: Context, v: "POST:returns/inspect.json"): EndpointReturnsInspect; (ctx: Context, v: "POST:returns/open.json"): EndpointReturnsOpen; (ctx: Context, v: "GET:returns/page.json"): EndpointReturnsPage; (ctx: Context, v: "POST:returns/receive.json"): EndpointReturnsReceive; (ctx: Context, v: "POST:returns/refund.json"): EndpointReturnsRefund; (ctx: Context, v: "POST:returns/reject.json"): EndpointReturnsReject; (ctx: Context, v: "DELETE:review_dimension_sets.json"): EndpointReviewDimensionSetsDelete; (ctx: Context, v: "GET:review_dimension_sets.json"): EndpointReviewDimensionSets; (ctx: Context, v: "POST:review_dimension_sets.json"): EndpointReviewDimensionSetsCreate; (ctx: Context, v: "DELETE:review_dimensions.json"): EndpointReviewDimensionsDelete; (ctx: Context, v: "GET:review_dimensions.json"): EndpointReviewDimensions; (ctx: Context, v: "POST:review_dimensions.json"): EndpointReviewDimensionsCreate; (ctx: Context, v: "DELETE:roles.json"): EndpointRolesDelete; (ctx: Context, v: "GET:roles.json"): EndpointRoles; (ctx: Context, v: "POST:roles.json"): EndpointRolesCreate; (ctx: Context, v: "DELETE:scheduled_fulfillments.json"): EndpointScheduledFulfillmentsDelete; (ctx: Context, v: "GET:scheduled_fulfillments.json"): EndpointScheduledFulfillments; (ctx: Context, v: "POST:scheduled_fulfillments.json"): EndpointScheduledFulfillmentsCreate; (ctx: Context, v: "POST:scheduled_fulfillments/cancel_reservation.json"): EndpointScheduledFulfillmentsCancelReservation; (ctx: Context, v: "POST:scheduled_fulfillments/reserve.json"): EndpointScheduledFulfillmentsReserve; (ctx: Context, v: "POST:search/brands.json"): EndpointSearchBrands; (ctx: Context, v: "POST:search/categories.json"): EndpointSearchCategories; (ctx: Context, v: "POST:search/content_blocks.json"): EndpointSearchContentBlocks; (ctx: Context, v: "POST:search/customer_inventory.json"): EndpointSearchCustomerInventory; (ctx: Context, v: "POST:search/customers.json"): EndpointSearchCustomers; (ctx: Context, v: "POST:search/files.json"): EndpointSearchFiles; (ctx: Context, v: "POST:search/orders.json"): EndpointSearchOrders; (ctx: Context, v: "POST:search/products.json"): EndpointSearchProducts; (ctx: Context, v: "POST:search/promotions.json"): EndpointSearchPromotions; (ctx: Context, v: "POST:search/purchase_orders.json"): EndpointSearchPurchaseOrders; (ctx: Context, v: "POST:search/questions.json"): EndpointSearchQuestions; (ctx: Context, v: "POST:search/reindex.json"): EndpointSearchReindex; (ctx: Context, v: "POST:search/reviews.json"): EndpointSearchReviews; (ctx: Context, v: "POST:search/subscriptions.json"): EndpointSearchSubscriptions; (ctx: Context, v: "POST:search/suppliers.json"): EndpointSearchSuppliers; (ctx: Context, v: "POST:search/transfers.json"): EndpointSearchTransfers; (ctx: Context, v: "POST:search/unified.json"): EndpointSearchUnified; (ctx: Context, v: "POST:search/variants.json"): EndpointSearchVariants; (ctx: Context, v: "GET:sharded_tasks.json"): EndpointShardedTasks; (ctx: Context, v: "DELETE:shipping_providers.json"): EndpointShippingProvidersDelete; (ctx: Context, v: "GET:shipping_providers.json"): EndpointShippingProviders; (ctx: Context, v: "POST:shipping_providers.json"): EndpointShippingProvidersCreate; (ctx: Context, v: "POST:shipping_providers/test.json"): EndpointShippingProvidersTest; (ctx: Context, v: "DELETE:shipping_rules.json"): EndpointShippingRulesDelete; (ctx: Context, v: "GET:shipping_rules.json"): EndpointShippingRules; (ctx: Context, v: "POST:shipping_rules.json"): EndpointShippingRulesCreate; (ctx: Context, v: "POST:shipping_rules/export.json"): EndpointShippingRulesExport; (ctx: Context, v: "POST:shipping_rules/import.json"): EndpointShippingRulesImport; (ctx: Context, v: "DELETE:shops.json"): EndpointShopsDelete; (ctx: Context, v: "GET:shops.json"): EndpointShops; (ctx: Context, v: "POST:shops.json"): EndpointShopsCreate; (ctx: Context, v: "POST:shops/drop_cache.json"): EndpointShopsDropCache; (ctx: Context, v: "GET:shops/page.json"): EndpointShopsPage; (ctx: Context, v: "GET:shops/preferences.json"): EndpointShopsPreferences; (ctx: Context, v: "POST:shops/preferences.json"): EndpointShopsPreferencesCreate; (ctx: Context, v: "GET:shops/settings.json"): EndpointShopsSettings; (ctx: Context, v: "POST:shops/settings.json"): EndpointShopsSettingsCreate; (ctx: Context, v: "GET:slugify.json"): EndpointSlugify; (ctx: Context, v: "DELETE:sms/messages.json"): EndpointSmsMessagesDelete; (ctx: Context, v: "GET:sms/messages/page.json"): EndpointSmsMessagesPage; (ctx: Context, v: "GET:sms/sent_summary.json"): EndpointSmsSentSummary; (ctx: Context, v: "GET:subscriptions.json"): EndpointSubscriptions; (ctx: Context, v: "POST:subscriptions/cancel.json"): EndpointSubscriptionsCancel; (ctx: Context, v: "POST:subscriptions/edit.json"): EndpointSubscriptionsEdit; (ctx: Context, v: "GET:subscriptions/page.json"): EndpointSubscriptionsPage; (ctx: Context, v: "POST:subscriptions/pause.json"): EndpointSubscriptionsPause; (ctx: Context, v: "POST:subscriptions/resume.json"): EndpointSubscriptionsResume; (ctx: Context, v: "POST:subscriptions/skip_next.json"): EndpointSubscriptionsSkipNext; (ctx: Context, v: "POST:suggest/blogs.json"): EndpointSuggestBlogs; (ctx: Context, v: "POST:suggest/brands.json"): EndpointSuggestBrands; (ctx: Context, v: "POST:suggest/categories.json"): EndpointSuggestCategories; (ctx: Context, v: "POST:suggest/content_blocks.json"): EndpointSuggestContentBlocks; (ctx: Context, v: "POST:suggest/customer_inventory.json"): EndpointSuggestCustomerInventory; (ctx: Context, v: "POST:suggest/customers.json"): EndpointSuggestCustomers; (ctx: Context, v: "POST:suggest/files.json"): EndpointSuggestFiles; (ctx: Context, v: "POST:suggest/orders.json"): EndpointSuggestOrders; (ctx: Context, v: "POST:suggest/products.json"): EndpointSuggestProducts; (ctx: Context, v: "POST:suggest/promotions.json"): EndpointSuggestPromotions; (ctx: Context, v: "POST:suggest/purchase_orders.json"): EndpointSuggestPurchaseOrders; (ctx: Context, v: "POST:suggest/questions.json"): EndpointSuggestQuestions; (ctx: Context, v: "POST:suggest/reviews.json"): EndpointSuggestReviews; (ctx: Context, v: "POST:suggest/subscriptions.json"): EndpointSuggestSubscriptions; (ctx: Context, v: "POST:suggest/suppliers.json"): EndpointSuggestSuppliers; (ctx: Context, v: "POST:suggest/support_articles.json"): EndpointSuggestSupportArticles; (ctx: Context, v: "POST:suggest/transfers.json"): EndpointSuggestTransfers; (ctx: Context, v: "DELETE:suppliers.json"): EndpointSuppliersDelete; (ctx: Context, v: "GET:suppliers.json"): EndpointSuppliers; (ctx: Context, v: "POST:suppliers.json"): EndpointSuppliersCreate; (ctx: Context, v: "POST:suppliers/export.json"): EndpointSuppliersExport; (ctx: Context, v: "POST:suppliers/import.json"): EndpointSuppliersImport; (ctx: Context, v: "GET:suppliers/page.json"): EndpointSuppliersPage; (ctx: Context, v: "GET:support_articles.json"): EndpointSupportArticles; (ctx: Context, v: "GET:support_articles/page.json"): EndpointSupportArticlesPage; (ctx: Context, v: "POST:support_articles/vote.json"): EndpointSupportArticlesVote; (ctx: Context, v: "DELETE:survey_questions.json"): EndpointSurveyQuestionsDelete; (ctx: Context, v: "GET:survey_questions.json"): EndpointSurveyQuestions; (ctx: Context, v: "POST:survey_questions.json"): EndpointSurveyQuestionsCreate; (ctx: Context, v: "POST:survey_questions/export.json"): EndpointSurveyQuestionsExport; (ctx: Context, v: "POST:survey_questions/import.json"): EndpointSurveyQuestionsImport; (ctx: Context, v: "DELETE:tasks.json"): EndpointTasksDelete; (ctx: Context, v: "GET:tasks.json"): EndpointTasks; (ctx: Context, v: "POST:tasks.json"): EndpointTasksCreate; (ctx: Context, v: "GET:tasks/result.json"): EndpointTasksResult; (ctx: Context, v: "GET:tax_classes.json"): EndpointTaxClasses; (ctx: Context, v: "DELETE:tax_rules.json"): EndpointTaxRulesDelete; (ctx: Context, v: "GET:tax_rules.json"): EndpointTaxRules; (ctx: Context, v: "POST:tax_rules.json"): EndpointTaxRulesCreate; (ctx: Context, v: "POST:tax_rules/add_default.json"): EndpointTaxRulesAddDefault; (ctx: Context, v: "POST:tax_rules/export.json"): EndpointTaxRulesExport; (ctx: Context, v: "POST:tax_rules/import.json"): EndpointTaxRulesImport; (ctx: Context, v: "DELETE:tax_system.json"): EndpointTaxSystemDelete; (ctx: Context, v: "GET:tax_system.json"): EndpointTaxSystem; (ctx: Context, v: "POST:tax_system.json"): EndpointTaxSystemCreate; (ctx: Context, v: "POST:tax_system/test.json"): EndpointTaxSystemTest; (ctx: Context, v: "DELETE:transfer_notes.json"): EndpointTransferNotesDelete; (ctx: Context, v: "GET:transfer_notes.json"): EndpointTransferNotes; (ctx: Context, v: "POST:transfer_notes.json"): EndpointTransferNotesCreate; (ctx: Context, v: "DELETE:transfers.json"): EndpointTransfersDelete; (ctx: Context, v: "GET:transfers.json"): EndpointTransfers; (ctx: Context, v: "POST:transfers.json"): EndpointTransfersCreate; (ctx: Context, v: "POST:transfers/close.json"): EndpointTransfersClose; (ctx: Context, v: "POST:transfers/export.json"): EndpointTransfersExport; (ctx: Context, v: "POST:transfers/import.json"): EndpointTransfersImport; (ctx: Context, v: "GET:transfers/log.json"): EndpointTransfersLog; (ctx: Context, v: "POST:transfers/open.json"): EndpointTransfersOpen; (ctx: Context, v: "GET:transfers/page.json"): EndpointTransfersPage; (ctx: Context, v: "POST:transfers/receive.json"): EndpointTransfersReceive; (ctx: Context, v: "POST:transfers/reject.json"): EndpointTransfersReject; (ctx: Context, v: "GET:usage.json"): EndpointUsage; (ctx: Context, v: "DELETE:user_files.json"): EndpointUserFilesDelete; (ctx: Context, v: "GET:user_files.json"): EndpointUserFiles; (ctx: Context, v: "POST:user_files.json"): EndpointUserFilesCreate; (ctx: Context, v: "DELETE:users.json"): EndpointUsersDelete; (ctx: Context, v: "GET:users.json"): EndpointUsers; (ctx: Context, v: "POST:users.json"): EndpointUsersCreate; (ctx: Context, v: "DELETE:users/oauth.json"): EndpointUsersOauthDelete; (ctx: Context, v: "POST:users/oauth.json"): EndpointUsersOauth; (ctx: Context, v: "DELETE:users/two_factor.json"): EndpointUsersTwoFactorDelete; (ctx: Context, v: "POST:users/two_factor.json"): EndpointUsersTwoFactor; (ctx: Context, v: "POST:users/two_factor/backup_phone.json"): EndpointUsersTwoFactorBackupPhone; (ctx: Context, v: "POST:users/two_factor/recovery_codes.json"): EndpointUsersTwoFactorRecoveryCodes; (ctx: Context, v: "GET:users/two_factor/recovery_codes/show.json"): EndpointUsersTwoFactorRecoveryCodesShow; (ctx: Context, v: "POST:users/two_factor/validate.json"): EndpointUsersTwoFactorValidate; (ctx: Context, v: "DELETE:variant_inventory.json"): EndpointVariantInventoryDelete; (ctx: Context, v: "GET:variant_inventory.json"): EndpointVariantInventory; (ctx: Context, v: "POST:variant_inventory.json"): EndpointVariantInventoryCreate; (ctx: Context, v: "GET:variant_inventory/log/page.json"): EndpointVariantInventoryLogPage; (ctx: Context, v: "DELETE:webhooks.json"): EndpointWebhooksDelete; (ctx: Context, v: "GET:webhooks.json"): EndpointWebhooks; (ctx: Context, v: "POST:webhooks.json"): EndpointWebhooksCreate; (ctx: Context, v: "GET:webhooks/events.json"): EndpointWebhooksEvents; (ctx: Context, v: "GET:webhooks/events/page.json"): EndpointWebhooksEventsPage; (ctx: Context, v: "GET:webhooks/status/page.json"): EndpointWebhooksStatusPage; (ctx: Context, v: "DELETE:xero.json"): EndpointXeroDelete; (ctx: Context, v: "GET:xero.json"): EndpointXero; (ctx: Context, v: "POST:xero.json"): EndpointXeroCreate; (ctx: Context, v: "GET:xero/accounts.json"): EndpointXeroAccounts; (ctx: Context, v: "POST:xero/authorize.json"): EndpointXeroAuthorize; (ctx: Context, v: "GET:xero/log.json"): EndpointXeroLog; (ctx: Context, v: "GET:xero/tax_rates.json"): EndpointXeroTaxRates; } export {};