/** * This file was auto-generated by openapi-typescript and ts-morph. * Do not make direct changes to the file. */ export interface paths { readonly "/tax/zonecheck": { readonly parameters: { readonly query?: never; readonly header: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: components["parameters"]["Accept"]; }; readonly path?: never; readonly cookie?: never; }; /** * Check zone given an address. * @description Check the applicable tax zone for a given address and customer group. */ readonly post: operations["zone-check"]; }; } export type webhooks = Record; export interface components { schemas: { readonly ZoneCheck: { /** * @description Two-letter ISO 3166-1 country code. * @example AU */ readonly country_code: string; /** * @description ISO 3166-2 subdivision code, up to three alphanumeric characters. * @example NSW */ readonly subdivision_codes?: string; /** * @description Postal code. * @example 2099 */ readonly postal_code?: string; /** * @description Customer Group ID to which the customer is belongs. * @example 0 */ readonly customer_group_id?: number; }; readonly TaxZone: { /** * @description Tax Zone ID. Internal identifier used to get, update, or delete a specific tax zone. * @example 1 */ readonly id?: number; /** * @description The human-readable name for this tax zone. The name displays on the merchant's control panel. * @example Australia */ readonly name?: string; /** * @description Indicates whether a tax zone is enabled. Tax operations are only for enabled zones. * @default true */ readonly enabled: boolean; /** @description Settings that describe how a store displays prices to shoppers matched with this tax zone. */ readonly price_display_settings?: { /** @description Indicates whether to show prices as tax inclusive or tax exclusive to shoppers matched with this tax zone. */ readonly show_inclusive?: boolean; /** @description Indicates whether to show both tax inclusive and tax exclusive prices when viewing product detail; for example, on product pages. This view applies to shoppers matched with this tax zone. */ readonly show_both_on_detail_view?: boolean; /** @description Indicates whether to show both tax inclusive and tax exclusive prices when viewing a list of products; for example, on category and brand pages. This view applies to shoppers matched with this tax zone. */ readonly show_both_on_list_view?: boolean; }; /** @description Settings that describe which shoppers match this tax zone and help determine the most appropriate target for a shopper. You cannot define shopper target settings for the default tax zone because it must accommodate all shoppers who donʼt qualify for any other zone. */ readonly shopper_target_settings?: { /** @description A tax zone may target shoppers in one or more locations. */ readonly locations?: readonly { /** * @description Two-letter ISO 3166-1 country code * @example AU */ readonly country_code?: string; /** * @description Three-letter ISO 3166-2 subdivision code * @example [ * "NSW", * "QLD" * ] */ readonly subdivision_codes?: readonly string[]; /** @example [ * "2234", * "2170" * ] */ readonly postal_codes?: readonly string[]; }[]; /** @description One or more customer groups that a tax zone targets. Empty array if zone applies to all customers. */ readonly customer_groups?: readonly number[]; }; }; }; responses: never; parameters: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: string; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly ContentType: string; }; requestBodies: never; headers: never; pathItems: never; } export type $defs = Record; export interface operations { readonly "zone-check": { readonly parameters: { readonly query?: never; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path?: never; readonly cookie?: never; }; readonly requestBody: { readonly content: { readonly "application/json": readonly components["schemas"]["ZoneCheck"][]; }; }; readonly responses: { /** @description OK */ readonly 200: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { readonly data?: readonly components["schemas"]["TaxZone"][]; }; }; }; /** @description The request body does not meet specifications. */ readonly 422: { headers: { readonly [name: string]: unknown; }; content?: never; }; }; }; }